THE EARTH - Online Monthly Newspaper of the Ringing Cedars movement

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 page variables.

The variables documentation is divided into several pages

Basic Variables - core variables
Debug Variables - variables useful for debugging
Edit Variables - variables used when editing pages
I18n Variables - variables used for internationalization (i18n)
Layout Variables - variables that control page layout
Link Variables - variables that control the display of links in pages
Notify - send mail when pages are modified (supersedes Mail Posts)
Other Variables - variables not yet classified
Pagelist Variables - variables used with page lists and search results
Path Variables - variables used to specify various locations on the server
Security Variables - variables crucial for site security
Upload Variables - variables used for uploads/attachments

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.

Variable	Documented in
`$AsSpacedFunction`	BasicVariables
`$AuthId`	BasicVariables
`$AuthLDAPBindDN`	SecurityVariables
`$AuthLDAPBindPassword`	SecurityVariables
`$Author`	BasicVariables
`$AuthorGroup`	BasicVariables
`$CookiePrefix`	BasicVariables
`$DefaultGroup`	BasicVariables
`$DefaultName`	BasicVariables
`$DefaultPage`	BasicVariables
`$DefaultPageTextFmt`	EditVariables
`$DefaultPasswords`	SecurityVariables
`$DeleteKeyPattern`	EditVariables
`$DiffKeepDays`	EditVariables
`$DraftSuffix`	EditVariables
`$EditFunctions`	EditVariables
`$EditRedirectFmt`	EditVariables
`$EditTemplatesFmt`	EditVariables
`$EnableDiag`	DebugVariables
`$EnableDirectDownload`	UploadVariables
`$EnableDrafts`	EditVariables
`$EnableFixedUrlRedirect`	LayoutVariables
`$EnableGUIButtons`	EditVariables
`$EnableIMSCaching`	DebugVariables
`$EnableNotify`	Notify
`$EnablePGCust`	BasicVariables
`$EnablePageIndex`	PagelistVariables
`$EnablePageListProtect`	PagelistVariables
`$EnablePathInfo`	LayoutVariables
`$EnablePostAttrClearSession`	SecurityVariables
`$EnablePostAuthorRequired`	EditVariables
`$EnableStopWatch`	DebugVariables
`$EnableUpload`	UploadVariables
`$EnableUploadVersions`	UploadVariables
`$FPLTemplatePageFmt`	PagelistVariables
`$FarmD`	PathVariables
`$FarmPubDirUrl`	PathVariables
`$FmtP`	OtherVariables
`$FmtPV`	OtherVariables
`$FmtV`	OtherVariables
`$GroupFooterFmt`	LayoutVariables
`$GroupHeaderFmt`	LayoutVariables
`$GroupPattern`	BasicVariables
`$HTMLFooterFmt`	LayoutVariables
`$HTMLHeaderFmt`	LayoutVariables
`$HTMLStylesFmt`	LayoutVariables
`$HTMLVSpace`	LayoutVariables
`$HandleAuth`	SecurityVariables
`$HandleEditFmt`	EditVariables
`$IMapLinkFmt`	LinkVariables
`$InterMapFiles`	LinkVariables
`$IsPagePosted`	EditVariables
`$LinkPageCreateFmt`	LinkVariables
`$LinkPageCreateSpaceFmt`	LinkVariables
`$LinkPageExistsFmt`	LinkVariables
`$LinkPageSelfFmt`	LinkVariables
`$LinkUploadCreateFmt`	UploadVariables
`$LinkWikiWords`	BasicVariables
`$LocalDir`	PathVariables
`$LogoutCookies`	BasicVariables
`$LogoutRedirectFmt`	BasicVariables
`$MakePageNameFunction`	LinkVariables
`$MakePageNamePatterns`	LinkVariables
`$MaxIncludes`	LayoutVariables
`$MessagesFmt`	LayoutVariables
`$MetaRobots`	LayoutVariables
`$NamePattern`	BasicVariables
`$NotifyBodyFmt`	Notify
`$NotifyDelay`	Notify
`$NotifyFile`	Notify
`$NotifyFrom`	Notify
`$NotifyHeaders`	Notify
`$NotifyItemFmt`	Notify
`$NotifyList`	Notify
`$NotifyListPageFmt`	Notify
`$NotifyParameters`	Notify
`$NotifySquelch`	Notify
`$NotifySubjectFmt`	Notify
`$NotifyTimeFmt`	Notify
`$PageAttributes`	SecurityVariables
`$PageCSSListFmt`	PathVariables
`$PageEditFmt`	EditVariables
`$PageEditForm`	EditVariables
`$PageIndexFile`	PagelistVariables
`$PageLogoUrl`	LayoutVariables
`$PageNotFoundHeaderFmt`	LayoutVariables
`$PagePathFmt`	LinkVariables
`$PageRedirectFmt`	LayoutVariables
`$PageSearchForm`	PagelistVariables
`$PubDirUrl`	PathVariables
`$RCLinesMax`	LayoutVariables
`$ROSPatterns`	EditVariables
`$RecentChangesFmt`	LayoutVariables
`$ScriptUrl`	PathVariables
`$SearchPatterns`	PagelistVariables
`$SiteGroup`	BasicVariables
`$Skin`	LayoutVariables
`$SkinDirUrl`	PathVariables
`$SkinLibDirs`	LayoutVariables
`$SpaceWikiWords`	BasicVariables
`$TableCellAttrFmt`	LayoutVariables
`$TableRowAttrFmt`	LayoutVariables
`$TableRowIndexMax`	LayoutVariables
`$TimeFmt`	BasicVariables
`$UploadDir`	UploadVariables
`$UploadMaxSize`	UploadVariables
`$UploadNameChars`	UploadVariables
`$UploadPrefixFmt`	UploadVariables
`$UploadUrlFmt`	UploadVariables
`$UrlLinkFmt`	LinkVariables
`$VarPagesFmt`	I18nVariables
`$Version`	BasicVariables
`$VersionNum`	BasicVariables
`$WikiDir`	PathVariables
`$WikiLibDirs`	PathVariables
`$WikiStyle`	LayoutVariables
`$WikiTitle`	LayoutVariables
`$WikiWordCount`	LinkVariables
`$WikiWordCountMax`	LinkVariables
`$WikiWordPattern`	BasicVariables
`$WorkDir`	PathVariables
`$XLLangs`	I18nVariables

THE EARTH - Online Monthly Newspaper of the Ringing Cedars movement

Dec 22, 2024

Sign up for the e-mail issue

See Also

Search

Google Search

Popular searches:

Our Sponsors