Documentation update.

git-svn-id: svn://pmwiki.org/pmwiki/trunk@2356 524c5546-5005-0410-9a3e-e25e191bd360

1 files changed, 3 insertions, 5 deletions

diff --git a/wikilib.d/PmWiki.LinkVariables b/wikilib.d/PmWiki.LinkVariables
index 3f0449e7..634459f3 100644
--- a/wikilib.d/PmWiki.LinkVariables
+++ b/wikilib.d/PmWiki.LinkVariables
@@ -5,9 +5,7 @@ charset=ISO-8859-1
 csum=
 host=81.65.14.164
 name=PmWiki.LinkVariables
-passwdattr=
-passwdedit=
-rev=55
+rev=57
 targets=PmWiki.CustomInterMap,PmWiki.PageDirectives
-text=(:Summary:variables that control the display of links in pages:)%0a(:Audience: admins (advanced):)%0a:$EnableLinkPageRelative:When enabled, causes PmWiki to use relative urls for page links instead of absolute urls.%0a        $EnableLinkPageRelative = 1;%0a%0a:$PagePathFmt: This array lists the order in which PmWiki looks for the page that you ''most likely'' are attempting to link to. The default is listed below. Look at Cookbook:PagePaths for some ideas.%0a        [=array('{$Group}.$1','$1.$1'.'$1.{$DefaultName}')=]%0a%0a:$LinkPageExistsFmt:The (HTML) string to output for links to already existing wiki pages.  Defaults to %0a        %3ca class='wikilink' href='\$LinkUrl'>\$LinkText%3c/a>%0a%0a:$LinkPageCreateFmt:The (HTML) string to output for links to non-existent wiki pages.  The default is to add a '?' after the link text with a link to the page edit/create form.  Defaults to%0a        %3ca class='createlinktext' href='\$PageUrl?action=edit'>\$LinkText%3c/a>%0a        %3ca class='createlink' href='\$PageUrl?action=edit'>?%3c/a>%0a%0a:$LinkPageCreateSpaceFmt:Same as $LinkPageCreateFmt, but used when the link text has a space in it. %0a%0a:$LinkPageSelfFmt:The (HTML) string to output for self-referencing links (i.e. links to the page itself).  Defaults to%0a        %3ca class='selflink' href='\$LinkUrl'>\$LinkText%3c/a>%0a%0a:$UrlLinkFmt:The (HTML) string to output for URL-links that begin with 'http:', 'ftp:', etc.  Defaults to%0a        %3ca class='urllink' href='\$LinkUrl' rel='nofollow'>\$LinkText%3c/a>%0a%0a:$IMapLinkFmt: an array of link formats for various link "schemes". Not set as default.%0a->Examples of custom formats to allow different styling via classes: %0a->Links to http: standard url links:%0a         $IMapLinkFmt['http:'] = "%3ca class='httplink urllink' href='\$LinkUrl'>\$LinkText%3c/a>";  %0a->Links to https: secure pages:%0a         $IMapLinkFmt['https:'] = "%3ca class='httpslink urllink' href='\$LinkUrl'>\$LinkText%3c/a>";   %0a->Links to PmWiki: InterMap shortcut:%0a         $IMapLinkFmt['PmWiki:'] = "%3ca class='pmwikilink urllink' href='\$LinkUrl'>\$LinkText%3c/a>"; %0a->Links to Cookbook: InterMap shortcut %0a         $IMapLinkFmt['Cookbook:'] = "%3ca class='cookbooklink urllink' href='\$LinkUrl'>\$LinkText%3c/a>"; %0a%0a:$InterMapFiles:An array consisting a list of files and pages containing InterMap entries to be loaded (see [[CustomInterMap]]).%0a%0a:$MakePageNameFunction:Name of a custom function to replace `MakePageName(), which converts strings into valid page names.%0a%0a:$MakePageNamePatterns:%0a: :$MakePageNamePatterns is an array of regular expression replacements that is used to map the page link in a ''free link'' such as [@[[free link]]@] into a page name. Currently the default sequence is: [@%0a    "/'/" => '',                           # strip single-quotes%0a    "/[^$PageNameChars]+/" => ' ',         # convert non-alnums to spaces%0a    "/((^|[^-\\w])\\w)/e" %0a      => "strtoupper('$1')",               # initial caps after spaces%0a    "/ /" => ''                            # strip spaces%0a@]%0a%0a:$WikiWordCountMax:The maximum number of times to convert each WikiWord encountered on a page.  Defaults to 1,000,000.  Common settings for this variable are zero (disable WikiWord links) and one (convert only the first occurrence of each WikiWord).%0a        $WikiWordCountMax = 0;     # disable WikiWord links%0a        $WikiWordCountMax = 1;     # convert only first WikiWord%0a%0a:$WikiWordCount:An array that allows the number of WikiWord conversions to be set on a per-WikiWord basis.  The default is to use $WikiWordCountMax unless a value is set in this array.  By default PmWiki sets @@$WikiWordCount['PmWiki']=1@@ to limit the number of conversions of "PmWiki".%0a        $WikiWordCount[=['PhD']=0;     # Don't convert "PhD"=]%0a        $WikiWordCount['WikiWord']=5;  # Convert WikiWord 5 times%0a        # the following lines keep a page from linking to itself%0a        $title = [=FmtPageName=]('$Title_',$pagename);%0a        $WikiWordCount[$title]=0;   %0a %0a:$EnableRedirectQuiet:Enable the @@quiet=1@@ parameter for the [[PmWiki.PageDirectives#redirect|redirect directive]]. On publicly edited wikis it is advisable not to enable quiet redirects.%0a        $EnableRedirectQuiet = 0;     # disable quiet redirects (default)%0a        $EnableRedirectQuiet = 1;     # enable quiet redirects%0a
-time=1246996348
+text=(:Summary:variables that control the display of links in pages:)%0a(:Audience: admins (advanced):)%0a:$EnableLinkPageRelative:When enabled, causes PmWiki to use relative urls for page links instead of absolute urls.%0a        $EnableLinkPageRelative = 1;%0a%0a:$PagePathFmt: This array lists the order in which PmWiki looks for the page that you ''most likely'' are attempting to link to. The default is listed below. Look at Cookbook:PagePaths for some ideas.%0a        [=array('{$Group}.$1','$1.$1'.'$1.{$DefaultName}')=]%0a%0a:$LinkPageExistsFmt:The (HTML) string to output for links to already existing wiki pages.  Defaults to %0a        %3ca class='wikilink' href='\$LinkUrl'>\$LinkText%3c/a>%0a%0a:$LinkPageCreateFmt:The (HTML) string to output for links to non-existent wiki pages.  The default is to add a '?' after the link text with a link to the page edit/create form.  Defaults to%0a        %3ca class='createlinktext' href='\$PageUrl?action=edit'>\$LinkText%3c/a>%0a        %3ca class='createlink' href='\$PageUrl?action=edit'>?%3c/a>%0a%0a:$LinkPageCreateSpaceFmt:Same as $LinkPageCreateFmt, but used when the link text has a space in it. %0a%0a:$LinkPageSelfFmt:The (HTML) string to output for self-referencing links (i.e. links to the page itself).  Defaults to%0a        %3ca class='selflink' href='\$LinkUrl'>\$LinkText%3c/a>%0a%0a:$UrlLinkFmt:The (HTML) string to output for URL-links that begin with 'http:', 'ftp:', etc.  Defaults to%0a        %3ca class='urllink' href='\$LinkUrl' rel='nofollow'>\$LinkText%3c/a>%0a%0a:$IMapLinkFmt: an array of link formats for various link "schemes". Not set as default.%0a->Examples of custom formats to allow different styling via classes: %0a->Links to http: standard url links:%0a         $IMapLinkFmt['http:'] = "%3ca class='httplink urllink' href='\$LinkUrl'>\$LinkText%3c/a>";  %0a->Links to https: secure pages:%0a         $IMapLinkFmt['https:'] = "%3ca class='httpslink urllink' href='\$LinkUrl'>\$LinkText%3c/a>";   %0a->Links to PmWiki: InterMap shortcut:%0a         $IMapLinkFmt['PmWiki:'] = "%3ca class='pmwikilink urllink' href='\$LinkUrl'>\$LinkText%3c/a>";%0a%0a:$InterMapFiles:An array consisting a list of files and pages containing InterMap entries to be loaded (see [[CustomInterMap]]).%0a%0a:$MakePageNameFunction:Name of a custom function to replace `MakePageName(), which converts strings into valid page names.%0a%0a:$MakePageNamePatterns:%0a: :$MakePageNamePatterns is an array of regular expression replacements that is used to map the page link in a ''free link'' such as [@[[free link]]@] into a page name. Currently the default sequence is: [@%0a    "/'/" => '',                           # strip single-quotes%0a    "/[^$PageNameChars]+/" => ' ',         # convert non-alnums to spaces%0a    "/((^|[^-\\w])\\w)/e" %0a      => "strtoupper('$1')",               # initial caps after spaces%0a    "/ /" => ''                            # strip spaces%0a@]%0a%0a:$WikiWordCountMax:The maximum number of times to convert each WikiWord encountered on a page.  Defaults to 1,000,000.  Common settings for this variable are zero (disable WikiWord links) and one (convert only the first occurrence of each WikiWord).%0a        $WikiWordCountMax = 0;     # disable WikiWord links%0a        $WikiWordCountMax = 1;     # convert only first WikiWord%0a%0a:$WikiWordCount:An array that allows the number of WikiWord conversions to be set on a per-WikiWord basis.  The default is to use $WikiWordCountMax unless a value is set in this array.  By default PmWiki sets @@$WikiWordCount['PmWiki']=1@@ to limit the number of conversions of "PmWiki".%0a        $WikiWordCount[=['PhD']=0;     # Don't convert "PhD"=]%0a        $WikiWordCount['WikiWord']=5;  # Convert WikiWord 5 times%0a        # the following lines keep a page from linking to itself%0a        $title = [=FmtPageName=]('$Title_',$pagename);%0a        $WikiWordCount[$title]=0;   %0a %0a:$EnableRedirectQuiet:Enable the @@quiet=1@@ parameter for the [[PmWiki.PageDirectives#redirect|redirect directive]]. On publicly edited wikis it is advisable not to enable quiet redirects.%0a        $EnableRedirectQuiet = 0;     # disable quiet redirects (default)%0a        $EnableRedirectQuiet = 1;     # enable quiet redirects%0a
+time=1246997167