imag/lib/domain/libimagwiki at d2a5e8fb59b2f8a780d0ead752c38853ece7380f - matthiasbeyer/imag

History

Matthias Beyer d2a5e8fb59 Rename functions: _external_link -> _url Signed-off-by: Matthias Beyer <mail@beyermatthias.de>		2019-05-31 12:48:00 +02:00
..
src	Rename functions: _external_link -> _url	2019-05-31 12:48:00 +02:00
Cargo.toml	Update toml-query to 0.9.0	2019-05-29 18:39:25 +02:00
README.md	Initial import: libimagwiki	2018-04-15 10:27:09 +02:00

README.md

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.


+-------------+
|             |
|  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).