Grundlegende Variablen

für die Liste aller Seiten

Eine Einleitung zur Verwendung fehlt Sofern die Werte verfügbar sind, werden sie am rechten Rand angegeben als Variablenwert: "{$VariableName}".

$AsSpacedFunction

Name der verwendeten Funktion um WikiWörter in normal getrennte Ausdrücke zu verwandeln. Standard ist '`AsSpaced'.

$AsSpacedFunction = 'MyAsSpaced';

Variablenwert von $Author: ""

$Author

Wird auf den aktuellen Leser gesetzt, der potentiell ein Autor ist (siehe Diskussion). Siehe auch $EnablePostAuthorRequired.

$AuthorGroup

Die WikiGruppe für Benutzerprofile. Voreinstellung ist 'Profiles'. Diese Gruppe ist implizit in der Auszeichnung für den Autoren [[~Autorenname]] enthalten.

$AuthorGroup = 'Benutzer';

$AuthId

Auf Websites, die PmWikis nutzerbasierte Autorisierung benutzen, enthält $AuthId den "Leser" oder Loginnamen.

SessionAuth($pagename);

if( isset($AuthId) ) { // dieser Benutzer ist authentifiziert

$AuthPw

englischsprachige Beschreibung steht noch aus, siehe derweil unter AuthId vs AuthPw.

SessionAuth($pagename);

if( isset($AuthPw) ) { // dieser Benutzer hat ein Passwort eingegeben

Variablenwert von $BaseName: "PmWikiDe.BasicVariables"

$BaseName

$BaseNamePatterns

Erlaubt die Besetzung der seitenspezifischen Variable {$BaseName}. Der Schlüssel in dem Hash ist das zu ersetzende Muster und der Wert ist der Ersetzungsstring.

# Wenn {$FullName} 'Group.Page-Draft' enthält, dann ist {$BaseName} 'Group.Page'
$BaseNamePatterns['/-Draft$/'] = '';
# Wenn {$FullName} 'Comments-Group.Page' ist, dann ist {$BaseName} 'Group.Page'
$BaseNamePatterns['/^Comments-/'] = '';

$CategoryGroup

Die Wikigruppe, die für die Kategorien benutzt wird. Standard ist 'Category' (Siehe Kategorien). Diese Variable ist implizit im Markup [[!CategoryName]].

$CookiePrefix

Ein Präfix für Cookies, die von PmWiki gesetzt werden, um Konflikte mit gleichnamigen Cookies anderer Applikationen zu vermeiden, oder um getrennte Cookies für mehrere Wikis in der gleichen Domain zu ermöglichen. Voreinstellung ist '' (leerer String).

$CookiePrefix = 'pmwiki_'; # Cookie-Präfix auf 'pmwiki_' setzen

Eindeutige (getrennte) Cookies in einer WikiFarm erzeugt z. B.

$CookiePrefix = substr($tmp = md5(__FILE__), 0, 5).'_';

Variablenwert von $DefaultGroup: "Main"

$DefaultGroup

Legt eine WikiGruppe als Standard fest. Diese wird (beim Start) angezeigt, wenn keine Gruppe in der URL angegeben wurde.

Variablenwert von $DefaultName: "HomePage"

$DefaultName

Name der Standardstartseite einer WikiGruppe. Er wird verwendet, wenn keine Seite mit dem gleichen Namen wie die Gruppe existiert.

Beachten Sie, dass das Verhalten verschieden ist, je nachdem, ob die Seite existiert oder nicht. Möglicherweise wollen Sie $PagePathFmt zusätzlich zu $DefaultName ändern, damit es auch wirklich eine Wirkung hat.

Beachten Sie den Hinweis unter $DefaultPage bezüglich der Reihenfolge, in der dies in Ihrer (farm)config.php-Datei definiert werden muss - das muss vor jeglichem Aufruf der Funktion ResolvePageName() gesetzt werden.

$DefaultPage

Startseite beim Aufruf von PmWiki ohne eine bestimmte Seitenangabe. Normalerweise: $DefaultGroup.$DefaultName.

Beachten Sie, dass für ein Funktionieren der Variablen $DefaultGroup, $DefaultName und $DefaultPage diese zu Beginn der Datei (farm)config.php definiert sein müssen, bevor ein Aufruf von ResolvePageName() erfolgt, das bedeutet, vor jedem Skript oder jedem Rezept, das diese Funktion aufruft. Das bedeutet auch, dass sie nicht in einem Seiten- oder Gruppenanpassungsskript gesetzt werden können - ResolvePageName() wird aufgerufen, bevor diese Skripten geladen werden.

Beachten Sie bitte, dass diese Variable dafür gedacht ist, sie in der (farm)config.php-Datei zu setzen, nicht in individuellen Gruppen. Der Versuch, $DefaultName, $DefaultPage oder $PagePathFmt in verschiedenen Gruppen unterschiedlich zu setzen, mündet in Anomalien bei gruppenübergreifenden Verweisen.

$EnableLocalConfig

Steuert Anpassungen durch local/config.php (normalerweise für ein Wiki in einer Farm). Ist $EnableLocalConfig in der local/farmconfig.php-Datei auf Null gesetzt, werden die local/config.php-Dateien der Farmwikis nicht geladen.

$EnableLocalConfig = 0; # deaktiviert local/config in den Farmwikis

$EnableStdConfig

Deaktiviert scripts/stdconfig.php und einen großen Teil der Kernfunktionen, die in dem pmwiki/scripts-Verzeichnis bereitgestellt werden, es sei denn, Sie fügen Sie in Ihrer eigenen LOkalem Konfiguration hinzu (insbesondere Kern-Markup-Regeln, Seitenversionen, Skins, Uploads). Das erlaubt es Ihnen, PmWikis Verhalten komplett umzugestalten, wenn es sein muss.

$EnableStdConfig = 0; # deaktiviert weitgehend das Standardverhalten

$EnablePGCust

Erlaubt/Verbietet einzelne Seiten- und Gruppenanpassungen. Der Wert kann in jeder lokalen Anpassung auf null gesetzt werden um verbleibende Seiten- bzw. Gruppenanpassungen zu ignorieren.

$EnablePGCust = 0; # deaktiviert Seiten-/Gruppenanpassungen

$EnableBaseNameConfig

Wenn aktiv, und wenn die Seite eine andere Basisseite (per $BaseNamePatterns) hat, wird die lokale Konfiguration für diese Basisseite eingeschlossen. Wenn die Seite z. B. "Group.Page-Draft" ist, würde dies versuchen, die Datei local/Group.Page.php zusätzlich zu local/Group.Page-Draft.php einzuschließen.

$EnableBaseNameConfig = 1; # Schließe Basisnamen-Konfiguration ein

$EnableRedirect

Wenn aktiv (Voreinstellung), werden Redirects automatisch vom Browser ausgeführt. Wird $EnableRedirect auf Null gesetzt, wartet PmWiki und gibt eine "Redirect to link"-Nachricht aus. Das ist manchmal bei der Fehlersuche nützlich, damit man die Ausgabe sehen kann, bevor die Weiterleitung erfolgt.

$EnableWikiWords

Aktiviert die besondere Behandlung von WikiWörtern.

$EnableWSPre

Wenn dieser Wert größer 0 ist, werden Zeilen mit entsprechend vielen oder mehr führenden Leerzeichen als vorformatierter Text interpretiert. Beispiele:

$EnableWSPre = 1; # ein führendes Leerzeichen erzeugt vorformatierten Text

$EnableWSPre = 0; # führende Leerzeichen haben keine Auswirkung

$EnableWSPre = 4; # Wenigstens vier führende Leerzeichen sind erforderlich

$FTimeFmt

Übersteuert das für "ftime" voreingestellte Datumsformat. Voreinstellung für $FTimeFmt ist $TimeFmt. (Siehe Markup Expressions .)

$GroupPattern

Enthält das reguläre Suchmuster, das für den Test auf zulässige Wikigruppen-Namen verwendet wird. Standardmäßig kann jeder Gruppenname verwendet werden, der mit einem Großbuchstaben beginnt, man kann aber auch die gültigen Gruppennamen einschränken (siehe Cookbook:LimitWikiGroups).

# Gruppen auf Site, SiteAdmin, PmWiki, und MeineGruppe beschränken

$GroupPattern = '(?:Site|SiteAdmin|PmWiki|MeineGruppe)';

# Beachten Sie den '?-i'-Schalter für Nichtbeachtung der Groß/Kleinschreibung

$GroupPattern = '(?-i:Site|SiteAdmin|PmWiki|MeineGruppe)';

$LinkWikiWords

Wenn aktiviert, verlinken alle nackten WikiWörter auf einer Seite automatisch zu Seiten mit dem selben Namen. Dies kann aber durch die Direktiven (:linkwikiwords:) und (:nolinkwikiwords:) beeinflusst werden.

$LinkWikiWords = 1; # aktiviert die WikiWord-Verlinkung

$LinkWikiWords = 0; # deaktiviert die WikiWord-Verlinkung

Beachten Sie, dass das Setzen dieser Variable die Aktivierung von WikiWords erfordert, siehe $EnableWikiWords.

$LogoutRedirectFmt

Bestimmt die Seite, auf die der Benutzer nach ?action=logout weitergeleitet werden soll. Voreinstellung ist die aktuelle Seite.

$LogoutRedirectFmt = 'Site.Logout'; # Weiterleitung hierhin bei ?action=logout

$LogoutCookies

Ein Array mit Namen von Cookies, die bei ?action=logout gelöscht werden sollen.

$NamePattern

Das Suchmuster für reguläre Ausdrücke eines zulässigen Seitennamen. Die Voreinstellung erlaubt Großbuchstaben oder Zahlen zu Beginn eines Namens gefolgt von einer Reihe von Buchstaben, Bindestrichen oder Unterstrichen.

$pagename

Die Variable enthält den Namen der aktuellen Seite.

$page = PageVar($pagename, '$FullName'); # =$pagename
$group = PageVar($pagename, '$Group');
$name = PageVar($pagename, '$Name');

$PagePathFmt

Ein Array, das kontrolliert, wie der Name der Standard-Gruppenstartseite bestimmt wird.

Beachten Sie bitte, dass diese Variable in der (farm)config.php-Datei gesetzt werden sollte, nicht in individuellen Gruppen. Der Versuch, $DefaultName, $DefaultPage or $PagePathFmt in verschiedenen Gruppen unterschiedlich zu setzen, mündet in Anomalien bei gruppenübergreifenden Verweisen.

Variablenwert von $SiteGroup: "Site"

$SiteGroup

Standardgruppe für Konfiguratons- und Hilfsmittelseiten wie Site.EditForm, Site.PageNotFound usw., normalerweise "Site".

Variablenwert von $SiteAdminGroup: "SiteAdmin"

$SiteAdminGroup

Standardgruppe für geschützte Verwaltungsseiten wie SiteAdmin.AuthList, SiteAdmin.AuthUser, SiteAdmin.ApprovedUrls?, usw., normalerweise "SiteAdmin".

$Skin

Der Name des Verzeichnisses, das die Skin-(theme-, Layoutvorlage-)Dateien enthält. Vorgabe ist "pmwiki". Siehe Skins.

$SpaceWikiWords

Ist diese Funktion aktiviert, werden WikiWörter in Seiten automatisch im Rahmen von $AsSpacedFunction getrennt. Dies kann aber durch die Direktiven (:spacewikiwords:) und (:nospacewikiwords:) beeinflusst werden.

$SpaceWikiWords = 1; # aktiviert die WikiWort-Trennung

$SpaceWikiWords = 0; # deaktiviert die WikiWort-Trennung

$TimeFmt

Das verwendete Format für Datums- und Zeitangaben im strftime()-Format. Der Standardwert ist '%B %d, %Y at %I:%M %p', was Daten die Form "September 8, 2005 at 10:57 PM" gibt. In der deutschen I18n wird in PmWikiDe.XLPage die Variable auf "%d.%m.%Y, %H:%M Uhr" gesetzt, das ergibt '29.04.2011, 23:15 Uhr'. Formatiert die $CurrentTime-Variable.

$TimeFmt = '%B %d, %Y'; # ergibt "September 8, 2005"

$TimeFmt = '%Y-%m-%d' ; # ergibt "2005-09-08"

$EnableFTimeNew

Wenn die Variable auf 1 gesetzt ist, aktiviert sie die neue Funktion zum Formatieren von Datum und Zeit für PHP vor 8.1. Das erlaubt Ihnen, die Ausgabe von Datum und Zeit zu sehen, z. B. im Seitenfuß, in den letzten Änderungen und in den Seitenversionen oder im {(ftime)}-Markup-Ausdruck. Siehe Erklärungen dazu in Functions#PSFT. (Für PHP 8.1 ist strftime() missbilligt und die neuen Funktionen sind per Voreinstellung aktiv.)

Variablenwert von $Version: "pmwiki-2.3.33"

$Version

Die Version von PmWiki als String.

Variablenwert von $VersionNum: "2003033"

$VersionNum

Die Version von PmWiki als Nummer "major release" und "minor release" mit Nullen auf drei Stellen aufgefüllt. Damit wird $VersionNum für "pmwiki-2.1.40" zu 2001040.

Die erste Stelle ist '2', die nächsten drei Stellen die "major release" und die letzten drei Stellen die "minor release". Betaversionen verwenden 900-999 als "minor release". Beispiele:

2.1.0          2001000
2.1.1          2001001
...
2.1.27         2001027
2.2.0-beta1    2001901
2.2.0-beta2    2001902
...
2.2.0-beta18   2001918
...
2.2.0          2002000

$WikiWordPattern

Das Muster, das ein WikiWort beschreibt.

$EnableRelativePageVars

Diese Variable kontrolliert, wie Seitenspezifische Variablen und Seiten-Text-Variablen in eingeschlossenen Seiten (included pages) von PmWiki verstanden werden.

$EnableRelativePageVars = 1; # PmWikis aktuelle Standardeinstellung

In diesem Fall zeigt {$Name} den Namen der physischen Seite an, in die die Variable geschrieben wurde. Wenn {$Name} in einer eingeschlossenen Seite aufgerufen wird, wird der Name der eingeschlossenen Seite angezeigt. (Das ist im Augenblick die Voreinstellung von PmWiki). Die in der eingeschlossenen Seite definierten Seiten-Text-Variablen werden, wenn sie aufgerufen werden, ausgewertet und ihr Wert wird angezeigt.

$EnableRelativePageVars = 0; # zurückfallen auf die frühere Standardeinstellung

In diesem Fall zeigt {$Name} den Namen der Seite an, die gerade angesehen wird und in der Hauptseite steht, deren Überschrift man sieht und deren Name in der (URL-) Adresszeile des Browsers steht. Sogar wenn {$Name} in einer eingeschlossenen Seite steht und die eingeschlossene Seite innerhalb der angesehenen Seite angezeigt wird, wird dort der Name der Hauptseite angezeigt. Die in der eingeschlossenen Seite definierten Seiten-Text-Variablen werden nicht ausgewertet, ihr Wert wird nicht angezeigt. So war PmWiki eingestellt in der Version 2.2.8 und in den früheren Versionen. Seit der Version 2.2.9 ist die oben beschriebene Variante eingestellt, sie läßt sich aber zurückstellen auf das alte Verhalten mit dieser Zeile in der config.php.

{*$Name} mit einem Sternchen wird auf jeden Fall den Namen der Hauptseite anzeigen, unabhängig vom Wert von $EnableRelativePageVars.

Kategorien: PmWiki Developer
  für die Liste aller Seiten