Wiki source code of Configuration

Last modified by Vincent Massol on 2021/01/13

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Once you have XWiki [[installed>>Documentation.AdminGuide.Installation.WebHome]] you'll want to configure it. Configuration can be done in 2 ways:
6
7 * by stopping the XWiki instance and editing either the ##xwiki/WEB-INF/xwiki.cfg## file or the ##xwiki/WEB-INF/xwiki.properties## 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 ##xwiki.properties##
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.(((
9 {{info}}
10 * Some configurations are only accessible from the ##xwiki.cfg## and ##xwiki.properties## 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]].
12 {{/info}}
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]].
14
15 There are various things you can configure:
16
17 = Enable superadmin account =
18
19 Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example:
20
21 {{code language="none"}}
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
25 {{/code}}
26
27 When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property.
28
29 = Language settings =
30
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.
32
33 In addition you can configure your wiki to be multilingual. See the [[I18 user page>>platform:Features.I18N]] for more information.
34
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).
36
37 {{code language="none"}}
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
41
42 #-# Force only one of the supported languages to be accepted. Default is true.
43 # xwiki.language.forceSupported=1
44 {{/code}}
45
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}}
49
50 == Algorithm ==
51
52 The algorithm to find the locale to use is the following, in this order:
53
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
62
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.
64
65 = Date format =
66
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:
68
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
73
74 [[More information about date formatting>>http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html]].
75
76 = Enabling/Disabling Statistics =
77
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##):
79
80 {{code}}
81 xwiki.stats=0
82 xwiki.stats.default=0
83 {{/code}}
84
85 where:
86
87 * ##xwiki.stats## controls whether statistics are on or off
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.(((
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:
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##
93 {{/info}}
94 )))
95
96 = Optional Store Features =
97
98 == Document versioning ==
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.
101
102 To disable versioning edit //xwiki.cfg// and add {{code}}xwiki.store.versioning=0{{/code}}.
103
104 [[Attachment versioning>>Documentation.AdminGuide.Attachments#HVersions]] is also available and turned on by default.
105
106 == Document recycle bin ==
107
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}}.
109
110 {{info}}
111 Disabling the recycle bin will make it impossible to restore a deleted document, unless a database backup is available.
112 {{/info}}
113
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:
115
116 {{code}}
117 # Admins must wait 3 days before being allowed to permanently delete
118 xwiki.store.recyclebin.adminWaitDays=3
119 # Normal users must also wait 3 days
120 xwiki.store.recyclebin.waitDays=3
121 {{/code}}
122
123 [[Attachment recycle bin>>Documentation.AdminGuide.Attachments#HDeletion]] is similar.
124
125 = Customizing error pages =
126
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:
128
129 * ##XWiki.WikiDoesNotExist##,
130 * ##XWiki.DocumentDoesNotExist##,
131 * ##XWiki.AttachmentDoesNotExist##,
132 * ##XWiki.AccessDenied##
133
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.
135
136 = Customizing the Skin =
137
138 See the [[Skin Guide>>Documentation.AdminGuide.Skins]].
139
140 = Security configuration =
141
142 See the [[Security Guide>>Documentation.AdminGuide.Security]].
143
144 = HTTPS/SSL =
145
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//.
147
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:
149 * [[Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]]
150
151 = Customizing Menus =
152
153 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.
154
155 = Encoding =
156
157 See the [[Encoding Guide>>Documentation.AdminGuide.Configuration.Encoding.WebHome]].
158
159 = User Authentication =
160
161 See the [[Authentication Guide>>Documentation.AdminGuide.Authentication.WebHome]].
162
163 == Customizing the Verified Registration Page (Since 2.2M2) ==
164
165 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.
166
167 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.
168
169 For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]].
170
171 = Initial Groups =
172
173 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:
174
175 (((
176 {{code language="none"}}
177 xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers
178 {{/code}}
179 )))
180
181 * Current members will not be automatically be added to these groups, only new members.
182 * The groups have to be created before being specified as initial groups.
183
184 = Logging =
185
186 See the [[Logging page>>Documentation.AdminGuide.Logging]].
187
188 = Configuring Interwiki links =
189
190 [[Interwiki linking>>http://en.wikipedia.org/wiki/InterWiki]] is a short hand syntax for linking to pages on other websites. For example, you could link to http://en.wikipedia.org/wiki/InterWiki just by typing ~[~[[email protected]]].
191
192 {{info}}
193 Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x.
194 {{/info}}
195
196 {{warning}}
197 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]].
198 {{/warning}}
199
200 == Interwiki links (XWiki Syntax 1.0) ==
201
202 Since XWiki renders wiki syntax using the [[Radeox>>http://codemonkeyism.com/forking-radeox-a-new-wiki-render-engine/]] engine, it supports Interwiki links in [[much the same way as SnipSnap>>http://snipsnap.org/space/InterWiki+HowTo]].
203
204 To configure Interwiki links on your wiki:
205
206 * Create a file named ##[location from where you start your container]/conf/**intermap.txt**##
207 * Fill ##intermap.txt## with content like:(((
208 {{code}}
209 IMDB http://us.imdb.com/Title?
210 OpenWiki http://openwiki.com/?
211 SourceForge http://sourceforge.net/
212 TWiki http://twiki.org/cgi-bin/view/
213 Why http://clublet.com/c/c/why?
214 Wiki http://c2.com/cgi/wiki?
215 WikiPedia http://www.wikipedia.com/wiki/
216 {{/code}}
217 )))You can of course add your own entries.
218
219 {{warning}}
220 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.
221 {{/warning}}
222
223 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.
224
225 == Interwiki links (XWiki Syntax 2.x) ==
226
227 In order to use Interwiki links in the XWiki Syntax 2.x it is necessary to configure the appropriate list in your ##xwiki.properties## file. Look for the following section:
228
229 {{code language="none"}}
230 #-# [Since 2.5M2]
231 #-# InterWiki definitions in the format alias=URL
232 #-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link
233 # Some examples:
234 # rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
235 # rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/
236 {{/code}}
237
238 = Link URLs =
239
240 With parameters, you can specify what type of links will be made by XWiki.
241
242 == Reverse proxy setup ==
243
244 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.
245
246 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.
247
248 * **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/}}}//
249 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.
250
251 * **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.
252
253 == Short URLs ==
254
255 It's possible to [[configure XWiki to use shorter URLs>>platform:Main.ShortURLs]].
256
257 = Configure the names of database schemas =
258
259 {{info}}Since 1.6M1{{/info}} Sometimes, especially in a complex environment, we need to control the names of database schemes, other than default.
260
261 * **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).
262 * **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.
263
264 = Controlling Page Tabs =
265
266 You can do this from the [[Administration>>extensions:Extension.Administration Application#HPresentation]].
267
268 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>>platform:DevGuide.Scripting#HControllingPageTabs]].
269
270 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:
271
272 {{code language="none"}}
273 #if (!$hasAdmin)
274 ## Hide tabs
275 #set($displayDocExtra = false)
276 ## Hide viewer shortcuts in the menu
277 #set ($displayShortcuts = false)
278 #end
279 {{/code}}
280
281 = Configure "Version Summary" behavior =
282
283 When you're editing a page you can add a brief description of your changes in the "Version Summary" field by default (look at [[platform:Features.PageEditing#HCommoneditactions]]). You can disable this feature by setting ##xwiki.editcomment=0## in ##xwiki.cfg##.
284
285 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//
286
287 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.
288
289 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//.
290
291 = Configuring Directories =
292
293 XWiki uses the following directories:
294
295 * 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.
296 * 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.
297
298 == Permanent Directory ==
299
300 To set the permanent directory, you have 2 options:
301
302 * Set the ##xwiki.data.dir## system property when starting the JVM (ie. the Servlet Container's JVM, specifically: ##-Dxwiki.data.dir=...##)
303 * Set the ##environment.permanentDirectory## property in your ##xwiki.properties## file
304
305 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.
306
307 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.
308
309 {{info}}
310 There are 2 ways to find out what's your current permanent directory:
311
312 * {{version since="9.10"}}Check the XWiki logs and look for the "Using permanent directory" string.{{/version}}
313 * Put the following in a wiki page (using the wiki editor). Beware that you'll need to have programming rights for this to work:
314 {{/info}}
315
316 List of sub-directories in the permanent directory:
317
318 * ##store##: Data stores
319 ** ##store/file##: Attachments ([[when they're saved on the filesystem>>platform: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).
320 ** ##store/solr##: Solr configurations and data that are not cache data (cache data for in ##cache##, see below).
321 * ##extension##: Installed extensions.
322 * ##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:
323 ** Solr search indexes
324 ** 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.
325 ** FOP Font cache
326 * ##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.
327 * ##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.
328 * ##jobs##: Logs and statuses of the various jobs that executed inside XWiki (e.g. when deleting a page or set of pages a job is used). It also contains the status of the Flavor which is setup as a job. Removing this directory can cause problems (it'll remove the status of the Flavor for example).
329 * ##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).
330 * {{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}}
331
332 == Temporary Directory ==
333
334 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 [[##java.io.tmpdir##>>http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties()]] System property. If this is not a writable directory, an exception will be thrown.
335
336 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 [[##java.io.tmpdir##>>http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties()]] System property.
337
338 {{info}}
339 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:
340 {{/info}}
341
342 = Configuring WebDAV (since 1.7) =
343
344 WebDAV support has been added to XWiki beginning with XWiki 1.7. It is very important to note that WebDAV is enabled by default.
345
346 == Securing WebDAV Server ==
347
348 XWiki's WebDAV implementation only supports the [[Basic Access Authentication>>http://en.wikipedia.org/wiki/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.
349
350 == Disabling WebDAV ==
351
352 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:
353
354 {{code language="xml"}}
355 <servlet-mapping>
356 <servlet-name>webdav</servlet-name>
357 <url-pattern>/webdav/*</url-pattern>
358 </servlet-mapping>
359 {{/code}}
360
361 = Redirections =
362
363 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}}.
364 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.
365
366 = Customizing the PDF export Look & Feel =
367
368 {{info}}
369 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.
370 {{/info}}
371
372 Here's how the PDF and RTF exports currently work:
373 {{image reference="XWikiExport201010290119.png"/}}
374
375 As shown in the diagram you can customize 4 parts:
376
377 * 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
378 * 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
379 * 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.
380 * The FOP XSL transformation. The default one, ##fop.xsl##, is also packed in a core jar.
381
382 After the export request triggers XWiki ExportAction, the content of your document is parsed by Velocity to get the initial XHTML content. **[[JTidy>>http://jtidy.sourceforge.net/]]**, 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.
383
384 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>>platform:DevGuide.DataModel]]. To do that simply create a new page called //XWiki.PDFClass// and edit it in class mode (for ex. //{{{http://yourserver.com/xwiki/bin/edit/XWiki/PDFClass?editor=class}}}//). Add the following "Text Area" properties as needed (they are all optional so you only need to define the ones you need to use):
385
386 * ##style##: contains the CSS information that will overwrite or complement the default ##pdf.css## values if they exist. **[[css4j>>https://css4j.github.io/]]**, a CSS API implementation for the Java™ platform, will take care of this.
387 * ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one. It is processed by **[[Apache Xalan>>http://xml.apache.org/xalan-j/]]**, a XSLT processor for transforming XML documents into HTML, text, or other XML document types. Since version 3.0M2 (see issue [[XWIKI-5918>>https://jira.xwiki.org/browse/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)
388 * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. It is processed by **[[Apache FOP>>http://xmlgraphics.apache.org/fop/]]**.
389
390 {{warning}}
391 The name of the class must be ##XWiki.PDFClass##.
392 {{/warning}}
393
394 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.
395
396 Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
397
398 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}}}//.
399
400 {{warning}}
401 No template is used by default.
402 {{/warning}}
403
404 {{info}}
405 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:
406
407 {{code language="css"}}
408 #template('colorThemeInit.vm')
409 h2 {
410 color: $theme.titleColor;
411 }
412
413 td {
414 border-color: $theme.borderColor;
415 }
416
417 h1, .my_Page_break {
418 page-break-before:always;
419 }
420
421 {{/code}}
422 {{/info}}
423
424 = Override the PDF Templates =
425
426 == Customize the PDF Footer ==
427
428 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##:
429
430 {{image reference="OverridePDFFooter.png"/}}
431
432 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:
433
434 {{image reference="OverridePDFFooterEdit1.png"/}}
435
436 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:
437
438 {{code}}
439 $msg.Page <span class="page-number"></span> - $msg.get('lastmodifiedby')
440 $xwiki.getUserName($tdoc.author, false)
441 $msg.get('lastmodifiedon')
442 $!xwiki.formatDate($tdoc.date)
443 <div>
444 <p>CustomName SAS. All rights reserved. Confidential and proprietary document. Printed Copies are not controlled.</p>
445 </div>
446 {{/code}}
447
448 To see the changes, just export any wiki page:
449
450 {{image reference="OverridePDFFooterFinal.png"/}}
451
452 == Customize the PDF Cover ==
453
454 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}}}//).
455
456 {{image reference="OverridePDFCover.png"/}}
457
458 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:
459
460 {{code}}
461 <img src="$xwiki.getSkinFile("logo.png")"/>
462
463 <div style="text-align: center; width: 100%;">
464 <h1>
465 #set($title = "$!pdfdoc.display('title', 'rendered')")
466 #if($title == '')
467 $escapetool.xml($!doc.displayTitle)
468 #else
469 $escapetool.xml($title)
470 #end
471 </h1>
472 <br />
473 <br />
474 $!xwiki.getUserName($tdoc.author, false)
475 <br />
476 $!xwiki.formatDate($tdoc.date)
477 </div>
478 {{/code}}
479
480 The last step consists of attaching the image "logo.png" to the skin:
481
482 {{image reference="OverridePDFCoverFinal.png"/}}
483
484 == Override the CSS rules ==
485
486 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:
487
488 * ##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
489 * ##xhtmlxsl##: contains the XHTML2FO XSL transformation that will override the default one
490 * ##fopxsl##: contains the FOP XSL transformation that will override the default one
491
492 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.
493
494 {{image reference="CreatePDFClass.png"/}}
495
496 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.
497
498 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:
499
500 {{code}}
501 (% class="mytable" %)
502 |=Column 1|=Column 2
503 | data|data
504 {{/code}}
505
506 Next, edit the template page (e.g. XWiki.PDFTemplate) in "Objects" mode and write your own CSS rules in the "style" property:
507
508 {{image reference="CreatePDFTemplate.png"/}}
509
510 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}}}//.
511
512 {{image reference="SandboxTestPage1PDF.png" width="700"/}}
513
514 **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.
515
516 {{info}}
517 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.
518 {{/info}}
519
520 {{warning}}
521 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>>https://xmlgraphics.apache.org/fop/compliance.html]].
522 Furthermore, you can not use multiple attributes to select a CSS element (see issue: [[XWIKI-14653>>https://jira.xwiki.org/browse/XWIKI-14653]]).
523 {{/warning}}
524
525 == Override the xhtml2fo.xsl rules ==
526
527 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.
528
529 For example, to disable the generation of clickable URLs in the PDF, modify the following section:
530 {{code}} <xsl:template match="html:a[@href]" mode="transform">
531 <fo:basic-link xsl:use-attribute-sets="a-link">
532 <xsl:call-template name="process-a-link"/>
533 </fo:basic-link>
534 </xsl:template>{{/code}}
535 as
536 {{code}} <xsl:template match="html:a[@href]" mode="transform">
537 <fo:inline>
538 <xsl:call-template name="process-a-link"/>
539 </fo:inline>
540 </xsl:template>{{/code}}
541 or disable the generation of clickable URLs for some specific href links in the PDF
542 {{code}} <xsl:template match="html:a[@href]" mode="transform">
543 <xsl:choose>
544 <!-- disable these internal links ("data-parent" attribute start with "#accordion" or href is "#my_anchor") -->
545 <xsl:when test="starts-with(@data-parent,'#accordion') or @href = '#my_anchor'">
546 <fo:inline>
547 <xsl:call-template name="process-a-link"/>
548 </fo:inline>
549 </xsl:when>
550 <xsl:otherwise>
551 <fo:basic-link xsl:use-attribute-sets="a-link">
552 <xsl:call-template name="process-a-link"/>
553 </fo:basic-link>
554 </xsl:otherwise>
555 </xsl:choose>
556
557 </xsl:template>{{/code}}
558
559 == Debugging PDF export ==
560
561 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:
562
563 {{code language="none"}}
564 DEBUG c.x.x.p.i.PdfExportImpl - Cleaning HTML: //(show XHTML code without style)//
565 DEBUG c.x.x.p.i.PdfExportImpl - Cleaned XHTML:
566 DEBUG c.x.x.p.i.PdfExportImpl - Applying the following CSS: //(show CSS properties)//
567 DEBUG c.x.x.p.i.PdfExportImpl - HTML with CSS applied: //(show HTML code with CSS properties merged in tag with "style=" )//
568 DEBUG c.x.x.p.i.PdfExportImpl - Final XHTML for export:
569 DEBUG c.x.x.p.i.PdfExportImpl - Intermediary XSL-FO: //(show document with eXtensible Stylesheet Language - Formatting Objects used to generate PDF files)//
570 DEBUG c.x.x.p.i.PdfExportImpl - Final XSL-FO source:
571 and finally DEBUG c.x.x.p.i.PdfExportImpl - PageSequence x-page-sequence generated 3 pages.
572 {{/code}}
573
574 = Configuring Wiki Syntaxes and default Syntax =
575
576 To know how to configure the [[Wiki syntaxes>>platform:Main.XWikiSyntax]] that are available to the user when writing wiki pages, check the [[Rendering Administration Application>>extensions:Extension.Rendering Administration Application]].
577
578 = Title behavior =
579
580 The following configuration parameters (found in ##xwiki.cfg##) can be used to control title behavior:
581
582 {{code language="none"}}
583 #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
584 #-# mode is active, XWiki will try to extract a title from the document content.
585 #-# If the document's content first header (level 1 or level 2) matches the document's title
586 #-# the first header is stripped.
587 #-# The default value is 0.
588 # xwiki.title.compatibility=1
589
590 #-# Defines the maximum header depth to look for when computing a document's title from its content. If no header
591 #-# equal or lower to the specified depth is found then the computed title falls back to the document name.
592 #-# The default value is 2.
593 # xwiki.title.headerdepth=2
594
595 #-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this
596 #-# property is set to 1. The default value is 0 (not mandatory).
597 # xwiki.title.mandatory=0
598 {{/code}}
599
600 = Link Label Generation =
601
602 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. ##[[platform:Main.WebHome]]##).
603
604 Her's an extract from the ##xwiki.properties## file which is where this feature is configurable:
605
606 {{code language="none"}}
607 #-# [Since 1.8RC2]
608 #-# Specifies how links labels are displayed when the user doesn't specify the label explicitly.
609 #-# Valid values:
610 #-# %w: wiki name
611 #-# %s: full space name (e.g. space1.space2)
612 #-# Note: Prior to 7.4.2/8.0M2 this was only displaying the last space name
613 #-# %ls: last space name. New in 7.4.2/8.0M2
614 #-# %p: page name
615 #-# %np: nested page name (i.e. will display the space name for Nested Pages). New in 7.4.2/8.0M2
616 #-# %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage"
617 #-# %NP: nested page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage".
618 #-# New in 7.4.2/8.0M2
619 #-# %t: page title
620 #-#
621 #-# Note that if the page title is empty or not defined then it defaults to %np. This is also the case
622 #-# if the title cannot be retrieved for the document.
623 #-#
624 #-# The default is "%np". Some examples: "%s.%p", "%w:%s.%p".
625 # rendering.linkLabelFormat = %np
626 {{/code}}
627
628 = Rendering Cache =
629
630 See the [[Performance page>>Documentation.AdminGuide.Performances.WebHome#HRenderingcache]].
631
632 = Allowed Pages for Inactive Users =
633
634 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.
635
636 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).
637
638 {{info}}
639 Inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.
640 {{/info}}
641
642 = Rendering Transformations =
643
644 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 ##xwiki.properties##:
645
646 {{code language="none"}}
647 #-# [Since 2.6RC1]
648 #-# Controls what transformations will be executed when rendering content.
649 #-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with
650 #-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.
651 #-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the
652 #-# macro execution. If you don't list it, macros won't get executed.
653 #-# The default value is: rendering.transformations = macro, icon
654 {{/code}}
655
656 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}}.
657
658 = Securing Groovy Scripts =
659
660 See:
661
662 * The [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]]
663 * The [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]]
664
665 = Lock Duration =
666
667 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.
668
669 In order to increase this duration, you have 2 options:
670
671 * 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##.
672 * Or add the configuration in the wiki itself:
673 ** Edit the ##XWiki.XWikiPreferences## document using the class editor
674 ** Add a Number property named ##lock_Timeout## (case sensitive)
675 ** Edit the ##XWiki.XWikiPreferences## document using the object editor
676 ** Find the ##lock_Timeout## property and put the desired number of *seconds* a lock should be valid for
677 ** Don't forget to save the document
678
679 = Editing =
680
681 == Default editor ==
682
683 You can choose the default editor to use from "Configuration > Edit Mode Settings" (see below). You can also configure the default WYSIWYG editor to use ({{info}}XWiki 8.2{{/info}}).
684
685 {{image reference="DefaultEditorStarting30.png" width="45%"/}} {{image reference="default-wysiwyg-config.png" width="45%"/}}
686
687 == Default WYSIWYG editor ==
688
689 See the [[WYSIWYG Editor Configuration>>extensions:Extension.CKEditor Integration.WebHome#HConfiguretheEditor]] page to find out how you can enable or disable editing features.
690
691 == Section Editing ==
692
693 By default section editing is limited to level 1 and level 2 sections. This can be controlled by editing ##xwiki.cfg##:
694
695 {{code}}
696 #-# This parameter controls the depth of sections that have section editing.
697 #-# By default level 1 and level 2 sections have section editing.
698 xwiki.section.depth=2
699 {{/code}}
700
701 You can also enable/disable section editing with:
702
703 {{code}}
704 #-# This parameter will activate the sectional editing.
705 xwiki.section.edit=1
706 {{/code}}
707
708 == Editing Conflicts ==
709
710 The [[Edit Conflict feature>>]] can be disabled ({{info}}XWiki 11.3.2{{/info}} and {{info}}XWiki 11.6RC1{{/info}}) from the ##xwiki.properties## file by setting ##edit.conflictChecking.enabled = false##:
711
712 {{code language="none"}}
713 #-# [Since 11.3.2, 11.6RC1]
714 #-# Indicate if the mechanism to detect and handle edition conflicts should be enabled or not.
715 #-# If disabled, it means that in case of edition conflicts, the latest save will be always take into account, and
716 #-# erase previous data (which can always be recovered in the history of the document).
717 #-# This option is provided because the feature is still experimental and it could be useful is some specific usecases
718 #-# to switch it off. However it is not recommended to do so.
719 #-#
720 #-# The default is:
721 # edit.conflictChecking.enabled = true
722 {{/code}}
723
724 == In-place Editing ==
725
726 To disable the in-place WYSIWYG editing mode (and thus default to the Standalone WYSIWYG editing mode), modify the ##xwiki.properties## file and set ##edit.document.inPlaceEditing.enabled = false## ({{info}}XWiki 12.5{{/info}}):
727
728 {{code language="none"}}
729 #-# [Since 12.5]
730 #-# Indicate if the XWiki documents should be edited in-place, without leaving the view mode, whenever possible (e.g. if
731 #-# the default edit mode for that document and the preferred editor both support in-place editing). When enabled,
732 #-# clicking on the document Edit button makes the document title and content editable in-place, without leaving the
733 #-# view mode. When disabled, clicking on the document Edit button loads the default (stand-alone) edit mode for that
734 #-# document.
735 #-#
736 #-# The default is:
737 # edit.document.inPlaceEditing.enabled = true
738 {{/code}}
739
740 = Delete Pages =
741
742 {{version since="12.9RC1"}}
743 This section is hidden when the [[recycle bin is not activated>>||anchor="HDocumentrecyclebin"]].
744 {{/version}}
745
746 == Enabling Advanced users to skip the recycle bin ==
747
748 {{version since="12.8RC1"}}
749 Advanced users can be allowed choose if they want to skip the recycle bin (and remove the pages permanently) when deleting pages.
750
751 To do so, search for the "Delete" section and set "can skip the recycle bin" to Yes. The default value is No.
752
753 [[image:skip_recycle_bin_admin_cropped.png]]
754 {{/version}}
755
756 Advanced users can be allowed choose if they want to skip the recycle bin (and remove the pages permanently) when deleting pages.
757
758 To do so, search for the "Delete" section and set "can skip the recycle bin" to Yes. The default value is No.
759
760 [[image:skip_recycle_bin_admin_cropped.png]]
761
762 {{version since="12.9RC1"}}
763 The configuration is resolved by looking in three locations, from the most specific to the least specific:
764
765 * In the configuration of the current wiki
766 * In the configuration of the main wiki
767 * In ##xwiki.properties## (see the property details below)
768
769 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.
770
771 Details of the configuration on ##xwiki.properties##:
772
773 {{code language="none"}}
774 #-# [Since 12.9RC1]
775 #-# Indicates whether skipping the recycle bin when deleting pages is allowed for Advanced users.
776 #-# It is disabled by default.
777 #-# This setting is only used if the wiki has a recycle bin activated (xwiki.recyclebin=1 in xwiki.cfg).
778 #-# This setting can be overloaded:
779 #-# * By the main wiki in the Refactoring.Code.RefactoringConfigurationClass class of the
780 #-# Refactoring.Code.RefactoringConfiguration document of the main wiki.
781 #-# * By sub-wikis in the Refactoring.Code.RefactoringConfigurationClass class of the
782 #-# Refactoring.Code.RefactoringConfiguration document of the sub-wikis (itself overloading the main wiki's
783 #-# configuration).
784 #-#
785 #-# The default value is:
786 # refactoring.isRecycleBinSkippingActivated = false
787 {{/code}}
788 {{/version}}
789
790 = Sample xwiki.cfg =
791
792 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.cfg.vm"}}xwiki.cfg.vm{{/scm}}
793
794 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.
795
796 = Sample xwiki.properties =
797
798 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.properties.vm"}}xwiki.properties.vm{{/scm}}
799
800 Note that we generate the default ##xwiki.properties## 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