Mercurial > wikked

comparison docs/pages/02_overview.md @ 398:0f4032dafc1f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Adjustments to documentation.
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 23 Oct 2015 23:50:18 -0700
parents dcaa41b39c23
children
comparison
equal deleted inserted replaced
397:dcaa41b39c23 398:0f4032dafc1f
1 --- 1 ---
2 title: Overview 2 title: Overview
3 icon: book 3 icon: book
4 header_img: witch.png 4 header_img: melting.png
5 --- 5 ---
6 6
7 Wikked's data is entirely stored in text files on disk. All you ever need, or 7 Wikked's data is entirely stored in text files on disk. All you ever need, or
8 should really care about, are those text files, and the source control 8 should really care about, are those text files, and the source control
9 repository which contains their history. Wikked may create some other files -- 9 repository which contains their history. Wikked may create some other files --
10 cache files, indices, etc. -- but they can always be safely deleted and 10 cache files, indices, etc. -- but they can always be safely deleted and
11 re-created. 11 re-created.
12
13
14 ## General features
15
16 Wikked implements the usual [wiki][] concepts of being able to edit pages, look
17 at their history, revert to previous revisions, or easily link to other pages.
18
19 Wikked also supports the ability to include a page into another page, to assign
20 metadata (like categories) to pages, and to query pages based on that metadata.
21 So for example you can display a list of all pages under the category "_Witches
22 of Oz_".
23
24 Finally, because the wiki sits on top of a standard source controlled
25 repository with text files in it, you can edit, pull, push, merge, rebase, and
26 more. This may not be shown correctly on the web history page, but you can still
27 do that.
28
29 [wiki]: https://en.wikipedia.org/wiki/Wiki
12 30
13 31
14 ## The wiki folder 32 ## The wiki folder
15 33
16 If you look at your new wiki, you should see a file called `Main page.md`, along 34 If you look at your new wiki, you should see a file called `Main page.md`, along
41 > However, please note that most revision control systems are going to behave 59 > However, please note that most revision control systems are going to behave
42 > badly if you'll be working with your repository on mixed systems (_i.e._ 60 > badly if you'll be working with your repository on mixed systems (_i.e._
43 > Windows, Mac, Linux). 61 > Windows, Mac, Linux).
44 62
45 63
46 ## General features
47
48 Wikked implements the usual wiki concepts of being able to edit pages, look at
49 their history and revert to previous revisions, and of course easily link to
50 other pages.
51
52 Wikked also supports the ability to include a page into another page, to assign
53 metadata (like categories) to pages, and to query pages based on that metadata.
54 So for example you can display a list of all pages under the category "_Witches
55 of Oz_".
56
57
58 ## Limitations 64 ## Limitations
59 65
60 Wikked was written mainly for a small group of editors in mind. It's especially 66 Wikked was written mainly for a small group of editors in mind. It's especially
61 well suited for a personal digital notebook, a private family documents 67 well suited for a personal digital notebook, a private family documents
62 repository, or a wiki for a small team of people. 68 repository, or a wiki for a small team of people.