• Immutable Page
  • Info
  • Attachments

CommentedConfigurationFile

/!\ needs update for 1.5 or DeleteThisPage.

Below is a configuration file containing all (or at least most) of the configuration options applicable in MoinMoin 1.3.5. The intent is to document options in an editable file, so that you can find and set options without the need to be continually referencing multiple web pages.

Note that this is _not_ a farm configuration file.

Options are grouped (as best as possible) by category. Simply find the options of interest to you, remove the # at the beginning of the option's assignment, and set the appropriate values. The given values are the default values as specified in the options table in HelpOnConfiguration.

As a usage note, I find it better to copy options of interest to the bottom of the config file, and uncomment and set them there. This keeps all of the custom settings in one place, making it easier both to see what has been configured, and to move configurations over to a new version of the CommentConfigurationFile, should such a thing ever be written.

# -*- coding: iso-8859-1 -*-
# IMPORTANT! This encoding (charset) setting MUST be correct! If you live in a
# western country and you don't know that you use utf-8, you probably want to
# use iso-8859-1 (or some other iso charset). If you use utf-8 (a Unicode
# encoding) you MUST use: coding: utf-8
# That setting must match the encoding your editor uses when you modify the
# settings below. If it does not, special non-ASCII chars will be wrong.

"""
    MoinMoin - Configuration for a single wiki

    If you run a single wiki only, you can omit the farmconfig.py config
    file and just use wikiconfig.py - it will be used for every request
    we get in that case.

    Note that there are more config options than you'll find in
    the version of this file that is installed by default; see
    the module MoinMoin.multiconfig for a full list of names and their
    default values.

    Also, the URL http://moinmoin.wikiwikiweb.de/HelpOnConfiguration has
    a list of config options.

    @copyright: 2000-2005 by Juergen Hermann <jh@web.de>
    @license: GNU GPL, see COPYING for details.
"""

from MoinMoin.multiconfig import DefaultConfig


