summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/pagespec/po.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ikiwiki/pagespec/po.mdwn')
-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..a5f88cf66
--- /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`.