From 4e230ecc619740ebf01194f529d412fbb2043c00 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 20:55:18 +0200 Subject: [PATCH 1/7] doc: Update version --- doc/src/00000.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/00000.md b/doc/src/00000.md index 41ecb4b5..fe83aaa4 100644 --- a/doc/src/00000.md +++ b/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 From 9354ae003a4cbe0b750c17504afa74d4cbf93523 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 20:56:57 +0200 Subject: [PATCH 2/7] doc: Fix bullet-list markup --- doc/src/04100-module-notes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/src/04100-module-notes.md b/doc/src/04100-module-notes.md index 723f56ca..1f62ed26 100644 --- a/doc/src/04100-module-notes.md +++ b/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) From 6f71dc517f15e81699845ef400da28cb28d37099 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 20:57:36 +0200 Subject: [PATCH 3/7] doc: Remove comment --- doc/src/04020-module-movies | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/src/04020-module-movies b/doc/src/04020-module-movies index ac0c6169..847306e1 100644 --- a/doc/src/04020-module-movies +++ b/doc/src/04020-module-movies @@ -2,12 +2,11 @@ The Movies module. +## Description + + + +### Backends + + -### Description -# -# -# -#### Backends -# -# -# From bbb5e5858338fa874475e4006ee13120a7686d76 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 20:58:04 +0200 Subject: [PATCH 4/7] doc: Fix filename --- doc/src/{04020-module-movies => 04020-module-movies.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/src/{04020-module-movies => 04020-module-movies.md} (100%) diff --git a/doc/src/04020-module-movies b/doc/src/04020-module-movies.md similarity index 100% rename from doc/src/04020-module-movies rename to doc/src/04020-module-movies.md From 40d4939f3a4c1d54f26857398b2f1ef778e75647 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 21:02:21 +0200 Subject: [PATCH 5/7] doc: Fix up store entry example markup and content --- doc/src/02000-store.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/src/02000-store.md b/doc/src/02000-store.md index 7faafca9..965cd24e 100644 --- a/doc/src/02000-store.md +++ b/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. From 34e164e954d4f799eed3117f5dafc968a2a68e3e Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 21:32:50 +0200 Subject: [PATCH 6/7] doc: Add more description of modules --- doc/src/04000-modules.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/doc/src/04000-modules.md b/doc/src/04000-modules.md index e4317f7a..620e1819 100644 --- a/doc/src/04000-modules.md +++ b/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) From 75f57d622ce39427cf0202d0f7dc3dbcfbdba009 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 30 Jul 2016 21:36:45 +0200 Subject: [PATCH 7/7] doc: Fix code listing --- doc/src/04020-module-counter.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/src/04020-module-counter.md b/doc/src/04020-module-counter.md index ad09531d..29a819a8 100644 --- a/doc/src/04020-module-counter.md +++ b/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