Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

[git.ikiwiki.info.git] / doc / plugins / contrib / field.mdwn

diff --git a/doc/plugins/contrib/field.mdwn b/doc/plugins/contrib/field.mdwn
index a43bf24b29007e63b1b00ada8a4b7deba67ab94a..09646d28ad2dfdf94ab3aa67e985898b2b1e85a5 100644 (file)
--- a/doc/plugins/contrib/field.mdwn
+++ b/doc/plugins/contrib/field.mdwn
@@ -13,6 +13,9 @@ IkiWiki::Plugin::field - front-end for per-page record fields.
     # simple registration
     field_register => [qw{meta}],
 
     # simple registration
     field_register => [qw{meta}],
 

+    # allow the config to be queried as a field
+    field_allow_config => 1,
+

 ## DESCRIPTION
 
 This plugin is meant to be used in conjunction with other plugins
 ## DESCRIPTION
 
 This plugin is meant to be used in conjunction with other plugins


@@ -32,8 +35,17 @@ a given page.  This can be used in three ways:
 
 The following options can be set in the ikiwiki setup file.
 
 
 The following options can be set in the ikiwiki setup file.
 

+**field_allow_config**
+
+    field_allow_config => 1,
+
+Allow the $config hash to be queried like any other field; the 
+keys of the config hash are the field names.
+

 **field_register**
 
 **field_register**
 

+    field_register => [qw{meta}],
+

 A list of plugin-IDs to register.  This assumes that the plugins in
 question store data in the %pagestatus hash using the ID of that plugin,
 and thus the field values are looked for there.
 A list of plugin-IDs to register.  This assumes that the plugins in
 question store data in the %pagestatus hash using the ID of that plugin,
 and thus the field values are looked for there.


@@ -46,12 +58,17 @@ registered with the "field" plugin.
 
 The "field" PageSpec function can be used to match the value of a field for a page.
 
 
 The "field" PageSpec function can be used to match the value of a field for a page.
 

-field(*name* *glob*)
+**field(*name* *glob*)**

 
 For example:
 
 field(bar Foo*) will match if the "bar" field starts with "Foo".
 
 
 For example:
 
 field(bar Foo*) will match if the "bar" field starts with "Foo".
 

+**destfield(*name* *glob*)**
+
+is the same, except that it tests the destination page (that is, in cases
+when the source page is being included in another page).
+

 ## FUNCTIONS
 
 ### field_register
 ## FUNCTIONS
 
 ### field_register