<<

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 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 • 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 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.

This is why, to change the parent of a page, you will have to rename it, as indicated in the 'Nested Page Actions' documentation. New Default Templates

XWiki provides 4 new default templates containing pre-created page structures that can be used immediately. The "Simple Page" template is basically the "Blank Page" template with 2 extra macros: "Box" and "Table of Contents".

The "Article Page" template allows to create a news article-like page with: • a summary wrapped in a Jumbotron component • the content of the article displayed in the column on the left • a table of contents (generated using the "Box" and "Table of Contents" macros) and associated images displayed in the column on the right

Page 12 XWiki Standard 9.8.1 User Guide

Simple Page Template Article Page Template

The "Encyclopedia Page" template is similar to "Article Page" with one difference: the images from the column on the right are replaced with a single image and a table wrapped in a box container. The "Meeting Report" template allows to easily store meeting notes and agenda.

Page 13 XWiki Standard 9.8.1 User Guide

Encyclopedia Page Template Meeting Report Template

Related Pages

• User Guide • Simple and Advanced Editing • Pages Overview • Nested Page Actions • Index Application • Editing Modes • Common Edit Actions • Developer Guide • XWiki Rendering Macros in Java Overview • XWiki Rendering Macros Overview • XWiki JavaScript API • Tree Widget • Tag Plugin • Tag Cloud Macro • Table of Contents Macro • Spaces Macro • Floating Box Macro • Event Stream Module • Document Tree Macro • Children Macro • Box Macro • Activity Stream Plugin • Admin Guide • Template Providers • Set the Page Access Rights Simple and Advanced Editing

To edit a page using the default editor, click on the "Edit" button located in the actions bar.

Page 14 XWiki Standard 9.8.1 User Guide

XWiki comes with "Simple" and "Advanced" editing modes and you may choose which editing mode you prefer from your user preferences page. If you use the simple editing mode, you will automatically edit the page in WYSIWYG or "Wiki" mode for standard pages and in "Inline form" mode for pages including Forms.

By using the advanced editing, you will have some extra options in the menu when clicking the "Edit" button: • "Objects" • "Class"

By clicking on "Edit", you will simply use the default editor for that page or form. The default editor setting is available in the user preferences page. As we have adopted the Nested Pages feature, the "Access Rights" option was removed from the edit menu for non-terminal pages. In its place, you can use the new Administer Page UI. Hide Technical Content and Change Syntax

In XWiki it is possible to hide a wiki page. This means that some events triggered by these pages, like creation, edit or delete, won't appear in the Activity Stream, the search results, the wiki index or the page index. To hide a wiki page, edit it in "Wiki" or "Wysiwyg" mode and check the "Hidden page" option from the "Page Information" panel to the right then click on "Save & View". It is also possible to make your hidden pages invisible for other users when they use the Search feature. To learn more about this, go to the documentation page about 'user preferences'.

Page 15 XWiki Standard 9.8.1 User Guide

Finally, you may convert the page content to another syntax by selecting the desired value from the "Page syntax" drop-down. For the moment, only the xwiki/2.1 syntax is configured by default, but provided you are a wiki administrator you will see a "Configure more syntaxes" link allowing you to add extra options to the list. For more details, please refer to the XWiki Syntaxes documentation.

Related Pages

• User Guide • XWiki Syntaxes • Wiki Pages • User Preferences • Tags Application • Syntax Highlighting Application • Share Page by Email • Pages Overview • Page Attachments • Editing Modes • Common Edit Actions • CK Editor • Developer Guide • Template Module • Rendering Module • Localization Module • Content Macro • Admin Guide • Customization Overview • CKEditor Configuration Common Edit Actions

All the available edit modes have some or all of the following elements:

Page 16 XWiki Standard 9.8.1 User Guide

• The Is minor edit check-box is meant to mark the fact that superficial changes were made to the document. To learn how to manage the changes made to a wiki page, go to the documentation page about "Version control". • The Version Summary field allows you to enter a short description of the changes made on the document in the version that is being saved. • The Cancel button discards the changes and redirects you to the current document in view mode. • The Preview button displays the document as it would look if the current changes were saved. This button is not available in all editing modes. • The Save & Continue button submits the current changes and redirects you to the current document in edit mode. • The Save & View button submits the current changes and redirects you to the current document in view mode. • If the Autosave check-box is enabled, the current document will be automatically saved as a minor version. The default time interval is 5 minutes but you can easily change it. The automatic save widget was available only for the wiki editor, but starting with version 8.3 we have also made it available in Wysiwyg mode.

Related Pages

• User Guide • Wiki Pages • Simple and Advanced Editing • Pages Overview • Page History • Editing Modes • Developer Guide • The "xwikircs" Table • Diff Module Editing Modes To access all the available editing modes from the menu you need to be an "advanced user" as explained in the User Preferences documentation page. Otherwise, when clicking the "Edit" button, the default editor will be used.

Page 17 XWiki Standard 9.8.1 User Guide

The XWiki editing modes are:

• Wiki - this mode allows you to enter text using a simple Wiki Syntax. The syntax help page is available by clicking on the link displayed in the "XWiki Syntax Help" panel.

Syntax highlighting is automatically activated for the "Wiki" editor that now also has some new features including: • line numbers • active line highlighting • tab line indentation • 2 spaces on tab • matching and auto-closing , parentheses and quotes • matching selection highlighting • scroll to undo/redo position • trailing white-space highlighting • multi-line comment auto indentation on newline

Page 18 XWiki Standard 9.8.1 User Guide

• search / replace with regex support • WYSIWYG - this mode is ideal for first time users or for people not at ease to use the Wiki Syntax.

• Inline form - this mode is a special feature of XWiki allowing administrators to define patterns of structured information (like a blog entry, or a standard form). Pages containing such structured information can be edited and re-edited as simple HTML forms, which have almost the same structure as the displayed page. Thus, when clicking on "Edit" the page content can be edited in-place, or inline and the form view is automatically displayed.

Page 19 XWiki Standard 9.8.1 User Guide

• Objects - this mode makes it possible to attach Objects to pages. Objects are simple sets of properties containing additional information about a page.

• Class - this mode calls the class editor on the current page, allowing you to edit the class attached to the document.

Page 20 XWiki Standard 9.8.1 User Guide

The Edit button loads the default editor for that page or form. The default editor setting is available in the user preferences page. Also, as we have adopted the Nested Pages feature, the "Access Rights" option was removed from the edit menu for non- terminal pages. In its place, you can use the new Administer Page UI.

Related Pages

• User Guide • Wiki Pages • View the List of Joined Sub-Wikis • User Preferences

Page 21 XWiki Standard 9.8.1 User Guide

• Sub-Wiki Invitations • Simple and Advanced Editing • Pages Overview • Office Importer Application • Leave a Sub-Wiki • Join a Sub-Wiki • Common Edit Actions • CK Editor • Developer Guide • XWiki Data Model • Wysiwyg Module • Customize the Look and Feel of the PDF and RTF Export • Create and Override a Skin • Admin Guide • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Customization Overview • Create a Sub-Wiki • CKEditor Configuration XWiki Syntaxes • Link Syntax for Nested Pages • Relative Links to Sibling Nested Pages • Syntax Highlighting XWiki allows to convert the page content to another syntax by editing it in "Wiki" or "Wysiwyg" mode and selecting the desired value from the "Page syntax" drop-down in the "Page Information" panel.

For the moment, only the xwiki/2.1 syntax is configured by default, but provided you are a wiki administrator you will see a "Configure more syntaxes" link allowing you to add extra options to the list via the "Editing" -> "Syntaxes" section of the wiki preferences page.

Page 22 XWiki Standard 9.8.1 User Guide

The reason why the configuration defines disabled syntaxes is because when you install an extension contributing a new syntax in your wiki, we want this syntax to be enabled by default. Otherwise, an administrator user would have to install the extension and then activate the syntax. Link Syntax for Nested Pages

After adopting the nested pages paradigm, a discrepancy appeared between the UI and the wiki syntax, namely the user still had to specify both the space and page name when creating a link to it. The same principle applied for links to images ([[image:SomeImage.png]]) or attachments ([[attach:SomeFile.pdf]]) and the technical reason was that at the wiki syntax level, untyped links were being resolved to doc: type links. The solution to this problem was to add a new space: type link which allows to write [[space:Nested.Page1.Page2]] and to make it the new default type that untyped links resolve to. Therefore, to create a link to the nested page Nested.Page1.Page2, it is enough to write [[Nested.Page1.Page2]]. In order to keep the backwards compatibility with the existing untyped links, XWiki has implemented the same mechanism for URLs, meaning that: • first try to link to an existing terminal page • in case no such terminal page exists, link to the nested page both when the non-terminal page exists or when it doesn't. The link label generator now supports Nested Pages by default and several new configuration formats have been introduced: • %s now uses the full space name i.e. space1.space2; in older XWiki versions, this format was only displaying the last space name • new formats: • %ls displays the last space name • %np displays the nested page name i.e. the space name for Nested Pages • %NP displays the nested page name with spaces between camel-case words, i.e. "My Page" if the page name is "MyPage" More details about the new links behavior as well as examples are available in the "XWiki.XWikiSyntax" wiki page, by clicking on "XWiki Syntax Guide" in the "Navigation" panel displayed in the column on the left.

Page 23 XWiki Standard 9.8.1 User Guide

Relative Links to Sibling Nested Pages

For the case when the current page is non-terminal and it contains an untyped relative link (like [[Page]]), we still keep the backwards compatibility with the pre-Nested-Pages behavior. If the relative link hasn't been resolved using the aforementioned algorithm, we perform 2 more checks: • try to link to an existing terminal page that is a sibling of the current page; in this case [[Page]] is resolved to the equivalent of [[doc:CurrentPageParent.Page]]; • if no such terminal page exists, link to the nested page that is a sibling of the current one; in this case [[Page]] is resolved to the equivalent of [[doc:CurrentPageParent.Page.WebHome]], both when the non-terminal page exists or when it doesn't. Syntax Highlighting

Syntax highlighting is automatically activated for the "Wiki" editor that now also has some new features including: • line numbers • active line highlighting • tab line indentation • 2 spaces on tab • matching and auto-closing brackets, parentheses and quotes • matching selection highlighting • scroll to undo/redo position • trailing white-space highlighting • multi-line comment auto indentation on newline • search / replace with regex support

Page 24 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • Syntax Highlighting Application • Simple and Advanced Editing • Developer Guide • Template Module • Rendering Module • Localization Module • Content Macro CK Editor • Overview • Editing Area • Toolbar • Menus • Text Formatting • Text Styles • Headings • Lists • Create and Edit Links • Link to a Wiki Page • Link to a Page Attachment • Link to a Web Page • Link to an Email Address • Insert and Edit Images • Create and Edit Tables • Insert and Edit Macros • Inserting Symbols • Import Office Content • Paste Office Content

Page 25 XWiki Standard 9.8.1 User Guide

The CKEditor provides most of the standard editing features available in CKEditor as well as some additional features that are specific to XWiki. Overview

Toolbar Item / Menu Function Applies bold, italic, underline or strikethrough formatting to the selected text. See Text Styles. 2 Subscript (x2) or superscript (x ) the selected text. See Text Styles.

Remove all the styles applied to a piece of text.

Creates bulleted or numbered lists. See Lists.

Increases or decreases the indentation of a list item. See Lists.

Insert a block quote.

Set the text alignment: left, centered, right or justified.

Set the text direction from left to right or from right to left.

Cut a text selection.

Copy a text selection.

Paste a text from clipboard.

Paste from clipboard as plain text.

Copy the content of or Excel documents and paste them into the editor while preserving the structure and styles that were present in the original text. Undo or redo the most recent action taken.

Find and replace a character or a text selection.

Page 26 XWiki Standard 9.8.1 User Guide

Add or remove a link. See also Create and Edit Links for a detailed description. Add a reference/location in a page using the ID macro.

Insert an attached or an external image. See also Insert and Edit Images for a detailed description. Insert a table. See also Insert and Edit Tables for a detailed description. Insert an XWiki macro. See also Insert and Edit Macros for a detailed description. Inserts symbols or special characters (accented characters, trademark, currency symbol etc.). See also Inserting Symbols for a detailed description. Import a Microsoft Office file in XWiki. See also Import Office Content for more details. Inserts a horizontal rule.

Change the style used by the selected text. See Text Styles.

Page 27 XWiki Standard 9.8.1 User Guide

Format the text as heading (level 1 to 6) and much more. See Headings.

Change the font used by the selected text.

Change the font size used by the selected text.

Change the text color or the background color of the selected text.

Display the wiki source code of the current page.

Load the page in preview mode.

Enable / disable the full screen feature.

Editing Area

The editing area is the place where you type in your text and format your document. It is a rich text area because you can see, while editing, how the text will look like after it is saved. The editing area also allows you to select a piece of text which is useful when you want to format it. If your content becomes larger than the available space in the editing area the scroll bars, vertical or horizontal, will appear. Toolbar

The toolbar is the place where you can find most of the editor features. It is placed right on top of the editing area. Each feature can be activated through a widget like a button or a list box. Features can be grouped and groups of features are separated from one another using containers. The toolbar gets updated whenever you take an action on the editing area (like typing a character or clicking). As a consequence, some features could be disabled depending on where you place the insertion caret inside the rich text area.

A toolbar button can be in one of the four states depicted in the previous image. From left to right we have: not clicked, hovering, clicked and disabled. When a button is in the not clicked state, it means the associated feature hasn't been activated on the current . By "current context" we mean the place where the insertion caret or the selected text is inside the editing area. When you place the mouse pointer over a toolbar button, the later enters the hovering state. In this state you can see a tooltip explaining what the associated feature does. If a toolbar button is in the clicked state, it means the associated feature has been activated on the current context. By clicking the button again`, you can usually toggle off the effect of the feature (remove the bold style etc.). A toolbar button is disabled when you are not allowed to activate its feature in the current context.

Page 28 XWiki Standard 9.8.1 User Guide

Toolbar list boxes are also updated when you take an action on the editing area. The proper value is selected depending on the current context. If no value is selected, it means that none of the list box options match the value of the associated feature for the current context. Menus

The menu bar is the place where you can find the advanced editing features. All menu items have an icon to help you easily recognize them. When a menu item is disabled, it means its feature cannot be activated on the current context (the currently selected text or the text around the insertion caret). Text Formatting Text Styles

You can change the way your text looks like by using the basic text styles buttons in order to make the the font bold ( ), italic ( ), underlined ( ), stroked through ( ), subscript ( ) or superscript ( ). The chosen style affects either the selected text or, if there is just the insertion caret, the next characters you will be writing.

This is a text with bold style

This is a text with italic style

This is a text with underline style

This is a text with strike through style

PABC = LAB + LBC + LCA

E = mc2

a b P(x)= x1 + x2

You can mix any of these styles. To toggle off a text style, click again the associated toolbar button. If you want to remove all the styles at once click on .

You can mix bold and italic styles: Hello user! You can mix italic and underline styles: Hello user! You can mix boldand strike through styles: Hello user!

Additionally, you may use the "Styles" drop-down list of the CKEditor toolbar which makes it easy to apply customized styles and semantic values to content created in the editor. Some old styles that were not supported by the XWiki syntax - like "Subtitle", "Computer Code", "Keyword Phrase" - were removed and replaced with some new ones. Block Styles

