Merge pull request #601 from matthiasbeyer/doc-updates

Doc updates

doc/src/00000.md

@@ -1,6 +1,6 @@
 ---
 title: imag User Documentation
-version: 0.1.0
+version: 0.2.0
 date: July 2016
 listings: true
 codeBlockCaptions: true

doc/src/02000-store.md

@@ -67,15 +67,15 @@ store binary data. We don't want this, though.
 
 An example for a file in the store follows.
 
-```
+```text
+
 ---
 [imag]
+links = ["/home/user/more_kittens.mpeg"]
 version = "0.2.0"
 
-imag.links = ["/home/user/more_kittens.mpeg"]
-
-[examplemodule]
-arbitrary = "data"
+[note]
+name = "foo"
 ---
 
 This is an example text, written by the user.

doc/src/04000-modules.md

@@ -9,5 +9,33 @@ linking, tagging or references to files outside of the store or even the store
 interface itself (which by the way shouldn't be used by the end-user at all).
 Others cover things like diary, notes, wiki or bookmarks.
 
-The modules try to offer a consistent commandline user interface.
+We try really hard to offer a consistent commandline user interface over all of
+these modules.
+
+The following sections describe each module in detail, including its purpose and
+its provided backends.
+
+A backend is simply an external tool imag might be able to use.
+For example, the `imag-todo` module offers a `taskwarrior` interface, so imag
+itself does not cover anything which has to do with todo management, but lets
+you continue using `taskwarrior` for that (which does a really good job).
+So what does the `imag-todo` module do?
+Well, it offers you ways to track tasks created in `taskwarrior` and putting
+files which can be used as references to tasks then.
+For example, if you create a task in `taskwarrior`, you end up with an UUID for
+this task.
+imag stores this UUID in a store entry and you are now able to `imag-link` this
+file with other files in the store.
+This way you can link `taskwarrior` tasks with other data (of course,
+`imag-todo` offers some more commands, for searching tasks and so on).
+
+But what if you do not like `taskwarrior`?
+That's what backends are for.
+The goal of imag is to provide backends for not just one tool which implements a
+PIM aspect, but for many.
+So you can change the configuration for `imag-todo` to not use `taskwarrior` but
+some other todo tool.
+
+(This is all hypothetical by now because these things are not yet implemented.
+Anyhow, we aim for exactly what is described above)
 

doc/src/04020-module-counter.md

@@ -20,6 +20,7 @@ counters will be added as well.
 Here are some examples how to use the counter module:
 
 ```bash
+
 imag counter create --name example --initval 42 # or: -n example -i 42
 imag counter --inc example # or -i example
 imag counter --reset example

doc/src/04020-module-movies

@@ -1,13 +0,0 @@
-## Movies {#sec:modules:movies}
-
-The Movies module.
-
-
-### Description
-#
-#<!-- Description of the module -->
-#
-#### Backends
-#
-#<!-- Backends the module supports including links to external resources -->
-#

doc/src/04020-module-movies.md

@@ -0,0 +1,12 @@
+## Movies {#sec:modules:movies}
+
+The Movies module.
+
+## Description
+
+<!-- Description of the module -->
+
+### Backends
+
+<!-- Backends the module supports including links to external resources -->
+

doc/src/04100-module-notes.md

@@ -7,10 +7,10 @@ The notes module offers:
 
 * adding, removing and settings of tags
 * listing notes, optionally filtered by
-  * tags
-  * `grep`ping through note content and listing
-    * the matches
-    * files with matches
+    * tags
+    * `grep`ping through note content and listing
+        * the matches
+        * files with matches
 * opening a note via `xdg-open` (rendered as HTML if content is written in
   a markup language)