diff options
| -rw-r--r-- | ikiwiki.mdwn | 15 | ||||
| -rw-r--r-- | ikiwiki/blog.mdwn | 2 | ||||
| -rw-r--r-- | ikiwiki/formatting.mdwn | 2 | ||||
| -rw-r--r-- | ikiwiki/markdown.mdwn | 3 | ||||
| -rw-r--r-- | sandbox.mdwn | 2 | ||||
| -rw-r--r-- | shortcuts.mdwn | 19 | ||||
| -rw-r--r-- | templates.mdwn | 26 | ||||
| -rw-r--r-- | templates/note.mdwn | 4 |
8 files changed, 47 insertions, 26 deletions
diff --git a/ikiwiki.mdwn b/ikiwiki.mdwn new file mode 100644 index 0000000..c3773ed --- /dev/null +++ b/ikiwiki.mdwn @@ -0,0 +1,15 @@ +This wiki is powered by [ikiwiki](http://ikiwiki.info/). +[[if test="enabled(version)" + then="(Currently running version [[version ]].)" +]] + +Some documentation on using ikiwiki: + +* [[ikiwiki/formatting]] +* [[ikiwiki/blog]] +* [[ikiwiki/pagespec]] +* [[ikiwiki/PreprocessorDirective]] +* [[ikiwiki/wikilink]] +* [[ikiwiki/markdown]] +* [[ikiwiki/subpage]] +* [[ikiwiki/openid]] diff --git a/ikiwiki/blog.mdwn b/ikiwiki/blog.mdwn index fe83977..6e5eec4 100644 --- a/ikiwiki/blog.mdwn +++ b/ikiwiki/blog.mdwn @@ -93,3 +93,5 @@ directive: the rss/atom feeds. The default is the same as the `show` value above. * `feedonly` - Only generate the feed, do not display the pages inline on the page. +* `timeformat` - Use this to specify how to display the time or date for pages + in the blog. The format string is passed to the strftime(3) function. diff --git a/ikiwiki/formatting.mdwn b/ikiwiki/formatting.mdwn index 4e8760c..69e2891 100644 --- a/ikiwiki/formatting.mdwn +++ b/ikiwiki/formatting.mdwn @@ -1,4 +1,4 @@ -[[meta title="Help on formatting wiki pages"]] +[[meta title="Formatting wiki pages"]] 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 diff --git a/ikiwiki/markdown.mdwn b/ikiwiki/markdown.mdwn index e7823bb..73aee9c 100644 --- a/ikiwiki/markdown.mdwn +++ b/ikiwiki/markdown.mdwn @@ -2,7 +2,7 @@ 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 [[HelpOnFormatting]] and +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 emacs can help in editing. @@ -10,4 +10,3 @@ 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. - diff --git a/sandbox.mdwn b/sandbox.mdwn index c93c8f3..c66534f 100644 --- a/sandbox.mdwn +++ b/sandbox.mdwn @@ -29,4 +29,4 @@ Bulleted list * *item* * item -[[WikiLink]] +[[ikiwiki/WikiLink]] diff --git a/shortcuts.mdwn b/shortcuts.mdwn index 7884084..105c8e0 100644 --- a/shortcuts.mdwn +++ b/shortcuts.mdwn @@ -11,7 +11,7 @@ Some examples of using shortcuts include: This page controls what shortcut links the wiki supports. * [[shortcut name=google url="http://www.google.com/search?q=%s"]] -* [[shortcut name=archive url="http://web.archive.org/*/%s"]] +* [[shortcut name=archive url="http://web.archive.org/*/%S"]] * [[shortcut name=gmap url="http://maps.google.com/maps?q=%s"]] * [[shortcut name=gmsg url="http://groups.google.com/groups?selm=%s"]] * [[shortcut name=wikipedia url="http://en.wikipedia.org/wiki/%s"]] @@ -37,8 +37,7 @@ This page controls what shortcut links the wiki supports. * [[shortcut name=cpan url="http://search.cpan.org/search?mode=dist&query=%s"]] * [[shortcut name=ctan url="http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=%s"]] * [[shortcut name=hoogle url="http://haskell.org/hoogle/?q=%s"]] -* [[shortcut name=iki url="http://ikiwiki.info/%s/"]] -* [[shortcut name=ikirev url="http://ikiwiki.info/cgi-bin/viewvc.cgi?view=rev&root=ikiwiki&revision=%s"]] +* [[shortcut name=iki url="http://ikiwiki.info/%S/"]] * [[shortcut name=ljuser url="http://%s.livejournal.com/"]] * [[shortcut name=rfc url="http://www.ietf.org/rfc/rfc%s.txt" desc="RFC %s"]] * [[shortcut name=c2 url="http://c2.com/cgi/wiki?%s"]] @@ -54,16 +53,16 @@ This page controls what shortcut links the wiki supports. * [[shortcut name=cia url="http://cia.vc/stats/project/%s"]] * [[shortcut name=ciauser url="http://cia.vc/stats/user/%s"]] * [[shortcut name=flickr url="http://www.flickr.com/photos/%s"]] -* [[shortcut name=zooomr url="http://www.zooomr.com/photos/%s"]] - * Note: You have to include the username and number in here, such as `bob/123455`. -To add a new shortcut, use the `shortcut` [[PreprocessorDirective]]. "%s" is -replaced with the text passed to the named shortcut. The optional `desc` -parameter controls the description of the link. +To add a new shortcut, use the `shortcut` +[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the +text passed to the named shortcut, after url-encoding it, and '%S' is +replaced with the raw, non-encoded text. The optional `desc` parameter +controls the description of the link. Remember that the `name` you give the shortcut will become a new -[[PreprocessorDirective]]. Avoid using a `name` that conflicts with an -existing directive. +[[ikiwiki/PreprocessorDirective]]. Avoid using a `name` that conflicts +with an existing directive. If you come up with a shortcut that you think others might find useful, consider contributing it to the [[iki shortcuts]] page on the ikiwiki diff --git a/templates.mdwn b/templates.mdwn index 33e02b9..9ed9b83 100644 --- a/templates.mdwn +++ b/templates.mdwn @@ -26,9 +26,9 @@ Using a template works like this: This fills out the [[note]] template, filling in the `text` field with the specified value, and inserts the result into the page. -A value can include any markup that would be allowed in the wiki page -outside the template. Triple-quoting the value even allows quotes to be -included in it. Combined with multi-line quoted values, this allows for +Generally, a value can include any markup that would be allowed in the wiki +page outside the template. Triple-quoting the value even allows quotes to +be included in it. Combined with multi-line quoted values, this allows for large chunks of marked up text to be embedded into a template: \[[template id=foo name="Sally" color="green" age=8 notes=""" @@ -43,13 +43,15 @@ To create a template, simply add a template directive to a page, and page will provide a link that can be used to create the template. The template is a regular wiki page, located in the `templates/` directory. -The template uses the syntax used by the -[cpan HTML::Template](http://search.cpan.org/search?mode=dist&query=HTML::Template) -perl module, which allows for some fairly complex things to be done. -Consult its documentation for the full syntax, but all you really need to know -are a few things: +The template uses the syntax used by the [[cpan HTML::Template]] perl +module, which allows for some fairly complex things to be done. Consult its +documentation for the full syntax, but all you really need to know are a +few things: -* To insert the value of a variable, use `<TMPL_VAR variable>`. +* To insert the value of a variable, use `<TMPL_VAR variable>`. Wiki markup + in the value will first be converted to html. +* To insert the raw value of a variable, with wiki markup not yet converted + to html, use `<TMPL_VAR raw_variable>`. * To make a block of text conditional on a variable being set use `<TMPL_IF NAME="variable">text</TMPL_IF>`. * To use one block of text if a variable is set and a second if it's not, @@ -58,7 +60,7 @@ are a few things: Here's a sample template: <span class="infobox"> - Name: <TMPL_VAR name><br /> + Name: [[<TMPL_VAR raw_name>]]<br /> Age: <TMPL_VAR age><br /> <TMPL_IF NAME="color"> Favorite color: <TMPL_VAR color><br /> @@ -75,3 +77,7 @@ The filled out template will be formatted the same as the rest of the page that contains it, so you can include WikiLinks and all other forms of wiki markup in the template. Note though that such WikiLinks will not show up as backlinks to the page that uses the template. + +Note the use of "raw_name" inside the [[WikiLink]] generator. This ensures +that if the name contains something that might be mistaken for wiki markup, +it's not converted to html before being processed as a [[WikiLink]]. diff --git a/templates/note.mdwn b/templates/note.mdwn index d992e02..4cc323c 100644 --- a/templates/note.mdwn +++ b/templates/note.mdwn @@ -1,6 +1,6 @@ -<span class="notebox"> +<div class="notebox"> <TMPL_VAR text> -</span> +</div> <TMPL_UNLESS NAME="text"> Use this template to insert a note into a page. The note will be styled to float to the right of other text on the page. This template has one |