diff options
Diffstat (limited to 'doc/ikiwiki')
| -rw-r--r-- | doc/ikiwiki/directive/aggregate.mdwn | 5 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/comment.mdwn | 38 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/format.mdwn | 8 | ||||
| -rw-r--r-- | doc/ikiwiki/openid.mdwn | 2 | ||||
| -rw-r--r-- | doc/ikiwiki/wikilink.mdwn | 2 | ||||
| -rw-r--r-- | doc/ikiwiki/wikilink/discussion.mdwn | 4 |
6 files changed, 55 insertions, 4 deletions
diff --git a/doc/ikiwiki/directive/aggregate.mdwn b/doc/ikiwiki/directive/aggregate.mdwn index 70174f440..ddfcd40b7 100644 --- a/doc/ikiwiki/directive/aggregate.mdwn +++ b/doc/ikiwiki/directive/aggregate.mdwn @@ -19,6 +19,11 @@ more aggregated feeds. For example: \[[!inline pages="internal(example/*)"]] +Note the use of `internal()` in the [[ikiwiki/PageSpec]] to match +aggregated pages. By default, aggregated pages are internal pages, +which prevents them from showing up directly in the wiki, and so this +special [[PageSpec]] is needed to match them. + ## usage Here are descriptions of all the supported parameters to the `aggregate` diff --git a/doc/ikiwiki/directive/comment.mdwn b/doc/ikiwiki/directive/comment.mdwn new file mode 100644 index 000000000..21386dfc3 --- /dev/null +++ b/doc/ikiwiki/directive/comment.mdwn @@ -0,0 +1,38 @@ +The `comment` directive is supplied by the +[[!iki plugins/comments desc=comments]] plugin, and is used to add a comment +to a page. Typically, the directive is the only thing on a comment page, +and is filled out by the comment plugin when a user posts a comment. + +Example: + + \[[!comment format=mdwn + username="foo" + subject="Bar" + date="2009-06-02T19:05:01Z" + content=""" + Blah blah. + """ + ]] + +## usage + +The only required parameter is `content`, the others just add or override +metadata of the comment. + +* `content` - Text to display for the comment. + Note that [[directives|ikiwiki/directive]] + may not be allowed, depending on the configuration + of the comment plugin. +* `format` - Specifies the markup used for the content. +* `subject` - Subject for the comment. +* `date` - Date the comment was posted. Can be entered in + nearly any format, since it's parsed by [[!cpan TimeDate]] +* `username` - Used to record the username (or OpenID) + of a logged in commenter. +* `ip` - Can be used to record the IP address of a commenter, + if they posted anonymously. +* `claimedauthor` - Records the name that the user entered, + if anonmous commenters are allowed to enter their (unverified) + name. + +[[!meta robots="noindex, follow"]] diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn index 94cf1b04f..23830e9cd 100644 --- a/doc/ikiwiki/directive/format.mdwn +++ b/doc/ikiwiki/directive/format.mdwn @@ -18,4 +18,12 @@ some other format: 4 """]] +Note that if the highlight plugin is enabled, this directive can also be +used to display syntax highlighted code. Many languages and formats are +supported. For example: + + \[[format perl """ + print "hello, world\n"; + """]] + [[!meta robots="noindex, follow"]] diff --git a/doc/ikiwiki/openid.mdwn b/doc/ikiwiki/openid.mdwn index 5c91dfb58..a79655284 100644 --- a/doc/ikiwiki/openid.mdwn +++ b/doc/ikiwiki/openid.mdwn @@ -16,7 +16,7 @@ To sign up for an OpenID, visit one of the following identity providers: * [Videntity](http://videntity.org/) * [LiveJournal](http://www.livejournal.com/openid/) * [TrustBearer](https://openid.trustbearer.com/) -* or any of the [many others out there](http://openiddirectory.com/openid-providers-c-1.html) (but not [Yahoo](http://openid.yahoo.com) [[yet|plugins/openid/discussion/#Yahoo_unsupported]]). +* 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=""" diff --git a/doc/ikiwiki/wikilink.mdwn b/doc/ikiwiki/wikilink.mdwn index 371c2528f..f561d5850 100644 --- a/doc/ikiwiki/wikilink.mdwn +++ b/doc/ikiwiki/wikilink.mdwn @@ -21,7 +21,7 @@ name as the link text. For example `\[[foo_bar|SandBox]]` links to the SandBox 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]]` +`\[[WikiLink#foo]]` . ## Directives and WikiLinks diff --git a/doc/ikiwiki/wikilink/discussion.mdwn b/doc/ikiwiki/wikilink/discussion.mdwn index 0677ff7de..b146c9447 100644 --- a/doc/ikiwiki/wikilink/discussion.mdwn +++ b/doc/ikiwiki/wikilink/discussion.mdwn @@ -1,6 +1,6 @@ -# Creating an anchor in Markdown +# Creating an [[anchor]] in Markdown -Is it a native Markdown "tag" for creating an anchor? Unfortunately, +Is it a native Markdown "tag" for creating an [[anchor]]? Unfortunately, I haven't any information about it at [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) page. |