Seitenlistenvariablen

für die Liste aller Seiten

%apply=item id=EnablePageListProtect?%$EnablePageListProtect

Auf 1 gesetzt (das ist der Standard), bewirkt diese Variable, dass (:pagelist:) und (:searchresult:) die Seiten nicht mit auflisten, für die der Besucher aktuell kein Leserecht hat. Setzt man diese Variable auf 0, bedeutet das, dass lesegeschützte Seiten in Seitenlisten auftauchen können, andererseits kann das die Suchgeschwindigkeit erheblich heraufsetzen (weil die Seitenerlaubnisse nicht geprüft werden müssen).

%apply=item id=PageListSortCmpFunction?%$PageListSortCmpFunction

Die Funktion wird genutzt, um Werte für die Reihenfolge miteinander zu vergleichen, aus historischen Gründen ist die Voreinstellung 'strcasecmp' und sortiert alphabetisch und unabhängig von der Groß/Kleinschreibung. Wenn Sie regelmäßig Zahlen oder Strings mit Zahlen sortieren, können Sie diese Variable auf 'strnatcasecmp' setzen und die Liste wird gemäß einer natürlichen Reihenfolge sortiert, unabhängig von der Groß/Kleinschreibung.
$PageListSortCmpFunction = 'strnatcasecmp';# "natürliche" Sortierung von Seitenlisten
Oder Sie geben hier den Namen einer selbstgeschriebenen Sortierfunktion an. Dies ist die allgemeine Sortierfunktion, für spezielle Anforderungen können Sie spezifische Funktionen schreiben, siehe Angepasste Seitenlistenreihenfolge.

%apply=item id=PageListVarFoldFn?%$PageListVarFoldFn

Seitenlisten- und Such-Ausdrücke, einschließlich Seitenvariablensuchausdrücke, sind für das lateinische Alphabet immer groß/kleinschreibungsunabhängig. Für internationale Zeichen waren die Seitenvariablen-Ausdrücke bis PmWiki 2.2.115 groß/kleinschreibungsabhängig und wurden groß/kleinschreibungsunabhängig ab 2.2.116 (wie beim lateinischen Alphabet). Wenn Ihre Seitenlisten auf das bisherige Verhalten angewiesen sind, können Sie hier den Namen einer Funktion setzen, die die Groß/Kleinschreibung internationaler Zeichen nicht ändert, z. B.:

$PageListVarFoldFn = 'strval';

%apply=item id=SearchPatterns?%$SearchPatterns

Ein Array von Seitennamenmustern, die nötig sind für – oder ausgeschlossen werden sollen von – Such- und Seitenlisten-Ergebnissen. Damit eine Seite in eine Suchliste oder Seitenliste aufgenommen wird, darf sie nicht auf ein Muster mit einem Ausrufezeichen am Beginn passen, muss aber auf alle anderen Muster passen. Siehe Cookbook:SearchPatterns.

# begrenze jede Suche auf die Gruppe 'Main'
$SearchPatterns['default'][] = '/^Main\\./';
# Schließe die Gruppe 'Main' von den Suchergebnissen aus
$SearchPatterns['default'][] = '!^Main\\.!';
# Schließe die 'RecentChanges'-Seiten aller Gruppe und die
# 'AllRecentChanges'-Seite von den Suchergebnissen aus
$SearchPatterns['default'][] = '!\\.(All)?RecentChanges$!';
# Schütze Seiten davor, sich selbst zu listen
$SearchPatterns['default'][] = FmtPageName('!^$FullName$!', $pagename);

%apply=item id=SearchBoxOpt?%$SearchBoxOpt

Zum Beispiel $SearchBoxOpt ['target'] = '$DefaultGroup.Search';

%apply=item id=SearchBoxInputType?%$SearchBoxInputType

Das HTML "type"-Attribut für das Suchfeld. Vorgabe ist "text" und damit valides HTML4?. Wenn Ihr Skin HTML5? benutzt, können Sie das auf "search" abändern:

$SearchBoxInputType = "search";

%apply=item id=EnablePageIndex?%$EnablePageIndex

Auf 0 gesetzt, wird die Standardindizierung abgeschaltet. Standardmäßig verwaltet PmWiki einen "Link- und Wortindex" in $PageIndexFile, der die Behandlung von Kategorien und Rückverweise sowie die Suche erheblich beschleunigt.

%apply=item id=PageIndexFile?%$PageIndexFile

Hierin steht der Ort für die Seitenindexdatei für Seitenlisten ((:pagelist:)). Der Standard dafür ist $Workdir/.pageindex.

%apply=item id=PageListCacheDir?%$PageListCacheDir

