Wiki source code of Configuration
Version 59.2 by Sorin Burjan on 2010/06/23
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | One you have XWiki [[installed>>Installation]] you'll want to configure it. Configuration can be done in 2 ways: | ||
| 2 | |||
| 3 | * by stopping the XWiki instance and editing the ##xwiki/WEB-INF/xwiki.cfg## file, and then restarting XWiki | ||
| 4 | * by logging in as a user with admin rights and going to the Administration page (when using the XWiki 1.0 skin, there's a an "Administration" link in the top right corner of the screen - 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. | ||
| 5 | |||
| 6 | Note that some configurations are only accessible from the ##xwiki.cfg## file and have no equivalent on the Administration page. | ||
| 7 | |||
| 8 | You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [[check Config and Indexes application>>code:Applications.CheckConfigAndIndexesApplication]]. | ||
| 9 | |||
| 10 | There are various things you can configure: | ||
| 11 | |||
| 12 | {{toc/}} | ||
| 13 | |||
| 14 | = Enable superadmin account = | ||
| 15 | |||
| 16 | Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example: | ||
| 17 | |||
| 18 | {{code language="none"}} | ||
| 19 | # Enable to allow superadmin. It is disabled by default as this could be a security breach if | ||
| 20 | # it were set and you forgot about it. | ||
| 21 | xwiki.superadminpassword=system | ||
| 22 | {{/code}} | ||
| 23 | |||
| 24 | When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property. | ||
| 25 | |||
| 26 | = Language settings = | ||
| 27 | |||
| 28 | To define the default language for your wiki go to the Administration page and in the Preferences tag 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. | ||
| 29 | |||
| 30 | In addition you can configure you wiki to be multilingual. See the [[I18 user page>>Features.I18N]] for more information. | ||
| 31 | |||
| 32 | 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: | ||
| 33 | |||
| 34 | {{code language="none"}} | ||
| 35 | #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This | ||
| 36 | #-# allows to use the default language of the wiki when the user didn't manually choose a language. | ||
| 37 | # xwiki.language.preferDefault=0 | ||
| 38 | |||
| 39 | #-# Force only one of the supported languages to be accepted. | ||
| 40 | # xwiki.language.forceSupported=0 | ||
| 41 | {{/code}} | ||
| 42 | |||
| 43 | = Date format = | ||
| 44 | |||
| 45 | To define the date format used in the interfaces, go to //Administration// / //General//, locate the "Date format" field and enter the date format you wish to use. Examples: | ||
| 46 | |||
| 47 | |=Format|=Result | ||
| 48 | |MMMM dd, HH:mm|January 27, 12:27 | ||
| 49 | |yyyy/MM/dd, HH:mm|2009/01/27, 12:27 | ||
| 50 | |dd/MM/yyyy, HH:mm|27/01/2009, 12:27 | ||
| 51 | |||
| 52 | [[More information about date formatting>>http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html]]. | ||
| 53 | |||
| 54 | = Wiki Access Configuration = | ||
| 55 | |||
| 56 | The first thing you will want to do is configure a policy access for your wiki. Depending on what you intend to use your wiki for, you have several options: | ||
| 57 | |||
| 58 | * [[Open Wiki>>#HOpenWiki]]: anyone can edit pages (including non registered users) | ||
| 59 | * [[Public Wiki>>#HPublicWiki]]: only registered users can edit pages but registration is open to anyone. This is the default configuration of the default wiki (the wiki provided as a XAR on the [[download page>>xwiki:Main.Download]]). | ||
| 60 | * [[Private Wiki with password>>#HPrivateWikiwithpassword]]: registration is closed | ||
| 61 | * [[Private Wiki with token for registering>>#HPrivateWikiwithtoken]]: registration is closed but users knowing the token can register | ||
| 62 | |||
| 63 | == Open Wiki == | ||
| 64 | |||
| 65 | TODO | ||
| 66 | |||
| 67 | == Public Wiki == | ||
| 68 | |||
| 69 | Nothing to do. This is the default Way. If you want that only people with a verified Email Address can edit pages, you have to set "Use email verification" AND "Check Active fields for user authentication" to "Yes" in Administration/Registration. | ||
| 70 | |||
| 71 | === Requiring guests to fill out a captcha in order to comment (Since: [[Enterprise 2.3M1>>xwiki:Main.ReleaseNotesXWikiEnterprise23M1]]) === | ||
| 72 | It is nice to allow guests to comment on a page, often the most helpful people are unwilling to go to the bother of registration and it creates a more open atmosphere. Unfortunately comments can contain links which can be used as a vector for search engine spam. To keep your site open while preventing automated commenting, you can require guests to fill out a captcha before commenting. The captcha will not be displayed or even loaded until they click on the comment window to type their message so you need not worry about guests' idle surfing causing the [[captcha module>>code:Modules.CaptchaModule]] to use too much of your server's CPU power. | ||
| 73 | |||
| 74 | You can require guests to fill out a captcha for posting comments on a wiki or space level. You can require it on the wiki level but remove that requirement for a single space, or you can require it only for one or more spaces but not the entire wiki. | ||
| 75 | To turn on comment captcha requirement, go to wiki or space administration, click on the "Rights" section and notice the checkbox toward the bottom labeled "Require unregistered users to solve a captcha when posting a comment on a page". Check that box and guests will be required to solve a captcha to comment. | ||
| 76 | **Note:** This setting does not allow guests to comment, it only denies them permission to comment without a captcha on pages where they already had it. To allow commenting, you will have to check the normal "allow comment" checkbox for unregistered users. | ||
| 77 | |||
| 78 | Result: | ||
| 79 | [[image:CommentCaptcha.png||style="border:1px solid black;"]] | ||
| 80 | |||
| 81 | == Private Wiki with password == | ||
| 82 | |||
| 83 | === Global rights === | ||
| 84 | |||
| 85 | In [[Global rights>>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globalrights&global=1]] set **User:XWikiGuest, Groups:, Level:register, Allow-Deny:Allow**. | ||
| 86 | |||
| 87 | === Registration === | ||
| 88 | |||
| 89 | In [[Preferences>>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences]] under **Registration** set **Use email verification:yes**. fill the other fields appropriately. | ||
| 90 | |||
| 91 | == Private Wiki with token == | ||
| 92 | |||
| 93 | TODO | ||
| 94 | |||
| 95 | * **[[Find out more about XWiki access rights here>>Access Rights]]** | ||
| 96 | |||
| 97 | = Enabling/Disabling Statistics = | ||
| 98 | |||
| 99 | To disable [[the Statistics feature>>code:Applications.StatisticsApplication]], edit your //xwiki.cfg// file and replace the following properties as shown here: | ||
| 100 | {{code language="xml"}} | ||
| 101 | xwiki.stats=0 | ||
| 102 | xwiki.stats.default=0 | ||
| 103 | {{/code}} | ||
| 104 | |||
| 105 | where: | ||
| 106 | |||
| 107 | * //xwiki.stats// controls whether Statistics are on or off | ||
| 108 | * //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 is on/off by setting the "statistics" field in XWiki.XWikiPreferences. If no such field is defined the the default value //xwiki.stats.default// is used. | ||
| 109 | |||
| 110 | To enable Statistics, change "0" to "1". | ||
| 111 | |||
| 112 | = Optional Store Features = | ||
| 113 | |||
| 114 | == Document versioning == | ||
| 115 | |||
| 116 | 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. | ||
| 117 | |||
| 118 | To disable the versioning store, edit //xwiki.cfg// and add: | ||
| 119 | {{code}} | ||
| 120 | xwiki.store.versioning=0 | ||
| 121 | {{/code}} | ||
| 122 | |||
| 123 | == Attachment versioning == | ||
| 124 | |||
| 125 | XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD). If you need only latest versions of attachments, you can disable attachment version control by editing your //xwiki.cfg// and adding: | ||
| 126 | {{code}} | ||
| 127 | xwiki.store.attachment.versioning=0 | ||
| 128 | {{/code}} | ||
| 129 | |||
| 130 | == Document recycle bin == | ||
| 131 | |||
| 132 | 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: | ||
| 133 | |||
| 134 | {{code}} | ||
| 135 | xwiki.recyclebin=0 | ||
| 136 | {{/code}} | ||
| 137 | |||
| 138 | Note that disabling it will make it impossible to restore a deleted document, unless a database backup is available. | ||
| 139 | |||
| 140 | 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: | ||
| 141 | |||
| 142 | {{code}} | ||
| 143 | # Admins must wait 3 days before being allowed to permanently delete | ||
| 144 | xwiki.store.recyclebin.adminWaitDays=3 | ||
| 145 | # Normal users must also wait 3 days | ||
| 146 | xwiki.store.recyclebin.waitDays=3 | ||
| 147 | {{/code}} | ||
| 148 | |||
| 149 | == Attachment recycle bin == | ||
| 150 | |||
| 151 | Deleted attachments are also stored in a recycle bin, so that they can be restored along with the document when rolling back or previewing an earlier version in which the attachment should be visible. To disable this feature, edit //xwiki.cfg// and add: | ||
| 152 | |||
| 153 | {{code}} | ||
| 154 | storage.attachment.recyclebin=0 | ||
| 155 | {{/code}} | ||
| 156 | |||
| 157 | = Customizing the Skin = | ||
| 158 | |||
| 159 | See the [[Skin Guide>>AdminGuide.Skins]]. | ||
| 160 | |||
| 161 | = Security configuration = | ||
| 162 | |||
| 163 | See the [[Security Guide>>AdminGuide.Security]]. | ||
| 164 | |||
| 165 | = Customizing Menus = | ||
| 166 | |||
| 167 | 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>>code:Applications.PanelsApplication]] to provide the different menu panels you see on the left or right of your wikis. Check the [[Panels Application>>code:Applications.PanelsApplication]] to know more on how to configure/modify them. | ||
| 168 | |||
| 169 | = Encoding = | ||
| 170 | |||
| 171 | See the [[Encoding Guide>>AdminGuide.Encoding]]. | ||
| 172 | |||
| 173 | = User Authentication = | ||
| 174 | |||
| 175 | See the [[Authentication Guide>>AdminGuide.Authentication]]. | ||
| 176 | |||
| 177 | = Customizing the registration page (2.1 and older) = | ||
| 178 | |||
| 179 | The default registration page is defined as a template on the file system (named ##registerinline.vm##). However it's possible to easily override it by creating a page named ##XWiki.Registration##. | ||
| 180 | |||
| 181 | See [[more details about configuring the registration page>>AdminGuide.User Management#HCustomizingtheRegistrationpage]]. | ||
| 182 | |||
| 183 | == Customizing the Verified Registration Page (Since 2.2M2) == | ||
| 184 | |||
| 185 | The Verified Registration Page is part of the [[Administration Application>>code:Applications.AdministrationApplication]] 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 add validation constraints to the fields which are there. | ||
| 186 | |||
| 187 | (Since 2.3M1) | ||
| 188 | 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. | ||
| 189 | |||
| 190 | To turn on captcha support in version 2.2 you have to edit your [[xwiki.properties>>#HSamplexwikiproperties]] file. You will find this in xwiki/WEB-INF/xwiki.properties you need to add a line which says: | ||
| 191 | |||
| 192 | {{code}} | ||
| 193 | captcha.enabled=true | ||
| 194 | {{/code}} | ||
| 195 | |||
| 196 | Then the registration page will require captchas. | ||
| 197 | |||
| 198 | For more information about configuring the registration page you can visit the page on the [[Administration Application>>code:Applications.AdministrationApplication]]. | ||
| 199 | |||
| 200 | = Initial Groups = | ||
| 201 | 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>>#HSamplexwikicfg]] file. To make all new users be added to the groups **XWiki.CoolPeople** and **XWiki.CommunityMembers** you would set the ##initialGroups## parameter like this: | ||
| 202 | |||
| 203 | {{code language=none}} | ||
| 204 | xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers | ||
| 205 | {{/code}} | ||
| 206 | |||
| 207 | * Current members will not be automatically be added to these groups, only new members. | ||
| 208 | * The groups have to be created before being specified as initial groups. | ||
| 209 | |||
| 210 | = Logging = | ||
| 211 | |||
| 212 | See the [[Logging page>>Logging]]. | ||
| 213 | |||
| 214 | = Configuring Interwiki links = | ||
| 215 | |||
| 216 | [[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]. | ||
| 217 | |||
| 218 | Since XWiki renders wiki syntax using the [[Radeox>>http://radeox.org]] engine, it supports Interwiki links in [[much the same way as SnipSnap>>http://snipsnap.org/space/InterWiki+HowTo]]. | ||
| 219 | |||
| 220 | To configure Interwiki links on your wiki: | ||
| 221 | |||
| 222 | * Create a file named ##[location from where you start your container]/conf/**intermap.txt**## | ||
| 223 | * Fill ##intermap.txt## with content like: | ||
| 224 | {{code}} | ||
| 225 | IMDB http://us.imdb.com/Title? | ||
| 226 | OpenWiki http://openwiki.com/? | ||
| 227 | SourceForge http://sourceforge.net/ | ||
| 228 | TWiki http://twiki.org/cgi-bin/view/ | ||
| 229 | Why http://clublet.com/c/c/why? | ||
| 230 | Wiki http://c2.com/cgi/wiki? | ||
| 231 | WikiPedia http://www.wikipedia.com/wiki/ | ||
| 232 | {{/code}} | ||
| 233 | |||
| 234 | You can of course add your own entries. | ||
| 235 | |||
| 236 | * Note that Radeox's parser for intermap.txt is [[very fragile>>http://snipforge.org/jira/browse/RADEOX-49]]. A blank line at the bottom of the file is enough to make it fall over. | ||
| 237 | * Restart XWiki (you'll need to restart XWiki every time you change ##intermap.txt##) and try out an Interwiki link. | ||
| 238 | * 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. | ||
| 239 | |||
| 240 | = Setting the default editor to use (Wiki or WYSIWYG) = | ||
| 241 | |||
| 242 | Go the Administration screen, then click on the "General" icon and select the default editor to use, as shown on the following screenshot: | ||
| 243 | |||
| 244 | [[image:DefaultEditor.png||style="border:1px solid black;"]] | ||
| 245 | |||
| 246 | = Configure the WYSIWYG editor = | ||
| 247 | |||
| 248 | See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features. | ||
| 249 | |||
| 250 | = Short URLs = | ||
| 251 | |||
| 252 | It's possible to [[configure XWiki so that is uses shorter URLs>>Main.ShortURLs]]. | ||
| 253 | |||
| 254 | = Configure the names of database schemas (since 1.6M1) = | ||
| 255 | |||
| 256 | Sometimes, especially in enterprise environment, we need control names of database schemes, other than default. | ||
| 257 | |||
| 258 | * 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 hibernate configuration file). | ||
| 259 | * 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 applying to the main wiki database name. | ||
| 260 | |||
| 261 | = Turning off comments or attachments = | ||
| 262 | |||
| 263 | You need to change the XWiki.XWikiPreferences class like this: | ||
| 264 | |||
| 265 | * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class## | ||
| 266 | * Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class | ||
| 267 | * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field | ||
| 268 | |||
| 269 | That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes". | ||
| 270 | |||
| 271 | = Configure edit comment behavior = | ||
| 272 | |||
| 273 | When page editing you can add a comment of changes in special comment field by default (Look at [[Features.PageEditing#HCommoneditactions]]). You can disable this feature by set //xwiki.editcomment=0// in //xwiki.cfg//. | ||
| 274 | |||
| 275 | When edit comment feature is enabled, you also can set edit comment mandatory by set //xwiki.editcomment.mandatory=1// in //xwiki.cfg//. This will show popup window with the request to set edit comment if there is no comment entered. It doesn't allow to set empty comment. If you want a popup, but want to be able to set empty edit comment, set //xwiki.editcomment.suggested=1// in //xwiki.cfg// | ||
| 276 | |||
| 277 | If you set edit comment as mandatory or suggested, you can also remove comment field from page editing form and use only popup window for set edit comment. Set //xwiki.editcomment.hidden=0// in //xwiki.cfg// to do this. | ||
| 278 | |||
| 279 | You can use the special fields in //XWikiPreferences// object instead of edit //xwiki.cfg//. These fields are: //editcomment//, //editcomment_mandatory//, //editcomment_suggested// and //editcomment_hidden//. | ||
| 280 | |||
| 281 | = Configuring the SMTP server = | ||
| 282 | |||
| 283 | If you're planning to use XWiki's feature that send emails you'll need to configure the SMTP server used and the email address under which XWiki will send emails. | ||
| 284 | |||
| 285 | To configure these go to the Administration page (##[[http://<server>/xwiki/bin/admin/XWiki/XWikiPreferences]]##), click on the "general" icon and modify the ##Admin email## field to set the email under which XWiki emails will be sent and modify the ##Outgoing SMTP Server## field to set the SMTP server to use, as shown on the figure below. | ||
| 286 | |||
| 287 | [[image:emailconfiguration.png||style="border:1px solid black;"]] | ||
| 288 | |||
| 289 | == Configuring authentication for SMTP == | ||
| 290 | |||
| 291 | {{warning}}These instructions are now obsolete{{/warning}} | ||
| 292 | |||
| 293 | By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must: | ||
| 294 | |||
| 295 | * Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add two ##String## fields, named ##smtp_server_username## and ##smtp_server_password##. | ||
| 296 | * Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=smtp_server_username,smtp_server_password##) and enter the required username and password in the newly added fields. | ||
| 297 | |||
| 298 | == Configuring TLS for the connection to the server == | ||
| 299 | |||
| 300 | {{warning}}These instructions are now obsolete{{/warning}} | ||
| 301 | |||
| 302 | In order to enable TLS, you must: | ||
| 303 | |||
| 304 | * Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add a ##TextArea## field, named ##javamail_extra_props ##. | ||
| 305 | * Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=javamail_extra_props##) and enter: ##mail.smtp.starttls.enable=true## | ||
| 306 | |||
| 307 | == Using Google SMTP server == | ||
| 308 | |||
| 309 | |=property|=value | ||
| 310 | |server|smtp.gmail.com | ||
| 311 | |port|587 | ||
| 312 | |user|vovan@gmail.com | ||
| 313 | |password|xakep | ||
| 314 | |JavaMail properties|mail.smtp.starttls.enable=true | ||
| 315 | |||
| 316 | = Configuring WebDAV (since 1.7) = | ||
| 317 | |||
| 318 | WebDAV support has been added to XWiki beginning from XWiki Enterprise 1.7. It is very important to note that WebDAV is enabled by default. | ||
| 319 | |||
| 320 | == Securing WebDAV Server == | ||
| 321 | |||
| 322 | XWiki's WebDAV implementation only supports [[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. | ||
| 323 | |||
| 324 | == Disabling WebDAV == | ||
| 325 | |||
| 326 | 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 something like: | ||
| 327 | |||
| 328 | {{code language="xml"}} | ||
| 329 | <servlet-mapping> | ||
| 330 | <servlet-name>webdav</servlet-name> | ||
| 331 | <url-pattern>/webdav/*</url-pattern> | ||
| 332 | </servlet-mapping> | ||
| 333 | {{/code}} | ||
| 334 | |||
| 335 | |||
| 336 | |||
| 337 | = Redirections = | ||
| 338 | |||
| 339 | XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property: | ||
| 340 | {{code}} | ||
| 341 | xwiki.preferences.redirect=1 | ||
| 342 | {{/code}} | ||
| 343 | |||
| 344 | 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. | ||
| 345 | |||
| 346 | = Customizing the PDF export Look & Feel = | ||
| 347 | |||
| 348 | {{info}}In the future we'll want to rewrite the PDF/RTF exports as Renderers in the new [[Rendering Module architecture>>code:Modules.RenderingModule]]. When this happens this section will be upgraded.{{/info}} | ||
| 349 | |||
| 350 | Here's how the PDF and RTF exports currently work: | ||
| 351 | [[image:XWikiExport200805192259.png||style="border:1px solid black;"]] | ||
| 352 | |||
| 353 | As shown in the diagram you can customize 4 parts: | ||
| 354 | |||
| 355 | * pdf.vm and the referenced subparts, pdfhtmlheader.vm, pdfheader.vm, pdffooter.vm, pdftoc.vm, pdfcover.vm, which can be overridden in a custom skin | ||
| 356 | * The CSS used to render the content as PDF/RTF | ||
| 357 | * The XHTML2FO XSL transformation | ||
| 358 | * The FOP XSL transformation | ||
| 359 | |||
| 360 | In order to provide your own customization you need to start by creating a new [[XWiki Class>>platform:DevGuide.DataModel]]. To do that simply create a new page 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): | ||
| 361 | |||
| 362 | * ##style##: contains the CSS information that will be overriding the default ##pdf.css## values. | ||
| 363 | * ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one. | ||
| 364 | * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. | ||
| 365 | |||
| 366 | Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it. | ||
| 367 | |||
| 368 | 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]]##. | ||
| 369 | |||
| 370 | {{warning}} | ||
| 371 | As mentioned the ##style## property stores CSS code. Don't add blank line between the rules. The field is parsed and rendered, so a blank line causes a paragraph to appear there, which breaks the CSS. You must use this... | ||
| 372 | {{code language=css}} | ||
| 373 | h2 { | ||
| 374 | margin-left: 2cm; | ||
| 375 | margin-bottom: 1cm; | ||
| 376 | color: red; | ||
| 377 | } | ||
| 378 | h3 { | ||
| 379 | margin: 3cm; | ||
| 380 | color: yellow; | ||
| 381 | } | ||
| 382 | {{/code}} | ||
| 383 | And not... | ||
| 384 | {{code language=css}} | ||
| 385 | h2 { | ||
| 386 | margin-left: 2cm; | ||
| 387 | margin-bottom: 1cm; | ||
| 388 | color: red; | ||
| 389 | } | ||
| 390 | |||
| 391 | h3 { | ||
| 392 | margin: 3cm; | ||
| 393 | color: yellow; | ||
| 394 | } | ||
| 395 | {{/code}} | ||
| 396 | {{/warning}} | ||
| 397 | |||
| 398 | {{info}}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.{{/info}} | ||
| 399 | |||
| 400 | = Configuring Wiki Syntaxes and default Syntax = | ||
| 401 | |||
| 402 | Starting with XWiki Enterprise 1.6 it's possible to configure the [[Wiki syntaxes>>platform:Main.XWikiSyntax]] that are available to the user. To do so edit the **##WEB-INF/xwiki.cfg##** file and configure the ##xwiki.rendering.syntaxes## property. It's a comma-separated list of syntax ids. For example: | ||
| 403 | |||
| 404 | {{code}} | ||
| 405 | xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0, mediawiki/1.0, xhtml/1.0, twiki/1.0 | ||
| 406 | {{/code}} | ||
| 407 | |||
| 408 | In addition starting with XWiki Enterprise 1.8 it's possible to set the default syntax to be used when creating new documents. To do so edit the **##WEB-INF/xwiki.properties##** file and configure the ##core.defaultDocumentSyntax## property. For example to use XWiki Syntax 2.0 by default: | ||
| 409 | |||
| 410 | {{code}} | ||
| 411 | #-# Specifies the default syntax to use when creating new documents. | ||
| 412 | #-# Default value is xwiki/1.0. | ||
| 413 | core.defaultDocumentSyntax = xwiki/2.0 | ||
| 414 | {{/code}} | ||
| 415 | |||
| 416 | {{warning}}Hint: If it doesn't work check that you've edited the correct configuration file.{{/warning}} | ||
| 417 | |||
| 418 | = Sample xwiki.cfg = | ||
| 419 | |||
| 420 | {{code language="none"}} | ||
| 421 | #--------------------------------------- | ||
| 422 | # Preamble | ||
| 423 | # | ||
| 424 | # This is the main old XWiki configuration file. Commented parameters show the default value, although some features | ||
| 425 | # might be disabled. To customize, uncomment and put your own value instead. | ||
| 426 | |||
| 427 | |||
| 428 | #--------------------------------------- | ||
| 429 | # General wiki settings | ||
| 430 | # | ||
| 431 | |||
| 432 | #-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true | ||
| 433 | # xwiki.readonly=no | ||
| 434 | |||
| 435 | #-# [Since 1.6RC1] Defines the list of supported syntaxes | ||
| 436 | #-# Available syntaxes are: | ||
| 437 | #-# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0, mediawiki/1.0, twiki/1.0, xhtml/1.0, html/4.01, plain/1.0 | ||
| 438 | xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0 | ||
| 439 | |||
| 440 | #-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document | ||
| 441 | #-# names. | ||
| 442 | # xwiki.users.initialGroups=XWiki.XWikiAllGroup | ||
| 443 | |||
| 444 | #-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the | ||
| 445 | #-# group's document? | ||
| 446 | # xwiki.authentication.group.allgroupimplicit=0 | ||
| 447 | |||
| 448 | #-# Uncomment if you want to ignore requests for unmapped actions, and simply display the document | ||
| 449 | # xwiki.unknownActionResponse=view | ||
| 450 | |||
| 451 | #-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored, | ||
| 452 | #-# since we want to be independend of the underlying system. | ||
| 453 | xwiki.encoding=UTF-8 | ||
| 454 | |||
| 455 | #-# This parameter will activate the sectional editing. | ||
| 456 | xwiki.section.edit=1 | ||
| 457 | |||
| 458 | #-# This parameter controls the depth of sections that have section editing. | ||
| 459 | #-# By default level 1 and level 2 sections have section editing. | ||
| 460 | xwiki.section.depth=2 | ||
| 461 | |||
| 462 | #-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links. | ||
| 463 | xwiki.backlinks=1 | ||
| 464 | |||
| 465 | #-# Enable document tags. | ||
| 466 | xwiki.tags=1 | ||
| 467 | |||
| 468 | |||
| 469 | #--------------------------------------- | ||
| 470 | # Storage | ||
| 471 | # | ||
| 472 | |||
| 473 | #-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one | ||
| 474 | #-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other | ||
| 475 | #-# than 'default') and put its hint here. | ||
| 476 | # | ||
| 477 | #-# The main (documents) storage. | ||
| 478 | # xwiki.store.main.hint=default | ||
| 479 | #-# The attachment storage. | ||
| 480 | # xwiki.store.attachment.hint=default | ||
| 481 | #-# The document versioning storage. | ||
| 482 | # xwiki.store.versioning.hint=default | ||
| 483 | #-# The attachment versioning storage. Use 'void' to disable attachment versioning. | ||
| 484 | # xwiki.store.attachment.versioning.hint=default | ||
| 485 | #-# The document recycle bin storage. | ||
| 486 | # xwiki.store.recyclebin.hint=default | ||
| 487 | #-# The attachment recycle bin storage. | ||
| 488 | # xwiki.store.attachment.recyclebin.hint=default | ||
| 489 | |||
| 490 | #-# Whether the document recycle bin feature is activated or not | ||
| 491 | # xwiki.recyclebin=1 | ||
| 492 | #-# Whether the attachment recycle bin feature is activated or not | ||
| 493 | # storage.attachment.recyclebin=1 | ||
| 494 | #-# Whether the document versioning feature is activated or not | ||
| 495 | # xwiki.store.versioning=1 | ||
| 496 | #-# Whether the attachment versioning feature is activated or not | ||
| 497 | # xwiki.store.attachment.versioning=1 | ||
| 498 | #-# Whether the attachments should also be rolled back when a document is reverted. | ||
| 499 | # xwiki.store.rollbackattachmentwithdocuments=1 | ||
| 500 | |||
| 501 | #-# The path to the hibernate configuration file. | ||
| 502 | # xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml | ||
| 503 | |||
| 504 | #-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between | ||
| 505 | #-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to | ||
| 506 | #-# improve the startup time. | ||
| 507 | # xwiki.store.hibernate.updateschema=1 | ||
| 508 | |||
| 509 | #-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain | ||
| 510 | #-# queries when large number of objects from particular classes are used in the wiki. | ||
| 511 | # xwiki.store.hibernate.custommapping=1 | ||
| 512 | #-# Dynamic custom mapping. | ||
| 513 | # xwiki.store.hibernate.custommapping.dynamic=0 | ||
| 514 | |||
| 515 | #-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption. | ||
| 516 | #-# Disable only when memory is critical. | ||
| 517 | # xwiki.store.cache=1 | ||
| 518 | |||
| 519 | #-# Maximum number of documents to keep in the cache. | ||
| 520 | # xwiki.store.cache.capacity=100 | ||
| 521 | |||
| 522 | #-# [Since 1.6M1] | ||
| 523 | #-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode. | ||
| 524 | # xwiki.db=xwiki | ||
| 525 | |||
| 526 | #-# [Since 1.6M1] | ||
| 527 | #-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode. | ||
| 528 | # xwiki.db.prefix= | ||
| 529 | |||
| 530 | |||
| 531 | #--------------------------------------- | ||
| 532 | # Data migrations | ||
| 533 | # | ||
| 534 | # Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for | ||
| 535 | # migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not | ||
| 536 | # handled by velocity. | ||
| 537 | |||
| 538 | #-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to | ||
| 539 | #-# disable them in production. | ||
| 540 | xwiki.store.migration=1 | ||
| 541 | |||
| 542 | #-# Migration manager class. The default works with a Hibernate storage. | ||
| 543 | # xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager | ||
| 544 | |||
| 545 | #-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going | ||
| 546 | #-# live afterwards. | ||
| 547 | # xwiki.store.migration.exitAfterEnd=0 | ||
| 548 | |||
| 549 | #-# Indicate the list of databases to migrate. | ||
| 550 | #-# to upgrade all wikis database set xwiki.store.migration.databases=all | ||
| 551 | #-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2 | ||
| 552 | #-# Note: the main wiki is always migrated whatever the configuration. | ||
| 553 | # xwiki.store.migration.databases= | ||
| 554 | |||
| 555 | #--------------------------------------- | ||
| 556 | # Internationalization | ||
| 557 | # | ||
| 558 | |||
| 559 | #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This | ||
| 560 | #-# allows to use the default language of the wiki when the user didn't manually choose a language. | ||
| 561 | # xwiki.language.preferDefault=0 | ||
| 562 | |||
| 563 | #-# Force only one of the supported languages to be accepted. | ||
| 564 | # xwiki.language.forceSupported=0 | ||
| 565 | |||
| 566 | |||
| 567 | #--------------------------------------- | ||
| 568 | # Virtual wikis (farm) | ||
| 569 | # | ||
| 570 | |||
| 571 | #-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and | ||
| 572 | #-# responding to different URLs | ||
| 573 | xwiki.virtual=0 | ||
| 574 | |||
| 575 | #-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page. | ||
| 576 | xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist | ||
| 577 | |||
| 578 | #-# Forbidden names that should not be allowed when creating a new wiki. | ||
| 579 | # xwiki.virtual.reserved_wikis= | ||
| 580 | |||
| 581 | #-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain | ||
| 582 | #-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the | ||
| 583 | #-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/. | ||
| 584 | #-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property. | ||
| 585 | # xwiki.virtual.usepath=0 | ||
| 586 | |||
| 587 | #-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml. | ||
| 588 | # xwiki.virtual.usepath.servletpath=wiki | ||
| 589 | |||
| 590 | #--------------------------------------- | ||
| 591 | # URLs | ||
| 592 | # | ||
| 593 | |||
| 594 | #-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server | ||
| 595 | #-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example: | ||
| 596 | #-# xwiki.home=http://www.xwiki.org/ | ||
| 597 | #-# xwiki.home=http://wiki.mycompany.net:8080/ | ||
| 598 | # xwiki.home= | ||
| 599 | |||
| 600 | #-# The name of the default URL factory that should be used. | ||
| 601 | # xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl | ||
| 602 | |||
| 603 | #-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this | ||
| 604 | #-# is not recommended in most cases. | ||
| 605 | #-# For example: | ||
| 606 | #-# xwiki.url.protocol=https | ||
| 607 | # xwiki.url.protocol= | ||
| 608 | #-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this | ||
| 609 | #-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example: | ||
| 610 | #-# xwiki.webapppath=xwiki/ | ||
| 611 | # xwiki.webapppath= | ||
| 612 | #-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL, | ||
| 613 | #-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should | ||
| 614 | #-# contain a trailing /, but not a leading one. For example: | ||
| 615 | #-# xwiki.servletpath=bin/ | ||
| 616 | # xwiki.servletpath= | ||
| 617 | #-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when | ||
| 618 | #-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short | ||
| 619 | #-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs | ||
| 620 | # xwiki.defaultservletpath=bin/ | ||
| 621 | |||
| 622 | #-# Whether the /view/ part of the URL should be included if the target action is 'view'. | ||
| 623 | # xwiki.showviewaction=1 | ||
| 624 | #-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither. | ||
| 625 | # xwiki.defaultweb=Main | ||
| 626 | #-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show. | ||
| 627 | # xwiki.usedefaultweb=0 | ||
| 628 | #-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither. | ||
| 629 | # xwiki.defaultpage=WebHome | ||
| 630 | #-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show. | ||
| 631 | # xwiki.usedefaultaction=0 | ||
| 632 | |||
| 633 | |||
| 634 | #--------------------------------------- | ||
| 635 | # Users | ||
| 636 | # | ||
| 637 | |||
| 638 | xwiki.inactiveuser.allowedpages= | ||
| 639 | |||
| 640 | |||
| 641 | #--------------------------------------- | ||
| 642 | # Authentication and authorization | ||
| 643 | # | ||
| 644 | |||
| 645 | #-# Enable to allow superadmin. It is disabled by default as this could be a | ||
| 646 | #-# security breach if it were set and you forgot about it. Should only be enabled | ||
| 647 | #-# for recovering the Wiki when the rights are completely messed. | ||
| 648 | # xwiki.superadminpassword=system | ||
| 649 | |||
| 650 | #-# Authentication type. You can use 'basic' to always use basic authentication. | ||
| 651 | # xwiki.authentication=form | ||
| 652 | |||
| 653 | #-# Indicate if the authentication has do be done for each request | ||
| 654 | #-# 0: the default value, authentication is done only once by session. | ||
| 655 | #-# 1: the authentication is done for each request. | ||
| 656 | # xwiki.authentication.always=0 | ||
| 657 | |||
| 658 | #-# Cookie encryption keys. You SHOULD replace these values with any random string, | ||
| 659 | #-# as long as the length is the same. | ||
| 660 | xwiki.authentication.validationKey=totototototototototototototototo | ||
| 661 | xwiki.authentication.encryptionKey=titititititititititititititititi | ||
| 662 | |||
| 663 | #-# Comma separated list of domains for which authentication cookies are set. This | ||
| 664 | #-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if | ||
| 665 | #-# the current domain name corresponding to the wiki ends with one of the entries | ||
| 666 | #-# in this parameter, then the cookie is set for the larger domain. Otherwise, it | ||
| 667 | #-# is set for the exact domain name of the wiki. | ||
| 668 | #-# | ||
| 669 | #-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in | ||
| 670 | #-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net | ||
| 671 | #-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log | ||
| 672 | #-# in on wiki1.otherdomain.net, then I will only be authenticated on | ||
| 673 | #-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net. | ||
| 674 | #-# | ||
| 675 | #-# So you need this parameter set only for global authentication in a | ||
| 676 | #-# farm, there's no need to specify your domain name otherwise. | ||
| 677 | #-# | ||
| 678 | #-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org | ||
| 679 | xwiki.authentication.cookiedomains= | ||
| 680 | |||
| 681 | #-# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet. | ||
| 682 | #-# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout | ||
| 683 | #-# Currently accepted patterns: | ||
| 684 | #-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup) | ||
| 685 | #-# - /logout/ (this works with the short URLs configuration) | ||
| 686 | #-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis) | ||
| 687 | xwiki.authentication.logoutpage=(/|/[^/]+/|/wiki/[^/]+/)logout/* | ||
| 688 | |||
| 689 | #-# The group management class. | ||
| 690 | # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl | ||
| 691 | #-# Default value for exo: | ||
| 692 | # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl | ||
| 693 | |||
| 694 | #-# The authentication management class. | ||
| 695 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl | ||
| 696 | #-# Default value for exo: | ||
| 697 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl | ||
| 698 | #-# Default value for LDAP: | ||
| 699 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl | ||
| 700 | |||
| 701 | #-# The authorization management class. | ||
| 702 | # xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl | ||
| 703 | |||
| 704 | #-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login | ||
| 705 | #-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form. | ||
| 706 | # xwiki.hidelogin=false | ||
| 707 | |||
| 708 | #-# HTTP status code to sent when the authentication failed. | ||
| 709 | xwiki.authentication.unauthorized_code=200 | ||
| 710 | |||
| 711 | |||
| 712 | #--------------------------------------- | ||
| 713 | # Rendering | ||
| 714 | # | ||
| 715 | |||
| 716 | #-# Disable particular renderers (in the old rendering engine). | ||
| 717 | #-# Macro mapping | ||
| 718 | # xwiki.render.macromapping=1 | ||
| 719 | #-# Velocity interpreter | ||
| 720 | # xwiki.render.velocity=1 | ||
| 721 | #-# Groovy interpreter | ||
| 722 | # xwiki.render.groovy=1 | ||
| 723 | #-# Plugin rendering | ||
| 724 | # xwiki.render.plugin=1 | ||
| 725 | #-# Radeox wiki renderer | ||
| 726 | # xwiki.render.wiki=1 | ||
| 727 | #-# Simple wiki syntax rendering | ||
| 728 | # xwiki.render.wikiwiki=0 | ||
| 729 | |||
| 730 | #-# Maximum number of documents to keep in the rendered cache | ||
| 731 | # xwiki.render.cache.capacity=100 | ||
| 732 | |||
| 733 | #-# Default target for external links. Use _blank to open external links in a new tab/window. | ||
| 734 | # xwiki.render.externallinks.defaulttarget= | ||
| 735 | |||
| 736 | |||
| 737 | #--------------------------------------- | ||
| 738 | # Editing | ||
| 739 | # | ||
| 740 | |||
| 741 | #-# Minor edits don't participate in notifications. | ||
| 742 | # xwiki.minoredit=1 | ||
| 743 | |||
| 744 | #-# Use edit comments | ||
| 745 | xwiki.editcomment=1 | ||
| 746 | |||
| 747 | #-# Hide editcomment field and only use Javascript | ||
| 748 | # xwiki.editcomment.hidden=0 | ||
| 749 | |||
| 750 | #-# Make edit comment mandatory | ||
| 751 | xwiki.editcomment.mandatory=0 | ||
| 752 | |||
| 753 | #-# Make edit comment suggested (asks 1 time if the comment is empty. | ||
| 754 | #-# 1 shows one popup if comment is empty. | ||
| 755 | #-# 0 means there is no popup. | ||
| 756 | #-# This setting is ignored if mandatory is set | ||
| 757 | # xwiki.editcomment.suggested=0 | ||
| 758 | |||
| 759 | |||
| 760 | #------------------------------------------------------------------------------------- | ||
| 761 | # LDAP | ||
| 762 | #------------------------------------------------------------------------------------- | ||
| 763 | |||
| 764 | #-# new LDAP authentication service | ||
| 765 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl | ||
| 766 | |||
| 767 | #-# Turn LDAP authentication on - otherwise only XWiki authentication | ||
| 768 | #-# 0: disable | ||
| 769 | #-# 1: enable | ||
| 770 | # xwiki.authentication.ldap=1 | ||
| 771 | |||
| 772 | #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.) | ||
| 773 | xwiki.authentication.ldap.server=127.0.0.1 | ||
| 774 | xwiki.authentication.ldap.port=389 | ||
| 775 | |||
| 776 | #-# LDAP login, empty = anonymous access, otherwise specify full dn | ||
| 777 | #-# {0} is replaced with the username, {1} with the password | ||
| 778 | xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP | ||
| 779 | xwiki.authentication.ldap.bind_pass={1} | ||
| 780 | |||
| 781 | #-# Force to check password after LDAP connection | ||
| 782 | #-# 0: disable | ||
| 783 | #-# 1: enable | ||
| 784 | xwiki.authentication.ldap.validate_password=0 | ||
| 785 | |||
| 786 | #-# only members of the following group will be verified in the LDAP | ||
| 787 | #-# otherwise only users that are found after searching starting from the base_DN | ||
| 788 | # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US | ||
| 789 | |||
| 790 | #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl] | ||
| 791 | #-# only users not member of the following group can autheticate | ||
| 792 | # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US | ||
| 793 | |||
| 794 | #-# base DN for searches | ||
| 795 | xwiki.authentication.ldap.base_DN= | ||
| 796 | |||
| 797 | #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn) | ||
| 798 | # xwiki.authentication.ldap.UID_attr=cn | ||
| 799 | |||
| 800 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 801 | #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1 | ||
| 802 | # xwiki.authentication.ldap.password_field=userPassword | ||
| 803 | |||
| 804 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 805 | #-# The potential LDAP groups classes. Separated by commas. | ||
| 806 | # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList | ||
| 807 | |||
| 808 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 809 | #-# The potential names of the LDAP groups fields containings the members. Separated by commas. | ||
| 810 | # xwiki.authentication.ldap.group_memberfields=member,uniqueMember | ||
| 811 | |||
| 812 | #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute) | ||
| 813 | xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail | ||
| 814 | |||
| 815 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 816 | #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created. | ||
| 817 | xwiki.authentication.ldap.update_user=1 | ||
| 818 | |||
| 819 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 820 | #-# mapps XWiki groups to LDAP groups, separator is "|" | ||
| 821 | # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\ | ||
| 822 | # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US | ||
| 823 | |||
| 824 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 825 | #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6) | ||
| 826 | # xwiki.authentication.ldap.groupcache_expiration=21800 | ||
| 827 | |||
| 828 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 829 | #-# - create : synchronize group membership only when the user is first created | ||
| 830 | #-# - always: synchronize on every login | ||
| 831 | # xwiki.authentication.ldap.mode_group_sync=always | ||
| 832 | |||
| 833 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 834 | #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials | ||
| 835 | xwiki.authentication.ldap.trylocal=1 | ||
| 836 | |||
| 837 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 838 | #-# SSL connection to LDAP server | ||
| 839 | #-# 0: normal | ||
| 840 | #-# 1: SSL | ||
| 841 | # xwiki.authentication.ldap.ssl=0 | ||
| 842 | |||
| 843 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 844 | #-# The keystore file to use in SSL connection | ||
| 845 | # xwiki.authentication.ldap.ssl.keystore= | ||
| 846 | |||
| 847 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 848 | #-# The java secure provider used in SSL connection | ||
| 849 | # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider | ||
| 850 | |||
| 851 | |||
| 852 | #--------------------------------------- | ||
| 853 | # Cache | ||
| 854 | # [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.] | ||
| 855 | #--------------------------------------- | ||
| 856 | |||
| 857 | #-# [Since 1.5M2] | ||
| 858 | #-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation) | ||
| 859 | #-# cache component. | ||
| 860 | # xwiki.cache.cachefactory.hint=jbosscache | ||
| 861 | |||
| 862 | #-# [Since 1.5M2] | ||
| 863 | #-# The cache component to use as local cache component. | ||
| 864 | # xwiki.cache.cachefactory.local.hint=jbosscache/local | ||
| 865 | |||
| 866 | |||
| 867 | #--------------------------------------- | ||
| 868 | # WYSIWYG Editor configuration | ||
| 869 | # | ||
| 870 | |||
| 871 | #-# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the | ||
| 872 | #-# xwiki.wysiwyg.toolbars property. | ||
| 873 | #-# When not defined it defaults to: | ||
| 874 | # xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \ | ||
| 875 | # styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \ | ||
| 876 | # tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar | ||
| 877 | #-# The full list of toolbars includes the one defined above and the following ones: | ||
| 878 | #-# subtoolbar, findtoolbar, symboltoolbar | ||
| 879 | |||
| 880 | |||
| 881 | #--------------------------------------- | ||
| 882 | # Skins & Templates configuration | ||
| 883 | # | ||
| 884 | |||
| 885 | #-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default | ||
| 886 | #-# wiki already specifies a skin, so this setting is only valid for empty wikis. | ||
| 887 | xwiki.defaultskin=colibri | ||
| 888 | |||
| 889 | #-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched | ||
| 890 | #-# if not found in the more specific skins. | ||
| 891 | xwiki.defaultbaseskin=albatross | ||
| 892 | |||
| 893 | #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility | ||
| 894 | #-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title | ||
| 895 | #-# the first header is stripped. | ||
| 896 | xwiki.title.compatibility=1 | ||
| 897 | |||
| 898 | #--------------------------------------- | ||
| 899 | # Extensions | ||
| 900 | # | ||
| 901 | |||
| 902 | #-# List of active plugins. | ||
| 903 | xwiki.plugins=\ | ||
| 904 | com.xpn.xwiki.monitor.api.MonitorPlugin,\ | ||
| 905 | com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\ | ||
| 906 | com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin,\ | ||
| 907 | com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\ | ||
| 908 | com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin,\ | ||
| 909 | com.xpn.xwiki.plugin.feed.FeedPlugin,\ | ||
| 910 | com.xpn.xwiki.plugin.ldap.LDAPPlugin,\ | ||
| 911 | com.xpn.xwiki.plugin.google.GooglePlugin,\ | ||
| 912 | com.xpn.xwiki.plugin.flickr.FlickrPlugin,\ | ||
| 913 | com.xpn.xwiki.plugin.mail.MailPlugin,\ | ||
| 914 | com.xpn.xwiki.plugin.packaging.PackagePlugin,\ | ||
| 915 | com.xpn.xwiki.plugin.query.QueryPlugin,\ | ||
| 916 | com.xpn.xwiki.plugin.svg.SVGPlugin,\ | ||
| 917 | com.xpn.xwiki.plugin.charts.ChartingPlugin,\ | ||
| 918 | com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\ | ||
| 919 | com.xpn.xwiki.plugin.image.ImagePlugin,\ | ||
| 920 | com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\ | ||
| 921 | com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\ | ||
| 922 | com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\ | ||
| 923 | com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\ | ||
| 924 | com.xpn.xwiki.plugin.lucene.LucenePlugin,\ | ||
| 925 | com.xpn.xwiki.plugin.diff.DiffPlugin,\ | ||
| 926 | com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\ | ||
| 927 | com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\ | ||
| 928 | com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\ | ||
| 929 | com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\ | ||
| 930 | com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \ | ||
| 931 | com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \ | ||
| 932 | com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \ | ||
| 933 | com.xpn.xwiki.plugin.tag.TagPlugin | ||
| 934 | |||
| 935 | #-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed, | ||
| 936 | #-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of | ||
| 937 | #-# performance and a bit of memory. | ||
| 938 | # xwiki.monitor=1 | ||
| 939 | |||
| 940 | #-# Maximum number of last requests to remember. | ||
| 941 | # xwiki.monitor.lastlistsize=20 | ||
| 942 | |||
| 943 | #-# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...). | ||
| 944 | #-# Enabled by default. | ||
| 945 | # xwiki.stats=1 | ||
| 946 | #-# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics". | ||
| 947 | #-# Note: Statistics are disabled by default for improved performances/space. | ||
| 948 | xwiki.stats.default=0 | ||
| 949 | #-# It is also possible to choose a different stats service to record statistics separately from XWiki. | ||
| 950 | # xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl | ||
| 951 | |||
| 952 | #-# This parameter will activate the eXo Platform integration | ||
| 953 | xwiki.exo=0 | ||
| 954 | |||
| 955 | #-# GraphViz plugin configuration. The GraphViz plugin is not configured by default. | ||
| 956 | #-# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins | ||
| 957 | #-# in the xwiki.plugins property. | ||
| 958 | #-# Uncomment and set the locations of the Dot and Neato executables | ||
| 959 | # xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe | ||
| 960 | # xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe | ||
| 961 | |||
| 962 | xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/ | ||
| 963 | xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/ | ||
| 964 | |||
| 965 | xwiki.plugin.image.cache.capacity=30 | ||
| 966 | |||
| 967 | #-# Calendar Prev/Next Month bounds. | ||
| 968 | #-# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months | ||
| 969 | #-# after. A value of 0 means that there is no limit in that direction. | ||
| 970 | # xwiki.calendar.bound.prev=6 | ||
| 971 | # xwiki.calendar.bound.next=12 | ||
| 972 | |||
| 973 | #-# Lucene search engine | ||
| 974 | #-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work" | ||
| 975 | #-# diectory. Change it if you want to store indexes in another place. | ||
| 976 | # xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene | ||
| 977 | #-# The text analyzer to use for indexing. | ||
| 978 | # xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer | ||
| 979 | #-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster, | ||
| 980 | #-# but with a minor performance reduction. Adjust according to your wiki load. | ||
| 981 | # xwiki.plugins.lucene.indexinterval=20 | ||
| 982 | #-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the | ||
| 983 | #-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the | ||
| 984 | #-# full reindex option. | ||
| 985 | # xwiki.plugins.lucene.maxQueueSize=1000 | ||
| 986 | |||
| 987 | #-# [Since 2.0RC1] | ||
| 988 | #-# Activity Stream plugin. | ||
| 989 | #-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own | ||
| 990 | #-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main | ||
| 991 | #-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any | ||
| 992 | #-# effect. These options should not be both set to 0 (in this case the local store will be forced). | ||
| 993 | #-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis. | ||
| 994 | #-# | ||
| 995 | #-# Default: 1 | ||
| 996 | # xwiki.plugin.activitystream.uselocalstore=1 | ||
| 997 | #-# | ||
| 998 | #-# Default: 1 | ||
| 999 | # xwiki.plugin.activitystream.usemainstore=1 | ||
| 1000 | #-# | ||
| 1001 | #-# Number of days the events should be kept (0 or any negative value: infinite duration) | ||
| 1002 | #-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to | ||
| 1003 | #-# delete events older than the configured value. | ||
| 1004 | #-# Default: 0 | ||
| 1005 | # xwiki.plugin.activitystream.daystokeepevents=0 | ||
| 1006 | |||
| 1007 | #--------------------------------------- | ||
| 1008 | # Misc | ||
| 1009 | # | ||
| 1010 | |||
| 1011 | #-# Temporary directory where XWiki can put files (during exort and upload, for example). | ||
| 1012 | # xwiki.temp.dir=/tmp/xwiki | ||
| 1013 | #-# XWiki work directory | ||
| 1014 | # xwiki.work.dir=/usr/local/xwiki | ||
| 1015 | |||
| 1016 | xwiki.work.dir=work | ||
| 1017 | {{/code}} | ||
| 1018 | |||
| 1019 | = Sample xwiki.properties = | ||
| 1020 | |||
| 1021 | {{code language="none"}} | ||
| 1022 | # This is the new XWiki configuration file. In the future it'll replace the old | ||
| 1023 | # xwiki.cfg file. However right now it's only used by some XWiki components. | ||
| 1024 | # As time progresses more and more component will get their configurations from | ||
| 1025 | # this file. | ||
| 1026 | |||
| 1027 | #------------------------------------------------------------------------------------- | ||
| 1028 | # Core | ||
| 1029 | #------------------------------------------------------------------------------------- | ||
| 1030 | |||
| 1031 | #-# [Since 1.8RC2] | ||
| 1032 | #-# Specifies the default syntax to use when creating new documents. | ||
| 1033 | #-# Default value is xwiki/2.0. | ||
| 1034 | # core.defaultDocumentSyntax = xwiki/1.0 | ||
| 1035 | |||
| 1036 | #------------------------------------------------------------------------------------- | ||
| 1037 | # Rendering | ||
| 1038 | #------------------------------------------------------------------------------------- | ||
| 1039 | |||
| 1040 | #-# [Since 1.8RC2] | ||
| 1041 | #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely. | ||
| 1042 | #-# Valid values: | ||
| 1043 | #-# %w: wiki name | ||
| 1044 | #-# %s: space name | ||
| 1045 | #-# %p: page name | ||
| 1046 | #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage" | ||
| 1047 | #-# %t: page title | ||
| 1048 | #-# | ||
| 1049 | #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case | ||
| 1050 | #-# if the title cannot be retrieved for the document. | ||
| 1051 | #-# | ||
| 1052 | #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p". | ||
| 1053 | # rendering.linkLabelFormat = %p | ||
| 1054 | |||
| 1055 | #-# [Since 2.0M3] | ||
| 1056 | #-# Overrides default macro categories (Each macro has a default category already defined, for example | ||
| 1057 | #-# "presentation" for the Table of Contents Macro). | ||
| 1058 | #-# | ||
| 1059 | #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category + | ||
| 1060 | #-# redefine the category for the Script Macro to be "My Other Category", you'd use: | ||
| 1061 | # rendering.macroCategories = toc:My Category | ||
| 1062 | # rendering.macroCategories = script:My Other Category | ||
| 1063 | |||
| 1064 | #------------------------------------------------------------------------------------- | ||
| 1065 | # Cache | ||
| 1066 | #------------------------------------------------------------------------------------- | ||
| 1067 | |||
| 1068 | #-# [Since 1.7M1] | ||
| 1069 | #-# The standard cache component implementation to use (can be local or distributed depending on the implementation). | ||
| 1070 | #-# The default standard cache implementation is JBoss Cache. | ||
| 1071 | # cache.defaultCache=jbosscache | ||
| 1072 | |||
| 1073 | #-# [Since 1.7M1] | ||
| 1074 | #-# The local cache implementation to use. | ||
| 1075 | #-# The default local cache implementation is JBoss Cache. | ||
| 1076 | # cache.defaultLocalCache=jbosscache/local | ||
| 1077 | |||
| 1078 | #---------------------------------------------------------------------------------- | ||
| 1079 | # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin | ||
| 1080 | #---------------------------------------------------------------------------------- | ||
| 1081 | |||
| 1082 | #-# [Since 1.9M2] | ||
| 1083 | #-# Type of the openoffice server instance used by officeimporter plugin. | ||
| 1084 | #-# 0 - Internally managed server instance. (Default) | ||
| 1085 | #-# 1 - Externally managed (local) server instance. | ||
| 1086 | # openoffice.serverType=0 | ||
| 1087 | |||
| 1088 | #-# [Since 1.9M2] | ||
| 1089 | #-# Port number used for connecting to the openoffice server instance. | ||
| 1090 | #-# Default port is 8100 | ||
| 1091 | # openoffice.serverPort=8100 | ||
| 1092 | |||
| 1093 | #-# [Since 1.9M2] | ||
| 1094 | #-# If the openoffice server should be started / connected upon XE start. | ||
| 1095 | #-# Default value is false | ||
| 1096 | # openoffice.autoStart=false | ||
| 1097 | |||
| 1098 | #-# [Since 1.8RC3] | ||
| 1099 | #-# Path to openoffice installation (serverType:0 only). | ||
| 1100 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 1101 | # openoffice.homePath=/opt/openoffice.org3/ | ||
| 1102 | |||
| 1103 | #-# [Since 1.8RC3] | ||
| 1104 | #-# Path to openoffice execution profile (serverType:0 only). | ||
| 1105 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 1106 | # openoffice.profilePath=/home/user/.openoffice.org/3 | ||
| 1107 | |||
| 1108 | #-# [Since 1.8RC3] | ||
| 1109 | #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only). | ||
| 1110 | #-# Default value is 50 | ||
| 1111 | # openoffice.maxTasksPerProcess=50 | ||
| 1112 | |||
| 1113 | #-# [Since 1.8RC3] | ||
| 1114 | #-# Timeout for conversion tasks (in miliseconds) (serverType:0 only). | ||
| 1115 | #-# Default value is 30 seconds | ||
| 1116 | # openoffice.taskExecutionTimeout=30000 | ||
| 1117 | |||
| 1118 | #------------------------------------------------------------------------------------- | ||
| 1119 | # Velocity | ||
| 1120 | #------------------------------------------------------------------------------------- | ||
| 1121 | |||
| 1122 | #-# [Since 2.0M1] | ||
| 1123 | #-# Velocity Tools that will be available from your scripts. The format is | ||
| 1124 | #-# velocity.tools.<name under which it'll be available in the context> = <class name> | ||
| 1125 | #-# Default values (no need to add them) | ||
| 1126 | #-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool | ||
| 1127 | #-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool | ||
| 1128 | #-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool | ||
| 1129 | #-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool | ||
| 1130 | #-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool | ||
| 1131 | #-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool | ||
| 1132 | #-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool | ||
| 1133 | |||
| 1134 | #-# [Since 2.0M1] | ||
| 1135 | #-# Velocity configuration properties. The format is | ||
| 1136 | #-# velocity.property.<Velocity property name> = <value> | ||
| 1137 | #-# Default values (no need to add them) | ||
| 1138 | #-# velocity.properties = resource.loader = webapp | ||
| 1139 | #-# velocity.properties = directive.set.null.allowed = true | ||
| 1140 | #-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader | ||
| 1141 | #-# velocity.properties = velocimacro.messages.on = false | ||
| 1142 | #-# velocity.properties = resource.manager.logwhenfound = false | ||
| 1143 | #-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true | ||
| 1144 | #-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector | ||
| 1145 | #-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector | ||
| 1146 | |||
| 1147 | #------------------------------------------------------------------------------------- | ||
| 1148 | # Events distribution | ||
| 1149 | #------------------------------------------------------------------------------------- | ||
| 1150 | |||
| 1151 | #-# [Since 2.0M3] | ||
| 1152 | #-# Indicate if the network distribution module is enabled or not. | ||
| 1153 | #-# By default remote events are disabled. | ||
| 1154 | # observation.remote.enabled = false | ||
| 1155 | |||
| 1156 | #-# [Since 2.0M3] | ||
| 1157 | #-# The list of events communication channels to start when the application starts. | ||
| 1158 | #-# By default no channel is configured. | ||
| 1159 | #-# | ||
| 1160 | #-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel | ||
| 1161 | #-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more | ||
| 1162 | #-# information. | ||
| 1163 | #-# Example: observation.remote.channels = public, cluster | ||
| 1164 | |||
| 1165 | #-# [Since 2.0M4] | ||
| 1166 | #-# The implementation of network adapter to use. | ||
| 1167 | #-# The default is jgroups. | ||
| 1168 | #-# | ||
| 1169 | #-# By default obnly jgroups is provided. To add one implements NetworkAdaptor componenet interface. The identifier provided in the configuration is matched with the component role hint. | ||
| 1170 | #-# Example: observation.remote.networkadapter = jgroups | ||
| 1171 | |||
| 1172 | #------------------------------------------------------------------------------------- | ||
| 1173 | # Administration | ||
| 1174 | #------------------------------------------------------------------------------------- | ||
| 1175 | |||
| 1176 | #-# [Since 2.2M2] | ||
| 1177 | #-# Enable captcha: true|false | ||
| 1178 | #-# | ||
| 1179 | #-# Captcha is disabled by default. | ||
| 1180 | #-# Example: captcha.enabled = true | ||
| 1181 | {{/code}} |