• Box - adds a (% class="box" %) container similar to the one created by the "Box" Macro. • Info Box - adds an Information Box container similar to the one created by the "Information Message" macro. • Warning Box - adds an Warning Box container similar to the one created by the "Warning Message" macro. • Success Box - adds an Success Box container similar to the one created by the "Success Message" macro. • Error Box - adds an Error Box container similar to the one created by the "Error Message" macro. • Floating Box - adds an Floating Box container similar to the one created by the "Floating Box" macro. • Lead Paragraph - allows to insert a text paragraph inside a (% class="lead" %) structure. Inline Styles

• Typewriter - apply the teletype style. • Marker - associate a marker pseudo-element in order to apply list-style attributes on a given element. • Small - display the content in a tag. • Uppercase

Page 29 XWiki Standard 9.8.1 User Guide

The XWiki integration has been improved by enabling and configuring the Advanced Content Filter for the XWiki 2.1 syntax. This should prevent the editor from generating content that cannot be saved as wiki syntax and disables automatically the editor features that generate such content. Headings

Headings can be used to organize your text. You can split the content in sections and subsections and then specify a title for each of them. You can choose the heading level to apply from the "Paragraph Format" list box on the toolbar. If you want to remove the heading style, just choose the "Normal" option. Note that formats work on block level which means that you do not need to select any text in order to apply them and entire blocks will be affected by your choice.

Additionally you may use the drop-down list to: • write pre-formatted text by clicking on "Format" which displays the content in a

 tag. • define a text section by clicking on "Normal (DIV)" which displays the content in a 
tag. Lists

You can create two kinds of lists: • numbered which are also called ordered because the order of the list items is important. • bulleted which are also called unordered because the order of the list items is not important. The only difference between these two types of lists is the symbol, a number or a bullet, preceding the list items but they behave the same. To start a list, you have to place the caret on the line that you would like to become the first list item in your new list and click on the toolbar button for the type of list you wish to create: for a bulleted list or for a numbered list.

You can also quickly create a list from a couple of lines by selecting those lines and clicking on the toolbar button for the type of list you wish to create.

Page 30 XWiki Standard 9.8.1 User Guide

Once you have a list, you can add more list items by using the Enter key. Pressing Enter in the middle of a list item splits that list item in two. Typing Enter at the end of a list item creates a new empty list item.

You can create sub-lists by indenting list items. To do this click the button from the toolbar. Note that you can indent just one level because a sub-list must always have a parent list. You can indent multiple list items at once though, by selecting them first. The outdent feature, , is the opposite of indent. Unlike indent, you can outdent a list item multiple levels. Outdenting a top level list item transforms it in plain text. Finally, you can mix bulleted lists with numbered lists.

After you created the list, click on the toolbar button for the associated list type to go back to plain text. Create and Edit Links

In order to create a link, you usually select the text that you would like to become the label of the link, then click on the

menu and choose the right option based on the type of link you wish to create. You can change the label of the link later, by editing the link after it was created or directly in the editing area. If you don't provide a label when creating a link, the editor will use the page name / attachment name / URL / mail address. Moreover, you may use an image as the link label.

To edit the link properties, just click again on the menu. To select a link, you can either place the caret inside the link label or select a piece of the link label. If the link label is an image then you have to select that image.

To remove a link (unlink) you have to select it and click the menu. Note that the link label (text or image) is not deleted from the page content. You cannot create links inside links but unlike the old Wysiwyg editor, the CKEditor allows to create a link if the selected label spans through multiple blocks of text.

Page 31 XWiki Standard 9.8.1 User Guide

Link to a Wiki Page

To create a link to a wiki page, select the text or image you wish to become the link label and click on the menu which will open the options box. Note that the dialog has a new "Display Text" input allowing to specify the link label. To quickly search for wiki pages, simply use the text box that will offer you suggestions based on the results matching your input.

In case you are not sure about the page name, click the file icon and either select it from the page tree or search for it using the integrated finder.

Page 32 XWiki Standard 9.8.1 User Guide

Advanced users can also specify a query string for the page URL (this is useful for instance when you need to create a link to the page comments or attachments) or an anchor.

Page 33 XWiki Standard 9.8.1 User Guide

Finally, provided the "Show Advanced Tab" and "Show Target Tab" options are enabled in the CKEditor administration page, you may set the link attributes like: Id, Name, Advisory Title, Style, whether to force download and so on

Page 34 XWiki Standard 9.8.1 User Guide

or to set the link "target" attribute like opening it in a new window

Page 35 XWiki Standard 9.8.1 User Guide

or in the specific frame or popup window.

Link Label Generation

The CKEditor Integration was upgraded to the latest version which brings support for creating wiki links with auto-generated label. It is now possible to configure the way labels are generated by the system when the user doesn't provide one by editing the "WEB-INF/xwiki.properties" file and setting the rendering.linkLabelFormat parameter. Its default value is %np (nested page) meaning that it uses the nested page name. The other possible values are: • %w: use the wiki name • %s: use the full space name (e.g. space1.space2) • %ls: use the last space name • %p: page name • %P: use page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage" • %NP: use the nested page name with spaces between camel-case words, i.e. "My Page" if the page name is "MyPage" • %t: page title The feature is disabled by default in CKEditor because at the moment XWiki uses the page name (not the page title) for auto- generated link labels by default, which can confuse the users given that we display the page title in the page tree and in the page suggest.

Page 36 XWiki Standard 9.8.1 User Guide

Link to a Page Attachment

To create a link to an attachment, select the text or image you wish to become the link label and click on the menu which will open the options box. Next, click the downward icon next to the text input, select the "Attachment" option

and either use the suggestion box

Page 37 XWiki Standard 9.8.1 User Guide

or click the paperclip icon and use the page tree to search for the attachment.

Page 38 XWiki Standard 9.8.1 User Guide

Similarly to wiki page links, you may specify a query string for the attachment URL. If the file doesn't exist in the wiki, click the "Upload" tab, choose a file from your computer and click on "Send it to the server".

Page 39 XWiki Standard 9.8.1 User Guide

If you go back to the "Link Info" tab you will notice that the newly uploaded file was attached to the current page.

Page 40 XWiki Standard 9.8.1 User Guide

Another way to create a link to a non-image attachment is to simply drop it over the editing area. This way, the file is automatically attached to the current page and a corresponding link is created.

Link to a Web Page

To create a link to a web page, select the text or image you wish to become the link label and click on the menu. Next, click the downward icon in the "Link Info" window, select the "URL" option

Page 41 XWiki Standard 9.8.1 User Guide

and enter the web address in the text input.

Page 42 XWiki Standard 9.8.1 User Guide

Link to an Email Address

To create a link to an email address, select the text or image you wish to become the link label and click on the menu. Next, click the downward icon in the "Link Info" window, select the "Mail Address" option,

Page 43 XWiki Standard 9.8.1 User Guide

enter the recipient email and / or the message subject and body, then hit "Ok".

Page 44 XWiki Standard 9.8.1 User Guide

This way, each time you click the link, you will be able to send an email to the selected recipient and with the chosen subject and / or body. Insert and Edit Images

To insert an image, place the caret where you want it to be displayed and click the menu. You have three ways to specify which image to insert: • Search for an image attachment using the text input.

Page 45 XWiki Standard 9.8.1 User Guide

• Click the paperclip icon and use the page tree and its integrated finder.

Page 46 XWiki Standard 9.8.1 User Guide

• Upload a new image to the edited page as explained in the previous section. Before the image is inserted, you can edit the image properties:

• the image width and height on the page - to lock the image aspect ratio, click the open lock icon • an alternative text that is printed instead of the image when the image cannot be displayed • the image alignment

Page 47 XWiki Standard 9.8.1 User Guide

You can resize the image inside the editing area by dragging the resize handlers or move it around using the drag & drop handlers.

Create and Edit Tables

To create an empty table, place the caret where you would like the new table to be inserted and click the menu. In the opened dialog you can specify the table properties:

Page 48 XWiki Standard 9.8.1 User Guide

• the number of rows and columns the new table should have • the width and height of the table • whether the table header is the first row, first column or both • the border size • the cell padding and spacing • the table alignment: Left, Center, Right or none • the table caption • the table summary

Advanced users have the option to associate an ID and a CSS class for styling the table.

Page 49 XWiki Standard 9.8.1 User Guide

After hitting "Ok" you should see the table in the editing area and you can navigate from cell to cell using the arrow keys.

Page 50 XWiki Standard 9.8.1 User Guide

Unlike the old Wysiwyg editor, the CKEditor allows to insert a table inside another table. If you need a new column, you can insert one before or after an existing column. Just place the caret in one of the cells from the reference column, right-click your mouse, hover the "Column" option and choose the appropriate action from the menu. You can also delete columns in the same manner: place the caret in one of the cells from the column to be deleted and choose "Delete Columns" from the "Column" menu.

Page 51 XWiki Standard 9.8.1 User Guide

Inserting a new row or a cell is much like inserting a new column. First you choose a reference row / cell, then you choose the appropriate option from the "Row" / "Cell" menu.

The "Cell" menu also has options for merging or splitting cells and for editing cell properties including: • width and height (in pixels or percents) • horizontal and vertical alignment • cell type: data or header • rows and columns span • background and border color • whether to enable word wrap or not

Page 52 XWiki Standard 9.8.1 User Guide

To delete a table or edit its properties, place the caret in any of its cells, right-click your mouse and choose the "Delete Table" or the "Table Properties" option respectively from the menu. Insert and Edit Macros

A macro is a piece of code that you can reuse in your pages in order to do common things like displaying an information box, a table of contents or the avatar for a specific user. Start by clicking the menu - you should see a dialog with all the available macros, but you can also filter then by category: Content, Development, Formatting, Internal, Navigation, Social. Each macro has a short description that will give you a hint about what it does. To access an exhaustive list of XWiki macros, please refer to the "Related Pages" section.

Page 53 XWiki Standard 9.8.1 User Guide

Supposing you wish to use the "Document Tree" macro, just click on "Select" - parameters control the behavior and the output of a macro and some of them are mandatory. Next, click on "Submit" to insert the macro,

Page 54 XWiki Standard 9.8.1 User Guide

then save the page in order to load the tree.

Page 55 XWiki Standard 9.8.1 User Guide

Starting with version 9.1, inserting a block-level macro in-line will split the paragraph, thus avoiding the "macro cannot be used inline" error. Also, starting with version 9.2 you can speed up macro insertion by placing dedicated insert buttons on the tool bar. To learn how to do this, please refer to this link. Inserting Symbols

In order to insert symbols or special characters (accented characters, trademark, currency symbol etc.): • place the caret where you would like the symbol to be inserted on or select the text that you would like to be replaced by the inserted symbol • click on the button on the toolbar • click on the symbol you wish to insert

Page 56 XWiki Standard 9.8.1 User Guide

The symbol picker automatically closes after you choose a symbol. The caret is placed after the inserted symbol so you can open the symbol picker again if you wish to insert more symbols. Import Office Content

The editor allows you to import content from office applications like Open Office Writer or Microsoft Word by clicking the button.

Page 57 XWiki Standard 9.8.1 User Guide

The "Filter styles" check box means that if you want the pasted text to look as much as possible as in your office application, then you should leave it unchecked. Otherwise, if you care only about the content and not the text styles then check "Filter Styles" which will result in a much cleaner document but the result may look different than in your office application. The "Use the Office Document Viewer" option allows you to import an Office file using the {{office /}} macro. This is useful if you don't plan to edit the content of the Office file after the import or in case you don't want to mix the content of the Office file with the one from the wiki page. While the file is being processed (uploaded in XWiki and its content converted into XWiki syntax) you should see a "Importing Office File" message in the editing area.

If the import is successful, you will see a confirmation message and the content of the Office file will be rendered in the editing area.

Page 58 XWiki Standard 9.8.1 User Guide

Paste Office Content

The button of the CKEditor allows to copy the content of Microsoft Word or Excel documents and paste it to the rich text area while preserving the structure and styles that were present in the original text. Just paste what you have copied from the office application in the text area that you can see on the opened dialog and click the "Ok" button.

Page 59 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • Simple and Advanced Editing • Pages Overview • Office Importer Application • Editing Modes • Developer Guide • XWiki Velocity Macros Overview • XWiki Rendering Macros in Java Overview • XWiki Rendering Macros Overview • XWiki API Reference • Wysiwyg Module • Velocity Macro • Programming Overview • Other XWiki Macros • ID Macro • Admin Guide • Customization Overview • CKEditor Configuration Nested Page Actions The Page Administration Menu

The page administration menu is available in the "More Actions" menu under "Manage" by clicking on the button and it has 2 versions depending on the page type. If the page is nested (non-terminal) the "Manage" section has the following 4 items: • Administer Page • Copy • Move / Rename • Delete If the page is terminal (non-nested), the option "Administer Page" is replaced by "Administer Parent".

Page 60 XWiki Standard 9.8.1 User Guide

Nested Page (Non-Terminal) Non-Nested Page (Terminal)

Administer Page

The "Administer Page" menu item redirects to the nested page's preferences page that resembles the old space preferences page ("WebPreferences"). The vertical menu on the left allows you to: • choose the skin, color theme and icon theme to use • decide which panel column to display and the width of each column • globally activate or deactivate the display of history, attachments, annotations, comments and page information • customize the panels layout using the Panel List • set the permissions scheme which can apply either on the current page only or on all its children

Page 61 XWiki Standard 9.8.1 User Guide

Administer Parent

The "Administer Parent" UI is the same as "Administer Page" - the only difference is that you are actually customizing the preferences of the parent, not of the page itself.

Copy Page Copy a Terminal Page

For a terminal page, the copy form has 4 elements: • Source - the breadcrumb of the page that is going to be copied

Page 62 XWiki Standard 9.8.1 User Guide

• Copy Title - the title of the target page; by default, this field copies the name of the source, but you can easily change it • Location - the location of the target page; by default the path is the same as for the source • Copy as Terminal Page - leave this option unchecked if you want to create a nested page instead of a terminal one

To change the target page location: • click on the blue editing pen icon and select the wiki, parent and name; just like when creating a new page, you may leave the "Parent" field empty in order to create a top-level page, but only provided you leave Copy as Terminal Page unchecked.

Page 63 XWiki Standard 9.8.1 User Guide

• click the blue hierarchy icon and select the wiki and parent from the page tree or search for them using the integrated finder.

Copy a Nested Page

For a nested page, the copy form has an extra option, "Preserve children", allowing you to copy the entire page hierarchy.

Page 64 XWiki Standard 9.8.1 User Guide

To load the children livetable, click on "[x] children".

In case its previous value was equal to the old page name, the page title is updated when copying a nested page in order to reflect the new page name. If the page has multiple translations, you can either copy all of them or you may select a particular one.

Page 65 XWiki Standard 9.8.1 User Guide

The copy process is asynchronous and it is performed in a background thread, when triggered from the UI. After clicking on "Copy" (for both nested and terminal pages), you will be redirected to a status page where you can see the options that have been selected, as well as the progress of the operation.

If successful, advanced users have access to the copy log from which they can navigate to the target page using the breadcrumbs.

Page 66 XWiki Standard 9.8.1 User Guide

Rename Page

Before renaming a page, please be aware of the following limitations: • backlinks have to be enabled - they are by default but if you have deactivated them, the rename operation will not update backlinks. • backlinks located in XWiki objects and translated content are not currently renamed. • backlinks are saved when a page is saved but it is possible for this operation to fail, especially on a clean database. In this special case, you can log in as administrator and call $xwiki.refreshLinks() in a wiki page in order to update all links. Rename a Terminal Page

