All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ini.jspwiki.properties Maven / Gradle / Ivy

#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
#  specific language governing permissions and limitations
#  under the License.

###########################################################################
#
#  This is the JSPWiki configuration file.  You'll need to edit this
#  a bit.  The first few lines are the most important ones.
#
#  If you don't want to edit this file, you can override each individual
#  property by specifying the property name as a standard
#  Java System Property.
#
#  Wherever it is said that an option can be "true" or "false", you can
#  also use "yes"/"no", or "on/off".  Just for some convenience.
#
#
#  You can use this to override the default application name.  It affects
#  the HTML titles and logging, for example.  It can be different from
#  the actual web name (http://my.com/mywiki) of the application, but usually
#  it is the same.
#
jspwiki.applicationName = JSPWiki

#
#  Which page provider class to use.  Possibilities are:
#
#    FileSystemProvider     - for simple pure file storage with no version information
#    VersioningFileProvider - for simple pure file storage with    version information
#
jspwiki.pageProvider = FileSystemProvider

#
# How to order pages in various lists and plugins.  By default, they are
# ordered using Java's "natural" String order (purely character by character
# comparison). This means that the pages named "Page1", "Page2" and "Page10"
# appear in the order "Page1", "Page10", "Page2".
#
# To specify a different ordering, give the fully qualified name of a String
# Comparator. If the class can't be found, an error will be logged and page
# sorting will fall back to the default "natural" ordering. You can specify
# any String Comparator class here BUT be careful of using case insensitive
# comparators as JSPWiki page names may be case sensitive.
# Example: jspwiki.pageNameComparator.class = my.fully.qualified.comparator
#
# For convenience, we have provided a few possibly useful comparators:
#
# HumanComparator understands numbers and sorts in a more human friendly
# order (English only).  Using HumanComparator, the pages "Page1", "Page2",
# "Page10" will sort in that order.
# Example: jspwiki.pageNameComparator.class = HumanComparator
#
# LocaleComparator uses the server's Locale for ordering.  Useful if your
# content is always in a language other than English.  Does not do human
# friendly numeric ordering.
# Example: jspwiki.pageNameComparator.class = LocaleComparator
#
#jspwiki.pageNameComparator.class =

#
#  Set to true, if you want to cache page data into memory.  This is in general a good idea.
#
#  Default is true (use cache).
#
#  NB: This replaces the JSPWiki 1.x "CachingProvider" setting, since it probably was too confusing.
#
jspwiki.cache.enable = true
# This property superseedes
#jspwiki.usePageCache = true (which has been thus deprecated)

#
# Specify file from classpath that holds ehcache configuration.
#
# By default, JSPWiki caches will hold up to 1.000 elements, except the RSS cache, which will hold up to 250 elements
jspwiki.cache.custom-config-file = jspwiki-ehcache.xml

#
#  Determines where wiki files are kept for FileSystemProvider i.e.:
#
#  jspwiki.fileSystemProvider.pageDir = /p/web/www-data/jspwiki/
#
#  If you're using Windows, then you must duplicate the backslashes.
#  For example, use:
#
#  jspwiki.fileSystemProvider.pageDir = C:\\Data\\jspwiki
#
#  If not provided, will default to a "jspwiki-files" directory
#  in the user's home folder.
#


#
#  The JSPWiki working directory.  If not set, a temporary path will
#  be used.  You can see the location of the workdir in the logs.
#  It is HIGHLY recommended that you set this.
#
#  The working directory is used to cache things like Lucene search
#  results.
#
#jspwiki.workDir =

#
#  ATTACHMENTS:
#
#  Use the following property to define which attachment provider
#  you want to use.  You have basically two choices:
#    * Set the value to BasicAttachmentProvider
#      a simple, flat file versioning provider
#    * Leave the value empty (or just comment the line out)
#      the attachment functionality is disabled
#
jspwiki.attachment.provider = BasicAttachmentProvider
# This property superseedes
#jspwiki.attachmentProvider = BasicAttachmentProvider (which has been thus deprecated)

#
#  The BasicAttachmentProvider needs to know where to store the files
#  the user has uploaded.  It's okay to put these in the same directory
#  as you put your text files (i.e. the pageDir setting above).
#
#  If you're using Windows, then you must duplicate the backslashes.
#  For example, use:
#
#  jspwiki.basicAttachmentProvider.storageDir = C:\\Data\\jspwiki
#
#  If not provided, will default to a "jspwiki-files" directory
#  in the user's home folder.
#

#
#  You can tell the BasicAttachmentProvider to add a flag
#  so that browsers do not cache certain (or all) attachment
#  types. This is useful in intranet environments. You should activate
#  this if your users complain that their excel files are not uploaded
#  correctly and they still do have an old version: Usually the
#  file was uploaded correctly, but they get the locally cached version
#
#  You can use regular expressions to disable the cache, e.g the
#  following example will disable browser cache for all excel and word files
#
#  If you don't define this property, cache is enabled by default for
#  all attachments
#
#  jspwiki.basicAttachmentProvider.disableCache = .*\.xls|.*\.doc

