Wiki source code of Configuration

Version 235.3 by Vincent Massol on 2024/04/04

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