contrib plugin: pagespecalias
authorJon Dowland <jmtd@debian.org>
Wed, 28 Dec 2011 16:36:38 +0000 (16:36 +0000)
committerJon Dowland <jmtd@debian.org>
Wed, 28 Dec 2011 17:05:05 +0000 (17:05 +0000)
doc/plugins/contrib/pagespec_alias.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/contrib/pagespec_alias.mdwn b/doc/plugins/contrib/pagespec_alias.mdwn
new file mode 100644 (file)
index 0000000..1d78890
--- /dev/null
@@ -0,0 +1,28 @@
+[[!template id=plugin name=pagespec_alias author="[[Jon]]"]]
+[[!tag type/meta]]
+
+The pagespec_alias plugin allows the administrator(s) of a wiki to define
+[[PageSpec]] aliases: short names for PageSpecs to ease re-use.
+
+Within the setup file, the `pagespec_aliases` value is treated as a list
+of key/value pairs.  The keys define alias names, the values the pagespecs
+to which they refer.
+
+For example:
+
+    pagespec_aliases:
+       image: "*.png or *.jpg or *.jpeg or *.gif or *.ico"
+       helper: "*.css or *.js"
+       boring: "image() or helper() or internal(*)"
+
+With the above, you could use the pagespec aliases such as 
+
+    \[[!map pages="!boring()"]]
+
+To define a site map which excluded various page names which might be
+uninteresting to include in a site map.
+
+
+## Download
+
+ * <https://github.com/jmtd/ikiwiki/blob/jmtd/pagespec-alias/IkiWiki/Plugin/alias.pm>