aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki/pagespec
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2008-10-15 01:25:01 +0200
committerintrigeri <intrigeri@boum.org>2008-10-18 15:49:12 +0200
commitd8c28006748ffe6037104bba4c040b2850cd8402 (patch)
treeef89fb69b3af9779a97302cd56c6de3d18ccdce4 /doc/ikiwiki/pagespec
parent886731612504bd4ac70244497b3313a20b7b6049 (diff)
downloadikiwiki-d8c28006748ffe6037104bba4c040b2850cd8402.tar
ikiwiki-d8c28006748ffe6037104bba4c040b2850cd8402.tar.gz
po plugin: documented custom PageSpec tests, reorganized doc a bit
Signed-off-by: intrigeri <intrigeri@boum.org>
Diffstat (limited to 'doc/ikiwiki/pagespec')
-rw-r--r--doc/ikiwiki/pagespec/po.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/ikiwiki/pagespec/po.mdwn b/doc/ikiwiki/pagespec/po.mdwn
new file mode 100644
index 000000000..2edfaa0c1
--- /dev/null
+++ b/doc/ikiwiki/pagespec/po.mdwn
@@ -0,0 +1,16 @@
+[[!if test="enabled(po)"
+ then="This wiki has po support **enabled**."
+ else="This wiki has po support **disabled**."]]
+
+If the [[po|plugins/po]] plugin is enabled, the regular
+[[ikiwiki/PageSpec]] syntax is expanded with the following additional
+tests that can be used to improve user navigation in a multi-lingual
+wiki:
+
+* "`lang(LL)`" - Tests whether a page is written in the language
+ specified as a ISO639-1 (two-letter) language code.
+* "`currentlang()`" - Tests whether a page is written in the same
+ language as the current page.
+
+Note: every non-PO page is considered to be written in
+`po_master_language`, as specified in `ikiwiki.setup`.