Wiki source code of Configuration

Version 189.1 by Vincent Massol on 2018/11/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 enter the language code for the language you wish to use. For example: "en" for English, "fr" for French, "de" for German, etc.
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 and set to 1:
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.
43 # xwiki.language.forceSupported=0
44 {{/code}}
45
46 = Date format =
47
48 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:
49
50 |=Format|=Result
51 |MMMM dd, HH:mm|January 27, 12:27
52 |yyyy/MM/dd, HH:mm|2009/01/27, 12:27
53 |dd/MM/yyyy, HH:mm|27/01/2009, 12:27
54
55 [[More information about date formatting>>http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html]].
56
57 = Enabling/Disabling Statistics =
58
59 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##):
60
61 {{code}}
62 xwiki.stats=0
63 xwiki.stats.default=0
64 {{/code}}
65
66 where:
67
68 * ##xwiki.stats## controls whether statistics are on or off
69 * ##xwiki.stats.default## controls whether statistics are on or off by default for the current Wiki. This is useful in [[Virtual 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.(((
70 {{info}}
71 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:
72 * 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}}}//
73 * 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##
74 {{/info}}
75 )))
76
77 = Optional Store Features =
78
79 == Document versioning ==
80
81 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.
82
83 To disable versioning edit //xwiki.cfg// and add {{code}}xwiki.store.versioning=0{{/code}}.
84
85 [[Attachment versioning>>Documentation.AdminGuide.Attachments#HVersions]] is also available and turned on by default.
86
87 == Document recycle bin ==
88
89 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}}.
90
91 {{info}}
92 Disabling the recycle bin will make it impossible to restore a deleted document, unless a database backup is available.
93 {{/info}}
94
95 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:
96
97 {{code}}
98 # Admins must wait 3 days before being allowed to permanently delete
99 xwiki.store.recyclebin.adminWaitDays=3
100 # Normal users must also wait 3 days
101 xwiki.store.recyclebin.waitDays=3
102 {{/code}}
103
104 [[Attachment recycle bin>>Documentation.AdminGuide.Attachments#HDeletion]] is similar.
105
106 = Customizing error pages =
107
108 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:
109
110 * ##XWiki.WikiDoesNotExist##,
111 * ##XWiki.DocumentDoesNotExist##,
112 * ##XWiki.AttachmentDoesNotExist##,
113 * ##XWiki.AccessDenied##
114
115 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.
116
117 = Customizing the Skin =
118
119 See the [[Skin Guide>>Documentation.AdminGuide.Skins]].
120
121 = Security configuration =
122
123 See the [[Security Guide>>Documentation.AdminGuide.Security]].
124
125 By default the protocol to use to generate external URLs (https, http) is extracted from request 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//.
126
127 = Customizing Menus =
128
129 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.
130
131 = Encoding =
132
133 See the [[Encoding Guide>>Documentation.AdminGuide.Configuration.Encoding.WebHome]].
134
135 = User Authentication =
136
137 See the [[Authentication Guide>>Documentation.AdminGuide.Authentication.WebHome]].
138
139 == Customizing the Verified Registration Page (Since 2.2M2) ==
140
141 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.
142
143 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.
144
145 For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]].
146
147 = Initial Groups =
148
149 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:
150
151 (((
152 {{code language="none"}}
153 xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers
154 {{/code}}
155 )))
156
157 * Current members will not be automatically be added to these groups, only new members.
158 * The groups have to be created before being specified as initial groups.
159
160 = Logging =
161
162 See the [[Logging page>>Documentation.AdminGuide.Logging]].
163
164 = Configuring Interwiki links =
165
166 [[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 ~[~[InterWiki@WikiPedia]].
167
168 {{info}}
169 Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x.
170 {{/info}}
171
172 {{warning}}
173 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~]~].
174 {{/warning}}
175
176 == Interwiki links (XWiki Syntax 1.0) ==
177
178 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]].
179
180 To configure Interwiki links on your wiki:
181
182 * Create a file named ##[location from where you start your container]/conf/**intermap.txt**##
183 * Fill ##intermap.txt## with content like:(((
184 {{code}}
185 IMDB http://us.imdb.com/Title?
186 OpenWiki http://openwiki.com/?
187 SourceForge http://sourceforge.net/
188 TWiki http://twiki.org/cgi-bin/view/
189 Why http://clublet.com/c/c/why?
190 Wiki http://c2.com/cgi/wiki?
191 WikiPedia http://www.wikipedia.com/wiki/
192 {{/code}}
193 )))You can of course add your own entries.
194
195 {{warning}}
196 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.
197 {{/warning}}
198
199 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.
200
201 == Interwiki links (XWiki Syntax 2.x) ==
202
203 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:
204
205 {{code language="none"}}
206 #-# [Since 2.5M2]
207 #-# InterWiki definitions in the format alias=URL
208 #-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link
209 # Some examples:
210 # rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
211 # rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/
212 {{/code}}
213
214 = Setting the default editor to use (Wiki or WYSIWYG) =
215
216 Starting with XWiki 3.0, which introduced a revamp of the Administration, you can choose the default editor from "Configuration > Edit Mode Settings" (see below). Starting with XWiki 8.2 you can also configure the default WYSIWYG editor.
217
218 {{image reference="DefaultEditorStarting30.png" width="45%"/}} {{image reference="default-wysiwyg-config.png" width="45%"/}}
219
220 = Configure the WYSIWYG editor =
221
222 See the [[WYSIWYG Editor Configuration>>extensions:Extension.CKEditor Integration.WebHome#HConfiguretheEditor]] page to find out how you can enable or disable editing features.
223
224 = Link URLs =
225
226 With parameters, you can specify what type of links will be made by XWiki.
227
228 == Reverse proxy setup ==
229
230 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.
231
232 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.
233
234 * **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/}}}//
235 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.
236
237 * **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.
238
239 == Short URLs ==
240
241 It's possible to [[configure XWiki to use shorter URLs>>platform:Main.ShortURLs]].
242
243 = Configure the names of database schemas =
244
245 {{info}}Since 1.6M1{{/info}} Sometimes, especially in a complex environment, we need to control the names of database schemes, other than default.
246
247 * **xwiki.db**: name of database schema for the main wiki (including the name of the wiki in a non-virtual environment, otherwise the database name comes from the hibernate configuration file).
248 * **xwiki.db.prefix**: useful mainly for [[virtual wikis>>Documentation.AdminGuide.Virtualization.WebHome]], where we have a separate database schema for each virtual 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.
249
250 = Controlling Page Tabs =
251
252 You can do this from the [[Administration>>extensions:Extension.Administration Application#HPresentation]].
253
254 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]].
255
256 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:
257
258 {{code language="none"}}
259 #if (!$hasAdmin)
260 ## Hide tabs
261 #set($displayDocExtra = false)
262 ## Hide viewer shortcuts in the menu
263 #set ($displayShortcuts = false)
264 #end
265 {{/code}}
266
267 = Configure "Version Summary" behavior =
268
269 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##.
270
271 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//
272
273 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.
274
275 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//.
276
277 = Configuring Directories =
278
279 XWiki uses the following directories:
280
281 * 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.
282 * 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.
283
284 To set the permanent directory, you have 2 options:
285
286 * Set the ##xwiki.data.dir## system property when starting the JVM (ie. the Servlet Container's JVM, specifically: ##-Dxwiki.data.dir=...##)
287 * Set the ##environment.permanentDirectory## property in your ##xwiki.properties## file
288
289 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.
290
291 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.
292
293 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 [[java.io.tmpdir>>http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties()]]. If this is not a writable directory, an exception will be thrown.
294
295 {{info}}
296 There are 2 ways to find out what's your current permanent directory:
297 * (since XWiki 9.10) Check the XWiki logs and look for the "Using permanent directory" string.
298 * Put the following in a wiki page (using the wiki editor). Beware that you'll need to have programming rights for this to work:(((
299 {{code language="none"}}
300 {{velocity}}
301 $services.component.getInstance('org.xwiki.environment.Environment').getPermanentDirectory()
302 {{/velocity}}
303 {{/code}}
304 )))
305 {{/info}}
306
307 = Configuring WebDAV (since 1.7) =
308
309 WebDAV support has been added to XWiki beginning with XWiki 1.7. It is very important to note that WebDAV is enabled by default.
310
311 == Securing WebDAV Server ==
312
313 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.
314
315 == Disabling WebDAV ==
316
317 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:
318
319 {{code language="xml"}}
320 <servlet-mapping>
321 <servlet-name>webdav</servlet-name>
322 <url-pattern>/webdav/*</url-pattern>
323 </servlet-mapping>
324 {{/code}}
325
326 = Redirections =
327
328 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}}.
329 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.
330
331 = Customizing the PDF export Look & Feel =
332
333 {{info}}
334 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.
335 {{/info}}
336
337 Here's how the PDF and RTF exports currently work:
338 {{image reference="XWikiExport201010290119.png"/}}
339
340 As shown in the diagram you can customize 4 parts:
341
342 * 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
343 * 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
344 * 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 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.
345 * The FOP XSL transformation. The default one, fop.xsl, is also packed in core jar.
346
347 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.
348
349 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):
350
351 * ##style##: contains the CSS information that will overwrite or complement the default ##pdf.css## values if they exist. **[[css4j>>http://www.informatica.info/projects/css/]]**, a CSS API implementation for the Java&trade platform, will take care of this
352 * ##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)
353 * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. It is processed by **[[Apache FOP>>http://xmlgraphics.apache.org/fop/]]**.
354
355 {{warning}}
356 The name of the class must be ##XWiki.PDFClass##.
357 {{/warning}}
358
359 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.
360
361 Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
362
363 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}}}//.
364
365 {{warning}}
366 No template is used by default.
367 {{/warning}}
368
369 {{info}}
370 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:
371
372 {{code language="css"}}
373 #template('colorThemeInit.vm')
374 h2 {
375 color: $theme.titleColor;
376 }
377
378 td {
379 border-color: $theme.borderColor;
380 }
381
382 h1, .my_Page_break {
383 page-break-before:always;
384 }
385
386 {{/code}}
387 {{/info}}
388
389 = Override the PDF Templates =
390
391 == Customize the PDF Footer ==
392
393 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##:
394
395 {{image reference="OverridePDFFooter.png"/}}
396
397 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:
398
399 {{image reference="OverridePDFFooterEdit1.png"/}}
400
401 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:
402
403 {{code}}
404 $msg.Page <span class="page-number"></span> - $msg.get('lastmodifiedby')
405 $xwiki.getUserName($tdoc.author, false)
406 $msg.get('lastmodifiedon')
407 $!xwiki.formatDate($tdoc.date)
408 <div>
409 <p>CustomName SAS. All rights reserved. Confidential and proprietary document. Printed Copies are not controlled.</p>
410 </div>
411 {{/code}}
412
413 To see the changes, just export any wiki page:
414
415 {{image reference="OverridePDFFooterFinal.png"/}}
416
417 == Customize the PDF Cover ==
418
419 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}}}//).
420
421 {{image reference="OverridePDFCover.png"/}}
422
423 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:
424
425 {{code}}
426 <img src="$xwiki.getSkinFile("logo.png")"/>
427
428 <div style="text-align: center; width: 100%;">
429 <h1>
430 #set($title = "$!pdfdoc.display('title', 'rendered')")
431 #if($title == '')
432 $escapetool.xml($!doc.displayTitle)
433 #else
434 $escapetool.xml($title)
435 #end
436 </h1>
437 <br />
438 <br />
439 $!xwiki.getUserName($tdoc.author, false)
440 <br />
441 $!xwiki.formatDate($tdoc.date)
442 </div>
443 {{/code}}
444
445 The last step consists of attaching the image "logo.png" to the skin:
446
447 {{image reference="OverridePDFCoverFinal.png"/}}
448
449 == Override the CSS rules ==
450
451 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:
452
453 * ##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
454 * ##xhtmlxsl##: contains the XHTML2FO XSL transformation that will override the default one
455 * ##fopxsl##: contains the FOP XSL transformation that will override the default one
456
457 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.
458
459 {{image reference="CreatePDFClass.png"/}}
460
461 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.
462
463 Supposing your wiki page contains a table, you have to edit it in "Wiki" mode and add a style parameter as shown below:
464
465 {{code}}
466 (% class="mytable" %)
467 |=Column 1|=Column 2
468 | data|data
469 {{/code}}
470
471 Next, edit the page in "Objects" mode and write your own CSS rules in the "style" property:
472
473 {{image reference="CreatePDFTemplate.png"/}}
474
475 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/XWiki/PDFTemplate?format=pdf&pdftemplate=XWiki.PDFTemplate}}}//.
476
477 {{image reference="CustomizedPDF.png"/}}
478
479 {{info}}
480 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.
481 {{/info}}
482
483 {{warning}}
484 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]].
485 Furthermore, you can not use multiple attributes to select a CSS element (see issue: [[XWIKI-14653>>https://jira.xwiki.org/browse/XWIKI-14653]]).
486 {{/warning}}
487
488 == Override the xhtml2fo.xsl rules ==
489
490 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.
491
492 For example, to disable the generation of clickable URLs in the PDF, modify the following section:
493 {{code}} <xsl:template match="html:a[@href]" mode="transform">
494 <fo:basic-link xsl:use-attribute-sets="a-link">
495 <xsl:call-template name="process-a-link"/>
496 </fo:basic-link>
497 </xsl:template>{{/code}}
498 as
499 {{code}} <xsl:template match="html:a[@href]" mode="transform">
500 <fo:inline>
501 <xsl:call-template name="process-a-link"/>
502 </fo:inline>
503 </xsl:template>{{/code}}
504 or disable the generation of clickable URLs for some specific href links in the PDF
505 {{code}} <xsl:template match="html:a[@href]" mode="transform">
506 <xsl:choose>
507 <!-- disable these internal links ("data-parent" attribute start with "#accordion" or href is "#my_anchor") -->
508 <xsl:when test="starts-with(@data-parent,'#accordion') or @href = '#my_anchor'">
509 <fo:inline>
510 <xsl:call-template name="process-a-link"/>
511 </fo:inline>
512 </xsl:when>
513 <xsl:otherwise>
514 <fo:basic-link xsl:use-attribute-sets="a-link">
515 <xsl:call-template name="process-a-link"/>
516 </fo:basic-link>
517 </xsl:otherwise>
518 </xsl:choose>
519
520 </xsl:template>{{/code}}
521
522 == Debugging PDF export ==
523
524 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:
525
526 {{code language="none"}}
527 DEBUG c.x.x.p.i.PdfExportImpl - Cleaning HTML: //(show XHTML code without style)//
528 DEBUG c.x.x.p.i.PdfExportImpl - Cleaned XHTML:
529 DEBUG c.x.x.p.i.PdfExportImpl - Applying the following CSS: //(show CSS properties)//
530 DEBUG c.x.x.p.i.PdfExportImpl - HTML with CSS applied: //(show HTML code with CSS properties merged in tag with "style=" )//
531 DEBUG c.x.x.p.i.PdfExportImpl - Final XHTML for export:
532 DEBUG c.x.x.p.i.PdfExportImpl - Intermediary XSL-FO: //(show document with eXtensible Stylesheet Language - Formatting Objects used to generate PDF files)//
533 DEBUG c.x.x.p.i.PdfExportImpl - Final XSL-FO source:
534 and finally DEBUG c.x.x.p.i.PdfExportImpl - PageSequence x-page-sequence generated 3 pages.
535 {{/code}}
536
537 = Configuring Wiki Syntaxes and default Syntax =
538
539 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]].
540
541 = Title behavior =
542
543 The following configuration parameters (found in ##xwiki.cfg##) can be used to control title behavior:
544
545 {{code language="none"}}
546 #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
547 #-# mode is active, XWiki will try to extract a title from the document content.
548 #-# If the document's content first header (level 1 or level 2) matches the document's title
549 #-# the first header is stripped.
550 #-# The default value is 0.
551 # xwiki.title.compatibility=1
552
553 #-# Defines the maximum header depth to look for when computing a document's title from its content. If no header
554 #-# equal or lower to the specified depth is found then the computed title falls back to the document name.
555 #-# The default value is 2.
556 # xwiki.title.headerdepth=2
557
558 #-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this
559 #-# property is set to 1. The default value is 0 (not mandatory).
560 # xwiki.title.mandatory=0
561 {{/code}}
562
563 = Link Label Generation =
564
565 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]]##).
566
567 Her's an extract from the ##xwiki.properties## file which is where this feature is configurable:
568
569 {{code language="none"}}
570 #-# [Since 1.8RC2]
571 #-# Specifies how links labels are displayed when the user doesn't specify the label explicitly.
572 #-# Valid values:
573 #-# %w: wiki name
574 #-# %s: full space name (e.g. space1.space2)
575 #-# Note: Prior to 7.4.2/8.0M2 this was only displaying the last space name
576 #-# %ls: last space name. New in 7.4.2/8.0M2
577 #-# %p: page name
578 #-# %np: nested page name (i.e. will display the space name for Nested Pages). New in 7.4.2/8.0M2
579 #-# %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage"
580 #-# %NP: nested page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage".
581 #-# New in 7.4.2/8.0M2
582 #-# %t: page title
583 #-#
584 #-# Note that if the page title is empty or not defined then it defaults to %np. This is also the case
585 #-# if the title cannot be retrieved for the document.
586 #-#
587 #-# The default is "%np". Some examples: "%s.%p", "%w:%s.%p".
588 # rendering.linkLabelFormat = %np
589 {{/code}}
590
591 = Rendering Cache =
592
593 See the [[Performance page>>Documentation.AdminGuide.Performances.WebHome#HRenderingcache]].
594
595 = Allowed Pages for Inactive Users =
596
597 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.
598
599 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).
600
601 {{info}}
602 Inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.
603 {{/info}}
604
605 = Rendering Transformations =
606
607 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##:
608
609 {{code language="none"}}
610 #-# [Since 2.6RC1]
611 #-# Controls what transformations will be executed when rendering content.
612 #-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with
613 #-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.
614 #-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the
615 #-# macro execution. If you don't list it, macros won't get executed.
616 #-# The default value is: rendering.transformations = macro, icon
617 {{/code}}
618
619 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}}.
620
621 = Securing Groovy Scripts =
622
623 See:
624
625 * The [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]]
626 * The [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]]
627
628 = Lock Duration =
629
630 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.
631
632 In order to increase this duration, you have 2 options:
633
634 * 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##.
635 * Or add the configuration in the wiki itself:
636 ** Edit the ##XWiki.XWikiPreferences## document using the class editor
637 ** Add a Number property named ##lock_Timeout## (case sensitive)
638 ** Edit the ##XWiki.XWikiPreferences## document using the object editor
639 ** Find the ##lock_Timeout## property and put the desired number of *seconds* a lock should be valid for
640 ** Don't forget to save the document
641
642 = Section Editing =
643
644 By default section editing is limited to level 1 and level 2 sections. This can be controlled by editing ##xwiki.cfg##:
645
646 {{code}}
647 #-# This parameter controls the depth of sections that have section editing.
648 #-# By default level 1 and level 2 sections have section editing.
649 xwiki.section.depth=2
650 {{/code}}
651
652 You can also enable/disable section editing with:
653
654 {{code}}
655 #-# This parameter will activate the sectional editing.
656 xwiki.section.edit=1
657 {{/code}}
658
659 = Sample xwiki.cfg =
660
661 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.cfg.vm"}}xwiki.cfg.vm{{/scm}}
662
663 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.
664
665 = Sample xwiki.properties =
666
667 See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.properties.vm"}}xwiki.properties.vm{{/scm}}
668
669 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.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected