summaryrefslogtreecommitdiff
path: root/conf
diff options
context:
space:
mode:
authorPatrick Brown <ptbrown@whoopdedo.org>2015-07-22 22:28:09 -0400
committerPatrick Brown <ptbrown@whoopdedo.org>2015-07-22 22:28:09 -0400
commitb43568ad387384d9ae09bf4d7c0835ecbdc6b5b1 (patch)
tree0c590728c2047b483ae4b83f2ca0b1659167aa25 /conf
parent0cfb5a3076f8591bdbe10f9915199b3b3863dec8 (diff)
downloadrpg-b43568ad387384d9ae09bf4d7c0835ecbdc6b5b1.tar.gz
rpg-b43568ad387384d9ae09bf4d7c0835ecbdc6b5b1.tar.bz2
Document all options in the interwiki config
Diffstat (limited to 'conf')
-rw-r--r--conf/interwiki.conf12
1 files changed, 10 insertions, 2 deletions
diff --git a/conf/interwiki.conf b/conf/interwiki.conf
index 9305c038a..3ddcfd810 100644
--- a/conf/interwiki.conf
+++ b/conf/interwiki.conf
@@ -1,8 +1,16 @@
-# Each URL may contain one of the placeholders {URL} or {NAME}
+# Each URL may contain one of these placeholders
# {URL} is replaced by the URL encoded representation of the wikiname
# this is the right thing to do in most cases
# {NAME} this is replaced by the wikiname as given in the document
-# no further encoding is done
+# only mandatory encoded is done, urlencoding if the link
+# is an external URL, or encoding as a wikiname if it is an
+# internal link (begins with a colon)
+# {SCHEME}
+# {HOST}
+# {PORT}
+# {PATH}
+# {QUERY} these placeholders will be replaced with the appropriate part
+# of the link when parsed as a URL
# If no placeholder is defined the urlencoded name is appended to the URL
# To prevent losing your added InterWiki shortcuts after an upgrade,