class Config(DefaultConfig):
    
    # ----- PERMISSIONS AND SECURITY --------
    # 
    # #True to enable Access Control Lists - fine grained page access rights settings (see HelpOnAccessControlLists)
    # acl_enabled = 0
    # acl_rights_before = u""
    # acl_rights_default = u"Trusted:read,write,delete,revert Known:read,write,delete,revert All:read,write"
    # acl_rights_after = u""
    # 
    # #Allow unsafe actions (list of strings, like ['AttachFile', 'DeletePage', 'RenamePage'])
    # allowed_actions = []
    # 
    # # True to enable moin using the username of a user already authenticated by http basic auth
    # auth_http_enabled = 0


    # ------ BASIC CONFIGURATION ---------
    # 
    # # Path to the data directory containing your (locally made) wiki pages.
    # data_dir = './data/'
    # 
    # # Path to the underlay directory containing distribution system and help pages.
    # data_underlay_dir = './underlay/'
    # 
    # #lookup table to remap URL prefixes (dict of 'prefix': 'replacement'); especially useful in intranets, when whole trees of externally hosted documents move around
    # url_mappings = {}
    # 
    # #used as the base URL for icons, css, etc.
    # url_prefix = '/wiki'
    
    
    # ------- MARKUP SYNTAX ---------
    #
    # #True to enable ["free link"] markup
    # allow_extended_names = 1
    # 
    # #If true, numeric entities like &#8364; for € are not escaped, but &amp; and stuff still is
    # allow_numeric_entities = 1
    # 
    # #True to enable `inline literal` markup
    # backtick_meta = 1
    # 
    # #True to enable !NoWikiName markup
    # bang_meta = 0
    # 
    # #Default page parser / format (name of module in MoinMoin.parser)
    # default_markup = 'wiki'


    # ------- USER INTERFACE OPTIONS --------
    # 
    # #Short description of your wiki site, displayed below the logo on each page, and used in RSS documents as the channel title [Unicode]
    # sitename = u'Untitled Wiki'
    # 
    # #the name of the theme that is used by default (see HelpOnThemes)
    # theme_default = 'modern'
    # 
    # #If True, do not allow to change the theme
    # theme_force = False
    # 
    # #The wiki logo top of page, HTML is allowed (<img> is possible as well) [Unicode]
    # logo_string = sitename
    # 
    # #Number of pages in the trail of visited pages
    # trail_size = 5
    # 
    # #Most important page names. Users can add more names in their quick links in UserPreferences. To link to URL, use u"[url link title]", to use a shortened name for long page name, use u"[LongLongPageName title]". To use page names with spaces, use u"[page_name_with_spaces any title]" [list of Unicode strings]
    # navi_bar = [u'%(page_front_page)s', u'RecentChanges', u'FindPage', u'HelpContents',]
    # 
    # #Default for displaying WantedPages with a question mark, like in the original wiki (changeable by the user)
    # nonexist_qm = 0
    # 
    # #Path to a file containing global InterWiki definitions (or a list of such filenames)
    # shared_intermap = None
    # 
    # #refresh = (minimum_delay_s, targets_allowed) enables use of #refresh 5 PageName processing instruction, targets_allowed must be either 'internal' or 'external'
    # refresh = None
    # 
    # #Disable this option to hide host names and IPs
    # show_hosts = 1
    # 
    # #True to show section numbers in headings by default
    # show_section_numbers = 1
    # 
    # #Shows some timing values at bottom of page - used for development
    # show_timings = 0
    # 
    # #Show MoinMoin version at the bottom of each page
    # show_version = 0
    # 
    # #dict of {'iconname': (url, title, icon-img-key), ...}. Available only in classic theme.
    # page_icons_table = <see comment>
    # 
    # #Show a license hint in page editor.
    # page_license_enabled = 0
    # 
    # #Page linked from the license hint. [Unicode]
    # page_license_page = u'WikiLicense'
    # 
    # #Name of the page containing user-provided spellchecker words [Unicode]
    # page_local_spelling_words = u'LocalSpellingWords'


    # ------ EXTENSIONS/EXTRA FEATURES ----------
    # 
    # #True to enable XSLT processing via 4Suite (note that this enables anyone with enough know-how to insert arbitrary HTML into your wiki, which is why it defaults to 0)
    # allow_xslt = 0
    # 
    # #If None, send attachments via CGI; else this has to be a dictionary with the path to attachment storage (key dir) and the equivalent URL prefix to that same dir (key url)
    # attachments = None
    # 
    # #output formats that are cached; set to [] to turn off caching (useful for development)
    # caching_formats = ['text_html']
    # 
    # #If you have gdchart, use something like chart_options = {'width': 720, 'height': 540}
    # chart_options = None
    # 
    # #12 hours from now until the MoinMoin cookie expires and you get logged out
    # cookie_lifetime = 12


    # ------- DATE AND TIME: formats, time zone, etc. --------
    # 
    # #Time format used on RecentChanges for page edits within the last 24 hours
    # changed_time_fmt = '%H:%M'
    # 
    # #System date format, used mostly in RecentChanges
    # date_fmt = '%Y-%m-%d'
    # 
    # #Default format for dates and times (when the user has no preferences or chose the "default" date format)
    # datetime_fmt = '%Y-%m-%d %H:%M:%S'
    # 
    # #Default language for user interface and page content, see HelpOnLanguages!
    # default_lang = 'en'
    # 
    # #Editor locking policy: None, 'warn <timeout in minutes>', or 'lock <timeout in minutes>'
    # edit_locking = 'warn 10'
    # 
    # #Default height of the edit box
    # edit_rows = 30
    # 
    # #List of denied IPs; if an IP ends with a dot, it denies a whole subnet (class A, B or C)
    # hosts_deny = []
    # 
    # #default time zone offset in hours from UTC
    # tz_offset = 0.0


    # ------- HTML OPTIONS ---------
    # 
    # #Additional <HEAD> tags for all pages (see HelpOnSkins)
    # html_head = ""
    #
    # # Additional <HEAD> tags for requests with query strings, like actions
    # html_head_queries = '''<meta name="robots" content="noindex,nofollow">\n'''
    #
    # #Additional <HEAD> tags for POST requests
    # html_head_posts = '''<meta name="robots" content="noindex,nofollow">\n'''
    # 
    # #Additional <HEAD> tags for some few index pages
    # html_head_index = '''<meta name="robots" content="index,follow">\n'''
    # 
    # #Additional <HEAD> tags for most normal pages
    # html_head_normal = '''<meta name="robots" content="index,nofollow">\n'''
    # 
    # #Allows you to set a specific HTML page title (if not set, it defaults to the value of sitename)
    # html_pagetitle = None
    # 
    # #Custom HTML markup sent before the system footer (see HelpOnSkins)
    # page_footer1 = ""
    # 
    # #Custom HTML markup sent after the system footer (see HelpOnSkins)
    # page_footer2 = ""
    # 
    # #Custom HTML markup sent before the system header / title area (see HelpOnSkins)
    # page_header1 = ""
    # 
    # #Custom HTML markup sent after the system header / title area (see HelpOnSkins)
    # page_header2 = ""
    # 
    # #list of icons to show in iconbar, valid values are only those in page_icons_table. Available only in classic theme.
    # page_iconbar = ["view"]
    # 
    # #list with html fragments with logos or strings for crediting.
    # page_credits = []


    # ------ MAIL OPTIONS -------
    # 
    # #From: header used in sent mails
    # mail_from = None
    # 
    # #"user pwd" if you need to use SMTP AUTH
    # mail_login = None
    # 
    # #IP or domain name of an SMTP-enabled server; note that email features (notification, mailing of login data) works only if this variable is set
    # mail_smarthost = None


    # ------ PAGE DEFINITIONS ---------
    # 
    # #Name of the front page (see Default front page) [Unicode]
    # page_front_page = u'FrontPage'
    # 
    # #Pagenames containing a match for this regex are regarded as Wiki categories [Unicode]
    # page_category_regex = u'^Category[A-Z]'
    # 
    # #Pagenames containing a match for this regex are regarded as containing variable dictionary definitions [Unicode]
    # page_dict_regex = u'[a-z]Dict$'
    # 
    # #Pagenames containing a match for this regex are regarded as containing form definitions [Unicode]
    # page_form_regex = u'[a-z]Form$'
    # 
    # #Pagenames containing a match for this regex are regarded as containing group definitions [Unicode]
    # page_group_regex = u'[a-z]Group$'
    # 
    # #Pagenames containing a match for this regex are regarded as templates for new pages [Unicode
    # page_template_regex = u'[a-z]Template$'


    # ------ MISCELLANEOUS -----------
    # 
    # #A regex of HTTP_USER_AGENTs that should be excluded from logging
    # ua_spiders = ('archiver|cfetch|crawler|curl|gigabot|google|holmes|htdig|httrack|httpunit|jeeves|larbin|leech|'
    #                          'linkbot|linkmap|linkwalk|mercator|mirror|msnbot|nutbot|puf|robot|scooter|'
    #                          'search|sherlock|sitecheck|spider|teleport|wget')

    # 
Tell others about this page:

last modified 2005-11-13 13:36:08