Mercurial > wikked
changeset 398:0f4032dafc1f
docs: Adjustments to documentation.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Fri, 23 Oct 2015 23:50:18 -0700 |
parents | dcaa41b39c23 |
children | de9a88073d41 |
files | docs/pages/00__index.md docs/pages/01_installation.md docs/pages/02_overview.md docs/pages/03_configuration.md docs/pages/04_syntax.md |
diffstat | 5 files changed, 36 insertions(+), 29 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/pages/00__index.md Wed Oct 21 22:48:19 2015 -0700 +++ b/docs/pages/00__index.md Fri Oct 23 23:50:18 2015 -0700 @@ -14,7 +14,7 @@ Install **Wikked** using Python 3.4 or later and `pip`: - pip install wikked + pip install --pre wikked Let's create a new wiki:
--- a/docs/pages/01_installation.md Wed Oct 21 22:48:19 2015 -0700 +++ b/docs/pages/01_installation.md Fri Oct 23 23:50:18 2015 -0700 @@ -9,7 +9,7 @@ You need [Python 3.4][py3] or later to use Wikked. Then, the easiest way to install it is to use `pip`: - pip install wikked + pip install --pre wikked If you want to use the very latest (and potentially broken) version:
--- a/docs/pages/02_overview.md Wed Oct 21 22:48:19 2015 -0700 +++ b/docs/pages/02_overview.md Fri Oct 23 23:50:18 2015 -0700 @@ -1,7 +1,7 @@ --- title: Overview icon: book -header_img: witch.png +header_img: melting.png --- Wikked's data is entirely stored in text files on disk. All you ever need, or @@ -11,6 +11,24 @@ re-created. +## General features + +Wikked implements the usual [wiki][] concepts of being able to edit pages, look +at their history, revert to previous revisions, or easily link to other pages. + +Wikked also supports the ability to include a page into another page, to assign +metadata (like categories) to pages, and to query pages based on that metadata. +So for example you can display a list of all pages under the category "_Witches +of Oz_". + +Finally, because the wiki sits on top of a standard source controlled +repository with text files in it, you can edit, pull, push, merge, rebase, and +more. This may not be shown correctly on the web history page, but you can still +do that. + +[wiki]: https://en.wikipedia.org/wiki/Wiki + + ## The wiki folder If you look at your new wiki, you should see a file called `Main page.md`, along @@ -43,18 +61,6 @@ > Windows, Mac, Linux). -## General features - -Wikked implements the usual wiki concepts of being able to edit pages, look at -their history and revert to previous revisions, and of course easily link to -other pages. - -Wikked also supports the ability to include a page into another page, to assign -metadata (like categories) to pages, and to query pages based on that metadata. -So for example you can display a list of all pages under the category "_Witches -of Oz_". - - ## Limitations Wikked was written mainly for a small group of editors in mind. It's especially
--- a/docs/pages/03_configuration.md Wed Oct 21 22:48:19 2015 -0700 +++ b/docs/pages/03_configuration.md Fri Oct 23 23:50:18 2015 -0700 @@ -1,7 +1,7 @@ --- title: Configuration icon: cog -header_img: soldier_monkey.png +header_img: witch.png --- Wikked can be configured with a few files: @@ -10,10 +10,10 @@ revision control, so that various clones of the wiki have the same options where it makes sense. -* `.wiki/wikirc`: some options, however, don't have to be the same depending on - where you run the wiki. This file is contained in the ignored-by-default - `.wiki` folder, and as such is meant to store options valid only for a local - installation. +* `.wiki/wikirc`: some options may have to be different depending on where you + run the wiki from. This file is a complementary variant of the `.wikirc` file, + but is contained in the ignored-by-default `.wiki` folder. As such it is meant + to store options valid only for a local installation. * `.wiki/app.cfg`: Wikked runs on top of [Flask][]. This file, if it exists, will be passed on to Flask for more advanced configuration scenarios. See the
--- a/docs/pages/04_syntax.md Wed Oct 21 22:48:19 2015 -0700 +++ b/docs/pages/04_syntax.md Fri Oct 23 23:50:18 2015 -0700 @@ -1,7 +1,7 @@ --- title: Syntax icon: pencil -header_img: melting.png +header_img: soldier_monkey.png --- ## Formatting @@ -14,9 +14,9 @@ ...turn into this: -> Ring around the rosie, a pocket full of *spears*! Thought you were pretty -> foxy, didn't you? **Well!** The last to go will see the first three go -> before her! _And your mangy little dog, too!_ +Ring around the rosie, a pocket full of *spears*! Thought you were pretty foxy, +didn't you? **Well!** The last to go will see the first three go before her! +_And your mangy little dog, too!_ [markdown]: http://daringfireball.net/projects/markdown/ @@ -96,7 +96,8 @@ lets you use a banner graphic or some other way to present the page to a visitor. -* `redirect`: Redirects to another page. +* `redirect`: Redirects to another page. The link resolution rules apply to the + redirect target. * `readers`: Specifies the users who can read this page. When not present, the default readers for the wiki will be able to read the page. See the @@ -116,10 +117,10 @@ {{include: Warning}} {%endraw%} -You can supply a relative or absolute page name to the `include` meta. For -convenience, however, Wikked will first look in the `/Templates` folder for a -page of that name to include. If it doesn't find one, it will resolve the path -as usual. +You can supply a relative or absolute page name to the `include` meta -- link +resolving rules apply. For convenience, however, if the path is not absolute, +Wikked will first look in the `/Templates` folder for a page of that name to +include. If it doesn't find one, it will resolve the path as usual. > You can make Wikked look into a different folder than `/Templates` by changing > the `templates_dir` option in the configuration file. See the [configuration