#
#  You can limit the maximum size of an attachment by setting this
#  value.  The value is in bytes, and by default all attachments
#  are accepted.
# This limit is not enforced for users with AdminPermissions.
#
#  The following line would limit the attachment size to 100,000 bytes
#jspwiki.attachment.maxsize=100000

#
#  By default JSPWiki accepts all types of attachments.  However, you
#  can allow some types only, or forbid some other types.  By default,
#  all file types are allowed (if you do not specify the "allow" list
#  at all or it is empty).
# These allow/forbid statements are not enforced for users with AdminPermissions.
#
#  These both are space-separated lists of file suffixes
#
#  Example: Allow only PNG, JPG, ZIP and JAR file attachments
#jspwiki.attachment.allowed=.png .jpg .zip .jar

#  Example: Forbid HTML, PHP, ASP and EXE
#jspwiki.attachment.forbidden=.html .htm .php .asp .exe

# Attachment links to HTML, HTM and JS files will force a download rather than opening the attachment
jspwiki.attachment.forceDownload= .html .htm .js .svg

#
#  page Diff Representation
#
#  To show differences between page versions, you can define a
# difference provider.
#  The following choices are available:
#    * TraditionalDiffProvider - Uses internal (java) diff
#        to create a list of changes and shows it line by
#        line colored. This is the default
#    * ContextualDiffProvider - Uses internal (java) diff
#        to create changes inline and shows it on a word by
#        word basis using CSS. This is much superior to the
#        traditional diff provider, however, it is still quite
#        new and not much tested. YMMV.
#    * ExternalDiffProvider - uses a system diff program (which
#        can be configured using "jspwiki.diffCommand") to
#        create an unified (!) diff.
#
#        Example for a diff command:
#        jspwiki.diffCommand = /usr/bin/diff -u %s1 %s2
#
jspwiki.diffProvider = TraditionalDiffProvider

#
#  Page references
#
# The reference manager keeps track of wikipage references, that is, what pages a
# given page refers to, and they other way round, what pages refer to a given page.
# If using a custom reference manager, specify the ReferenceManager implementation
# class here (it is expected that the implementation will have a constructor
# receiving an Engine):
jspwiki.refManager = org.apache.wiki.references.DefaultReferenceManager

#
#  Determines which character encoding JSPWiki should use.  If you want
#  to support all languages in your Wiki, you probably want to enable
#  this.  From JSPWiki 2.2, it is strongly suggested that you use UTF-8.
#
#  Note that you can't switch these in the mean time, since the way the
#  files are encoded on disk is incompatible between ISO-Latin1 and UTF-8.
#  Don't try.  You'll get all sorts of interesting problems, if you do.
#
#  Possible values are 'ISO-8859-1' (default, if none has been specified)
#  and 'UTF-8'.

jspwiki.encoding = UTF-8

#
# The following 3 properties apply sensible constraints around custom page
# properties that can be saved into the AbstractFileProvider. These default
# values were chosen with future JDBC providers in mind.
# See: https://issues.apache.org/jira/browse/JSPWIKI-856
#
#custom.pageproperty.max.allowed=200
#custom.pageproperty.key.length=255
#custom.pageproperty.value.length=4096


#
#  Determines whether raw HTML is allowed as Wiki input.
#
#  THIS IS A DANGEROUS OPTION!
#
#  If you decide to allow raw HTML, understand that ANY person who has
#  access to your Wiki site can embed ANY sort of malicious JavaScript,
#  or plugin, or ActiveX, or whatever on your site.  They can even mess it
#  up so royally it is impossible for you to replace the situation without
#  the need of direct access to the repository.  So think twice before
#  allowing raw HTML on your own site.
#
#  Most probably you want to use this on Intranets, or personal servers,
#  where only a handful of people can access the wiki.
#
#  Text between {{{ and }}} -options is not affected by this setting, so
#  it's always safe to quote HTML code with those.
#
#  The default for this option is "false".
#
jspwiki.translatorReader.allowHTML = false

############################################################################
#
#  Usability niceties.
#
#
#  If this property is set to "true", then page titles are rendered
#  using an extra space between every capital letter.  It may make
#  page titles readable on some occasions, but it does have the
#  drawback of making the titles look a bit funny at times.
#
jspwiki.breakTitleWithSpaces = false

#
#  If set to true, this property means that "WikiName" and "WikiNames"
#  are considered equal when linking between them.  Setting this to
#  true does not prevent you from having both kinds of pages - we just
#  fall back to the other one if the primary name does not exist.
#
#  For any other language, you'll probably want to turn this off.
#
jspwiki.translatorReader.matchEnglishPlurals = true

#
#  If you set this to true, the Wiki translator will then also consider
#  "traditional" WikiNames (that is, names of pages JustSmashedTogether
#  without square brackets) as hyperlinks.  This technique is also
#  known as "CamelCase", or "BumpyCase", or "InterCapping".  I personally
#  like CamelCase as a word, which is why this property is named as it is :-).
#
#  By default this is false, since traditional WikiLinks may confuse newbies.
#
#  This option can be overridden on a per-page basis using the SET directive.
#
jspwiki.translatorReader.camelCaseLinks = false

#
#  This sets the default template used by the Wiki engine.  The templates
#  live in templates/