This page documents the variables available in Pm Wiki 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

• Basic Variables - core variables
• Layout Variables - variables that control page layout
• Path Variables? - variables used to specify various locations on the server
• Link Variables - variables that control the display of links in pages
• Edit Variables - variables used when editing pages
• Upload Variables - variables used for uploads/attachments
• I18n Variables - variables used for internationalization (i18n)
• Other Variables - variables not yet classified
• Mail Posts - mails sent when pages are modified

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

Cookbook.Functions?

<< Url approvals | Pm Wiki.Documentation Index | Wiki architecture? >>

Variable	Documented in
$AsSpacedFunction	BasicVariables
$DefaultGroup	BasicVariables
$DefaultName	BasicVariables
$DefaultPage	BasicVariables
$DefaultPageTextFmt	EditVariables
$DeleteKeyPattern	EditVariables
$EditFunctions	EditVariables
$EditTemplatesFmt	EditVariables
$EnableDirectDownload	UploadVariables
$EnableFixedUrlRedirect	OtherVariables
$EnableGUIButtons	EditVariables
$EnableIMSCaching	OtherVariables
$EnableMailPosts	MailPosts
$EnablePGCust	BasicVariables
$EnablePageListProtect	OtherVariables
$EnablePathInfo	LayoutVariables
$EnablePostAuthorRequired	EditVariables
$EnableStopWatch	OtherVariables
$EnableUpload	UploadVariables
$FmtP	OtherVariables
$FmtV	OtherVariables
$GroupPattern	BasicVariables
$HTMLHeaderFmt	LayoutVariables
$HTMLStylesFmt	LayoutVariables
$HandleEditFmt	EditVariables
$InterMapFiles	LinkVariables
$IsPagePosted	EditVariables
$LinkPageCreateFmt	LinkVariables
$LinkPageCreateSpaceFmt	LinkVariables
$LinkPageExistsFmt	LinkVariables
$LinkPageSelfFmt	LinkVariables
$LinkWikiWords	BasicVariables
$MailPostsDelay	MailPosts
$MailPostsFile	MailPosts
$MailPostsFrom	MailPosts
$MailPostsFunction	MailPosts
$MailPostsHeaders	MailPosts
$MailPostsItemFmt	MailPosts
$MailPostsMessage	MailPosts
$MailPostsSquelch	MailPosts
$MailPostsSubject	MailPosts
$MailPostsTimeFmt	MailPosts
$MailPostsTo	MailPosts
$MakePageNameFunction	LinkVariables
$MaxIncludes	LayoutVariables
$MessagesFmt	LayoutVariables
$MetaRobots	OtherVariables
$NamePattern	BasicVariables
$PageEditFmt	EditVariables
$PagePathFmt	LinkVariables
$PageRedirectFmt	LayoutVariables
$RCLinesMax	LayoutVariables
$ROSPatterns	EditVariables
$RecentChangesFmt	LayoutVariables
$SearchPatterns	OtherVariables
$SiteGroup	BasicVariables
$Skin	LayoutVariables
$SkinDirUrl	LayoutVariables
$SpaceWikiWords	BasicVariables
$TableCellAttrFmt	OtherVariables
$TableRowAttrFmt	OtherVariables
$TableRowIndexMax	OtherVariables
$UploadDir	UploadVariables
$UploadPrefixFmt	UploadVariables
$UploadUrlFmt	UploadVariables
$UrlLinkFmt	LinkVariables
$VarPagesFmt	I18nVariables
$WikiStyle	LayoutVariables
$WikiTitle	LayoutVariables
$WikiWordCount	LinkVariables
$WikiWordCountMax	LinkVariables
$WikiWordPattern	BasicVariables