From Science at Synchrotrons in South Africa

PmWiki: Variables


List of documented PHP variables

VariableDocumented in
$ActionSkinLayoutVariables
$AsSpacedFunctionBasicVariables
$AuthIdBasicVariables
$AuthLDAPBindDNSecurityVariables
$AuthLDAPBindPasswordSecurityVariables
$AuthPwBasicVariables
$AuthorGroupBasicVariables
$AutoCreateEditVariables
$BaseNameBasicVariables
$BaseNamePatternsBasicVariables
$BlockedMessagesFmtBlocklist
$BlocklistActionsBlocklist
$BlocklistDownloadBlocklist
$BlocklistDownloadFmtBlocklist
$BlocklistDownloadRefreshBlocklist
$BlocklistMessageFmtBlocklist
$BlocklistPagesBlocklist
$CategoryGroupBasicVariables
$CookiePrefixBasicVariables
$DefaultGroupBasicVariables
$DefaultNameBasicVariables
$DefaultPageBasicVariables
$DefaultPageTextFmtEditVariables
$DefaultPasswordsSecurityVariables
$DeleteKeyPatternEditVariables
$DiffKeepDaysEditVariables
$DiffKeepNumEditVariables
$DraftRecentChangesFmtLayoutVariables
$DraftSuffixEditVariables
$EditFunctionsEditVariables
$EditRedirectFmtEditVariables
$EditTemplatesFmtEditVariables
$EnableBlocklistBlocklist
$EnableBlocklistImmediateBlocklist
$EnableDiagDebugVariables
$EnableDiffInlineLayoutVariables
$EnableDirectDownloadUploadVariables
$EnableDraftAtomicDiffEditVariables
$EnableDraftsEditVariables
$EnableFixedUrlRedirectLayoutVariables
$EnableGUIButtonsEditVariables
$EnableIMSCachingDebugVariables
$EnableLinkPageRelativeLinkVariables
$EnableLocalConfigBasicVariables
$EnableNotifyNotify
$EnableNotifySubjectEncodeNotify
$EnablePGCustBasicVariables
$EnablePageIndexPagelistVariables
$EnablePageListProtectPagelistVariables
$EnablePageTitlePriorityLayoutVariables
$EnablePageVarAuthSecurityVariables
$EnablePathInfoLayoutVariables
$EnablePostAttrClearSessionSecurityVariables
$EnablePostAuthorRequiredEditVariables
$EnablePublishAttrSecurityVariables
$EnableRedirectBasicVariables
$EnableRedirectQuietLinkVariables
$EnableRelativePageVarsBasicVariables
$EnableSessionPasswordsSecurityVariables
$EnableStopWatchDebugVariables
$EnableTableAutoValignTopLayoutVariables
$EnableUndefinedTemplateVarsPagelistVariables
$EnableUploadUploadVariables
$EnableUploadGroupAuthUploadVariables
$EnableUploadOverwriteUploadVariables
$EnableUploadVersionsUploadVariables
$EnableWSPreBasicVariables
$EnableWhyBlockedBlocklist
$EnableWikiWordsBasicVariables
$EnableXLPageScriptLoadI18nVariables
$FPLTemplatePageFmtPagelistVariables
$FTimeFmtBasicVariables
$FarmDPathVariables
$FarmPubDirUrlPathVariables
$FmtPOtherVariables
$FmtPVOtherVariables
$FmtVOtherVariables
$GroupFooterFmtLayoutVariables
$GroupHeaderFmtLayoutVariables
$GroupPatternBasicVariables
$GroupPrintFooterFmtLayoutVariables
$GroupPrintHeaderFmtLayoutVariables
$HTMLFooterFmtLayoutVariables
$HTMLHeaderFmtLayoutVariables
$HTMLPNewlineLayoutVariables
$HTMLStylesFmtLayoutVariables
$HTMLVSpaceLayoutVariables
$HandleAuthSecurityVariables
$HandleEditFmtEditVariables
$IMapLinkFmtLinkVariables
$InterMapFilesLinkVariables
$IsPagePostedEditVariables
$LinkPageCreateFmtLinkVariables
$LinkPageCreateSpaceFmtLinkVariables
$LinkPageExistsFmtLinkVariables
$LinkPageSelfFmtLinkVariables
$LinkUploadCreateFmtUploadVariables
$LinkWikiWordsBasicVariables
$LocalDirPathVariables
$LogoutCookiesBasicVariables
$LogoutRedirectFmtBasicVariables
$MakePageNameFunctionLinkVariables
$MakePageNamePatternsLinkVariables
$MakePageNameSplitPatternLinkVariables
$MakeUploadNamePatternsUploadVariables
$MaxIncludesLayoutVariables
$MaxPageTextVarsOtherVariables
$MessagesFmtLayoutVariables
$MetaRobotsLayoutVariables
$NamePatternBasicVariables
$NotifyBodyFmtNotify
$NotifyDelayNotify
$NotifyFileNotify
$NotifyFromNotify
$NotifyHeadersNotify
$NotifyItemFmtNotify
$NotifyListNotify
$NotifyListPageFmtNotify
$NotifyParametersNotify
$NotifySquelchNotify
$NotifySubjectFmtNotify
$NotifyTimeFmtNotify
$PageAttributesSecurityVariables
$PageCSSListFmtPathVariables
$PageCacheDirOtherVariables
$PageEditFmtEditVariables
$PageEditFormEditVariables
$PageIndexFilePagelistVariables
$PageListCacheDirPagelistVariables
$PageLogoUrlLayoutVariables
$PageNotFoundHeaderFmtLayoutVariables
$PagePathFmtLinkVariables
$PageRedirectFmtLayoutVariables
$PageSearchFormPagelistVariables
$PubDirUrlPathVariables
$RCLinesMaxLayoutVariables
$ROEPatternsEditVariables
$ROSPatternsEditVariables
$RecentChangesFmtLayoutVariables
$RecentUploadsFmtLayoutVariables
$ScriptUrlPathVariables
$SearchBoxOptPagelistVariables
$SearchPatternsPagelistVariables
$SessionDecodeSecurityVariables
$SessionEncodeSecurityVariables
$SiteAdminGroupBasicVariables
$SiteGroupBasicVariables
$SkinDirPathVariables
$SkinDirUrlPathVariables
$SkinLibDirsLayoutVariables
$SpaceWikiWordsBasicVariables
$TableCellAlignFmtLayoutVariables
$TableCellAttrFmtLayoutVariables
$TableRowAttrFmtLayoutVariables
$TableRowIndexMaxLayoutVariables
$TimeFmtBasicVariables
$UploadBlacklistUploadVariables
$UploadDirUploadVariables
$UploadDirQuotaUploadVariables
$UploadExtSizeUploadVariables
$UploadMaxSizeUploadVariables
$UploadNameCharsUploadVariables
$UploadPermAddUploadVariables
$UploadPermSetUploadVariables
$UploadPrefixFmtUploadVariables
$UploadPrefixQuotaUploadVariables
$UploadUrlFmtUploadVariables
$UrlLinkFmtLinkVariables
$VarPagesFmtI18nVariables
$VersionBasicVariables
$VersionNumBasicVariables
$WikiDirPathVariables
$WikiLibDirsPathVariables
$WikiStyleLayoutVariables
$WikiStyleApplyLayoutVariables
$WikiTitleLayoutVariables
$WikiWordCountLinkVariables
$WikiWordCountMaxLinkVariables
$WikiWordPatternBasicVariables
$WorkDirPathVariables
$XLLangsI18nVariables
where is this documented?

This page documents the PHP 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:

The following functions are also controlled by several variables:

The following variables are used in page markup.

An complete index of documented PHP 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.

Note: The automatic variable index and link generation is done by scripts/vardoc.php using $VarPagesFmt to find the pages containing trails of pages with the variable documentation.

There is a slight discrepancy between index generation and link generation: The index generation finds lines starting with a colon followed by "$" and an uppercase word. In contrast, the automatic link generation works only with WikiWords ($WikiWordPattern) preceded by "$". Therefore all "non WikiWord" variables are shown as link only in the list below, but not elsewhere in PmWiki, as $Author, $Version and $XL.

See Also

Categories: PmWiki Developer

Retrieved from /wiki/PmWiki/Variables
Page last modified on September 03, 2012, at 12:22 PM