doc: Format for line length
This commit is contained in:
parent
6e56f469ae
commit
104cbfbfa7
6 changed files with 35 additions and 15 deletions
|
@ -6,7 +6,7 @@ The diary module giv3s you the possibility to write your diary in imag.
|
||||||
It offers daily, hourly and minutely entries (the latter beeing more like
|
It offers daily, hourly and minutely entries (the latter beeing more like
|
||||||
a private tumble-blog).
|
a private tumble-blog).
|
||||||
|
|
||||||
Exporting the diary is possible, so one can write it in markdown and
|
Exporting the diary is possible, so one can write it in markdown and
|
||||||
later pass that to pandoc, if desired, to generate a website or book
|
later pass that to pandoc, if desired, to generate a website or book
|
||||||
from it.
|
from it.
|
||||||
|
|
||||||
|
|
|
@ -1,16 +1,26 @@
|
||||||
## Mails {#sec:modules:mails}
|
## Mails {#sec:modules:mails}
|
||||||
|
|
||||||
The Mails module implements a commandline email client. Emails can be written (via `$EDITOR`) and viewed, also in threads. Emails can be crawled for creating new contacts.
|
The Mails module implements a commandline email client. Emails can be written
|
||||||
|
(via `$EDITOR`) and viewed, also in threads. Emails can be crawled for creating
|
||||||
|
new contacts.
|
||||||
|
|
||||||
A Text User Interface is not planned, but might be there at some point.
|
A Text User Interface is not planned, but might be there at some point.
|
||||||
|
|
||||||
The mail module implements a minimal Email client. It does not handle IMAP syncing or SMTP things, it is just a _viewer_ for emails (a MUA).
|
The mail module implements a minimal Email client. It does not handle IMAP
|
||||||
|
syncing or SMTP things, it is just a _viewer_ for emails (a MUA).
|
||||||
|
|
||||||
The goal of the initial implementation is only a CLI, not a TUI like mutt offers, for example (but that might be implemented later). As this is an imag module, it also creates references to mails inside the imag store which can be used by other tools then (for example `imag-link` to link an entry with a mail - or the imag entry representing that mail).
|
The goal of the initial implementation is only a CLI, not a TUI like mutt
|
||||||
|
offers, for example (but that might be implemented later). As this is an imag
|
||||||
|
module, it also creates references to mails inside the imag store which can be
|
||||||
|
used by other tools then (for example `imag-link` to link an entry with a mail -
|
||||||
|
or the imag entry representing that mail).
|
||||||
|
|
||||||
So this module offers functionality to read (Maildir) mailboxes, search for and list mails and mail-threads and reply to mails (by spawning the `$EDITOR`).
|
So this module offers functionality to read (Maildir) mailboxes, search for and
|
||||||
|
list mails and mail-threads and reply to mails (by spawning the `$EDITOR`).
|
||||||
|
|
||||||
Outgoing mails are pushed to a special directory and can later on be send via `imag-mail` which calls a MTA (for example msmtp) and also creates store entries for the outgoing mails.
|
Outgoing mails are pushed to a special directory and can later on be send via
|
||||||
|
`imag-mail` which calls a MTA (for example msmtp) and also creates store entries
|
||||||
|
for the outgoing mails.
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,10 @@
|
||||||
## Timetrack {#sec:modules:timetrack}
|
## Timetrack {#sec:modules:timetrack}
|
||||||
|
|
||||||
The Timetrack module implements a `timewarrior`-like timetracking functionality for imag.
|
The Timetrack module implements a `timewarrior`-like timetracking functionality
|
||||||
|
for imag.
|
||||||
|
|
||||||
Each timetracking is a 'tag' which can be started and stopped. These tags are _no_ tags as in imag-tag, but timetracking-tags.
|
Each timetracking is a 'tag' which can be started and stopped. These tags are
|
||||||
|
_no_ tags as in imag-tag, but timetracking-tags.
|
||||||
|
|
||||||
Summaries can be printed, also filtered by tags if desired.
|
Summaries can be printed, also filtered by tags if desired.
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
## Todo {#sec:modules:todo}
|
## Todo {#sec:modules:todo}
|
||||||
|
|
||||||
The Todo module implements `taskwarrior` functionality by integrating taskwarrior itself into imag.
|
The Todo module implements `taskwarrior` functionality by integrating
|
||||||
|
taskwarrior itself into imag.
|
||||||
|
|
||||||
Each taskwarrior task s referenced from imag and represented as imag entry, thus making it linkable by other imag entries.
|
Each taskwarrior task s referenced from imag and represented as imag entry, thus
|
||||||
|
making it linkable by other imag entries.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,9 +1,14 @@
|
||||||
## libimagmails
|
## libimagmails
|
||||||
|
|
||||||
The mail library implements everything that is needed for beeing used to implement a mail reader (MUA).
|
The mail library implements everything that is needed for beeing used to
|
||||||
|
implement a mail reader (MUA).
|
||||||
|
|
||||||
It therefor providea reading mailboxes, getting related content or mails, saving attachements to external locations, crafting new mails and responses,...
|
It therefor providea reading mailboxes, getting related content or mails, saving
|
||||||
|
attachements to external locations, crafting new mails and responses,...
|
||||||
|
|
||||||
It also offers, natively, ways to search for mails (which are represented as imag entries) via tags, categories or even other metadata.
|
It also offers, natively, ways to search for mails (which are represented as
|
||||||
|
imag entries) via tags, categories or even other metadata.
|
||||||
|
|
||||||
|
For more information on the domain of the `imag-mail` command, look at the
|
||||||
|
documentation of the @sec:modules:mails module.
|
||||||
|
|
||||||
For more information on the domain of the `imag-mail` command, look at the documentation of the @sec:modules:mails module.
|
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
|
|
||||||
The library for the todo module.
|
The library for the todo module.
|
||||||
|
|
||||||
Whether this wraps `taskwarrior` or implements a todo tracking mechanism in imag itself is to be defined. Probably the latter.
|
Whether this wraps `taskwarrior` or implements a todo tracking mechanism in imag
|
||||||
|
itself is to be defined. Probably the latter.
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue