Wiki source code of Configuration

Version 201.1 by Vincent Massol on 2020/03/12

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

Wiki source code of Configuration

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected