Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: Fri, 13 Mar 2009 22:50:21 +0100

====== Usage ======

**Zim** can be used in several different ways. In this section we would like to give some examples of possible usage patterns, but this is in no way an exhaustive list. Also these styles could be combined in a single notebook, e.g. one could dedicate a notebook to a particular project and combine the organizer and journal styles in using it. However it is better the have several specialized notebooks than one big dump of unrelated material.

See also [[+Getting Started|Getting Started]]


===== Topic based notebook =====
This is the simplest use pattern where a notebook simply contains a collection of notes on various topics. Each topic can have it's own page or can be spread over several sub-pages when it is subdivided in multiple sections. This is for example the way a student taking class notes would work.

Topics can be organized on forehand, like in the case of a student taking class notes, or can emerge over time. An example of the later case is a notebook used to jot down brainstorm ideas, which are unorganized at first and may go into one big page, but afterwards are divided over various pages and categorized.


===== Organizer =====
When a zim notebook is used as an organizer typically it will contain a collection of notes on various ongoing projects, task lists etc.

For this use one would typically enable the Task List plugin and set it to show all open checkboxes throughout the notebook. Now on each page one can define tasks and action items and the Task List dialog will give a overview of all open items.

The Calendar plugin can also be used for an organizer. It is not really intended as a planner, but can be very useful to keep notes by date, e.g. meeting minutes etc. In combination with the Task List plugin one can write down his action items as checkbox items during the meeting by date and have them show up in the Task List.

See also [[+Getting Things Done|Getting Things Done]]


===== Document Editor =====
TODO general description

For this use the Task List plugin can be used to flag places in the document that are not yet finished or need more attention. Typically one would configure the Task List to use labels, with that usages one can have inline comments in the document using the tags "TODO" and "FIXME". The Task List dialog then gives a list of places where one needs to come back later.

If the same notebook contains both notes on the document and the polished text it is useful to be able to only export the polished text without the notes. In order to this one can either separate notes and final text in different namespaces or one can create an "index" page listing links to all the pages that are part of the final document. That way one can make the selection in the export dialog to only export the relevant sections.

MISSING: export many pages to single document
MISSING: selection in export dialog based on index page as describe above
MISSING: custom ordering in a namespace


===== Journal =====
A journal style notebook would rely heavily on the calendar plugin to keep track of notes by date. This style can be used e.g. to keep a diary or as a laboratory journal documenting progress by day.

This style can be mixed with notes per topics, using the calendar pages as a kind of inbox for raw notes keeping track of the what happened while using pages per topic to organize and distill conclusions or to write down procedures to be followed etc.

See also: [[+Daily Journal|Daily Journal]]


===== Collection Manager =====
In this style the notebook is used as a database of for example books, movies, stamps, etc. One dedicates one page to each item in the collection and puts all info about the item in there.

In this style notebook the Task List and Calendar plugins are probably not used.


===== Sharing a notebook with multiple users =====
TODO: talk about version control

