PmWiki

Page Text Variables

PmWiki.PageTextVariables History

Hide minor edits - Show changes to markup

July 14, 2015, at 09:29 AM by Shahad - JbYvOz7j2D1
Changed line 1 from:

We <a href="http://xvqhgta.com">col'duve</a> done with that insight early on.

to:

ba salam.kheili kheili az in karooetn ro mipasandam ke raigan sathe irano pooshesh midin.haghighatesh emrooz shabakeye bbc barnameye khan academy ro neshoon midad va goft dar sathe jahan va dar tamami payeha az in videoha be hameye zabanha dare va albate chon too iran video playere an filtere site shoma ro moarrefi kard.mikhastam pishnahad bedam ta az videohaye farsi an estefade konid ta ishalla kelase dars jahani she.mamnoon http://yccpih.com [url=http://ahzvbkbgl.com]ahzvbkbgl[/url] [link=http://qwuhgcib.com]qwuhgcib[/link]

July 11, 2015, at 07:24 PM by Francesco - jsskXXPQmQe
Changed line 1 from:

I'm imsdseper. You've really raised the bar with that. http://jnfgdetsjm.com [url=http://mwveqoen.com]mwveqoen[/url] [link=http://jrelobmnaq.com]jrelobmnaq[/link]

to:

We <a href="http://xvqhgta.com">col'duve</a> done with that insight early on.

July 10, 2015, at 02:06 AM by Blondie - cRGHeyDrg4y
Changed line 1 from:

Never would have thunk I would find this so <a href="http://nfakoang.com">inpildensabse.</a>

to:

I'm imsdseper. You've really raised the bar with that. http://jnfgdetsjm.com [url=http://mwveqoen.com]mwveqoen[/url] [link=http://jrelobmnaq.com]jrelobmnaq[/link]

July 08, 2015, at 04:06 AM by Denim - 4k9BorfAsO0
Changed line 1 from:

You have more useful info than the British had colonies prWW-eII.

to:

Never would have thunk I would find this so <a href="http://nfakoang.com">inpildensabse.</a>

July 07, 2015, at 05:48 AM by Ahmad - 64UeLRDs
Changed lines 1-204 from:

(:Summary:Page variables automatically made available through natural or explicit page markup:)

Page text variables are string variables automatically made available through natural page markup or explicitly with page directive markup within the wiki text of the page.

Defining Page Text Variables

There are three ways to define automated Page Text Variables:

  • use a definition list - the normal pmwiki markup for a definition list will create a page text variable

(:markup caption='Example definition list:' class="horiz":)

Name
Crisses

"" (:markupend:)

This creates a new variable that can be accessed by {$:Name} (becomes: "") in the page.
  • use a simple colon delimiter in normal text

(:markup caption='Example colon delimited:' class="horiz":) Address: 1313 Mockingbird Lane

"" (:markupend:)

This creates the {$:Address} variable (variable markup becomes: "") in the page.
  • hidden directive form - PmWiki markup that doesn't render on the page, but defines the variable

(:markup caption='Example directive:' class="horiz":) (:Country: Transylvania :) "" (:markupend:)

This creates the {$:Country} variable (variable markup becomes: "") in the page.

Usage

Usage on the same page

On the same page you can resolve page text variables through the {$:Var} format (shown above).

Usage in headers and footers

If you want a GroupHeader, GroupFooter, SideBar, etc to call on page text variable in the main page, you need to include 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. (:markup caption='Example' class=horiz:) (:markupend:) To include a page text variable from a header or footer see usage from other pages below.

Usage from other pages

If you want to pull the data from another page, use the {Group/PageName$:Var} format. (:markup caption='Example:' class="horiz":) Suburb: Khandallah (:Lake:Taupo:)

Mountain
Mt Ruapehu
""
""
""

(:markupend:)

Usage from included pages

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.

Nested page text variables

Page text variables can be nested (:markup caption='Example:' class="horiz":)

MailingAddress
, ,

"" (:markupend:)

