X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7351d545d96df3c1359312b1a5b79530fa6ab4fd..3aacac3b:/doc/todo/wikitrails.mdwn diff --git a/doc/todo/wikitrails.mdwn b/doc/todo/wikitrails.mdwn index ca97c9404..d11d29bb2 100644 --- a/doc/todo/wikitrails.mdwn +++ b/doc/todo/wikitrails.mdwn @@ -1,17 +1,27 @@ ## summary at times it is useful to have a guided tour or trail through a subset of the pages of a wiki; in pmwiki, this is implemented as [wikitrails](http://www.pmwiki.org/wiki/PmWiki/WikiTrails). +### smcv's implementation + +... is the out-of-tree [[plugins/trail]] plugin, see there for details. + +> And will be the one landing in ikiwiki. So, I'm closing this bug report. [[done]] --[[Joey]] + +### chrysn's implementation + i'm working on a python xmlrpc plugin for ikiwiki to support wikitrails, both as a navigation feature (have "forward" and "back" links based on a sequence) and a modified inline that includes all pages in the trail with appropriate modifications (suitable for printing if necessary). -the current status is published on `git://github.com/github076986099/ikiwiki-plugins.git`; as of now, i don't have a public demo of it. +the current status is published on `git://prometheus.amsuess.com/ikiwiki-plugins`; as of now, i don't have a public demo of it. feedback on both the concept and the code is very much appreciated by [[discussion]] or [email](mailto:chrysn@fsfe.org). -## usage +> update as of 2013: this implementation is kept in said ikiwiki-plugins directory for historical reference only; with the implementation nowadays available in ikiwiki, my implementation is obsolete. --[[chrysn]] + +#### usage two preprocessor commands are provided: -### \[[!trail index="my_indexpage"]] +##### \[[!trail index="my_indexpage"]] embeds a navigation object with forward and back links as well as an indicator of the current position in the trail. @@ -19,15 +29,15 @@ if index is not specified, a suitable page up the path is used. this works very well together with the [[sidebar|plugins/sidebar]] plugin if the pages in a directory are roughly the same as the pages in the trail and the `index` is directory index page; just put the \[[!trail]] in the sidebar. -### \[[!trailinclude index="my_indexpage"]] +##### \[[!trailinclude index="my_indexpage"]] all pages linked from the index page are included in the same way as \[[!inline]] does, but in the proper sequence, with headings according to the indent in the source page and adoptions for the headings inside the page (a level 2 heading in a page that is a sub-sub-chapter in the whole trail will become a level 5 heading when trailincluded). -## the index page +#### the index page the index page is parsed as markdown; numbered lists and "`*`" bulleted lists are discovered. -## current issues +#### current issues * rebuilding --- currently, there is no propper rebuilding of pages (will use `will_render` and `add_depends`). care has to be taken of how not yet created pages play into this. * inline recursion --- there is simply no guard yet