diff options
Diffstat (limited to 'doc/ikiwiki')
| -rw-r--r-- | doc/ikiwiki/blog.mdwn | 8 | ||||
| -rw-r--r-- | doc/ikiwiki/directive.mdwn (renamed from doc/ikiwiki/preprocessordirective.mdwn) | 6 | ||||
| -rw-r--r-- | doc/ikiwiki/markdown.mdwn | 6 | ||||
| -rw-r--r-- | doc/ikiwiki/wikilink.mdwn | 6 | ||||
| -rw-r--r-- | doc/ikiwiki/wikilink/discussion.mdwn | 2 |
5 files changed, 14 insertions, 14 deletions
diff --git a/doc/ikiwiki/blog.mdwn b/doc/ikiwiki/blog.mdwn index 19ec7ac30..53d4c7a96 100644 --- a/doc/ikiwiki/blog.mdwn +++ b/doc/ikiwiki/blog.mdwn @@ -7,7 +7,7 @@ then="You can" else="If this wiki had the inline plugin enabled, you could"]] turn any page on this wiki into a weblog by using the `inline` -[[PreProcessorDirective]]. For example: +[[directive]]. For example: \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] @@ -17,9 +17,9 @@ of them will appear in the page. Note that if files that are not pages match the [[PageSpec]], they will be included in the feed using RSS enclosures, which is useful for podcasting. -The optional `rootpage` parameter tells the wiki that new posts to this blog -should default to being [[SubPage]]s of "blog", and enables a form at the -top of the blog that can be used to add new items. +The optional `rootpage` parameter tells the wiki that new posts to this +blog should default to being [[SubPages|SubPage]] of "blog", and enables a +form at the top of the blog that can be used to add new items. If you want your blog to have an archive page listing every post ever made to it, you can accomplish that like this: diff --git a/doc/ikiwiki/preprocessordirective.mdwn b/doc/ikiwiki/directive.mdwn index 743c0d9f5..9a01aaa82 100644 --- a/doc/ikiwiki/preprocessordirective.mdwn +++ b/doc/ikiwiki/directive.mdwn @@ -1,5 +1,5 @@ [[!meta robots="noindex, follow"]] -Preprocessor directives are similar to a [[WikiLink]] in form, except they +Directives are similar to a [[WikiLink]] in form, except they begin with `!` and may contain parameters. The general form is: \[[!directive param="value" param="value"]] @@ -12,7 +12,7 @@ Also, some directives may use parameters without values, for example: \[[!tag foo]] -A preprocessor directive does not need to all be on one line, it can be +A directive does not need to all be on one line, it can be wrapped to multiple lines if you like: \[[!directive foo="baldersnatch" @@ -28,7 +28,7 @@ of text with triple-quotes: 3. "baz" """]] -ikiwiki also has an older syntax for preprocessor directives, which requires a +ikiwiki also has an older syntax for directives, which requires a space in directives to distinguish them from [[wikilinks|wikilink]]. This syntax has several disadvantages: it requires a space after directives with no parameters (such as `\[[pagecount ]]`), and it prohibits spaces in diff --git a/doc/ikiwiki/markdown.mdwn b/doc/ikiwiki/markdown.mdwn index bbda9add7..a4190945f 100644 --- a/doc/ikiwiki/markdown.mdwn +++ b/doc/ikiwiki/markdown.mdwn @@ -8,6 +8,6 @@ For documentation about the markdown syntax, see [[formatting]] and [markdown mode](http://jblevins.org/projects/markdown-mode/) for emacs can help in editing. -Note that [[WikiLink]]s and [[PreProcessorDirective]]s are not part of the -markdown syntax, and are the only bit of markup that this wiki handles -internally. +Note that [[WikiLinks|WikiLink]] and [[directives|directive]] are not part +of the markdown syntax, and are the only bit of markup that this wiki +handles internally. diff --git a/doc/ikiwiki/wikilink.mdwn b/doc/ikiwiki/wikilink.mdwn index bd5e3d185..371c2528f 100644 --- a/doc/ikiwiki/wikilink.mdwn +++ b/doc/ikiwiki/wikilink.mdwn @@ -23,11 +23,11 @@ page, but the link will appear like this: [[foo_bar|SandBox]]. To link to an anchor inside a page, you can use something like `\[[WikiLink#foo]]` -## Preprocessor directives and wikilinks +## Directives and WikiLinks ikiwiki has two syntaxes for -[[preprocessor_directives|PreprocessorDirective]]. The older syntax -used spaces to distinguish between preprocessor directives and +[[directives|directive]]. The older syntax +used spaces to distinguish between directives and wikilinks; as a result, with that syntax in use, you cannot use spaces in WikiLinks, and must replace spaces with underscores. The newer syntax, enabled with the `prefix_directives` option in an ikiwiki diff --git a/doc/ikiwiki/wikilink/discussion.mdwn b/doc/ikiwiki/wikilink/discussion.mdwn index e69fcb31b..e4b1f933f 100644 --- a/doc/ikiwiki/wikilink/discussion.mdwn +++ b/doc/ikiwiki/wikilink/discussion.mdwn @@ -14,7 +14,7 @@ BTW, ikiwiki doesn't displays the #foo anchor in the example --[[Paweł|ptecza]] > No such syntax exists in markdown. ikiwiki could certainly have a -> [[preprocessor_directive|preprocessordirective]] for it, though. +> [[preprocessor_directive|directive]] for it, though. > --[[JoshTriplett]] >> [[!tag wishlist]] |