X-Git-Url: http://nitlanguage.org diff --git a/contrib/nitiwiki/README.md b/contrib/nitiwiki/README.md index 1c764d4..757fa36 100644 --- a/contrib/nitiwiki/README.md +++ b/contrib/nitiwiki/README.md @@ -108,7 +108,6 @@ Settings: * `wiki.name`: Displayed name * `wiki.desc`: Long description * `wiki.logo`: Logo image url -* `wiki.root_url`: Base url used to resolve links * `wiki.root_dir`: Absolute path of base directory * `wiki.source_dir`: Source directory (relative path from `wiki.root_dir`) * `wiki.out_dir`: Output directory (relative) @@ -175,6 +174,29 @@ will appear like this: `Contact me!`. You can link to an anchor inside a page, using something like `[[WikiLink#foo]]`. +#### Trails of Pages + +Wikilinks, with the directive `trail`, will register the target page as an element of a trail. +Each `trail` are chained together and will display navigational link `prev` for the previous page of the trail, `next` for the next page of the trail and `up` to go to the pages that has used the `trail` wikilink. + +For instance, if the page `doc.md` has the following content: + +~~~md +To use nitiwiki, first [[trail: install|install it]], +then [[trail: simple_wiki|create a first wiki]]. + +You can also do advanced things like: + +* [[trail: github|editing pages with github]] +* [[trail: templating| adapting the templates]] +~~~ + +A trail will be made and will consist of the sequence of pages `install`, `simple_wiki`, `github` and `templating`. +On each one of these pages, there will be links for the previous page, the next page and the `doc.md` page. + +If a page includes trail wikilinks and is also the target for trail wikilinks, then the two trails are merged and pages will be visitable in a depth-first order. +This nesting of trails can be used to have sections and sub-sections. + #### Render the wiki in HTML Once you have done your changes, use: @@ -228,7 +250,7 @@ Every template can access to: * `SUBTITLE`: Wiki description * `LOGO`: Wiki logo image path -Additionnal macros can be used in specialized templates. +Additional macros can be used in specialized templates. ### Main template @@ -244,7 +266,9 @@ The template file `template.html` represents the overall structure of your wiki %HEADER% %TOP_MENU%