When renaming a terminal page, the form displays the following elements: • Source - the breadcrumb of the page that is going to be renamed. • Update Links - by checking this option, all the links pointing to the source page will be updated in order to point to the target page. To load a livetable with the wiki pages having backlinks to the source page, simply click on [x] incoming links. • Create an Automatic Redirect - this option is useful when you have external links like bookmarks that point to the source page and, by selecting it, these links will redirect to the target page.

Page 67 XWiki Standard 9.8.1 User Guide

• New Title - the title of the target page; by default, this field copies the name of the source, but you may change it • New Location - the location of the target page; by default the path is the same as for the source • Rename as Terminal Page - leave this option unchecked if you want to create a nested page instead of a terminal one

Page 68 XWiki Standard 9.8.1 User Guide

To change the target page location: • click on the blue editing pen icon and select the wiki, parent and name; just like when creating a new page, you may leave the "Parent" field empty in order to create a top-level page, but only provided you leave Rename as Terminal Page unchecked.

Page 69 XWiki Standard 9.8.1 User Guide

• click the blue hierarchy icon and select the wiki and parent from the page tree or search for them using the integrated finder.

Page 70 XWiki Standard 9.8.1 User Guide

Rename a Nested Page

For a nested page, the copy form has an extra option, "Preserve children", allowing you to rename the entire page hierarchy. If left unchecked, all pages having this page as parent will become orphaned.

Page 71 XWiki Standard 9.8.1 User Guide

To load the children livetable, click on "[x] child pages". When renaming a nested page, the page title is updated in order to reflect the new page name, provided its previous value was equal to the old page name. Similarly to the copy operation, the rename process is also asynchronous and it is performed in a background thread, when triggered from the UI. After clicking on "Rename" (for both nested and terminal pages), you will be redirected to a status page where you can see the options that have been selected, as well as the progress of the operation.

Page 72 XWiki Standard 9.8.1 User Guide

Provided the operation is successful, advanced users have access to the rename log from which they can navigate to the target page using the breadcrumbs.

Delete Page

If the page you are about to delete is a terminal page, you will be asked to confirm the operation.

Page 73 XWiki Standard 9.8.1 User Guide

For nested pages, there is an extra "Affect children ([Number_Of_Children])" option which allows you to delete the entire hierarchy. If left unchecked, all pages having this page as parent will become orphaned.

On the other hand, if the only child is the "WebPreferences" page, the "Affect children ([Number_Of_Children])" option is checked by default.

In order to list the children that might be affected, the delete UI uses the "Title" and "Location" columns. The reason why the "Title" column is not filterable is because XWiki doesn't currently support filtering on page title. Finally, in case there are pages having backlinks to the one you wish to delete, you will be warned of the fact that those links will point to an empty page, unless you manually remove the links.

After clicking on "Delete", you will see a progress bar and a confirmation message, provided there were no errors.

To recover the entire hierarchy, please refer to the Page Index documentation where explained how to restore a batch of deleted pages.

Page 74 XWiki Standard 9.8.1 User Guide

System and Extension pages are now protected against accidental deletion because when you try to delete such pages, XWiki will ask you to confirm the operation, and list all concerned pages.

More Actions Menu - "Actions" Section

The "Actions" section contains a list of items you are already familiar with:

• Export allows exporting the current page in various formats like PDF, RTF, ODF, HTML or XAR • Annotate allows accessing the page annotations • Print Preview • In order to Share the page by email either as a link or inline in the message, you need to have a SMTP server correctly configured.

Page 75 XWiki Standard 9.8.1 User Guide

View Page Source

View Source displays the wiki source code of the current page which has been improved to look nicer and have proper line numbers that support Syntax highlighting and linking.

Moreover, you can enable the blame view by clicking the "Show last authors" button. You will notice that each line of the page content is annotated with the last author that modified it and the revision in which the modification was introduced. The blame view also works when viewing the source of a page revision (other than the latest one) so it can be accessed at any point in the history of the page. Hovering the avatar and the revision number will display the author's name and the date and time when the line was changed. The fact that multiple lines are grouped is in order to express that they were all modified within the same revision i.e. by the same author and at the same date.

Page 76 XWiki Standard 9.8.1 User Guide

Finally, clicking on any revision number will display a diff with all the modifications performed in that particular change by its author.

Page 77 XWiki Standard 9.8.1 User Guide

More Actions Menu - "Viewers" Section

The "Viewers" section also varies depending on the page type. For a terminal page, you have a "Siblings" option, whereas for nested pages you have a "Children" option.

Page 78 XWiki Standard 9.8.1 User Guide

Nested Page (Non-Terminal) Non-Nested Page (Terminal)

• Children - displays the children of the current nested page.

• Siblings - replaces the old "space index" feature and displays the pages having the same parent as the current terminal page.

Page 79 XWiki Standard 9.8.1 User Guide

Both "Children" and "Siblings" livetables display the "Title" and "Location" columns which are computed using the page breadcrumb. The reason why the "Title" column is not filterable is because XWiki doesn't currently support filtering on the page title. • Comments allows accessing the page comments • Attachments redirects to the files attached to the current page • History redirects to the page versions • Information displays the backlinks and included pages. The old "Parent" and "Children" sections were removed because there are already dedicated menu items available.

You can also access the page backlinks and included pages by scrolling down to the bottom of the page and clicking on the "Information" tab.

Page 80 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Wiki Pages • Share Page by Email • Pages Overview • Page Comments • Index Application • Dashboard Application • Annotations Application • Activity Stream • Developer Guide • XWiki JavaScript API • The "xwikicomments" Table • Document Tree Macro • Comment Macro • Children Macro • Admin Guide • Set the Page Access Rights • Panels Application • Configure Annotations • Applications Panel • App Within Minutes Application Share Page by Email

To share a wiki page by email, click the button and choose the "Share by email" option in the "Actions" section.

Page 81 XWiki Standard 9.8.1 User Guide

In order for the feature to work correctly, you will need to configure a SMTP server as described in the dedicated documentation page. You may choose to send the page: • As a link • Inline in the message In the "Send to" box, you can either specify an email address or an username as long as the user has an email address specified in his profile page. The suggest as you type feature will help you through.

Page 82 XWiki Standard 9.8.1 User Guide

The User Picker is used by default by all the XCLASS properties of type "List of Users" to display the user avatar, first name and last name. Also, it allows adding multiple users in one step.

Page 83 XWiki Standard 9.8.1 User Guide

Moreover, when you are in a sub-wiki, the "Send to" dialog displays a scope toggle that allows you to control whether the suggested users are local or global.

If you are in local scope, the icon will be , whereas in global scope, the icon will be . In case you want to remove an user from the list, just hover it and click on the red "X" in the top right corner.

Page 84 XWiki Standard 9.8.1 User Guide

To remove all users at once, just click on the "Clear selection" link. You can also customize the message you want to send and it is also possible for you to receive a copy if you select the "Send me a copy" check-box. Finally, click on "Send" and you are done. Additionally, you may include the shared page in your favorites list, so that you get a notification message each time someone modifies it.

Related Pages

• User Guide • Tags Application • Simple and Advanced Editing • Pages Overview • Page Attachments • Nested Page Actions • Admin Guide • XWiki Mail Features • Customization Overview Page Comments • Create or Reply to a Comment • Edit or Delete a Comment Users with the comment right can leave comments on pages. This way even if you don't have edit rights but you have comment rights, you may still provide feedback. Create or Reply to a Comment

The comments area is located in the first tab at the bottom of the page. To add a comment, simply enter the text then click on "Add comment".

Page 85 XWiki Standard 9.8.1 User Guide

You can also click the button and click on "Comments" in the "Viewers" section.

To reply to a comment, click the "Reply" icon.

Page 86 XWiki Standard 9.8.1 User Guide

In addition to plain text you may also use XWiki syntax in the content.

To preview your comment click on the "Preview" button after you have entered the content.

Should you want to go back and edit your comment further, click "Back". To discard the comment altogether click "Cancel". If you are ready to submit your comment click on "Add Comment".

Edit or Delete a Comment In order to be able to edit or delete your comments, you need to have edit rights on the page containing them. Also, only an administrator has the privileges to edit or delete other users' comments, whereas normal users can only perform these actions on their own comments. You may change the comment you made at a later time by clicking the "Edit" pen icon.

You may also create a permanent link to point to a specific comment by clicking on the "Permalink"* icon.

Click on the "Go to permalink" button to view the comment in a separate page or on the "Hide" button to go back.

Page 87 XWiki Standard 9.8.1 User Guide

To delete a comment hover it then click on the red "X" icon and confirm.

Related Pages

• User Guide • Pages Overview • Nested Page Actions • Annotations Application • Developer Guide • XWiki JavaScript API • The "xwikicomments" Table • Comment Macro • Admin Guide • Configure Annotations Page Attachments

To attach a file, click the button then choose "Attachments" in the "Viewers" section

Page 88 XWiki Standard 9.8.1 User Guide

or scroll down to the bottom of the page and click on the "Attachments" tab.

Next, click the "Browse" button, select the file from your computer and click "Open". At this point you may choose to attach another file. Once you are done adding all items click the "Attach" button.

Page 89 XWiki Standard 9.8.1 User Guide

You will now see in the same tab a list of the files you have attached with: • a thumbnail preview for image attachments • an icon for non-image files depending on their extension (the icons are using the configured Icon Theme)

Non-ASCII characters are not filtered from the file name when uploading an attachment which means that the name of the attachment can contain special characters. Starting withe version 9.0 XWiki added support for attachments bigger than 2GB.

Page 90 XWiki Standard 9.8.1 User Guide

The File Upload widget provides an interactive upload User Interface in order to enhance the HTML input elements of type file. To hide the upload related information, just click the "Hide Upload Status" button. To learn more about the configuration options, go the "File Upload Widget" documentation page which is listed in the "Related Pages" section.

Related Pages

• User Guide • Tags Application • Simple and Advanced Editing • Share Page by Email • Pages Overview • Developer Guide • Zip Explorer Plugin • XWiki Widgets Overview • HTML5 File Upload Widget • Attachment Selector Macro • Admin Guide • WebDAV • Import - Export Application • Attach Large Files Page History

To see the previous versions of a page, click on the button in the actions bar, then on "History" in the "Viewers" section

Page 91 XWiki Standard 9.8.1 User Guide

or scroll to the bottom of the page and click on the "History" tab.

Page 92 XWiki Standard 9.8.1 User Guide

The page history displays all the page versions, the author the date of each change, along with a summary which displays the reason why the page was modified. Besides listing the page versions, the history page can be used to perform other actions as well: • Compare any two versions. • Set an older version as the current version by clicking the "Rollback" provided the user has edit rights on the page. • Delete a version from the history provided the user has administration rights. • Delete a selected version range. • See, compare or revert to the standard version of a document i.e. the one coming from the installed extension. In our case the standard version is named "Version coming from extension XWiki Platform - Distribution - Flavor - Common 9.8.1". By default, minor edits do not appear in the page history. The option "Show minor edits" lists all versions, including minor ones. Compare Two Page Versions

In order to compare 2 versions, you need to check one of the radio buttons corresponding to the version from which you want to start the comparison, located in the "From" column. You will then need to check the radio button corresponding to the version you want to compare the previously selected version against, located in the "To" column. You may choose to include minor edits in the comparison. After selecting the 2 versions you wish to compare, click on the "Compare selected versions" button. Depending on the changes you have made, you will get a result similar to the image below:

Page 93 XWiki Standard 9.8.1 User Guide

Page 94 XWiki Standard 9.8.1 User Guide

The diff "Summary" displays the type of entity that was modified - "Object", "Page property" (content, default language etc.), "Attachments" and so on - and the number of elements added, removed or modified. In case there are several entities modified, click on each of them to display more details and to access the list of differences. With red you will the content that has been removed since the earlier version wheres the new content will be colored in green. The compared versions now clickable so that you can load the page at that specific revision. In order to know that you are in fact seeing a page revision other than its last, simply take a look at the text below the page title.

Page Revision (other than its last) Last Page Revision

Related Pages

• User Guide • Common Edit Actions • Developer Guide • The "xwikircs" Table • Diff Module Page Export Formats • PDF Export • Export Several Pages into the Same PDF • URL Parameters for the PDF Export • The PDF Options Panel • ODT Export • RTF Export • XAR Export • URL Parameters for the XAR Export • HTML Export • URL Parameters for the HTML Export

XWiki offers the possibility to export a single wiki page into several formats which are available by clicking on the button in the actions bar, then on "Export".

Page 95 XWiki Standard 9.8.1 User Guide

PDF Export

To export a page as PDF, click on the button in the page's actions bar, then on "Export" and select the "Export as PDF" option under "Office Formats"

Page 96 XWiki Standard 9.8.1 User Guide

or type the following URL:ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=pdf Export Several Pages into the Same PDF

To export several pages into the same PDF, type the following URL: ServerName/xwiki/bin/export/WikiSpace/WikiPage? format=pdf&pages=WikiSpace.WikiPage&pages=Sandbox.ProjectTest &pages=Managers.Leaders&pages=XWiki.MyDashboard Note that if you are using the pages parameter to export several pages, the current wiki page specified in the URL won't be exported, so you will have to specify it again with &pages=WikiSpace.WikiPage. URL Parameters for the PDF Export • pages: you can use it several times, each parameter representing a page to be exported. • includechilds: its numeric value specifies the depth of children pages to include in the PDF export; for instance, if you type &includechilds=2 in the URL, you will include all the children pages of the page to export (all the pages having this page as parent) and all the children's children. • includelinks: its numeric value specifies the depth of linked pages to include in the PDF export; for example &includelinks=2 will include all the pages linked from the page to export and the links in those pages. • pagebreaks: if its value is set to 1 then a page break will be inserted between all the exported pages. • comments: if its value is set to 1 then the comments will also be exported. • attachments: if its value is set to 1 then the attached images will also be exported. The PDF Options Panel

The "PDF Export Options" panel is available when exporting a page as PDF via the "Export" menu. This panel allows you to configure the "Cover", "Table of Contents", "Comments" and "Image Attachments" parameters which were previously available only as query string parameters to the URL or by overriding the PDF templates (as described in the documentation page about the customization of the export look & feel). Moreover, you may select the page translation to export as well as disable the display of header and footer (usually the page name and date).

Page 97 XWiki Standard 9.8.1 User Guide

Page 98 XWiki Standard 9.8.1 User Guide

ODT Export

If you configure the wiki to work with an Office server like Open Office or Libre Office, you will have a dedicated option available in the "Export" menu, under "Office Formats". By default, only the "ODT Export" will be exposed, but it is possible to export a page to other office formats supported by the Office server, like the Microsoft Word proprietary .DOC format, by typing the following URL:ServerName/xwiki/bin/export/Main/WebHome?format=doc. RTF Export

The RTF export works just like the PDF export, the only difference being in the format you specify in the URL: ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=rtf XAR Export

This option allows you to export pages in the internal XML format used by XWiki. To do this, click on the button in the page's actions bar, then on "Export" and select the "Export as XAR" option under "Other Formats" or type the following URL: ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=xar

In case the exported page is nested and has children, you may choose to export them too. URL Parameters for the XAR Export • pages: you can use it several times, each parameter representing a page to be exported. Example: ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=xar&pages=WikiSpace.WikiPage&pages=Sandbox.ProjectTest &pages=Managers.Leaders&pages=XWiki.MyDashboard

Page 99 XWiki Standard 9.8.1 User Guide

