Zim - A Desktop Wiki
Zim's default installation ships with a Version Control Plugin. To enable it, go to
Dependencies: This plugin requires one of the supported version control systems to be installed. Currently Bazaar, Git and Mercurial are supported, so one of these applications is required. In specific the "
If the option Autosave version on regular intervals is enabled zim will save (or "commit") a new version every time you close zim or when opening zim if new changes are detected.
If you want to keep track of your changes or if you want to collaborate on a Zim notebook as a team, version control is the best way to go. Zim integrates very well with existing version control software because all relevant data is stored in plain text files.
To save the current state of the Notebook, choose
You can browse the complete history of saved versions by selecting
TODO here should be documented how to share the newly created repository with your collaborators... (Depends on the backend chosen)
See the Bazaar user manual for various scenarios of collaboration (follow the "documentation" link on their website).
Technically speaking a local repository is created when enabling Version Control, depending on the backend you choose, this repository is managed by Bazaar, Git, or Mercurial. Every time you save a version, another revision is checked in. Zim just uses standard version control systems as backend, so you can always view and export your history using standard tools.
On startup zim tries to detect the version control system used for a specific notebook, and use it if supported. So you can manually initialize repository (e.g. by branching) and then open them with zim. No need to tell Zim that the notebook is managed explicitly.
Manual Version Control
This is for advanced users that have to use another Version Control System or have other reasons not to use the included plugin.
To manually manage revisions of your notebook, the following files should be added to your repository:
All files created by Zim are in plain text format and only change when you explicitly change them so you should get readable, reasonable diffs and merges in case of conflicts.
You can and should ignore the following items however:
The files in the "
If you want for some reason stop using version control and throw away all history, you can do the following:
This website was written in Zim !