aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/getfield.mdwn
diff options
context:
space:
mode:
authorhttp://kerravonsen.dreamwidth.org/ <http://kerravonsen.dreamwidth.org/@web>2011-09-05 23:36:06 -0400
committeradmin <admin@branchable.com>2011-09-05 23:36:06 -0400
commit4bfc25aa61c90f92ca2251c2a8238eba25759b54 (patch)
tree6a1c1f9ec43d5b083977280ccc9af28a0a4b245a /doc/plugins/contrib/getfield.mdwn
parentb0930dcb39d1f7612c2cdf310666cf2ae50e2c4c (diff)
downloadikiwiki-4bfc25aa61c90f92ca2251c2a8238eba25759b54.tar
ikiwiki-4bfc25aa61c90f92ca2251c2a8238eba25759b54.tar.gz
new version of getfield 1.20110906
Diffstat (limited to 'doc/plugins/contrib/getfield.mdwn')
-rw-r--r--doc/plugins/contrib/getfield.mdwn18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/plugins/contrib/getfield.mdwn b/doc/plugins/contrib/getfield.mdwn
index 0a92894f1..61e80c58a 100644
--- a/doc/plugins/contrib/getfield.mdwn
+++ b/doc/plugins/contrib/getfield.mdwn
@@ -26,7 +26,7 @@ One can get the value of a field by using special markup in the page.
This does not use directive markup, in order to make it easier to
use the markup inside other directives. There are four forms:
-* {{$*fieldname*}}
+* \{{$*fieldname*}}
This queries the value of *fieldname* for the source page.
@@ -39,7 +39,7 @@ use the markup inside other directives. There are four forms:
<h1>My Long and Complicated Title With Potential For Spelling Mistakes</h1>
-* {{$*pagename*#*fieldname*}}
+* \{{$*pagename*#*fieldname*}}
This queries the value of *fieldname* for the page *pagename*.
@@ -53,13 +53,13 @@ use the markup inside other directives. There are four forms:
On PageBar:
- For more info, see \[[{{$PageFoo#title}}|PageFoo]].
+ For more info, see \[[\{{$PageFoo#title}}|PageFoo]].
When PageBar is displayed:
&lt;p&gt;For more info, see &lt;a href="PageFoo"&gt;I Am Page Foo&lt;/a&gt;.&lt;/p&gt;
-* {{+$*fieldname*+}}
+* \{{+$*fieldname*+}}
This queries the value of *fieldname* for the destination page; that is,
the value when this page is included inside another page.
@@ -88,16 +88,22 @@ use the markup inside other directives. There are four forms:
<h1>I Am Page B</h1>
<p>Stuff about A.</p>
-* {{+$*pagename*#*fieldname*+}}
+* \{{+$*pagename*#*fieldname*+}}
This queries the value of *fieldname* for the page *pagename*; the
- only difference between this and {{$*pagename*#*fieldname*}} is
+ only difference between this and \{{$*pagename*#*fieldname*}} is
that the full name of *pagename* is calculated relative to the
destination page rather than the source page.
I can't really think of a reason why this should be needed, but
this format has been added for completeness.
+### Escaping
+
+Getfield markup can be escaped by putting a backwards slash `\`
+in front of the markup.
+If that is done, then the markup is displayed as-is.
+
### No Value Found
If no value is found for the given field, then the field name is returned.