Note that if you are using the pages parameter to export several pages, the current wiki page specified in the URL won't be exported, so you will have to specify it again with &pages=WikiSpace.WikiPage. • history: if set to true (&history=true), you will also export the history of the page. • backup: specifies if the XWiki preserves the page author of each page when reimporting it into a XWiki instance. • author: if defined, specifies the author's name in the XAR export; this name can be viewed when reimporting the page into a XWiki instance. • description: if defined, a description will be added to the XAR export; this description can be viewed when reimporting the page into a XWiki instance. • license: if defined, specifies the license to the XAR export which can be viewed when reimporting the page into a XWiki instance. • version: if defined, specifies the version of the export.

The URL format allows exporting: • a full space: /xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=Main.%25 • a full wiki: /xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=%25.%25 • any list of pages matching a pattern: /xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=%25.%25Home Note that the character % has to be converted in %25 in an URL. HTML Export

This option allows you to export wiki pages as static HTML pages which are independent from the XWiki engine. All pages are exported in view mode so that you won't need a web server to access them.

To export a page as HTML, click on the button in the page's actions bar, then on "Export" and select the "Export as HTML" option under "Other Formats" or type the following URL: ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=html Similarly to the XAR export, it is now possible to export a list of selected children along with the current nested page. The exported pages are now located in directories named after the parent pages in which they are located. In addition, a basic HTML index page named index.html is generated at the root listing and linking to all exported pages.

URL Parameters for the HTML Export • name: the name of the generated .zip file. • description: the comment in the generated .zip file. • pages: you can use it several times, each parameter representing a page to be exported; for instance if you want to export all the pages from a space of a certain sub-wiki, you will type the following URL: ServerName/xwiki/bin/export/WikiSpace/WikiPage?format=html&pages=wikiid:pageFullNamePattern • wikiid: the name of the wiki from where to get the wiki pages • pageFullNamePatern: the full name pattern of the page based on HQL "LIKE" comparator. Note that the character % has to be converted in %25 in an URL.

Page 100 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Office Importer Application • Developer Guide • PDF Viewer Macro • Office Macro • Customize the Look and Feel of the PDF and RTF Export • Admin Guide • Import - Export Application • Configure the Office Server • Admin Tools Application Internationalization • Switch to Another Language • Set the Default and Supported Languages • Edit a Translation XWiki can be set-up to support one or various languages. XWiki Standard now supports 38 languages: • Arabic (ar) • Brazilian Portuguese (pt_BR) • Bulgarian (bg) • Cambodian (km) • Catalan (ca) • Chinese, Simplified (zh) • Chinese, Traditional (zh_TW) • Croatian (hr) • Czech (cs) • Danish (da) • Dutch (nl) • English (en) • French (fr) • Galician (gl) • German (de) • Greek (el) • Hindi (hi) • Hungarian (hu) • Indonesian (id) • Italian (it) • Kannada (kn) • Korean (ko) • Latvian (lv) • Lithuanian (ln) • Norwegian (no) • Persian (fa) • Polish (pl) • Portuguese (pt) • Romanian (ro) • Russian (ru) • Slovak (sk) • Slovenian (sl) • Spanish (es) • Swedish (sv) • Turkish (tr) • Ukrainian (uk) • Vietnamese (vi)

Switch to Another Language

By default, the language displayed will be the one coming from the browser. However, on every page you can choose to switch between the different existing translations as follows:

Page 101 XWiki Standard 9.8.1 User Guide

• click the button in the upper right corner which will open the drawer menu • click on "Languages" to expand the list of available translations, then on the translation you wish to load

Another possibility is to suffix URLs with language=<2-letter language code>. Once you click on a language, you are forcing it and thus all pages which have translations in that language will display these translations by default when you access them. Set the Default and Supported Languages

To define the default language or to set the supported ones you need to have administration rights. For more details about the process or about the way of forcing a single language, go to the "Customize the Language and Timezone Settings" documentation page.

Page 102 XWiki Standard 9.8.1 User Guide

Edit a Translation

You may edit the page in the default language that is indicated in the "Page Information" panel as shown below:

You can there see the current language you are performing translations in and the alternative languages you may translate your page to. These are the languages you have previously set up in the wiki administration page.

In order to translate your page in a different language, click on one of the languages (e.g. Fr). As a result, you will see the wiki interface translated in that language.

Page 103 XWiki Standard 9.8.1 User Guide

Once you save a page in one of the supported languages, that page becomes the original page and the language it is written in becomes the default language. All page translations share the same set of XWiki objects. As a result, it is impossible to have different objects (like tags, access rights, comments etc.) in different translations.

Related Pages

• User Guide • Search Application • Developer Guide • Localization Module • Customize the Keyboard Shortcuts • Admin Guide • Customize the Language and Timezone Settings • App Within Minutes Application Activity Stream

The Activity Stream feature helps you keep better track of what is happening on the wiki and is available by default on the wiki home page. The listed events include:

• page creation • page edit • page delete • comments and annotations events • attachment events • the posts shared with other users via the {{shareMessage /}} macro. More information about message sharing and the way you can follow other users' posts is available in the documentation page about the "User Status".

Page 104 XWiki Standard 9.8.1 User Guide

On the main wiki, the Activity Stream displays the events from other sub-wikis, provided the current user has view rights on the documents. Also, the sub-wiki pretty name is displayed next to the page name. By hovering any event listed in the Activity Stream, you will notice an arrow icon in the top right corner. If you click on it you will be able to see an expanded list containing the changes performed by the user on that particular page: the edits (including the object changes) or the recently added comments, annotations and attachments.

Page 105 XWiki Standard 9.8.1 User Guide

In order to see the new comment, annotation or the name of the attached file, hover the corresponding sub-event and click on the arrow icon in the top right corner. If you want to see the changes made on the content or the objects of a page, a diff is available by clicking on the "see changes" link next to the corresponding event.

Page 106 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • View the List of Joined Sub-Wikis • Users and Groups Overview • User Status • User Profile • User Preferences • Notifications Application • Nested Page Actions • Dashboard Application • Developer Guide • XWiki Platform Plugins Overview • Event Stream Module • Activity Stream Plugin • Activity Macro • Admin Guide • Enable / Disable the Message Stream Keyboard Shortcuts

Keyboard shortcuts help you save time since you don't have to take your hands off the keyboard in order to use the mouse. • View Mode • Edit • Show • Actions • Edit and Inline Mode • Preview Mode • Annotations XWiki keyboard shortcuts are powered by openjs.org shortcut library. View Mode Keyboard shortcuts are only available to advanced users, preventing simple users to get unexpected behavior when pressing keyboard keys by mistake. Edit e Edit the page using the default edition mode k Edit the page in wiki edition mode g Edit the page using the WYSIWYG editor f Inline Form r Edit page access rights o Edit page objects s Edit class

Show c Go to page comments a Go to page attachments h Go to page history d View page wiki code

Actions F2 Rename page Delete Delete page

Edit and Inline Mode Keyboard shortcuts are not available from the wysiwyg edit mode (since the WYSIWYG editor grabs all the key pressed events)

Page 107 XWiki Standard 9.8.1 User Guide

+ c Cancel edition + p Preview the page without saving + + s Save and continue to edit the page + s Save and view the page

Preview Mode + c Cancel edition + b Back to the edition + + s Save and continue to edit the page + s Save and view the page

Annotations + m Annotate a piece of text

Related Pages

• Developer Guide • Modal Popup Widget • Customize the Keyboard Shortcuts XWiki Applications Overview

An application is a self-contained set of XWiki pages that offers a powerful way to create advanced content within wiki pages. These pages can be exported into a single archive file named a XAR which can be imported again into other wikis. XWiki Bundled Applications

Administration Application Allows to administrate an XWiki Standard instance.

Annotations Application Annotation User Interface.

Application Within Minutes Helps you create collaborative web applications within minutes, based on XWiki's powerful structured data management system.

Dashboard Application Provides Wiki and User Dashboards.

Extension Manager Application Used to install, update or remove extensions in/from the wiki.

FAQ Application Allows to create and manage questions and answers for frequently asked questions.

File Manager Application Application for managing a hierarchy of folders and files that embeds viewers for many known file types, such as Office and PDF.

Flamingo Color Theme Application Allow to easily customize skins based on Flamingo and live preview the results.

Flash Messages Application Allows to create Flash messages aiming at one or multiple XWiki groups.

Forum Application

Page 108 XWiki Standard 9.8.1 User Guide

Allows to create multiple forums and topics where users can vote, comment and answer to, as well as to moderate and flag comments, answers and topics.

Full Calendar Macro Displays a Calendar in Javascript and allows to get events from XWiki pages.

Help Center Application Application that showcases the main XWiki features through demo content.

Ideas Application Allows to create, vote for and manage the suggestions and improvements proposed by the members of your team.

Import - Export Application Allows to export one or several pages from your wiki into a XAR file or to import one or several pages from an existing XAR file in order to move wiki pages from one instance to another or to perform a lightweight backup of your wiki.

Index Application Displays an index of all documents, attachments, orphans, deleted items in the wiki.

Invitation Application Allows users to send emails, inviting friends and colleagues to join a wiki.

JWPlayer Macro Allows to play media files using JW Player.

Link Checker Application Displays states of external links found in the wiki.

Logging Application An application to review and manipulate XWiki logs.

Mail Application Application for configuring emails and for managing their status.

Map Macro Displays a geographical map provided by the Google Maps service, with which users can interact.

Meeting Application Allows to organize meetings, invite participants and also see the past meetings or the ones scheduled in the future in a calendar view.

Menu Application Provides an easy way of creating navigation menus that you can choose to display either horizontally as a top bar below the page header or vertically in a side panel.

Nested Pages Migrator Application Helper for converting terminal pages into Nested Pages.

Notes Application Helps the user to see all the notes (pages) created in an XWiki location.

Notifications Application Allows to subscribe to wiki pages or even whole wikis and thus receive realtime alerts and email notifications whenever a modification occurs.

Office Importer Application

Page 109 XWiki Standard 9.8.1 User Guide

Imports office documents into wiki pages.

Panels Applications Provides placeholders to put content located or right of the page's content.

PDFViewer Macro Macro adapted and packaged in order to be able to load PDF attachments directly into the content of an XWiki page.

Scheduler Application Allows scheduling jobs.

Solr Search Application Allows searching on the wiki using Apache Solr.

Skin Application Allows to edit an existing skin.

XWiki SVN Application Allows concurrent development on multiple servers and simplifies publishing XWiki applications to SVN.

Tag Application Tag pages with keywords and navigate your wiki using these keywords.

User Profile Application Displays user profiles and controls the user preferences, dashboard, notifications.

User Directory Application Displays a directory of all users in the wiki.

Syntax Highlighting Application Provides CodeMirror based syntax highlighting for Velocity, Groovy, JavaScript, CSS, Python, HTML and XWiki Macros (Experimental).

Tour Application Allows to create guided tours for any wiki page in order to better familiarize users with the most relevant features on that page.

Webdav Application Allows editing attachments through WebDAV.

Wiki Application An XWiki application for creating and managing wikis.

Wiki Flavor Application Allow to manage a list of flavors for the creation of new wikis.

Wiki Macro Bridge Application Allows creating XWiki macros through wiki pages.

XPoll Application Provides a Doodle-like UI for easy voting, without requiring edit rights on the page. Annotations Application • Create Annotations • Edit Annotations • Reply to an Annotation • Display Annotations

Page 110 XWiki Standard 9.8.1 User Guide

• Filter Annotations by Author • Delete Annotations • Configure Annotations The Annotations Application allows users to annotate text in an XWiki document. Create Annotations

To annotate a piece of text you just need to select it, hit Ctrl + M or Meta + M and enter the text you want to associate with the selection in the dialog window. Next, click on "Add annotation" and you are done.

Edit Annotations In order to be able to edit your annotations, you need to have edit rights on the page containing them. Also, only an administrator has the privileges to edit other users' annotations, whereas normal users can only edit their own. There are two ways of editing an annotation: • Straight from the page by clicking the annotation, then on the yellow pen icon. Once you are done with the changes, click on "Update".

• In the "Comments" tab, click the pen icon, change the text, then click on "Save comment".

Page 111 XWiki Standard 9.8.1 User Guide

Reply to an Annotation

Annotations have been merged with comments by default which means that you can reply to an annotation. This is the reason why the "Annotations" tab has been removed and annotations are displayed in the "Comments" tab. To add a comment to an annotation, click on the "Comments" tab at the bottom of the page, then on the "Reply" icon.

In addition to plain text you may also use the XWiki syntax.

To preview your comment click on the "Preview" button after you have entered the content.

To discard the comment click on "Cancel" or, if you are ready to submit it, click on "Add Comment".

Page 112 XWiki Standard 9.8.1 User Guide

More details about the steps to create a permanent link or to edit/delete your reply are available in the documentation page about "Comments". Display Annotations

By default annotations are not shown within the page. In order to display the annotated items highlighted, click the button and choose "Annotate" in the "Actions" section,

then check the "Show annotations" option. The annotation for a text item will appear when hovering the yellow icon next to it.

Page 113 XWiki Standard 9.8.1 User Guide

By default, annotations are listed in the "Comments" tab because they have been merged. In order to display all the replies to a given annotation, just hover the yellow icon next to the annotated text and click on "See thread". You will be redirected to the bottom of the page where the corresponding annotation will be highlighted.

Filter Annotations by Author

Filtering annotations by user means you will be able to see the annotations authored by a specific user. To do so, click the

button and choose "Annotate", then check "Show annotations". Next, click the "Refine the display criteria" link and check the user for whom you want to see the annotations. By doing so, only the annotations of this specific user will be highlighted in the page content.

Delete Annotations To be able to delete your annotations, you need to have edit rights on the page containing them. Also, only an administrator has the privileges to delete other users' annotations, whereas normal users can only delete their own. There are two ways of deleting an annotation: • hover the annotation and click on the red X button

• go to the "Comments" tab at the bottom of the page and click on the X button next to the annotation

Page 114 XWiki Standard 9.8.1 User Guide

Deleting an annotation won't remove the associated replies. Configure Annotations

Annotations can be customized from the wiki administration page, provided you log in with an user having administration rights. To know more, check the "Configure Annotations" documentation page listed in the "Related Pages" section.

Related Pages

• User Guide • XWiki Applications Overview • Pages Overview • Page Comments • Nested Page Actions • Developer Guide • XWiki JavaScript API • The "xwikicomments" Table • Comment Macro • Admin Guide • Configure Annotations Dashboard Application • Edit the Page Containing the Dashboard • Gadgets • Insert a Gadget • Edit the Parameters of a Gadget • Delete a Gadget • Columns • Add a Column • Create a Dashboard • User Dashboards • Access Your Personal Dashboard • Gadgets • Add a Gadget • Edit a Gadget • Remove a Gadget • Columns • Insert a Column • Display a Personal Dashboard Instead of the Default One A dashboard allows you to customize pages by adding gadgets and columns. XWiki Standard comes with a visual editor available by clicking on the "Dashboard" link in the "Applications" panel on the left.

Page 115 XWiki Standard 9.8.1 User Guide

Edit the Page Containing the Dashboard

In order for the edit menu to have the "Inline form" option, you will need to make sure you are an advanced user. In Inline mode, you will notice 2 extra buttons: "Add Gadget" and "Add Column". Also, when hovering a gadget, the possible actions, edit and delete, are displayed in the header.

Gadgets Insert a Gadget

To add a gadget, edit the home page of the "Dashboard" space in "Inline" mode and click the "Add Gadget" button. You will then see a window with all the available macros, each of them containing a short description about its usability. To improve the user experience, the Gadget Wizard has been updated to use the new Macro Wizard from the CKEditor. Search for the macro you wish to insert from one of the predefined categories (for instance the "Info Message" macro in the "Formatting" category), then click on "Select".

