matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity
imag/lib/domain/libimagwiki
History
Matthias Beyer 1d89844613 Run 'cargo fix' for rust-2018 
With this patch we move the codebase to Rust-2018.

The diff was generated by executing

    cargo fix --all --all-features --edition

on the codebase.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-05-18 00:20:59 +02:00
..
src Run 'cargo fix' for rust-2018 2019-05-18 00:20:59 +02:00
Cargo.toml Update version strings 2018-11-10 11:56:37 +01: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).