diff options
| author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-02-20 03:05:47 +0000 |
|---|---|---|
| committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-02-20 03:05:47 +0000 |
| commit | fa52a730ff3b30c7d2cdd8cd5f9c8c25a0c0a2a5 (patch) | |
| tree | 3a4eadd971ccd69bd4037ad3647b6cce64047833 /doc/plugins | |
| parent | 2ce6c23f9485d26d443fb5a1f8c5286a5e668625 (diff) | |
| download | ikiwiki-fa52a730ff3b30c7d2cdd8cd5f9c8c25a0c0a2a5.tar ikiwiki-fa52a730ff3b30c7d2cdd8cd5f9c8c25a0c0a2a5.tar.gz | |
* Changed calling convention for httmllink slightly. The first three
parameters remain the same, but additional options are now passed in using
named parameters.
* Change plugin interface version to 1.02 to reflect this change.
* Add a new anchor option to htmllink. Thanks Ben for the idea.
* Support anchors in wikilinks.
* Add a "more" plugin based on one contributed by Ben to allow implementing
those dreaded "Read more" links in blogs.
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/more.mdwn | 15 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 12 |
2 files changed, 22 insertions, 5 deletions
diff --git a/doc/plugins/more.mdwn b/doc/plugins/more.mdwn new file mode 100644 index 000000000..44a777813 --- /dev/null +++ b/doc/plugins/more.mdwn @@ -0,0 +1,15 @@ +[[template id=plugin name=more author="Ben"]] +[[tag type/format]] + +This plugin provides a way to have a "more" link on a page in a blog, that +leads to the full version of the page. Use it like this: + + \[[more linktext="click for more" text=""" + This is the rest of my post. Not intended for people catching up on + their blogs at 30,000 feet. Because I like to make things + difficult. + """]] + +If the `linktext` parameter is omitted it defaults to just "more". + +Note that you can accomplish something similar using a [[toggle]] instead. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index c10d73cf9..889057e69 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -329,7 +329,7 @@ subdirectory with the same name as the source page, failing that goes down the directory tree to the base looking for matching pages, as described in [[SubPage/LinkingRules]]. -#### `htmllink($$$;$$$)` +#### `htmllink($$$;@)` Many plugins need to generate html links and add them to a page. This is done by using the `htmllink` function. The usual way to call @@ -346,11 +346,13 @@ Here `$destpage` is the inlining page. A `destpage` parameter is passed to some of the hook functions above; the ones that are not passed it are not used during inlining and don't need to worry about this issue. -The remaining three optional parameters to `htmllink` are: +After the three required parameters, named parameters can be used to +control some options. These are: -1. noimageinline - set to true to avoid turning links into inline html images -1. forcesubpage - set to force a link to a subpage -1. linktext - set to force the link text to something +* noimageinline - set to true to avoid turning links into inline html images +* forcesubpage - set to force a link to a subpage +* linktext - set to force the link text to something +* anchor - set to make the link include an anchor #### `readfile($;$)` |