web commit by http://subvert.org.uk/~bma/: Add my thoughts.

[ikiwiki.git] / doc / plugins / meta.mdwn

diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 0bcd11b67289fbdfb833a3d27df6cdfa549dd24f..b503e45112f029da47c2e185678e6660a8517cde 100644 (file)
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -103,6 +103,21 @@ Supported fields:
   For both cases, an anchor to jump to inside the destination page may also be
   specified using the common `PAGE#ANCHOR` syntax.
 
+* robots
+
+  Causes the robots meta tag to be written:
+
+        \[[meta robots="index, nofollow"]]
+
+  Valid values for the attribute are: "index", "noindex", "follow", and
+  "nofollow". Multiple comma-separated values are allowed, but obviously only
+  some combinations make sense. If there is no robots meta tag, "index,
+  follow" is used as the default.
+
+  The plugin escapes the value, but otherwise does not care about its
+  contents. In particular, it does not check the values against the set of
+  valid values but serves whatever you pass it.
+
 If the field is not one of the above predefined fields, the metadata will be
 written to the generated html page as a <meta> header. However, this
 won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to