Page 116 XWiki Standard 9.8.1 User Guide

Fill in the mandatory sections and click on "Submit.

Page 117 XWiki Standard 9.8.1 User Guide

The gadget will be added at the end of the last column,

but you can drag it and move it around to different columns of the dashboard.

Page 118 XWiki Standard 9.8.1 User Guide

Edit the Parameters of a Gadget

To edit the parameters of a gadget, edit the home page of the "Dashboard" space in Inline mode, hover the title bar of the gadget and click on the yellow pen icon in the top right corner.

You will then see a wizard similar to the one used for adding the gadget. The new parameters will be automatically saved when clicking on the "Submit" button and the gadget will be placed again at the end of the last column. Advanced users can also use the Objects mode for editing the parameters of a gadget. The advantage is that in Objects mode you can place any content inside the gadget, like for instance XWiki syntax or Velocity code.

Page 119 XWiki Standard 9.8.1 User Guide

Delete a Gadget

To delete a gadget, you have two options: • Edit the dashboard page in Inline mode, hover the title bar of the gadget and click on the red "X" icon in the top right corner. • Edit the dashboard page in Objects mode and click on the corresponding "X" icon. Columns Add a Column

To add a column, edit the home page of the "Dashboard" space in Inline mode and click on the "Add Column" button in the top right corner.

Page 120 XWiki Standard 9.8.1 User Guide

Inside the newly added column, you may perform the same actions described above: insert a gadget, edit its parameters and delete it.

Page 121 XWiki Standard 9.8.1 User Guide

Create a Dashboard

You may create a dashboard in any page: • by selecting the Dashboard template in the "Create Page" form • by adding the {{dashboard}} macro with CKEditor. If you want to know more about the Dashboard macro parameters, go to the dedicated page which is listed in the "Related Pages" section.

Page 122 XWiki Standard 9.8.1 User Guide

A Dashboard only displays a gadget provided its content is not empty when rendered which allows Gadgets to control whether they should be displayed or not. User Dashboards

XWiki Standard brings support for personal dashboards, allowing each user to define his own dashboard in the profile page and to use it either in the profile page or instead of the dashboard displayed by default the wiki home page. Access Your Personal Dashboard

In order to define your own dashboard, click your user avatar in the top menu bar,

then, in your user profile page, click on the tab "My dashboard" under "Settings".

Page 123 XWiki Standard 9.8.1 User Guide

The dashboard can be customized by adding gadgets and columns. To do so, click on the yellow pen in the top right corner of the section "Dashboard preferences". This will make the tab "My dashboard" available for editing in "Inline" mode and you will notice 2 green buttons: "Add Gadget" and "Add Column".

Gadgets Add a Gadget

To add a gadget, go to 'My Dashboard' section of your user profile, edit it in Inline mode and click on the "Add Gadget" button. You will then see a window with all the available macros each of them containing a short description about its usability.

Page 124 XWiki Standard 9.8.1 User Guide

Search for the macro you wish to insert, then click on "Select". We will choose the "Watchlist" macro that loads the list of favorites for the current user.

Page 125 XWiki Standard 9.8.1 User Guide

After clicking on "Submit", the "Watchlist" gadget will be added at the end of the last column, but you can drag it and move it around to different columns of the dashboard. Also, when hovering the gadget, the possible actions, edit and delete, are displayed in the header.

Edit a Gadget

To edit the parameters of a gadget, go to 'My Dashboard' section of your user profile, edit it in Inline mode, hover the title bar of the gadget and click on the yellow pen icon in the top right corner.

You will then see a wizard similar to the one used for adding the gadget. The new parameters will be automatically saved when clicking on the "Insert gadget" button and the gadget will be placed again at the end of the last column. Advanced users can edit their profile page in "Objects" mode in order to customize the parameters of a gadget, the advantage being that any content can be placed inside the gadget, like pieces of code or XWiki syntax.

Page 126 XWiki Standard 9.8.1 User Guide

Remove a Gadget

To delete a gadget, there are two options: • Go to 'My Dashboard' section of your user profile, edit it in Inline mode, hover the title bar of the gadget and click on the red "X" icon in the top right corner. • Edit your user profile page in "Objects" mode and click on the corresponding red "X" icon. Columns Insert a Column

To add a column, go to 'My Dashboard' section of your user profile, edit it in Inline mode and click on the "Add Column" button in the top right corner.

Inside the newly added column, you can perform the same actions described above: insert a gadget, edit its parameters and delete it.

Page 127 XWiki Standard 9.8.1 User Guide

When you are done adding gadgets and columns, click on "Save & View" to see your personal dashboard displayed on the profile page. Display a Personal Dashboard Instead of the Default One

To display your personal dashboard instead of the default one, go to your user profile and click on the "My dashboard" tab. In the "Dashboard preferences" section click the yellow pen in the top right corner. You will then see a drop-down list just below the text "Replace the Default Dashboard with My Custom Dashboard".

To complete, choose "Yes", then save the page. If you navigate to the wiki dashboard page, you should see the one configured on your user profile.

Page 128 XWiki Standard 9.8.1 User Guide

To reverse this operation, click on your avatar in the upper right corner of the screen, then on "My dashboard" in your profile page. Next, locate the "Dashboard preferences" text area and click on the yellow pen in the top right corner, in order to open the tab "My dashboard" in Inline mode. Finally, choose "No" in the drop-down list just below the text "Replace the Default Dashboard with My Custom Dashboard" and save the page to complete the changes.

Page 129 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Users and Groups Overview • User Status • User Profile • User Preferences • Nested Page Actions • Activity Stream • Developer Guide • XWiki Rendering Macros in Java Overview • User Avatar Macro • User Avatar Java Macro • Dashboard Macro • Admin Guide • Panels Application • Enable / Disable the Message Stream • Edit a Global User • Customize the User Profile Sections Flamingo Skin

Flamingo is XWiki's default skin - it is based on the Bootstrap Framework that uses the HTML5 DOCTYPE in order to provide a modern and responsive user interface which adapts to the small screen of current mobile devices: tablets, smartphones and so on. The Flamingo skin uses: • Bootstrap 3.3.7 on XWiki Enterprise 8.2 • Bootstrap 3.3.6 on XWiki Enterprise 8.1 • Bootstrap 3.3.5 on XWiki Enterprise 7.2 • Bootstrap 3.3.4 on XWiki Enterprise 7.1 • Bootstrap 3.3.2 on XWiki Entreprise 6.4.1 and 7.0 • Bootstrap 3.3.1 on XWiki Enterprise 6.4 • Bootstrap 3.2.0 on XWiki Enterprise 6.2 • Bootstrap 3.1.1 on XWiki Enterprise 6.1 XWiki has a total of 4 bundled themes, Charcoal, Marina, Garden and Kitty and another 16 themes that have been adapted from the Bootswatch collection. These ones have been integrated using the advanced lessCode property. Most importantly, the preview of the Flamingo Theme Application won't work in these cases. Also, the Bootswatch themes use some fonts from the Google Fonts web service which means that if you are working behind a proxy that filters some requests, or if you are browsing XWiki on an intranet without having an Internet connection, you will not have the same fonts, but a default one instead. Responsive Skin

On a desktop, the user gets a full view of the site whereas on a smartphone or a tablet the window will retract so that the user no longer needs to zoom and shrink the text or images.

Page 130 XWiki Standard 9.8.1 User Guide

On a small screen, the page header is displayed above the main content area and the left and right panels float below.

Page 131 XWiki Standard 9.8.1 User Guide

New Home Page

The old Dashboard application for the main home page was replaced with instruction steps written in wiki syntax in order to be simpler for new users to edit its content. Moreover, the main home page has its dedicated tour in order to better familiarize you with the most relevant features.

Sandbox Relocation

The Sandbox pages were previously accessible through a link in the Quick Links Panel. In the latest XWiki versions, the link has been removed and a Sandbox entry has been added to the Applications Panel.

Page 132 XWiki Standard 9.8.1 User Guide

Before Version 8.1 Starting with Version 8.1

Drawer Menu

Starting with version 7.2, the "Wiki Name" menu from the top bar was moved to a drawer menu which is accessible by clicking the button. The languages menu was also moved to the drawer. Since XWiki 8.4.2, the drawer menu displays items by scope which can be: • local - concerns only the current wiki • global - affects the whole farm As a consequence, items like "Home", "Create Wiki" and "Delete Wiki" have been removed from the drawer menu, in order to focus on frequent operations.

Page 133 XWiki Standard 9.8.1 User Guide

Before Version 7.2 Current Version

Search Box

The search box is still in the top menu bar, but it is only displayed after clicking the magnifying glass button.

Alerts

Whenever someone else modifies a page in your favorites list, posts a blog article or submits a comment, you will see a number of notifications displayed on the top menu bar, just above the bell icon.

Page 134 XWiki Standard 9.8.1 User Guide

Actions Menu

The "Cog" menu and the "More Actions" menu have been merged to a single menu to address issues with understanding what is the difference between them.

Before Version 9.4

Page 135 XWiki Standard 9.8.1 User Guide

Current Version

Content Menu Usability Improvements

Each menu button now has labels and backgrounds so that it is clearer and easier for users to interact with them.

Before Version 9.4 Current Version

Wiki and Page Administration Improvements

The wiki and page administration menu is now implemented using a collapsible accordion. Most of the sections from the "Applications" group have been moved to existing or new groups, a consistent style was applied across all the administration sections and more hints were added for the configuration options. Moreover, the search input was added so that you can filter the administration categories and sections. Note that for now the live search matches only the category/section name and description.

Page 136 XWiki Standard 9.8.1 User Guide

Wiki Administration Before Version 9.3 Current Version Live Search

Page 137 XWiki Standard 9.8.1 User Guide

Page Administration Before Version 9.3

Current Version

Page Source View Improvements

The wiki source code of the current page has been improved to look nicer and have proper line numbers that support Syntax highlighting and linking.

Page 138 XWiki Standard 9.8.1 User Guide

Also, you can enable the blame view by clicking the "Show last authors" button.

Page 139 XWiki Standard 9.8.1 User Guide

Attachments

In the "Attachments" tab before the attachment name you can now see: • a thumbnail preview for images • an icon reflecting the file extension for non-image files

Page 140 XWiki Standard 9.8.1 User Guide

Nested Pages Page Hierarchy

Starting with version 7.2, XWiki has adopted the 'Nested Pages' paradigm. As a consequence: • the concept of "space" is no longer used • the old Parent-Child relationship was dropped and the Breadcrumb was reworked in order 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 after creating a nested page (top-level or not). Non-Terminal Page

Page 141 XWiki Standard 9.8.1 User Guide

Breadcrumb

Terminal Page

Breadcrumb

Non-Terminal Top-Level Page

Page 142 XWiki Standard 9.8.1 User Guide

Breadcrumb

Page 143 XWiki Standard 9.8.1 User Guide

Page 144

XWiki Standard 9.8.1 User Guide

• the wiki home page is now included in the breadcrumb for its children and descendants • the ability to modify the page parent has been removed in edit mode

"Edit" Menu

The old "Edit" menu blue button was replaced by an editing pen and the "Access Rights" option was removed for non-terminal pages. In its place, you can use the new Administer Page UI. Secondly, there is an extra "Edit" menu item which loads the default editor for that page or form. The default editor setting is available in the user preferences page.

Before 7.2 After 7.2

Import

The Import UI was moved to the new standard tree.

Page 145 XWiki Standard 9.8.1 User Guide

Page 146 XWiki Standard 9.8.1 User Guide

Panels Application

After adopting the "Nested Pages" paradigm, there have been 2 main changes in the Panels application: • the "Navigation" panel displays nested pages • the "SpaceDocs Panel" has been deprecated and replaced by 2 new panels: • the "Sibling Pages" panel displays the siblings of a terminal page • the "Child Pages" panel displays the children of a nested page

Page 147 XWiki Standard 9.8.1 User Guide

Tips Panel

The "Tips" panel is part of the Help Application and displays useful tips and tricks about how to use XWiki. Also, the message about the shortcut key to use the "Jump To Page" feature has been moved from the old "Quick Link" panel to the "Tips" panel.

"Need Help" Panel

The "Need Help?" panel was added to the column on the right and comes with dedicated links in order to get community and professional support.

Applications Panel and Applications Index

The "Applications" panel displays a better overview of the applications installed on the wiki so that users can quickly switch between extensions. For administrators, there is an extra section available named "More applications" with links to Extension Manager and App Within Minutes. Starting with XWiki Enterprise 8.2, some applications were removed from the "Applications" panel - like Scheduler, Invitation, Panels - with the intention to simplify the UI and promote a smaller number of applications.

Page 148 XWiki Standard 9.8.1 User Guide

Before version 8.2 Starting with version 8.2

Page 149 XWiki Standard 9.8.1 User Guide

Page 150 XWiki Standard 9.8.1 User Guide

In order for them to still be discoverable, we added in the "Application Index" option to the drawer menu.

In older versions, applications were listed alphabetically, which was quite limiting for the users. This is the reason why version 8.4 adds support for reordering items. User Preferences

For easy use, each field in the user preferences page now has a documentation hint.

Page 151 XWiki Standard 9.8.1 User Guide

LightBox and Modal Popups

Modal Popups and LightBox resource components are now responsive and adapt to small resolutions.

Page 152 XWiki Standard 9.8.1 User Guide

Registration Lightbox "Share by Email" Modal Popup

Improved Tree Display

The "Tree" tab in the Page Index Application uses the Document Tree Macro based on a JQuery plugin named jstree.

Page 153 XWiki Standard 9.8.1 User Guide

Also, the Document Tree Widget has also been integrated with the Wysiwyg editor.

Page 154 XWiki Standard 9.8.1 User Guide

Export Page Improvements

The page export modal popup is now split in 2 format categories: • Office Formats - for the PDF, RTF and ODT export

Page 155 XWiki Standard 9.8.1 User Guide

• Other Formats - for the XAR and HTML export; in case the exported page is nested and has children, you may choose to export them too.

Also, the "Export" menu has been replaced with a corresponding entry in the "More Actions" menu.

Page 156 XWiki Standard 9.8.1 User Guide

Login Form Improvements

Easy to Customize Color Themes

The default color theme is the "Charcoal" which displays a preview of the wiki home page

Page 157 XWiki Standard 9.8.1 User Guide

and a "Variables" panel with the list of LESS variables you can customize.

Page 158 XWiki Standard 9.8.1 User Guide

The preview only works for the 4 bundled Flamingo themes: Charcoal, Marina, Garden and Kitty. The remaining 16 themes were created from Bootswatch using the lessCode property. In the newer versions, the "Logos" section has an associated attachment selector, so that it is much easier to update the wiki logo. If until now you had to first attach an image to the color theme page, then edit the page in "Inline" mode and finally select the image from a list, now all you have to do is to click on "Choose an attachment" straight from inline mode an upload the new logo from you local files. On sub-wikis the "Color Theme" section has 2 tabs: • Local - refers to the color themes from the current sub-wiki • Global - allows to use a color theme from the main wiki

Page 159 XWiki Standard 9.8.1 User Guide

Icon Theme Application and Font Awesome

XWiki comes with the new "Icon Theme" application which allows administrator users to choose the wiki icon set via the "Presentation" section of the wiki preferences page.

The available icon sets are silk and Font Awesome which is used by default.

