Update intro
This commit is contained in:
parent
6e45727f15
commit
869f5377f9
2 changed files with 28 additions and 15 deletions
|
@ -1,17 +1,16 @@
|
|||
# Introduction {#sec:introduction}
|
||||
|
||||
This document is the user documentation for imag, the personal
|
||||
information management suite for the commandline. Besides being a documentation,
|
||||
it serves also as "roadmap" where this project should go.
|
||||
information management suite for the commandline.
|
||||
|
||||
**Basically: This is Hobby stuff. Expect incompleteness, false statements and
|
||||
generally read with big grain of salt.**
|
||||
generally read with grain of salt.**
|
||||
|
||||
If you have any objections, suggestions for improvements, bugs, etc, please file
|
||||
them.
|
||||
them (See [@sec:contributing]).
|
||||
A way to reach out to the imag project maintainer(s) is described in the
|
||||
CONTRIBUTING file of the repository or in this document, in the appropriate
|
||||
section.
|
||||
[@sec:contributing] section.
|
||||
|
||||
|
||||
## The Problem {#sec:intro:problem}
|
||||
|
||||
|
@ -19,20 +18,21 @@ The problem this project tries to solve is to provide a modular commandline
|
|||
application for personal information management.
|
||||
|
||||
It targets "power users" or "commandline users", uses plain text as a storage
|
||||
format and tries to be scriptable.
|
||||
format and tries to be as scriptable as possible.
|
||||
imag offers the ability to link data from different "PIM aspects" (such as
|
||||
"diary" and "bookmark" for example).
|
||||
"diary", "contacts" and "bookmark" for example).
|
||||
|
||||
One major goal of imag is to make the PIM data traverseable and queryable.
|
||||
For example: a wiki article can be linked to an appointment which is linked to a
|
||||
todo which is linked to a note which is linked to a contact.
|
||||
|
||||
imag wants to offer an all-in-one scriptable modular commandline personal
|
||||
information management suite for all PIM aspects one can think of.
|
||||
information management suite for all PIM aspects one could possibly think of.
|
||||
Because imag uses plain text (TOML headers for structured data and plain text
|
||||
which can be rendered using markdown, for example, for continuous text)
|
||||
the user is always able to access their data without the imag tools at hand.
|
||||
|
||||
|
||||
## The Approach {#sec:intro:approach}
|
||||
|
||||
The approach "imag" takes on solving this problem is to store content in a
|
||||
|
@ -42,8 +42,8 @@ structured data.
|
|||
This can be used to implement a variety of "domain modules" using the store.
|
||||
While content is stored in _one_ place, imag does not duplicate content.
|
||||
imag does not copy or move icalendar files, emails, vcard files, music or
|
||||
movies to the store, but creates references to the actual files and stores
|
||||
meta-information in the store.
|
||||
movies to the store, but tries to remember the actual files are and stores
|
||||
meta-information about them in the store.
|
||||
|
||||
Detailed explanation on this approach follows in the chapters of this work.
|
||||
|
||||
|
@ -57,7 +57,7 @@ library of the imag distribution to store content in the store of imag and
|
|||
make it visible to imag this way.
|
||||
|
||||
This is a technical detail a user does not necessarily need to know, but as imag
|
||||
is intended for power-users anyways, we could say it fits here.
|
||||
is intended for power-users anyways, we would say it fits here.
|
||||
|
||||
## Alternative Projects {#sec:intro:alternatives}
|
||||
|
||||
|
@ -68,6 +68,19 @@ for the [emacs](https://www.gnu.org/software/emacs/) text editor.
|
|||
There is also [zim](http://zim-wiki.org/), a desktop wiki editor which is
|
||||
intended to be used for a personal wiki.
|
||||
|
||||
The difference between imag and the mentioned projects is that imag is not there
|
||||
yet. Some parts can be used, though it is far away from being feature-complete.
|
||||
The difference between imag and the mentioned projects is:
|
||||
* emacs orgmode is (from what I know and see) for _orgabizing_ things. imag is
|
||||
intended not only for organizing, but also for recording, tracking and
|
||||
querying.
|
||||
* zim is a wiki, which could be used for PIM but is not specialized for it.
|
||||
Recording habits might be possible, but not that simple as with imag
|
||||
|
||||
imag is not there
|
||||
yet, though. Some parts can be used, though it is far away from being feature-complete.
|
||||
|
||||
In addition: imag is text-editor independent and other tools than imag might be
|
||||
used to access data stored in the imag store.
|
||||
For example, one could "grep", "awk" and "sed" entries without much hassle and
|
||||
even write bash scripts for automatically filling imag entries with data.
|
||||
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Contributing to imag
|
||||
# Contributing to imag {#sec:contributing}
|
||||
|
||||
So you want to contribute to imag! Thank you, that's awesome!
|
||||
|
||||
|
|
Loading…
Reference in a new issue