summaryrefslogtreecommitdiff
path: root/ikiwiki
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2008-05-29 09:20:41 +0200
committerJonas Smedegaard <dr@jones.dk>2008-05-29 09:20:41 +0200
commitef822340190099f08caed767742ce01a43a156e8 (patch)
tree6452c68fa1137746cef2719cd4275a84568ad25e /ikiwiki
parent509b5e775030896799a02201a3c84ba501744df6 (diff)
Sync with ikiwiki 2.47.
Diffstat (limited to 'ikiwiki')
-rw-r--r--ikiwiki/blog.mdwn25
-rw-r--r--ikiwiki/formatting.mdwn23
-rw-r--r--ikiwiki/markdown.mdwn3
-rw-r--r--ikiwiki/openid.mdwn12
-rw-r--r--ikiwiki/pagespec.mdwn1
-rw-r--r--ikiwiki/preprocessordirective.mdwn26
-rw-r--r--ikiwiki/subpage.mdwn1
-rw-r--r--ikiwiki/subpage/linkingrules.mdwn1
-rw-r--r--ikiwiki/wikilink.mdwn15
9 files changed, 66 insertions, 41 deletions
diff --git a/ikiwiki/blog.mdwn b/ikiwiki/blog.mdwn
index 6e5eec4..f1293ec 100644
--- a/ikiwiki/blog.mdwn
+++ b/ikiwiki/blog.mdwn
@@ -1,14 +1,15 @@
-[[if test="enabled(inline)"
+[[!meta robots="noindex, follow"]]
+[[!if test="enabled(inline)"
then="This wiki has the inline plugin **enabled**."
else="This wiki has the inline plugin **disabled**."]]
-[[if test="enabled(inline)"
+[[!if test="enabled(inline)"
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:
- \[[inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
+ \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
Any pages that match the specified [[PageSpec]] (in the example, any
[[SubPage]] of "blog") will be part of the blog, and the newest 10
@@ -23,23 +24,23 @@ 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:
- \[[inline pages="blog/* and !*/Discussion" archive="yes"]]
+ \[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
You can even create an automatically generated list of all the pages on the
wiki, with the most recently added at the top, like this:
- \[[inline pages="* and !*/Discussion" archive="yes"]]
+ \[[!inline pages="* and !*/Discussion" archive="yes"]]
If you want to be able to add pages to a given blog feed by tagging them,
you can do that too. To tag a page, just make it link to a page or pages
that represent its tags. Then use the special `link()` [[PageSpec]] to match
all pages that have a given tag:
- \[[inline pages="link(life)"]]
+ \[[!inline pages="link(life)"]]
Or include some tags and exclude others:
- \[[inline pages="link(debian) and !link(social)"]]
+ \[[!inline pages="link(debian) and !link(social)"]]
## usage
@@ -52,10 +53,12 @@ directive:
Set to 0 to show all matching pages.
* `skip` - Specify a number of pages to skip displaying. Can be useful
to produce a feed that only shows archived pages.
-* `rss` - controls generation of an rss feed. On by default if the wiki is
- configured to use rss feeds, set to "no" to disable.
-* `atom` - controls generation of an atom feed. On by default if the wiki is
- configured to use atom feeds, set to "no" to disable.
+* `rss` - controls generation of an rss feed. If the wiki is configured to
+ generate rss feeds by default, set to "no" to disable. If the wiki is
+ configured to `allowrss`, set to "yes" to enable.
+* `atom` - controls generation of an atom feed. If the wiki is configured to
+ generate atom feeds by default, set to "no" to disable. If the wiki is
+ configured to `allowatom`, set to "yes" to enable.
* `feeds` - controls generation of all types of feeds. Set to "no" to
disable generating any feeds.
* `postform` - Set to "yes" to enables a form to post new pages to a [[blog]].
diff --git a/ikiwiki/formatting.mdwn b/ikiwiki/formatting.mdwn
index 69e2891..29dbce1 100644
--- a/ikiwiki/formatting.mdwn
+++ b/ikiwiki/formatting.mdwn
@@ -1,4 +1,5 @@
-[[meta title="Formatting wiki pages"]]
+[[!meta title="Formatting wiki pages"]]
+[[!meta robots="noindex, follow"]]
Text on this wiki is, by default, written in a form very close to how you
might write text for an email message. This style of text formatting is
@@ -59,36 +60,36 @@ you use the following additional features:
* To link to another page on the wiki, place the page's name inside double
square brackets. So you would use `\[[WikiLink]]` to link to [[WikiLink]].
-[[if test="enabled(smiley) and smileys" then="""
+[[!if test="enabled(smiley) and smileys" then="""
* Insert [[smileys]] and some other useful symbols. :-)
"""]]
-[[if test="enabled(shortcut) and shortcuts" then="""
+[[!if test="enabled(shortcut) and shortcuts" then="""
* Use [[shortcuts]] to link to common resources.
- \[[wikipedia War\_of\_1812]]
+ \[[!wikipedia War\_of\_1812]]
"""]]
-[[if test="enabled(toc)" then="""
+[[!if test="enabled(toc)" then="""
* Add a table of contents to a page:
- \[[toc ]]
+ \[[!toc ]]
"""]]
-[[if test="enabled(meta)" then="""
+[[!if test="enabled(meta)" then="""
* Change the title of a page:
- \[[meta title="full page title"]]
+ \[[!meta title="full page title"]]
"""]]
-[[if test="enabled(inline) and blog" then="""
+[[!if test="enabled(inline) and blog" then="""
* Create a [[blog]] by inlining a set of pages:
- \[[inline pages="blog/*"]]
+ \[[!inline pages="blog/*"]]
"""]]
-[[if test="enabled(template) and templates" then="""
+[[!if test="enabled(template) and templates" then="""
* Create and fill out [[templates]] for repeated chunks of
parameterized wiki text.
"""]]
diff --git a/ikiwiki/markdown.mdwn b/ikiwiki/markdown.mdwn
index 73aee9c..bbda9ad 100644
--- a/ikiwiki/markdown.mdwn
+++ b/ikiwiki/markdown.mdwn
@@ -1,10 +1,11 @@
+[[!meta robots="noindex, follow"]]
[Markdown](http://daringfireball.net/projects/markdown/)
is a minimal markup language that resembles plain text as used in
email messages. It is the markup language used by this wiki by default.
For documentation about the markdown syntax, see [[formatting]] and
[Markdown: syntax](http://daringfireball.net/projects/markdown/syntax). A
-[markdown mode](http://jrblevin.freeshell.org/software/markdown-mode/) for
+[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
diff --git a/ikiwiki/openid.mdwn b/ikiwiki/openid.mdwn
index f02a0a6..dd851e5 100644
--- a/ikiwiki/openid.mdwn
+++ b/ikiwiki/openid.mdwn
@@ -1,6 +1,7 @@
-[[meta title="OpenID"]]
+[[!meta title="OpenID"]]
+[[!meta robots="noindex, follow"]]
-[[if test="enabled(openid)"
+[[!if test="enabled(openid)"
then="This wiki has OpenID **enabled**."
else="This wiki has OpenID **disabled**."]]
@@ -14,10 +15,11 @@ To sign up for an OpenID, visit one of the following identity providers:
* [GetOpenID](https://getopenid.com/)
* [Videntity](http://videntity.org/)
* [LiveJournal](http://www.livejournal.com/openid/)
-* or any of the [many others out there](http://openiddirectory.com/index.php?dir=1)..
+* [TrustBearer](https://openid.trustbearer.com/)
+* or any of the [many others out there](http://openiddirectory.com/openid-providers-c-1.html).
Your OpenID is the URL that you are given when you sign up.
-[[if test="enabled(openid)" then="""
+[[!if test="enabled(openid)" then="""
To sign in to this wiki using OpenID, just enter it in the OpenID field in the
signin form. You do not need to give this wiki a password or go through any
registration process when using OpenID.
@@ -28,5 +30,5 @@ registration process when using OpenID.
It's also possible to make a page in the wiki usable as an OpenID url,
by delegating it to an openid server. Here's an example of how to do that:
- \[[meta openid="http://yourid.myopenid.com/"
+ \[[!meta openid="http://yourid.myopenid.com/"
server="http://www.myopenid.com/server"]]
diff --git a/ikiwiki/pagespec.mdwn b/ikiwiki/pagespec.mdwn
index 3cd6bb9..156e3f6 100644
--- a/ikiwiki/pagespec.mdwn
+++ b/ikiwiki/pagespec.mdwn
@@ -1,3 +1,4 @@
+[[!meta robots="noindex, follow"]]
To select a set of pages, such as pages that are locked, pages
whose commit emails you want subscribe to, or pages to combine into a
blog, the wiki uses a PageSpec. This is an expression that matches
diff --git a/ikiwiki/preprocessordirective.mdwn b/ikiwiki/preprocessordirective.mdwn
index 1e2332c..743c0d9 100644
--- a/ikiwiki/preprocessordirective.mdwn
+++ b/ikiwiki/preprocessordirective.mdwn
@@ -1,7 +1,8 @@
+[[!meta robots="noindex, follow"]]
Preprocessor directives are similar to a [[WikiLink]] in form, except they
-contain spaces and parameters. The general form is:
+begin with `!` and may contain parameters. The general form is:
- \[[directive param="value" param="value"]]
+ \[[!directive param="value" param="value"]]
This gets expanded before the rest of the page is processed, and can be used
to transform the page in various ways.
@@ -9,25 +10,30 @@ to transform the page in various ways.
The quotes around values can be omitted if the value is a simple word.
Also, some directives may use parameters without values, for example:
- \[[tag foo]]
-
-Note that if a preprocessor directive has no parameters, a space still must
-be put after its name, to avoid confusion with a [[WikiLink]]. For example:
-
- \[[pagecount ]]
+ \[[!tag foo]]
A preprocessor directive does not need to all be on one line, it can be
wrapped to multiple lines if you like:
- \[[directive foo="baldersnatch"
+ \[[!directive foo="baldersnatch"
bar="supercalifragalisticexpealadocious" baz=11]]
Also, multiple lines of *quoted* text can be used for a value.
To allow quote marks inside the quoted text, delimit the block
of text with triple-quotes:
- \[[directive text="""
+ \[[!directive text="""
1. "foo"
2. "bar"
3. "baz"
"""]]
+
+ikiwiki also has an older syntax for preprocessor 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
+[[wikilinks|wikilink]]. ikiwiki now provides the `!`-prefixed syntax shown
+above as the preferred alternative. However, ikiwiki still supports wikis
+using the older syntax, if the `prefix_directives` option is not enabled.
+For backward compatibility with existing wikis, this option currently
+defaults to off, so ikiwiki supports the old syntax.
diff --git a/ikiwiki/subpage.mdwn b/ikiwiki/subpage.mdwn
index 4366920..e047b86 100644
--- a/ikiwiki/subpage.mdwn
+++ b/ikiwiki/subpage.mdwn
@@ -1,3 +1,4 @@
+[[!meta robots="noindex, follow"]]
ikiwiki supports placing pages in a directory hierarchy. For example,
this page, [[SubPage]] has some related pages placed under it, like
[[SubPage/LinkingRules]]. This is a useful way to add some order to your
diff --git a/ikiwiki/subpage/linkingrules.mdwn b/ikiwiki/subpage/linkingrules.mdwn
index c106230..e547f30 100644
--- a/ikiwiki/subpage/linkingrules.mdwn
+++ b/ikiwiki/subpage/linkingrules.mdwn
@@ -1,3 +1,4 @@
+[[!meta robots="noindex, follow"]]
To link to or from a [[SubPage]], you can normally use a regular
[[WikiLink]] that does not contain the name of the parent directory of
the [[SubPage]]. Ikiwiki descends the directory hierarchy looking for a
diff --git a/ikiwiki/wikilink.mdwn b/ikiwiki/wikilink.mdwn
index 38df00f..bd5e3d1 100644
--- a/ikiwiki/wikilink.mdwn
+++ b/ikiwiki/wikilink.mdwn
@@ -1,3 +1,4 @@
+[[!meta robots="noindex, follow"]]
WikiLinks provide easy linking between pages of the wiki. To create a
[[WikiLink]], just put the name of the page to link to in double brackets.
For example `\[[WikiLink]]`.
@@ -22,6 +23,14 @@ 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]]`
-**Note that you cannot use spaces in WikiLinks**. Replace spaces with
-underscores. The presence of spaces is used to distinguish between a
-[[PreprocessorDirective]] and a WikiLink.
+## Preprocessor directives and wikilinks
+
+ikiwiki has two syntaxes for
+[[preprocessor_directives|PreprocessorDirective]]. The older syntax
+used spaces to distinguish between preprocessor 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
+setup file, prefixes directives with `!`, and thus does not prevent
+links with spaces. Future versions of ikiwiki will turn this option
+on by default.