PmWiki»Variables

Variables

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.

Note not to confuse these variables (set and used only in PHP) with MarkupVariables, available through page markup.

The variables documentation is divided into several pages

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 global $-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

<< Url approvals | DocumentationIndex | Page file format >>


VariableDocumented in
$AsSpacedFunctionBasicVariables
$AuthIDBasicVariables
$AuthorGroupBasicVariables
$CookiePrefixBasicVariables
$DefaultGroupBasicVariables
$DefaultNameBasicVariables
$DefaultPageBasicVariables
$DefaultPageTextFmtEditVariables
$DeleteKeyPatternEditVariables
$EditFunctionsEditVariables
$EditTemplatesFmtEditVariables
$EnableDirectDownloadUploadVariables
$EnableFixedUrlRedirectOtherVariables
$EnableGUIButtonsEditVariables
$EnableIMSCachingOtherVariables
$EnableLinkIndexOtherVariables
$EnableMailPostsMailPosts
$EnablePGCustBasicVariables
$EnablePageListProtectOtherVariables
$EnablePathInfoLayoutVariables
$EnablePostAuthorRequiredEditVariables
$EnableStopWatchOtherVariables
$EnableUploadUploadVariables
$EnableUploadVersionsUploadVariables
$FarmDPathVariables
$FmtPOtherVariables
$FmtVOtherVariables
$GroupPatternBasicVariables
$HTMLHeaderFmtLayoutVariables
$HTMLStylesFmtLayoutVariables
$HandleAuthOtherVariables
$HandleEditFmtEditVariables
$InterMapFilesLinkVariables
$IsPagePostedEditVariables
$LastModifiedByBasicVariables
$LinkIndexFileOtherVariables
$LinkPageCreateFmtLinkVariables
$LinkPageCreateSpaceFmtLinkVariables
$LinkPageExistsFmtLinkVariables
$LinkPageSelfFmtLinkVariables
$LinkWikiWordsBasicVariables
$LogoutCookiesBasicVariables
$LogoutRedirectFmtBasicVariables
$MailPostsDelayMailPosts
$MailPostsFileMailPosts
$MailPostsFromMailPosts
$MailPostsFunctionMailPosts
$MailPostsHeadersMailPosts
$MailPostsItemFmtMailPosts
$MailPostsMessageMailPosts
$MailPostsSquelchMailPosts
$MailPostsSubjectMailPosts
$MailPostsTimeFmtMailPosts
$MailPostsToMailPosts
$MakePageNameFunctionLinkVariables
$MakePageNamePatternsOtherVariables
$MaxIncludesLayoutVariables
$MessagesFmtLayoutVariables
$MetaRobotsOtherVariables
$NamePatternBasicVariables
$PageEditFmtEditVariables
$PageLogoUrlLayoutVariables
$PagePathFmtLinkVariables
$PageRedirectFmtLayoutVariables
$PubDirUrlPathVariables
$RCLinesMaxLayoutVariables
$ROSPatternsEditVariables
$RecentChangesFmtLayoutVariables
$ScriptUrlPathVariables
$SearchPatternsOtherVariables
$SiteGroupBasicVariables
$SkinLayoutVariables
$SkinDirUrlPathVariables
$SpaceWikiWordsBasicVariables
$TableCellAttrFmtOtherVariables
$TableRowAttrFmtOtherVariables
$TableRowIndexMaxOtherVariables
$TimeFmtBasicVariables
$UploadDirUploadVariables
$UploadPrefixFmtUploadVariables
$UploadUrlFmtUploadVariables
$UrlLinkFmtLinkVariables
$VarPagesFmtI18nVariables
$VersionBasicVariables
$VersionNumBasicVariables
$WikiDirOtherVariables
$WikiStyleLayoutVariables
$WikiTitleLayoutVariables
$WikiWordCountLinkVariables
$WikiWordCountMaxLinkVariables
$WikiWordPatternBasicVariables
$WorkDirOtherVariables