Variables

(:Summary: PmWiki group header. Includes styles and trail.:)

(:Summary:Variables available for local customisation:) (:Audience: administrators (basic) :)

This page documents the variables available in PmWiki for local customizations. Much of this documentation is still incomplete but people are working on it now. Feel free to add placeholders for variables you want to have documented if you don't know what the variable does.

The variables documentation is divided into several pages

PHP Variables

• Basic Variables - {BasicVariables$:Summary}
• Debug Variables - {DebugVariables$:Summary}
• Edit Variables - {EditVariables$:Summary}
• I18n Variables - {I18nVariables$:Summary}
• Layout Variables - {LayoutVariables$:Summary}
• Link Variables - {LinkVariables$:Summary}
• Other Variables - {OtherVariables$:Summary}
• Pagelist Variables - {PagelistVariables$:Summary}
• Path Variables - {PathVariables$:Summary}
• Security Variables - {SecurityVariables$:Summary}
• Upload Variables - {UploadVariables$:Summary}

PmWiki Page Variables - set and used only in PmWiki pages

• Page Variables - {PageVariables$:Summary}
• Page TextVariables - {PageTextVariables$:Summary}
• Markup Expressions - {MarkupExpressions$:Summary}

A complete index of documented variables is given below.

In general, variables with names ending in 'Fmt' (such as $PageLayoutFmt) have their values processed for $-variable substitutions prior to being output. Thus strings such as {$Name} and {$PageUrl} are replaced with the name and URL of the page when the string is printed.

See Also

• Blocklist - {Blocklist$:Summary}
• Notify - {Notify$:Summary}
• Functions - {Functions$:Summary}
• Basic Variables to provide circular trail