Mercurial > wikked

comparison docs/pages/02_overview.md @ 382:3a61f45702cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add documentation site.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 04 Oct 2015 08:02:43 -0700
parents
children dcaa41b39c23
comparison
equal deleted inserted replaced
381:d5511d832af3 382:3a61f45702cb
1 ---
2 title: Overview
3 icon: book
4 ---
5
6 Wikked's data is entirely stored in text files on disk. All you ever need, or
7 should really care about, are those text files, and the source control
8 repository which contains their history. Wikked may create some other files --
9 cache files, indices, etc. -- but they can always be safely deleted and
10 re-created.
11
12
13 ## The wiki folder
14
15 If you look at your new wiki, you should see a file called `Main page.md`, along
16 with a few hidden files and directories.
17
18 * Each page's text is stored in a file whose name is the name of the page --
19 like that `Main page.md`. That name is important, since that's what you'll use
20 for linking to it, and what will show up in that page's URL. A page named
21 `Toto.md` would be available at the URL `/read/Toto`.
22
23 * Sub-directories also map to sub-folders in page names and URLs, so a file
24 located at `Villains/Flying monkeys.md` would be available at
25 `/read/Villains/Flying monkeys.md`.
26
27 * There's a `.wiki` folder that was created in the wiki root. This folder is
28 a cache, and can generally be safely deleted and re-created with the `wk
29 reset` command. You may however have some [local configuration
30 file(s)][config] in there, which we'll talk about later, so watch out before
31 deleting that folder.
32
33 * There's also some source control related files in there, like a `.hg` folder
34 and `.hgignore` file in the case of Mercurial. Don't touch those, they're
35 important (they store your pages' history). You can learn about them using the
36 wonders of the internet.
37
38 > There's nothing preventing you from using accented or non-latin characters for
39 > a new page name, except for characters that would be invalid for a file name.
40 > However, please note that most revision control systems are going to behave
41 > badly if you'll be working with your repository on mixed systems (_i.e._
42 > Windows, Mac, Linux).
43
44
45 ## General features
46
47 Wikked implements the usual wiki concepts of being able to edit pages, look at
48 their history and revert to previous revisions, and of course easily link to
49 other pages.
50
51 Wikked also supports the ability to include a page into another page, to assign
52 metadata (like categories) to pages, and to query pages based on that metadata.
53 So for example you can display a list of all pages under the category "_Witches
54 of Oz_".
55
56
57 ## Limitations
58
59 Wikked was written mainly for a small group of editors in mind. It's especially
60 well suited for a personal digital notebook, a private family documents
61 repository, or a wiki for a small team of people.
62
63 The main limitation of Wikked comes into play when you increase the number of
64 contributors -- *not* when you increase the number of visitors. Once the website
65 is cached, all requests are done against the SQL database, and search is done
66 through the indexer. This means you can scale quite well as long as you have the
67 appropriate backend (and as long as I don't write anything stupid in the code).
68
69 However, user accounts are stored in a text file, and must be added by hand by
70 an administrator, so it's impossible to scale this up to hundreds or thousands
71 of users. You could probably improve this by adding a different user account
72 backend, but when those users start editing pages, each edit must write to a
73 separate file on disk, and be committed to a source control repository, and this
74 will probably prove to be a bottleneck anyway at some point.
75
76 In summary: Wikked should be able to handle lots of visitors, but not too
77 many contributors.
78
79 ## Support
80
81 If you need assistance with Wikked, [contact me directly][me] or report an issue
82 on the [GitHub bug tracker][bugs].
83
84 [me]: http://ludovic.chabant.com
85 [bugs]: https://github.com/ludovicchabant/Wikked/issues
86 [config]: {{pcurl('configuration')}}
87