[Home]UseModWiki/Settings

UseModWiki | UseModWiki | RecentChanges | Preferences

The 0.92 wiki distribution included a settings document which briefly explained the new and added settings. I did not have time to update it for 1.0, so I decided to move it to the wiki site. Over time I hope to expand the following list and translate it to better wiki formatting. --CliffordAdams

New configuration settings added after 0.92

$InterWikiMoniker = '';         # InterWiki moniker for this wiki. (for RSS)
$SiteDescription  = $SiteName;  # Description of this wiki. (for RSS)
$RssLogoUrl  = '';              # Optional image for RSS feed
$KeepSize    = 0;               # If non-zero, maximum size of keep file
$BGColor     = 'white';         # Background color ('' to disable)
$DiffColor1  = '#ffffaf';       # Background color of old/deleted text
$DiffColor2  = '#cfffcf';       # Background color of new/added text
$FavIcon     = '';              # URL of bookmark/favorites icon, or ''
$RssDays     = 7;               # Default number of days in RSS feed
$UserHeader  = '';              # Optional HTML header additional content
$UserBody    = '';              # Optional <BODY> tag additional content
$EarlyRules  = '';              # Local syntax rules for wiki->html (evaled)
$LateRules   = '';              # Local syntax rules for wiki->html (evaled)
$StartUID    = 1001;            # Starting number for user IDs
$UploadDir   = '';              # Full path (like /foo/www/uploads) for files
$UploadUrl   = '';              # Full URL (like http://foo.com/uploads)
@ImageSites  = qw();            # Url prefixes of good image sites: ()=all

$DeletedPage = 'DeletedPage';   # 0 = disable, 'PageName' = tag to delete page
$ReplaceFile = 'ReplaceFile';   # 0 = disable, 'PageName' = indicator tag
@ReplaceableFiles = ();     # List of allowed server files to replace
$TableSyntax = 1;           # 1 = wiki syntax tables, 0 = no table syntax
$NewFS       = 0;           # 1 = new multibyte $FS,  0 = old $FS
$UseUpload   = 0;           # 1 = allow uploads,      0 = no uploads

$MetaKeywords = 1;      # 1 = Google-friendly,    0 = search-engine averse
$NamedAnchors = 1;      # 0 = no anchors, 1 = enable anchors,
                        # 2 = enable but suppress display
$SlashLinks   = 0;      # 1 = use script/action links, 0 = script?action
$UpperFirst   = 1;      # 1 = free links start uppercase, 0 = no ucfirst
$AdminBar     = 1;      # 1 = admins see admin links, 0 = no admin bar
$RepInterMap  = 0;      # 1 = intermap is replacable, 0 = not replacable
$ConfirmDel   = 1;      # 1 = delete link confirm page, 0 = immediate delete
$MaskHosts    = 0;      # 1 = mask hosts/IPs,      0 = no masking
$LockCrash    = 0;      # 1 = crash if lock stuck, 0 = auto clear locks
$HistoryEdit  = 0;      # 1 = edit links on history page, 0 = no edit links
$OldThinLine  = 0;      # 1 = old ==== thick line, 0 = ------ for thick line
$NumberDates  = 0;      # 1 = 2003-6-17 dates,     0 = June 17, 2003 dates
$ParseParas   = 0;      # 1 = new paragraph markup, 0 = old markup
$AuthorFooter = 1;      # 1 = show last author in footer, 0 = do not show
$AllUpload    = 0;      # 1 = anyone can upload,   0 = only editor/admins
$LimitFileUrl = 1;      # 1 = limited use of file: URLs, 0 = no limits
$MaintTrimRc  = 0;      # 1 = maintain action trims RC, 0 = only maintainrc
$SearchButton = 0;      # 1 = search button on page, 0 = old behavior
$EditNameLink = 0;      # 1 = edit links use name (CSS), 0 = '?' links
$UseMetaWiki  = 0;      # 1 = add MetaWiki search links, 0 = no MW links
$BracketImg   = 1;      # 1 = [url url.gif] becomes image link, 0 = no img

# Names of sites.  (The first entry is used for the number link.)
@IsbnNames = ('bn.com', 'amazon.com', 'powells.com', 'search');
# Full URL of each site before the ISBN
@IsbnPre = ('http://shop.barnesandnoble.com/bookSearch/isbnInquiry.asp?isbn=',
            'http://www.amazon.com/exec/obidos/ISBN=',
            'http://www.powells.com/cgi-bin/biblio?isbn=',
            'http://www.pricescan.com/books/BookDetail.asp?isbn=');
# Rest of URL of each site after the ISBN (usually '')
@IsbnPost = ('', '', '', '');

$EmailFile   = "$DataDir/emails";   # Email notification lists

New settings in 0.92

$StyleSheet  = "";              # URL for CSS stylesheet (like "/wiki.css")

  The URL for an external CSS stylesheet.

$NotFoundPg  = "";              # Page for not-found links ("" for blank pg)

  If a page is not found by an ordinary link (like wiki.pl?SomePage), this
option allows a special not-found page to be displayed rather than the
usual blank "Describe this page here." message.  It is probably most useful
for sites with more visitors than editors, or as a kind of "404" page in
case wiki pages are deleted or renamed.

$FooterNote  = "";              # HTML for bottom of every page

  The contents of $FooterNote will be displayed at the bottom of every
normal wiki page (some error messages will not display this message).  It is
raw HTML, so make sure you escape special characters properly.

