SEISMIC
RADIO |
PmWiki /
PageTextVariablesPage text variables are string variables created in the wiki text of a page, and can be automatically made available for inclusion in other pages. Defining Page Text VariablesThere are three ways to define automated Page Text Variables (more patterns can be defined if needed) :
This creates a new variable that can be accessed by {$:Name} (becomes: "Crisses") in the page.
This creates the {$:Address} variable (variable markup becomes: "1313 Mockingbird Lane") in the page.
This creates the {$:Country} variable (variable markup becomes: "Transylvania ") in the page.
Default values for unset or empty Page Text VariablesIf a page text variable is not defined in a page, or if the current visitor doesn't have read permissions for the page containing the variable definition, then the markup to access the variable like An administrator can define default values for such cases (PmWiki 2.2.121+). The following arrays can be defined in $DefaultUnsetPageTextVars = array( 'SpecificVariable' => 'SpecificVariable is unset', '*PartialMatch*' => 'some value', '*' => '(unset)', ); $DefaultEmptyPageTextVars = array( 'SpecificVariable' => 'SpecificVariable is set, but empty', '*' => '(empty)', ); In the above examples,
The patterns are processed in order, and the first matching pattern assigns the value to the variable. The asterisk UsageUsage on the same pageOn the same page you can resolve page text variables through the Usage in headers and footers: special referencesIf you want a GroupHeader, GroupFooter, SideBar, etc to call on page text variable in the main page, you need to include special reference information.
To explicitly reference the page text variable from the page being displayed add an asterisk to the page text variable's markup:
To include a page text variable from a header or footer see usage from other pages below. Special references also apply to page variables and page list templates.
Usage from other pagesIf you want to pull the data from another page, use the
Usage from included pagesPage text variables are never included from their source page. See Usage from other pages above to refer to a page text variable on another page. Usage with pagelistsPage lists can also access the page text variables:
And to create pagelist formats (such as those documented at Site.Page List Templates, Page Lists, Page List Templates, Page Variables. Store custom pagelists at Site.Local Templates?). Page lists can also use page text variables to select pages :
lists pages having '$:City' set to 'Paris'.
'quotes' must surround all the selections.
The page text variable value is always the text that is written in the page. It is only evaluated when the variable is printed/output to HTML. To sort by a page text variable variable, all values in all pages are the not-yet-evaluated text strings, and the pagelist order function does what it can with them. It does not process/evaluate the text at this point. E.g. With a page name in to format "yyyyMonth" it is simpler to use a Then use An alternative is writing in the wiki page: (:MonthNum:07:)
as the markup expression that follows won't work: (:MonthNum:{(ftime fmt=%m when="{$Namespaced}")}:)
Testing if set or not set within a pagelist
Tip :
Use page text variable in a templateDisplay pages by Audience page text variable.
Use page text variables in conditional markupPage text variables will be assigned/evaluated before any conditional markup is evaluated. This effectively means that you cannot declare a PTV within an Usage - from within code (developers only)The standard $var=PageVar($pagename,'$:City')
It works by caching all page (text) variables it finds in a page (in This page may have a more recent version on pmwiki.org: PmWiki:PageTextVariables, and a talk page: PmWiki:PageTextVariables-Talk. |