Wiki source code of Configuration

Last modified by Thomas Mortagne on 2023/10/31

Hide last authors
Sorin Burjan 61.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Sorin Burjan 60.2 4
Ecaterina Moraru (Valica) 174.6 5 Once you have XWiki [[installed>>Documentation.AdminGuide.Installation.WebHome]] you'll want to configure it. Configuration can be done in 2 ways:
Vincent Massol 1.1 6
Manuel Smeria 140.2 7 * by stopping the XWiki instance and editing either the ##xwiki/WEB-INF/xwiki.cfg## file or the ##xwiki/WEB-INF/ one, and then restarting XWiki. Note that ##xwiki.cfg## was the historical file containing the configuration option but we're moving away from it and in due time all the XWiki configuration options will be found in
Marc Lijour 141.1 8 * by logging in as a user with admin rights and going to the administration page using the top level menu. You can also go directly to //{{{http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences}}}//. This allows to keep the server running while making the changes.(((
Ricardo Rodríguez 82.1 9 {{info}}
Manuel Smeria 140.2 10 * Some configurations are only accessible from the ##xwiki.cfg## and files and have no equivalent on the administration page.
11 * If you're a developer and need to understand how Configuration works in XWiki, check the [[Configuration Module Documentation>>extensions:Extension.Configuration Module]].
Ricardo Rodríguez 82.1 12 {{/info}}
Marc Lijour 141.1 13 )))You can verify some basic settings of your XWiki installation (on Tomcat, MySQL) using the [[Check Config and Indexes application>>extensions:Extension.Check Config And Indexes Application]].
Vincent Massol 1.1 14
15 There are various things you can configure:
Vincent Massol 1.12 16
Thomas Mortagne 53.1 17 = Enable superadmin account =
Vincent Massol 1.29 18
Caleb James DeLisle 51.1 19 Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example:
Vincent Massol 1.29 20
Vincent Massol 54.2 21 {{code language="none"}}
Vincent Massol 1.29 22 # Enable to allow superadmin. It is disabled by default as this could be a security breach if
23 # it were set and you forgot about it.
24 xwiki.superadminpassword=system
Caleb James DeLisle 51.1 25 {{/code}}
Vincent Massol 1.29 26
Caleb James DeLisle 51.1 27 When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property.
Vincent Massol 4.1 28
Thomas Mortagne 53.1 29 = Language settings =
Vincent Massol 12.1 30
Vincent Massol 200.1 31 To define the default language for your wiki go to the administration page, click on "Localization", locate the "Default Language" field and select the language you wish to use.
Vincent Massol 12.1 32
Thomas Mortagne 234.1 33 In addition you can configure your wiki to be multilingual. See the [[I18 user page>>Documentation.UserGuide.Features.I18N]] for more information.
Vincent Massol 12.2 34
Simon Urli 190.1 35 Last, you can also force your wiki to display only in one of the languages specified in the settings, by editing your ##WEB-INF/xwiki.cfg## file. Search for the "Internationalization" section, and you should see two commented settings that you can uncomment to fix their value (1 means true, 0 false).
Vincent Massol 43.1 36
Vincent Massol 54.2 37 {{code language="none"}}
Vincent Massol 43.1 38 #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
39 #-# allows to use the default language of the wiki when the user didn't manually choose a language.
40 # xwiki.language.preferDefault=0
Simon Urli 190.1 42 #-# Force only one of the supported languages to be accepted. Default is true.
43 # xwiki.language.forceSupported=1
Caleb James DeLisle 51.1 44 {{/code}}
Vincent Massol 43.1 45
Simon Urli 190.1 46 {{warning}}
47 Starting with XWiki {{info}}11.2RC1{{/info}} the option ##xwiki.language.forceSupported## is by default set to true. The option was by default set to false on prior versions.
48 {{/warning}}
Vincent Massol 200.1 50 == Algorithm ==
52 The algorithm to find the locale to use is the following, in this order:
Manuel Leduc 207.1 53
Vincent Massol 200.1 54 * If the wiki is not multilingual use the wiki default locale (##default_language## xproperty in ##XWikiPreferences## xobject or English if not found).
55 * If the wiki is multilingual
56 ** Try to get the locale passed in the request (looking for a ##language## query string parameter).
57 ** If the language value is ##default## use the wiki default locale. If a parameter is found sets a ##language## cookie to remember the language in use.
58 ** Try to get the locale from the ##language## cookie
59 ** If the default language is preferred (##xwiki.language.preferDefault## from ##xwiki.cfg## or ##preferDefaultLanguage## property from the space preferences (##WebPreferences## xobject) or wiki preferences (##XWikiPreferences## xobject})), and since the user didn't explicitly ask for a language already, then use the wiki default locale.
60 ** Try to use the browser's ##Accept-Language## header sent in HTTP request.
61 ** Fallback to the wiki default locale
63 In addition the ##xwiki.language.forceSupported## configuration property (editable in ##xwiki.cfg##) is enabled by default and means that if at any step above the locale found is not in the list of supported locales, then the locale is not set and the algorithm moves to the next step.
Thomas Mortagne 53.1 65 = Date format =
Jean-Vincent Drean 36.1 66
Manuel Smeria 140.2 67 To define the date format used in the interfaces, go to //Wiki -> Administer Wiki -> Localization//, locate the "Date format" field and enter the date format you wish to use. Examples:
Jean-Vincent Drean 36.1 68
Caleb James DeLisle 51.1 69 |=Format|=Result
70 |MMMM dd, HH:mm|January 27, 12:27
71 |yyyy/MM/dd, HH:mm|2009/01/27, 12:27
72 |dd/MM/yyyy, HH:mm|27/01/2009, 12:27
Jean-Vincent Drean 36.1 73
Manuel Smeria 140.2 74 [[More information about date formatting>>]].
Jean-Vincent Drean 36.2 75
Thomas Mortagne 53.1 76 = Enabling/Disabling Statistics =
Vincent Massol 1.1 77
Manuel Smeria 140.2 78 To disable [[the Statistics feature>>extensions:Extension.Statistics Application]] edit your //xwiki.cfg// file and replace the following properties as shown here (to enable statistics, change ##0## to ##1##):
Vincent Massol 1.1 79
Vincent Massol 140.1 80 {{code}}
81 xwiki.stats=0
82 xwiki.stats.default=0
83 {{/code}}
Vincent Massol 1.10 85 where:
Marc Lijour 141.1 86
Manuel Smeria 140.2 87 * ##xwiki.stats## controls whether statistics are on or off
Vincent Massol 205.3 88 * ##xwiki.stats.default## controls whether statistics are on or off by default for the current Wiki. This is useful in [[multi wiki mode>>Documentation.AdminGuide.Virtualization.WebHome]]. A wiki can decide whether statistics are on or off by setting the "statistics" field in ##XWiki.XWikiPreferences##. If no such field is defined then the default value //xwiki.stats.default// is used.(((
Vincent Massol 140.1 89 {{info}}
90 There's currently no UI to set the statistics on or off for a given subwiki. Thus at the moment you'll need to do 2 things:
Manuel Smeria 140.4 91 * Edit ##XWiki.XWikiPreferences## to add a new boolean property to the class, by going to //{{{http://localhost:8080/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class}}}//
92 * Set the ##statistics## property to true by going to //{{{http://localhost:8080/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object}}}// and setting the ##statistics## property to ##true##
Vincent Massol 140.1 93 {{/info}}
Manuel Smeria 140.4 94 )))
Marc Lijour 141.1 95
Thomas Mortagne 53.1 96 = Optional Store Features =
Artem Melentyev 12.3 97
Thomas Mortagne 53.1 98 == Document versioning ==
Sergiu Dumitriu 49.1 99
100 One of the key features of a wiki engine is the ability to keep all the history of a document, giving users the ability to see the evolution of a document, but also to revert changes. However, the history of an active wiki continuously grows and is usually much larger than the current version of the data. It is possible to disable the versioning feature in XWiki, which means that less storage space will be used, although it will not be possible to revert the document in case of vandalism.
Manuel Smeria 140.2 102 To disable versioning edit //xwiki.cfg// and add {{code}}{{/code}}.
Sergiu Dumitriu 49.1 103
Ecaterina Moraru (Valica) 174.6 104 [[Attachment versioning>>Documentation.AdminGuide.Attachments#HVersions]] is also available and turned on by default.
Sergiu Dumitriu 49.1 105
Thomas Mortagne 53.1 106 == Document recycle bin ==
Artem Melentyev 12.4 107
Manuel Smeria 140.2 108 By default deleted documents are not permanently removed, but are placed in a //recycle bin//, from which they can later be removed or restored. To disable it, edit //xwiki.cfg// and add {{code}}xwiki.recyclebin=0{{/code}}.
Sergiu Dumitriu 49.1 109
Manuel Smeria 140.2 110 {{info}}
111 Disabling the recycle bin will make it impossible to restore a deleted document, unless a database backup is available.
112 {{/info}}
Sergiu Dumitriu 49.1 113
Caleb James DeLisle 51.1 114 By default, a deleted document can be permanently deleted right away by administrators, and after 7 days by regular users. To change these limits, edit //xwiki.cfg// and add:
Sergiu Dumitriu 49.1 115
Jan-Paul Kleijn 232.1 116 {{code language="none"}}
Sergiu Dumitriu 49.1 117 # Admins must wait 3 days before being allowed to permanently delete
119 # Normal users must also wait 3 days
Caleb James DeLisle 51.1 121 {{/code}}
Sergiu Dumitriu 49.1 122
Ecaterina Moraru (Valica) 174.6 123 [[Attachment recycle bin>>Documentation.AdminGuide.Attachments#HDeletion]] is similar.
Sergiu Dumitriu 49.1 124
slauriere 186.1 125 = Customizing error pages =
Vincent Massol 187.1 127 The screen displayed to the user when an error occurs can be easily customized without modifying the skin in the following cases: when the wiki, document or attachment that is currently looked for does not exist, or when a denied access occurs. You simply need to create the following respective pages in your wiki:
slauriere 186.1 128
Vincent Massol 187.1 129 * ##XWiki.WikiDoesNotExist##,
Thomas Mortagne 234.1 130 * ##XWiki.DocumentDoesNotExist##,
Vincent Massol 187.1 131 * ##XWiki.AttachmentDoesNotExist##,
132 * ##XWiki.AccessDenied##
134 Creating these pages rather than editing the skin's velocity files will save you time during upgrades since you won't need to merge the possibly updated skin files with yours.
Thomas Mortagne 53.1 136 = Customizing the Skin =
Vincent Massol 1.3 137
Ecaterina Moraru (Valica) 174.6 138 See the [[Skin Guide>>Documentation.AdminGuide.Skins]].
Vincent Massol 1.3 139
Thomas Mortagne 53.1 140 = Security configuration =
Vincent Massol 1.3 141
Ecaterina Moraru (Valica) 174.6 142 See the [[Security Guide>>Documentation.AdminGuide.Security]].
Vincent Massol 1.3 143
Vincent Massol 213.1 144 = HTTPS/SSL =
Caleb James DeLisle 76.1 145
Vincent Massol 213.1 146 By default the protocol to use to generate external URLs (HTTPS, HTTP) is extracted from requests to XWiki so most of the time you don't have anything to do if you properly configured your proxy but it's possible to force a specific protocol using ##xwiki.url.protocol## property in //xwiki.cfg//.
148 To setup HTTPS/SSL you may need to configure your Servlet Container and any front end web server or proxy in front of XWiki. For example:
Cami Andrei 226.1 149
Vincent Massol 213.1 150 * [[Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]]
Thomas Mortagne 53.1 152 = Customizing Menus =
Vincent Massol 1.3 153
Vincent Massol 114.6 154 The first thing to understand is that menus depend on the skin you're using. If you're using the 1.0 skin it's likely you're using the [[Panels Application>>extensions:Extension.Panels Application]] to provide the different menu panels you see on the left or right of your wikis. Check the [[Panels Application>>extensions:Extension.Panels Application]] to know more on how to configure/modify them.
Vincent Massol 1.3 155
Thomas Mortagne 53.1 156 = Encoding =
Vincent Massol 1.3 157
Vincent Massol 178.1 158 See the [[Encoding Guide>>Documentation.AdminGuide.Configuration.Encoding.WebHome]].
slauriere 1.5 159
Thomas Mortagne 53.1 160 = User Authentication =
slauriere 1.5 161
Vincent Massol 177.1 162 See the [[Authentication Guide>>Documentation.AdminGuide.Authentication.WebHome]].
TimL 1.18 163
Thomas Mortagne 53.1 164 == Customizing the Verified Registration Page (Since 2.2M2) ==
Caleb James DeLisle 52.1 165
Manuel Smeria 140.2 166 The Verified Registration Page is part of the [[Administration Application>>extensions:Extension.Administration Application]] and allows you to require users to fill in a captcha and validates user input on both the server side and the client side using Javascript. The configuration allows you to add fields and validation constraints to the fields which are there.
Caleb James DeLisle 52.1 167
Manuel Smeria 140.2 168 Since version 2.3M1 in order to turn on captcha you simply go to the administration page, click "Registration" and you will find a checkbox for turning on captcha along with other registation page related settings.
Caleb James DeLisle 52.1 169
Vincent Massol 114.6 170 For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]].
Caleb James DeLisle 52.1 171
Caleb James DeLisle 57.1 172 = Initial Groups =
Sorin Burjan 61.1 173
Ecaterina Moraru (Valica) 174.6 174 You can set the default groups which new users will automatically be added to by changing the ##xwiki.users.initialGroups## parameter in your [[xwiki.cfg>>Documentation.AdminGuide.Configuration#HSamplexwiki.cfg]] file. To make all new users be added to the groups **XWiki.CoolPeople** and **XWiki.CommunityMembers** you will have to set the ##initialGroups## parameter like this:
Marc Lijour 141.1 175
Manuel Smeria 140.4 176 (((
Sorin Burjan 61.1 177 {{code language="none"}}
Caleb James DeLisle 57.1 178 xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers
179 {{/code}}
Manuel Smeria 140.4 180 )))
Marc Lijour 141.1 181
Caleb James DeLisle 57.1 182 * Current members will not be automatically be added to these groups, only new members.
183 * The groups have to be created before being specified as initial groups.
Thomas Mortagne 53.1 185 = Logging =
Vincent Massol 1.23 186
Ecaterina Moraru (Valica) 174.6 187 See the [[Logging page>>Documentation.AdminGuide.Logging]].
Vincent Massol 1.23 188
Thomas Mortagne 53.1 189 = Configuring Interwiki links =
Vincent Massol 1.24 190
JohannesStoldt 119.1 191 [[Interwiki linking>>]] is a short hand syntax for linking to pages on other websites. For example, you could link to just by typing ~[~[InterWiki@WikiPedia]].
Vincent Massol 1.24 192
JohannesStoldt 119.1 193 {{info}}
194 Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x.
195 {{/info}}
197 {{warning}}
Manuel Leduc 207.1 198 The link notation for Interwiki links has changed in XWiki Syntax 2.1. Links should look like this in XWiki Syntax 2.1: ~[~[interwiki:WikiPedia:InterWiki]].
JohannesStoldt 119.1 199 {{/warning}}
201 == Interwiki links (XWiki Syntax 1.0) ==
Vincent Massol 125.3 203 Since XWiki renders wiki syntax using the [[Radeox>>]] engine, it supports Interwiki links in [[much the same way as SnipSnap>>]].
Vincent Massol 1.24 204
205 To configure Interwiki links on your wiki:
Caleb James DeLisle 51.1 207 * Create a file named ##[location from where you start your container]/conf/**intermap.txt**##
Marc Lijour 141.1 208 * Fill ##intermap.txt## with content like:(((
Manuel Smeria 140.2 209 {{code}}
210 IMDB
Vincent Massol 1.24 211 OpenWiki
212 SourceForge
213 TWiki
214 Why
215 Wiki
Manuel Smeria 140.2 216 WikiPedia
217 {{/code}}
Marc Lijour 141.1 218 )))You can of course add your own entries.
Vincent Massol 1.24 219
Manuel Smeria 140.2 220 {{warning}}
221 Radeox's parser for ##intermap.txt## is very fragile. A blank line at the bottom of the file is enough to make it fall over.
222 {{/warning}}
Vincent Massol 1.24 223
Manuel Smeria 140.2 224 Restart XWiki (you'll need to restart XWiki every time you change ##intermap.txt##) and try out an Interwiki link. If it does not work, check your ##xwiki.log## file. You'll see if ##conf/intermap.txt## could not be found, or if there was an error parsing it.
JohannesStoldt 119.1 226 == Interwiki links (XWiki Syntax 2.x) ==
228 In order to use Interwiki links in the XWiki Syntax 2.x it is necessary to configure the appropriate list in your file. Look for the following section:
230 {{code language="none"}}
231 #-# [Since 2.5M2]
232 #-# InterWiki definitions in the format alias=URL
233 #-# See for a definition of an InterWiki link
234 # Some examples:
235 # rendering.interWikiDefinitions = wikipedia =
236 # rendering.interWikiDefinitions = definition =
237 {{/code}}
Caleb James DeLisle 116.1 239 = Link URLs =
JohannesStoldt 119.1 240
Caleb James DeLisle 116.1 241 With parameters, you can specify what type of links will be made by XWiki.
Vincent Massol 7.1 242
Caleb James DeLisle 116.1 243 == Reverse proxy setup ==
JohannesStoldt 119.1 244
Caleb James DeLisle 116.1 245 XWiki can and does run behind reverse proxies such as Apache mod_proxy. Usually the only thing needed is to have the ##x-forwarded-host## http header set to the external URL and XWiki will write links correctly.
Ecaterina Moraru (Valica) 172.1 247 Some reverse proxy software does not set this header and with XWiki 3.0M3 or newer, you can use the ##xwiki.home## parameter in single wiki instances (non farm) to achieve the same result.
Caleb James DeLisle 116.1 248
Manuel Smeria 140.4 249 * **xwiki.home** - parameter in ##xwiki.cfg## will be used to make all links pointing to the main wiki on the server. If your main wiki is called "xwiki" but you want your users to access it by going to //www.yoursite.tld// instead of //xwiki.yoursite.tld//, you may set the ##xwiki.home## parameter to //{{{http://www.yoursite.tld/}}}//
Ecaterina Moraru (Valica) 172.1 250 Since XWiki 3.0M3, this parameter will also work for single wiki instances and will be the final authority if the ##x-forwarded-host## parameter is not set.
Caleb James DeLisle 116.1 251
Manuel Smeria 140.2 252 * **xwiki.url.protocol** - with the ##xwiki.url.protocol## parameter in ##xwiki.cfg## you can explicitly specify the protocol as https. This is useful if you are running xwiki behind a reverse proxy which converts https into plain http so xwiki only sees http.
Caleb James DeLisle 116.1 253
254 == Short URLs ==
JohannesStoldt 119.1 255
Thomas Mortagne 234.1 256 It's possible to [[configure XWiki to use shorter URLs>>Documentation.AdminGuide.ShortURLs]].
Vincent Massol 7.1 257
Vincent Massol 144.3 258 = Configure the names of database schemas =
rssh 8.1 259
Ecaterina Moraru (Valica) 173.1 260 {{info}}Since 1.6M1{{/info}} Sometimes, especially in a complex environment, we need to control the names of database schemes, other than default.
rssh 8.1 261
Vincent Massol 205.3 262 * **xwiki.db**: name of database schema for the main wiki (including the name of the wiki in a single-wiki environment, otherwise the database name comes from the Hibernate configuration file).
263 * **xwiki.db.prefix**: useful mainly for [[sub wikis>>Documentation.AdminGuide.Virtualization.WebHome]], where we have a separate database schema for each sub wiki. This prefix is added to the database schema name after usual mapping between wiki names and schemas. Note that this is also applied to the main wiki database name.
rssh 8.1 264
Vincent Massol 181.1 265 = Controlling Page Tabs =
Thomas Mortagne 44.1 266
Vincent Massol 181.2 267 You can do this from the [[Administration>>extensions:Extension.Administration Application#HPresentation]].
Vincent Massol 9.1 268
Thomas Mortagne 234.1 269 If you wish to turn on/off comments/annotations/attachments/history/information tabs only for a single page you just need to [[define some properties in a script in the page>>Documentation.DevGuide.Scripting#HControllingPageTabs]].
Vincent Massol 9.1 270
Vincent Massol 156.1 271 Last, if you wish to turn them off based on some programmatic rule (such as display them only for Administrators), you should define the properties in the ##layoutExtraVars.vm## template file from your XWiki installation. For example:
273 {{code language="none"}}
274 #if (!$hasAdmin)
Vincent Massol 181.1 275 ## Hide tabs
276 #set($displayDocExtra = false)
277 ## Hide viewer shortcuts in the menu
278 #set ($displayShortcuts = false)
Vincent Massol 156.1 279 #end
280 {{/code}}
Manuel Smeria 140.2 282 = Configure "Version Summary" behavior =
Artem Melentyev 16.1 283
Thomas Mortagne 234.1 284 When you're editing a page you can add a brief description of your changes in the "Version Summary" field by default (look at [[Documentation.UserGuide.Features.PageEditing#HCommoneditactions]]). You can disable this feature by setting ##xwiki.editcomment=0## in ##xwiki.cfg##.
Artem Melentyev 16.1 285
Manuel Smeria 140.2 286 When the "Version Summary" feature is enabled, you can also set "Version Summary" to be mandatory by setting //xwiki.editcomment.mandatory=1// in //xwiki.cfg//. This will show a popup window with the request to write a short comment if there is no comment entered. It doesn't allow you to enter an empty comment. If you want a popup, but you also want to be able to enter an empty comment, set //xwiki.editcomment.suggested=1// in //xwiki.cfg//
Artem Melentyev 16.1 287
Manuel Smeria 140.2 288 If you set "Version Summary" as mandatory or suggested, you can also remove the "Version Summary" field and use only a popup window for writing a comment. Set //xwiki.editcomment.hidden=0// in //xwiki.cfg// to do this.
Artem Melentyev 16.1 289
Manuel Smeria 140.2 290 You can use the special fields in the //XWikiPreferences// object instead of editing //xwiki.cfg//. These fields are: //editcomment//, //editcomment_mandatory//, //editcomment_suggested// and //editcomment_hidden//.
Artem Melentyev 16.1 291
Caleb James DeLisle 138.1 292 = Configuring Directories =
Vincent Massol 169.2 294 XWiki uses the following directories:
Caleb James DeLisle 138.1 295
Vincent Massol 169.2 296 * A Temporary directory. It's used for example to cache images after re-sizing them or store attachments after loading them out of the database.
Ecaterina Moraru (Valica) 174.6 297 * A Permanent directory. It's used for storing data such as extensions and [[filesystem attachments>>Documentation.AdminGuide.Attachments#HFilesystemAttachmentStore28SinceXWikiEnterprise3.0M229]] which must not be deleted and search indexes which are replaceable but laborious to create.
Caleb James DeLisle 138.1 298
Vincent Massol 202.1 299 == Permanent Directory ==
Vincent Massol 139.1 301 To set the permanent directory, you have 2 options:
Marc Lijour 141.1 302
Manuel Smeria 140.2 303 * Set the system property when starting the JVM (ie. the Servlet Container's JVM, specifically:
304 * Set the ##environment.permanentDirectory## property in your file
Caleb James DeLisle 138.1 305
Thomas Mortagne 169.1 306 Make sure to choose a folder different from the XWiki home on which XWiki (which usually means whatever user running the application server in which XWiki is installed) has write access. For example the standard Debian package use ##/var/lib/xwiki/data## which is usually a good fit for many Linux distributions.
Thomas Mortagne 168.1 307
Vincent Massol 169.2 308 If the location points to a file or a directory to which XWiki does not have write access to, a warning will be printed in the log and the temporary directory will be used as a default. The temporary directory can be periodically cleaned and all its content deleted so it is critical that it is not used for anything else. Thus it's especially important to set the Permanent directory to not point to the temporary directory.
Caleb James DeLisle 138.1 309
Vincent Massol 183.1 310 {{info}}
Vincent Massol 184.1 311 There are 2 ways to find out what's your current permanent directory:
Manuel Leduc 207.1 312
Manuel Leduc 210.1 313 * {{version since="9.10"}}Check the XWiki logs and look for the "Using permanent directory" string.{{/version}}
Cami Andrei 227.2 314 * Put the following in a wiki page (using the wiki editor). Beware that you'll need to have programming rights for this to work:(((
315 {{code language="none"}}
316 {{velocity}}
317 $services.component.getInstance('org.xwiki.environment.Environment').getPermanentDirectory().getCanonicalPath()
318 {{/velocity}}
319 {{/code}}
320 )))
Vincent Massol 183.1 321 {{/info}}
Vincent Massol 205.1 323 List of sub-directories in the permanent directory:
Manuel Leduc 207.1 324
Vincent Massol 205.1 325 * ##store##: Data stores
Vincent Massol 228.3 326 ** ##store/file##: Attachments ([[when they're saved on the filesystem>>Documentation.AdminGuide.Attachments#HAttachmentStorage]], which is the default, otherwise they're saved in the database), and deleted documents. Note that even when attachments are saved on the filesystem the attachment metadata are saved in the database (e.g. creator, date, etc).
Thomas Mortagne 229.1 327 ** ##store/solr##: Solr configurations and data which are not possible to reindex from a different data source (cache data is located in ##cache##, see below).
328 * ##extension##: Installed extensions and metadata about where they are installed.
Vincent Massol 205.1 329 * ##cache##: Cache files. These files and subdirectories can be removed, XWiki will regenerate them (e.g. the Solr seach indexes). However that can take a lot of time. Examples of what's contained in the cache:
330 ** Solr search indexes
331 ** Descriptors of core extensions. If you delete them, XWiki will simply try to resolve those extensions again at startup but it won't need to resolve much since the WAR embeds complete descriptors for all the JARs. Removing this directory allows cleaning descriptors that were downloaded in previous versions of XWiki.
332 ** FOP Font cache
333 * ##mails##: The [[Mail Sender API>>extensions:Extension.Mail Sender API]] (used by several features of XWiki that require sending mails) will serialize email messages in this directory before they are sent, so that if XWiki crashes or is stopped, those mails are not lost and can be resent. Once a mail is successfully sent, its associated file is removed from this directory. Thus this directory will contain mails that failed to be sent.
Manuel Leduc 207.1 334 * ##logs##: Contains the xwiki logs but this is only true for the [[XWiki Standalone packaging>>Documentation.AdminGuide.Installation.WebHome#HInstallationMethods]] which has Jetty configured to generate its logs in this directory.
Vincent Massol 228.2 335 * ##jobs/status##: Logs and statuses of the various background jobs executed inside XWiki (e.g. when deleting a page or set of pages a job is used). The path follows the job id. Note that most of them are used only to remember what happened during the job execution and are generally safe to remove but some might use the job status for other purposes. Here are a few example of standard jobs (but there can be more coming from extensions):
Thomas Mortagne 229.1 336 ** ##jobs/status/distribution##: Remember the decisions taken in the Distribution Wizard (DW) of each wiki (usually during install/upgrade). It's recommended to keep them but the worst that can happen when deleting them is getting the DW again during next restart (if one of the step is triggered, for example when you have an orphaned or invalid extension installed) and have to cancel again some steps until the next upgrade
337 ** ##jobs/status/extension##: Removing them is safe and won't have any impact other than loosing the log of latest install/uninstall of each extension
338 ** ##jobs/status/refactoring##: Removing them is safe and won't have any impact other than loosing the log of latest refactoring operations
339 ** ##jobs/status/solr/indexer##: Removing it is safe and won't have any impact other than loosing the log of latest Solr indexing operation
340 ** ##jobs/status/wikicreation##: Removing it is safe and won't have any impact other than loosing the log of latest wiki creation operations
Manuel Leduc 207.1 341 * ##database##: This is only true for the [[XWiki Standalone packaging>>Documentation.AdminGuide.Installation.WebHome#HInstallationMethods]] and it contains the HSQLDB database data (i.e. the wiki pages and more).
Manuel Leduc 210.1 342 * {{version since="12.6"}}##mentions##: The [[Mentions Application>>extensions:Extension.Mentions Application.WebHome]] uses this directory to store the queue of documents that are waiting to be analysed for new mentions.{{/version}}
Manuel Leduc 227.1 343 * {{version since="14.0-rc-1"}}##observation##: The [[extensions:Extension.Observation Module Remote]] uses this directory to store the unique identifier of the instance in a cluster.{{/version}}
Thomas Mortagne 235.1 344 * {{version since="15.9"}}{{/version}}: Contains configuration generated by XWiki itself (for example the validation and encryption keys used for cookies when not provided in ##xwiki.cfg##)
Vincent Massol 205.1 345
Vincent Massol 202.1 346 == Temporary Directory ==
348 The temporary directory is taken from the Servlet Container's ##javax.servlet.context.tempdir## Servlet Context property and thus must be configured at that level. If it is pointed to a file or directory where XWiki cannot write, it will print a warning in the log and attempt to use the [[>>]] System property. If this is not a writable directory, an exception will be thrown.
350 Also note that 3rd party libraries used by XWiki could be using another temporary directory. Usually that would the tmp dir provided by the JVM, i.e. the location pointed to by the [[>>]] System property.
352 {{info}}
Manuel Leduc 207.1 353 To know the location, put the following in a wiki page (using the wiki editor). Beware that you'll need to have programming rights for this to work:
Vincent Massol 232.2 354
355 {{code language="none"}}
356 {{velocity}}
Vincent Massol 232.3 357 $services.component.getInstance('org.xwiki.environment.Environment').getTemporaryDirectory().getCanonicalPath()
Vincent Massol 232.2 358 {{/velocity}}
359 {{/code}}
Vincent Massol 202.1 360 {{/info}}
Thomas Mortagne 53.1 362 = Configuring WebDAV (since 1.7) =
Asiri Rathnayake 31.1 363
Ecaterina Moraru (Valica) 174.1 364 WebDAV support has been added to XWiki beginning with XWiki 1.7. It is very important to note that WebDAV is enabled by default.
Asiri Rathnayake 32.1 365
Thomas Mortagne 53.1 366 == Securing WebDAV Server ==
Asiri Rathnayake 32.1 367
Manuel Smeria 140.2 368 XWiki's WebDAV implementation only supports the [[Basic Access Authentication>>]] scheme for authenticating WebDAV clients. Because of this reason it is highly recommended that you employ a transport level security mechanism like SSL to protect your clients. You may consult your web application container's documentation to see how this can be achieved.
Asiri Rathnayake 33.1 369
Thomas Mortagne 53.1 370 == Disabling WebDAV ==
Asiri Rathnayake 33.1 371
Manuel Smeria 140.2 372 To disable WebDAV support in your XWiki server, simply edit your ##web.xml## file and remove the url-mapping element for mapping webdav requests. The url-mapping element for WebDAV looks like this:
Asiri Rathnayake 33.1 373
Thomas Mortagne 53.1 374 {{code language="xml"}}
Asiri Rathnayake 33.1 375 <servlet-mapping>
376 <servlet-name>webdav</servlet-name>
377 <url-pattern>/webdav/*</url-pattern>
378 </servlet-mapping>
Caleb James DeLisle 51.1 379 {{/code}}
Asiri Rathnayake 33.1 380
Thomas Mortagne 53.1 381 = Redirections =
Vincent Massol 13.1 382
Manuel Smeria 140.2 383 XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property: {{code}}xwiki.preferences.redirect=1{{/code}}.
Caleb James DeLisle 51.1 384 Then for each redirection you want to add, add a ##XWiki.GlobalRedirect## object to your main wiki's ##XWiki.XWikiPreferences## document. The ##XWiki.GlobalRedirect## object has 2 fields: ##pattern## and ##destination##. The URL received is matched on ##pattern## and if there's a match it's replaced with the value from ##destination##. XWiki then redirects to the new URL.
Vincent Massol 13.1 385
Simon Urli 224.1 386 == Trusted domains ==
388 By default redirections are only allowed to the trusted domains of the wiki. Those trusted domains are coming from two sources:
389 - all domains used to access the wiki are trusted by definition, as well as the aliases used for subwikis,
390 - in it's possible to specify the property ##url.trustedDomains## to specify other domains that should be trusted.
Cami Andrei 226.1 392 In case a redirection is attempted on a domain not trusted, a warning is displayed in logs and the redirection is prevented.
Simon Urli 224.1 393 Note that this whole mechanism can be switched off by settings ##url.trustedDomainsEnabled## to ##false## in
Thomas Mortagne 53.1 395 = Customizing the PDF export Look & Feel =
Vincent Massol 15.1 396
Sorin Burjan 61.1 397 {{info}}
Vincent Massol 230.1 398 * {{version since="14.10"}}The default PDF export is now using the [[client-side PDF Export Application>>extensions:Extension.PDF Export Application.WebHome]]. The documentation below is for the older server-side PDF export (implemented with Apache FOP){{/version}}
399 * In the future we'll want to rewrite the PDF/RTF exports as renderers in the new [[Rendering Module architecture>>extensions:Extension.Rendering Module]]. When this happens this section will be upgraded.
Sorin Burjan 61.1 400 {{/info}}
Ricardo Rodríguez 24.1 401
Vincent Massol 231.1 402 == General Architecture ==
Vincent Massol 30.2 404 Here's how the PDF and RTF exports currently work:
Silvia Macovei 154.2 405 {{image reference="XWikiExport201010290119.png"/}}
Ricardo Rodríguez 28.1 406
Sergiu Dumitriu 58.1 407 As shown in the diagram you can customize 4 parts:
Thomas Mortagne 53.1 408
Vincent Massol 210.2 409 * The templates, ##pdf.vm## and the referenced subparts, ##pdfhtmlheader.vm##, ##pdfheader.vm##, ##pdffooter.vm##, ##pdftoc.vm##, ##pdfcover.vm##, which can be overridden by a copy located in a custom skin
Manuel Smeria 140.2 410 * The CSS used to render the content as PDF/RTF. There is no pdf.css by default. It could be created in /templates or in a skin; a copy in a skin, override the one located in /templates
Vincent Massol 210.2 411 * The XHTML2FO XSL transformation. The default one, ##{{scm project="xwiki-platform" path="xwiki-platform-core/xwiki-platform-oldcore/src/main/resources/xhtml2fo.xsl"}}xhtml2fo.xsl{{/scm}}##, is packed in a core jar but it could be override by a new one in a template or a ##xhtml2fo.xsl## file in ##WEB-INF/classes## directory, if customization needed.
412 * The FOP XSL transformation. The default one, ##fop.xsl##, is also packed in a core jar.
Vincent Massol 30.2 413
Manuel Smeria 140.2 414 After the export request triggers XWiki ExportAction, the content of your document is parsed by Velocity to get the initial XHTML content. **[[JTidy>>]]**, a HTML/XHTML syntax checker and pretty printer, will clean the initial XHTML to make it XHTML compliant. No customization is possible in this step.
Ricardo Rodríguez 108.1 415
Thomas Mortagne 234.1 416 In order to provide your own customization you need to start by tweaking the default templates (they can also be copied to a new skin) and/or by creating a new [[XWiki Class>>Documentation.DevGuide.DataModel]]. To do that simply create a new page called //XWiki.PDFClass// and edit it in class mode (for ex. //{{{}}}//). Add the following "Text Area" properties as needed (they are all optional so you only need to define the ones you need to use):
Thomas Mortagne 53.1 417
Carlos Amengual 193.1 418 * ##style##: contains the CSS information that will overwrite or complement the default ##pdf.css## values if they exist. **[[css4j>>]]**, a CSS API implementation for the Java™ platform, will take care of this.
Thomas Mortagne 164.1 419 * ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one. It is processed by **[[Apache Xalan>>]]**, a XSLT processor for transforming XML documents into HTML, text, or other XML document types. Since version 3.0M2 (see issue [[XWIKI-5918>>||title="Impossible to override XSLT documents used in the PDF export process"]]) this field needs to be the actual content of the customized ##xhtml2fo.xsl##. Note that you can also use velocity in this field (useful to get the content of an attached .xsl file, which comes in very handy when you need to fill in a big file, since the limit of textarea properties is of 60 000 characters)
Ricardo Rodríguez 109.1 420 * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. It is processed by **[[Apache FOP>>]]**.
Vincent Massol 30.2 421
JohannesStoldt 119.1 422 {{warning}}
Manuel Smeria 140.2 423 The name of the class must be ##XWiki.PDFClass##.
JohannesStoldt 119.1 424 {{/warning}}
Sergiu Dumitriu 114.5 425
Ricardo Rodríguez 106.1 426 The good thing about fop/xsl-fo is that the xsl-fo document is independent of the final result. So we can export the wiki documents into many formats.
Caleb James DeLisle 51.1 428 Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
Vincent Massol 30.2 429
Manuel Smeria 140.4 430 Last use that page when calling the PDF/RTF export using the ##pdftemplate## parameter as in //{{{http://yourserver/xwiki/bin/export/Space/Page?format=pdf&language=en&pdftemplate=XWiki.PDFTemplate}}}//.
Vincent Massol 30.2 431
Manuel Smeria 140.2 432 {{warning}}
Manuel Smeria 140.3 433 No template is used by default.
Manuel Smeria 140.2 434 {{/warning}}
Sergiu Dumitriu 79.1 436 {{info}}
Pascal Bastien 179.1 437 As mentioned the ##style## property stores CSS code. The field is parsed by the Velocity engine, so you can use the [[current color theme>>extensions:Extension.Color Theme Application#HUsingColorThemesvariables]] to style your PDF. Also, you can insert page break in PDF file with //page-break-before// CSS instruction. For example:
Manuel Smeria 140.2 438
Vincent Massol 181.1 439 {{code language="css"}}
Sergiu Dumitriu 79.1 440 #template('colorThemeInit.vm')
Ricardo Rodríguez 28.1 441 h2 {
Sergiu Dumitriu 79.1 442 color: $theme.titleColor;
Ricardo Rodríguez 28.1 443 }
Sergiu Dumitriu 79.1 445 td {
446 border-color: $theme.borderColor;
Ricardo Rodríguez 28.1 447 }
Pascal Bastien 179.1 448
449 h1, .my_Page_break {
450 page-break-before:always;
451 }
Caleb James DeLisle 51.1 453 {{/code}}
Sergiu Dumitriu 79.1 454 {{/info}}
Ricardo Rodríguez 28.1 455
Vincent Massol 230.1 456 == Override the PDF Templates ==
Sorin Burjan 131.1 457
Vincent Massol 230.1 458 === Customize the PDF Footer ===
Sorin Burjan 131.1 459
Manuel Smeria 140.4 460 By default, the PDF footer will display the page number, the last author and the date on which the last modification was performed. In order to also display a customized message, the template ##pdffooter.vm## must be overridden. To do that, edit the skin class (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/XWikiSkins?editor=class}}}//) and add a "TextArea" object named ##pdffooter.vm##:
Sorin Burjan 131.1 461
Silvia Macovei 154.2 462 {{image reference="OverridePDFFooter.png"/}}
Sorin Burjan 131.1 463
Clemens Robbenhaar 144.2 464 After adding the ##pdffooter.vm## you might want to edit it (clicking on it opens a detailed editor) and e.g. give it a "Pretty name". In this editor, also set the "Editor" property to "pure text" as otherwise the WYSIWYG-Editor will be used:
Clemens Robbenhaar 143.1 465
Silvia Macovei 154.2 466 {{image reference="OverridePDFFooterEdit1.png"/}}
Clemens Robbenhaar 144.2 467
Manuel Smeria 140.4 468 Next, edit the skin page (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object}}}//) and add the following code to the ##pdffooter.vm## property:
Sorin Burjan 131.1 469
Manuel Smeria 140.2 470 {{code}}
471 $msg.Page <span class="page-number"></span> - $msg.get('lastmodifiedby')
472 $xwiki.getUserName($, false)
473 $msg.get('lastmodifiedon')
474 $!xwiki.formatDate($
475 <div>
476 <p>CustomName SAS. All rights reserved. Confidential and proprietary document. Printed Copies are not controlled.</p>
477 </div>
478 {{/code}}
Sorin Burjan 131.1 480 To see the changes, just export any wiki page:
Silvia Macovei 154.2 482 {{image reference="OverridePDFFooterFinal.png"/}}
Sorin Burjan 131.1 483
Vincent Massol 230.1 484 === Customize the PDF Cover ===
Sorin Burjan 131.1 485
Manuel Smeria 140.4 486 This could be useful when you want for instance to add the company's logo to the PDF cover. In order to do this, the template ##pdfcover.vm## must be overridden. Just like for the PDF header, a "TextArea" property named ##pdfcover.vm## must be added to the XWiki.XWikiSkins class (e.g. //{{{http://yourserver/xwiki/bin/view/XWiki/XWikiSkins?editor=class}}}//).
Sorin Burjan 131.1 487
Silvia Macovei 154.2 488 {{image reference="OverridePDFCover.png"/}}
Sorin Burjan 131.1 489
Manuel Smeria 140.4 490 Next, edit the skin page (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object}}}//) and add the following code to the ##pdfcover.vm## property:
Sorin Burjan 132.1 491
Manuel Smeria 140.3 492 {{code}}
493 <img src="$xwiki.getSkinFile("logo.png")"/>
Sorin Burjan 131.1 494
495 <div style="text-align: center; width: 100%;">
496 <h1>
497 #set($title = "$!pdfdoc.display('title', 'rendered')")
498 #if($title == '')
499 $escapetool.xml($!doc.displayTitle)
500 #else
501 $escapetool.xml($title)
502 #end
503 </h1>
504 <br />
505 <br />
506 $!xwiki.getUserName($, false)
507 <br />
508 $!xwiki.formatDate($
Manuel Smeria 140.3 509 </div>
510 {{/code}}
Caleb James DeLisle 137.1 511
Manuel Smeria 140.3 512 The last step consists of attaching the image "logo.png" to the skin:
Sorin Burjan 131.1 513
Silvia Macovei 154.2 514 {{image reference="OverridePDFCoverFinal.png"/}}
Sorin Burjan 131.1 515
Vincent Massol 230.1 516 === Override the CSS rules ===
Sorin Burjan 132.2 517
Vincent Massol 189.1 518 In order to use your own template when exporting a page as PDF, you need to create a class in the XWiki space and name it PDFClass. Next, edit the page in "Class" mode (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/PDFClass?editor=class}}}//) and add the following ##TextArea## properties:
Sorin Burjan 131.1 519
Vincent Massol 188.3 520 * ##style##: contains the CSS rules that will override the default ##pdf.css## values; by default, there won't be a ##pdf.css## file on your filesystem, but you can create it in the folder ##\webapps\xwiki\templates\## or specify it in your skin page
521 * ##xhtmlxsl##: contains the XHTML2FO XSL transformation that will override the default one
522 * ##fopxsl##: contains the FOP XSL transformation that will override the default one
Sorin Burjan 131.1 523
Vincent Massol 189.1 524 For each property added, make sure to set the ##Content## property metadata to ##PureText## in order to not get the WYSIWYG editor which would make it complex to enter XML/XSL.
Silvia Macovei 154.2 526 {{image reference="CreatePDFClass.png"/}}
Sorin Burjan 131.1 527
Manuel Smeria 140.3 528 Then, create the wiki page for which your want to customize the PDF export (e.g. XWiki.PDFTemplate) and add a "XWiki.PDFClass" object to it.
Sorin Burjan 131.1 529
Oana Florea 196.1 530 Supposing your wiki page //Sandbox.TestPage1// contains a table, you have to edit it in "Wiki" mode and add a style parameter as shown below:
Manuel Smeria 140.3 531
Sorin Burjan 134.3 532 {{code}}
Sorin Burjan 131.1 533 (% class="mytable" %)
534 |=Column 1|=Column 2
535 | data|data
Sorin Burjan 134.4 536 {{/code}}
Manuel Smeria 140.3 537
Oana Florea 196.1 538 Next, edit the template page (e.g. XWiki.PDFTemplate) in "Objects" mode and write your own CSS rules in the "style" property:
Sorin Burjan 131.1 539
Silvia Macovei 154.2 540 {{image reference="CreatePDFTemplate.png"/}}
Sorin Burjan 131.1 541
Oana Florea 196.1 542 Because no template is used by default, you need to specify the ##pdftemplate## parameter in the URL in order to use your own template: //{{{http://yourserver/xwiki/bin/export/Sandbox/TestPage1/?format=pdf&pdftemplate=XWiki.PDFTemplate}}}//.
Sorin Burjan 131.1 543
Oana Florea 197.2 544 {{image reference="SandboxTestPage1PDF.png" width="700"/}}
Sorin Burjan 131.1 545
Oana Florea 197.2 546 **Tip**: download the [[PDF class>>attach:XWiki.PDFClass.xar]] and [[PDF template >>attach:XWiki.PDFTemplate.xar]]for this example and test them on your wiki.
Oana Florea 196.1 547
Sorin Burjan 61.1 548 {{info}}
549 Even though RTF export is expected to work the same way, there are still some isues to be solved affecting how CSS properties control the final layout.
550 {{/info}}
Ricardo Rodríguez 28.1 551
Pascal Bastien 179.1 552 {{warning}}
553 If some CSS styling doesn't work on PDF export, you could check if CSS instruction is supported by XSL-FO on [[Apache™ FOP Compliance Page>>]].
554 Furthermore, you can not use multiple attributes to select a CSS element (see issue: [[XWIKI-14653>>]]).
555 {{/warning}}
Vincent Massol 230.1 557 === Override the xhtml2fo.xsl rules ===
Marc Lijour 141.1 558
Pascal Bastien 180.1 559 As explained above, the entire code of {{scm project="xwiki-platform" path="xwiki-platform-core/xwiki-platform-oldcore/src/main/resources/xhtml2fo.xsl"}}xhtml2fo.xsl{{/scm}} needs to be copied in the xhtmlxsl textarea and then customized.
Marc Lijour 141.1 560
Pascal Bastien 170.2 561 For example, to disable the generation of clickable URLs in the PDF, modify the following section:
Thomas Mortagne 234.2 562
563 {{code}}
564 <xsl:template match="html:a[@href]" mode="transform">
565 <fo:basic-link xsl:use-attribute-sets="a-link">
566 <xsl:call-template name="process-a-link"></xsl:call-template>
567 </fo:basic-link>
568 </xsl:template>
569 {{/code}}
Marc Lijour 141.1 571 as
Thomas Mortagne 234.2 572
573 {{code}}
574 <xsl:template match="html:a[@href]" mode="transform">
575 <fo:inline>
576 <xsl:call-template name="process-a-link"></xsl:call-template>
577 </fo:inline>
Thomas Mortagne 235.1 578 </xsl:template>
579 {{/code}}
Thomas Mortagne 234.2 580
581 or disable the generation of clickable URLs for some specific href links in the PDF
583 {{code}}
584 <xsl:template match="html:a[@href]" mode="transform">
585 <xsl:choose>
586 <!-- disable these internal links ("data-parent" attribute start with "#accordion" or href is "#my_anchor") -->
587 <xsl:when test="starts-with(@data-parent,'#accordion') or @href = '#my_anchor'">
Marc Lijour 141.1 588 <fo:inline>
Thomas Mortagne 234.2 589 <xsl:call-template name="process-a-link"></xsl:call-template>
Marc Lijour 141.1 590 </fo:inline>
Thomas Mortagne 234.2 591 </xsl:when>
592 <xsl:otherwise>
593 <fo:basic-link xsl:use-attribute-sets="a-link">
594 <xsl:call-template name="process-a-link"></xsl:call-template>
595 </fo:basic-link>
596 </xsl:otherwise>
597 </xsl:choose>
598 </xsl:template>
599 {{/code}}
Marc Lijour 141.1 600
Vincent Massol 230.1 601 === Debugging PDF export ===
Thomas Mortagne 167.1 602
Pascal Bastien 165.1 603 To inspect contents of created XHTML file (and be able to style it) - turn on logging <xwiki>/xwiki/bin/view/AdminGuide/Logging and set //com.xpn.xwiki// level to //DEBUG//. After PDF export action, xwiki log file containing intermediates states XHTML code after theses lines:
605 {{code language="none"}}
Pascal Bastien 166.1 606 DEBUG c.x.x.p.i.PdfExportImpl - Cleaning HTML: //(show XHTML code without style)//
Pascal Bastien 165.1 607 DEBUG c.x.x.p.i.PdfExportImpl - Cleaned XHTML:
Pascal Bastien 166.1 608 DEBUG c.x.x.p.i.PdfExportImpl - Applying the following CSS: //(show CSS properties)//
609 DEBUG c.x.x.p.i.PdfExportImpl - HTML with CSS applied: //(show HTML code with CSS properties merged in tag with "style=" )//
Pascal Bastien 165.1 610 DEBUG c.x.x.p.i.PdfExportImpl - Final XHTML for export:
Pascal Bastien 166.1 611 DEBUG c.x.x.p.i.PdfExportImpl - Intermediary XSL-FO: //(show document with eXtensible Stylesheet Language - Formatting Objects used to generate PDF files)//
Pascal Bastien 165.1 612 DEBUG c.x.x.p.i.PdfExportImpl - Final XSL-FO source:
613 and finally DEBUG c.x.x.p.i.PdfExportImpl - PageSequence x-page-sequence generated 3 pages.
614 {{/code}}
Thomas Mortagne 53.1 616 = Configuring Wiki Syntaxes and default Syntax =
Ricardo Rodríguez 46.1 617
Thomas Mortagne 234.1 618 To know how to configure the [[Wiki syntaxes>>Documentation.UserGuide.Features.XWikiSyntax]] that are available to the user when writing wiki pages, check the [[Rendering Administration Application>>extensions:Extension.Rendering Administration Application]].
Ricardo Rodríguez 24.1 619
Vincent Massol 115.1 620 = Title behavior =
Manuel Smeria 140.3 622 The following configuration parameters (found in ##xwiki.cfg##) can be used to control title behavior:
Vincent Massol 115.1 623
624 {{code language="none"}}
625 #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
Vincent Massol 163.3 626 #-# mode is active, XWiki will try to extract a title from the document content.
627 #-# If the document's content first header (level 1 or level 2) matches the document's title
Vincent Massol 115.1 628 #-# the first header is stripped.
Vincent Massol 163.3 629 #-# The default value is 0.
630 # xwiki.title.compatibility=1
Vincent Massol 115.1 631
632 #-# Defines the maximum header depth to look for when computing a document's title from its content. If no header
633 #-# equal or lower to the specified depth is found then the computed title falls back to the document name.
634 #-# The default value is 2.
635 # xwiki.title.headerdepth=2
637 #-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this
638 #-# property is set to 1. The default value is 0 (not mandatory).
639 # xwiki.title.mandatory=0
640 {{/code}}
Vincent Massol 117.1 642 = Link Label Generation =
Thomas Mortagne 234.1 644 Starting with XWiki Syntax 2.0 it's possible to configure how labels are generated by the system when the user doesn't provide one (e.g. ##~[~[mywiki:Main.WebHome]]##).
Vincent Massol 117.1 645
646 Her's an extract from the file which is where this feature is configurable:
648 {{code language="none"}}
649 #-# [Since 1.8RC2]
Vincent Massol 159.1 650 #-# Specifies how links labels are displayed when the user doesn't specify the label explicitly.
Vincent Massol 117.1 651 #-# Valid values:
652 #-# %w: wiki name
Vincent Massol 159.1 653 #-# %s: full space name (e.g. space1.space2)
654 #-# Note: Prior to 7.4.2/8.0M2 this was only displaying the last space name
655 #-# %ls: last space name. New in 7.4.2/8.0M2
Vincent Massol 117.1 656 #-# %p: page name
Vincent Massol 159.1 657 #-# %np: nested page name (i.e. will display the space name for Nested Pages). New in 7.4.2/8.0M2
658 #-# %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage"
659 #-# %NP: nested page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage".
660 #-# New in 7.4.2/8.0M2
Vincent Massol 117.1 661 #-# %t: page title
662 #-#
Vincent Massol 159.1 663 #-# Note that if the page title is empty or not defined then it defaults to %np. This is also the case
Vincent Massol 117.1 664 #-# if the title cannot be retrieved for the document.
665 #-#
Vincent Massol 159.1 666 #-# The default is "%np". Some examples: "%s.%p", "%w:%s.%p".
667 # rendering.linkLabelFormat = %np
Vincent Massol 117.1 668 {{/code}}
Vincent Massol 121.1 670 = Rendering Cache =
Vincent Massol 176.1 672 See the [[Performance page>>Documentation.AdminGuide.Performances.WebHome#HRenderingcache]].
Vincent Massol 121.1 673
Guillaume Lerouge 125.1 674 = Allowed Pages for Inactive Users =
Sergiu Dumitriu 125.2 676 The //xwiki.cfg// configuration file includes a property called ##xwiki.inactiveuser.allowedpages##. This property can be used to build a whitelist of pages that can be read by inactive users. The format that should be used is a comma-separated list of pages that users that are marked as inactive are allowed to see.
Guillaume Lerouge 125.1 677
Sergiu Dumitriu 125.2 678 This property is needed due to the fact that in XWiki, some users can be marked as inactive, for example when enabling user email verification in the administration. An inactive user has an account, but the account needs to be validated in order for the user to be able to access the wiki. Access rights do not apply to inactive users (they are recognized neither as XWikiGuest nor as members of XWikiAllGroup).
Guillaume Lerouge 125.1 679
Manuel Smeria 140.3 680 {{info}}
681 Inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.
682 {{/info}}
Guillaume Lerouge 125.1 683
Vincent Massol 125.8 684 = Rendering Transformations =
Manuel Smeria 140.3 686 You can control which [[Transformations>>rendering:Main.Architecture]] are active (by default the [[Macro>>rendering:Main.Architecture]] and [[Icon>>rendering:Main.Transformations#HIconTransformation]] ones are active by default) by editing
Vincent Massol 125.8 687
688 {{code language="none"}}
689 #-# [Since 2.6RC1]
690 #-# Controls what transformations will be executed when rendering content.
691 #-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with
692 #-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.
693 #-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the
694 #-# macro execution. If you don't list it, macros won't get executed.
695 #-# The default value is: rendering.transformations = macro, icon
696 {{/code}}
Manuel Smeria 140.3 698 For example if you wish to turn off the Icon Transformation in order to not render emoticons, you'd have to define the following property: {{code language="none"}}rendering.transformations = macro{{/code}}.
Vincent Massol 125.8 699
Manuel Leduc 229.2 700 = Macros categories and visibility =
702 You can override the default categories of a macro by editing
Jan-Paul Kleijn 232.1 704 {{code language="properties"}}
Manuel Leduc 229.2 705 #-# [Since 2.0M3]
706 #-# Overrides default macro categories (Each macro has default categories already defined, for example
707 #-# "Navigation" for the Table of Contents Macro).
708 #-# Note: the categories are case sensitive.
709 #-#
710 #-# Ex: To redefine the macro categories for the TOC macro so that it'd be in the "My Category" and "Deprecated"
711 #-# categories + redefine the category for the Script Macro to be "My Other Category", you'd use:
712 # rendering.transformation.macro.categories = toc = My Category\,Deprecated
713 # rendering.transformation.macro.categories = script = My Other Category
714 {{/code}}
Jan-Paul Kleijn 232.1 716 {{version since="14.8"}}
Manuel Leduc 229.2 717 You can also configure the macro categories hidden by default by editing
719 {{code language='properties'}}
720 #-# [Since 14.8RC1]
721 #-# Override the default hidden macro categories.
722 #-# Note: the categories are case sensitive.
723 #-#
Manuel Leduc 233.1 724 #-# The default value is:
725 # rendering.transformation.macro.hiddenCategories = Internal,Deprecated
726 #-#
727 #-# For instance, to make the "Development" category hidden by default, in addition to the "Internal" and
Manuel Leduc 229.2 728 #-# "Deprecated" categories, you'd use:
729 # rendering.transformation.macro.hiddenCategories = Development,Internal,Deprecated
730 {{/code}}
731 {{/version}}
Vincent Massol 135.1 733 = Securing Groovy Scripts =
Vincent Massol 136.1 735 See:
Vincent Massol 135.1 736
Manuel Smeria 140.3 737 * The [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]]
738 * The [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]]
Vincent Massol 182.1 740 = Lock Duration =
742 By default, when a user starts editing a page, a lock will be set on that page, see [[Page Editing>>Documentation.UserGuide.Features.PageEditing#HLocking]]. The lock is valid by default for 30 minutes, after which it gets invalidated.
744 In order to increase this duration, you have 2 options:
746 * Add a property named ##lock_Timeout## to your ##xwiki.cfg## configuration file, and set the value in seconds (and restart XWiki). For example for 15 minutes: ##lock_Timeout = 900##.
747 * Or add the configuration in the wiki itself:
748 ** Edit the ##XWiki.XWikiPreferences## document using the class editor
749 ** Add a Number property named ##lock_Timeout## (case sensitive)
750 ** Edit the ##XWiki.XWikiPreferences## document using the object editor
751 ** Find the ##lock_Timeout## property and put the desired number of *seconds* a lock should be valid for
752 ** Don't forget to save the document
Vincent Massol 203.1 754 = Editing =
Vincent Massol 185.1 755
Vincent Massol 203.1 756 == Default editor ==
Vincent Massol 215.1 758 You can choose which default editor to use when editing wiki content (wiki or WYSIWYG editor). XWiki uses the following strategy when deciding which editor to use:
Cami Andrei 226.1 759
Vincent Massol 215.1 760 1. If editing a [[TextArea object property>>Documentation.DevGuide.DataModel.WebHome]] and that property has explicitly specified a specific editor to be used to edit it, then that editor will be used. This is set when [[using the Class editor>>Documentation.UserGuide.Features.PageEditing#HClasseseditingmode]]. For example:(((
761 {{image reference="editor-class-property.png"/}}
762 )))
763 1. Then, if no property editor is defined, or if editing standard wiki content (like page content), XWiki will check if the [[current user has configured an editor for a given content type>>extensions:Extension.Edit Module#HConfiguretheDefaultEditor]] and if the current edited content is of that type, then that editor will be used. For example:(((
764 {{image reference="editor-content-user.png"/}}
765 )))
766 1. Then, if no property editor is defined, XWiki will check if the [[current (nested) page has configured an editor for a given content type>>extensions:Extension.Edit Module#HConfiguretheDefaultEditor]] and if the current edited content is of that type, then that editor will be used. For example:(((
767 {{image reference="editor-content-page.png"/}}
768 )))
769 1. Then, if no property editor is defined, XWiki will check if the [[current wiki has configured an editor for a given content type>>extensions:Extension.Edit Module#HConfiguretheDefaultEditor]] and if the current edited content is of that type, then that editor will be used. For example:(((
770 {{image reference="editor-content-wiki.png"/}}
771 )))
772 1. Then, if no property editor is defined, XWiki will check if there's a [[configuration in for a given content type>>extensions:Extension.Edit Module#HConfiguretheDefaultEditor]] and if the current edited content is of that type, then that editor will be used. For example:(((
773 {{code language="properties"}}
775 {{/code}}
776 )))
777 1. Then, if no editor has been defined, XWiki will check if the current [[user has defined a preferred editor to use>>extensions:Extension.User Module.User Profile Application.WebHome#HEditPreferences]]. For example:(((
778 {{image reference="editor-user.png"/}}
779 )))
Cami Andrei 226.1 780 1. Then, if no preferred editor to use has been defined for the current user, XWiki will check the default editor set up in the Page Administration (XWiki.XWikiPreferences of the page) . Could be set because of [[XWIKI-17324>>]]. For example:(((
781 {{image reference="editor-space-preference-object.png"/}}
782 )))
Vincent Massol 215.1 783 1. Then, if no editor has been defined, XWiki will check the [[default editor set up in the Administration UI>>extensions:Extension.Administration Application#HEditing]]. For example:(((
784 {{image reference="editor-admin.png"/}}
785 )))
Vincent Massol 203.1 786
787 == Default WYSIWYG editor ==
Vincent Massol 215.1 789 {{version since="8.2"}}
790 You can configure the [[default WYSIWYG editor to use>>extensions:Extension.CKEditor Integration.WebHome#HAdministrationSection]].
791 {{/version}}
Vincent Massol 203.1 793 See the [[WYSIWYG Editor Configuration>>extensions:Extension.CKEditor Integration.WebHome#HConfiguretheEditor]] page to find out how you can enable or disable editing features.
795 == Section Editing ==
Vincent Massol 185.1 797 By default section editing is limited to level 1 and level 2 sections. This can be controlled by editing ##xwiki.cfg##:
799 {{code}}
800 #-# This parameter controls the depth of sections that have section editing.
801 #-# By default level 1 and level 2 sections have section editing.
802 xwiki.section.depth=2
803 {{/code}}
805 You can also enable/disable section editing with:
807 {{code}}
808 #-# This parameter will activate the sectional editing.
809 xwiki.section.edit=1
810 {{/code}}
Vincent Massol 203.1 812 == Editing Conflicts ==
Vincent Massol 204.1 814 The [[Edit Conflict feature>>]] can be disabled ({{info}}XWiki 11.3.2{{/info}} and {{info}}XWiki 11.6RC1{{/info}}) from the file by setting ##edit.conflictChecking.enabled = false##:
Vincent Massol 203.1 815
Manuel Leduc 207.1 816 {{code language="none"}}
Vincent Massol 204.1 817 #-# [Since 11.3.2, 11.6RC1]
818 #-# Indicate if the mechanism to detect and handle edition conflicts should be enabled or not.
819 #-# If disabled, it means that in case of edition conflicts, the latest save will be always take into account, and
820 #-# erase previous data (which can always be recovered in the history of the document).
821 #-# This option is provided because the feature is still experimental and it could be useful is some specific usecases
822 #-# to switch it off. However it is not recommended to do so.
823 #-#
824 #-# The default is:
825 # edit.conflictChecking.enabled = true
Vincent Massol 203.1 826 {{/code}}
828 == In-place Editing ==
Vincent Massol 204.1 830 To disable the in-place WYSIWYG editing mode (and thus default to the Standalone WYSIWYG editing mode), modify the file and set ##edit.document.inPlaceEditing.enabled = false## ({{info}}XWiki 12.5{{/info}}):
Vincent Massol 203.1 831
Manuel Leduc 207.1 832 {{code language="none"}}
Vincent Massol 203.1 833 #-# [Since 12.5]
834 #-# Indicate if the XWiki documents should be edited in-place, without leaving the view mode, whenever possible (e.g. if
835 #-# the default edit mode for that document and the preferred editor both support in-place editing). When enabled,
836 #-# clicking on the document Edit button makes the document title and content editable in-place, without leaving the
837 #-# view mode. When disabled, clicking on the document Edit button loads the default (stand-alone) edit mode for that
838 #-# document.
839 #-#
840 #-# The default is:
841 # edit.document.inPlaceEditing.enabled = true
842 {{/code}}
Manuel Leduc 207.1 844 = Delete Pages =
Manuel Leduc 210.3 846 {{version since="12.9RC1"}}
847 This section is hidden when the [[recycle bin is not activated>>||anchor="HDocumentrecyclebin"]].
848 {{/version}}
Manuel Leduc 207.1 850 == Enabling Advanced users to skip the recycle bin ==
Manuel Leduc 208.1 852 {{version since="12.8RC1"}}
Manuel Leduc 207.1 853 Advanced users can be allowed choose if they want to skip the recycle bin (and remove the pages permanently) when deleting pages.
855 To do so, search for the "Delete" section and set "can skip the recycle bin" to Yes. The default value is No.
857 [[image:skip_recycle_bin_admin_cropped.png]]
Manuel Leduc 208.1 858 {{/version}}
Manuel Leduc 207.1 859
Manuel Leduc 208.1 860 Advanced users can be allowed choose if they want to skip the recycle bin (and remove the pages permanently) when deleting pages.
862 To do so, search for the "Delete" section and set "can skip the recycle bin" to Yes. The default value is No.
864 [[image:skip_recycle_bin_admin_cropped.png]]
Manuel Leduc 212.1 866 {{version since="12.9RC1"}}
867 The configuration is resolved by looking in three locations, from the most specific to the least specific:
869 * In the configuration of the current wiki
870 * In the configuration of the main wiki
871 * In (see the property details below)
873 If the default value is found on one location, the next one is tried. If no value is found, the recycle bin skipping is not activated.
875 Details of the configuration on
877 {{code language="none"}}
878 #-# [Since 12.9RC1]
879 #-# Indicates whether skipping the recycle bin when deleting pages is allowed for Advanced users.
880 #-# It is disabled by default.
881 #-# This setting is only used if the wiki has a recycle bin activated (xwiki.recyclebin=1 in xwiki.cfg).
882 #-# This setting can be overloaded:
883 #-# * By the main wiki in the Refactoring.Code.RefactoringConfigurationClass class of the
884 #-# Refactoring.Code.RefactoringConfiguration document of the main wiki.
885 #-# * By sub-wikis in the Refactoring.Code.RefactoringConfigurationClass class of the
886 #-# Refactoring.Code.RefactoringConfiguration document of the sub-wikis (itself overloading the main wiki's
887 #-# configuration).
888 #-#
889 #-# The default value is:
890 # refactoring.isRecycleBinSkippingActivated = false
891 {{/code}}
892 {{/version}}
Thomas Mortagne 53.1 894 = Sample xwiki.cfg =
TimL 1.18 895
Vincent Massol 158.1 896 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.cfg.vm"}}xwiki.cfg.vm{{/scm}}
Vincent Massol 30.1 897
Vincent Massol 158.1 898 Note that we generate the default ##xwiki.cfg## file from this template file by applying Velocity on it during the build, so all ##$<something>## properties that you see in this file are replaced at build time.
Vincent Massol 50.1 899
Thomas Mortagne 53.1 900 = Sample =
Vincent Massol 50.1 901
Clemens Robbenhaar 188.2 902 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/"}}{{/scm}}
Vincent Massol 50.1 903
Clemens Robbenhaar 188.2 904 Note that we generate the default file from this template file by applying Velocity on it during the build, so all ##$<something>## properties that you see in this file are replaced at build time.

Get Connected