aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/sample-config.php45
1 files changed, 26 insertions, 19 deletions
diff --git a/docs/sample-config.php b/docs/sample-config.php
index fdc7482a..27c665b2 100644
--- a/docs/sample-config.php
+++ b/docs/sample-config.php
@@ -40,30 +40,34 @@ $Skin = 'pmwiki-responsive';
## Highly recommended for new wikis.
include_once("scripts/xlpage-utf-8.php");
-## If you're running a publicly available site and allow anyone to
-## edit without requiring a password, you probably want to put some
-## blocklists in place to avoid wikispam. See PmWiki.Blocklist.
-# $EnableBlocklist = 1; # enable manual blocklists
-# $EnableBlocklist = 10; # enable automatic blocklists
+## When installing a new wiki, if you expect to have a large number of
+## pages, per-group storage may be appropriate. For migrating existing
+## wikis, see Cookbook:PerGroupSubDirectories
+# $WikiDir = new PageStore('wiki.d/{$Group}/{$FullName}');
+
+## You can enable a number of functions improving your experience
+## editing and reviewing pages. This includes LocalTimes, PmSyntax,
+## GUIButtons, TableOfContents and more, search the documentation
+## for this variable:
+# $EnableCommonEnhancements = 1;
## PmWiki comes with graphical user interface buttons for editing;
## to enable these buttons, set $EnableGUIButtons to 1.
+## (included in $EnableCommonEnhancements)
# $EnableGUIButtons = 1;
-## This enables a message if editors have modified a page but try to
-## move away from the edit form before saving the text.
-$EnableNotSavedWarning = 1; # 1: warn editors; 0: disable warning
-
## You can enable syntax highlighting for the documentation and/or
## for the edit form.
+## (included in $EnableCommonEnhancements)
# $EnablePmSyntax = 1; # or 2, see documentation
## For a basic table of contents, see page PmWiki/TableOfContents
+## (included in $EnableCommonEnhancements)
# $PmTOC['Enable'] = 1;
## To enable markup syntax from the Creole common wiki markup language
## (http://www.wikicreole.org/), include it here:
-# include_once("scripts/creole.php");
+# $EnableCreole = 1;
## Some sites may want leading spaces on markup lines to indicate
## "preformatted text blocks", set $EnableWSPre=1 if you want to do
@@ -107,7 +111,7 @@ $UploadPermAdd = 0; # Recommended for most new installations
## By default, viewers are prevented from seeing the existence
## of read-protected pages in search results and page listings,
## but this can be slow as PmWiki has to check the permissions
-## of each page. Setting $EnablePageListProtect to zero will
+## of each page. Setting $EnablePageListProtect to zero may
## speed things up considerably, but it will also mean that
## viewers may learn of the existence of read-protected pages.
## (It does not enable them to access the contents of the pages.)
@@ -115,14 +119,11 @@ $UploadPermAdd = 0; # Recommended for most new installations
## The refcount.php script enables ?action=refcount, which helps to
## find missing and orphaned pages. See PmWiki.RefCount.
-# if ($action == 'refcount') include_once("scripts/refcount.php");
+# $EnableRefCount = 1;
-## The feeds.php script enables ?action=rss, ?action=atom, ?action=rdf,
-## and ?action=dc, for generation of syndication feeds in various formats.
-# if ($action == 'rss') include_once("scripts/feeds.php"); # RSS 2.0
-# if ($action == 'atom') include_once("scripts/feeds.php"); # Atom 1.0
-# if ($action == 'dc') include_once("scripts/feeds.php"); # Dublin Core
-# if ($action == 'rdf') include_once("scripts/feeds.php"); # RSS 1.0
+## You can enable ?action=rss, ?action=atom, ?action=rdf, and ?action=dc,
+## for generation of syndication feeds for Recent Changes pages.
+# $EnableFeeds['rss'] = 1; # RSS 2.0
## By default, pages in the Category group are manually created.
## Uncomment the following line to have blank category pages
@@ -131,6 +132,12 @@ $UploadPermAdd = 0; # Recommended for most new installations
## the author has edit permissions to the Category group.)
# $AutoCreate['/^Category\\./'] = array('ctime' => $Now);
+## If you're running a publicly available site and allow anyone to
+## edit without requiring a password, you probably want to put some
+## blocklists in place to avoid wikispam. See PmWiki.Blocklist.
+# $EnableBlocklist = 1; # enable manual blocklists
+# $EnableBlocklist = 10; # enable automatic blocklists
+
## PmWiki allows a great deal of flexibility for creating custom markup.
## To add support for '*bold*' and '~italic~' markup (the single quotes
## are part of the markup), uncomment the following lines.
@@ -142,8 +149,8 @@ $UploadPermAdd = 0; # Recommended for most new installations
## are turned into links, uncomment the line below. See PmWiki.UrlApprovals.
## Also, setting $UnapprovedLinkCountMax limits the number of unapproved
## links that are allowed in a page (useful to control wikispam).
+# $EnableUrlApprove = 1;
# $UnapprovedLinkCountMax = 10;
-# include_once("scripts/urlapprove.php");
## The following lines make additional editing buttons appear in the
## edit page for subheadings, lists, tables, etc.