Variables in Pm Wiki at phsne.org/archive

< Url approvals | Documentation index | Functions >

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

PmWiki Page Variables - set and used only in PmWiki pages

Page Variables - variables that are associated with pages
Page TextVariables - Page variables automatically made available through natural or explicit page markup
Markup Expressions - String and formatting operations

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.

Blocklist - Blocking IP addresses, phrases, and expressions to counteract spam and vandalism.
Notify - Allows a site administrator to configure PmWiki to send email messages whenever pages are changed on the wiki site
Functions - How some of the functions in pmwiki.php work
Basic Variables to provide circular trail

Variable	Documented in
`$ActionSkin`	LayoutVariables
`$AsSpacedFunction`	BasicVariables
`$AuthId`	BasicVariables
`$AuthLDAPBindDN`	SecurityVariables
`$AuthLDAPBindPassword`	SecurityVariables
`$AuthPw`	BasicVariables
`$AuthUserFunctions`	SecurityVariables
`$Author`	BasicVariables
`$AuthorGroup`	BasicVariables
`$AutoCreate`	EditVariables
`$BaseNamePatterns`	BasicVariables
`$BlockedMessagesFmt`	Blocklist
`$BlocklistActions`	Blocklist
`$BlocklistDownload`	Blocklist
`$BlocklistDownloadFmt`	Blocklist
`$BlocklistDownloadRefresh`	Blocklist
`$BlocklistMessageFmt`	Blocklist
`$BlocklistPages`	Blocklist
`$CategoryGroup`	BasicVariables
`$CookiePrefix`	BasicVariables
`$DefaultGroup`	BasicVariables
`$DefaultName`	BasicVariables
`$DefaultPage`	BasicVariables
`$DefaultPageTextFmt`	EditVariables
`$DefaultPasswords`	SecurityVariables
`$DeleteKeyPattern`	EditVariables
`$DiffKeepDays`	EditVariables
`$DraftRecentChangesFmt`	LayoutVariables
`$DraftSuffix`	EditVariables
`$EditFunctions`	EditVariables
`$EditRedirectFmt`	EditVariables
`$EditTemplatesFmt`	EditVariables
`$EnableBlocklist`	Blocklist
`$EnableBlocklistImmediate`	Blocklist
`$EnableDiag`	DebugVariables
`$EnableDirectDownload`	UploadVariables
`$EnableDrafts`	EditVariables
`$EnableFixedUrlRedirect`	LayoutVariables
`$EnableGUIButtons`	EditVariables
`$EnableIMSCaching`	DebugVariables
`$EnableLinkPageRelative`	LinkVariables
`$EnableLocalConfig`	BasicVariables
`$EnableNotify`	Notify
`$EnableNotifySubjectEncode`	Notify
`$EnablePGCust`	BasicVariables
`$EnablePageIndex`	PagelistVariables
`$EnablePageListProtect`	PagelistVariables
`$EnablePathInfo`	LayoutVariables
`$EnablePostAttrClearSession`	SecurityVariables
`$EnablePostAuthorRequired`	EditVariables
`$EnablePublishAttr`	SecurityVariables
`$EnableRedirect`	BasicVariables
`$EnableRedirectQuiet`	LinkVariables
`$EnableSessionPasswords`	SecurityVariables
`$EnableStopWatch`	DebugVariables
`$EnableUpload`	UploadVariables
`$EnableUploadGroupAuth`	UploadVariables
`$EnableUploadOverwrite`	UploadVariables
`$EnableUploadVersions`	UploadVariables
`$EnableWSPre`	BasicVariables
`$EnableWhyBlocked`	Blocklist
`$EnableWikiWords`	BasicVariables
`$FPLTemplatePageFmt`	PagelistVariables
`$FTimeFmt`	BasicVariables
`$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
`$MaxPageTextVars`	OtherVariables
`$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
`$PageListCacheDir`	PagelistVariables
`$PageLogoUrl`	LayoutVariables
`$PageNotFoundHeaderFmt`	LayoutVariables
`$PagePathFmt`	LinkVariables
`$PageRedirectFmt`	LayoutVariables
`$PageSearchForm`	PagelistVariables
`$PubDirUrl`	PathVariables
`$RCLinesMax`	LayoutVariables
`$ROEPatterns`	EditVariables
`$ROSPatterns`	EditVariables
`$RecentChangesFmt`	LayoutVariables
`$ScriptUrl`	PathVariables
`$SearchBoxOpt`	PagelistVariables
`$SearchPatterns`	PagelistVariables
`$SessionDecode`	SecurityVariables
`$SessionEncode`	SecurityVariables
`$SiteAdminGroup`	BasicVariables
`$SiteGroup`	BasicVariables
`$SkinDirUrl`	PathVariables
`$SkinLibDirs`	LayoutVariables
`$SpaceWikiWords`	BasicVariables
`$TableCellAttrFmt`	LayoutVariables
`$TableRowAttrFmt`	LayoutVariables
`$TableRowIndexMax`	LayoutVariables
`$TimeFmt`	BasicVariables
`$UploadDir`	UploadVariables
`$UploadDirQuota`	UploadVariables
`$UploadMaxSize`	UploadVariables
`$UploadNameChars`	UploadVariables
`$UploadPrefixFmt`	UploadVariables
`$UploadPrefixQuota`	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
`$XL`	I18nVariables
`$XLLangs`	I18nVariables

< Url approvals | Documentation index | Functions >

This page may have a more recent version on pmwiki.org: PmWiki:Variables, and a talk page: PmWiki:Variables-Talk.

This page & PHSNE publications linked from this page are Copyright © 2006-2012 Photographic Historical Society of New England, Inc. Members' Pages, images, videos and documents copyright � their original creators or assignees.

PHP Variables

PmWiki Page Variables - set and used only in PmWiki pages

See Also