Xwiki Standard 9.8.1 User Guide Xwiki Standard 9.8.1 User Guide
Total Page:16
File Type:pdf, Size:1020Kb
XWiki Standard 9.8.1 User Guide XWiki Standard 9.8.1 User Guide Table of Contents Pages Overview .................................................................................................................................................................... 3 XWiki Applications Overview .......................................................................................................................................... 108 Other XWiki Applications Overview ................................................................................................................................ 217 Users and Groups Overview ............................................................................................................................................. 231 Page 2 XWiki Standard 9.8.1 User Guide • Pages Overview • Create a Wiki Page • Simple and Advanced Edit • Common Edit Actions • Editing Modes • XWiki Syntaxes • The CKEditor • Nested Page Actions • Share Page By Email • Page Comments • Page Attachments • Page History • Page Export Formats • Internationalization • Activity Stream • Keyboard Shortcuts • XWiki Applications Overview • Annotations Application • Dashboard Application • Flamingo Skin • Help Center Application • Index Application • Office Importer Application • Search Application • Syntax Highlighting Application • Tag Application • Tour Application • Other Applications • Blog Application • Users and Groups Overview • Registration • Login • User Profile • User Preferences • User Status • Join a Sub-Wiki • Wiki Invitations • View the List of Joined Wikis • Leave Wiki Pages Overview FAQ Create and Edit Pages What are nested and terminal pages? How do I create a blank page? How do I create a dashboard page? What to do in order to have more options in the edit menu? What is a minor edit and how can I add a comment to the changes I make? How do I preview my changes or cancel my modifications? What is the wiki editor? What is inline editing? What are XWiki objects? What are XWiki classes? How do I use the wiki syntax? What is the CKeditor? How do I import office documents into wiki pages? Advanced Page Features How do I set a parent to a page? How do I administer a nested page? Where do I see the children of a nested page? How do I administer the parent of a terminal page? Page 3 XWiki Standard 9.8.1 User Guide Where do I see the siblings of a terminal page? How do I preview my page for print? Where do I see the source code of a page? How do I copy a page? How do I rename a page? How do I delete a page? How do I check whether there are backlinks to the current page? How do I access the tag list? How do I add tags to a page? How do I rename a tag? How do I delete a tag? Is there a way to hide a page from other users? What are the keyboard shortcuts I can use? How do I export a page? How to I attach a file to a page? How do I access a page history? How do I compare two versions of the same document? Where do I see who last modified the document? Collaboration Within Pages How do I share a page by email? How do I add an annotation? How can I reply to an annotation? How do I show the annotations on a page? How do I edit an annotation? How do I delete an annotation? How do I filter annotations by author? How do I add a comment to a page? How do I preview a comment before I submit it? How do I edit one of my comments after I have submitted it? How do I reply to an existing comment? Wiki Pages • XWiki Page Structure • Create a New Blank Page • Create a Dashboard • Page Hierarchy • New Default Templates XWiki Page Structure Starting with XWiki 7.2, we have introduced the possibility to create pages inside other pages - this new feature is called Nested Pages and comes with 2 new concepts: • Nested Page or Non-Terminal Page is a wiki page that can have child pages. • Non-Nested Page or Terminal Page is a wiki page that cannot have children and it is usually created by applications and scripts. Simple users can create only nested pages, whereas Advanced users can create both nested and terminal pages. The advantages or using nested pages include: • improved and simplified manner to organize your content hierarchically • ability to set permissions at each level • the page hierarchy is reflected in the URL • the entire hierarchy is updated whenever a page is renamed or deleted You can still use the sub-wiki alternative in 2 main cases: • the need to provide custom applications and/or extensions to a group of wiki users but not to others • the need to implement a wiki farm where each sub-wiki has its own users and applications Create a New Blank Page To create a new wiki page, go to anywhere in the wiki and click the "+ Create" button. Page 4 XWiki Standard 9.8.1 User Guide If you are an advanced user, the page creation form has 4 elements, otherwise, you will see only the first 3 of them: • Title - the page title • Type - in case there are page templates available, you can choose either one of them or the "Blank Page" template, which is the default one. Moreover, you have the possibility to filter page types thanks to a dedicated text input. • Location - the place in the page hierarchy where the new document will be created. • Terminal Page - this option is available only for advanced users and it allows to create a non-nested page i.e. a document that cannot have child pages. More information about how to create and manage generic page templates is available in the "Template Providers" documentation listed under "Related Pages". To set the page location, click the blue editing pen icon, which will load 2 more fields: • Parent - the parent of the new page; right after starting to type the name, the suggest feature will display the list of all the occurrences, so that you can select from them. To collapse the suggestion results, just click on "hide suggestions". As soon as you select a parent, the breadcrumb is updated in order to reflect the location of the page in the reference hierarchy. By leaving this field empty, you will create a top-level page which is the equivalent of an old space home page. • Name - the name of the page i.e. the string appearing in the URL. Page 5 XWiki Standard 9.8.1 User Guide Another way of selecting a location is to click on the blue hierarchy icon and select a space from the document tree or to search it using the integrated finder. Page 6 XWiki Standard 9.8.1 User Guide The editing pen icon and the advanced edit fields like the wiki, parent and page name are hidden for simple users who will have to use the tree picker to select the target location. Page 7 XWiki Standard 9.8.1 User Guide Once you are done filling the form, click on "Create". Your new document will open in edit mode, Wysiwyg or text, depending on what you have chosen in your user preferences page. In the editor window you may add content to the newly created page. Page 8 XWiki Standard 9.8.1 User Guide Once you are done adding content, save the page to finalize the process. If you decide to create a terminal page, it is mandatory to set a parent for it. When creating a new page, the system automatically creates a [PageName].WebHome, which creates a space, though this is hidden in the URL. For instance, the nested page "MarketingMeetingNotesNovember2017" has a corresponding "MarketingMeetingNotesNovember2017.WebHome". Another way to create a new blank page is straight from the URL, by entering the new page name in the address bar of your browser. If the page doesn't exist, you will get the message "The requested page could not be found". Also, there will be an "edit this page" link in order to create it. We have added partial matches to the "Notice" screen for both not found pages and attachments, in addition to the existing stemmed (using indexed Solr data) and fuzzy matches (string difference of 2). The list of suggestions addresses minor typos and misspelling - including lower case versus upper case - and also bad location requests. Page 9 XWiki Standard 9.8.1 User Guide Create a Dashboard To create a dashboard, go to any page and click the "+ Create" button, as explained in the previous section and: • fill in the title and name - in our case they are both set to "Applications" • leave the "Parent" field empty in order to create a top-level nested page • select the "Dashboard - Customisable gadgets" option under "Page Type" -> "Templates" After clicking on "Create", the new page will open in "Inline" mode. The dashboard already has 2 columns and 3 default gadgets: • Page index using the Document Tree Macro • Tag Cloud • Activity Stream but you can further customize it by adding gadgets and columns. Page 10 XWiki Standard 9.8.1 User Guide Page Hierarchy Due to the decision to start using Nested Pages, the old Parent-Child relationship was dropped. Thus, the functionality is turned off by default. A system administrator can enable it at any time by setting the core.hierarchyMode property to parentchild in the /WEB-INF/xwiki.properties configuration file, followed by a server restart. The new breadcrumb has been reworked to reflect the location of a page in the reference hierarchy. Each breadcrumb element has a drop-down tree that shows the siblings and the children, helping you navigate easily around the wiki. In the table below you can see the breadcrumb for terminal and non-terminal pages and also what appears in the "Spaces" widget after creating a nested page (top-level or not). Non-Terminal Page Terminal Page Page 11 XWiki Standard 9.8.1 User Guide Non-Terminal Top-Level Page Since adopting the nested pages feature, the ability to modify the page parent has been removed in edit mode.