FAQ

config.php

%newwin% https://example.com/ %%
* mailto:myaddress@example.com
* [[mailto:myaddress@example.com]]
* [[mailto:myaddress@example.com | email me]]
* [[mailto:myaddress@example.com?subject=Some subject | email me]]

[[https://example.com/ | WikiWord]]
[[WikiWord -> https://example.com/]]
(:pagelist link=SomePage list=all:)   -- show all links to SomePage
(:pagelist link={$FullName} list=all:)  -- show all links to the current page
(:if exists Group1.Page:)
   [[Group1.Page|Page]]
(:elseif exists Group2.Page:)
   [[Group2.Page|Page]]
(:ifend:)
DisableMarkup('img');
$ImgExtPattern = "$^";

|| border=1 rules=rows frame=hsides
|| cell 1 || cell 2 || cell 3 ||
|| cell 1 || cell 2 || cell 3 ||

|| border=1 rules=cols frame=vsides
||! cell 1 ||! cell 2 ||! cell 3 ||
|| cell 1  ||  cell 2 ||  cell 3 ||

||border="1" style="border-collapse:collapse" cellpadding="5" width=66%
||!Header ||! Header || '''Header'''||
||cells   ||  with   ||      padding||
||        ||         ||             ||

table.column td.col1 { width: 120px; }
table.column td.col3 { width: 40px; }

(:if ! name {PmWiki.IncludeOtherPages$FullName}:) 
%comment% name of this page is not the same as the page this text was sourced from
->[[{PmWiki.IncludeOtherPages$FullName}#anchor | more ...]]
(:ifend:)

      $LinkFunctions['PmWikiHome:'] = 'LinkIMap';
      $IMap['PmWikiHome:'] = 'https://pmwiki.org/wiki/$1';

 Root    /

 Root:commoninfo/infoaboutu.php

### If you use Site.SiteHeader and Group.GroupHeader
$GroupHeaderFmt = '(:include {$SiteGroup}.SiteHeader'
  . ' basepage={*$FullName}:)(:nl:)' . $GroupHeaderFmt;

### If you use Site.SiteHeader instead of Group.GroupHeader
$GroupHeaderFmt = '(:include {$SiteGroup}.SiteHeader'
  . ' basepage={*$FullName}:)(:nl:)';

### If you use Site.SiteFooter and Group.GroupFooter
$GroupFooterFmt .= '(:nl:)(:include {$SiteGroup}.SiteFooter'
  . ' basepage={*$FullName}:)';

### If you use Site.SiteFooter instead of Group.GroupFooter
$GroupFooterFmt = '(:nl:)(:include {$SiteGroup}.SiteFooter'
  . ' basepage={*$FullName}:)';

$group = FmtPageName('$Group', $pagename);
$DefaultPasswords['edit'] = 'id:'.$group;
include_once("$FarmD/scripts/authuser.php"); 
count=1..10       # first ten pages of list
count=5..10       # 5th through 10th pages of list
count=10..        # skip first ten pages
count=..10        # 1st through 10th page of list
count=-10..       # last ten pages of list
count=..-10       # all but the last nine pages
count=5..10       # 5th through 10th pages of list
count=10..5       # same as 5..10 but in reverse sequence
count=-1..1       # all pages in reverse sequence
(:pagelist order=-name count=10:)
(:pagelist order=-name count=1..10:)
(:pagelist order=name count=-1..-10:) 
(:pagelist request=1:)

(:pagelist request=order,count:)

(:pagelist request=-fmt,-trail:)

  (:pagelist if="date {(ftime %GW%V {*$Name})} {=$Name}" :)

  (:pagelist if="date 2009-01-01..2009-12-31 '{=$:Mydate}'" :)

>>comment<<
[[#tvars]]
(:template default count=1 ParamName=Simon:)
Hi, , how are you today?
[[#tvarsend]]
>><<

(:pagelist fmt=#tvars ParamName="Sam":)

(:pagelist fmt=#tvars ParamName="Sally":)

(:pagelist fmt=#tvars:)

 (:searchbox label="Search this wiki":)

XLSDV('en', array(
        'SearchFor' => 'Results of search for <em>$Needle</em>:',
        'SearchFound' => 
                '$MatchCount pages found out of $MatchSearched pages searched.'
));
SDV($SearchResultsFmt, "<div class='wikisearch'>\$[SearchFor]
  <div class='vspace'></div>\$MatchList
  <div class='vspace'></div>\$[SearchFound]</div>");
    $WikiLibDirs = array(&$WikiDir,
      new PageStore('/path/to/existing/wiki.d/{$FullName}'),
      new PageStore('wikilib.d/{$FullName}'));

$UploadExtSize['zip'] = 0;  # Disallow uploading .zip files
$UploadExtSize[''] = 0;     # Disallow files with no extension
$UploadPrefixFmt = '/$FullName';    # per-page, in Group.Name directories
$UploadPrefixFmt = '/$Group/$Name'; # per-page, in Group directories with Name subdirectories
$UploadPrefixFmt = '';   # site-wide
   $UploadDirQuota = 100*1024;         # limit uploads to 100KiB
   $UploadDirQuota = 1000*1024;        # limit uploads to 1000KiB
   $UploadDirQuota = 1024*1024;        # limit uploads to 1MiB
   $UploadDirQuota = 25*1024*1024;     # limit uploads to 25MiB
   $UploadDirQuota = 2*1024*1024*1024; # limit uploads to 2GiB
## Allow passwordless editing from own turf, pass for others.
if ($action=='edit'
 && !preg_match("/^90\\.68\\./", $_SERVER['REMOTE_ADDR']) )    
 { $DefaultPasswords['edit'] = pmcrypt('foobar'); }

if($_SERVER['REMOTE_ADDR'] == '127.0.0.1') { # your IP address here
 $_POST['authpw'] = 'xxx';                  # the admin password
}

  $EnablePostAuthorRequired = 1;

$DiffStartFmt = 
  "<div class='diffbox'><div class='difftime'><a name='diff\$DiffGMT' href='#diff\$DiffGMT'>\$DiffTime</a>
   \$[by] <span class='diffauthor'>\$DiffAuthor</span> - \$DiffChangeSum</div>";

SDV($HideDiscussion, 0); 	#define var name
Markup('hideDiscussion', '<{$var}',
 '/\\(:nodiscussion:\\)/', 'setHideDiscussion'); 
function setHideDiscussion() { 
  global $HideDiscussion; 
  $HideDiscussion = true;
} 

$WikiStyle['vMenu']['background']='#ffffcc' ;
$WikiStyle['vMenu']['float']='left' ;
$WikiStyle['vMenu']['border']='1px dotted red' ;

.noul a {text-decoration: none;}
.noul a:hover {text-decoration: underline; color: blue;}
  %noul% [[Link]] %%

   XLPage('es','PmWikiEs.XLPage');
   XLPage('fr','PmWikiFr.XLPage');
   XLPage('ru','PmWikiRu.XLPage');
   $XLLangs = array('en');
    XLPage('fr-ca', 'PmWikiFrCa.XLPage');
    XLPage('fr', 'PmWikiFr.XLPage');
## Get the group and page name
$pagename = ResolvePageName($pagename);
$page = PageVar($pagename, '$FullName');
$group = PageVar($pagename, '$Group');
$name = PageVar($pagename, '$Name');

if($_SERVER['SERVER_ADDR'] == '127.0.0.1') {
  # Home wiki

}
else {
  # Online wiki

}
function MarkupExcerpt($pagename) {
    $page = RetrieveAuthPage($pagename, 'read', false);
    return substr(@$page['text'], 0, 200);
}

$FmtPV['$MarkupExcerpt'] = 'MarkupExcerpt($pn)';
$FeedFmt['rss']['item']['description'] = '$MarkupExcerpt';
$FeedFmt['rss']['item']['description'] = '$LastSummary'; 
$FeedFmt['rss']['item']['title'] = '{$Group} / {$Title} @ $ItemISOTime';
    .../AllRecentChanges?action=rss&authpw=secret

$FeedFmt['rss']['feed']['image'] =
" <title>Logo title</title>
 <link>https://example.com/</link>
 <url>https://example.com/images/logo.gif</url>
 <width>120</width>
 <height>60</height>";

   if ($action == 'rss')
     SDVA($_REQUEST, array(
       'group' => 'News',
       'order' => '-time',
       'count' => 10));

$HTMLHeaderFmt['feedlinks'] = '<link rel="alternate" type="application/rss+xml" 
  title="$WikiTitle" href="$ScriptUrl?n=Site.AllRecentChanges&amp;action=rss" />
<link rel="alternate" type="application/atom+xml" title="$WikiTitle"
  href="$ScriptUrl?n=Site.AllRecentChanges&amp;action=atom" />';
   if (PageVar($pagename, '$Group')!='ForbiddenGroup') {
     $RecentChangesFmt['Site.MyFeedPage'] =
       '* [[{$FullName}]]  . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]';
   }

   $FeedFmt['rss']['item']['guid'] = '{$PageUrl}?guid=$ItemISOTime';

   ## For new pages updates: https://example.com/wiki/HomePage?action=rss
   ## For edits updates: https://example.com/wiki/HomePage?action=rss&edits=1
   if(@$_REQUEST['edits'] && $action == 'rss')
     $FeedFmt['rss']['item']['guid'] = '{$PageUrl}?guid=$ItemISOTime';

Warning: session_write_close() [function.session-write-close]:
open(/some/filesystem/path/to/a/directory/sess_[...]) failed: No such file
or directory (2) in /your/filesystem/path/to/pmwiki.php on line NNN

    $TableRowIndexMax = 1;

$DefaultPasswords['admin'] = array( pmcrypt('masterpass'), # global password
    '@admins', '@moderators', # +users in these groups
    'id:Fred', 'id:Barney');  # +users Fred and Barney
## Define usernames and passwords.
$AuthUser['carol'] = '$1$CknC8zAs$dC8z2vu3UvnIXMfOcGDON0';

## Enable authentication based on username.
include_once('scripts/authuser.php');

# $DefaultPasswords['admin'] = pmcrypt('secret');
$DefaultPasswords['admin'] = 'id:carol';

$HandleAuth['upload'] = 'edit';
// And to prevent a WikiSandbox from having it's 'attr' permissions changed 
// except by the admin (but allowing editors to change it on their own pages/group)
if(($group=="Site") || ($group=="Main") || ($group=="Category") || 
   ($group=="SiteAdmin") || ($group=="PmWiki") ) {
        $HandleAuth['attr'] = 'admin';  // for all main admin pages, set 'attr' to 'admin' password
} else { 
        $HandleAuth['attr'] = 'edit';  // if you can edit, then you can set attr
}

A simple bullet list of ten most recently modified pages	`(:pagelist trail=Site.AllRecentChanges count=10 fmt=#simple:)`
Display the first ten pages of a list	`count=10 # display the first ten pages of list`
Negative numbers specify pages to be displayed from the end of the list:	`count=-10 # display last ten pages of list`
Ranges may be specified using '..', thus:	count=1..10 # first ten pages of list count=5..10 # 5th through 10th pages of list
Negative numbers in ranges count from the end of the list:	`count=-10..-5 # 10th from end, 9th from end, ..., 5th from end`
Omitting the start or end of the range uses the start or end of the list:	count=10.. # skip first ten pages count=..10 # 1st through 10th page of list count=-10.. # last ten pages of list count=..-10 # all but the last nine pages
Ranges can be reversed, indicating that the order of pages in the output should likewise be reversed:	count=5..10 # 5th through 10th pages of list count=10..5 # same as 5..10 but in reverse sequence count=-1..1 # all pages in reverse sequence
"Reverse sequence" here refers to the sequence after any sorting has taken place. Therefore the three directives to the right are equivalent:	(:pagelist order=-name count=10:) (:pagelist order=-name count=1..10:) (:pagelist order=name count=-1..-10:)

FAQ

FAQ

link= and category=

count=

wrap=

class=

request=

req=1

passwd=

if=

order=

cache=0

Specifying variables as parameters

Examples

The Searchbox Directive

The Searchresults directive

Customizing "Results of search for..." and "3 pages found out of..."

See Also

FAQ

Wiki Vandalism and Spam