wiki de milsiete89 | PmWiki / MarkupVariables

Editando PmWiki.MarkupVariables

%audience% authors (intermediate)

[[#desc]]This page describes the "variables" that are available in the markup through the construction @@{$''<variable>''}@@. For example, putting "[@{$Group}@]" in the markup of this page renders as "{$Group}".

Note: These variables do not necessarily exist in the PHP code, i.e. you cannot assume that using [@$group@] in [@local/config.php@] will produce the correct result. Instead, check the [[Variables#index| list of internal Variables]] first, you may find a match.

Here are the variables that are available through markup:

->[@{$Group}@] - page's group name, as in "`{$Group}"
->[@{$Groupspaced}@] - spaced group name, as in "{$Groupspaced}"
->[@{$DefaultGroup}@] - default group name, as in "{$DefaultGroup}"
->[@{$SiteGroup}@] - default group name for e.g. RecentChanges, as in "{$SiteGroup}"
->[@{$Name}@] - page name, as in "`{$Name}"
->[@{$Namespaced}@] - spaced page name, as in "{$Namespaced}"
->[@{$DefaultName}@] - name of default page, as in "`{$DefaultName}"
->[@{$FullName}@] - page's full name, as in "`{$FullName}"
->[@{$Title}@] - page title (may differ from Name), as in "{$Title}"
->[@{$Titlespaced}@] - title/spaced page name, as in "{$Titlespaced}"
->[@{$UrlPage}@] - requested URL (valid only on the `PageNotFound page)

->[@{$LastModified}@] - date page was edited, as in "{$LastModified}"
->[@{$LastModifiedBy}@] - page's last editor, as in "{$LastModifiedBy}"
->[@{$LastModifiedHost}@] - IP of page's last editor, as in "{$LastModifiedHost}"

->[@{$Author}@] - the name of the person currently interacting with the site, as in "{$Author}"
->[@{$AuthId}@] - current authenticated id, as in "{$AuthId}"

->[@{$Version}@] - [[PmWiki]] version, as in "{$Version}"

%audience% administrators (intermediate)
!! Defining additional markup variables

You can define additional markup variables by adding something like the
following to your configuration script (e.g. @@local/config.php@@):
 [=
	Markup('{$local-variables}', '>{$fmt}',
	  '/{\\$(Var1|Var2|Var3)}/e',
	  "\$GLOBALS['$1']");
	$GLOBALS['Var1'] = "Variable 1";
	$GLOBALS['Var2'] = "Variable 2";
	$GLOBALS['Var3'] = "Variable 3";
=]

This method of adding the markup variables will also make them known to the
function @@[[FmtPageName -> PmWiki.Functions#FmtPageName]]@@ which may or
may not be desirable. If you don't want that, then define the extra markup
variables directly, like this:

Markup('{$Var1}', '>{$fmt}', '/\\{\\$Var1\\}/', 'Variable 1');
	Markup('{$Var2}', '>{$fmt}', '/\\{\\$Var2\\}/', 'Variable 2');
	Markup('{$Var3}', '>{$fmt}', '/\\{\\$Var3\\}/', 'Variable 3');

!!![[#ex1]] Example 1

Let's say you want [@{$mygroup}@] to render as the name of the current group
using only lower case letters. Here's how you could do it using the first
approach described above:

[=
	Markup('{$local-variables}', '>{$fmt}',
	  '/{\\$(Var1|Var2|mygroup)}/e',
	  "\$GLOBALS['$1']");
	$GLOBALS['Var1'] = "Variable 1";
	$GLOBALS['Var2'] = "Variable 2";
	$GLOBALS['mygroup'] = lower(FmtPageName('$Group', $pagename));
=]

Using the second approach, you need to add something like this to your
configuration script:

[=
	Markup('{$mygroup}', '>{$fmt}',
	      '/\\{\\$mygroup\\}/', 
	      lower(FmtPageName('$Group', $pagename)));

Markup('{$Var1}', '>{$fmt}', '/\\{\\$Var1\\}/', 'Variable 1');

Markup('{$Var2}', '>{$fmt}', '/\\{\\$Var2\\}/', 'Variable 2');
=]

!!![[#ex2]] Example 2

Here is an example of a situation where you can't really define a variable
as described earlier. Let's say you want each instance of [@{$tic-toc}@] to
be replaced with the current time in system ticks when that part of the page
is output. The difference here is that a function needs to be invoked (to
get the current time) for each of the occurences. In order to do this, just
use the function [@Markup()@] as usual. Here's how it could be done:
 [=
	Markup('{$tic-toc}', '>{$var}',
	       '/\\{\\$tic-toc\\}/e',
	       "array_sum(explode(' ',microtime()))");
=]

!! Links

Also see these pages:

* [[PmWiki.Variables]] &mdash; about variables internal to PmWiki.
* [[PmWiki.MarkupMasterIndex]] &mdash; complete list of PmWiki markups.

%trail% <<|DocumentationIndex|>>

Sumario:

Autor: Esta es una edición menor

Basic Editing - Text Formatting Rules - Documentation Index	Tables: Simple - Advanced
Paragraphs: for a new paragraph, use a blank line; -> to indent text, -< hanging text	Line break: \\ or [[<<]]
Lists: * for bullet lists, # for numbered lists, :term:definition for definition lists Emphasis: ''italics'', '''bold''', '''''bold italics''''', @@typewriter@@ (monospaced) References: [[another page]], [[http://www.example.com]], [[another page \| link text]], [[#anchor]] Groups: [[Group/Page]] displays Page, [[Group.Page]] displays Group.Page, [[Group(.Page)]] displays Group
Separators: !!, !!! for headings, ---- for horizontal line Other markups: [+bigger+], [-smaller-], '^superscript^', '_subscript_', {+inserted+}, {-deleted-}	Prevent formatting: [=...=] Preformatted block: [@...@]