Page 160 XWiki Standard 9.8.1 User Guide

Silk Font Awesome

The App Within Minutes application provides an icon picker with a default preview for Font Awesome icons.

Page 161 XWiki Standard 9.8.1 User Guide

The other available icon set is Silk which corresponds to the images located in the "\webapps\xwiki\resources\icons\silk" folder on your filesystem.

Improved Quality of the Image Avatar

The quality of scaled images (most noticeable in the case of user avatars) was much improved, thanks to the Thumbnailator library that we started using since version 8.4.4.

User Profile Activity Stream

Page 162 XWiki Standard 9.8.1 User Guide

Comments Tab

Page 163 XWiki Standard 9.8.1 User Guide

User Index

CKEditor Configuration Section

Starting with version 8.4, we have added a dedicated configuration page to the wiki preferences. The new section allows administrators to activate or deactivate specific functionalities in the editor toolbar or to enable the display of the "Advanced" and "Target" tabs in the "Link" dialog box.

Page 164 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Developer Guide • Skin Extension Plugin • LESS Module and LESS CSS • Create and Override a Skin • Admin Guide • Skin Application • Flamingo Color Themes Application Help Center Application

Help Center is an application bundled with XWiki Standard that showcases the main XWiki features through demo content. To access it, click on "Help" in the "Applications" panel or simply navigate to "Help.WebHome".

Page 165 XWiki Standard 9.8.1 User Guide

If you are a new XWiki user, click on "Learn more" in the "Getting Started" section in order to get basic information regarding the XWiki version currently installed on your server

or save time and take a look at the integrated Video gallery which will get you up to speed.

Page 166 XWiki Standard 9.8.1 User Guide

Once you get more familiar with the concepts, go to "Main XWiki Features" and check the available examples. You should soon be able to start actually using XWiki's powerful features including import and export tools, page templates and play with the integrated editors in order to create page hierarchies, write applications, macros and much more.

Page 167 XWiki Standard 9.8.1 User Guide

Page 168 XWiki Standard 9.8.1 User Guide

Page 169 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Admin Guide • Template Providers

Page 170 XWiki Standard 9.8.1 User Guide

Index Application • Page Index View • Page Tree View • Attachments View • Deleted Pages and Attachments • Restore Deleted Pages and Attachments • Page Children • Page Siblings The page index offers a quick way of accessing and managing pages and attachments in your wiki. The page list is available by clicking the button which opens the drawer menu, then on "Page Index".

Page Index View

The "Index" tab displays all the wiki pages alphabetically using the {{documents /}} macro and allows you to filter them by different criteria like title, location, the last edit date and the last author. Depending on the user privileges, the "Actions" column displays 4 possible actions for each page: delete, copy, rename and edit the access rights.

Page 171 XWiki Standard 9.8.1 User Guide

The "Location" column displays the location of the page in the reference hierarchy and allows to filter at several path levels.

Page 172 XWiki Standard 9.8.1 User Guide

Also, XWiki has introduced the "Title" column instead of the old "Page" column because all nested pages are called WebHome, so displaying this value would not be user-friendly. However, note that XWiki doesn't support filtering on page titles.

The "Orphaned Pages" tab is visible only if the Parent-Child Hierarchy Mode is enabled, which is not the case 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. Page Tree View

The "Tree" tab displays a tree view of all pages and attached files using the reworked Document Tree Macro and is thus honoring the Nested Pages paradigm.

The Document Tree Macro is based on a JQuery plugin named jstree. For more details, check the dedicated documentation pages listed in the "Related Pages" section under "Programming Guide". Also, the integrated Page Tree Finder allows to easily locate pages and attachments.

Page 173 XWiki Standard 9.8.1 User Guide

Attachments View

The "Attachments" tab lists all files attached to XWiki pages that you can now sort and filter by file name, file type, size or date (thanks to the new range picker).

File Type Filter File Size Filter Date Range Filer

Just like in the case of page attachments the "Type" column displays: • a thumbnail preview for image attachments • an icon for non-image files depending on their extension (the icons are using the configured Icon Theme)

Page 174 XWiki Standard 9.8.1 User Guide

Similarly to the Page Index, you can search for attachments in the nested pages hierarchy using the new "Location" column that has replaced the old "Page" and "Space" columns.

Page 175 XWiki Standard 9.8.1 User Guide

Deleted Pages and Attachments

Additionally, provided you have wiki administration rights, you will see a livetable of deleted pages

and deleted attachments.

Deleted pages and attachments are stored in a database in the "xwikirecyclebin" and "xwikiattrecyclebin" tables. In order to permanently delete a page from recycle bin, click on the "X" button in the "Actions" column. Restore Deleted Pages and Attachments

To recover an individual page, click on the green icon in the "Actions" column. Note that if a new page has been created with the same name, the deleted one cannot be restored anymore. In case you have performed a delete operation that removed multiple pages at the same time (like deleting a nested page and its children), it is now possible to restore them all together to their original state and location. This is possible by assigning a common batch ID to the deleted pages in the recycle bin so that you can now browse the deleted documents and group them by batch.

Page 176 XWiki Standard 9.8.1 User Guide

To list the deleted pages from the same batch, simply click the link in the "Deleted Batch ID" column.

You will be redirected to the restore screen where you can choose to either restore just that page or the entire batch of pages that were deleted with it. Note that you are only seeing the pages from that batch that still exist in the recycle bin. It is possible for some pages to have been restored in the meantime or to have been deleted from the recycle bin.

The batch ID is also displayed in the "Notice" screen when trying to access a deleted page and clicking it will redirect to the batch restore screen.

Page 177 XWiki Standard 9.8.1 User Guide

After clicking on "Restore" an asynchronous job is launched and if successful you will see a confirmation message.

If a page from the batch was recreated in the meantime with the same name and in the same location as the deleted one, then the restore operation will report as failed, even if all the other pages may have been successfully restored. An advanced user can inspect the log to see which page from the batch failed to restore.

In order to be able to restore a deleted translation, the main page containing the default translation needs to be restored first or recreated. To do that you have 2 options: • restore the default translation from the "Deleted Pages" tab

Page 178 XWiki Standard 9.8.1 User Guide

• click on the disabled restore button of the translation and you will be redirected to the location of the default page where you can re-create it.

Regarding deleted attachments, they cannot be restored separately, but along with the deleted page that contained them. You will need to restore the page, then rollback to a version before the attachment was deleted. In case the page is no longer in recycle bin, the deleted attachment cannot be recovered any more. To work around database limitation when deleting pages with many attachments, a new file recycle bin component has been introduced. You can enable it in the "WEB-INF/xwiki.cfg" configuration file with the following: xwiki.store.recyclebin.content.hint=file Page Children

Nested or non-terminal Pages are wiki pages that can have other child pages which are also known as terminal.

In order to access the children of a nested page, click the button and choose "Children" in the "Viewers" section.

The livetable is similar to the one displayed by the "Index" tab of the wiki page index. You may filter pages by location or last modification date and, depending on the user privileges, you can also copy, delete, rename pages and change the page access rights.

Page 179 XWiki Standard 9.8.1 User Guide

Page Siblings

For terminal pages, the "Siblings" livetable is available by clicking the button, then on "Siblings"

and displays the pages having the current page as parent.

Page 180 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Wiki Pages • Nested Page Actions • Developer Guide • XWiki Rendering Macros in Java Overview • XWiki Rendering Macros Overview • Tree Widget • Spaces Macro • Documents Macro • Document Tree Macro • Children Macro • Admin Guide • App Within Minutes Application Office Importer Application • Requirements • Import an Office Page Using the "Create Page" Form • Import an Office Page Using CKEditor The Office Importer application is bundled with XWiki Standard and it allows you to import Office documents into wiki pages. This application uses an Office server in order to convert Office documents into HTML and then into XWiki syntax. Requirements

In order to use the Office Importer application, you need to: • have a properly configured XWiki Standard instance • install OpenOffice or LibreOffice

Page 181 XWiki Standard 9.8.1 User Guide

• start the OpenOffice/LibreOffice server on the machine hosting your XWiki Standard instance To learn how to configure the Office server, follow the dedicated documentation page. There are 2 ways of importing an Office file into a wiki page: • using the "Create Page" form • using CKEditor Import an Office Page Using the "Create Page" Form

If you have configured an Office server and XWiki is connected to it, go to any wiki page and click the "+ Create" button.

To learn how to fill in the "Title" and "Location" fields, please refer to this link. You will also notice a "Page from Office" option in the "Type" section.

After clicking on "Create", you will be redirected to the new Office Importer UI which has been reworked in order to honor nested pages. The "Target" field represents the location in the page hierarchy where the new page will be created.

Page 182 XWiki Standard 9.8.1 User Guide

By checking the "Filter styles" option, any unnecessary styles will be removed from the result. Also, you may choose to create multiple wiki pages from the source page which will be split before each heading. If the operation is successful, you will then see the XWiki.OfficeImporterResults page which contains 2 links: • the result link leading you to the recently imported page • the Go back link which redirects you to the Office Importer main page

In case the imported file has embedded images, they are now saved as attachments to the target wiki page. This used to be the default behavior until recent versions of LibreOffice / OpenOffice have started to embed the images in the generated HTML, which ended up in the wiki syntax. Starting with version 8.3, the initial behavior has been restored. Import an Office Page Using CKEditor

Edit an existing wiki page or a new one in "Wysiwyg" mode then follow the steps described in the dedicated documentation page.

Related Pages

• User Guide • XWiki Applications Overview • Pages Overview

Page 183 XWiki Standard 9.8.1 User Guide

• Page Export Formats • Editing Modes • CK Editor • Developer Guide • Wysiwyg Module • Office Macro • Customize the Look and Feel of the PDF and RTF Export • Admin Guide • Import - Export Application • Customization Overview • Configure the Office Server • CKEditor Configuration • Admin Tools Application Search Application • Search Suggest • Solr Search Application • Database Search Search Suggest

In order to search the wiki or the entire farm, go to any page, click the magnifying glass icon in the top menu bar which will load a text input to the left, type your keyword and hit "Enter".

The suggestion as you type feature for the search box will help you by grouping the results as follows: • Page name • Page content • Attachment name • Attachment content • Users • Blog posts • Wikis

Page 184 XWiki Standard 9.8.1 User Guide

To see the complete list of results, click on "Go to search page..." in the top right corner of the suggestion box and you will be redirected to the page Main.Search. In case no result is found, the search box will display a message and a link to the search page.

The search suggest is using the Solr engine by default, due to the fact that we have created a search suggest service based on Solr. We have also added search suggest sources that mimic the behavior of the existing Lucene-based ones so that now the search suggest takes into account the configured search engine. More information is available in the Search Suggest configuration page. Solr Search Application

The XWiki default search engine is Solr, based on Apache Solr which has its own index. You may access the Solr search page by navigating to Main.SolrSearch. The Solr search module automatically indexes the changes made on the wiki and at each startup a background job checks if the Solr index and the database are synchronized. If not, the job only applies the updates. Manual indexing is still available because it is more stable so, in case you need to perform it, follow the steps described in the "Search Configuration" documentation page.

Page 185 XWiki Standard 9.8.1 User Guide

By default, results are sorted by relevance i.e. depending on the scoring of each page. You may also choose to filter the results by title, the last modification date or the last author. If the keyword is not found in the page title, the wiki name or the page name but in content of the wiki page, the search results will also display excerpts in which each occurrence will be highlighted.

The number of displayed results depend on the user rights on the pages. So, normally, an administrator user will get more matches than one with basic privileges. Also, the display of the result location has been updated to in order to support nested pages. Initially, only one match is displayed, but you can view all the matches by clicking on the "Highlight all matches" link.

Page 186 XWiki Standard 9.8.1 User Guide

To disable highlighting, click on "Highlighting" below the search input. When the functionality is disabled, the text switches from bold to normal.

In order to receive RSS updates about the wiki pages containing the keyword you are searching for, click the "RSS feed for search on [keyword]" link at the bottom of the search results.

To the right, the "Refine Your Search" panel displays search facets that will help you analyze search results depending on the space and page name, the creation and last edit date, author and creator. The displayed facets are always relative to the current search results and they support multiple selection. Moreover, selecting a value doesn't hide the rest of the displayed values for that facet and you can still see the number of results matching that value. Finally, the facet selection is preserved when performing a new search.

Page 187 XWiki Standard 9.8.1 User Guide

Categories can be expanded or collapsed by clicking on the corresponding "Expand all" or "Collapse all" link in the panel header. You can also clear the current facets by clicking on the "Reset all" link. The "Results Type" facet defaults to "Document" type. The reason is to keep the consistency with the old "Result Type" filter from the "Advanced Search" options which was set to include by default only pages in the search results.

Page 188 XWiki Standard 9.8.1 User Guide

Other possible values are: • Object • Object Property • Attachment

Depending on the result type, the UI displays a dedicated icon which is retrieved from the Flamingo Icon Themes. Also, when searching in Objects and Objects Property, the displayed results contain the page title and a location breadcrumb.

Page 189 XWiki Standard 9.8.1 User Guide

If the wiki is multilingual, you can also select the language in which to perform the search. In case no option is selected, the "No Language" option will be taken into account, along with the default current wiki language, which in this case is "English". We have chose this approach in order to avoid confusion because some pages don't have a default language set (like the ones containing pieces of code) or they are part of the XWiki UI, therefore they are displayed in the current language.

Entities are indexed with the list of supported locales, which means that if your current locale is "fr_FR" you will find all entities that you would have seen when the current locale is "fr_FR". The "Space" facet has been replaced with a "Location" facet that supports nested pages and allows to search in a specific location in the page hierarchy.

Page 190 XWiki Standard 9.8.1 User Guide

The "Page" facet has been removed by default because it doesn't bring value in the context of nested pages as all non-terminal pages are named "WebHome". The "Wiki" facet is displayed by default only on the main wiki and only if there are multiple wikis created. The "Last Modification Date", "Creation Date" and "Upload Date" facets provide time intervals for an easier navigation like: • Today • Last 7 Days • Last 30 Days • Older than 30 Days

but also allow you to specify a custom date and time interval using a Calendar Picker.

Page 191 XWiki Standard 9.8.1 User Guide

The File Type facet filters results based on the attachment file type. File types are grouped by category like image, text, Office file and you can select either an entire category or a specific file type.

The File Size facet allows you to filter results based on the attachment size. You can now choose between 4 ranges: • Tiny for less than 10Kb • Small for sizes between 10Kb and 500Kb • Medium for sizes between 500Kb and 5MB • Large for more than 5MB

Page 192 XWiki Standard 9.8.1 User Guide

The "Creator", "Last Author" and "Uploaded By" facets display the full name, alias and user avatar.

In case the task is too slow, you may disable faceting by clicking on "Facets" below the search input. When the functionality is disabled, the text switches from bold to normal and the facets panel is hidden.

One important Solr search improvement is the fact that starting with cycle 7.x the UI is responsive on small screens. On mobile phones, the facets panel is collapsed between the search box and the search results and the user can easily expand it with a tap.

Page 193 XWiki Standard 9.8.1 User Guide

Database Search

The database search page performs HQL queries in the database and it is available by navigating to Main.DatabaseSearch.

Page 194 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Tags Application • Pages Overview • Notifications Application • Internationalization • Blog Application • Developer Guide • Solr Schema and API • RSS Macro • Lucene Plugin • Admin Guide • Search Suggest Sources • Customize the Search Feature • Customize the Language and Timezone Settings Syntax Highlighting Application • Features • Administration

Page 195 XWiki Standard 9.8.1 User Guide

