summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2018-04-10 21:57:11 +0200
committerMatthias Beyer <mail@beyermatthias.de>2018-04-15 10:27:09 +0200
commitbb0d4319c392d75458adb6871db89a1666e70313 (patch)
tree1d8b7198417bc7f74d63b52de2d498328ddcf3ec /doc
parent90eb83a538885d8ea548e2f9d6842528d7164cf0 (diff)
Initial import: libimagwiki
Diffstat (limited to 'doc')
-rw-r--r--doc/src/05100-lib-wiki.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/src/05100-lib-wiki.md b/doc/src/05100-lib-wiki.md
new file mode 100644
index 00000000..93ba6970
--- /dev/null
+++ b/doc/src/05100-lib-wiki.md
@@ -0,0 +1,59 @@
+## libimagwiki
+
+The wiki library implements a complete wiki for personal use.
+
+This basically is a note-taking functionality combined with linking.
+
+### Layout
+
+The basic structure and layout is as simple as it gets:
+
+`/wiki` holds all wikis. The default wiki is `/wiki/default`. Below that there
+are entries. Entries can be in sub-collections, so
+`/wiki/default/cars/mustang` could be an entry.
+
+
+``` {.numberLines}
+
++-------------+
+| |
+| WikiStore |
+| |
++------+------+
+ 1 |
+ |
+ | n
++------v------+
+| |
+| Wiki |
+| |
++------+------+
+ 1 |
+ |
+ | n
++------v------+
+| | n
+| Entry <------+
+| | |
++------+------+ |
+ 1 | |
+ | |
+ | |
+ +-------------+
+```
+
+The store offers an interface to get a Wiki. The wiki offers an interface to get
+entries from it.
+
+Each Entry might link to a number of other entries _within the same wiki_.
+Cross-linking from one wiki entry to an entry of another wiki is technically
+possible, but not supported by the Entry itself (also read below).
+
+When creating a new wiki, the main page is automatically created.
+
+### Autolinking
+
+The `Entry` structure offers an interface which can be used to automatically
+detect links in the markdown.
+The links are then automatically linked (as in `libimagentrylink`).
+