Wiki source code of Configuration

Version 163.3 by Vincent Massol on 2017/01/27

version	line-number	content
61.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
60.2	4
124.1	5	Once you have XWiki [[installed>>Installation]] 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
140.2	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.
12.1	32
140.2	33	In addition you can configure your wiki to be multilingual. See the [[I18 user page>>Features.I18N]] for more information.
12.2	34
51.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 and set to 1:
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
	42	#-# Force only one of the supported languages to be accepted.
	43	# xwiki.language.forceSupported=0
51.1	44	{{/code}}
43.1	45
53.1	46	= Date format =
36.1	47
140.2	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:
36.1	49
51.1	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
36.1	54
140.2	55	[[More information about date formatting>>http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html]].
36.2	56
53.1	57	= Enabling/Disabling Statistics =
1.1	58
140.2	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##):
1.1	60
140.1	61	{{code}}
	62	xwiki.stats=0
	63	xwiki.stats.default=0
	64	{{/code}}
	65
1.10	66	where:
141.1	67
140.2	68	* ##xwiki.stats## controls whether statistics are on or off
141.1	69	* ##xwiki.stats.default## controls whether statistics are on or off by default for the current Wiki. This is useful in [[Virtual Wiki mode>>AdminGuide.Virtualization]]. 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	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:
140.4	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##
140.1	74	{{/info}}
140.4	75	)))
141.1	76
53.1	77	= Optional Store Features =
12.3	78
53.1	79	== Document versioning ==
49.1	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
140.2	83	To disable versioning edit //xwiki.cfg// and add {{code}}xwiki.store.versioning=0{{/code}}.
49.1	84
140.2	85	[[Attachment versioning>>platform:AdminGuide.Attachments#HVersions]] is also available and turned on by default.
49.1	86
53.1	87	== Document recycle bin ==
12.4	88
140.2	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}}.
49.1	90
140.2	91	{{info}}
	92	Disabling the recycle bin will make it impossible to restore a deleted document, unless a database backup is available.
	93	{{/info}}
49.1	94
51.1	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:
49.1	96
51.1	97	{{code}}
49.1	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
51.1	102	{{/code}}
49.1	103
123.1	104	[[Attachment recycle bin>>platform:AdminGuide.Attachments#HDeletion]] is similar.
49.1	105
53.1	106	= Customizing the Skin =
1.3	107
51.1	108	See the [[Skin Guide>>AdminGuide.Skins]].
1.3	109
53.1	110	= Security configuration =
1.3	111
51.1	112	See the [[Security Guide>>AdminGuide.Security]].
1.3	113
76.1	114	If the users will be accessing XWiki using SSL (https) then you will have to change the way links are created so that external links do not redirect users back to the http page. This is accomplished by setting the ##xwiki.url.protocol## property in //xwiki.cfg//.
	115
53.1	116	= Customizing Menus =
1.3	117
114.6	118	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	119
53.1	120	= Encoding =
1.3	121
51.1	122	See the [[Encoding Guide>>AdminGuide.Encoding]].
1.5	123
53.1	124	= User Authentication =
1.5	125
51.1	126	See the [[Authentication Guide>>AdminGuide.Authentication]].
1.18	127
53.1	128	== Customizing the Verified Registration Page (Since 2.2M2) ==
52.1	129
140.2	130	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	131
140.2	132	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	133
114.6	134	For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]].
52.1	135
57.1	136	= Initial Groups =
61.1	137
140.2	138	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>>#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	139
140.4	140	(((
61.1	141	{{code language="none"}}
57.1	142	xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers
	143	{{/code}}
140.4	144	)))
141.1	145
57.1	146	* Current members will not be automatically be added to these groups, only new members.
	147	* The groups have to be created before being specified as initial groups.
	148