$EditNote    = "";              # HTML Notice above buttons on edit page

  This is like $FooterNote, but it is displayed on the editing page.  It is
a good place for a brief policy note about contributed content.

$MaxPost     = 1024 * 210;      # Maximum 210K posts (about 200K for pages)

  The maximum accepted size of a POST (edit) request in bytes.  Page
submissions beyond this size will not be accepted.  This may be useful to
prevent simple denial-of-service attacks.

$NewText     = "";              # New page text ("" for default message)

  The text that is inserted into a newly-created page.  Leave this setting
blank to keep the default message.

$HttpCharset = "";              # Charset for pages, like "iso-8859-2"

  If non-blank, this charset will be used in the HTTP header.  This may be
most useful for non-English wikis.

$UserGotoBar = "";              # HTML added to end of goto bar

  If non-blank, this is added to the end of the goto/link bar on each page.

$RunCGI      = 1;       # 1 = Run script as CGI,  0 = Load but do not run

  For those who are using mod_perl, FastCGI, or similar persistent-CGI
systems, set this variable to 0 *in the script* in order to prevent the
script from running as soon as it is loaded.  See the PersistentCGI page on
the UseMod wiki for more details.

$UseLookup   = 1;       # 1 = lookup host names,  0 = skip lookup (IP only)

  If saving a page takes a long time (20 or more seconds), try changing
this setting to 0.

$FreeUpper   = 1;       # 1 = force upper case,   0 = do not force case

  The new 0.92 code by default forces all words in a page-title to start
with an uppercase letter.  (A link like [[This is a link]] will go to
a page named [[This Is A Link]].)  This convention allows similar links
(differing only in case) to point to the same page.

  Sites that use sentences as links might not want this behavior, so the
$FreeUpper setting allows it to be disabled.  Note that the first letter
of the first word is still *always* uppercased regardless of this setting.

$FastGlob    = 1;       # 1 = new faster code,    0 = old compatible code

  Thanks to user feedback the indexing code has been greatly improved.
In case of problems, however, the old code is available.

$EmbedWiki   = 0;       # 1 = no headers/footers, 0 = normal wiki pages

  Normally this setting will be kept at 0.  If set to 1, only the wiki
text of each page will be displayed (no headers, linkbars, footers, search
forms, or logos are displayed).

New settings as of 0.91:

$HomePage    = "HomePage";      # Home page (change space to _)

  This option existed in 0.90, but it can now accept free-link names
(if $FreeLinks is set to 1).  For example, $HomePage = "My_Home_Page";
would make the homepage be "My Home Page".  Note that _ characters are
required instead of spaces.

$RCName      = "RecentChanges"; # Name of changes page (change space to _)

  The name of the RecentChanges page can now be changed.  Like the $HomePage
option, free-link names are allowed with spaces changed to _ characters
(like "My_Recent_Changes").

# Major options:
$FreeLinks   = 1;       # 1 = use [[word]] links, 0 = LinkPattern only

  This is the biggest change in 0.91.  Pages can now have names with spaces
and limited punctuation.  (See the online documentation for more details.)
If you do not want this feature in your wiki, change this setting to 0.

$WikiLinks   = 1;       # 1 = use LinkPattern,    0 = use [[word]] only

  If you are using the FreeLinks feature, you can *optionally* set
$WikiLinks to 0 to disable automatic linking of text matching the LinkPattern.
If you set this to 0, the only links in the text will be those created
with double-brackets (like [[word]]).  This may be useful if a site wishes
to use [[word]]-style links exclusively and doesn't want AccidentalLinking.

$AdminDelete = 1;       # 1 = Admin only page,    0 = Editor can delete pages

  If set to 0, the "action=editlinks" feature will be available for logins
with a valid editor password (as well as admins).  Note that the editlinks
feature can completely and irreversably erase pages and RecentChanges-log
entries.

# Minor options:
$UseIndex    = 0;       # 1 = use index file,     0 = slow/reliable method

  This is not a new option, but the default value is changed from the 0.90
release.  Some sites have experienced problems with pages showing up as
not defined after the page was created.  Setting $UseIndex to 0 eliminated
the problem.  For small sites (less than 500 pages) this setting will not
matter much.  Larger sites may want to try setting $UseIndex to 1 as it
should speed up actions like searching and the "Random Page" link.

$UseHeadings = 1;       # 1 = allow = h1 text =,  0 = no header formatting

  New formatting.  Text like ==h2 text== is rendered like <h2>h2 text</h2>.
The number of "=" characters determines the header number.

$NetworkFile = 1;       # 1 = allow remote file:, 0 = no file:// links

  If enabled, file:// links to remote sites will be enabled.  Local
file:// links are disabled because of possible problems with links
like file:///C:/Windows/calc.exe (substituting a bad program instead).

$BracketWiki = 0;       # 1 = [WikiLnk txt] link, 0 = no local descriptions

  In 0.90, text like [WikiLink any text here] became a link which looked
like [any text here], pointing to WikiLink.  This occasionally caused
problems with things like category lists like [CategoryAlpha CategoryBeta].
This behavior is now optional, and is disabled by default.  If you want
the 0.90 behavior of local described-links, change this setting to 1.


UseModWiki | UseModWiki | RecentChanges | Preferences
Edit text of this page | View other revisions | Search MetaWiki
Last edited September 13, 2016 11:35 pm by MarkusLude (diff)
Search: