Page text variables are string variables created in the wiki text of a page, and can be automatically made available for inclusion in other pages.
There are three ways to define automated Page Text Variables:
:Name: Crisses
"{$:Name}"
|
"Crisses" |
{$:Name} (becomes: "Crisses") in the page.
Address: 1313 Mockingbird Lane
"{$:Address}"
| Address: 1313 Mockingbird Lane "1313 Mockingbird Lane" |
{$:Address} variable (variable markup becomes: "1313 Mockingbird Lane") in the page.
(:Country: Transylvania :)
"{$:Country}"
| "Transylvania " |
{$:Country} variable (variable markup becomes: "Transylvania ") in the page.
On the same page you can resolve page text variables through the {$:Var} format (shown above).
If 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: {*$:Address} on the GroupFooter or GroupHeader page.
{*$:City}
|
To include a page text variable from a header or footer see usage from other pages below.
If you want to pull the data from another page, use the {Group/PageName$:Var} format.
Suburb: Khandallah
(:Lake:Taupo:)
:Mountain:Mt Ruapehu
->"{PmWiki/PageTextVariables$:Suburb}"
->"{{$FullName}$:Lake}"
->"{PmWiki/PageTextVariables$:Mountain}"
| Suburb: Khandallah
"Khandallah"
"Taupo"
"Mt Ruapehu"
|
Page 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.
Page lists can also access the page text variables:
(:pagelist group=PmWiki order=$:Summary count=6 fmt=#singleline:) |
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 :
(:pagelist group=PmWiki $:City=Paris count=8 fmt=#singleline order=-name:) |
(:pagelist group=PmWiki $:City="Addis Ababa,Paris" order=-$:Version count=8 fmt=#singleline:) |
| =- | PTV is set (is not empty), eg (:pagelist $:Var=- :) |
| =-?* | PTV is not set (is empty), ie not one character followed by 0 or more characters, eg. (:pagelist $:Var=-?* :) |
| =* | display all pages, regardless of the page text variable (slow) |
| =-* | display no pages, regardless of the page text variable (slow) |
Tip : (:if ! equal "{$:PTV}" "":) will test if PTV is empty/unset or not.
(:pagelist group=PmWiki $:Summary=-?* count=6 fmt=#singleline:) |
Display pages by Audience page text variable.
>>comment<<
[[#byaudience]]
(:if ! equal '{=$:Audience}'
'{<$:Audience}':)
-<'''{=$:Audience}''':
(:ifend:)
[[{=$Name}]]
[[#byaudienceend]]
>><<
(:pagelist group=PmWiki count=10
fmt=#byaudience order=-$:Audience:)
|
visitors (intermediate) :
authors, admins (intermediate) :
authors, admins (advanced) :
authors (intermediate) :
Uploads Categories IncludeOtherPages TableDirectives PageVariables GroupHeaders |
Page text variables will be assigned/evaluated before any conditional markup is evaluated. This effectively means that you cannot declare a PTV within an if...else condition; and also that a PTV will have a value even if it is set within a (:if false:)....(:if:) condition.
The standard PageVar?($pagename,$varname) function can return page text variables, but remember to include the dollar and colon like this:
It works by caching all page (text) variables it finds in a page (in $PCache) and returns the one requested.