53.1	149	= Logging =
1.23	150
51.1	151	See the [[Logging page>>Logging]].
1.23	152
53.1	153	= Configuring Interwiki links =
1.24	154
119.1	155	[[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	156
119.1	157	{{info}}
	158	Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x.
	159	{{/info}}
	160
	161	{{warning}}
	162	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~]~].
	163	{{/warning}}
	164
	165	== Interwiki links (XWiki Syntax 1.0) ==
	166
125.3	167	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	168
	169	To configure Interwiki links on your wiki:
	170
51.1	171	* Create a file named ##[location from where you start your container]/conf/intermap.txt##
141.1	172	* Fill ##intermap.txt## with content like:(((
140.2	173	{{code}}
	174	IMDB http://us.imdb.com/Title?
1.24	175	OpenWiki http://openwiki.com/?
	176	SourceForge http://sourceforge.net/
	177	TWiki http://twiki.org/cgi-bin/view/
	178	Why http://clublet.com/c/c/why?
	179	Wiki http://c2.com/cgi/wiki?
140.2	180	WikiPedia http://www.wikipedia.com/wiki/
	181	{{/code}}
141.1	182	)))You can of course add your own entries.
1.24	183
140.2	184	{{warning}}
	185	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.
	186	{{/warning}}
1.24	187
140.2	188	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.
	189
119.1	190	== Interwiki links (XWiki Syntax 2.x) ==
	191
	192	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:
	193
	194	{{code language="none"}}
	195	#-# [Since 2.5M2]
	196	#-# InterWiki definitions in the format alias=URL
	197	#-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link
	198	# Some examples:
	199	# rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
	200	# rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/
	201	{{/code}}
	202
53.1	203	= Setting the default editor to use (Wiki or WYSIWYG) =
1.26	204
163.2	205	Starting with XWiki Enterprise 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	206
163.1	207	{{image reference="DefaultEditorStarting30.png" width="45%" /}} {{image reference="default-wysiwyg-config.png" width="45%"/}}
127.1	208
53.1	209	= Configure the WYSIWYG editor =
47.1	210
51.1	211	See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features.
47.1	212
116.1	213	= Link URLs =
119.1	214
116.1	215	With parameters, you can specify what type of links will be made by XWiki.
7.1	216
116.1	217	== Reverse proxy setup ==
119.1	218
116.1	219	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.
	220
140.2	221	Some reverse proxy software does not set this header and with XWiki Enterprise 3.0M3 or newer, you can use the ##xwiki.home## parameter in single wiki instances (non farm) to achieve the same result.
116.1	222
140.4	223	* 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/}}}//
116.1	224	Since XWiki Enterprise 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.
	225
140.2	226	* 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	227
	228	== Short URLs ==
119.1	229
140.2	230	It's possible to [[configure XWiki to use shorter URLs>>Main.ShortURLs]].
7.1	231
144.3	232	= Configure the names of database schemas =
8.1	233
144.3	234	{{info}}Since 1.6M1{{/info}} Sometimes, especially in enterprise environment, we need to control the names of database schemes, other than default.
8.1	235
144.3	236	* 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).
	237	* xwiki.db.prefix: useful mainly for [[virtual wikis>>Virtualization]], 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	238
53.1	239	= Turning off comments or attachments =
44.1	240
140.2	241	You need to change the ##XWiki.XWikiPreferences## class like this:
9.1	242
51.1	243	* Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##
	244	* Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class
	245	* Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field
9.1	246
	247	That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
	248
157.1	249	If you wish to turn off comments/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#HControllingWhichSectionstoDisplay]].
156.1	250
	251	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:
	252
	253	{{code language="none"}}
	254	#if (!$hasAdmin)
	255	#set($docextras = [])
	256	#end
	257	{{/code}}
	258
