matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Rewrite module section intro

Browse source
This commit is contained in:
Matthias Beyer 2017-10-15 10:47:00 +02:00
parent 16ebf52385
commit cd429a3116
1 changed files with 3 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
doc/src/04000-modules.md
View file

@ -6,36 +6,13 @@ There is a huge list of modules available in the imag core distribution.
From a naming perspective, we do not differ between low-level and high-level From a naming perspective, we do not differ between low-level and high-level
modules. Some of the modules shipped with imag cover core functionality such as modules. Some of the modules shipped with imag cover core functionality such as
linking, tagging or references to files outside of the store or even the store 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). interface itself.
Others cover things like diary, notes, wiki or bookmarks. Others cover things like diary, notes, wiki or bookmarks.
These are also called "domains".
We try really hard to offer a consistent commandline user interface over all of We try really hard to offer a consistent commandline user interface over all of
these modules. these modules.
The following sections describe each module in detail, including its purpose and The following sections describe each module in detail, including its purpose and
its provided backends. its provided functionality.
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)