aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki-prefix-directives.mdwn
diff options
context:
space:
mode:
authorJosh Triplett <josh@freedesktop.org>2008-01-27 16:13:54 -0800
committerJosh Triplett <josh@freedesktop.org>2008-01-27 16:14:38 -0800
commit1b03a06c8c0dbf59469ff30d09a0c9c3051e0b00 (patch)
tree06f20b766475a98f7881aa962f0c8a494c87908b /doc/ikiwiki-prefix-directives.mdwn
parentfafb2edaa7aeb1293e716fa96f087cb713f4a70a (diff)
downloadikiwiki-1b03a06c8c0dbf59469ff30d09a0c9c3051e0b00.tar
ikiwiki-1b03a06c8c0dbf59469ff30d09a0c9c3051e0b00.tar.gz
Add new preprocessor directive syntax¸ using a '!' prefix.
Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
Diffstat (limited to 'doc/ikiwiki-prefix-directives.mdwn')
-rw-r--r--doc/ikiwiki-prefix-directives.mdwn26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/ikiwiki-prefix-directives.mdwn b/doc/ikiwiki-prefix-directives.mdwn
new file mode 100644
index 000000000..df4b88b1c
--- /dev/null
+++ b/doc/ikiwiki-prefix-directives.mdwn
@@ -0,0 +1,26 @@
+# NAME
+
+ikiwiki-prefix-directives - convert ikiwiki pages to prefixed directive syntax
+
+# SYNOPSIS
+
+ikiwiki-prefix-directives page.mdwn...
+
+# DESCRIPTION
+
+`ikiwiki-prefix-directives` converts an ikiwiki page from the old
+preprocessor directive syntax, requiring a space, to the new syntax,
+prefixed by '!'.
+
+Preprocessor directives which already use the new syntax will remain
+unchanged.
+
+Note that if the page contains wiki links with spaces, which some
+older versions of ikiwiki accepted, ikiwiki-prefix-directives will
+treat these as preprocessor directives and convert them.
+
+# AUTHOR
+
+Josh Triplett <josh@freedesktop.org>
+
+Warning: this page is automatically made into ikiwiki-prefix-directives's man page, edit with care