Another way you may nest PTVs is to make (part of) the variable name a variable in itself: (:markup caption='Example:' class="horiz":) x:Test/Ptvb Contents of y on page : (:markupend:)

Usage with pagelists

Page lists can also access the page text variables: (:markup caption='Example:' class="horiz":) (:pagelist group=PmWiki order=$:Summary count=6 fmt=#singleline:) (:markupend:)

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 : (:markup caption='Example:' class="horiz":) (:pagelist group=PmWiki $:City=Paris count=8 fmt=#singleline order=-name:) (:markupend:)

lists pages having '$:City' set to 'Paris'.

(:markup caption='Example: multiple selections' class="horiz":) (:pagelist group=PmWiki $:Audience="*authors (intermediate)*,*administrators (intermediate)*" order=-$:Audience,name count=10 fmt=#singleline:) (:markupend:)

lists pages having a '$:Audience' of 'authors (intermediate)' or 'administrators (intermediate)'.

(:markup caption='Example: multiple selections with spaces' class="horiz":) (:pagelist group=PmWiki $:City="Addis Ababa,Paris" order=-$:Version count=8 fmt=#singleline:) (:markupend:)

'quotes' must surround all the selections.

(:markup caption='Example: Pages with City variable set' class="horiz":) City: Addis Ababa (:pagelist group=PmWiki $:City=- count=10 fmt=#singleline:) (:markupend:)

City variable is set.
  • When using page text variables for selection or ordering, don't put the curly braces around the variable name. The curly forms do a replacement before the pagelist command is evaluated.

Testing if set or not set

(:table:) (:cellnr:)=- (:cell:)PTV is set (is not empty), eg (:pagelist $:MyPageTextVariable=- :) (:cellnr:) =-?* (:cell:)PTV is not set (is empty), ie is not set to one char followed by 0 or more chars, eg

(:pagelist $:MyPageTextVariable=-?* :)

(:cellnr:)=* (:cell:)display all pages, the page text variable is irrelevant (:cellnr:)=-* (:cell:)display no pages, the page text variable is irrelevant (:tableend:)

(:markup caption='Example: Pages without a summary' class="horiz":) (:pagelist group=PmWiki $:Summary=-?* count=6 fmt=#singleline:) (:markupend:)

Use page text variable in a template

Display pages by Audience page text variable. (:markup caption='Example:' class="horiz":)

(:if ! equal '{=$:Audience}' '{<$:Audience}':)

{=$:Audience}:

(:ifend:) {=$Name}?

(:pagelist group=PmWiki count=10 fmt=#byaudience order=-$:Audience:) (:markupend:)

Use page text variables in conditional markup

Page text variables will be assigned/evaluated before any conditional markup is evaluated. That means you can use page text variables with conditional markup, but not conditional markup within page text variables. For instance a PTV will have a value even if it is set within a (:if false:)....(:if:) condition.

Usage - other

Data relevant to a page (the "Base" page) may now also be found in other groups. If the Base page is Main/HomePage, the data page could be Data-Main/HomePage. A new variable called $BaseName, which automatically calculates the Base page name from the Data page name, and can be defined by including the following in config.php:

// The pattern for figuring out the basename of a page
$BaseNamePatterns['/^Data-/'] = '';

Your pattern may vary.

Usage - from within code (developers only)

The standard PageVar($pagename,$varname) function can return page text variables, but remember to include the dollar and colon like this:

$var=PageVar($pagename,'$:City')

Actually, for text variables, PageVar just calls PageTextVar($pagename,$varname), so your code can be sped up slightly by calling it directly, but it takes just the raw variable name without any leading characters, like this:

$var=PageTextVar($pagename,'City')

It works by caching all page text-variables it finds in a page (in $PCache) and returns the one requested.

Feature availability

Page text variables were introduced in 2.2.0 beta 2.

to:

You have more useful info than the British had colonies prWW-eII.

Green Marinee theme adapted by David Gilbert, powered by PmWiki