enthält den Namen eines beschreibbaren Verzeichnisses, wo PmWiki Ergebnisse von (:pagelist:)-Direktiven zwischenspeichern kann, um schnell aufeinanderfolgende Anzeigen der gleichen Seitenliste zu beschleunigen. Die Variable ist standardmäßig leer, wodurch das Zwischenspeichern abgeschaltet ist.

# Enable pagelist caching in work.d/.pagelistcache
$PageListCacheDir = 'work.d/.pagelistcache';

%apply=item id=PageSearchForm?%$PageSearchForm

Hierin steht der Name der Seite, die benutzt wird, um die Ausgabe von Suchergebnissen zu gestalten für ?action=search (es sei denn, die aktuelle Seite enthält selbst eine "Suchergebnis"-Direktive in sich). Diese Variable kann ein Array sein, in dem Fall wird die erste Seite aus dem Array benutzt, die gefunden wird.

# Einfacher Einsatz des Seitensuchformulars in der Standardgruppe
$PageSearchForm = '$DefaultGroup.Search';

# Benutze die Suchseite der aktuellen Gruppe, falls sie existiert, 
# andernfalls benutze Site.Search
$PageSearchForm = array('$Group.Search', '[=$[$SiteGroup/Search]=]');

%apply=item id=FPLTemplatePageFmt?%$FPLTemplatePageFmt

Hierin steht der Name der Seiten, in denen nach einer Seitenlistenvorlage gesucht wird, die durch einen fmt=#xyz-Parameter angegeben wurde. Voreingestellt sind die aktuelle Seite, Site.LocalTemplates? und Site.PageListTemplates.

# PmWikis Standardeinstellung
global $FPLTemplatePageFmt;
$FPLTemplatePageFmt = array(
    '{$FullName}', 
    '{$SiteGroup}.LocalTemplates', 
    '{$SiteGroup}.PageListTemplates');

# Durchsuche auch eine Gruppen.Vorlagen-Seite (Group.Templates) 
# vor den beiden Volagenseiten aus der Site-Gruppe;
global $FPLTemplatePageFmt;
$FPLTemplatePageFmt = array(
    '{$FullName}', 
    '{$Group}.Templates',
    '{$SiteGroup}.LocalTemplates',
    '{$SiteGroup}.PageListTemplates');

# Durchsuche eine Gruppen.Vorlagen-Seite (Group.Templates) 
# vor den beiden Volagenseiten aus der Site-Gruppe;
SDV($FPLTemplatePageFmt, array(
        '{$FullName}',
        '{$Group}.Templates',
        '{$SiteGroup}.LocalTemplates', 
        '{$SiteGroup}.PageListTemplates')
   );

%apply=item id=EnableUndefinedTemplateVars?%$EnableUndefinedTemplateVars

Diese Variable kontrolliert, wie mit einer nicht definierten {$$Variable} umgegangen wird in includes und Seitenlistenvorlagen. Bei dem Wert 0 werden nicht definierte {$$Variable}n von dem Include-Abschnitt oder aus der Vorlage entfernt. Bei dem Wert 1 werden nicht definierte {$$Variable}n angezeigt wie sie sind, mit {$$...}. ''Hinweis: PmWiki 2.2.13 und früher belassen nicht gesetzte include/template-Variablen.

$EnableUndefinedTemplateVars = 0; # lösche nicht gesetzte Vorlagenvariablen

$EnableUndefinedTemplateVars = 1; # belasse nicht gesetzte Vorlagenvariablen und gib sie aus

%apply=item id=PageIndexFoldFunction?%$PageIndexFoldFunction

Eine vom Benutzer/Administrator definierte Funktion, die eingesetzt wird, um die Wörter der Seite zu 'falten' (vereinfachen, normalisieren), bevor sie in der wiki.d/.pageindex-Datei gespeichert werden, sowie die Suchterme, die der Benutzer eingibt. Gewöhnlich konvertiert PmWiki diese zur Kleinschreibung, hier können Sie eine Funktion definieren, die das anders behandelt (z. B. Inline-HTML-Tags herauslösen).

%apply=item id=PageIndexTermsFunction?%$PageIndexTermsFunction

Eine Funktion, die die Seitentexte in normalisierte Suchterme zerlegt. Per Voreinstellung wird die Funktion PageIndexTerms?() aufgerufen, mit dieser Variablen können Sie sie durch eine selbsterstellte Funktion überschreiben. Das könnte nützlich sein, wenn es erforderlich ist, dass Sie bestimmte Texte vom Seitenindex entfernen, z. B. Inline-HTML-Tags. Das erste und einzige Argument der Ersatzfunktion kann entweder eine Zeichenkette oder ein Array aus Zeichenketten sein.

für die Liste aller Seiten