XWiki Standard 9.8.1 Administrator Guide XWiki Standard 9.8.1 Administrator Guide
Table of Contents
XWiki Applications Overview ...... 16 Other XWiki Applications Overview ...... 168 Users and Groups Overview ...... 203 Rights Overview ...... 249 Customization Overview ...... 278 XWiki Setup Overview ...... 311
Page 2 XWiki Standard 9.8.1 Administrator Guide
• Attach Large Files • Page Template Providers • XWiki Applications Overview • Applications Panel • App Within Minutes • Extension Manager • Flamingo Color Theme Application • Import - Export Application • Logging Application • Mail Features • Menu Application • Notifications Application • Panels Application • Skin Application • User Directory Application • User Profile Application • WebDAV • Other Applications • Admin Tools Application • Statistics Application • Users and Groups Overview • Add a Global User • Edit a Global User • Delete a Global User • Add a Global Group • Edit a Global Group • Delete a Global Group • The Management of Local/Global Users and Groups • Manage Sub-Wiki Members • Rights Overview • Wiki Rights • Set the Page Access Rights • Group Rights • User Rights • Permission Types • Customize the User Registration Process • Customization Overview • Configure an Office Server • Configure Annotations • Customize the Language and Timezone Settings • CKEditor Configuration • Customize the Search Feature • Search Suggest Sources • Disable the Message Stream • Activate and Configure Google Analytics • XWiki Standard Setup Overview • Distribution Wizard • XWiki Standard Installation and Upgrade • MySQL Installation and Configuration • Create a Wiki • Wiki Directory • Modify Wiki Settings • Delete a Sub-Wiki Attach Large Files
XWiki Standard has a new file-system attachment storage allowing you to add very large attachments to the wiki documents. This feature is disabled by default, but you can enable it by editing the xwiki.cfg file and by making the following changes under the Storage section: #-# The attachment storage. xwiki.store.attachment.hint=file #-# The attachment versioning storage. Use 'void' to disable attachment versioning. xwiki.store.attachment.versioning.hint=file #-# The attachment recycle bin storage
Page 3 XWiki Standard 9.8.1 Administrator Guide xwiki.store.attachment.recyclebin.hint=file In order for the changes to be taken into account, you will have to restart the server. Next, you need to set the maximum size of the attachment. To do that, just edit the XWiki.XWikiPreferences page in "Objects" mode (e.g. ServerName/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object) and replace the value of the "Maximum Upload Size" property with a huge number (for instance "999999999999").
Store Attachments on the Filesystem
In order to move the attached files from the database to the file-system, you can use the "Filesystem Attachment Porter" tool available here. You just have to download the snippet, edit it and copy the code in any wiki page, for instance in "XWiki.FSPorter". The first step is to enable the file-system attachment storage as explained in the above section, then to restart the server. If the configuration is correct, when you navigate to "XWiki.FSPorter" you should see the following 3 lines colored in green: * org.xwiki.store.legacy.store.internal.FilesystemAttachmentStore@3b69d6d3 * org.xwiki.store.legacy.store.internal.FilesystemAttachmentVersioningStore@2196d51e * org.xwiki.store.legacy.store.internal.FilesystemAttachmentRecycleBinStore@3581b5cc
The attachments will be copied from the database into the permanent directory set for the servlet container. Note that the file-system porter will copy the attachments from the database to the storage folder but it will not delete the entries from the database. It is recommended to keep the attachments in the database that after the copy process finishes. The "Dry Run" option allows you to do a simulation in order to check for corrupted attachments without necessarily having the file-system storage enabled.
The "Verbose" option displays each attachment as it is processed. Once you click the "Start" button, the script will work in 20 second chunks and print the results of each chunk. In order for the script to switch to the next chunk you will have to click the "Continue" button.
Page 4 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • Page Attachments • Developer Guide • Zip Explorer Plugin • Attachment Selector Macro • Admin Guide • WebDAV • Admin Tools Application Template Providers • Create a Template Provider • Location Restrictions
Page 5 XWiki Standard 9.8.1 Administrator Guide
• Template Hierarchies Create a Template Provider
Template providers allow to create wiki pages using an existing template. To create a page template provider, click the
button in the upper right corner which will open the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Content" in the accordion menu to the left, then on "Page Templates".
Page 6 XWiki Standard 9.8.1 Administrator Guide
Under "Available Template Providers" you will notice 8 entries: • Blog Post Template Provider allowing to create a blog article • Space Dashboard Template Provider - allows creating a dashboard page • Contributors Template Provider - allows to create a Contributor page as part of the Help Center Application • Movies Template Provider - allows to create a Movie page as part of the Help Center Application • 4 page template providers corresponding to the 4 new templates included by default in XWiki Standard 8.2.x that are detailed in the page creation documentation: • Simple Page • Article Page • Encyclopedia Page • Meeting Report Next, fill in the template provider title and the location in the page hierarchy where the new page will be created.
Page 7 XWiki Standard 9.8.1 Administrator Guide
Additionally, you may check the "Terminal Page" option which means that the template provider page won't have any child pages. Note that this option is available only for advanced users. To set the page location, click the blue editing pen icon, which will load 2 more fields: • Parent - the parent of the new page; when choosing the page 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 8 XWiki Standard 9.8.1 Administrator Guide
Another way of selecting a location is to click on the blue hierarchy icon and select a parent from the document tree or to search it using the integrated finder.
Page 9 XWiki Standard 9.8.1 Administrator Guide
After clicking on "Create", the template provider document will automatically open in "Inline" mode. The "Provider Name" field is the one displayed in the list of available template providers from the "Templates" section in the wiki administration. The "Template Name" input represents the name displayed in the list of available templates when the create page form is launched. Its value can also be a translation key in order to allow internationalization of the template name. Provided you have checked the "Terminal Page" option in the previous screen, you will see a "Terminal Page" drop-down referring to whether or not to create terminal documents when using the current template provider. By default, the selected option is "Yes" but you can still override it by manually unchecking it so that the page is created as nested instead. Given that for regular users the "Terminal Page" checkbox is not displayed in the previous step (thus, it is selected by default), the page created using the current template provider will keep the same preference i.e. it will be a terminal page.
Page 10 XWiki Standard 9.8.1 Administrator Guide
You can add a Font Awesome icon and a description in order to display additional information in the list of template providers. The full list of supported icons is available in the page IconThemes.FontAwesome. The "Action on Create" option allows you to decide whether the new document will be saved or not before being opened for edition and the possible choices are "Edit" and "Save and Edit". Location Restrictions
You may enforce visibility restrictions i.e. decide on which locations the template provider will be visible to an user who wishes to create a new page. To so so, click the + icon below "List of locations where the template must be available" and select them from the page tree - in case you don't specify any location, the template will be available from any wiki page.
Template providers that are restricted to certain locations are also available from the children of those pages. The second type of restrictions refer to the list of locations where the template provider allows the creation of pages in order to control where users are allowed to create various types of content. A provider with no creation restrictions can be used to create pages anywhere in the wiki.
Page 11 XWiki Standard 9.8.1 Administrator Guide
Another implicit effect of such a restriction is the automatic fill of the destination location in the "Create Page" form. This means that when you switch template types in the creation form, the parent location field will be pre-filled with one of the template restrictions, provided the newly selected template has a creation restriction. The restrictions will used in the "Create Page" form to validate the "Location" -> "Parent" field.
On the other hand, if in a template provider has the "Creation Restrictions as Suggestions" option is checked, then the creation restrictions will not be enforced and will be used simply for identifying the default parent location that is pre-filled in the creation screen. The user will still be able to change the parent and choose an option outside the restrictions.
To add a creation restriction, click on the + icon below "Creation restrictions" and select one or multiple locations from the page tree.
Page 12 XWiki Standard 9.8.1 Administrator Guide
When a template has a creation restriction matching the current location or the parent of the current location, you will notice that, in the page creation screen, the page type "promotes" a certain template meaning that it is automatically selected. For instance, when trying to create a page from the Blog home page or any Blog post, you will see that the "Blog Post Template" is displayed first in the list and that it is pre-selected.
Page 13 XWiki Standard 9.8.1 Administrator Guide
In case multiple such providers are detected for the current location from which the user is trying to create a new page, all of them will be pushed to the top of the list. However, they will be sorted based on the specificity of the matching creation restriction, so that the restriction that matches the current location best is listed first and it is the pre-selected one. After clicking on "Save & View" to complete the process,
click on "Go back to the Wiki Administration".
Template Hierarchies
Supposing the document specified by the template provider - the page "Ideas.IdeasTemplate" - we created earlier is a non-terminal page and that it has 3 child documents:
Page 14 XWiki Standard 9.8.1 Administrator Guide
• "Idea Template Admins" • "Idea Template Managers" • "Idea Template QA"
This structure is named a "template document hierarchy" and whenever you create a new document using the "Idea Proposal" template, the entire hierarchy will be copied to the location of that new page. So, if you choose to create a new page using "Idea Proposal",
the first time you hit "Save & View" you will notice a message at the bottom of the form with a percentage representing the progress of the template hierarchy copy process.
Related Pages
• User Guide • Wiki Pages • Help Center Application • Admin Guide • XWiki Applications Overview
Page 15 XWiki Standard 9.8.1 Administrator Guide
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 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.
Page 16 XWiki Standard 9.8.1 Administrator Guide
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 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
Page 17 XWiki Standard 9.8.1 Administrator Guide
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. Applications Panel
The "Applications" panel in the column on the left shortcuts to the applications installed in the wiki so that you can quickly access them. Wiki administrators have an extra section available named "More applications" with links to the Extension Manager and App Within Minutes.
Page 18 XWiki Standard 9.8.1 Administrator Guide
Provided you are a wiki administrator, you may customize panel width via the "Look & Feel" -> "Panels" -> "Page Layout" section in the wiki preferences page, as detailed in the Panels Application documentation. When the size is set to "Small", the panel becomes a "dock" bar. The "Look & Feel" -> "Applications Panel" section in the wiki preferences page allows administrators to choose which ones of the installed applications will be displayed in the wiki sidebar.
To hide an application, just drag & drop its corresponding icon from the "Applications in the bar" box to "Applications not in the bar", then hit "Save".
Page 19 XWiki Standard 9.8.1 Administrator Guide
In older versions, applications were listed alphabetically, which was quite limiting for the users. This is the reason why newer versions have support for reordering items. 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. In order for them to still be discoverable, XWiki added in the "Application Index" option to the drawer menu.
Page 20 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • Nested Page Actions • Admin Guide • XWiki Applications Overview • Panels Application App Within Minutes Application • View Your XWiki Applications • Create an XWiki Application • Set the Application Name • Define the Structure of the Application • Entries Restrictions • Customize the Home Page • Edit the Application • App Within Minutes User Roles • Translate Your Application • Edit the Application Class • Edit the Application Home Page • Add Entries • Edit an Entry • Delete the Application Entries • Delete an Application XWiki Standard comes with the "App Within Minutes" wizard to help you create collaborative applications within minutes which are based on the XWiki's structured data management system.
Page 21 XWiki Standard 9.8.1 Administrator Guide
View Your XWiki Applications
To display your available web applications, click on "More applications" then on "Create your own" link in the "Applications" panel to the left.
You should then see the main page containing a livetable with all your web applications, if any. By default you should see 4 applications bundled with XWiki Standard that are created using AWM: • Contributors (demo application that is part of the Help Center Application) • Menu • Movies (demo application that is part of the Help Center Application) • Tour
Page 22 XWiki Standard 9.8.1 Administrator Guide
Create an XWiki Application
To create an application, click on "Create Application" which will launch a wizard to guide you through the process. Set the Application Name
The first step consists of establishing the name of the application which is used to determine: • the name and URL of the home page • the URL of the application's Code location • the URL and name of the class containing the structure of the application
You can use the "Location" field to set the location of the page hierarchy where to create the application. To modify the default location (i.e. under the wiki's "Main" location), click on the blue editing pen icon and select the parent. You may leave the field empty in order to create a top-level page.
You can also click the blue hierarchy icon and select the parent from the page tree or to search for it using the integrated finder.
Page 23 XWiki Standard 9.8.1 Administrator Guide
Click on the "Next Step" button once you are done. Define the Structure of the Application
The second step is about defining the class containing the application structure. The available fields are mapped directly to XClass property types:
App Within Minutes Field XClass Property Type Short Text String Long Text TextArea Number Number Boolean Boolean Static List Static List Date Date User List of Users Group List of Groups Database List Database List or mapped to a page field:
Page 24 XWiki Standard 9.8.1 Administrator Guide
• Content for which the value will be stored in the content of the application entry i.e. the content editable in "Wiki" or "Wysiwyg" mode • Title for which the value will be stored in the title of an application entry Note that you will only be allowed to use one "Content" or "Title" field per application. Supposing you want to create an application which lists all your present and former employees, you will need 8 properties in the class: • a "Title" field for the title of the application entry • a "Short Text" field for the first name • a "Short Text" field for the last name • a "Short Text" field for the email address • a "Static List" field for the availability of each employee: active or inactive • a Date Picker for the ending date of the contract • an "User" field for the manager • a "Content" field for any additional comments To do so, you just have to drag and drop the fields from the palette to the right. For the first name, last name and email address we will choose the "Short Text" field.
"Short Text" is the default "pretty name" of the property. In order to change it to "First Name", click on the text and start editing. You will notice that the background color will change.
To configure the property, hover it and click on the key icon in the top right corner.
Page 25 XWiki Standard 9.8.1 Administrator Guide
In the input just below "First Name" you can enter the default value to use when creating employee entries. The "Name" text- box refers to the name of the class property. When you are done, click on the green "Accept" icon in the top right corner to apply the changes.
In case you have changed your mind about using this field, you can delete it by clicking on the red "X" in the top right corner. For the other 2 fields, "Last Name" and "Email", just repeat this process. For the "Title" property you must know that visually there is no difference between this field and a "Short Text" field.
In order to define the availability of each employee, we will use a "Static List" field. By default, there are 3 options available.
To configure the list, click on the "key" icon in the top right corner. If you want to add an option, enter the "Value" and the "ID" then click on the green "+" icon.
Page 26 XWiki Standard 9.8.1 Administrator Guide
To remove an option, hover it and click on the "X" in the top right corner.
Add the "Inactive" option and save the changes.
For the ending date of the contract, drag-and-drop the "Date" picker field from the palette. You may change the date format and specify the current date as default value by selecting the "Empty Is Today" check-box.
Page 27 XWiki Standard 9.8.1 Administrator Guide
For the "Manager" column we will use the "User" field. The XWiki User Picker is used by default by all the XCLASS properties of type "List of Users".
The picker displays the user avatar and a link to the user profile and it allows you to select one or multiple default values, provided the "Multiple Select" option is checked.
If the "Multiple Select" option is checked, each selected user will be added to the list above the picker.
Page 28 XWiki Standard 9.8.1 Administrator Guide
In case you want to delete the default value in singleton mode, you may either select another user or hover the current user name and click on the red "X" in the top right corner.
In multiple select mode, you may remove all the users from the list by clicking on the "Clear selection" link. Visually, the "Content" field is equivalent to a "Text Area" property and it will load the default editor you have set in your user preferences page.
Click on the "Next Step" button when you are done. Entries Restrictions
The App within Minutes wizard has a new step - Entries - that generates a template provider allowing to expose the application in the "Create Page" dialog. This means that from now on you can create entries from both the application home page and using the "Create Page" dialog.
Page 29 XWiki Standard 9.8.1 Administrator Guide
You may associate a Font Awesome icon and a description to the template provider - these 2 elements will be displayed in the "Create Page" dialog. The full list of supported icons is available in the page IconThemes.FontAwesome. The field "From where to create the entries" allows to enforce visibility restrictions i.e. decide on which locations the application's template provider will be visible to an user who wishes to create entries. To so so, click the + icon and select them from the page tree - in case you don't specify any location, the template will be available from any wiki page.
The second type of restrictions - the field "Where to create the entries" - refers to the list of locations where the template provider of the application allows to create entries. By default, the users are allowed to create pages only in the location storing the application home page (Employees in our case).
Page 30 XWiki Standard 9.8.1 Administrator Guide
Another implicit effect of creation restrictions is the automatic fill of the location in the "Create Page" form. This means that the parent location field will be pre-filled with one of the template restrictions, provided the newly selected template has a creation restriction. The restrictions will used in the "Create Page" form to validate the location field.
On the other hand, if the "Don't enforce entry location" option is checked, then the creation restrictions will be used simply for identifying the default parent location that is pre-filled in the creation screen. The user will still be able to change the parent and choose an option outside the restrictions.
Page 31 XWiki Standard 9.8.1 Administrator Guide
Customize the Home Page
The last step allows you to customize the web page of your application, by adding a description and by managing the columns of the livetable in which the entries will be displayed.
To add a column, select it from the drop-down list then click on the green "+" button. Your may choose between the generic livetable columns or you may add the ones corresponding to the fields created earlier.
Page 32 XWiki Standard 9.8.1 Administrator Guide
To remove a column, hover it and click on the "X" in the top right corner. It is also possible to move the columns from right to left with a simple "drag and drop".
You may associate an icon with your application by providing a reference to an 16x16 icon. In order to make the image selection easier, App Within Minutes provides an icon picker with a default preview for Font Awesome icons.
Page 33 XWiki Standard 9.8.1 Administrator 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.
Click on "Finish" to see the home page of your web application.
Page 34 XWiki Standard 9.8.1 Administrator Guide
The new "Employees" application will then appear in the "Applications" panel to the left.
At this point, you have 2 options: go back on editing the application class or start adding entries. Edit the Application App Within Minutes User Roles
In older XWiki versions, the entire structure of an application created with App Within Minutes (class, sheet, template, translation pages and so on) was stored in the same location as the application entries. The main issue was the fact that it was not possible the separate users with rights to modify the application structure from the ones with privileges limited to the application entries only. This is why XWiki has introduced support for user roles and a Code location which is marked as "hidden". The "Code" location holds: • The application class page,
Page 35 XWiki Standard 9.8.1 Administrator Guide
The old Data location was removed and now all application entries are created by default under the application home page. To change this setting, use the fields • "From where to create the entries" • "Where to create the entries" and the option "Don't enforce entry location" as explained in the previous section. This way, you can have a dedicated permissions scheme for: • users who can edit or delete the application's structure like the sheet, template and class page and application code pages in general. • users with privileges to create, edit and delete application entries, but who cannot modify the application structure. Besides the "Code" location, the App Within Minutes wizard creates the following wiki pages initially: • The application home page having the same name as the application. • The Preferences page from which you can grant administration rights to the application creator in order to be able to delete all the application entries. In this page you can define a group with privileges to modify the application entries.
Page 36 XWiki Standard 9.8.1 Administrator Guide
A user with privileges to modify the application structure will see the "Actions" panel below
whereas users with rights limited to the application entries will see the "Actions" panel below.
Backward compatibility is preserved, so you should still be able to edit existing applications that don't have the new page organization. Translate Your Application
The App Within Minutes wizard generates a page translation bundle which allows you to translate the pretty names of class properties and livetable columns. In this case there are 2 scenarios. If you already have an application which was created with App Within Minutes, you will just have to edit it and save it in order to generate the new translation bundle. In case your wiki is set for multilingual support go to the application home page and click on "Translate Application" in the "Actions" menu.
Page 37 XWiki Standard 9.8.1 Administrator Guide
The link will redirect you to the page translation bundle. If you don't need to modify any translation keys, just scroll down and save the page.
Edit the Application Class
In the application home page, click on the "Edit Application" link located in the "Actions" panel.
Page 38 XWiki Standard 9.8.1 Administrator Guide
You will then get back to the second step of the wizard. In order for the changes to be reflected on the class sheet, class template and translations, the options "Update the Sheet", "Update the Template" and "Update the Translation" are selected by default.
Edit the Application Home Page
Click on "Next Step" and you will be redirected to the third step of the wizard where you may modify the description, change the icon as well as the way the columns are displayed. Click on "Finish" when you are done and you will get back to the application main page. Add Entries
To create an entry either: • Go to the application home page and click on the "Add New Entry" link located in the "Actions" panel. A popup will appear, requiring to specify the name of the entry.
Page 39 XWiki Standard 9.8.1 Administrator Guide
• Go to any location specified in the field "From where to create the entries", click the "+" button and select the option "Employees" under "Type" -> "Templates". As explained in the previous section the parent field should be pre-filled.
By clicking on the green "+" or on the "Create" button respectively, the new page will open in "Inline" mode and will contain all the class fields you have added earlier. To enter a date, just click inside the "Contract Ending Date" text-box which will open the calendar picker.
Page 40 XWiki Standard 9.8.1 Administrator Guide
After filling in all the fields, click on "Save & View".
Page 41 XWiki Standard 9.8.1 Administrator Guide
You will then see the wiki page containing the new entry.
Page 42 XWiki Standard 9.8.1 Administrator Guide
The new entry is also listed in the livetable from the application home page.
Page 43 XWiki Standard 9.8.1 Administrator Guide
Edit an Entry
To edit an entry, go to the application home page and click on the corresponding "Edit" button in the "Actions" column of the livetable (see in the above image). Delete the Application Entries
To remove all the application entries without deleting the application, go to the application home page and click on "Delete All Entries".
Next, click on "Yes" to confirm and send all the application entries to the recycle bin.
Delete an Application
To delete an application, go to the home page then click on "Delete Application" in the "Actions" panel.
Page 44 XWiki Standard 9.8.1 Administrator Guide
You will then see an information message announcing you that all pages in the space "Employees" will be moved to "Recycle Bin". Click on "Yes" to confirm.
To recover the application, navigate to the wiki index and click on the "Deleted Pages" tab, then restore then entire batch as explained in the "Restore Deleted Pages and Attachments" section of the "Index Application" documentation.
Page 45 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Preferences • Nested Page Actions • Internationalization • Index Application • Developer Guide • XWiki Velocity Macros Overview • XWiki Rendering Macros in Java Overview • XWiki JavaScript API • XWiki Data Model • Spaces Macro • Space Index Macro
Page 46 XWiki Standard 9.8.1 Administrator Guide
• Localization Module • Livetable Macro • Include Macro • Admin Guide • XWiki Applications Overview • Menu Application • Extension Manager Application • Customize the User Profile Sections • Customize the Language and Timezone Settings Extension Manager Application • Description • Access the Extension Manager • Install an Extension from the Main Wiki • Default Conflict Answer • The Advanced Search • Browse the Installed Extensions from the Main Wiki • Upgrade an Extension • Merge Conflict • Downgrade an Extension • Uninstall an Extension • Search for XWiki Core Extensions • The Extension Updater • Extension History This Extension Manager is a feature for installing, uninstalling, upgrading and downgrading XWiki extensions. Description
The Extension Manager allows you to: • download extensions from a remote repository to a local repository • install, upgrade, downgrade and uninstall any type of extension as long as you have a handler • browse the list of installed extensions • compare the extension versions • see a short description of each extension • see the list of dependencies for an extension • see if the extension you are about to install is compatible or not with the current XWiki Enterprise instance • check whether there are newer versions of the installed extensions • access the history of the extension-related actions and replay history records You can install an extension on the whole farm or only the main wiki. Starting with version 8.0 each feature has its own version which by default is the version of the extension. This can be useful when some embedded extension is not in sync with the extension or in case for some reason a new version of an extension starts from version "1.0". At the moment, the Extension Manager supports the following repositories: • the xwiki.org Extensions Repository which is currently searchable • the XWiki Public Nexus Maven Repository
In order to be able to install extensions from the XWiki Public Nexus Maven Repository, you can use the Advanced Search. To add more repositories, go to the Extension Module documentation page. It is also possible to add a constraint on where an extension should be installed (only root namespace etc.). For Maven, you can do it by using the
For an administrator user there are 2 ways of accessing the Extension Manager. The first one is by clicking on "More applications", then on "Install new applications" in the "Applications" panel to the left.
Page 47 XWiki Standard 9.8.1 Administrator Guide
The second possibility is by clicking the button to open the drawer menu, then on "Administer Wiki".
In the accordion menu on the left, click on "Extensions" and then: • again on "Extensions" in order to: • search for XWiki recommended extensions • install extensions
Page 48 XWiki Standard 9.8.1 Administrator Guide
• browse the installed extensions • see the list of extensions that make the XWiki core • on "History" to access the track of the extension-related actions or reuse the recorded upgrade decisions made with Distribution Wizard • on "Updater" to check for updates for the installed extensions
If you wish to install an extension on a specific sub-wiki, you need to access the Extension Manager of that sub-wiki. The steps are the same as for the main wiki. Install an Extension from the Main Wiki
When using Extension Manager from the main wiki, it is now allowed to install or upgrade an extension which requires upgrading or installing a farm level dependency. Moreover, the wizard automatically prompts to install on farm a new dependency that is indicated as constraint. Note that this is still not possible to do from a sub-wiki in the standard UI but any script with Programming Rights can enable the option in the install request. To install an extension in the main wiki, click on "Extensions" -> "Extensions" in the preferences page. You may browse through the list of available extensions by typing the extension name or a keyword in the text input and hitting Enter or clicking the magnifying glass button. There are 4 extension categories: • local extensions which are cached locally and remain cached even after uninstalling them; by default they include the extensions bundled with the standard XWiki distribution • installed extensions - in this category are the local extensions and the ones installed by users • core extensions • remote extensions published on http://extensions.xwiki.org
The Extension Manager displays only recommended remote extensions by default. In case no recommended extension is found for the provided search, you can browse the entire xwiki.org Extensions repository by clicking the "All Extensions" button and entering a keyword in the text input. The ratings are displayed in read-only mode, so in order to rate an extension you need to access the XWiki Extensions Repository.
Page 49 XWiki Standard 9.8.1 Administrator Guide
Let's take the Google Apps Application extension - by clicking on "Show Details" then on the "Description" tab you will notice some extra information like the group ID, the artifact ID or the list of stable releases that can be downloaded from the configured extension repositories. In case you are interested in what the source code looks like, click the "Sources" link which redirects to the corresponding GitHub repository.
Page 50 XWiki Standard 9.8.1 Administrator Guide
The "Dependencies" tab lists extensions or packages you have to install in order for the current one to function correctly. In the case the the App Within Minutes application, you will notice that some dependencies are marked as "Provided", whereas others are "Installed as dependency". This differentiation was introduced in order to distinguish between the extensions that have been installed directly by you or by a different user and the ones that have been installed as transitive dependencies.
Page 51 XWiki Standard 9.8.1 Administrator Guide
If the extension version is incompatible with your wiki instance, you will see a red status message. To find a compatible version, you can either use the Advanced Search or click on the "Description" tab and choose one of the "Stable versions".
Page 52 XWiki Standard 9.8.1 Administrator Guide
Supposing you want to install the version 8.1.2 of the "FAQ Application", click on "Install" and you will be prompted about the new extension.
A very important detail you should take into account is that by clicking on "Install" the extension will only be installed on the main wiki.
Page 53 XWiki Standard 9.8.1 Administrator Guide
Should you decide to install it on the sub-wikis too, just click on "Install on Farm". In both cases, click on "Continue" to confirm and start installing the extension.
Page 54 XWiki Standard 9.8.1 Administrator Guide
Since the process is asynchronous, you will soon see a progress bar. Also, the install log is progressively displayed in order for the user to receive constant feed-back. Once the progress bar has reached 100%, if you search for the "FAQ Application" in the installed extensions, then click on the "Description" tab, you will see the install log and a message saying the extension was installed on the "Home" namespace.
Page 55 XWiki Standard 9.8.1 Administrator Guide
In case the extension job fails, the error message is extracted and displayed so that the user can click on it and access the stack trace. If an extension is installed only on a sub-wiki, you have the option to install it on the farm directly from the UI.
Page 56 XWiki Standard 9.8.1 Administrator Guide
Default Conflict Answer
When installing XAR extensions, you might get conflicts that are mostly caused by changes made locally to extension pages. In such cases, Extension Manager will try to choose the safest way to workaround the conflict but, provided you have enabled the extension conflict setup in the user preferences page, you will see a "Default Conflict Answer" screen in the install log allowing you to change the default behavior.
The "Successful Merge" option dictates how will Extension Manager handle a merge without conflict: • prompt the user and ask what to to • keep the document already found in the wiki • perform an automatic merge • install the document found in the new extension version • install the document found in the previous version of the extension
Page 57 XWiki Standard 9.8.1 Administrator Guide
Similarly, the "Failing Merge" option lets you choose what will Extension Manager do in case of a merge conflict.
It is also possible that there is a local modified version of the extension in the wiki but with no previous version available. This is when the "Current Already Exist" option proves to be useful, because you can tell Extension Manager to: • prompt you and ask you what to do • keep the document already found in the wiki • install the document found in the new extension version
Finally, if an extension page exists in the previous version of the extension but that same page was deleted from the wiki, you may tell Extension Manager to: • prompt you and ask you what to do • keep the wiki situation as it is • install the document found in the new extension version • install the document found in the previous version of the extension
The Advanced Search
You may search for the extension ID and version by clicking on the "Advanced search" link. The ID of a Maven extension has the following syntax: groupId:artifactId.
Page 58 XWiki Standard 9.8.1 Administrator Guide
Click on "Search" to display the results.
If you are not sure about the group ID and the artifact ID, go back to "All Extensions" and search for the one you wish to install. Next, click the "Show Details" button and you will find the necessary information in the "Description" tab. Also, the released versions of the extension are available by clicking on the "Stable versions" link.
Browse the Installed Extensions from the Main Wiki
To see the installed extensions, go to the Extension Manager home page and click on "Installed Extensions" in the drop-down list next to the search button. You will then see the recently installed FAQ Application listed in the results page with a green "Installed" status.
Page 59 XWiki Standard 9.8.1 Administrator Guide
If you chose to install the extension on the whole farm, you will see an "Upgrade on Farm" or an "Uninstall from Farm" button and the "Description" tab will display the message "Installed globally", as well as the date and the user who installed it (in this case it is the user "Rose Anderson").
Page 60 XWiki Standard 9.8.1 Administrator Guide
If the extension has only been installed on the main wiki and then on individual sub-wikis, you will see an "Installed on the following namespaces:" message in the "Description" tab. Just like in the previous case, Extension Manager displays the date and the user(s) who installed the extension on each sub-wiki.
Page 61 XWiki Standard 9.8.1 Administrator Guide
The user and date information is available only for extensions installed or upgraded from version 7.0, whereas extensions that are already installed have this information only if they were installed directly i.e. not as dependency.
For extensions marked as "Invalid" you will notice a "Repair" button due to the fact that the Extension Manager automatically tries to repair any invalid dependency.
Page 62 XWiki Standard 9.8.1 Administrator Guide
Upgrade an Extension You can only use Extension Manager to upgrade the extensions installed by the user, i.e. not the core extensions. Start by accessing the Extension Manager's "Extensions" tab, select "All Extensions" or "Recommended Extensions" in the drop-down list and search for the extension you wish to upgrade. Supposing you have previously installed version 1.5.6 of the Meeting Application, if you search for it again, you will notice an "Upgrade" button. In case you have installed the application on the sub-wikis too, you will see an "Upgrade on Farm" button. The search results always display the most recent version of the extension which might not be compatible with the current XWiki runtime. To look for a compatible version, you can use the Advanced Search or the list of "Stable versions". Click the "Upgrade" or the "Upgrade on Farm" button,
then on "Continue" and you will be notified about the version to which your extension will be upgraded (1.6 in our case).
Page 63 XWiki Standard 9.8.1 Administrator Guide
If you then go to the installed extensions and search for the "Meeting Application", you will see that the new version is now 1.6.
To see the differences between the old version (1.5.6) and the new version (1.6), click on "Uninstall from Farm", then on "Compute changes". Note that transitive dependencies are automatically taken into account. A job will be launched in order retrieve the local changes that have been made on the wiki pages of the extension.
Page 64 XWiki Standard 9.8.1 Administrator Guide
Click the "Changes" tab to see more details: the "Summary" diff displays the type of entity that was modified - "Object", "Page property" (content, default language, class properties, attachments etc.) - 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. The screen-shot below illustrates the differences between version 6.4.5 and 7.1.2 of the FAQ Application.
Page 65 XWiki Standard 9.8.1 Administrator Guide
Merge Conflict
When downgrading or updating an extension, the Extension Manager compares the original UI package with the current UI in the wiki, as well as the changes introduced between the original UI package and the new UI package and tries to merge those changes to produce a resulting document. In case of conflict, it provides 3 possible actions: • install the merged version • install the new version of the document which means the previous changes will be discarded • keep the current version
Some changes that could trigger a conflict include: • A new page has been added to the wiki which is also a part of the new UI • A new feature or an improvement has been added to the wiki • The page is a configuration page part of the UI, the default configuration has been changed in the wiki and the new UI has new default value for the same settings • The access right of a page from the UI has been changed in the wiki and the new UI has different default rights for the same page To help you choose an action, Extension Manager provides a diff for: • the previous version which is in fact the original version of the page in the old UI package • the current version of the page in the wiki • the new version of the page in the new UI package • the merged version - the version computed by the Extension Manager, containing a merge of local changes and the new UI changes
Page 66 XWiki Standard 9.8.1 Administrator Guide
The "Summary" displays the type of entity that was modified - "Object", "Page property" (content, default language etc.) 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.
It is possible for the Extension Manager to not display the original version of the page. This usually happens when: • the page is new in the new version UI but it also exists locally in the wiki • the package of the original UI has not been repaired properly The additional option "Resolve automatically" you to resolve all the remaining merge conflicts automatically by choosing the same option as the one you select in the "Merge Conflict" drop-down list. If necessary, you might be prompted to delete extension pages found in the wiki that have been removed from the new version because they have become obsolete.
Page 67 XWiki Standard 9.8.1 Administrator Guide
Downgrade an Extension
The Extension Manager comes with a new "Downgrade" feature which is available using the Advanced Search or by choosing the extension version from the list of "Stable Versions". Supposing you have installed the version 8.1.3 of the FAQ Application and you want to install version 8.1, go to the Extension Manager's "Extensions" tab and click on "Advanced search". Fill in the 2 text-boxes like in the image below, then click on "Search".
You will be then notified that the version 8.1.3 of the application is already installed. Another possibility is to search for the FAQ Application in the extensions repository, click on the "Description" tab, then finally click on "8.1" under "Stable versions". Click on "Downgrade" or on "Downgrade on Farm" in case you have installed the application on the sub-wikis too,
Page 68 XWiki Standard 9.8.1 Administrator Guide
then on "Continue" to confirm.
Just just in the case of upgrade, you can use the "Compute Changes" feature to generate a diff between the old version (8.1.3) and the new one (8.1). You might also be prompted to delete unused pages. Uninstall an Extension
To uninstall an extension, go to the list of installed extensions then click on the corresponding "Uninstall" button or on the "Uninstall from Farm" button in case you have installed the extension on the sub-wikis too.
Page 69 XWiki Standard 9.8.1 Administrator Guide
In the "Progress" tab, you will be prompted about the list of packages you are about to remove: click on "Continue" to confirm.
You will then be prompted about the list of pages that are about to be deleted. By default all of them are selected, except for the case when there are modified pages. These ones will be left unselected so you won't lose your changes.
Page 70 XWiki Standard 9.8.1 Administrator Guide
Click on "Continue" to confirm removing all the selected items. To uninstall the extension only from a specific sub-wiki, follow the same steps, but using the Extension Manager of that sub- wiki. Search for XWiki Core Extensions
The Core extensions are bundled with XWiki Standard and they are available in the Extension Manager's "Extensions" tab if you select "Core extensions" in the drop-down list, then click the search button. Note that you cannot to uninstall, downgrade or upgrade any of the core extensions using the Extension Manager. To upgrade a core extension, you will need to upgrade the XWiki Standard WAR.
Page 71 XWiki Standard 9.8.1 Administrator Guide
The Extension Updater
The "Extensions" -> "Updater" section lists available updates for the installed extensions. To begin looking for newer extension versions, click on "Check for updates" or on "Check for updates on farm".
Page 72 XWiki Standard 9.8.1 Administrator Guide
The "Invalid Extensions" are incompatible with your current distribution and they have compatible new versions; these ones require an upgrade or a downgrade and are marked by a red status bar. The extensions marked by a yellow message still work with your current distribution but there are newer versions available.
To upgrade an extension, click on the corresponding "Upgrade" or "Upgrade on Farm" button and follow the on-screen instructions. In case the displayed information is outdated, just click again on "Check for updates" or on "Check for updates on farm".
Page 73 XWiki Standard 9.8.1 Administrator Guide
Extension History
Extension History is a new feature that records and displays extension-related actions like installing, upgrading, downgrading, repairing and uninstalling. Moreover, administrators can replay them at any time and even export them in order to replay the same decisions on another sub-wiki.
To access the Extension History, click on "Extensions" -> "History" in the accordion menu from the wiki administration page.
Page 74 XWiki Standard 9.8.1 Administrator Guide
The feature is particularly important when performing an upgrade with the Distribution Wizard: in case you have a large number of sub-wikis on your farm and most of them were created from the same template, it is enough to record the merge conflict decisions on one wiki, then to simply replay them on all the others. To learn more, please refer to this link. Finally, an administrator can keep track of the extension changes on the wiki and thus know at any time who performed an action and when. If you installed or upgraded the wiki with the Distribution Wizard, the Extension History should display a record of the "XWiki Standard Flavor" extension for the main wiki and the "XWiki Standard Flavor - Sub Wiki" extension on an sub-wiki. Additionally, you will see a record of each extension you upgraded with the Distribution Wizard.
Page 75 XWiki Standard 9.8.1 Administrator Guide
Main Wiki
Sub-Wiki
If you click on the name of the extension, you will be redirected to its description - to access a detailed diff, click on "Uninstall", then on "Compute changes", as previously explained
Page 76 XWiki Standard 9.8.1 Administrator Guide
and finally on the "Changes" tab.
Page 77 XWiki Standard 9.8.1 Administrator Guide
To revert a particular update, simply click the "Reset" button.
Page 78 XWiki Standard 9.8.1 Administrator Guide
To replay the record, go back to the "History" screen, select an extension from the list, then click on "Replay". Under "Replay Options" you have the possibility to replay the imported records using the wiki's original users, rather than the current user by selecting the "Preserve the users" option. By default, the "Namespaces" input only contains the domain name of the current wiki, but you can replay the record on multiple wikis at the same time, provided you have Programming Rights. In case there are merge conflicts that don't have an answer for in the recorded history file, then you will be prompted to answer them.
Click on "Continue", then on "Start" to confirm re-installing the "XWiki Standard Flavor - Sub-Wiki" extension. Details about the installed or modified extensions are available in the Replay Log.
To replay a history record from another sub-wiki, click on "Showing records from Local History" and upload an XML file from your computer.
Page 79 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Preferences • Developer Guide • XWiki Platform Modules Overview • XWiki Extension Repository Connector • Skins Extensions • Maven Extension Repository Connector • Extension Module • Active Installs Module • Admin Guide • XWiki Applications Overview • Distribution Wizard • App Within Minutes Application Flamingo Color Themes Application • LESS CSS • Switch Between Flamingo Color Themes • Edit the Default Theme • LESS Variables • Change the Flamingo Theme Logo • Advanced Color Theme Actions The Flamingo Color Themes Application is bundled with XWiki Standard and it provides the means to easily customize wiki skins and color themes based on Flamingo. LESS CSS
Flamingo uses the LESS Module to compile LESS files located in the current skin folder at runtime. The LESS module provides a Java integration of LESS CSS using the LESS CSS Compiler for Java. In fact, LESS extends the CSS language and makes it more efficient because it allows to create re-usable components. The generated result is a standard CSS file which eliminates the browser support issue. LESS is written is JavaScript and it can be used in 2 ways: • directly in the browser in order to see the rendered content • in the command line via Node.js which creates a CSS file Some of the LESS features include variables, extends, mix-ins, import and merge. For more details and examples, go to the "LESS Module and LESS CSS" documentation page. Switch Between Flamingo Color Themes
The default Flamingo color theme in the XWiki standard distribution is named "Charcoal". To enable a different one, click the
button which will open the drawer menu, then click on "Administer Wiki". In the wiki administration page, click on "Look & Feel" in the accordion menu, then choose "Themes".
Page 80 XWiki Standard 9.8.1 Administrator Guide
Finally, in the "Color Theme" section choose one of the options in the drop-down, then click on "Save".
Page 81 XWiki Standard 9.8.1 Administrator Guide
Another possibility is to click on "Manage color themes" located below the drop-down list which redirects to the Flamingo themes overview page. Once you have decided about the one that you want, click on "Use this theme".
XWiki Standard 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. On sub-wikis you will notice 2 tabs in the "Color Theme" section: • Local - refers to the color themes from the current sub-wiki • Global - allows to use a color theme from the main wiki
This way, in case you choose to use a global theme, it will be displayed differently in the page "FlamingoThemes.WebHome", more specifically it won't have the wiki prefix next to its name, unlike local themes.
Page 82 XWiki Standard 9.8.1 Administrator Guide
Edit the Default Theme
To begin editing a theme, go back to the wiki preferences page, click on "Look & Feel" -> "Themes", make sure the "Charcoal" theme is selected in the drop-down, then click on "Customize".
This will load a preview of the wiki home page using the "Charcoal" theme.
Page 83 XWiki Standard 9.8.1 Administrator Guide
You will notice a left panel named "Variables" with the list of LESS variables you can change.
Page 84 XWiki Standard 9.8.1 Administrator Guide
After each modification in the "Variables" panel, click "Refresh" in the right panel and you will see a preview. The process can take up to several seconds and the displayed UI might not be completely accurate. 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 which is not taken into account by the live preview. LESS Variables
Below you can see the list of LESS variable names and the corresponding mappings in the old Color Themes class.
Skin Element LESS Variable Default Value Logo @logo Color @text-color #333333 @body-bg $theme.pageBackgroundColor @xwiki-page-content-bg $theme.pageContentBackgroundColor @link-color $theme.linkColor
Page 85 XWiki Standard 9.8.1 Administrator Guide
@brand-primary $theme.buttonPrimaryBackgroundColor @brand-success $theme.notificationSuccessColor @brand-info $theme.notificationInfoColor @brand-warning $theme.notificationWarningColor @brand-danger $theme.notificationErrorColor @component-active-color The global color for active items like navs or drop-downs @component-active-bg The global background color for active items Typography @font-family-base @font-family-sans-serif @font-family-sans-serif @font-family-serif @font-family-monospace @font-size-base Buttons @btn-font-weight normal @btn-default-color $theme.buttonSecondaryTextColor @btn-default-bg $theme.buttonSecondaryBackgroundColor @btn-primary-color $theme.buttonPrimaryTextColor @btn-primary-bg $theme.buttonPrimaryBackgroundColor @btn-success-color $theme.menuAddEntryLinkColor @btn-success-bg $theme.menuAddEntryBackgroundColor @btn-info-color @btn-info-bg @btn-warning-color @btn-warning-bg @btn-danger-color @btn-danger-bg @btn-default-border Navigation Bar @navbar-default-color #777 @navbar-default-bg $theme.menuBackgroundColor @navbar-default-link-color $theme.menuLinkColor @navbar-default-link-hover-color $theme.menuLinkColor @navbar-default-link-hover-bg lighten($theme.menuBackgroundColor, 3%)
@navbar-default-link-active-color $theme.menuLinkColor @navbar-default-link-active-bg lighten($theme.menuBackgroundColor, 3%)
@navbar-height Drop-downs @dropdown-bg #fff @dropdown-border @dropdown-link-color $theme.textColor @dropdown-link-hover-color $theme.textColor @dropdown-link-hover-bg $theme.submenuContentBackgroundColor @dropdown-divider-bg Forms @input-bg #fff @input-border $theme.borderColor @input-color @input-border-focus @input-color-placeholder @legend-color @legend-border-color Panels @panel-bg #fff
Page 86 XWiki Standard 9.8.1 Administrator Guide
@panel-default-text $theme.panelTextColor Breadcrumb @breadcrumb-bg #f5f5f5 @breadcrumb-color @breadcrumb-separator
Change the Flamingo Theme Logo
To display your custom logo, open the theme page in "Inline" mode as shown in the previous section, click on "Logos" variable in the "Variables" panel, then on "Choose an attachment" in order to launch an attachment selector.
Next, upload a file from your computer or phone and click on "Upload and select".
Page 87 XWiki Standard 9.8.1 Administrator Guide
The new logo will be immediately applied the "Preview" window and you should also see a thumbnail image in the "Variables" panel.
Advanced Color Theme Actions
The "Variables" panel also provides an advanced feature allowing developers to enter some LESS code. Before XWiki 7.3, the preview didn't take this field into account, but now, if you save the theme, you will be able to see your change on the wiki.
Page 88 XWiki Standard 9.8.1 Administrator Guide
Any variable defined in the "Advanced" field takes priority over the variables defined in the other fields. For instance, if you defined @text-color in @lessCode, it will override any value from the @text-color field. More details about LESS CSS and examples are available in the "LESS Module and LESS CSS" documentation page.
Related Pages
• User Guide • Flamingo Skin • Developer Guide • XWiki Platform Modules Overview
Page 89 XWiki Standard 9.8.1 Administrator Guide
• Skins Extensions • Skin Extension Plugin • Programming Overview • LESS Module and LESS CSS • Create and Override a Skin • Admin Guide • XWiki Applications Overview • Skin Application • Customization Overview Import - Export Application • Import • Export The 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. Import
To access the import feature UI, click the button to open the drawer menu, then click on "Administer Wiki". In the wiki preferences page, click on "Content" in the accordion menu to the left, then on "Import".
Click on "Browse / Choose file" to select the XAR file you wish to import and it will be automatically uploaded.
Page 90 XWiki Standard 9.8.1 Administrator Guide
The File Upload widget provides an interactive upload User Interface in order to enhance the HTML input elements of type file. To learn more about the configuration options, go to the "HTML 5 File Upload Widget" documentation page listed in the "Related Pages" section under "Developer Guide". Click on the XAR in the "Available Packages" section
Page 91 XWiki Standard 9.8.1 Administrator Guide
and you should soon see the preselected page list of your XAR. If you don't want to preserve the page history, the newly imported pages will have the revision set to "1.1". In case you want to keep the author of the imported pages, check the "Import as backup package" option.
Page 92 XWiki Standard 9.8.1 Administrator Guide
Finally, click on the "Import" button to confirm. If successful, you will see a list of installed and skipped pages (if any).
Page 93 XWiki Standard 9.8.1 Administrator Guide
Export
To access the export feature UI, click the button to open the drawer menu, then click on "Administer Wiki". In the wiki preferences page, click on "Content" in the accordion menu to the left, then on "Export".
Fill in the form and click on the "Export" button.
Page 94 XWiki Standard 9.8.1 Administrator Guide
The resulting XAR file is in fact a renamed ZIP format with a package.xml file containing metadata about the export. A typical XAR created when doing an export will include all the pages on your XWiki instance grouped by folders, one for each location.
Page 95 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • Page Export Formats • Page Attachments • Office Importer Application • Developer Guide • XWiki Widgets Overview • HTML5 File Upload Widget • Customize the Look and Feel of the PDF and RTF Export • Admin Guide • XWiki Applications Overview • Configure the Office Server • Admin Tools Application Logging Application
The XWiki Logging Application works with the Logging Module to provide a dedicated UI in the wiki administration in order to easily retrieve and interpret XWiki logs. To access the application, click the button to open the drawer menu, then on "Administer Wiki".
Page 96 XWiki Standard 9.8.1 Administrator Guide
Next, click on "Logging" under "Other" in the accordion menu on the left
which will launch the list of registered XWiki loggers and the corresponding log level set for each of them.
Page 97 XWiki Standard 9.8.1 Administrator Guide
Page 98 XWiki Standard 9.8.1 Administrator Guide
An empty log level is equivalent to "default" meaning that the value is inherited from the logger of the parent. For instance, the parent of com.xpn.xwiki.plugin.watchlist.AutomaticWatchModeListener is com.xpn.xwiki.plugin.watchlist. The 5 available log levels are: • TRACE - designates finer-grained informational events than the DEBUG level. • DEBUG - designates fine-grained informational events that are most useful to debug an application. • INFO - designates informational messages that highlight the progress of the application at coarse-grained level. • WARN - designates potentially harmful situations. • ERROR - designates error events that might still allow the application to continue running. To set the ERROR log level for the com.xpn.xwiki.plugin.watchlist logger which is by default empty, select "ERROR" from the "Actions" drop-down, then click on "Set". The new value should then appear in the "Level" column.
By default XWiki is configured to log everything on the console only. Tomcat will capture stdout and add logs to the "tomcat/logs/catalina.out" file on UNIX systems and to the "logs/catalina.
Related Pages
• Developer Guide • XWiki Platform Modules Overview • Logging Module • Admin Guide • XWiki Applications Overview XWiki Mail Features • Obfuscate the Email Addresses • Configure a SMTP Server from the Wiki UI • Check the Mail Sending Status • Configure a SMTP Server from Tomcat on Localhost • Windows Systems that don't provide a SMTP Server • Configure hMailServer for Google Mail • Install the JavaMail Libraries
Page 99 XWiki Standard 9.8.1 Administrator Guide
XWiki Standard allows administrators to handle mail configuration and statuses via the "Mail Application" that uses the new
"Mail Sender API". The application is available in the wiki preferences page by clicking the button in order to open the drawer menu, then on "Administer Wiki".
In the "Mail" section of the accordion menu you will see 3 dedicated sections: • "Mail Sending" - exposes a list of parameters for configuring a SMTP server as well as some additional JavaMail properties • "Mail Sending Status" - displays the list of sent emails with the option of resending • "Advanced" - allows to enable or disable the email address obfuscation
Page 100 XWiki Standard 9.8.1 Administrator Guide
Obfuscate the Email Addresses
The "Obfuscate Email Addresses" option allows to enable or disable the obfuscation of the email addresses that are stored in object properties of type Email. By default, email addresses obfuscation is disabled but it can be easily activated by clicking on "Advanced" in the accordion menu from the wiki preferences page.
Next, choose "Yes" in the drop-down menu, then click on "Save". This way, only the first letter of the email account will be displayed whereas the rest of the letters will be replaced by an ellipsis.
Configure a SMTP Server from the Wiki UI
If you are using the "Notifications" and "Share page by email" features, you will need to configure a SMTP server and specify the default email address that XWiki will use. The easiest way is via the wiki administration by clicking on "Mail Sending" in the accordion menu to the left.
Page 101 XWiki Standard 9.8.1 Administrator Guide
Page 102 XWiki Standard 9.8.1 Administrator Guide
The SMTP server should be like mail.yourdomain.com (it defaults to localhost) .You might need to specify some additional JavaMail properties. The most common are:
• mail.smtp.starttls.enable: if set to true, this parameter enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must be configured so that the client trusts the server's certificate. • mail.smtp.auth: if set to true, the server will authenticate the user using the AUTH command. • mail.smtp.localhost: this is the local host name used in the SMTP HELO or EHLO command. The default value is InetAddress.getLocalHost().getHostName(). For the complete list of parameters, please consult the JavaMail API. Also, the Mail Sender API documentation is listed in the "Related Pages" section, under "Developer Guide". If you are using the Google SMTP server, the fields in the "Email" section should be filled like in the below example: • Server: smtp.gmail.com • Port: 587 • User: [email protected] • Additional JavaMail properties: mail.smtp.starttls.enable=true Starting with version 6.4, you may configure default BCC addresses which will be added to all emails sent using the Mail Sender API. You can also specify the delay to wait between each mail being sent. This was done in order to support mail throttling and not be considered a spammer by mail servers. The default value is 8 seconds but in case you wish to change it you have 2 possibilities: • Straight from the UI • Edit the "WEB-INF/xwiki.properties" file and set the mail.sender.sendWaitTime parameter with a value of your choice, in milliseconds. Note that this modification requires a server restart. mail.sender.sendWaitTime=10000 By default, the status for messages that have been sent successfully is stored by the Mail Application but you can deactivate this feature by checking the option "Discard Success Statuses?". Check the Mail Sending Status
The Mail Application also allows to check the status of sent emails, provided the feature that sent the email has defined that the mail status should be persisted, in which case it is possible to resend the ones that have failed to be sent. In the newest XWiki Standard versions, mails that weren't sent yet are now resent automatically at startup, thanks to the Mail Sender Storage API.
Page 103 XWiki Standard 9.8.1 Administrator Guide
When using the Database Mail Listener, in case a mail fails to be sent, both the error summary and the full error description are saved. For more details, check the Mail Sender API documentation. Configure a SMTP Server from Tomcat on Localhost
The first step is to add a global resource to the "Tomcat_Home/conf/server.xml" file as shown below:
Windows systems designed for home use, like Windows 7 or Windows 8 don't include a SMTP server. Instead, you can download:
Page 104 XWiki Standard 9.8.1 Administrator Guide
• Remote Server Administration Tools for Windows 7 with Service Pack 1 - this tool can be installed only on computers that are running the Enterprise, Professional, or Ultimate editions of Windows 7 or Windows 7 with SP1. To configure the SMTP email, follow this link. • hMailServer - an open source e-mail server for Microsoft Windows that supports IMAP, SMTP and POP3. To learn how to relay outbound email from legacy network devices using Google Mail or Google Apps mail servers, check the below sections. Configure hMailServer for Google Mail
Start by downloading "hMailServer", then perform a standard install. Next, connect to the server using the administrator password you chose during the installation:
In the left panel, click on "Settings" -> "Protocols" -> "SMTP".
Page 105 XWiki Standard 9.8.1 Administrator Guide
Next, click on the "Delivery of e-mail" tab, locate the "SMTP Relayer" section and: • for "Remote host name" enter "smtp.gmail.com" • for "Remote TCP/IP port" enter "465" • check "Server requires authentication" and enter your Gmail user name and password • check "Use SSL" • click on "Save"
Page 106 XWiki Standard 9.8.1 Administrator Guide
Go again to the left panel and click on "Settings" -> "Advanced" -> "IP Ranges".
Page 107 XWiki Standard 9.8.1 Administrator Guide
On "localhost", click on "Add" and fill in the required fields just like in the below image.
Page 108 XWiki Standard 9.8.1 Administrator Guide
You should also make sure the following options are disabled: • in the "Others" section: • Anti-Spam • Anti-Virus • in the "Require SMTP Authentication" section: • Local to local e-mail addresses • Local to external e-mail addresses • External to local e-mail addresses • External to external e-mail addresses For more configuration details, check the hMailServer documentation. Install the JavaMail Libraries
The XWiki Mail Sender API uses JavaMail that you can download from this link. You might also need the "JavaBeans Activation Framework" that can be downloaded from this link. The 2 files, "mail-1.4.1.jar" and "activation-1.1.1.jar" should be copied under "Tomcat_Home/lib".
Related Pages
Page 109 XWiki Standard 9.8.1 Administrator Guide
• User Guide • Share Page by Email • Notifications Application • Developer Guide • Mail Sender API • Admin Guide • XWiki Applications Overview • Customization Overview Menu Application • Access the Application Home Page • Create a Menu Entry • Menu Macro The Menu Application, now bundled with the XWiki Standard Flavor, was built with App Within Minutes in order to provide an easy way of creating navigation menus that you can choose to display: • horizontally as a top bar below the page header • vertically in a side panel By default, only wiki administrators have permission to view and access the Menu Application home page. However, menu entries are viewable by all the wiki users, provided the visibility scope of the entry allows it. Access the Application Home Page
Wiki administrators have 2 possibilities to access the Menu Application home page: • from the "Applications" panel displayed by default in the column on the left
• from the drawer menu, by clicking the button, then on "Application Index" and finally on "Menu"
Page 110 XWiki Standard 9.8.1 Administrator Guide
Create a Menu Entry By default, you need administration rights in order to create navigation menus. Start by accessing the Menu Application home page and click on "Add New Entry" in the "Actions" panel.
Next, enter the new menu name, then click the "+" icon or press Enter.
Page 111 XWiki Standard 9.8.1 Administrator Guide
You will notice that the "Menu Structure" field already contains a menu hierarchy example - basically, a menu consists of lists, anchors and icons. You may either choose to extend this one or to create a new structure from scratch. If you are familiar with the XWiki syntax, click on "Source" in the CKEditor menu bar and start customizing your menu.
You may also associate Font Awesome or Silk icons to each menu line using the syntax: • image:icon:[IconName] inside the wiki link for Silk icons • $services.icon.render('[IconName]') inside the wiki link for Font Awesome icons. In this case, also make sure to include the content inside a {{velocity}}{{/velocity}} macro The full list of icons supported in XWiki is available in the page IconThemes.FontAwesome and IconThemes.Silk respectively.
Page 112 XWiki Standard 9.8.1 Administrator Guide
Using Silk Icons Using Font Awesome Icons
Menu Display Location
By default, the option "Menu Display Location" is set to "Nowhere", meaning that the menu is hidden. To make it visible to other wiki users select: • "After the Page Header" - the menu is displayed horizontally as a top bar below the page header
• "Inside a Right Panel" / "Inside a Right Panel" - the menu is displayed vertically in the panel column on the right / on the left
Page 113 XWiki Standard 9.8.1 Administrator Guide
If you choose to display the menu in a panel column, you must also add it to that column from the Panel Layout. For instance, to display the menu "Menu.Navigation Menu" on the left column, simply add the value "Menu.Navigation Menu" in the field "Panels Displayed on the Left". Menu Visibility Scope
You can also specify a visibility scope for the menu: • Current User (default) • Current Wiki - visible to all users registered on the current wiki • Global - visible to all users registered on all the wiki farm In case you set the menu visibility scope to Global, you must also add it to the correct sub-wiki column as previously explained. Menu Macro
The "Menu" macro can be used outside the Menu Application to create a menu in the content of a wiki page. Usage
{{menu id="
Name Optional Allowed Values Default Value Description id yes Valid HTML ID Empty String Optional menu identifier that will be set on the HTML element wrapping the menu. You can use this identifier in the JavaScript code to access the menu DOM or in functional tests to assert the menu items. type yes horizontal (default) or horizontal The optional menu type vertical determines how the menu is displayed in the UI and its behavior.
The value of the type parameter is used as a CSS class name on the menu container and so it can accept various additional class names like: • use fixedWidth in combination with type="horizontal" when you have more than 2 levels of menus. The reason is that the horizontal menu was written to work without JavaScript (i.e. CSS-based) and in order to know where to display a drop-down sub-menu the drop-down menu must have a fixed width defined. Example{{menu type="horizontal fixedWidth"}}
Page 114 XWiki Standard 9.8.1 Administrator Guide
* [[image:icon:house Home>>Main.WebHome]] * ---- * Applications ** [[image:icon:transmit Blog>>Blog.WebHome]] ** [[image:icon:application_view_tile Dashboard>>Dashboard.WebHome]] ** [[image:icon:group User Directory>>Main.UserDirectory]] ** ---- ** [[Create>>AppWithinMinutes.WebHome]] ** [[Install>>XWiki.XWikiPreferences||queryString="editor=globaladmin§ion=XWiki.AddExtensions"]] * [[Documentation>>http://www.xwiki.org]] ** [[Syntax Help>>XWiki.XWikiSyntax||queryString="xpage=print"]] ** Take a Tour *** [[Basic Features>>]] *** [[Advanced Features>>]] {{/menu}} • collapsible makes a vertical menu collapsible but it requires JavaScript • open makes a collapsible vertical menu expanded by default when the page is loaded Hierarchy Panel{{menu type="vertical collapsible"}} {{velocity}} #set ($depth = 3) #set ($limit = 10) #macro (children $parentDoc $level) #foreach ($child in $parentDoc.getChildren($limit, 0)) #set ($childDoc = $xwiki.getDocument($child)) $stringtool.repeat('*', $level) {{html}}$escapetool.xml($childDoc.plainTitle){{/ html}} #if ($level < $depth) #children ($childDoc $mathtool.add($level, 1)) #end #end #end #children ($doc 1) {{/velocity}} {{/menu}}
Related Pages
• Admin Guide • XWiki Applications Overview • App Within Minutes Application Notifications Application • Watch XWiki Entities • Alerts • Coexistence with the Watchlist Application • Notifications Settings • Set the Email Frequency • Automatic Watch • Filters • Live Notifications The XWiki Notifications Application allows to subscribe to wiki pages or even whole wikis and thus receive realtime alerts and email notifications whenever a modification occurs. The Notifications Application is currently experimental and it is meant to replace the Watchlist Application in future XWiki releases. Watch XWiki Entities
In order to receive alerts when a page has been modified by someone else you first have to add it to your favorites. To do so, click the bell icon in the top menu bar to expand the notifications menu, then click the "ON" button next to:
Page 115 XWiki Standard 9.8.1 Administrator Guide
• the file icon to watch just the current page • the sitemap icon to watch the current nested page and its child pages • the globe icon to add the entire wiki to favorites
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. In case there are more than 20 unread alert messages, you will see the value 20+.
To mark a notification as "read" simply click the "checked" button - the button will then disappear and the background color will turn white. In case you wish to mark all notifications sent so far as read, click on "Clear all".
Page 116 XWiki Standard 9.8.1 Administrator Guide
Page 117 XWiki Standard 9.8.1 Administrator Guide
Similar notifications are grouped together in order to avoid a batch of identical content. This is why only one notification is displayed, but it is possible to list all activities (if any) by expanding the "Details" section.
Finally, you may subscribe to the RSS feed of the wiki notifications, either through your notifications center settings or directly by clicking the "RSS Feed" link. Coexistence with the Watchlist Application
If the Watchlist Application is installed, you will see two rows of buttons and settings in the menu: the first for the watch list, and the second for the notifications. Similarly, the "Settings" panel in your user profile page will display 2 categories: Watchlist and Notifications.
You will also receive 2 sets of emails: one from the Watchlist, and one from the Notifications Application. To avoid conflict, the "Watched Entities" feature is disabled by default. This is why we recommend to uninstall the Watchlist Application using the Extension Manager, then to enable the "Watched Entities" feature as follows: • edit the "WEB-INF/xwiki.properties" file • uncomment the parameter "otifications.watchedEntities.enabled" and set it to "true" • restart XWiki If you upgraded your XWiki, all the pages that you watched in the Watchlist Application are automatically watched by the Notifications Application, thanks to the Notifications - Watchlist Bridge Module. Notifications Settings
The "Settings" link in the alerts menu redirects to the "Notifications" section in your user profile page where both in-wiki alerts and email notifications are turned off by default. To enable notifications: • click the bell icon to enable notifications for all event types OR • click the downward arrow icon and for each application and enable / disable notifications for the event types you are interested in: a blog article is published, a page is created, edited or deleted, a comment is submitted.
Page 118 XWiki Standard 9.8.1 Administrator Guide
Check the table below to learn what each switch button means:
Toggle Button Comment Notifications disabled for all event types
Notifications enabled for some event types
Notifications enabled for all event types
Set the Email Frequency
The "Email Frequency" drop-down list in the "Email Preferences" section allows you to choose how often you will receive email notifications regarding the activity in your wiki or farm. The 4 available options are: • Hourly • Daily • Weekly • Live
Page 119 XWiki Standard 9.8.1 Administrator Guide
Automatic Watch
By default, the automatic watch feature is disabled, but you can enable it by choosing one of the other 4 options from the "Automatic Page Watching" drop-down list: • Never • Every time I make a modification - any change on any wiki page generates notifications • Every time I make a major modification - only the major changes generate notifications • Only when I create a new page - the notifications are generated only when new wiki pages are created
Filters
The "Filters" livetable displays the list of wikis, page hierarchies or single pages added to favorites and allows you to restrict on witch locations you want to receive notifications, for each event type. To remove an element from the list, click on the red "X" button in the "Actions" column.
Page 120 XWiki Standard 9.8.1 Administrator Guide
To create a filter, click on "+ Add filter" and fill in the form fields: • "Filter type" - can be inclusive or exclusive, meaning that notifications that come from a page that matches an exclusive filter will then be discarded. Exclusive filters take precedence over the inclusive ones. • "Notification Format" - whether the notification should be sent as alert, email or both. • "Event type" - the event(s) targeted by the filter: • a blog post is published • a new page is created • a page is modified or deleted • a comment is submitted • "Filter Scope" - the page(s) targeted by the filter. Note that when you select a nested page, the filter will also apply for the child pages.
Page 121 XWiki Standard 9.8.1 Administrator Guide
The new filter will appear as enabled in your notifications center.
The same behavior applies to system filters - they are enabled by default. However, you may disable them by clicking on "Advanced filtering options" and unchecking the corresponding button in the "Toggle" column.
Page 122 XWiki Standard 9.8.1 Administrator Guide
Live Notifications
The "Live" option is currently experimental, which is why it is disabled by default. To enable it, edit the "WEB-INF/ xwiki.properties" configuration file, uncomment the parameterwatchlist.realtime.enabled, set it to true and restart XWiki. The events that are currently triggering realtime notifications include: • pages created and deleted • page updates including: content and metadata modification, attachments added, edited or deleted. • class and object changes including: • new comments • replies to an existing comment • comment updated, either the current user's own comment or one of another user • comment deleted, either the current user's own comment or one of another user • rights changes • blog post changes, more specifically a blog post being published • generic "updated an object" events for an object update not handled by any of the cases above • generic "updated document" events for an update not handled by any of the cases above The wiki administrators can also define a "grace time" for live email notifications meaning that when an event that triggers a notification is sent, the platform will wait for the duration of this grace time before sending a notification email. If during this interval, a new event of the same kind is sent, the two events will be grouped in the same email. To set up a grace time: • edit the "WEB-INF/xwiki.properties" file • uncomment the parameter "notifications.emails.live.graceTime" and set it to a new value in minutes (by default it is set to 10 minutes) • restart XWiki The notification message tries to reference the page by its type which is determined using the class sheet system. To be more specific, if an existing object has a class on which a sheet binding is set, then the class gives the page type. For instance, the page "Blog.BlogIntroduction" has an attached object of the class "Blog.BlogPostClass" which has an "XWiki.ClassSheetBinding" pointing to "Blog.BlogPostSheet".
Page 123 XWiki Standard 9.8.1 Administrator Guide
This means that the class "Blog.BlogPostClass" gives the type of the page "Blog.BlogIntroduction". To obtain the type string, strip the "Class" suffix, split the camel case and lower-case the result, which gives "blog post". So, the notification message won't state that "User X deleted the document Blog.BlogIntroduction", but that "User X deleted the blog post Blog.BlogIntroduction". For more details about the class sheet binding system, please refer to the "XWiki Data Model" documentation which is linked below "Related Pages". When multiple Realtime notification emails are received regarding the same page, they will be grouped by page and by email client.
Related Pages
• User Guide • XWiki Applications Overview • Tags Application • Search Application • Blog Application • Activity Stream • Developer Guide • RSS Macro • Mail Sender API • Admin Guide • XWiki Mail Features Panels Application • Access The Panels Home Page • Create a Panel • Panel List • Change the Panels Visibility • Display a Panel for a Nested Page and its Children • Display a Panel on a Single Page
Page 124 XWiki Standard 9.8.1 Administrator Guide
• Customize the Panels Layout • Delete a Panel • "Applications" Panel • New Panels The XWiki Panels Applications allows creating menus for performing various actions in the wiki(s): search inside a location or the entire wiki, create a page, navigation and so on. XWiki provides a default set of panels grouped in 5 main categories: • Information - "Blog Categories", "Applications", "Quick Links", "Recently Created" etc. • Navigation - "Blog Archive", "Recent Blog Posts", "Navigation", "Child Pages", "Sibling Pages" • Tools - the "Search" panel, the "Create Page" panel • Administration • Other Also, there are 2 possible context actions for panels: view or edit. In order to create and edit panels or to change the panels layout, you need to have administration rights. Access The Panels Home Page
To access the Panels Application home page, click the icon which launches the drawer menu, then on "Application Index" in order to access the list of installed applications and finally on "Panels".
The new and improved Panels home page displays a livetable with the available panels that can filter panels by name, description, type (edit or view) and category (Information, Navigation, Tools, Administration and Other). Provided you have administration rights, you will also be able to edit or delete panels.
Page 125 XWiki Standard 9.8.1 Administrator Guide
Create a Panel
To create a panel, go to the Panels home page, fill in the name of your new panel and then click on "Create".
A new page will open in "Inline Form" mode so that you can continue the panel creation by filling in the corresponding fields.
Page 126 XWiki Standard 9.8.1 Administrator Guide
Finalize the process by saving the page.
Page 127 XWiki Standard 9.8.1 Administrator Guide
Panel List
The Panel List provides a dedicated UI for an easier customization of the panels layout and it is available globally, in the wiki administration page and locally, on the page administration. To access the global Panel List, go to the Panels home page and locate the "Available Panels" section. Finally, click the "Panel Wizard" link in information message with a magic wand icon.
Another way is to click the button which opens the drawer menu, then on "Administer Wiki".
Page 128 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Look & Feel" in the accordion menu, then on "Panels".
Next, select the Panel you wish to use from the "Panel List" tab,
Page 129 XWiki Standard 9.8.1 Administrator Guide
drag the panel from the "Panel List" and drop it into the panels area (left or right). Don't forget to scroll to the bottom of the page and click on "Save" after you are done.
Page 130 XWiki Standard 9.8.1 Administrator Guide
If you now go to any wiki page you will be able to see the panel in the same area you dropped it in.
To remove a panel from the left or right column without deleting it, just follow the reverse process: drag the panel from the column and drop it to the "Panel List", then click on "Save the new layout". Change the Panels Visibility
By default, the panels you drag & drop with the Panel List from the wiki administration are displayed on all the wiki pages. Display a Panel for a Nested Page and its Children
In case you want to display a panel only on a specific nested page and its children, you will have to access its Panel List. To do
so, click the button, then on "Administer Page".
Page 131 XWiki Standard 9.8.1 Administrator Guide
Next, click on "Look & Feel" -> "Panels" in the accordion menu on the left, then on the "Panel List" tab and follow the steps described in the previous section.
Page 132 XWiki Standard 9.8.1 Administrator Guide
Display a Panel on a Single Page
In order to display a panel only on a specific page, you have 2 possibilities. In case you don't need to further customize the look & feel of the panel, i.e. use the default skin and color theme, you can use the {{panel /}} macro as follows: {{panel title="My Panel"}} Content of the panel. {{/panel}} You can place any XWiki content in the content of the panel. Also, the title parameter is optional. If in return you want to use a custom CSS, one solution would be to use the panelheader and panelfooter Velocity macros, then to define CSS rules for the .panel class as shown in the "Skins Extensions" tutorial. Example:
{{velocity}} #panelheader('My panel') Some panel content #panelfooter() {{/velocity}} Other available Velocity macros which are distributed with a standard XWiki Standard instance are:
• #largepanelheader($title) • #hiddenpanelheader($title) • #largepanelfooter() • #hiddenpanelfooter() Customize the Panels Layout
By default, both panel columns are displayed in the wiki pages, but the page layout is customizable via the wiki or the nested page administration page.
To set the panels layout for the whole wiki, click the button to open the drawer menu, then on "Administer Wiki".
Page 133 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Look & Feel" -> "Panels" in the accordion menu
and on the "Page Layout" tab, select one of the different layouts and you will be able to preview the new page layout instantly. Should you decide to keep the changes, click on "Save".
Page 134 XWiki Standard 9.8.1 Administrator Guide
Any panel you drag & drop from the Panel List appears in the "Panels Displayed on the Left/Right" text-boxes. In case you already know the name of the panels you wish to be displayed and you don't want to use the Panel List, you may specify them here in a coma-separated list, as you can see in the image below.
Additionally, you can choose the width of each panel column - the available options are small, medium (default) and large. When you choose the "Small" width, the panel becomes a dock bar.
To set the panels layout for a nested page, click the button, then on "Administer Page".
Page 135 XWiki Standard 9.8.1 Administrator Guide
In the preferences page, click on "Look & Feel" -> "Panels" in the accordion menu to the left and follow the steps described in the above paragraphs. Delete a Panel
To delete a panel you have 2 possibilities. You can either locate it in the Panel List, then click on "Delete"
Page 136 XWiki Standard 9.8.1 Administrator Guide
or you can navigate to the panels home page, search for the panel in the livetable, then click the corresponding "Delete" link.
"Applications" Panel
The "Applications" panel is a special panel displayed on the left column which lists the extensions installed on the wiki and dedicated buttons for easy access. Wiki administrators can choose which applications to display as explained in the dedicated documentation page. New Panels
Nested Pages Panels
Given that starting with version XWiki has adopted the "Nested Pages" paradigm, there have been 2 main changes in the Panels application: • the "Navigation" panel displays nested pages and it is displayed by default the left column • the "Sibling Pages" panel displays the siblings of a terminal page • the "Child Pages" panel displays the children of a nested page
Page 137 XWiki Standard 9.8.1 Administrator Guide
Tips Panel
The "Tips" panel is part of the Help Application and displays useful tips and tricks about how to use XWiki.
Page 138 XWiki Standard 9.8.1 Administrator Guide
"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.
Related Pages
• User Guide • Nested Page Actions • Dashboard Application • Developer Guide • Dashboard Macro • Admin Guide • XWiki Applications Overview • Applications Panel Skin Application • Edit the Skin Page • Override Skin Resources • Override the Stylesheets The Skin Application is bundled with XWiki Standard and for the moment it only allows to edit an existing skin. In future versions, the application will have features for creating and managing multiple skins. Edit the Skin Page
As detailed in the "Flamingo Skin" documentation page, the default XWiki skin is Flamingo. To edit it, click the button which opens the drawer menu, then on "Administer Wiki".
Page 139 XWiki Standard 9.8.1 Administrator Guide
Next, click on "Look & Feel" -> "Themes" in the accordion menu on the left,
then on the "Customize" button in the "Skin" section
Page 140 XWiki Standard 9.8.1 Administrator Guide
and finally on "Edit this skin", which will launch the default skin page in "Inline form" mode.
As shown in the "Base skin" input, the base skin is "flamingo" which is stored in the folder "/webapps/xwiki/skins/flamingo". In order to add a new logo, click on "Choose an attachment", select an image from your computer, then click on "Upload and Select".
Page 141 XWiki Standard 9.8.1 Administrator Guide
You will then see the new logo in "Inline form" mode.
Note that by default, the displayed logo is the one defined in the color theme page used by the wiki. When the logo is not defined in the color theme, XWiki will display the one attached to the skin file. The reason for this is to allow you to have a different logo for each color theme. For more information, please refer to the Flamingo Color Theme Application documentation. The "Output Syntax" field has 2 options: • HTML 5 - recommended for new skins • XHTML 1.0 - added in order to keep backward compatibility with old skins like "colibri" and it is used by XWiki to know which renderer to use along with the skin. The renderer is important to generate valid HTML code. Override Skin Resources
Skin resources are Velocity, JavaScript, CSS and LESS files located in the "/webapps/xwiki/templates/" folder or in the current skin folder "/webapps/xwiki/skins/flamingo/". The main CSS file is "style.css", whereas the main LESS file is "less/style.less.vm".
Page 142 XWiki Standard 9.8.1 Administrator Guide
In case you need to replace a JavaScript resource, an image or even fonts, the best way is to attach it to the skin page, then to refer it using a Skin extension. More details are available in the "Skins extensions" tutorial linked under "Related Pages".
To customize for instance the "pdfcover.vm" template, enter the string pdfcover.vm in the input field under "Overridden templates", then click on "Add". You will then notice 2 new fields: • Path - representing the template name; this one is automatically filled and it should not be modified • Content - this is where you add the template Velocity code What you will have to do first is to paste the default code into the "Content" field which is:
#set ($title = "$!pdfdoc.display('title', 'rendered', '', $pdfobj)") #if ($title == '') $escapetool.xml($!tdoc.plainTitle) #else $escapetool.xml($title) #end
Don't forget to hit "Save & View" in order to submit your changes. If you then export a wiki page as PDF, the cover page should look like in the screen-shot below.
Page 143 XWiki Standard 9.8.1 Administrator Guide
For the moment the UI doesn't support overriding the default "style.css" file using the aforementioned method. As a workaround, you can click on "Deprecated properties" and enter the custom CSS in the "Style" field or follow the instructions from the next section.
Override the Stylesheets
The default or preferred stylesheet of the skin is named "style.css". To override it, you have two possibilities: the easiest one is to add your rules to the "/webapps/xwiki/skins/flamingo/style.css" file, then attach it to the skin page. However, this method is not recommended because it will be quite hard to keep track of the subsequent changes history and make comparisons .
Page 144 XWiki Standard 9.8.1 Administrator Guide
This is why you should edit the skin page in "Objects" mode and locate the "Style" property in the "XWiki.XWikiSkins" object which by default is empty.
Before adding your own CSS rules that will override the default implementation, you first need to load the main CSS file of the current flamingo skin by pasting the below lines. ## Get the compiled LESS code #set($css = $services.lesscss.compileSkinFile('style.less.vm')) ## Remove the useless part #set($index = $css.indexOf('.not-sent-to-the-browser-from-this-point')) #if($index >= 0) #set($css = $css.substring(0, $index)) #end ## Remove from the CSS some rules that make IE9 crash using the WYSIWYG (XWIKI-10661) ## Only if the user agent contains the IE9 signature ## @TODO: Remove this when IE9 will no longer be supported. #if($request.getHeader('User-Agent').contains('MSIE 9.0')) ## We removes css rules like ".className:empty{...}" ## "(?s)" means that the expression "." matches any character, including a line terminator #set($css = $css.replaceAll('(?s)\.[^\{]*:empty\{[^\}]*\}', '')) #end ## Display the CSS $!css For more details about skin customization, refer to the "Create and Override a Skin" page linked under "Related Pages". Also, if you are familiar with LESS, feel free to extend the .less files of the skin, according to the principles presented in the "LESS Module" documentation, linked in the "Related Pages".
Page 145 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • Flamingo Skin • Developer Guide • Skins Extensions • Skin Module • Skin Extension Plugin • Programming Overview • LESS Module and LESS CSS • Create and Override a Skin • Admin Guide • XWiki Applications Overview • Flamingo Color Themes Application User Directory Application • Access the User Directory • User Customized User Directory • Add a Column • Remove a Column • Restore the Defaults • Globally Customize the User Directory Access the User Directory
The User Directory displays the list of registered XWiki users, along with their avatar. To access it, click the button which opens the drawer menu, then on "User Index".
Page 146 XWiki Standard 9.8.1 Administrator Guide
User Customized User Directory
The User Directory can display sortable and filterable XWiki.XWikiUsers properties as columns so that any user can customize his view over the User Directory livetable by adding or removing columns. To do so, click on the "customized" link in the info message displayed just above the livetable. Add a Column
The columns that you may display in the livetable are shown in the "Available Columns" drop-down list. If you want to have an extra column, just select it then click on "Add".
Page 147 XWiki Standard 9.8.1 Administrator Guide
The corresponding XWiki.XWikiUsers class property will appear in the "Selected Columns" text-box
and you will also be able so see a preview of the livetable.
Page 148 XWiki Standard 9.8.1 Administrator Guide
In order for the changes to be permanent you will also need to click on the "Save" button. Go back to the User Directory page to see the results and you will notice that the message on top of the livetable has changed to "You are viewing a customized user directory. You can reset it to default or customize it further."
Remove a Column
To remove a column, navigate to the User Directory customization page, delete the name of the corresponding XWiki.XWikiUsers class property from the "Selected Columns" text-box then click on "Save". Restore the Defaults
The columns displayed by default are "first_name", "last_name" and the un-modifiable columns which will always be displayed first: "_avatar" and "doc.fullName". To restore the defaults go to the User Directory customization page and click on "Reset to Default". Globally Customize the User Directory
Wiki administrators can globally customize the User Directory and define which columns to display. To do so, log in as administrator, click the button to open the drawer menu and choose "Administer Wiki".
Page 149 XWiki Standard 9.8.1 Administrator Guide
In the accordion menu to the left, locate the "Users & Rights" sub-section, then click on "User Directory".
Page 150 XWiki Standard 9.8.1 Administrator Guide
To start the customization, just follow the same steps presented in the above paragraphs.
Page 151 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Status • Registration • Admin Guide • XWiki Applications Overview • Users and Groups Overview • The Management of Global/Local Users and Groups • Set the Users Access Rights • Manage the Sub-Wiki Users • Edit a Global User • Edit a Global Group • Delete a Global User • Create a Global User Customize the User Profile Sections • Choose Which Sections to Display • Customize the "Personal Information" Section • Customize the "Contact Information" Section • Customize the "External Links" Section • Modify the Section ID • Add a Section • Remove a Section • Extend the Class "XWiki.XWikiUsers" An administrator can choose which information is shown in the user profile tab. For this purpose, the "User Profile" application allows administrators to decide which fields of the XWiki.XWikiUsers class to display.
Click the button which opens the drawer menu, then click on "Administer Wiki".
Page 152 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Users & Rights" -> "User Profile" in the accordion menu to the left.
Page 153 XWiki Standard 9.8.1 Administrator Guide
Choose Which Sections to Display
In the text-box below "Section IDs" you can enter a space or newline separated list of section IDs to be displayed in the user profile. The IDs available by default are: • personal : the "First Name", "Last Name", "Company" and "Comment" subsections • contact : the "Email", "Phone" and "Address" subsections • links : the "Blog" and "Blog Feed" subsections
Customize the "Personal Information" Section
You may choose which personal information to display by entering a space or newline separated list of XWiki.XWikiUsers properties in the text-box below "Section Properties". The values listed by default are: • first_name • last_name • company
Page 154 XWiki Standard 9.8.1 Administrator Guide
• comment
You may also use an optional micro-formats class to prefix the property name (e.g.: given-name:first_name). Customize the "Contact Information" Section
Just like for the above section, you can choose which information to display by entering a space or newline separated list of XWiki.XWikiUsers properties in the corresponding text-box. There are 3 default options available: • email • phone • address You may also use micro-formats class to prefix the property name (e.g.: tel:phone).
Page 155 XWiki Standard 9.8.1 Administrator Guide
Customize the "External Links" Section
The values listed by default in this section are: • blog • blogfeed
Page 156 XWiki Standard 9.8.1 Administrator Guide
The XWiki.XWikiUsers class properties can be prefixed using a micro-formats class. Modify the Section ID
You may change the section ID by entering it in the corresponding text-box.
Page 157 XWiki Standard 9.8.1 Administrator Guide
The name you specify in the "Section ID" field (without containing any white spaces) must be the same as the one from the "Section IDs" text-box.
Add a Section
In the User Profile administration page, go to "All sections" and click on the "Add" link.
Next, go to the bottom of the page and you will notice 3 new corresponding "Section ID", "Section Name" and "Section Properties" fields.
Page 158 XWiki Standard 9.8.1 Administrator Guide
The section properties must exist in the XWiki.XWikiUsers class which is available at /xwiki/bin/edit/XWiki/XWikiUsers? editor=class. Finally, you need to specify the new section ID in the "Section IDs" text-box.
Page 159 XWiki Standard 9.8.1 Administrator Guide
Click on "Save" to apply the changes, then go to your user profile to see the new "IM Information" section displayed under "External Links".
Page 160 XWiki Standard 9.8.1 Administrator Guide
To edit the subsection, just click on the yellow pen icon located at the top of the user profile page.
Remove a Section
Go to the User Profile administration page and click on the corresponding "Remove" link located to the right of the section.
Page 161 XWiki Standard 9.8.1 Administrator Guide
Extend the Class "XWiki.XWikiUsers"
When customizing the user profile sections, you are not limited to the properties that already exist in the "XWiki.XWikiUsers" class. It it possible for you to extend the class then to display the new sections in the user profile. To do so, navigate to the page "XWiki.XWikiUsers" and edit it in "Class" mode. Supposing you need to add a section named "Job Information" which will display the manager and the contract type of each employee, you will need: • a property of type "List of Users" in order to select the name of the manager from the existing wiki users
In case the employee is a member of several teams and he/she has more than one manager, just check the "Multiple select" option. More information regarding the User Picker is available in the documentation about how to edit a group. • a "Static List" property with the following possible values: "Full-time" and "Part-time"
Page 162 XWiki Standard 9.8.1 Administrator Guide
After saving the class page, go to the User Profile administration and create a new section named "Job Information" with the "job_information" ID as explained in the above section. Finally, add the new "manager" and "contract" section properties,
Page 163 XWiki Standard 9.8.1 Administrator Guide
specify the "job_information" ID in "Section IDs"
Page 164 XWiki Standard 9.8.1 Administrator Guide
and click on "Save". The new section will then appear in the user profile.
Page 165 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Profile
Page 166 XWiki Standard 9.8.1 Administrator Guide
• Dashboard Application • Developer Guide • XWiki Data Model • User Avatar Macro • User Avatar Java Macro • Admin Guide • XWiki Applications Overview • Edit a Global User • App Within Minutes Application WebDAV
The WebDAV feature exposes wiki content like attachments or page content through the well-known WebDAV protocol. This allows using WebDAV clients like DAVExplorer, file browsers like the Windows Explorer (XP), the Finder (MAC) or Nautilus (Linux) to directly browse and edit wiki content just as you would do for files in your local file system.
XWiki.org when seen while browsing it using a file manager over WebDAV
Here are some benefits of a webDAV-enabled XWiki installation: • Mount an XWiki wiki content into the user's local file system. • Use local application programs to manipulate page content and attachments. • Easily perform batch operations on documents (e.g. add 100 attachments to a document). XWiki's WebDAV implementation doesn't support locking and versioning DAV operations yet, but you can use the Basic Access Authentication method. WebDAV Clients
The XWiki-WebDAV interface requires a WebDAV client installed, but nowadays operating systems have built-in WebDAV clients. There are many WebDAV clients and their behavior may vary because functionalities might not be unique. In the worst case, they might even be broken on some clients. We will keep updating this document with instructions on how to use the various WebDAV clients to access the XWiki-WebDAV interface. In the mean time, if you find out that your particular WebDAV client has problems with accessing / using the XWiki-WebDAV interface, you may consult the community for reporting issues. WebDAV clients known to work with the XWiki-WebDAV interface: • DAVExplorer - Platform Independent • WebFolders - Windows XP • WebDAV Redirector - Windows XP
Page 167 XWiki Standard 9.8.1 Administrator Guide
• NetDrive / WebDrive - Windows XP • BitKinex - Freeware for Windows • Nautilus - Gnome (Linux) • Konqueror - KDE (Linux) • Davfs2 - Linux
Related Pages
• User Guide • Page Attachments • Developer Guide • Zip Explorer Plugin • Attachment Selector Macro • Admin Guide • Attach Large Files 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. Admin Tools Application • Configuration Tools • Activity Tools • Storage Management Tools • Upgrade Tools • Import and Export Tools • Export • Export of the Wiki from a Specific Date • Export Page • Import Page • Large Export on Disk • Large Import from Disk • MySQL Tools • MySQL Encoding Check • XWiki Database Indexes Check • Run Query • Show Large History • Show Spammed Pages • Sanity Check The Admin Tools application is 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 As the application is not bundled with XWiki Standard, it is recommended to install it using the Extension Manager. You can later access it by clicking on "Admin Tools" in the "Applications" panel on the left - in case you cannot find it there, you can easily pin it as explained in the Applications Panel documentation.
Page 168 XWiki Standard 9.8.1 Administrator Guide
The application home page displays links to dedicated scripts grouped by category. Configuration Tools
This section has 2 scripts - one of them is "XWiki Configuration Check" (functional only on Linux environments) which displays: • the memory settings of the Java Virtual Machine including: • Max Memory - corresponds to the Java "Xmx" parameter • the amount on used memory • the amount of free memory • caching details like: • Store Page Cache Capacity - retrieves the value of the xwiki.store.cache.capacity parameter set in the file xwiki.cfg • Store Page Cache in Use • database configuration details: • Max Active - the number of possible connections to the database • Max Idle - the number of possible idle connections to the database • Active - the currently active connections to the database • Idle - the current idle connections to the database • encoding configuration for Tomcat, the XWiki instance and Java - in all 3 cases, the returned value should be UTF-8
The second script, "Programming Rights Check" saves XWiki pages from the entire farm with programming rights. Documents requiring programming rights have an attached "XWiki.RequiredRightClass" object set to "programming".
Page 169 XWiki Standard 9.8.1 Administrator Guide
In order for the script to execute correctly, you need to have programming rights. For more details, please refer to the Rights Overview page. Activity Tools
The "Activity Tools" section has 3 scripts: • Show Logs is for the moment only functional on Linux environments and displays the last 2000 lines of the "/usr/local/ tomcat/logs/catalina.out" log file
• Show Rights is a tool for displaying the rights overview for the wiki users and groups and it can be efficient to detect redundancies and inconsistencies: • the "Global" section displays privileges at wiki level • the "Spaces" section lists users and groups rights settings at space level • the "Pages" section lists users and groups rights at page level
Page 170 XWiki Standard 9.8.1 Administrator Guide
• Flush XWiki Cache - is a script for flushing the wiki cache which is useful when you add new JavaScript or CSS / LESS CSS functionality and you want to ensure the result is the correct one. Storage Management Tools • Space Used displays the amount of space in Megabytes used by some of the largest XWiki database tables: • xwikirecyclebin - stores deleted documents • xwikircs - stores document versions • xwikiattachment_content - stores the content of attachments • xwikiattachment_archive - stores attachments versions • xwikiattrecyclebin - stores deleted attachments It is recommended to run this script in case you are running out of database space, in order to know which tables should be flushed. Normally, you would want to delete xwikirecyclebin, xwikiattachment_archive and xwikiattrecyclebin. If you are storing attachments on the file system instead of the database, the script won't display anything for the last 3 tables. • Shrink Recycle Bins allows to quickly flush your wikis' documents and attachments recycle bins, more exactly the tables xwikirecyclebin and xwikiattrecyclebin respectively.
If you are storing attachments on the file system instead of the database, the script won't be able to flush the attachments recycle bin. • Database to FileSystem Porter helps you migrate attachments from the database to the file system, for the case when you have enabled the file system storage. For more details, please refer to the dedicated documentation. Upgrade Tools
If you have a heavily customized wiki and you plan to upgrade, you can use the "Wiki Diff" tool to compare your current wiki with the standard distribution. This way, you will know what to expect when upgrading with the Distribution Wizard. The script should automatically detect your distribution and fill in the "Source URL" field accordingly. In case you wish to compare with another version, you can find them all on the XWiki public Maven repository. To compare the source XAR with your current wiki, you may leave the "Target URL" field empty.
Page 171 XWiki Standard 9.8.1 Administrator Guide
The script will display a list of pages in XML format that have changed between the 2 versions. To see more details, click on the corresponding "View diff" link.
Import and Export Tools
This section provides 6 scripts that help you perform import/export actions that are not available in the standard distribution. Export
The "Export" page is a form with 3 columns - the "Your Wiki" column allows you to select the space to export.
Page 172 XWiki Standard 9.8.1 Administrator Guide
Page 173 XWiki Standard 9.8.1 Administrator Guide
Your may either select the space from a drop-down list
or enter the space name in the "Search space" input followed by a click on the "Go" button.
Whichever option you choose, you will then see a listing with all the documents in the selected space.
Page 174 XWiki Standard 9.8.1 Administrator Guide
Click on the "Select all" link in case you want to export the whole space or manually check each page to be added to the package. Next, click on the "Add to my package>>" button and you will notice that the selected pages will appear in the "Your Package" column. The "Your Package" column displays the list of pages added to the package.
Page 175 XWiki Standard 9.8.1 Administrator Guide
Page 176 XWiki Standard 9.8.1 Administrator Guide
If you want to keep them all, just click on the "Select all" link. In case you want to remove some pages from the package, you need to select them, then to click on the "Remove from my package>>" button.
The "Package Info" column allows you to define the exported package metadata: the name, description, license, author and version.
Page 177 XWiki Standard 9.8.1 Administrator Guide
Page 178 XWiki Standard 9.8.1 Administrator Guide
By default, the application will only export the latest version of each page in the package. In case you want to also export the history, check the "Add history" option, then click on "Export" to confirm. Export of the Wiki from a Specific Date
The page "Export of the Wiki from a specific date" allows to selectively export pages: • created at a given date - in this case you only need to fill in the "Date" field • created in a given interval - in this case you need to fill in both "Start Date" and "End Date" fields
Just like for the "Export" script, you have the option to export the history by checking the "With history" option. To keep the original author and creation date, you may additionally opt to export the XAR as "Backup pack". Export Page
The difference between the classic XWiki Standard page export feature and the "Export Page" script is that the latter allows you to also export the page history by checking the option "With versions".
Page 179 XWiki Standard 9.8.1 Administrator Guide
After clicking on "Export", you will be redirected to ServerName/xwiki/bin/view/Admin/ExportPage? type=export&name=Main.WebHome&versions=1 which should display a screen similar to the image below.
Import Page
The script "Import Page" allows you to import a single page XAR saved on the file system, with additional options:
Page 180 XWiki Standard 9.8.1 Administrator Guide
• "Page name to save to" - the name of the document to import the file to. If the page doesn't exist, it will be created, otherwise you may select one of the 5 possibilities: • "Do Not overwrite with versions" - do not replace the content of the target page but keep the versions • "Do Not overwrite without versions" - do not replace the content of the target page and don't keep the versions • "Add version" • "Overwrite with version" - replace the content of the target page and also keep the versions • "Overwrite without versions" - replace the content of the target page but don't keep the versions Large Export on Disk
The "Large Export on Disk" script is recommended for large wikis that cannot be exported using the standard feature because that could potentially cause a "Java Heap Space" error.
Page 181 XWiki Standard 9.8.1 Administrator Guide
The script allows you to select the spaces to export and, if you don't check the "Don't zip files, output to directory" option, each space will be exported to a corresponding folder and will contain XML files.
Page 182 XWiki Standard 9.8.1 Administrator Guide
Large Import from Disk
The script "Large Import from Disk" does the reverse operation: allows to import a large .ZIP file containing XML pages into your wiki. To import the entire archive, check the "Import all" option.
Otherwise, hit "Submit", select the files you wish to import, then click on "Submit" again.
Page 183 XWiki Standard 9.8.1 Administrator Guide
Page 184 XWiki Standard 9.8.1 Administrator Guide
Just like for the "Import Page" script, you have 5 additional options: • "Do Not overwrite with versions" - do not replace the content of the target page but keep the versions • "Do Not overwrite without versions" - do not replace the content of the target page and don't keep the versions • "Add version" • "Overwrite with version" - replace the content of the target page and also keep the versions • "Overwrite without versions" - replace the content of the target page but don't keep the versions MySQL Tools
This section contains 6 dedicated scripts for database querying and diagnosis. MySQL Encoding Check
To check encoding, just run the "MySQL Encoding Check" script which returns: • General database character set settings information like: • character_set_client - the character set for statements that arrive from the client. The session value of this variable is set using the character set requested by the client when the client connects to the server. This should be set to utf8mb4. • character_set_connection - the character set used for literals that do not have a character set introduced and for number-to-string conversion. This should also be set to utf8mb4. • character_set_database - the character set used by the default database that should be set to utf8. • character_set_filesystem - the file system character set used to interpret string literals that refer to file names. It is recommended to set it to binary. • character_set_results - the character set used for returning query results such as result sets or error messages to the client. • character_set_server - the default character set of the server that should be set to utf8. • character_set_system - the character set used by the server for storing identifiers that should be always set to utf8. A character set is a set of symbols and encodings.
• General database collation settings: • collation_connection - the collation of the connection character set which should be set to utf8mb4_general_ci (case insensitive).
Page 185 XWiki Standard 9.8.1 Administrator Guide
• collation_database - the collation used by the default database which should be utf8_bin in order to have correct sorting for page names that start with special characters. For instance, you want "é" to come after "e", not after "z". • collation_server - the default collation of the server that should be set to utf8_general_ci.
A collation is a set of rules for comparing characters in a character set. • Encoding settings for the main wiki database: • collation of the main wiki database - it should be set to utf8_bin. • character set of the xwikidoc table - it must be utf8. • collation of the xwikidoc table - it must be utf8_bin.
XWiki Database Indexes Check
In case your wiki pages load really slow or if any wiki search takes too much time to return any results, the first thing you need to check is whether database indexes have been created. To do so, simply execute the "XWiki Database Indexes Check" script which returns the list of indexes not found. To create the missing indexes, simply execute the MySQL commands available in the "XWiki Database Schema" documentation. Run Query
This script allows you to perform MySQL "SELECT" operations in the database. By default, the "URL" field is filled in for the main wiki database: "jdbc:mysql://localhost/upgrade1_xwiki? useServerPrepStmts=false&useUnicode=true&characterEncoding=UTF-8". To query a sub-wiki, simply replace the database name.
Page 186 XWiki Standard 9.8.1 Administrator Guide
Page 187 XWiki Standard 9.8.1 Administrator Guide
Show Large History
This script displays pages with many versions that occupy a significant amount of space in the xwikircs table.
To clear the database history from the UI, simply call the "reset" action which will keep only the latest version and will reset it to "1.1". For instance, call ServerName/xwiki/bin/reset/Sandbox/Test and confirm.
Show Spammed Pages
This script displays the pages having more comments than a predefined threshold which default to "50".
Page 188 XWiki Standard 9.8.1 Administrator Guide
You will then need to write a script that performs a comments cleanup. Sanity Check
This script searches for database inconsistencies including: • objects and attachments for which the document doesn't exist anymore • attachments with no content • duplicate objects attached to the same page • comments and preferences for which the object doesn't exist anymore • properties declared as having a particular type but which are not in the correct table • translation documents marked as original documents • orphan translated documents
Related Pages
Page 189 XWiki Standard 9.8.1 Administrator Guide
• User Guide • Page Export Formats • Office Importer Application • Developer Guide • XWiki Database Schema • The "xwikirecyclebin" Table • The "xwikircs" Table • The "xwikidoc" Table • The "xwikiattrecyclebin" Table • The "xwikiattachment_content" Table • The "xwikiattachment_archive" Table • The "xwikiattachment" Table • Security Module • Customize the Look and Feel of the PDF and RTF Export • Attachment Selector Macro • Admin Guide • XWiki Standard Installation and Upgrade • XWiki Setup Overview • Set the Wiki Access Rights • Set the Users Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • MySQL Installation and Configuration • Import - Export Application • Customize the User Registration Process • Create a Sub-Wiki • Configure the Office Server • Attach Large Files XWiki Statistics Application • Enable Statistics • Enable Statistics from the Configuration File • Enable Statistics from XWiki.XWikiPreferences • Access the Statistics Page • Page Statistics • Referrer Statistics • Visit Statistics • Activity Statistics • Display Wiki Statistics in Panels • Change the Default Number of Results The Statistics application is no longer bundled with XWiki Standard but you can easily install it using the Extension Manager. Enable Statistics Enable Statistics from the Configuration File
In XWiki Standard, the Statistics feature is disabled by default. In order to enable it, a system administrator has to edit the xwiki.cfg configuration file and make sure the value of the properties xwiki.stats and swiki.stats.default is set to 1, as shown below, xwiki.stats=1 xwiki.stats.default=1 where: • xwiki.stats controls whether the Statistics feature is on or off • xwiki.stats.default controls whether the Statistics feature is on or off by default for the current Wiki A restart of the wiki will be necessary to apply the changes. Enable Statistics from XWiki.XWikiPreferences
Since there is no UI available for enabling statistics, you will need to modify the administration page. First of all, edit the "XWiki.XWikiPreferences" class (/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class) and add a Boolean property named statistics.
Page 190 XWiki Standard 9.8.1 Administrator Guide
Next, edit the "XWiki.XWikiPreferences" page in "Objects" mode (/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object), expand the "XWiki.XWikiPreferences" object and set the "Statistics" property to "Yes".
Access the Statistics Page
In order to access the Statistics home page click the icon which launches the drawer menu, then on "Application Index" in order to access the list of installed applications and finally on "Statistics".
Page 191 XWiki Standard 9.8.1 Administrator Guide
You will notice that a panel is displayed for each of the 4 types of statistics.
Page 192 XWiki Standard 9.8.1 Administrator Guide
Page 193 XWiki Standard 9.8.1 Administrator Guide
XWiki tracks 4 types of statistics information: • Page statistics • Referrer statistics • Visit statistics • Activity statistics Page Statistics
To access this page, click on the "Page Statistics" link in the bulleted list to the bottom of the home page or type the following URL: /xwiki/bin/view/Stats/Document. By default, page statistics include:
• a tracking of the most viewed and edited wiki pages. • a tracking of the most viewed and edited wiki spaces.
Page 194 XWiki Standard 9.8.1 Administrator Guide
Page 195 XWiki Standard 9.8.1 Administrator Guide
Referrer Statistics
This page is available by clicking on the "Referrer" link in the bulleted list to the bottom of the home page or by typing the following URL: /xwiki/bin/view/Stats/Referrer. The Referrer page contains statistics about: • the address of the web pages linking to your wiki which are displayed in the "Best Referrers" panel • the most referred pages
Visit Statistics
To access this page, click on the "Visit Statistics" link in the bulleted list to the bottom of the home page or type the following URL: /xwiki/bin/view/Stats/Visit. The visit statistics list: • the most active contributors • the least active contributors
Page 196 XWiki Standard 9.8.1 Administrator Guide
The "Changes" column allows you to know how many times the page in question has been edited. Activity Statistics
This page is available by clicking on the "Activity Statistics" link in the bulleted list to the bottom of the home page or by typing the following URL: /xwiki/bin/view/Stats/Activity. The Activity statistics track: • the current week activity • the current month activity • the current year activity • all time activity
Page 197 XWiki Standard 9.8.1 Administrator Guide
Page 198 XWiki Standard 9.8.1 Administrator Guide
By default, these statistics count the non-unique visitors. Display Wiki Statistics in Panels
The Statistics Application which provides a collection of panels, accessible by clicking the button which opens the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Look & Feel" -> "Panels" in the accordion menu to the left, then select the "Panel List" tab.
The statistics panels are displayed under the "Information" category.
Page 199 XWiki Standard 9.8.1 Administrator Guide
To make any of these panels available in your wiki, go to the "Panels" documentation. As the wiki grows bigger and it contains many spaces, pages and users, performance issues might appear causing an increased loading time for the Panel Wizard. At the moment, the easiest way to avoid this situation is to comment the code for the panels in the pages Page Statistics and Visit Statistics. To do so, edit each panel in "Inline" mode as explained above and place the code between #* and *#. Change the Default Number of Results
Supposing you want to change the default number of users listed in the "Most Active Contributors" panel, you need to go to the 'Panel List' tab of the wiki administration page. Next, search for the panel in question in the "Information" category and click on "Edit" which will make the panel available for edition in "Inline Form" mode.
Page 200 XWiki Standard 9.8.1 Administrator Guide
In the "Content" text area, search for the line $xwiki.criteriaService.rangeFactory.createHeadRange(5)) and replace the number "5" (the default value) a value of your choice.
Page 201 XWiki Standard 9.8.1 Administrator Guide
Page 202 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• Developer Guide • The "xwikistatsvisit" Table • The "xwikistatsreferer" Table • The "xwikistatsdoc" Table • Admin Guide • Other XWiki Applications Overview • Activate and Configure Google Analytics Users and Groups Overview FAQ User and Group Directory
How do I create a global user? What is the difference between a local user and a global user? How do I access the list of global users? How do I access the list of local users? How do I edit a global user? How do I delete a user from the wiki? How do I browse the list of wiki users? How can I customize the User Directory livetable? How do I create a global group? What is the difference between a global group and a local group? How do I access the list of global groups? How do I access the list of local groups? How do I add a new member to a global group? Can I add a whole group to a global group? How do I delete a user from a global group? How do I edit a local group? How do I delete a global group? Sub-Wiki Membership
How do I see the members of a sub-wiki How do I add users to a sub-wiki How do I invite users to a sub-wiki How do I cancel an invitation to join a sub-wiki How do I accept a join request from an user? How do I reject a join request from an user? How do I remove an user from a sub-wiki Create a Global User
Global users can be created only from the main wiki. To do so, log in as administrator, click the button to open the drawer menu, then on "Administer Wiki".
Page 203 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Users & Rights" -> "Users" in the accordion menu to the left in order to bring up an overview of all users.
Page 204 XWiki Standard 9.8.1 Administrator Guide
Next, click on the "Add user" button,
Page 205 XWiki Standard 9.8.1 Administrator Guide
fill in all the required user information and click on "Save".
Page 206 XWiki Standard 9.8.1 Administrator Guide
If successful, a confirmation message will be displayed. You will be then redirected back to the overview page so that you can see the new user.
Page 207 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • XWiki Login • User Status • Registration • Admin Guide • Users and Groups Overview • User Directory Application • The Management of Global/Local Users and Groups • Set the Users Access Rights • Manage the Sub-Wiki Users • Edit a Global User • Edit a Global Group • Delete a Global User • Customize the User Registration Process Edit a Global User
Global users can be edited only from the main wiki. To do so, log in as administrator, click the button which opens the drawer menu, then on "Administer Wiki".
Page 208 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Users & Rights" -> "Users" in the accordion menu to the left in order to bring up an overview of all users.
Page 209 XWiki Standard 9.8.1 Administrator Guide
Click on the yellow pen icon in the "Manage" column corresponding to the user you want to edit,
Page 210 XWiki Standard 9.8.1 Administrator Guide
change or fill in the missing user information and click on "Save".
Page 211 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Status • User Profile • User Preferences • Registration • Dashboard Application • Developer Guide • User Avatar Macro • User Avatar Java Macro • Admin Guide • Users and Groups Overview • User Directory Application • The Management of Global/Local Users and Groups
Page 212 XWiki Standard 9.8.1 Administrator Guide
• Set the Users Access Rights • Manage the Sub-Wiki Users • Edit a Global Group • Delete a Global User • Customize the User Profile Sections • Create a Global User Delete a Global User
You may delete a global user only from the main wiki. To do so, log in as administrator, click the which opens the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Users & Rights" -> "Users" in the accordion menu to the left in order to bring up an overview of all users.
Page 213 XWiki Standard 9.8.1 Administrator Guide
To delete an user, click on the X button in the corresponding "Manage" column.
Page 214 XWiki Standard 9.8.1 Administrator Guide
The user will be automatically removed from all the groups he/she was a member of. You won't be able to delete the user you are currently logged in with, so you will need to log using other credentials in order to perform this operation.
Related Pages
• User Guide • User Status • Registration • Admin Guide • Users and Groups Overview • User Directory Application • The Management of Global/Local Users and Groups • Set the Users Access Rights • Manage the Sub-Wiki Users • Edit a Global User • Edit a Global Group • Create a Global User
Page 215 XWiki Standard 9.8.1 Administrator Guide
Create a Global Group
Global groups can be created only from the main wiki. To so so, log in as administrator, click the button which opens the drawer menu, then on "Administer Wiki".
In the wiki administration page, click on "Users & Rights" -> "Groups" in the accordion menu to the left to bring up an overview of all groups.
Page 216 XWiki Standard 9.8.1 Administrator Guide
Click on the "Add group" button to open the group creation light-box as shown in the image below.
Enter the group name and click on the "Create group" button.
Page 217 XWiki Standard 9.8.1 Administrator Guide
You will see the newly created group in the overview livetable.
Related Pages
• Admin Guide • Users and Groups Overview • The Management of Global/Local Users and Groups • Set the Group Access Rights • Edit a Global Group • Delete a Global Group Edit a Global Group • Add Users to a Group • Add Subgroups to a Group • Remove the Group Members
You may edit a global group only from the main wiki. To do so, log in as administrator, click the button which opens the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Users & Rights" -> "Groups" to bring up an overview of all groups.
Page 218 XWiki Standard 9.8.1 Administrator Guide
At this point you have two options: • Click on the group name then edit the page in "Inline form" mode to display the group members (if any).
Page 219 XWiki Standard 9.8.1 Administrator Guide
• Click on the pencil icon in the "Manage" column of the livetable which will open a lightbox with the group members. Add Users to a Group
For both options you can add a new user to the group by typing the username in the input below "Users to Add". After starting to type, if the user exists, the suggest feature will help you by displaying the list of all occurrences, so you can select from them. The User Picker displays the user avatar and a link to the user profile and it also allows you to add multiple users in one step.
Since for an XWiki group multiple selection is enabled by default, each selected user is added to a temporary list above the picker.
Page 220 XWiki Standard 9.8.1 Administrator Guide
To remove an user from the list, just hover it and click on the red "X" in the top right corner. You may remove all users at once by clicking on the "Clear selection" link. Once you are done creating the list, click on "Add" and the new users will also appear in the livetable.
Add Subgroups to a Group
You can add an entire group to the current group. This can be done by typing the group name in the input below "Subgroups to Add" then by selecting the group from the suggested list. The Group Picker allows you to add multiple subgroups in one step. The group alias is the name of the group document, the group name is the title of the group document and the group avatar is the first image attached to the group document.
If multiple selection is enabled, each selected subgroup is added to a temporary list above the picker.
Page 221 XWiki Standard 9.8.1 Administrator Guide
To remove a subgroup from the list, just hover it and click on the red "X" in the top right corner. You may remove all subgroups at once by clicking on the "Clear selection" link. Once you are done creating the list of new subgroups, click on "Add" and they will also appear in the livetable.
Remove the Group Members
To delete an user or a subgroup, click on the corresponding "remove" link in the "Manage" column. Also, in case an user or a group is deleted from the wiki, it will be automatically removed from all the groups it was a member of.
Related Pages
• User Guide • User Status • Registration • Admin Guide • Users and Groups Overview • User Directory Application • The Management of Global/Local Users and Groups • Set the Users Access Rights • Set the Group Access Rights • Edit a Global User • Delete a Global User • Delete a Global Group • Create a Global User • Create a Global Group
Page 222 XWiki Standard 9.8.1 Administrator Guide
Delete a Global Group
You may delete a global group only from the main wiki. To do so, log in as administrator, click the button to open the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Users & Rights" -> "Groups" in the accordion menu to bring up an overview of all groups.
Page 223 XWiki Standard 9.8.1 Administrator Guide
Delete a group by clicking on the corresponding X button in the "Manage" column.
When you delete a group, the users or groups in that group are not deleted. If you also want to delete the members of the group, you will have to delete them manually from the "Users" and "Groups" administration sections.
Page 224 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• Admin Guide • Users and Groups Overview • The Management of Global/Local Users and Groups • Set the Group Access Rights • Edit a Global Group • Create a Global Group The Management of Global/Local Users and Groups • Global Users versus Local Users • Browse the List of Main Wiki Users • Edit a Global User • Browse the List of Local Users • Edit a Local User • Global Groups versus Local Groups • Browse the List of Global Groups • Edit a Global Group • Browse the List of Local Groups • Edit a Local Group • Add an User to a Local Subgroup • Add a Subgroup to a Local Group • Delete an User or a Subgroup From a Local Group An XWiki Standard instance consists of a main wiki which is also named the wiki manager and a number of sub-wikis. Therefore, the users, groups and rights management can be done globally or locally. Global Users versus Local Users
Global users are created on the main wiki and the rights granted there will also apply on the sub-wikis. Local users are created on each sub-wiki and they will only be editors or administrators on that particular sub-wiki. Browse the List of Main Wiki Users
Go to any main wiki page, click the button to open the drawer menu, then on "Administer Wiki".
Page 225 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Users & Rights" -> "Users" in the accordion menu to the left
Page 226 XWiki Standard 9.8.1 Administrator Guide
and you will see the global users overview.
Page 227 XWiki Standard 9.8.1 Administrator Guide
Edit a Global User
Global users can only be edited from the main wiki. To do so, go to the administration page of the main wiki and follow the steps described here. Browse the List of Local Users
Go to any sub-wiki page, click the button, then click on "Administer wiki". In the wiki preferences page, click on "Users & Rights" -> "Users" in the accordion menu to the left.
Depending on the option you chose when creating the sub-wiki, you will see one of the 3 possible user interfaces. If the sub-wiki has only global users, you should see a livetable named "Current Members" with the main wiki users that have been added or invited to the sub-wiki.
Page 228 XWiki Standard 9.8.1 Administrator Guide
In case the sub-wiki has both local and global users, the "Current Members" livetable will display, besides the main wiki users, the list of local sub-wiki users.
Page 229 XWiki Standard 9.8.1 Administrator Guide
Page 230 XWiki Standard 9.8.1 Administrator Guide
To create a local user, click the "Add user" button in the "Users" section and follow the instructions described here. New local users will be automatically added as members and displayed in the "Current Members" livetable.
By default, only local users will be listed in the "Users" livetable but you can also choose to display the global users or both categories by selecting the corresponding option from the "Manage" column.
Finally, if the sub-wiki only has local users, you will see just the "Users" livetable and a button for creating new ones. This time too, only local users will be listed but you can still switch to "Global" or "Both".
Edit a Local User
Local users can only be edited in the sub-wiki they were created on. The process is similar to the one for global users and it is detailed here. Global Groups versus Local Groups
Just like in the case of global users, global groups are created on the main wiki and any rights granted to them will also apply on the sub-wikis. Local groups are created on each sub-wiki and they can contain both local and global users and subgroups whereas global groups can only have global members and subgroups. Browse the List of Global Groups
Go to any main wiki page, click the button, then on "Administer wiki". In the wiki administration page, click on "Users & Rights" -> "Groups" in the accordion menu to the left
Page 231 XWiki Standard 9.8.1 Administrator Guide
which will bring an overview of the global groups.
Edit a Global Group
Global groups can only be edited in the main wiki by adding or removing global users and global subgroups. For more details, follow this link. Browse the List of Local Groups
Go to any page of the sub-wiki, click the button, then click on "Administer wiki". In the wiki preferences page, click on "Users & Rights" -> "Groups" in the accordion menu to the left. Just like for local users, only local groups are displayed by default in the livetable: • XWikiAdminGroup includes all the local sub-wiki administrators. By default this group is empty. • XWikiAllGroup includes all the users that were added or invited to the sub-wiki, as explained in the above section.
Page 232 XWiki Standard 9.8.1 Administrator Guide
In case you want to list the global groups or should you prefer to display both categories, just select the corresponding option from the drop-down list in the "Manage" column.
The global groups names are not clickable and the number of members is not displayed which means that they can only be accessed or edited in the main wiki. Edit a Local Group
Go to the local group overview page and you have 2 options: • Click on the group name to open the group page. Next, click on the "Edit" menu to open the group page in "Inline form" mode.
Page 233 XWiki Standard 9.8.1 Administrator Guide
• Click on the pencil icon in the "Manage" column which will open a light-box displaying the members of the local group. Add an User to a Local Subgroup
In both cases you can add a new user to the group by typing the username in the input near "Add user to group". Provided the sub-wiki is configured to support this, you can add both local and global users by first selecting the corresponding option in the drop-down list. After starting to type, if the user exists, the suggest feature will help display the list of occurrences, so you can select from them. The User Picker displays the user avatar and a link to the user profile and it also allows you to add multiple users in one step. The process is the same as for global users. In order to toggle between the local and global scope, click on the globe icon. If you are in local scope, the icon will be ,
whereas in global scope, the icon will be .
Page 234 XWiki Standard 9.8.1 Administrator Guide
Add a Subgroup to a Local Group
You can also add an entire group to the current local group.This can be done by typing the group name in the input below "Subgroups to Add" then by selecting the group from the suggested list. The Group Picker allows you to add multiple subgroups in one step. The group alias is the name of the group page, the group name is the title of the group page while the group avatar is the first image attached to the group page. The process is the same as for global groups.
In order to toggle between the local and global scope, click on the globe icon. If you are in local scope, the icon will be , whereas in global scope, the icon will be . You can add both local and global subgroups by first choosing the corresponding option in the drop-down list. After starting to type, if the subgroup exists, the suggest feature will display the list of all the group names containing the typed letters.
Delete an User or a Subgroup From a Local Group
To remove an user or a subgroup from a local group, just click on the corresponding "remove" link in the "Manage" column.
Page 235 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Status • Registration • Admin Guide • Users and Groups Overview • User Directory Application • Set the Users Access Rights • Set the Group Access Rights • Manage the Sub-Wiki Users • Edit a Global User • Edit a Global Group • Delete a Global User • Delete a Global Group • Create a Global User • Create a Global Group Manage the Sub-Wiki Users • The Sub-Wiki User Directory • Add or Remove Users • The Sub-Wiki Supports only Global Users • The Sub-Wiki Supports only Local Users • The Sub-Wiki Supports both Local and Global Users • Create and Cancel Invitations • Sub-Wiki with Global Users • Sub-Wiki with Local Users • Sub-Wiki with both Local and Global Users • Join Requests • Accept a Join Request • Reject a Join Request In order to have the necessary privileges to manage the sub-wiki users, you need to either be its owner or an administrator. The Sub-Wiki User Directory
To access the users directory, click the button which opens the drawer menu, then on "User Index".
Page 236 XWiki Standard 9.8.1 Administrator Guide
The User Directory displays sortable and filterable XWiki.XWikiUsers properties as columns. Any user can customize his view over the User Directory livetable by adding or removing columns. To know more, go to the dedicated documentation page listed in the "Related Pages" section. In case you configured your wiki to support both local and global users, the "User Scope" drop-down allows choosing the sub- wiki members to display:
Page 237 XWiki Standard 9.8.1 Administrator Guide
• global users i.e. main wiki users • local users i.e. users created locally on the sub-wiki; this option is selected by default Add or Remove Users
Click the button which opens the drawer menu, then click on "Administer wiki".
In the sub-wiki preferences page, click on "Users & Rights" -> "Users" in the accordion menu to the left. Depending on the sub- wiki configuration, you have 3 possibilities. The Sub-Wiki Supports only Global Users
If you configured the sub-wiki to be accessible exclusively to global users, you will be able to add only main wiki users. To to so, fill in the user name and eventually a message which will be privately sent to the user, then click on "Add". After starting to type the user name, if the user exists, the suggest feature will help by displaying the list of occurrences.
Page 238 XWiki Standard 9.8.1 Administrator Guide
The XWiki User Picker allows you to add multiple users at once. To remove one of them, just hover the corresponding user name and click on the red "X" in the top right corner. In case you want to remove all the members at once, click on "Clear selection".
Page 239 XWiki Standard 9.8.1 Administrator Guide
The new member(s) of the sub-wiki will appear in the "Current Members" livetable.
To remove a member, click on the corresponding "remove" link in the "Manage" column. The Sub-Wiki Supports only Local Users
For a sub-wiki accessible only to local users, the "Add or Invite Users to Wiki", "Current Members" and "Candidates" section won't be displayed anymore. In exchange, you will see the users overview which will display local users by default.
Page 240 XWiki Standard 9.8.1 Administrator Guide
To create a local user, click on "Add user", fill in the required information in the registration form, then click on "Save".
Page 241 XWiki Standard 9.8.1 Administrator Guide
The Sub-Wiki Supports both Local and Global Users
For a sub-wiki that is accessible for its local users as well as for global users, you can add main wiki users by filling in the user name (and eventually a message which will be privately sent to the user) and clicking the "Add" button.
Page 242 XWiki Standard 9.8.1 Administrator Guide
Page 243 XWiki Standard 9.8.1 Administrator Guide
Existing local users are already displayed in the "Current Members" livetable. To add a new local user, you need to create it using the "Add User" button and he/she will be automatically added to the "Current Members" livetable. Create and Cancel Invitations
The "Invite User" feature is mostly used in an "invitation-only" sub-wiki but it is not restricted to that. Any global user can be invited, regardless of the wiki membership type. Go to the wiki administration page and click on the "Users" link in the vertical menu to the left. Similarly to the Add User feature, there are 3 possible cases. Sub-Wiki with Global Users
If the sub-wiki is accessible exclusively to global users, you will only be able to invite them by filling in the user name and eventually a message viewable by the user, then clicking the "Invite" button.
Just like in the above section, you can invite several users at once. If the operation is successful, you will see a confirmation message
and also new entries in the "Candidates" section to the bottom of the page.
Page 244 XWiki Standard 9.8.1 Administrator Guide
The invitation template contains information about the invited user, the status and type of the request and the name of the user who has made the invitation. The "Private Comment" is meant for the wiki administrators and its purpose is to provide a justification for inviting the user. The invitation message will be displayed in the activity stream displayed in the page Main.Activity,
as well as in the activity stream on the profile page of the invited user.
Page 245 XWiki Standard 9.8.1 Administrator Guide
Once the user accepts the invitation, you will notice a change of status in the "Candidates" section.
The same thing happens if an user rejects the invitation. To cancel an invitation, go to the wiki administration page and click on the "Users" link in the vertical menu to the left. In the "Candidates" section, click on the corresponding "Cancel Invitation" button. If successful, you will see a confirmation message.
The cancellation message will be visible in the activity stream on the wiki home page.
and in the activity stream on the user's profile page.
Page 246 XWiki Standard 9.8.1 Administrator Guide
Sub-Wiki with Local Users
For a sub-wiki accessible only to local users, the "Invite User" feature is not available because it was meant for inviting global users. Sub-Wiki with both Local and Global Users
For a sub-wiki that is accessible for its local users as well as for global users, you can invite main wiki users by filling in the user name (and eventually a message which will be privately sent to the user) and clicking the "Invite" button. The process is the same as for a sub-wiki that only supports global users. Join Requests Accept a Join Request
If you are the owner or an administrator, go to the wiki administration page and click on the "Users" link in the vertical menu to the left. In the "Candidates" section, click on the corresponding "Accept" button. You can also add a message in the "Admin's Message" text-box which will be privately sent to the requesting user as a reply. The "Private Comment" is meant for the wiki administrators and its purpose is to provide a justification for the acceptance of the request.
If successful, you will see a confirmation message to the top of the page. In the "Candidates" section, the status of the user request will become "Accepted" and you will also be able to see the administrator's message.
Page 247 XWiki Standard 9.8.1 Administrator Guide
Reject a Join Request
If you are the owner or an administrator, go to the wiki administration page and click on the "Users" link in the vertical menu to the left. In the "Candidates" section, click on the corresponding "Reject" button. You can also add a message in the "Admin's Message" text-box which will be privately sent to the requesting user as a reply. The "Private Comment" is meant for the wiki administrators and its purpose is to provide a justification for the rejection of the request.
If successful, you will see a confirmation message to the top of the page. In the "Candidates" section, the status will become "Rejected" and you will also be able to see the Administrator's message.
Page 248 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Admin Guide • XWiki Applications Overview • Wiki Directory • User Directory Application • The Management of Global/Local Users and Groups • Set the Wiki Access Rights • Set the Users Access Rights • Edit the Sub-Wiki Settings • Edit a Global User • Delete a Sub-Wiki • Delete a Global User • Create a Sub-Wiki • Create a Global User Rights Overview FAQ
How do I set the access rights for the whole wiki? How do I set the access rights for a sub-wiki? How do I set the permissions scheme for a nested page and its children? How do I set the permissions scheme for a terminal page? How do I set the access rights for global groups? How do I set the access rights for local groups? How do I set the access rights for global users? How do I set the access rights for local users? What are the different permission types? How do I use rights to configure access on the wiki? Set the Wiki Access Rights • Set the Main Wiki Access Rights • Set the Sub-Wiki Access Rights • Default Values for Rights at Main Wiki Level • Default Values for Rights at Sub-wiki Level Set the Main Wiki Access Rights
To change rights for the main wiki, log in as administrator, click the button to open the drawer menu, then click on "Administer Wiki".
Page 249 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Users & Rights" -> "Rights" in the accordion menu to the left.
Page 250 XWiki Standard 9.8.1 Administrator Guide
Next, select the users or groups for which you want to set a permission. Note that if you are on the main wiki, you are editing the rights for global users and groups. To know more about the difference between local and global users and groups, follow this link.
Page 251 XWiki Standard 9.8.1 Administrator Guide
Click once on a check-box to allow a right, twice to deny it and three times to clear the right and use the default values. Note that rights entries are saved automatically.
Starting with version 7.2, a new "Script" right has been added to control who has the right to write scripts. Anyone with edit rights can write a script in a wiki page. However, when the page is rendered, the script will only execute if the last author of the page has the "Script" right. For backward-compatibility reasons, the standard XWiki Standard distribution comes with the "Script" right being allowed for all users at the main wiki level. So, unless an administrator explicitly revokes the right for some users or groups, they will be able to execute the scripts they wrote. More information about permission types are available in the dedicated documentation page. Set the Sub-Wiki Access Rights
To change rights for a sub-wiki, log in as administrator, click the button, then on "Administer Wiki".
In the wiki preferences page, click on "Users & Rights" -> "Rights" in the accordion menu to the left.
Page 252 XWiki Standard 9.8.1 Administrator Guide
Select the local or global groups and users for which you want to set a permission.
Page 253 XWiki Standard 9.8.1 Administrator Guide
Click once on a check-box to allow a right, twice to deny it and three times to clear the right and use the default values. Note that rights entries are saved automatically. Unlike the main wiki, the "Script" right is set to default on sub-wikis, meaning that it is denied. Default Values for Rights at Main Wiki Level When a right has been allowed at a given level, it gets explicitly denied to anyone else at the same level. Wiki Right Default Value Comments VIEW ALLOWED EDIT ALLOWED EDIT rights at wiki level also imply VIEW rights COMMENT ALLOWED DELETE DENIED SCRIPT ALLOWED REGISTER ALLOWED ADMIN DENIED • ADMIN rights at wiki level also imply the VIEW, EDIT, COMMENT, DELETE and REGISTER rights. • If ADMIN rights are granted at wiki level, they cannot be denied at page level. • The rights implied by ADMIN rights will not be overridden by a denial at a lower level. PROGRAM DENIED • Programming rights can only be set in the main wiki. • PROGRAMMING rights at wiki level also imply VIEW, EDIT, COMMENT, DELETE, REGISTER and ADMIN rights.
Page 254 XWiki Standard 9.8.1 Administrator Guide
• If PROGRAMMING rights are granted at wiki level, they cannot be denied at page level. CREATE WIKI DENIED The rights to create wiki can only be granted via the main wiki.
Default Values for Rights at Sub-wiki Level When a right has been allowed at a given level, it gets explicitly denied to anyone else at the same level. Wiki Right Default Value Comments VIEW ALLOWED EDIT ALLOWED EDIT rights at wiki level also imply VIEW rights COMMENT ALLOWED SCRIPT DENIED DELETE DENIED ADMIN DENIED • ADMIN rights at wiki level also imply the VIEW, EDIT, COMMENT and DELETE rights. • If ADMIN rights are granted at wiki level, they cannot be denied at page level. • The rights implied by ADMIN rights will not be overridden by a denial at a lower level.
Related Pages
• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Developer Guide • Security Module • Admin Guide • Wiki Directory • Set the Users Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Customize the User Registration Process • Create a Sub-Wiki • Admin Tools Application Set the Page Access Rights • Set the Permission Scheme for a Nested Page and Its Children • Set the Permission Scheme for a Terminal Page • Default Values for Page Rights • Nested Page and Its Children • Single Page XWiki 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 represents a wiki page that can have child pages.
Page 255 XWiki Standard 9.8.1 Administrator Guide
• Non-Nested Page or Terminal Page is a wiki page with no child pages and it is usually created by applications and scripts.
This is the reason why we don't set permissions for spaces and pages any more, but for nested pages and their children. For more details concerning nested pages, please refer to the "Wiki Pages" documentation listed under "Related Pages". Also, a new "Script" right has been added to allow controlling who has the right to write scripts. Anyone with edit rights can write a script in a wiki page. However, when the page is rendered, the script will only execute if the last author of the page has the "Script" right. Set the Permission Scheme for a Nested Page and Its Children
To edit the access rights for a nested page, simply navigate to that page, click the button, then on "Administer Page".
Page 256 XWiki Standard 9.8.1 Administrator Guide
You will be redirected to the preferences page were there are 2 options in the menu on the left under "Users & Rights": • Rights: Page & Children - allows to set the permissions scheme that will apply on the current page and all its children.
Page 257 XWiki Standard 9.8.1 Administrator Guide
• Rights: Page - allows to set the permissions scheme that will apply on the current (parent) page only.
Click once on the check-box to grant a right, twice to deny it and a third time to clear the right and use the default values. Note that rights entries are saved automatically. The same process applies on the old spaces created before version 7.2. Set the Permission Scheme for a Terminal Page
Terminal pages don't have a preferences document - this is the reason why, in order to set the access rights for a single page, you will have to click the "Edit" button, then choose "Access rights".
Page 258 XWiki Standard 9.8.1 Administrator Guide
Just like in the previous section, click once on the check-box to grant a right, twice to deny it and a third time to clear the right and use the default values.
Default Values for Page Rights When a right has been allowed at a given level, it gets explicitly denied to anyone else at the same level. Nested Page and Its Children Wiki Right Default Value Comments VIEW ALLOWED EDIT ALLOWED EDIT rights at page level also imply VIEW rights COMMENT ALLOWED SCRIPT DENIED DELETE DENIED ADMIN DENIED • ADMIN rights at page level also imply the VIEW, EDIT, COMMENT and DELETE rights. • The rights implied by ADMIN rights will not be overridden by a denial at a lower level.
Page 259 XWiki Standard 9.8.1 Administrator Guide
Single Page Wiki Right Default Value Comments VIEW ALLOWED EDIT ALLOWED EDIT rights at page level also imply VIEW rights COMMENT ALLOWED SCRIPT DENIED DELETE DENIED
Related Pages
• User Guide • Wiki Pages • Nested Page Actions • Developer Guide • XWiki JavaScript API • Security Module • Document Tree Macro • Children Macro • Admin Guide • Set the Wiki Access Rights • Set the Users Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • Customize the User Registration Process • Create a Sub-Wiki • Admin Tools Application Set the Group Access Rights • Set the Rights for Global Groups at Wiki Level • Set the Rights for Local Groups at Wiki Level • Set the Group Access Rights at Page Level Set the Rights for Global Groups at Wiki Level
Global groups are created on the main wiki and any rights granted to them will also apply for the sub-wikis. You might need to grant explicit rights for global groups on a sub-wiki in one of the following cases: • the wiki only has global users • the wiki has both global and local users This configuration option is set when creating the wiki, but it can be easily changed at a later time.
To set the access rights for a global group, you need to be the wiki owner or an administrator. Click the button to open the drawer menu, then click on "Administer Wiki".
Page 260 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Users & Rights" -> "Rights" in the accordion menu to the left to bring up an overview of group rights.
Page 261 XWiki Standard 9.8.1 Administrator Guide
On a sub-wiki, the livetable displays the local groups by default, so you will need to switch to "Global" in the "Search scope":
Page 262 XWiki Standard 9.8.1 Administrator Guide
Sub-Wiki
Click the check-box once to grant a right, twice to deny it and three times to clear the right and use the default values. Note that rights entries are saved automatically.
Main Wiki
Page 263 XWiki Standard 9.8.1 Administrator Guide
In both cases, you will notice a new "Script" right which was introduced in order to allow controlling who has the right to write scripts. Anyone with edit rights can write a script in a wiki page. However, when the page is rendered, the script will only execute if the last author of the page has the "Script" right. For backward-compatibility reasons, the standard XWiki distribution comes with the "Script" right being allowed for all users at the main wiki level. So, unless an administrator explicitly revokes the right for some users or groups, they will be able to execute the scripts they wrote. Set the Rights for Local Groups at Wiki Level
The access rights for local groups can only be set on the sub-wiki they were created on. Local groups are created on sub-wikis that support: • only local users • both local and global users
To set the access rights for local groups, go to a sub-wiki and log in as administrator. Next, click the button, then click on "Administer wiki" to go to the wiki preferences page. Click on "Users & Rights" -> "Rights" in the accordion menu to the left to bring up an overview of group rights.
Click the check-box once to grant a right, twice to deny it and three times to clear the right and use the default values.
Page 264 XWiki Standard 9.8.1 Administrator Guide
Set the Group Access Rights at Page Level
In order to set the access rights only for a nested page or a terminal page, please refer to this documentation. The rights set at page level override the rights for its parent page, which override the rights for a wiki. Also, when a right has been allowed at a given level, it gets explicitly denied to anyone else at the same level. You can read about permission types on the dedicated documentation page. Also, to learn more about the local and global groups, please follow this link.
Related Pages
• Developer Guide • Security Module • Admin Guide • Users and Groups Overview • The Management of Global/Local Users and Groups • Set the Wiki Access Rights • Set the Users Access Rights • Set the Page Access Rights • Rights Overview • Permission Types • Edit a Global Group • Delete a Global Group • Customize the User Registration Process • Create a Sub-Wiki • Create a Global Group • Admin Tools Application Set the Users Access Rights • Set the Rights for Global Users at Wiki Level • Set the Rights for Local Users at Wiki Level • Set the Users Access Rights for a Page Set the Rights for Global Users at Wiki Level
Global users are created on the main wiki and the rights granted there will also apply for the sub-wikis. You might need to grant explicit rights for global users on a sub-wiki in one of the following cases:
Page 265 XWiki Standard 9.8.1 Administrator Guide
• the wiki only has global users • the wiki has both global and local users
This configuration option is set when creating the wiki, but it can be easily changed at a later time. To set the rights for a global user you need to have administration rights or to be the owner of the wiki. Next, click the
button which opens the drawer menu, then click on "Administer Wiki".
Next click on "Users & Rights" -> "Rights" in the accordion menu to the left.
Page 266 XWiki Standard 9.8.1 Administrator Guide
In the table header, click on the "Users" radio button to bring up an overview of user rights.
Page 267 XWiki Standard 9.8.1 Administrator Guide
Main Wiki
On a sub-wiki, the livetable displays the local users by default, so you will need to switch to "Global" in the "Search scope".
Page 268 XWiki Standard 9.8.1 Administrator Guide
Sub-Wiki
Finally, click the check-box once to grant a right, twice to deny it and three times to clear the right and use the default values. Rights entries are saved automatically. In both cases, you will notice a new "Script" right which was introduced in order to allow controlling who has the right to write scripts. Anyone with edit rights can write a script in a wiki page. However, when the page is rendered, the script will only execute if the last author of the page has the "Script" right. For backward-compatibility reasons, the standard XWiki distribution comes with the "Script" right being allowed for all users at the main wiki level. So, unless an administrator explicitly revokes the right for some users or groups, they will be able to execute the scripts they wrote. Set the Rights for Local Users at Wiki Level
Local users are created on each sub-wiki that supports: • only local users • both local and global users
To set the access rights for local users go to a sub-wiki and log in as administrator. Next, click the button, then on "Administer wiki" to go to the preferences page.
Page 269 XWiki Standard 9.8.1 Administrator Guide
Click on "Users & Rights" -> "Rights" in the accordion menu to the left.
Page 270 XWiki Standard 9.8.1 Administrator Guide
In the table header, check on the "Users" radio button to bring up an overview of user rights.
Finally, click the check-box once to grant a right, twice to deny it and three times to clear the right and use the default values.
Page 271 XWiki Standard 9.8.1 Administrator Guide
Set the Users Access Rights for a Page
In order to set the access rights only for a nested page or a terminal page, please refer to this documentation. The rights set at page level override the rights for its parent page, which override the rights for a wiki. Also, when a right has been allowed at a given level, it gets explicitly denied to anyone else at the same level. You can read about permission types on the dedicated documentation page. Also, to learn more about the local and global users, please follow this link.
Related Pages
• User Guide • User Status • Registration • Developer Guide • Security Module • Admin Guide • Users and Groups Overview • User Directory Application • The Management of Global/Local Users and Groups • Set the Wiki Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • Manage the Sub-Wiki Users • Edit a Global User • Edit a Global Group • Delete a Global User • Customize the User Registration Process • Create a Sub-Wiki • Create a Global User • Admin Tools Application Permission Types • View Right • Comment Right • Edit Right • Delete Right • Special Permissions • Administration Right • Programming Right • Register Right • Create Wikis Right • Script Right View Right
The view right gives the user the ability to view a document or load it using the API. • Availability: Page, Space and Wiki level. • Default status: ALLOWED • Priority order: deny > allow > no setting • Checking order: terminal page > parent nested page > wiki Comment Right
The comment gives the user the ability to add a comment, but not to edit or delete it. • Availability: Page, Space and Wiki level. • Default status: ALLOWED • Priority order: deny > allow > no setting
Page 272 XWiki Standard 9.8.1 Administrator Guide
• Checking order: terminal page > parent nested page > wiki In order to be able to edit or delete your own comments, you need to have edit rights on the space or page. Also, you won't be able to edit or delete the comments of other users, unless you have administration rights. Edit Right
The edit allows you to edit the page and all of its objects. • Availability: Page, Space and Wiki level. • Default status: ALLOWED • Priority order: deny > allow > no setting • Checking order: terminal page > parent nested page > wiki Delete Right
The delete right allows you to move a page to the recycle bin. • Availability: Page, Space and Wiki level. • Default status: DENIED (unless you're the document creator) • Priority order: deny > allow > no setting • Checking order: terminal page > parent nested page > wiki Special Permissions Administration Right
The administration right can only be granted at space or wiki level. A very important detail is that the wiki administrator cannot have his/her administration rights denied for a space. Also, having administration rights imply the view, comment, edit and delete permissions with the added ability to permanently delete a page from the recycle bin. • Availability: • Space (Automatically includes the view, comment, edit, delete rights) • Wiki (Automatically includes the view, comment, edit, delete, register) • Default status: DENIED • Priority order: allow > deny > no setting • Checking order: wiki > page Programming Right
A programmer is allowed to execute arbitrary Java code in the wiki, so any page which was last saved by an user with programmer rights can run dangerous scripts. Because it affects the entire wiki (or wiki farm), programming rights can only be granted from the wiki preferences page in a single wiki environment or from the main wiki in a multi-wiki environment. • Availability: Main wiki level • Default status: DENIED • Priority order: allow > deny > no setting • Checking order: wiki Register Right
The register right is usually granted or revoked for the non-registered pseudo-user "XWiki.XWikiGuest". This permission can only be set from the wiki preferences page. • Availability: Wiki level • Default status: ALLOWED • Priority order: allow > deny > no setting • Checking order: wiki Create Wikis Right
The "createwiki" right can only be granted via the main wiki, just like programming rights. For detailed information, check this documentation page. • Availability: Main wiki level • Default status: DENIED • Priority order: allow > deny > no setting • Checking order: wiki Script Right
The "Script" right was introduced in version 7.2 in order to control who has the right to write scripts. Anyone with edit rights can write a script in a wiki page. However, when the page is rendered, the script will only execute if the last author of the page has the "Script" right.
Page 273 XWiki Standard 9.8.1 Administrator Guide
For backward-compatibility reasons, the standard XWiki Enterprise distribution comes with the "Script" right being allowed for all users at the main wiki level. So, unless an administrator explicitly revokes the right for some users or groups, they will be able to execute the scripts they wrote. • Availability: Wiki level • Default status: • ALLOWED on the main wiki • DENIED on sub-wikis • Priority order: allow > deny > no setting • Checking order: wiki
Related Pages
• Developer Guide • Security Module • Admin Guide • Set the Wiki Access Rights • Set the Users Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Customize the User Registration Process • Create a Sub-Wiki • Admin Tools Application Customize the User Registration Process
You can configure your Wiki to be open, so that everyone can edit or comment without having to register or to log in. To do this, simply grant the "view" and "comment" rights to the pseudo-user named XWiki.XWikiGuest.
In order to require users to confirm their registration and to provide a valid email address, click the button to open the drawer menu, then click on "Administer Wiki".
Page 274 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Users & Rights" -> "Registration" in the accordion menu to the left.
Page 275 XWiki Standard 9.8.1 Administrator Guide
Next, set "Use email verification" to "YES" which means that an email will be sent to the email address the user registered with. The "Authentication Active Check" option set to "YES" will prevent the users from logging in without entering the token which was previously sent by email. The content of the message is set in the "Validation E-Mail Content" text area.
Page 276 XWiki Standard 9.8.1 Administrator Guide
Registration Options • Registration page heading is the line displayed at the top of the page for the users who are registering or who have just registered. • Confirmation E-Mail Content requires that you set "Use email verification" and "Authentication Active Check" to "YES". These settings are optional but you will still have to provide a link to activate the account.
• Welcome Message requires that you set "User email verification" to "YES" and modify the "Validation E-Mail Content" so that it doesn't mention the verification since it is not needed anymore.
Page 277 XWiki Standard 9.8.1 Administrator Guide
• Enable Javascript field validation enables or disables the Live Validation. Note that if this option is set to "FALSE", the fields will still be validated server-side. • Default field okay message refers to the message displayed by the Live Validation when the fields have been correctly filled in. • Enable login button enables or disables the button the users need to click on in order to log in. • Enable automatic login is disabled by default. If enabled, the user is automatically logged in after a successful registration. • Redirect here after registration refers to the URL of the wiki page the user will be redirected to after clicking the "Login" button. • Require captcha to register requires the user to solve a CAPTCHA in order to register. • Registration Successful Message is displayed when the user has successfully registered. More details about the registration page are available by navigating to XWiki.RegistrationHelp.
Related Pages
• User Guide • XWiki Login • Registration • Developer Guide • Security Module • Admin Guide • Set the Wiki Access Rights • Set the Users Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • Create a Sub-Wiki • Create a Global User • Admin Tools Application Customization Overview FAQ Skin and Color Themes
How do I edit a Flamingo color theme? How do I switch to another Flamingo color theme? How do I change the wiki logo?
Page 278 XWiki Standard 9.8.1 Administrator Guide
Localization
How to set the timezone for the whole wiki? How do I set up the languages available in the wiki Search Engines and Search Suggest Sources
How to set the default search engine? How to customize the Solr index? How do I debug Solr queries? How to disable the search suggest? How do I edit a search suggest source? How do I add a search suggest source? How do I delete a search suggest source? Other Advanced Configurations
How do I enable the Google Analytics tracking? How do I configure the CKEditor? How do I configure annotations? How do I disable the message stream? Configure the Office Server • Configure Office as an Internally Managed Server Process • The Local Office UI • Configure Office as an Externally Managed Server Process • The Automatic Start Feature There are two ways of configuring an Office server: • as an internally managed process which is the default option • as an externally managed process Configure Office as an Internally Managed Server Process
By choosing the default configuration for Office, you allow your XWiki Standard installation to manage the Office server process for you. Moreover, there is an UI available in the wiki preferences page allowing you to start, stop or restart the Office server. The Local Office UI
To get to the Office Server administration section, click the button in order to open the drawer menu, then click on "Administer Wiki".
Page 279 XWiki Standard 9.8.1 Administrator Guide
In the wiki preferences page, click on "Content" -> "Office Server" in the accordion menu to the left.
You will then see the UI of your internally managed Office server,
Page 280 XWiki Standard 9.8.1 Administrator Guide
along with the 3 available actions to an administrator: • start the server • restart the server • stop the server Configure Office as an Externally Managed Server Process This information only concerns the system administrators. Having an externally managed server process means that the system administrator has full control on the Office server process. First of all, you need to edit the xwiki.properties file and set the openoffice.serverType parameter to 1. Next, the Office server needs to be manually started as a separate process by running the following command in the terminal, into the "program" directory: soffice -headless -accept="socket,host=127.0.0.1,port=8100;urp;" -nofirststartwizard
Page 281 XWiki Standard 9.8.1 Administrator Guide
After restarting Tomcat, you will notice a change in the Office Server administration page, because this time you will only have 2 available actions:
• connect to the server • disconnect from the server
The Automatic Start Feature
In order to use the automatic start feature, edit the xwiki.properties file and set the openoffice.autoStart parameter to true as shown below: #-# [Since 1.9M2] #-# If the openoffice server should be started / connected upon XE start. #-# Default value is false # openoffice.autoStart=true
Related Pages
• User Guide • Page Export Formats • Office Importer Application • Developer Guide • Office Macro • Customize the Look and Feel of the PDF and RTF Export
Page 282 XWiki Standard 9.8.1 Administrator Guide
• Admin Guide • XWiki Applications Overview • Import - Export Application • Admin Tools Application Configure Annotations
Annotations can be configured from the dedicated section in the wiki administration page. To change the default settings, click the button which opens the drawer menu, then click on "Administer Wiki".
In the wiki preferences page, click on "Content" -> "Annotations" in the accordion menu to the left.
Page 283 XWiki Standard 9.8.1 Administrator Guide
From this section you may configure: • Whether annotations are enabled • Whether annotations are enabled on the whole wiki or on a subset of locations • Whether annotations are displayed by default or only when checking the "Show annotations" option on each page • Whether the annotations highlight should always be displayed or whether it should only appear when hovering over an annotation • Extra properties for the annotations.
Page 284 XWiki Standard 9.8.1 Administrator Guide
Page 285 XWiki Standard 9.8.1 Administrator Guide
Annotations are merged with comments by default so, if you go to the "XWiki Class Defining Annotations Structure" field from the annotations configuration page, you will see that now it is "XWiki.XWikiComments" instead of "AnnotationCode.AnnotationClass". The "XWiki.XWikiComments" class has also been modified by adding new properties in order to support annotations.
Related Pages
• User Guide • Page Comments • Nested Page Actions • Annotations Application • Developer Guide • XWiki JavaScript API • The "xwikicomments" Table • Comment Macro • Admin Guide • XWiki Applications Overview • Wiki Directory • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Customization Overview • Create a Sub-Wiki Customize the Language and Timezone Settings • Set Up the Supported Languages • Global Timezone Settings Set Up the Supported Languages
To set up the supported languages, log in as administrator, click the button to open the drawer menu, then click on "Administer Wiki".
Page 286 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Content" -> "Localization" in the accordion menu to the left.
At this point you have 3 possibilities:
Page 287 XWiki Standard 9.8.1 Administrator Guide
• keep the default settings by leaving "Multilingual" to "---" which means that the default language of the wiki will be English ("en"). • set "Multilingual" to "No" and enter the default language you wish to have on your wiki. XWiki currently supports 38 languages as explained in the documentation page about "Internationalization". • set "Multilingual" to "Yes", enter the supported languages separated by comas ("en,fr,de,es"), then define the default language for the wiki. The language text inputs have been replaced with filter drop-down boxes for easy use.
Page 288 XWiki Standard 9.8.1 Administrator Guide
Global Timezone Settings
XWiki Standard allows administrators to globally set the timezone without the need to directly access the server. So, in order to use a specific timezone for the whole wiki, just select it from the "Timezone" filter drop-down list in the "Date/Time" section.
Page 289 XWiki Standard 9.8.1 Administrator Guide
Related Pages
• User Guide • User Preferences • Search Application • Internationalization • Developer Guide • XWiki Rendering Macros in Java Overview • XWiki Platform Modules Overview • Translation Macro • Localization Module • Customize the Keyboard Shortcuts • Admin Guide • App Within Minutes Application CKEditor Configuration
CKEditor is the new XWiki Standard default Wysiwyg editor, which is why starting with version 8.4 we have added a dedicated configuration page to the wiki preferences.
To access it, click the button which opens the drawer menu, then on "Administer Wiki".
Next, click on "Editing" -> "WYSIWYG Editor" in the accordion menu to the left
Page 290 XWiki Standard 9.8.1 Administrator Guide
The "Disabled Plugins" and "Disabled Toolbar Features" filter drop-down boxes allow to activate or deactivate specific functionalities in the editor toolbar. Details about all of them are available in the "CKEditor" documentation listed below "Related Pages".
Page 291 XWiki Standard 9.8.1 Administrator Guide
The "Link:Show Advanced Tab" and "Link:Show Target Tab" enable the display of the "Advanced" and "Target" tabs in the "Link" dialog box in order to: • set the link attributes like: Id, Name, Advisory Title, Style, whether to force download and so on
Page 292 XWiki Standard 9.8.1 Administrator Guide
• set the link "target" attribute like opening it in a new window or in the specific frame or popup window.
Related Pages
• User Guide • Simple and Advanced Editing
Page 293 XWiki Standard 9.8.1 Administrator Guide
• Office Importer Application • Editing Modes • CK Editor • Developer Guide • Wysiwyg Module • Admin Guide • Customization Overview Customize the Search Feature • The Search Administration UI • Set the Default Search Engine • The Solr Index • Solr Search Debug Mode • Restrict the List of Wikis that are Searchable by Default The Search Administration UI
To access the Search administration UI, click the button in order to open the drawer menu, then click on "Administer Wiki".
In the wiki preferences page, click on "Search" -> "Search" in the accordion menu to the left.
Page 294 XWiki Standard 9.8.1 Administrator Guide
Set the Default Search Engine
The default XWiki search engine is Solr, but you may also pick "Database".
The Solr Index
Solr is the default XWiki Standard search engine based on Apache Solr which has its own index. The default folder that stores the Solr index is
The selected action will apply on the entire farm or on a sub-wiki of your choice.
Page 295 XWiki Standard 9.8.1 Administrator Guide
In case you wish to limit the pages that will be affected by the selected action, you can use a custom HQL or XWQL query.
After clicking on "Apply" to trigger the index, you will see a confirmation message.
The actual reading of wiki pages and their indexing is done in a safe background thread and in the "Queue Size" section you can see the number of entities that are left to be indexed, re-indexed or deleted from the index.
Solr Search Debug Mode
You can now debug the Solr search query string by adding &debug=true to the "Main.SolrSearch" URL query string. For instance, we are looking for the word "activity" in all the wiki pages. The search URL will then be like /xwiki/bin/view/Main/SolrSearch?f_type=DOCUMENT&text=activity&f_locale=en&f_locale=&r=1&debug=true and will display: • the used query parser: ExtendedDismaxQParser • the parsed query in order to see which index fields are used and what is their priority:
Page 296 XWiki Standard 9.8.1 Administrator Guide
+((objcontent_en:activ | objcontent__:activity)^0.4 | creator_display:activity^0.08 | (title_en:activ | title__:activity)^10.0 | (doccontent_en:activ |doccontent__:activity)^2.0 | attauthor_display:activity^0.016 | author_display:activity^0.08 | name:activity^10.0 | filename:activity^0.4 | (attcontent_en:activ | attcontent__:activity)^0.4 | space:activity^0.016 | (comment__:activity | comment_en:activ)^0.016 | (doccontentraw__:activity | doccontentraw_en:activ)^0.4) • the filter queries in order to know the facets that were applied and their values: {!tag=type}type:("DOCUMENT") {!tag=locale}locale:("en" OR "") • the processing time • the score for each search result and the way it was computed
Page 297 XWiki Standard 9.8.1 Administrator Guide
Page 298 XWiki Standard 9.8.1 Administrator Guide
Restrict the List of Wikis that are Searchable by Default
You can now restrict the list of wikis that are searchable by default from the main wiki by defining the following Velocity variable in a page that includes "Main.SolrSearch": #set ($wikisSearchableFromMainWiki = ["wiki1", "wiki2", "wiki3"])
Related Pages
• User Guide • Search Application • Developer Guide • Solr Schema and API • Query Module • Lucene Plugin • Admin Guide • XWiki Applications Overview • Search Suggest Sources Search Suggest Sources • Access the Search Suggest Administration • Search Suggest Engine • Edit a Search Suggest Source • Add a Search Suggest Source • Delete a Search Suggest Source Access the Search Suggest Administration
To access the search suggest UI, click the button to open the drawer menu, then click on "Administer wiki".
Page 299 XWiki Standard 9.8.1 Administrator Guide
In the wiki administration page, click on "Search" -> "Search Suggest" in the accordion menu to the left.
To disable the search suggest, choose "No" in the drop-down list then click on "Save".
Search Suggest Engine
The search suggest is using the Solr engine by default and we have created a dedicated search suggest service.
Page 300 XWiki Standard 9.8.1 Administrator Guide
By default, the search is done in: • the name of the page • the content of the page • the name of the attachment • the content of the attachment • user name • blog post • wiki Edit a Search Suggest Source
To modify a search suggest source just click on it and an edit form will open. If you choose to edit for instance "Page names", you should see the image below.
Page 301 XWiki Standard 9.8.1 Administrator Guide
Page 302 XWiki Standard 9.8.1 Administrator Guide
The form displays the suggest source information such as: • the name represented by a translation key • the search engine to use when retrieving results • the search suggest service • the query passed to the search suggest service • the maximum number of search results taken from the current source with "3" as default value • the icon used to mark the search results • whether the searched text will be highlighted in the search suggest results • whether the current suggest source is used or not; note that this option is taken into account provided the source search engine matches the search engine used by the current wiki You can now specify more advanced search parameters in the search query and they will be passed directly to the search engine. For instance, the old (title:__INPUT__* OR name:__INPUT__*) AND type:DOCUMENT query can now be written as: fq=type:DOCUMENT qf=title^2 name The main advantages are: • the query filter is the same for all search request made to the current Search Suggest source because it is cached by Solr • the ability to specify the boost for each field • if not specified, the __INPUT__ is still used by default Backwards compatibility with existing Solr Search Suggest sources is still preserved. More information about the commons query parameters are available in the "Solr Schema and API" documentation page which is listed in the "Related Pages" section. After you have made your changes, don't forget to click on the "Save" button. If on the contrary you don't need to edit the suggest source anymore, click on its name to collapse the form. Add a Search Suggest Source
To add a search suggest source, click on the "Add a new source" link which will open the creation form. Supposing that you want to search in the page title but without displaying the results from the spaces "Admin", "XWiki" or from any space beginning with "Doc" and "Lib", the form would look like in the image below:
Page 303 XWiki Standard 9.8.1 Administrator Guide
Page 304 XWiki Standard 9.8.1 Administrator Guide
Click on "Save" after you are done, refresh the page and the new source will be displayed in the "Solr" tab.
If you then search for any term, you will see the new "Page Title" section in the suggestion box.
Page 305 XWiki Standard 9.8.1 Administrator Guide
Delete a Search Suggest Source
To delete a search suggest source, just hover it, click in the red "X" icon
Page 306 XWiki Standard 9.8.1 Administrator Guide
and confirm.
Related Pages
• User Guide • Search Application • Developer Guide • Solr Schema and API • Lucene Plugin • Admin Guide • XWiki Applications Overview • Customize the Search Feature
Page 307 XWiki Standard 9.8.1 Administrator Guide
Enable / Disable the Message Stream
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 currently disabled by default in order to avoid cluttering the UI by default, considering that not all users would need the feature.
To enable the message stream, click the button which opens the drawer menu, then click on "Administer Wiki".
In the wiki preferences page, click on "Other" -> "Message Stream" in the accordion menu to the left.
Page 308 XWiki Standard 9.8.1 Administrator Guide
In the "Message Stream" administration page, select "Yes" from the drop-down list, then click on "Save".
Related Pages
• User Guide • User Status • Dashboard Application • Activity Stream • Admin Guide • Users and Groups Overview Activate and Configure Google Analytics
Wiki administrators use the Google Analytics (GA) service in order to get detailed statistics about the visitors. XWiki Standard provides a dedicated section in the wiki preferences page for activating the Google Analytics tracking.
To enable Google Analytics, click the button to open the drawer menu, then click the "Administer Wiki" link.
Page 309 XWiki Standard 9.8.1 Administrator Guide
Next, in the administration page, click on "Other" -> "Google Analytics" in the accordion menu to the left.
XWiki Standard allows you to define different tracking accounts for each wiki and to use more than one tracking account per wiki. All you need to do is to enter your Google Analytics account in the "Account" text area and to click on "Save". The account format is UA-xxxxxxx-x. It is also possible to enter several GA accounts separated by a space.
Page 310 XWiki Standard 9.8.1 Administrator Guide
Moreover, you can set the tracking method you chose when creating the Google Analytics account: Universal or Classic.
Related Pages
• Developer Guide • The "xwikistatsvisit" Table • The "xwikistatsreferer" Table • The "xwikistatsdoc" Table • Admin Guide • XWiki Statistics Application • Customization Overview XWiki Setup Overview
If you are a first time XWiki user we recommend that you use the installer to get up to speed quickly. Once you get more familiar with XWiki you might want to set it up on your own database or in your own container, in which case you will need to download the WAR file and set it up and use the XAR file to load a default set of pages. The standalone package provided by the installer includes a Jetty container and an HSQLDB database all set up. However, it is not supposed to be used in production, since the embedded database does not support large wikis efficiently.
Page 311 XWiki Standard 9.8.1 Administrator Guide
FAQ XWiki Setup and Upgrade
Where do I find the standalone distribution in order to get more familiar with XWiki? Where do I find the XWiki production installs? What servlet containers can XWiki use? What relational databases can XWiki use? What is Distribution Wizard and how can I use it to upgrade my wiki? What should I backup before an upgrade? How do I upgrade the XWiki WAR? How do I upgrade a wiki using a recorded file? How do I configure the MySQL? How do I login in case access right get messed up and my admin account doesn't work any more? Where do I find the older versions of XWiki? Wiki Management
How do I create a wiki template? How do I create a wiki from a template? How do I access the wiki directory? How do I edit the wiki parameters? How do I create a wiki template? How do I delete a sub-wiki? How do I configure an access policy for my wiki? Distribution Wizard • Clean Install • Step 1 - Register the Administrator User • Step 2 - Install the User Interface • Farm Upgrade • Install the User Interface • Merge Conflict • Upgrade Extensions • Report Step • Upgrade Sub-Wikis • Upgrade a Sub-Wiki Using a Recorded Actions File XWiki Standard comes with the "Distribution Wizard" feature, which is triggered when you first access a wiki page in view mode after an upgrade or a new XWiki Standard installation. In order for the Distribution Wizard to be triggered, you have to log in as administrator. The installation guide has 3 steps: • the "Admin User" step allows to register your user as the wiki owner. • the "Flavor" step allows installing the default set of wiki pages recommended for the current version of the XWiki runtime. • the "Extensions" step handles the update of the already installed extensions.
When performing an upgrade, you can either trigger Distribution Wizard from the main wiki and upgrade all the farm or you can trigger it separately from each sub-wiki. In the case of a clean install, when you first access any wiki page and log in as administrator, you will see an initialization screen.
The process will take no more than a few seconds and once it reaches 100%, you will be redirected to Distribution Wizard actions menu:
Page 312 XWiki Standard 9.8.1 Administrator Guide
In case you haven't finished configuring the wiki, click on "Later" and you will be redirected to the wiki page you have accessed in the first place. The Distribution Wizard won't be triggered again unless the server is restarted. The "Later" button has an additional option, "Replay recorded actions" which allows to replay a recorded upgrade or install performed on a different wiki. Please refer to the Upgrade a Sub-Wiki Using a Recorded Actions File section for more details. Clicking on "Never" means you will be redirected to the wiki page you have accessed in the first place and the Distribution Wizard won't be triggered again unless you change your distribution. This is usually recommended when you plan to do a manual install. Click on "Continue" in order to get to the first step of the process. Clean Install Step 1 - Register the Administrator User
This step is displayed only for the WAR distribution and allows you to register your own user as the owner, meaning that you won't ever lose administration rights for that user, unless you change the owner. The reason is to avoid security issues because in older XWiki version we used to have a hardcoded Admin user with the password admin and administrators had to change it explicitly or they would risk anyone being able to connect to their instance. Note that the main wiki owner now has Programming Rights by default, not only Administration Rights.
Page 313 XWiki Standard 9.8.1 Administrator Guide
Click on "Register and Login" to create the administrator user, then on "Continue" to begin installing the new wiki.
The "Admin user" step is skipped when upgrading your XWiki instance. Step 2 - Install the User Interface
A flavor is a predefined collection of applications for specific use cases. By default, you will be prompted with 2 standard flavors: • the "XWiki Standard Flavor" - a default set of wiki pages containing both content and applications for the Main Wiki • the "Demo Flavor" for demonstrating XWiki and featuring several recommended Extensions installed by default
Page 314 XWiki Standard 9.8.1 Administrator Guide
By clicking on the name of the extension, you are redirected to the documentation page on the xwiki.org Extensions repository. Supposing you wish to install "XWiki Standard Flavor", select it from the list and click on "Install this flavor". If you then click on "Show Details", then on the "Stable Versions" link in the "Description" tab, you will be able to access all the previously released versions with links to the repository where each one is stored. Also, the "Sources" link points to the xwiki-platform-distribution-flavor-mainwiki source code on GitHub. Finally, the "Issues" link points to the list of known JIRA issues related to the "XWIKI" (XWiki Platform) project.
Page 315 XWiki Standard 9.8.1 Administrator Guide
Should you decide to import the recommended set of wiki pages on the main wiki, click the "Install" button and the Install Plan Log will prompt you about the new extensions.
Page 316 XWiki Standard 9.8.1 Administrator Guide
Click on "Continue" to confirm and the Distribution Wizard will start resolving dependencies and install the extensions. The "Install Log" displays a detailed list of installed pages.
When the progress bar reaches 100%, go to the "Dependencies" tab to see the list of installed extensions which are marked by a green status bar then click on "Continue".
Page 317 XWiki Standard 9.8.1 Administrator Guide
Extensions are not marked as "Installed", but as "Installed as dependency". This is useful in order to distinguish between the extensions that have been installed directly (by you or a different user) and the extensions that have been installed as transitive dependencies. In case you changed your mind, you can always uninstall the extension. The wizard will prompt you with the list of extensions to be removed after which you may click on "Continue" to confirm.
Farm Upgrade Install the User Interface
Just like in the case of a clean install, after logging in as administrator, you will be redirected to Distribution Wizard actions menu with the same 3 buttons: "Continue", "Later" with the option to "Replay recorded actions" and "Never". After clicking on "Continue", then on "Show Details" and on the "Dependencies" tab, the installed applications that are incompatible with the new version of the web application are marked by a red bar. The ones marked by a yellow bar (if any) are the extensions that still work correctly with your current distribution but for which there are newer versions available.
Page 318 XWiki Standard 9.8.1 Administrator Guide
Should you decide to download the recommended set of wiki pages on the main wiki, select the "XWiki Standard Flavor" and click the "Install this flavor" button,
Page 319 XWiki Standard 9.8.1 Administrator Guide
then on "Upgrade" so that the Distribution Wizard can start resolving dependencies. All this information is displayed in the Install Plan Log.
In the "Progress" tab, installed applications that are incompatible with the new version of the WAR are marked by a red bar. The ones marked by a yellow bar are the extensions that still work correctly with your current distribution but for which there are newer versions available. Click on "Continue" to confirm and the Distribution Wizard will start computing the upgrade plan and installing the extensions.
Page 320 XWiki Standard 9.8.1 Administrator Guide
The "Install Log" displays a detailed list of installed or upgraded pages.
Page 321 XWiki Standard 9.8.1 Administrator Guide
Once the upgrade process starts, there might be some merge conflicts reported. More details are available in the next section. Finally, you can delete all the old or unused XWiki pages by selecting the "[WikiName]" case(s) and clicking on "Continue". By default, the wiki pages that have been modified are left unselected so that you won't lose your changes.
Page 322 XWiki Standard 9.8.1 Administrator Guide
When the progress bar has reached 100%, go to the "Dependencies" tab to see the list of installed extensions which are marked by a green status bar then click on "Continue".
Merge Conflict
The Distribution Wizard compares the original UI package with the current UI in the wiki, as well as the changes introduced between the original UI package and the new UI package and tries to merge those changes to produce a resulting document. Unless a conflicting change is found, these operations are done transparently.
Page 323 XWiki Standard 9.8.1 Administrator Guide
Some changes that could trigger a conflict include: • A new document has been added to the wiki which is also a part of the new UI • A new feature or an improvement has been added to the wiki • The document is a configuration document part of the UI, the default configuration has been changed in the wiki and the new UI has new default value for the same settings • The access right of a document from the UI has been changed in the wiki and the new UI has different default rights for the same document When a conflict occurs, the Distribution Wizard provides 3 possible actions: • install the merged version • install the new version of the document which means the previous changes will be discarded • keep the current version
Page 324 XWiki Standard 9.8.1 Administrator Guide
To help you choose, Distribution Wizard provides a diff for: • the previous version which is in fact the original version of the document in the old UI package • the current version of the document in the wiki • the new version of the document in the new UI package • the merged version - the version computed by the Distribution Wizard, containing a merge of local changes and the new UI changes
The "Summary" displays the type of entity that was modified - "Object", "Page property" (content, default language etc.) 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.
Page 325 XWiki Standard 9.8.1 Administrator Guide
Page 326 XWiki Standard 9.8.1 Administrator Guide
It is possible for the Distribution Wizard to not display the original version of the document. This usually happens when: • the document is new in the new version UI but it also exists locally in the wiki • the package of the original UI has not been repaired properly Also, it might happen that Distribution Wizard detects conflicts on user and group documents. In these cases, it is recommended to keep the current version, even when the diff does not show any change. As a general rule, when resolving a conflict: • XWiki class changes should always be installed • Group and User documents should always be preserved The Distribution Wizard has an additional option, "Resolve automatically", which allows you to resolve all the remaining merge conflicts automatically by choosing the same option as the one you select in the "Merge Conflict" drop-down list. Upgrade Extensions
In order to upgrade extensions, the steps to follow are the same as for the Extension Updater feature of the Extension Manager application.
The icons displayed next to each link are meant to differentiate external URLs from internal links. To begin looking for newer extension versions, click on "Check for updates" or on "Check for updates on farm".
The installed extensions are grouped in two categories: • the "Invalid Extensions" are incompatible with your current distribution and they have compatible new versions; these ones require an upgrade or a downgrade and are marked by a red status bar
Page 327 XWiki Standard 9.8.1 Administrator Guide
• the "Outdated Extensions" still work with your current distribution but there are newer versions available; these ones are marked by a yellow status bar
To upgrade an extension, click on the corresponding "Upgrade" or "Upgrade on Farm" button and follow the on-screen instructions. In case the displayed information is outdated, just click again on "Check for updates" or on "Check for updates on farm".
Page 328 XWiki Standard 9.8.1 Administrator Guide
Report Step
XWiki has introduced a new last step in which the Distribution Wizard displays all the changes made to the wiki(s) so that you can perform rollbacks.
Page 329 XWiki Standard 9.8.1 Administrator Guide
Page 330 XWiki Standard 9.8.1 Administrator Guide
For each sub-wiki, the new pages are marked by the icon and the upgraded ones are marked by the icon.
The available user options are: • delete a new page by clicking the icon • delete an upgraded page by clicking the icon or undo the changes by clicking the icon
Upgrade Sub-Wikis
To upgrade a sub-wiki, login with an administrator account and access any sub-wiki page - similarly to the main wiki, the Distribution Wizard is launched. In order to complete the process, you will have to go through 2 steps: • the "Flavor" step allows installing the default set of wiki pages recommended for the current version of the XWiki runtime. • the "Extensions" step handles the update of the already installed extensions.
You now have 2 options: upgrade by clicking on "Continue" or simply replay a recorded plan in order to save time. For the first case, select "XWiki Standard Flavor - Sub Wiki" in the "Flavor" screen and click on "Install this flavor",
Page 331 XWiki Standard 9.8.1 Administrator Guide
then on "Upgrade" so that the Distribution Wizard starts computing the upgrade plan.
Page 332 XWiki Standard 9.8.1 Administrator Guide
Next, click on "Continue" to confirm and you will notice that just like for the main wiki, previous extensions that are incompatible with your current distribution are marked by a red bar because they require an immediate upgrade, while the ones that are still compatible are marked by a yellow bar.
You might be prompted to delete all the old or unused XWiki pages (if there are any) by selecting the "Wiki Name" case and clicking on "Continue". By default, the wiki pages that have been modified are left unselected so that you won't lose your changes.
Page 333 XWiki Standard 9.8.1 Administrator Guide
Once the progress bar has reached 100%, go to the "Dependencies" tab and you will see 2 installed dependency extensions marked by a gray status bar: • XWiki Platform - Distribution - Flavor - Common • Wiki Application for subwikis
The process is similar for the remaining sub-wikis. Upgrade a Sub-Wiki Using a Recorded Actions File
To upgrade a sub-wiki by applying the same decisions as for another previously upgraded wiki, access its home page with an administrator account which will launch the Distribution Wizard, click on "Later", then on "Replay recorded actions" in order to be redirected to the wiki's XWiki.ExtensionHistory page.
Page 334 XWiki Standard 9.8.1 Administrator Guide
In this case, there are no history records for the current sub-wiki,
but Administrators can use the one from the main wiki by clicking on "Showing records from Local History" and uploading the corresponding XML file from your computer. The process of generating it is detailed in the Extension Manager documentation. Next, select the uploaded file and click on "Replay".
Under "Replay Options" you have the possibility to replay the imported records using the wiki's original users, rather than the current user by selecting the "Preserve the users" option.
Page 335 XWiki Standard 9.8.1 Administrator Guide
By default, the "Namespaces" input only contains the domain name of the current wiki, but you can replay the record on multiple wikis at the same time, provided you have Programming Rights. In case there are merge conflicts that don't have an answer in the recorded history file, then you will be prompted to answer them.
Click on "Continue", then on "Start" to confirm the upgrade by installing the "XWiki Standard Flavor - Sub Wiki" extension.
Details about the installed or modified extensions are available in the Replay Log.
Page 336 XWiki Standard 9.8.1 Administrator Guide
Once the progress bar has reached 100%, refresh the wiki's home page and you may start using the new version.
Related Pages
• Developer Guide • Skins Extensions • Extension Module • Admin Guide • XWiki Standard Installation and Upgrade • XWiki Setup Overview • Extension Manager Application XWiki Standard Installation and Upgrade • Download and Install Java • The XWiki Standalone Distribution • Change the Jetty Port • Install XWiki Without Internet Connection • Production Installs • Deploy the XWiki Standard WAR • Install and Configure a Servlet Container • Install and Configure a Relational Database • Installation of the default UI using the Distribution Wizard • Manually Import the Default XWiki XAR • Configure Multi-Wiki URL Access and Descriptors • Running Multiple Instances of XWiki in the Same Container • Running XWiki Behind a Proxy • Upgrade the Main Wiki • Backup the Existing Data • Upgrade the Web Application • Restore the Databases • Upgrade the XWiki XAR • Upgrade the Sub-Wikis XAR • Enable the superadmin Account • Download Older Versions of Our Products
Page 337 XWiki Standard 9.8.1 Administrator Guide
Download and Install Java
Starting with version 8.0, we are using Java 1.8 that can be downloaded from the Java website. If you use an earlier version of Java, you will get an error while starting XWiki: java.lang.reflect.InvocationTargetException [...] Caused by: java.lang.UnsupportedClassVersionError: org/xwiki/tools/jetty/listener/NotifyListener : Unsupported major.minor version 52.0 [...] The XWiki Standalone Distribution
The standalone installation includes an already configured Jetty container and an HSQLDB database. To install it, you just need to unpack the file xwiki-
If you already have a Web server running on port 8080, you need to set another port in the start script. This can be done by editing the file start_xwiki.sh (or start_xwiki.bat for Windows systems) and by modifying the value of the "JETTY_PORT" parameter. You can do the same thing directly in the command line by executing ./start_xwiki.sh ##port_number## Install XWiki Without Internet Connection
Starting with version 9.5, a XIP package is available for the XWiki Standard flavor that you can download from here. This is actually a zip file containing the required XWiki extensions in the same format than the local extensions repository. In order to use it: • unzip the file (in case the file extension is not recognized, you might have to rename it to .zip) in the folder
To install the XWiki Standard WAR, you need to get the latest xwiki-
XWiki Standard is able to work with any servlet container. You can consult the installation and configuration instructions are available for: • Tomcat • Jetty • GlassFish • WebSphere • JBoss • Oracle OC4J • Apache Geronimo
Page 338 XWiki Standard 9.8.1 Administrator Guide
If you are using Tomcat, you need to make sure you set the UTF-8 encoding for URLs. To do so, edit your "conf/server.xml" file and add URIEncoding="UTF-8 to the the HTTP connector listening to the port "8080" (or the one you are using):
During first startup, the database being empty, you will be directed to the second step for proceeding to the installation of the default UI. The appropriate UI package will be pre-selected and proposed for installation. During the installation, you will be prompted to register your own user as the owner, meaning that you won't ever lose administration rights for that user, unless you
Page 339 XWiki Standard 9.8.1 Administrator Guide change the owner. The reason is to avoid security issues because in older XE version we used to have a hardcoded Admin user with the password admin and administrators had to change it explicitly or they would risk anyone being able to connect to their instance. Note that the main wiki owner now has Programming Rights by default, not only Administration Rights. Proceeding with the Distribution Wizard requires a connection to the Internet from the server. If your server is disconnected from the Internet, you may skip the Distribution Wizard and proceed to the manual installation of the Default XWiki XAR. The XWiki Standard XAR does not contain any descriptor for the main wiki anymore. This descriptor is now automatically created/updated at startup and associated to the domain name found in the URL that was used to access the wiki the first time. Finally, starting with version 8.4, sub-wikis have asynchronous initialization which reduces the chance that one or several initializing wikis end up eating all the farm input threads.
Manually Import the Default XWiki XAR
You need this step only if you were unable to use the Distribution Wizard to install the default UI. The xwiki-platform-distribution-flavor-mainwiki-9.8.1.xar file available here contains a set of default XWiki pages which you can import in an empty XWiki instance. For sub-wikis, the xwiki-platform- distribution-flavor-wiki-9.8.1.xar should be used, and it is available here Configure Multi-Wiki URL Access and Descriptors
The URL Path Based Access This mode is enabled by default so you can access sub-wikis using an URL like http://hostname.domain.tld/xwiki/ wiki/WikiAlias/view/Space/Page. The /wiki/ part is used by XWiki to identify the URL as an URL path based multi-wiki access. This part is configurable through the property xwiki.virtual.usepath.servletpath from the xwiki.cfg file. In path based mode you can manage your wiki descriptor from the wiki administration, and there is no need to manage any special wiki aliases. The Domain Name Based Access This mode is disabled by default. To enable it, set the xwiki.virtual.usepath parameter to 0 in the "xwiki.cfg" file. You also need to configure your DNS with a wildcard CNAME that redirect *.domain.tld (or *.hostname.domain.tld depending on your use case) to hostname.domain.tld. The goal being that reaching the XWiki server could be achieved with hostname like: wikiname.domain.tld (or wikiname.hostname.domain.tld). If you are using SSL, your SSL certificate should also support wildcard names which is generally a paid option. You may also define additional unrelated DNS CNAME entries for the wikis, but this method will not allow dynamic creation of new wikis without a system administrator intervention on the DNS.
In domain based mode, you can access a wiki using the domain name (or the alias) registered in its descriptor with the field server ("Alias" in the UI). For example, if the URL is http://hostname.domain.tld, the value of the server field should be "hostname.domain.tld". You currently cannot manage this information from the wiki administration, but you can edit it from the Wiki index, using the edit action (you need to be an administrator to see this action).
When no matching alias is found: • if the host is an IP address (127.0.0.1, 85.65.12.36, etc.), XWiki selects the main wiki • else, if the first part of the host name is "www", XWiki selects the main wiki • else, if the first part of the host name matches a wiki identifier, XWiki selects this wiki If no wiki is found, by default, the main wiki is displayed. If you want an error to be displayed, you can configure xwiki.virtual.failOnWikiDoesNotExist to 1 in xwiki.cfg to have the wikidoesnotexist.vm template or xwiki:XWiki.WikiDoesNotExist page displayed. The old xwiki.virtual.redirect configuration is not supported anymore. So, to be able to access your wiki you may need :
Page 340 XWiki Standard 9.8.1 Administrator Guide
• to ensure xwiki.virtual.failOnWikiDoesNotExist is 0 or not defined OR • to configure your DNS OR • to modify the hosts file in your operating system. Note that you have to set the xwiki.authentication.logoutpage property accordingly. Modify the "wiki" part inside the value of the property for the right alias. Running Multiple Instances of XWiki in the Same Container
In case you have several instances of XWiki Standard in the "webapps" folder of Tomcat (or any other servlet container from this list), you need to edit the WEB-INF/cache/infinispan/config.xml file. Next, for each instance of XWiki, you have to change the jmxDomain value under the globalJmxStatistics tag so that each web application has a unique name. The default value is org.xwiki.infinispan:
Distribution Wizard and the Extension Manager require an Internet connection for searching and downloading extensions. In case your XWiki Standard instance works in a network that is accessing the internet through a proxy-server, the search results will come up empty and you will get "Connection Refused Exception" in the log files. To fix this, you must set up XWiki to know your proxy-server using "Apache httpclient" which is the default Java proxy configuration. For Linux systems, modify the "/
In order to avoid having post upgrade issues it is essential that you backup your wiki. Backup the Databases In case you have installed and configured a relational database it is recommended that you create a copy before upgrading. To do this execute mysqldump --add-drop-database --databases xwiki > xwiki.sql for MySQL. If you have also subwikis, you need to add their names next to xwiki in the above command to include them in the backup. Backup the Installed Extensions The extensions installed by the Distribution Wizard or by the Extension Manager are cached in the extensions folder of the permanent directory set for the servlet container. Backup the Attachments
Page 341 XWiki Standard 9.8.1 Administrator Guide
If you are storing attachments on the filesystem you will also have to make a copy of the storage folder in the permanent directory set for the servlet container. The default value is defined by the environment.permanentDirectory property of your WEB-INF/xwiki.properties configuration file. Backup the SOLR Index Folder If you are using SOLR as default search engine you need to locate the SOLR index folder which is environment.permanentDirectory/solr. Since the Solr configuration is stored on the filesystem in the environment.permanentDirectory/solr folder, it is recommended that you delete the entire folder before the upgrade. The reason for this is the fact that the Solr configuration might change between releases and by deleting the folder it will be recreated with the new configuration.
Backup the Configuration Files
In addition to the drivers and plugins you might have installed in your wiki, you also need a backup of several configuration files: • the Hibernate configuration file WEB-INF/hibernate.cfg.xml • the old XWiki Standard configuration file WEB-INF/xwiki.cfg • the new XWiki Standard configuration file WEB-INF/xwiki.properties • the Logging configuration file WEB-INF/classes/logback.xml • the WEB-INF/cache/infinispan/config.xml file that stores the unique value of jmxDomain; you should only backup this file when you have multiple XWiki instances in the same servlet container These files should be merged with the new versions. Backup the Skin Folder If you have a custom skin that is stored on the filesystem, make sure you backup the corresponding folder located in the webapps/xwiki/skins/ directory. Upgrade the Web Application
The recommended strategy is to stop the servlet container, download the xwiki-platform-distribution- war-9.8.1.war file you want to upgrade to then expand it. It is important not to copy the new files on top of the old ones because XWiki Standard would fail due to the old JARs that still remain in the /WEB-INF/lib/ folder. Next, check that the WEB-INF/xwiki.cfg file is properly configured for a migration as shown below: #-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to #-# disable them in production. xwiki.store.migration=1 #-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going #-# live afterwards. # xwiki.store.migration.exitAfterEnd=0 #-# Indicate the list of databases to migrate. #-# to upgrade all wikis database set xwiki.store.migration.databases=all #-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2 #-# Note: the main wiki is always migrated whatever the configuration. # xwiki.store.migration.databases=
You should also check the Release Notes for all the versions from the version you are upgrading from up to the new version you are installing in order to find out about the new features or configuration changes. Restore the Databases
The main steps to follow when restoring the MySQL database are: • Stop the servlet container • Restore the data from the dump with mysql xwiki --user=root -p < xwiki.sql • Start the servlet container More information regarding the restore process is available on xwiki.org. Upgrade the XWiki XAR
After restarting the servlet container, if you access any wiki page and log in, the Distribution Wizard will be triggered in order to help you perform the XAR upgrade. The pages that you have already modified will be automatically handled thanks to the merge conflict resolution feature.
Page 342 XWiki Standard 9.8.1 Administrator Guide
Upgrade the Sub-Wikis XAR
The easiest way is to let the Distribution Wizard handle the XAR upgrade for sub-wikis during the third step of the process. This way, the pages that you have already modified will be automatically handled thanks to the merge conflict resolution feature. Enable the superadmin Account
In case access rights get corrupted and you cannot authenticate with your wiki administrator user, you may choose to enable the superadmin account as follows: • edit the "WEB-INF/xwiki.cfg" file • uncomment the line # xwiki.superadminpassword=system • restart XWiki • login with the user superadmin and the password indicated by the xwiki.superadminpassword configuration parameter Download Older Versions of Our Products
If you are interested in some older versions of the XWiki products you can check this page.
Related Pages
• User Guide • XWiki Login • User Preferences • Developer Guide • XWiki Database Schema • Admin Guide • XWiki Setup Overview • MySQL Installation and Configuration • Distribution Wizard • Admin Tools Application MySQL Installation and Configuration • Start the MySQL Server • Check the MySQL Server • Create the "xwiki" Database • Display All Databases • Give Privileges to the "xwiki" User • Create a Password For the "root" Admin Account • Change or Update the "root" Password • Create the Database Indexes • Increase the "max_allowed_packet" Value • See What Values the MySQL Server is Running • Stop the MySQL Server MySQL is available at this website. Start the MySQL Server
On a Linux machine: If you are running MySQL as a service: sudo service mysql start If you are not running MySQL as a service: sudo /etc/init.d/mysqld start On a Windows machine: If you are running MySQL Server as a service: >net start mysql
Page 343 XWiki Standard 9.8.1 Administrator Guide
If you are not running MySQL as a service, you should execute the following command to start MySQL as a standalone console application:
>mysqld --console Check the MySQL Server
After installing MySQL, you will have to execute the following command in order to check if the MySQL server is properly started and listening for connections: For a Linux system: $ sudo netstat -tap | grep mysql You should get something similar to: tcp 0 0 localhost:mysql *:* LISTEN 2798/mysqld For a Windows system, you have to open the Command prompt as Administrator and run: >mysqladmin -u root version You should get something similar to: Server version 5.5.x Protocol version 10 Connection localhost via TCP/IP TCP port 3306 Uptime 2 hours 30 min Create the "xwiki" Database
In order to create the "xwiki" database with the UTF-8 binary encoding, you have to run: >mysql -u root -e "create database xwiki default character set utf8_bin" You can choose another name for your database but you will have to modify the xwiki.db parameter in the xwiki.cfg file. Display All Databases
To display all databases, you have to access the MySQL prompt: On a Linux system: mysql --user=root mysql show databases; On Windows: >mysql -u root mysql>show databases; Give Privileges to the "xwiki" User
To be able to create new wikis, the MySQL user will need to have all the privileges on the database granted. You can use any username, but make sure you update the connection.username property in the hibernate.cfg.xml file. In the following example, the username is xwiki. The command will automatically create the xwiki user in the MySQL database: >mysql -u root -e "grant all privileges on *.* to xwiki@localhost identified by 'xwiki'" Create a Password For the "root" Admin Account >mysqladmin -u root password //yourpassword// Change or Update the "root" Password $ mysqladmin -u root -p'oldpassword' password 'newpassword' Create the Database Indexes
Since XWiki does not automatically create database indexes, you can use the "Admin Tools" extension available here. Increase the "max_allowed_packet" Value
By default, the value of the "max_allowed_packet" parameter is 1M. In order to increase it, you have to start the server with:
Page 344 XWiki Standard 9.8.1 Administrator Guide
On a Linux system: mysql --max_allowed_packet=32M On Windows: >mysqld --max_allowed_packet=32M The new value can be checked by opening the MySQL prompt and by running: mysql>show variables like 'max%'; You can also set this parameter by editing the my.ini file for Windows, or the /etc/my.cnf file for Linux. If this parameter is not specified, you can manually add it in the [mysqld] section. See What Values the MySQL Server is Running
On Linux: >mysql --user=root mysql mysql>show variables; On Windows: >mysqladmin -u root variables Stop the MySQL Server
On a Linux machine: If you are running MySQL as a service: sudo service mysql stop If you are not running MySQL as a service: sudo /etc/init.d/mysqld stop On a Windows machine: If you are running MySQL Server as a service: >net stop mysql If you are not running MySQL Server as a service: >mysqladmin -u root -p shutdown
Related Pages
• Developer Guide • XWiki Database Schema • Admin Guide • XWiki Standard Installation and Upgrade • XWiki Setup Overview • Admin Tools Application Create a Sub-Wiki • The Right to Create Wikis • Create a Sub-Wiki • Create a Wiki Template • Create a Sub-Wiki from a Template / Flavor The Right to Create Wikis
Any main wiki user can create wikis, provided he/she has the "createwiki" right which can only be granted via the main wiki.
To do so, click the button which opens the drawer menu, then on "Administer Wiki".
Page 345 XWiki Standard 9.8.1 Administrator Guide
Next, in the preferences page, click on "Wikis" -> "Creation Right" in the accordion menu to the left
which will bring an overview of the global groups rights.
Page 346 XWiki Standard 9.8.1 Administrator Guide
Click once on a check-box to allow a right, twice to deny it and three times to clear it. Note that access rights are saved automatically. Create a Sub-Wiki
To create a sub-wiki, you must first access the Wiki Directory - start by clicking the button to open the drawer menu, then on "Wiki Index"
Page 347 XWiki Standard 9.8.1 Administrator Guide
and finally, on "+ Create Wiki".
Page 348 XWiki Standard 9.8.1 Administrator Guide
You will be redirected to the first step of the new wiki creation wizard allowing you to define: • the wiki identifier which corresponds to the database name in the database engine; the wiki identifier is also used to generate the wiki descriptor page which is stored in the main wiki • the wiki pretty name which represents the display name • the wiki template to use or whether the wiki is going to be used as template • a short description of the wiki purpose Create a Wiki Template
A template is a wiki that will be considered as a model to create new wikis. When a user selects a template to create a new wiki, all the content of the template is copied to the new wiki. Supposing you already have the right to create a wiki, the next thing to consider is whether there are wiki templates available. The list of existing wiki templates (if any) is available in the main wiki administration page by clicking on "Wikis" -> "Wiki Templates" in the accordion menu.
Page 349 XWiki Standard 9.8.1 Administrator Guide
In the first step of the wiki creation wizard, click the "Template" tab and make sure to check the option "This wiki will be a template".
In case you have enabled the domain name based access, the wizard will display a dedicated field so that you can enter the new wiki alias.
Page 350 XWiki Standard 9.8.1 Administrator Guide
After filling in the required fields, click on "Go to the Next Step" in which you will get to choose the wiki owner, the scope and the membership type.
The default owner is the current global user so, if you wish to delete the entry, hover the user name and click on the red "X" in the top right corner.
Page 351 XWiki Standard 9.8.1 Administrator Guide
To add the new owner, enter the first characters of the username and the suggest feature will help you by displaying the occurrences.
The same principle applies for the sub-wiki "Members". The dedicated input has improved allowing you to add multiple users at once.
Page 352 XWiki Standard 9.8.1 Administrator Guide
To remove a member, hover the corresponding user name and click on the red "X" in the top right corner. In case you want to remove all the members at once, click on "Clear selection". Each type of membership defines a different kind of sub-wiki: • any user can join the wiki (an open wiki) • any global user can make a join request, but an administrator has to accept it (a join-by-request wiki) • only the administrator can make invitations (an invitation-only wiki) Also, there are 3 possible user scopes which will tell you the type of users that will have access to the sub-wiki: • only global users (main wiki users) • only local users (users that will be created locally on the sub-wiki) • both local and global users After filling in the required fields, click on "Create" and the system will start provisioning the wiki, which means allocating memory and creating the database. The wiki creation process is not handled by the Distribution Wizard anymore - instead, it has been moved to a job and during the installation, you are informed in real time about each installed extension through a detailed install plan log.
When the progress bar reaches 100%, XWiki will display a success message: click on "Go to the wiki" to finish the installation and access the new sub-wiki home page.
Page 353 XWiki Standard 9.8.1 Administrator Guide
In the "Wiki Information" panel you will see a welcome message with the name and description of the wiki and also with information about the owner. The panel is not displayed by default, you can use the Panel List for this purpose.
Create a Sub-Wiki from a Template / Flavor
After creating a default wiki template, it is time to create a sub-wiki that will use it. To do so, during the first step of the wiki creation wizard, click the "Template" tab and select "Template Wiki".
Page 354 XWiki Standard 9.8.1 Administrator Guide
On the other hand, if you go to the "Flavor" tab an choose the "XWiki Standard Flavor - Sub Wiki" option you will obtain a sub-wiki containing a copy of the XWiki Standard pages and applications for sub-wikis. Additionally, you may create an empty wiki.
After choosing the user scope, the membership type and the initial members, click on "Create".
Page 355 XWiki Standard 9.8.1 Administrator Guide
Just like in the previous case, the system will start allocating memory for the new wiki and create the associated database.
Next, click on "Go to the wiki" to perform the last step of the process
Page 356 XWiki Standard 9.8.1 Administrator Guide and to be redirected to the new sub-wiki home page. In case the process fails, there will be an explanatory error message displayed and a button for cleaning and deleting the wiki.
Related Pages
• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Developer Guide • Security Module • Admin Guide • XWiki Setup Overview • XWiki Applications Overview • Wiki Directory • Set the Wiki Access Rights • Set the Users Access Rights • Set the Page Access Rights • Set the Group Access Rights • Rights Overview • Permission Types • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Delete a Sub-Wiki • Customize the User Registration Process • Customization Overview • Configure Annotations • Admin Tools Application Wiki Directory
To access the Wiki Directory, click the button to open the drawer menu, then on "Wiki Index".
Page 357 XWiki Standard 9.8.1 Administrator Guide
If you are an administrator or the wiki owner, you will see a "Delete" link in the "Actions" column. If you are a member with no privileges, but you have view rights on the wiki, you will only see the "Leave", "Join" or "Request Join" actions, depending on the membership.
Page 358 XWiki Standard 9.8.1 Administrator Guide
The Wiki Index only displays the wikis that the current user is able to access, either because he/she has view rights or the wiki is open or open-by-request. Private wikis, i.e. invitation-only wikis, on which the current user doesn't have view rights won't be displayed anymore. Regarding guest users, they will be able to see the Wiki Directory only provided they have view rights on the main wiki.
Related Pages
• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Admin Guide • XWiki Setup Overview • XWiki Applications Overview • 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 • Configure Annotations
Page 359 XWiki Standard 9.8.1 Administrator Guide
Edit the Sub-Wiki Settings • Edit the Wiki Descriptor • Edit the Wiki Owner • Wiki Aliases • Access the Wiki Descriptor from the Preferences Page • Additional Configurations In order to have the necessary privileges to administer a sub-wiki, you need to either be its owner or an administrator. Edit the Wiki Descriptor
You can customize most of a sub-wiki properties from its descriptor page: • pretty name • owner • home page • whether the wiki is used as template for other wikis • whether the generated external URLs are using the HTTPS protocol Moreover, the descriptor page can be used to create, edit and remove sub-wiki aliases. All sub-wiki descriptors are stored in the main wiki and can be accessed from the Wiki Directory by clicking the corresponding "Edit" link in the "Actions" column.
Next, edit the page in "Inline" mode and start making changes.
Page 360 XWiki Standard 9.8.1 Administrator Guide
Edit the Wiki Owner
The owner is a global user that he has all the privileges granted on the sub-wiki. To delete the entry, edit the descriptor page in "Inline" mode, hover the user name and click on the red "X" in the top right corner.
Page 361 XWiki Standard 9.8.1 Administrator Guide
To add the new owner, enter the first characters of the username and the suggest feature will help you by displaying the occurrences.
A sub-wiki cannot have multiple owners but it does support multiple administrators. Both the owner and the administrators can edit or delete the sub-wiki or manage its members. Wiki Aliases
A wiki can have several aliases apart from the primary one which can only be edited, but never deleted because it holds the descriptor. To add an alias, go to the descriptor page, locate the "Create a New Alias" section, enter the name of the new alias and click on "Create".
Page 362 XWiki Standard 9.8.1 Administrator Guide
The new alias will be displayed in the "View Aliases" section. To remove the alias, click the "Delete" button.
To add a description or to change the home page, just edit the descriptor in "Inline" mode.
Page 363 XWiki Standard 9.8.1 Administrator Guide
Access the Wiki Descriptor from the Preferences Page
The "Descriptor" section in the wiki preferences page allows administrator users to edit the pretty name, description, home page and owner of the current wiki.
In case you want to change the wiki owner, please take into account the fact that the previous owner will lose his owner rights.
Page 364 XWiki Standard 9.8.1 Administrator Guide
Additional Configurations
Additional configurations related to membership type, user scope and members can be done from the sub-wiki administration page. To do so, click the button to open the drawer menu, then on "Administer Wiki".
In the wiki preferences page, click on "Users & Rights" -> "Users" in the accordion menu to the left. After modifying the membership type or the user scope, don't forget to click on "Save".
Page 365 XWiki Standard 9.8.1 Administrator Guide
Page 366 XWiki Standard 9.8.1 Administrator Guide
Depending on this configuration you can add, invite or accept join requests from global users as described in the dedicated documentation page.
Related Pages
• User Guide • View the List of Joined Sub-Wikis • Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Admin Guide • XWiki Setup Overview • XWiki Applications Overview • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Delete a Sub-Wiki • Customization Overview • Create a Sub-Wiki • Configure Annotations Delete a Sub-Wiki
Provided you are the owner or an administrator, you can delete a wiki from the Wiki Directory, by clicking on "Delete" in the "Actions" column.
In order to prevent accidental deletion, you will be asked to confirm the action by entering the wiki identifier. This information is stored in the "Alias" property of the wiki descriptor.
After clicking on "Delete" you will get a confirmation message.
Related Pages
• User Guide • View the List of Joined Sub-Wikis
Page 367 XWiki Standard 9.8.1 Administrator Guide
• Sub-Wiki Invitations • Leave a Sub-Wiki • Join a Sub-Wiki • Editing Modes • Admin Guide • XWiki Setup Overview • XWiki Applications Overview • Wiki Directory • Set the Wiki Access Rights • Manage the Sub-Wiki Users • Edit the Sub-Wiki Settings • Customization Overview • Create a Sub-Wiki • Configure Annotations
Page 368