140.2	259	= Configure "Version Summary" behavior =
16.1	260
140.3	261	When you're editing a page you can add a brief description of your changes in the "Version Summary" field by default (look at [[Features.PageEditing#HCommoneditactions]]). You can disable this feature by setting ##xwiki.editcomment=0## in ##xwiki.cfg##.
16.1	262
140.2	263	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	264
140.2	265	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	266
140.2	267	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	268
138.1	269	= Configuring Directories =
	270
	271	XWiki uses a temporary directory to cache images after re-sizing them or store attachments after loading them out of the database. It also uses a permanent directory for storing data such as [[filesystem attachments>>AdminGuide.Attachments#HFilesystemAttachmentStore28SinceXWikiEnterprise3.0M229]] which must not be deleted and search indexes which are replaceable but laborious to create.
	272
	273	If there is no configured persistent directory, XWiki will use the temporary directory and log a warning on startup.
	274
140.2	275	Since [[XWiki Enterprise 4.1M2>>http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWikiEnterprise41M2#HBugfixesandimprovements]] the temporary files will be placed in a special sub-directory of the temporary directory called ##xwiki-temp##. This directory is periodically cleaned and all its content deleted so it is critical that it is not used for anything else.
138.1	276
139.1	277	To set the permanent directory, you have 2 options:
141.1	278
140.2	279	* Set the ##xwiki.data.dir## system property when starting the JVM (ie. the Servlet Container's JVM, specifically: ##-Dxwiki.data.dir=...##)
	280	* Set the ##environment.permanentDirectory## property in your ##xwiki.properties## file
138.1	281
139.1	282	If the location points to a file or a directory to which XWiki does not have access, a warning will be printed in the log and the temporary directory will be used as a default.
138.1	283
140.2	284	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	285
53.1	286	= Configuring WebDAV (since 1.7) =
31.1	287
140.2	288	WebDAV support has been added to XWiki beginning with XWiki Enterprise 1.7. It is very important to note that WebDAV is enabled by default.
32.1	289
53.1	290	== Securing WebDAV Server ==
32.1	291
140.2	292	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	293
53.1	294	== Disabling WebDAV ==
33.1	295
140.2	296	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	297
53.1	298	{{code language="xml"}}
33.1	299	<servlet-mapping>
	300	<servlet-name>webdav</servlet-name>
	301	<url-pattern>/webdav/*</url-pattern>
	302	</servlet-mapping>
51.1	303	{{/code}}
33.1	304
53.1	305	= Redirections =
13.1	306
140.2	307	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	308	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	309
53.1	310	= Customizing the PDF export Look & Feel =
15.1	311
61.1	312	{{info}}
140.2	313	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	314	{{/info}}
24.1	315
30.2	316	Here's how the PDF and RTF exports currently work:
154.2	317	{{image reference="XWikiExport201010290119.png"/}}
28.1	318
58.1	319	As shown in the diagram you can customize 4 parts:
53.1	320
140.2	321	* 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
	322	* 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
107.1	323	* The XHTML2FO XSL transformation. The default one, xhtml2fo.xsl, is packed in core jar.
108.1	324	* The FOP XSL transformation. The default one, fop.xsl, is also packed in core jar.
30.2	325
140.2	326	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	327
140.4	328	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	329
140.2	330	* ##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
	331	* ##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>>http://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	332	* ##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	333
119.1	334	{{warning}}
140.2	335	The name of the class must be ##XWiki.PDFClass##.
119.1	336	{{/warning}}
114.5	337
106.1	338	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.
	339
51.1	340	Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
30.2	341
140.4	342	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	343
140.2	344	{{warning}}
140.3	345	No template is used by default.
140.2	346	{{/warning}}
	347
79.1	348	{{info}}
114.7	349	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. For example:
140.2	350
51.1	351	{{code language=css}}
79.1	352	#template('colorThemeInit.vm')
28.1	353	h2 {
79.1	354	color: $theme.titleColor;
28.1	355	}
	356
79.1	357	td {
	358	border-color: $theme.borderColor;
28.1	359	}
51.1	360	{{/code}}
79.1	361	{{/info}}
28.1	362
132.1	363	= Override the PDF Templates =
131.1	364
132.1	365	== Customize the PDF Footer ==
131.1	366
140.4	367	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	368
154.2	369	{{image reference="OverridePDFFooter.png"/}}
131.1	370
144.2	371	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	372
154.2	373	{{image reference="OverridePDFFooterEdit1.png"/}}
144.2	374
140.4	375	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	376
140.2	377	{{code}}
	378	$msg.Page <span class="page-number"></span> - $msg.get('lastmodifiedby')
	379	$xwiki.getUserName($tdoc.author, false)
	380	$msg.get('lastmodifiedon')
	381	$!xwiki.formatDate($tdoc.date)
	382	<div>
	383	<p>CustomName SAS. All rights reserved. Confidential and proprietary document. Printed Copies are not controlled.</p>
	384	</div>
	385	{{/code}}
	386
131.1	387	To see the changes, just export any wiki page:
	388
154.2	389	{{image reference="OverridePDFFooterFinal.png"/}}
131.1	390
141.1	391	== Customize the PDF Cover ==
131.1	392
140.4	393	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	394
154.2	395	{{image reference="OverridePDFCover.png"/}}
131.1	396
140.4	397	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	398
140.3	399	{{code}}
	400	<img src="$xwiki.getSkinFile("logo.png")"/>
131.1	401
	402	<div style="text-align: center; width: 100%;">
	403	<h1>
	404	#set($title = "$!pdfdoc.display('title', 'rendered')")
	405	#if($title == '')
	406	$escapetool.xml($!doc.displayTitle)
	407	#else
	408	$escapetool.xml($title)
	409	#end
	410	</h1>
	411	<br />
	412	<br />
	413	$!xwiki.getUserName($tdoc.author, false)
	414	<br />
	415	$!xwiki.formatDate($tdoc.date)
140.3	416	</div>
	417	{{/code}}
137.1	418
140.3	419	The last step consists of attaching the image "logo.png" to the skin:
131.1	420
154.2	421	{{image reference="OverridePDFCoverFinal.png"/}}
131.1	422
132.2	423	== Override the CSS rules ==
	424
140.4	425	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	426
140.3	427	* style which 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
132.1	428	* xhtmlxsl which contains the XHTML2FO XSL transformation that will override the default one
	429	* fopxsl which contains the FOP XSL transformation that will override the default one
131.1	430
154.2	431	{{image reference="CreatePDFClass.png"/}}
131.1	432
140.3	433	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	434
	435	Supposing your wiki page contains a table, you have to edit it in "Wiki" mode and add a style parameter as shown below:
140.3	436
134.3	437	{{code}}
131.1	438	(% class="mytable" %)
	439	\|=Column 1\|=Column 2
	440	\| data\|data
134.4	441	{{/code}}
140.3	442
131.1	443	Next, edit the page in "Objects" mode and write your own CSS rules in the "style" property:
	444
154.2	445	{{image reference="CreatePDFTemplate.png"/}}
131.1	446
140.3	447	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}}}//.
131.1	448
154.2	449	{{image reference="CustomizedPDF.png"/}}
131.1	450
61.1	451	{{info}}
	452	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.
	453	{{/info}}
28.1	454
141.1	455	== Override the xhtml2fo.xsl rules ==
	456
	457	As explained above, the entire code of [[xhtml2fo.xsl>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-oldcore/src/main/resources/xhtml2fo.xsl]] needs to be copied in the xhtmlxsl textarea and then customized.
	458
	459	For example, to disable the generation of clickable URLs in the PDF, modify the follwing section:
	460	{{code}} <xsl:template match="html:a[@href]" mode="transform">
	461	<fo:basic-link xsl:use-attribute-sets="a-link">
	462	<xsl:call-template name="process-a-link"/>
	463	</fo:basic-link>
	464	</xsl:template>{{/code}}
	465	as
	466	{{code}} <xsl:template match="html:a[@href]" mode="transform">
	467	<fo:inline>
	468	<xsl:call-template name="process-a-link"/>
	469	</fo:inline>
	470	</xsl:template>{{/code}}
	471
53.1	472	= Configuring Wiki Syntaxes and default Syntax =
46.1	473
160.1	474	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	475
115.1	476	= Title behavior =
	477
140.3	478	The following configuration parameters (found in ##xwiki.cfg##) can be used to control title behavior:
115.1	479
	480	{{code language="none"}}
	481	#-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
163.3	482	#-# mode is active, XWiki will try to extract a title from the document content.
	483	#-# If the document's content first header (level 1 or level 2) matches the document's title
115.1	484	#-# the first header is stripped.
163.3	485	#-# The default value is 0.
	486	# xwiki.title.compatibility=1
115.1	487
	488	#-# Defines the maximum header depth to look for when computing a document's title from its content. If no header
	489	#-# equal or lower to the specified depth is found then the computed title falls back to the document name.
	490	#-# The default value is 2.
	491	# xwiki.title.headerdepth=2
	492
	493	#-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this
	494	#-# property is set to 1. The default value is 0 (not mandatory).
	495	# xwiki.title.mandatory=0
	496	{{/code}}
	497
117.1	498	= Link Label Generation =
	499
140.3	500	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. ##[[Main.WebHome]]##).
117.1	501
	502	Her's an extract from the ##xwiki.properties## file which is where this feature is configurable:
	503
	504	{{code language="none"}}
	505	#-# [Since 1.8RC2]
159.1	506	#-# Specifies how links labels are displayed when the user doesn't specify the label explicitly.
117.1	507	#-# Valid values:
	508	#-# %w: wiki name
159.1	509	#-# %s: full space name (e.g. space1.space2)
	510	#-# Note: Prior to 7.4.2/8.0M2 this was only displaying the last space name
	511	#-# %ls: last space name. New in 7.4.2/8.0M2
117.1	512	#-# %p: page name
159.1	513	#-# %np: nested page name (i.e. will display the space name for Nested Pages). New in 7.4.2/8.0M2
	514	#-# %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage"
	515	#-# %NP: nested page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage".
	516	#-# New in 7.4.2/8.0M2
117.1	517	#-# %t: page title
	518	#-#
159.1	519	#-# Note that if the page title is empty or not defined then it defaults to %np. This is also the case
117.1	520	#-# if the title cannot be retrieved for the document.
	521	#-#
159.1	522	#-# The default is "%np". Some examples: "%s.%p", "%w:%s.%p".
	523	# rendering.linkLabelFormat = %np
117.1	524	{{/code}}
	525
121.1	526	= Rendering Cache =
	527
140.3	528	See the [[Performance page>>platform:AdminGuide.Performances#HRenderingcache]].
121.1	529
125.1	530	= Allowed Pages for Inactive Users =
	531
125.2	532	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	533
125.2	534	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	535
140.3	536	{{info}}
	537	Inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.
	538	{{/info}}
125.1	539
125.8	540	= Rendering Transformations =
	541
140.3	542	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	543
	544	{{code language="none"}}
	545	#-# [Since 2.6RC1]
	546	#-# Controls what transformations will be executed when rendering content.
	547	#-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with
	548	#-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.
	549	#-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the
	550	#-# macro execution. If you don't list it, macros won't get executed.
	551	#-# The default value is: rendering.transformations = macro, icon
	552	{{/code}}
	553
140.3	554	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	555
135.1	556	= Securing Groovy Scripts =
	557
136.1	558	See:
135.1	559
140.3	560	* The [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]]
	561	* The [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]]
	562
53.1	563	= Sample xwiki.cfg =
1.18	564
158.1	565	See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.cfg.vm"}}xwiki.cfg.vm{{/scm}}
30.1	566
158.1	567	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	568
53.1	569	= Sample xwiki.properties =
50.1	570
158.1	571	See {{scm path="xwiki-platform-tools/xwiki-platform-tool-configuration-resources/src/main/resources/xwiki.properties.vm"}}xwiki.cfg.vm{{/scm}}
50.1	572
158.1	573	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	574

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