The XWiki Syntax Highlighting application provides CodeMirror based syntax highlighting for: • Velocity • Groovy • JavaScript • CSS • Python • HTML • XWiki Macros (Experimental) In XWiki Standard, syntax highlighting is automatically activated for: • page content editor ("Wiki" editing mode) • object editor for the following objects: • XWiki.StyleSheetExtension objects • XWiki.JavaScriptExtension objects • XWiki.XWikiSkins objects for all properties with the name ending in . or .js • XWiki.WikiMacroClass objects for the Code property

Features • syntax highlighting • line numbers • active line highlighting • tab line indentation and 2 spaces on tab • matching and auto-closing brackets, parentheses and quotes • matching selection highlighting • scroll to undo/redo position • trailing whitespace highlighting • multiline comment auto indentation on newline • find and replace tool with regex support: • Press Ctrl+F / Ctrl+Shift+F (while the editor is focused) to search inside the editor

Page 196 XWiki Standard 9.8.1 User Guide

• Press Ctrl+Shift+R (while the editor is focused) for search and replace

• Press F3 after searching for something (with the editor focused) in order to scroll to the next result Matching results are both highlighted in the editor and displayed in the scrollbar so that you can easily get to the next match.

• fullscreen editing support: press F11 while the editor is focused to enter full screen, then press Esc to exit full screen The Auto Completion Application provides auto-completion for Velocity and JavaScript, thus enhancing the Syntax Highlighting application's features. Administration

To disable the syntax highlighting feature, log in as administrator, click the button to open the drawer menu and choose "Administer Wiki".

Page 197 XWiki Standard 9.8.1 User Guide

Next, click on "Other" -> "Syntax Highlighting" in the accordion menu, uncheck the "Enabled" option, then hit "Save".

Additionally, you may choose one of the 33 themes provided by CodeMirror or change the color to use when highlighting the currently selected word or piece of text.

Page 198 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Syntaxes • XWiki Applications Overview • Simple and Advanced Editing • Developer Guide • Template Module • Rendering Module • Localization Module • Content Macro Tags Application • View the Tag List • Add Tags • Rename a Tag • Delete a Tag • Tag RSS View the Tag List

The existing tags are displayed by default in a tag cloud located on the wiki default dashboard page (Dashboard.WebHome).

Page 199 XWiki Standard 9.8.1 User Guide

In case you have customized your wiki dashboard so it wouldn't display the tag cloud, you can navigate to "Main.Tags". Given that tags are stored in objects attached to the original page, it is not possible to filter them by language. This means that for instance the same tag cloud will display all the existing English and French tags. Add Tags

In XWiki you can add tags to all pages which are then stored in "XWiki.XWikiTags" objects. To do so, go to the bottom of any page and click on [+].

Type in the page tags separated by commas and click on the "Add" button. The suggest feature will help you by displaying the list of all the existing tags that match the entered characters.

Page 200 XWiki Standard 9.8.1 User Guide

You can now see the tags you have just entered.

Rename a Tag

Scroll down to the bottom of the page and click on the tag you wish to rename. You will be redirected to the page "Main.Tags" which displays the list of pages tagged with the selected item, along with the activity stream of documents containing that specific tag.

Next, click the "Rename" button, enter the new tag name and click again on "Rename" to confirm.

Page 201 XWiki Standard 9.8.1 User Guide

The changes will also reflect on the documents listed by the "Main.Tags" page.

Delete a Tag

To remove a tag, scroll down to the bottom of the page, hover the tag and click on the red X button located on the top right corner.

Another way is to click on the tag you wish to delete. You will be redirected to the page "Main.Tags" which displays the list of pages tagged with the selected item, along with the activity stream of documents containing that specific tag. Next, click the "Delete" button, then again on "Delete Tag " to confirm.

Page 202 XWiki Standard 9.8.1 User Guide

You will be redirected back to the tag list page which will also display a success message.

Tag RSS

You can also receive RSS feeds for wiki pages containing a given tag. To do so, click the tag for which you wish to receive updates then, in the page "Main.Tags", click the "RSS Feed" link.

Page 203 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview • Simple and Advanced Editing • Share Page by Email • Search Application • Pages Overview • Page Attachments • Notifications Application • Blog Application

Page 204 XWiki Standard 9.8.1 User Guide

• Developer Guide • Tag Plugin • Tag Cloud Macro • RSS Macro Tour Application • Launch a Tour • Create a Tour The XWiki Tour Application allows to create guided tours for any wiki page in order to better familiarize users with the most relevant features on that page. To access it, click the icon which launches the drawer menu, then on "Application Index" in order to display the list of installed applications and finally on "Tour".

Launch a Tour

The tour is automatically launched when the user accesses the target page. The gallery below contains screenshots for the main wiki home page.

Page 205 XWiki Standard 9.8.1 User Guide

Page 206 XWiki Standard 9.8.1 User Guide

Page 207 XWiki Standard 9.8.1 User Guide

Page 208 XWiki Standard 9.8.1 User Guide

Page 209 XWiki Standard 9.8.1 User Guide

To close the tour without going through all the steps, the user has to option to click the "x" button in the upper right corner of the popup, in which case a "Show tour" button will be displayed on the bottom right of the page in order to launch it at a later time.

A tour having the target page specified can be also played by clicking on the "Launch" link in the live table on the Tour Application home page.

Page 210 XWiki Standard 9.8.1 User Guide

Create a Tour

Supposing you wish to create a tour for the main elements of your user profile page, go to the Tour Application home page and click on "Add Entry" in the "Actions" panel.

Next, enter the name of the tour page and click the green "+" button. The tour form has 3 fields: • Description - an optional field which is not used by the application as is it purely for informative purposes. • Active - whether the tour should be displayed or not. You can use this option to hide an incomplete or deprecated tour from other users. • Target Page - the reference (full name) of the page where the tour should be displayed, like for instance XWiki.Admin. • Target Class - the class name for which the tour entries should be displayed, like for instance XWiki.XWikiUsers. and a list of steps, each one corresponding to a page element you want to include in the tour.

Page 211 XWiki Standard 9.8.1 User Guide

To create a step, click on "+ New Step" located in the upper right corner of the "Steps" table and fill in the required fields: • Element - the CSS selector for the page element you wish to attach a popover to. If the element is not specified, the popover will be displayed in the center of the page. In order to obtain the CSS selector, you can use any browser's developer tools. • Title - it can be plain text or a translation key. • Content - the text to display (you can use plain text, wiki syntax or even macros). • Placement - the position of the popover in report to the page element: the possible values are Top, Bottom, Left and Right. • Order - the step index. • Backdrop - allows to hide all the elements of the page that are not concerned by the current step. • Target Page - represents the reference of the page where the step should be displayed and it is used for multiple page tours.

Page 212 XWiki Standard 9.8.1 User Guide

After clicking on "Add Step" you should see the entry displayed in the table.

The final list of steps corresponding to the user avatar, profile information and "Settings" panel should be similar to the one in the image below:

Page 213 XWiki Standard 9.8.1 User Guide

Once you are done adding steps, save the tour form and go to your user profile page in order to launch it.

Page 214 XWiki Standard 9.8.1 User Guide

Page 215 XWiki Standard 9.8.1 User Guide

Page 216 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Applications Overview Other XWiki Applications Overview Other XWiki Applications (Not Bundled)

Blog Application Transforms the wiki into a "bliki" with the ability to add Blog posts and display them.

Admin Tools Application A collection of scripts that wiki administrators can execute to list the system configuration information, perform various database maintenance tasks, display the rights configuration and so on.

Statistics Application Provides various panels and pages displaying wiki related statistics. Blog Application • Access the Blog Home Page • Create a Blog Post • Edit a Blog Post • Publish a Blog Post • Hide a Blog Post • Manage Blog Categories • Blog RSS Feeds • Multi-Blog Feature • Blog Macros • Blog Post List Macro • Blog Post Layout Macros The Blog Application which allows you to easily create blog posts and organize them into categories, to publish your blog posts instantly, or at a later date. Moreover, the XWiki blog has a dedicated set of panels that provide an easy navigation for you and other readers. The Blog Application is no longer bundled with XWiki Standard but you can easily install it using the Extension Manager. Access the Blog Home Page

There are currently 2 ways of accessing the XWiki Blog Application: • by clicking on "Blog" in the "Applications" panel

Page 217 XWiki Standard 9.8.1 User Guide

• by clicking the icon which launches the drawer menu, then on "Application Index" in order to access the list of installed applications and finally on "Blog"

Create a Blog Post

To create a new blog post, go to the Blog home page or access any blog category page from the "Blog Category" panel, fill in the new post title and click on "Create".

Page 218 XWiki Standard 9.8.1 User Guide

A new page will open in edit mode, allowing you to change the blog post title, add the post content,

and a summary.

Page 219 XWiki Standard 9.8.1 User Guide

Additionally, for a more visual and appealing display, you may attach an image to the blog article which will then appear as thumbnail, provided the blog is configured to use the Image thumbnail layout instead of the classic "Calendar" layout.

Next, select a category and set the publication date for the blog post.

To create a subcategory, hover any category name and click the + icon. Next, enter the category name and click on "Add". By default, the new category will have the hovered category as parent, which means that "News" will be the parent of "Open Source".

Page 220 XWiki Standard 9.8.1 User Guide

Another possibility is to click on the "Add a category" link. This way you can decide whether the new category will have an existing category as parent or not.

The new categories hierarchy will be automatically updated in the "Blog Categories" panel which is displayed by default in the right panel column. Notice that the panel now has an entry for "All" blog posts with a dedicated RSS feed.

Page 221 XWiki Standard 9.8.1 User Guide

After you have filled in all the information, click on "Save & View" and you are done. You can see your blog post as the latest entry in your blog.

Edit a Blog Post

To edit a blog entry, click on the pen icon located on the top right corner of the post.

The blog post will open in "Inline" mode allowing you to: • update the content • add or update the summary • add or update the thumbnail image • change the category • set a new publish date

Page 222 XWiki Standard 9.8.1 User Guide

• mark the blog post as hidden Publish a Blog Post

You can publish a blog post right after creating it or set a later time for it to be published.

To publish a blog post at any time before the set date, click the globe icon.

Hide a Blog Post

To hide a blog post from other users, click on the lock icon next to the edit pen

or click on the pen icon to edit the article and check the "Hide article" option.

To make the blog post visible again, just click on the open lock icon next to the edit pen.

Page 223 XWiki Standard 9.8.1 User Guide

Manage Blog Categories

You can easily filter blog posts by categories by clicking on the category name you are interested in from the "Blog Categories" panel. To edit categories or to create new ones, click on the "Edit Categories" link at the bottom of the panel.

To create a category, click on "Add a category" in the page "Manage blog categories". Fill in the new category name, select "None" for "Subcategory of" and click on "Add". To create a subcategory, just follow the steps with the sole difference is that this time you have to select an existing category as parent.

Page 224 XWiki Standard 9.8.1 User Guide

Another way of creating a subcategory is to hover an existing category, then click the + icon. This way, the hovered category will automatically be set as a parent for the new one.

Page 225 XWiki Standard 9.8.1 User Guide

To rename or delete a category, hover the category name and click on the pen icon

or on the X button respectively.

Page 226 XWiki Standard 9.8.1 User Guide

Blog RSS Feeds

You can easily subscribe to the RSS feed for the whole blog by clicking the RSS icon next to the "All" link in the "Blog Categories" panel. It is also possible to subscribe to the separate blog categories from any page in the Blog.

Multi-Blog Feature

Starting with version 9.4, XWiki supports having multiple blogs in the same wiki. The new feature follows a set of rules, namely: • the initial set of categories of the Blog location is shared by all existing blogs • new blogs can be created anywhere on the wiki, including under nested pages • a new set of categories is created automatically for each new blog. • all panels of the Blog Application will display contextual information based on: • the displayed blog article, OR • the displayed category or set of categories • the newly created blog will be configured with a minimal set of panels similarly to the initial Blog located in the Blog location. To create a blog, locate the "All Blogs" panel and click on "Manage Blogs" or navigate directly to the page Blog.Management which brings an overview of the blogs detected in your wiki.

Page 227 XWiki Standard 9.8.1 User Guide

Next, locate the section "Create a new blog" and fill in the blog title and location. To set a custom blog location, click the blue editing pen icon, which will load 2 more fields: • Parent - the parent of the new blog; 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 Blog i.e. the string appearing in the URL.

The new blog categories will be created in the new blog location meaning that if the blog location is "Internal Blog", the categories will be in its child page named "Categories".

Page 228 XWiki Standard 9.8.1 User Guide

If the option "Enable Blog Panels" is checked, the newly created blog will be configured with a minimal set of panels similarly to the initial Blog located in the Blog location. Next, by enabling the "Create Default Categories" option, you will also create a new set of categories for the new blog: "News", "Personal" and "Other". Finally, the option "Posts Layout" refers to the way the blog posts are displayed on the blog homepage: • Calendar - display a calendar image containing the article publishing date • Image thumbnail - display a thumbnail of the image attached to the blog article page. In case the article has no image attached, the Calendar layout is used by default.

Click on "Create" to confirm and if successful you will be soon redirected to the new blog home page so that you can start creating articles. Also, notice that the list in the "All Blogs" panel is updated with the new blog.

Page 229 XWiki Standard 9.8.1 User Guide

Blog Macros Blog Post List Macro

The "Blog Post List" macro is used to query and display blog posts anywhere in the wiki and the returned results can be displayed using customizable post layouts. Usage

{{blogpostlist blog="" category="" published="" layout="" layoutParams="" limit="" /}} Parameters definition

Name Optional Allowed Values Default Value Description blog yes a document reference The descriptor page of a blog (It should contain a page with a Blog.BlogClass object attached) category yes a document reference Either a given category or a category location (not mandatory when the blog parameter is specified) published yes yes, no, all yes Limit results to published posts hidden yes yes, no, all no Limit results to hidden posts fromDate yes string date Limit posts to those published starting with a given date. The accepted date format is yyyy-mm-dd. toDate yes string date Limit posts to those published before a given date. The accepted date format is yyyy-mm-dd. limit yes integer 10 Number of posts to display layout yes link, full, image link The name of the post layout macro that will be used to display the posts. The naming convention for the layout macros is: "BlogPostLayout${LayoutNameWithFirstLetterCapitalized}" layoutParams yes string Additional parameters of the blog post layout paginated yes yes, no In case the limit parameter is not provided the value of itemsPerPage is extracted from the blog descriptor

Example

{{blogpostlist blog="Blog.WebHome" category="Blog.News" published="yes" hidden="yes" layout="full" fromDate="2017-11-01 layoutParams="displayTitle=false" limit="10" /}} Blog Post Layout Macros

Blog post layouts are wiki macros for customizing the layout of blog posts. There are currently 3 blog post layout macros available: • blogPostLayoutLink • blogPostLayoutFull • blogPostLayoutImage Usage

Page 230 XWiki Standard 9.8.1 User Guide

{{blogPostLayout[Full|Link|Image] reference="" params="" /}} Parameters

Name Optional Allowed Values Default Value Description reference no a document reference The document reference of the blog post params yes string Additional parameters of the blog post layout

Examples

{{blogPostLayoutFull reference="InternalBlog.XWiki Seminar 2017" params="displayTitle=true|useSummary=true" /}}

{{blogPostLayoutLink reference="InternalBlog.XWiki Seminar 2017" params="displayTitle=true|useSummary=true" /}}

{{blogPostLayoutImage reference="InternalBlog.XWiki Seminar 2017" params="displayTitle=true|useSummary=true" /}}

Related Pages

• User Guide • Tags Application • Search Application • Other XWiki Applications Overview • Other XWiki Applications Overview • Notifications Application • Developer Guide • RSS Macro Users and Groups Overview FAQ Login and Registration

How do I register to the wiki? How do I log in? How do I recover my lost username? How do I reset my password in case I forget it?

Page 231 XWiki Standard 9.8.1 User Guide

User Profile and Preferences

How do I access my user profile? How do I add an avatar to my profile? How do I add information about me to the profile? How do I link my website, blog or social profiles from my profile? How do I see my wiki activity? How can I change the skin? Where do I change my password from? Where do I change my default editor from? How can I make my hidden documents visible? How can I set my timezone? How do I share a status message? How do I delete a status message? How do I follow other users' posts? How do I unfollow an user? How do I see the members of my network?

Sub-Wiki Membership

How do I join an open wiki How do I make a request to join a wiki How do I check whether I received any invitation to join a wiki How do I view an invitation? How do I accept an invitation? How do I reject an invitation? How do I postpone an invitation? How do I see the list of Wikis I am a member of? How do I see the activity stream of a wiki? How do I leave a wiki? Registration

To create a wiki account, click the button in order to open the drawer menu, then click on "Register".

Page 232 XWiki Standard 9.8.1 User Guide

A registration form will appear in order for you to fill in the user information.

Page 233 XWiki Standard 9.8.1 User Guide

Click on "Register" once you are done and if successful you will see confirmation message and a log-in button.

Page 234 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Login • Users and Groups Overview • User Status • Admin Guide • User Directory Application • The Management of Global/Local Users and Groups • Set the Users Access Rights • Edit a Global User • Edit a Global Group • Delete a Global User • Customize the User Registration Process • Create a Global User XWiki Login • Log-in • Recover Username • Reset Password Log-in

In order to authenticate against the wiki, click the to open the drawer menu, then click on "Log-in".

Page 235 XWiki Standard 9.8.1 User Guide

Next, fill in your username and password in the log-in window and click on "Log-in".

Page 236 XWiki Standard 9.8.1 User Guide

To disconnect, click again on the button, then on "Log-out".

By clicking on the avatar or on your "FirstName LastName", you will be redirected to the user profile page.

Page 237 XWiki Standard 9.8.1 User Guide

Recover Username

In case you have forgot or lost your username, click on the "Username" link in the Log-in window.

Page 238 XWiki Standard 9.8.1 User Guide

You will then be asked to fill in the email address you provided during the registration.

Next, click on "Retrieve Username" and you will receive the username information associated to the email address you provided.

Page 239 XWiki Standard 9.8.1 User Guide

Reset Password

In case you have lost or forgot your password, click on the "Password" link in the Log-in window.

Next, enter your username and click on "Reset Password".

Page 240 XWiki Standard 9.8.1 User Guide

A confirmation message will be then sent to the email address you provided during the registration. After clicking on the confirmation link, you will be redirected back to the wiki and prompted for a new password.

Related Pages

• User Guide • User Profile • User Preferences • Registration • Admin Guide • XWiki Standard Installation and Upgrade • Customize the User Registration Process • Create a Global User User Profile • Add an Avatar • Edit Your Profile Information

Page 241 XWiki Standard 9.8.1 User Guide

• Recent Changes • Change the Skin

You can easily access your user profile page: • by clicking on your user avatar in the top menu bar • by clicking the button to open the drawer menu, then on the user avatar or on your name

After the registration, your profile will only display your first and last name and an email address in case you provided one.

Add an Avatar

You can start customizing your profile by adding an avatar. To do this click on pen icon located on top right corner of the avatar image above the "Profile" tab. Next, click on "Browse", select an image from you computer, check the option "Replace [image_name]" (in case you already have an avatar image and you wish to change it) and click on "Upload and select".

Page 242 XWiki Standard 9.8.1 User Guide

You will then be redirected back to the profile page which will display the new avatar. In case this doesn't happen due to the browser cache, simply refresh the page.

Edit Your Profile Information

To edit your profile information all you have to do is to click on the yellow pen located at the top of your profile. In the "Personal Information" section you may edit your first name, last name, company and write a short description about you.

Page 243 XWiki Standard 9.8.1 User Guide

You may also fill in your contact details in the "Contact Information" section by adding your email, phone number and physical address.

The "External Links" section allows you to add links to your blog and blog feed.

After you are done editing, don't forget to save your changes.

Page 244 XWiki Standard 9.8.1 User Guide

Recent Changes

The user profile displays a list of the pages that have been recently modified by the profile owner. This means for example that if you create a new page, the event will show up in the "My Activity Stream" section of your profile.

Page 245 XWiki Standard 9.8.1 User Guide

Change the Skin

Any advanced user can choose which skin to be displayed after login by editing the profile page in "Objects" mode. The skin name is stored in the "skin" property of the XWiki.XWikiUsers object and the default value is "flamingo".

Related Pages

• User Guide • XWiki Login • View the List of Joined Sub-Wikis • User Status • User Preferences • Dashboard Application • Activity Stream • Developer Guide • User Avatar Macro • User Avatar Java Macro • Activity Macro • Admin Guide • Edit a Global User • Customize the User Profile Sections User Preferences • Change Editor Preferences • Display Preferences • Hide Technical Content • Extra Accessibility • Localization Preferences • Extension Preferences • Change Password The "User Preferences" section allows you to configure your default editor and to easily change your password. To access it: • click on your user avatar in the top menu bar • click the button to open the drawer menu, then on the user avatar or on your name

Next, in your user profile page, click on "Preferences" under "Settings" - for easy use, each field now has a documentation hint.

Page 246 XWiki Standard 9.8.1 User Guide

Change Editor Preferences

To change your editor preferences, click on the yellow pen icon in the top right corner. You may choose between "Text" and "Wysiwyg" as your default editor. More details about the editing modes are available in the dedicated documentation page. You may also select between the simple and advanced user, depending on your wiki needs. By selecting the simple user, you will have access only to the default editor. If you select the advanced user, you have a wide variety of edit options. More information regarding the simple and advanced editing are available in the dedicated documentation page listed in the "Related Pages" section.

Page 247 XWiki Standard 9.8.1 User Guide

Display Preferences Hide Technical Content

The XWiki users can decide if a document should be hidden which means that no event triggered by it will appear in the Activity Stream. To learn more about this feature, go to the documentation page about the simple and advanced editing. By selecting "Yes" in the "Display hidden documents" drop-down list, the hidden wiki pages and spaces will appear in the search results for you as well as for the other users. Extra Accessibility

By enabling the extra accessibility features from your user preferences, some visual elements will be added in order to help the visually impaired people navigate through the wiki: the links are underlined, the font is larger and stronger. This option is mostly useful for the screen readers. Localization Preferences

You can decide to use a specific timezone so that the dates reflect your current location without the need to make changes on the server. For this purpose, we have introduced the "Localization Preferences" section which contains a drop-down list you can select the timezone from.

Page 248 XWiki Standard 9.8.1 User Guide

Extension Preferences

By enabling the extension conflict setup option, you will be able to define the rules of the default conflict answer. This means that when installing an extension you can tell the Extension Manager how to handle: • a merge without conflict • a merge conflict • situations when a local modified version of the extension exists in the wiki but with no previous version available • cases when an extension page exists in the previous version of the extension but that same page was deleted from the wiki For more details, refer to the Extension Manager documentation listed under "Related Pages". Change Password

To change your password, click on the "Change password" button. A new page will appear asking you to fill in the current password and the new password. Click on "Save" and you are done.

Page 249 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • XWiki Login • XWiki Applications Overview • View the List of Joined Sub-Wikis • User Status • User Profile • Simple and Advanced Editing • Editing Modes • Dashboard Application • Activity Stream • Developer Guide • XWiki Extension Repository Connector • Maven Extension Repository Connector • Extension Module • Activity Macro • Active Installs Module • Admin Guide • XWiki Standard Installation and Upgrade • Extension Manager Application • Edit a Global User • Customize the Language and Timezone Settings • App Within Minutes Application User Status • Share A Status Message • Share a Message on Your User Profile Page • Share a Message on Another User's Profile Page • Delete a Status Message • Display the List of Users You Follow • Follow an User • Unfollow an User

Page 250 XWiki Standard 9.8.1 User Guide

The "Message Sharing" feature allows messaging and networking inside the wiki. Users can share their status messages which will displayed by the activity stream of their profile pages, as well as be the global one from the main home page.

The Message Stream Application is now disabled by default and needs to be enabled to activate the feature, as explained in the page "Enable / Disable the Message Stream" listed under "Related Pages". This was done in order to avoid cluttering the UI by default, considering that not all users would need the feature. Share A Status Message

The {{messageSender /}} macro allows posting a message on any wiki page. You can add this macro with the CKEditor or you can edit any page in "Wiki" mode and add the line below: {{messageSender /}}

Users can share a post on the main home page which will be visible: • to everyone • to followers • to a specific group

Page 251 XWiki Standard 9.8.1 User Guide

The XWiki Group Picker is used by default by all the XCLASS properties of type "List of Groups". After selecting a group from the drop-down list, it will be added to the right. If you want to remove the selected group, just hover it and click on the red "X" in the top right corner.

This feature does not allow you to share a message to several groups at once. • to a specific user

Page 252 XWiki Standard 9.8.1 User Guide

Similarly with the Group Picker, the User Picker is used by default by all the XCLASS properties of type "List of Users". After selecting the user from the drop-down list, it will be added to the right.

To remove it, hover the username and click on the red "X" in the top right corner. Also, just like for groups, you won't be able to share a message to several users at once. Recent posts will be displayed in the Activity Stream on the wiki home page.

Page 253 XWiki Standard 9.8.1 User Guide

Share a Message on Your User Profile Page

You can also share a message via your user profile page using the "Send Message" widget located "My Activity Stream".

Page 254 XWiki Standard 9.8.1 User Guide

Share a Message on Another User's Profile Page

You can share status messages on another user's profile page. In case the user is not in your network (i.e. you are not following him/her), the Share Message widget is automatically set in order for your post to be visible only for that user.

Page 255 XWiki Standard 9.8.1 User Guide

Delete a Status Message

To delete one of your status messages: • click on your user avatar in the top menu bar • click the button to open the drawer menu, then on the user avatar or on your name

Next, in your user profile page, click on "Network" under "Settings". In the "Network activity" widget, hover over the post you wish to delete, click on the red "x" in the top right corner near the creation date

Page 256 XWiki Standard 9.8.1 User Guide

and confirm.

Another way is to go to the main home page, hover over the post you wish to delete in the main activity stream, click on the red "x" in the top right corner near the creation date and confirm. Display the List of Users You Follow

To see the members of your network, click on your user avatar in the top menu bar,

then click on "Network" under "Settings" in your user profile page.

Follow an User

To follow the posts of another user, go his/her user profile page and click on "Follow".

Page 257 XWiki Standard 9.8.1 User Guide

Notice that the "Follow" button will then become "Following".

Unfollow an User

To unfollow an user, you have 2 options: • Go to the user profile page and click on the red "x" to the right of the "Following" button which will then become "Follow".

• Go to the "Network" tab from your user profile page, then click on the corresponding "Unfollow" link.

Page 258 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • View the List of Joined Sub-Wikis • Users and Groups Overview • User Profile • User Preferences • Registration • Dashboard Application • Activity Stream • Developer Guide • Activity Macro • Admin Guide • User Directory Application • The Management of Global/Local Users and Groups • Set the Users Access Rights • Enable / Disable the Message Stream • Edit a Global User • Edit a Global Group • Delete a Global User • Create a Global User Join a Sub-Wiki • Join an Open Wiki • Create a Request to Join a Wiki Join an Open Wiki

To join an open wiki, go to the Wiki Directory, then click on "Join" in the corresponding "Actions" column.

Page 259 XWiki Standard 9.8.1 User Guide

Next, in the "Join Wiki" page, click the "Yes" button to confirm.

Another way of joining an open wiki is by clicking on the "Join" button in the "Wiki Information" panel.

Page 260 XWiki Standard 9.8.1 User Guide

Create a Request to Join a Wiki

To become a member of a "join-by-request" wiki, go to the Wiki Directory and click on "Request Join" in the corresponding "Actions" column.

Page 261 XWiki Standard 9.8.1 User Guide

In the "Join Wiki" page, fill in the request message viewable by the administrator of the wiki and click on "Send Request".

If successful, you will see a confirmation message.

You will know that your request hasn't been accepted as long as see the message "You have requested to join this wiki" and the "Cancel Request" button in the "Wiki Information" panel.

Page 262 XWiki Standard 9.8.1 User Guide

Once the administrator accepts your request, the button in the "Wiki Information" panel will become "Leave Wiki" and your avatar will appear in the "Members" list.

Page 263 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Editing Modes • Admin Guide • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Create a Sub-Wiki Sub-Wiki Invitations • Check for Invitations • View an Invitation • Accept an Invitation • Reject an Invitation • Postpone an Invitation

Page 264 XWiki Standard 9.8.1 User Guide

Check for Invitations

To see whether you got any invitation to join an open or an "invitation-only" wiki, go to the Wiki Directory. The invitations are marked by a scroll icon in the "Actions" column of the livetable.

View an Invitation

Go to the Wiki Directory and click on "View Invitation" in the "Actions" column. You will be redirected to the "Join Wiki" page.

Page 265 XWiki Standard 9.8.1 User Guide

At this point, you have 3 options: accept, reject or postpone the invitation. Accept an Invitation

Go to the 'Join Wiki' page, fill in a message viewable by the wiki administrator and click on the "Accept" button. If successful, you will see a confirmation message.

Reject an Invitation

Go to the 'Join Wiki' page, fill in a message viewable by the wiki administrator to motivate your decision and click on the "Reject" button. If successful, you will see a confirmation message.

Postpone an Invitation

Go to the 'Join Wiki' page, fill in a message viewable by the wiki administrator and click on the "Later" button. You will be redirected back to the wiki directory.

Page 266 XWiki Standard 9.8.1 User Guide

Related Pages

• User Guide • View the List of Joined Sub-Wikis • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Admin Guide • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Create a Sub-Wiki View the List of Joined Sub-Wikis

To access the list of joined wikis: • click on your user avatar in the top menu bar • click the button to open the drawer menu, then on the user avatar or on your name

Next, in your user profile page, click on "Wikis" under "Settings". The wikis you are a member of are listed in the "Joined wikis" section.

Page 267 XWiki Standard 9.8.1 User Guide

Additionally, you may access the activity stream of the joined wiki(s) by clicking on the corresponding "show activity" link.

Related Pages

• User Guide • User Status • User Profile • User Preferences • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Activity Stream • Developer Guide • Activity Macro • Admin Guide • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Create a Sub-Wiki

Page 268 XWiki Standard 9.8.1 User Guide

Leave a Sub-Wiki

To quit a wiki, go to the Wiki Directory and click on "Leave" in the "Actions" column.

In the "Leave Wiki" page, click on "Yes"

and if successful, you will get a confirmation message.

Another way of leaving a wiki is to click on the "Leave Wiki" button in the "Wiki Information" panel and confirm.

Page 269 XWiki Standard 9.8.1 User Guide

You will not be able to leave a Wiki if you are its owner but another wiki administrator will have the rights to remove you from the user directory.

Related Pages

• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Join a Sub-Wiki • Editing Modes • Admin Guide • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Create a Sub-Wiki

Page 270