Difference between revisions of "Zim"

From ArchWiki
Jump to: navigation, search
(various fixes)
m (Style)
Line 3: Line 3:
 
{{Article summary text|Zim is a notepad like desktop application that is inspired by the way people use wikis.}}
 
{{Article summary text|Zim is a notepad like desktop application that is inspired by the way people use wikis.}}
 
{{Article summary end}}
 
{{Article summary end}}
''"[http://zim-wiki.org/ Zim] is a graphical text editor used to maintain a collection of wiki pages. Each page can contain links to other pages, simple formatting and images. Pages are stored in a folder structure, like in an outliner, and can have attachments. Creating a new page is as easy as linking to a nonexistent page. All data is stored in plain text files with wiki formatting. Various plugins provide additional functionality, like a task list manager, an equation editor, a tray icon, and support for version control.
+
From the project [http://zim-wiki.org/ home page]:
 +
: '' Zim is a graphical text editor used to maintain a collection of wiki pages. Each page can contain links to other pages, simple formatting and images. Pages are stored in a folder structure, like in an outliner, and can have attachments. Creating a new page is as easy as linking to a nonexistent page. All data is stored in plain text files with wiki formatting. Various plugins provide additional functionality, like a task list manager, an equation editor, a tray icon, and support for version control.''
  
==Features==
+
: ''Zim can be used to:''
 +
::* ''Keep an archive of notes''
 +
::* ''Take notes during meetings or lectures''
 +
::* ''Organize task lists''
 +
::* ''Draft blog entries and emails''
 +
::* ''Do brainstorming''
  
* Keep an archive of notes
+
== Installation ==
* Take notes during meetings or lectures
+
* Organize task lists
+
* Draft blog entries and emails
+
* Do brainstorming
+
  
==Installation==
+
You can install {{Pkg|zim}} from the [[official repositories]]. There is also an AUR package called {{AUR|zim-bzr}} which provides the latest developer snapshot.
You can install {{pkg|zim}} from the [[Official Repositories]]. There is also an AUR package called [https://aur.archlinux.org/packages.php?ID=46486 zim-bzr] which provides the latest developer snapshot.  
+
  
==Usage==
+
== Usage ==
  
The usage of Zim is very self-explanatory. This [http://www.youtube.com/watch?v=yBZpWgzO9Ps screencast] provides a good overview about the basic functionality.  
+
The usage of Zim is very self-explanatory. This [http://www.youtube.com/watch?v=yBZpWgzO9Ps screencast] provides a good overview about the basic functionality.
  
==Configuration==
+
== Configuration ==
  
The main configuration file is located in Zim's config directory: {{ic|~/.config/zim/preferences.conf}}. Another important file is located in the same directory: {{ic|~/.config/zim/notebooks.list}}. This file contains a list of all wikis and there file path.  
+
The main configuration file is located in Zim's config directory: {{ic|~/.config/zim/preferences.conf}}. Another important file is located in the same directory: {{ic|~/.config/zim/notebooks.list}}. This file contains a list of all wikis and there file path.
  
Besides the configuration there exist the wiki directories which are set up when a new wikis are created. Those folders store all wiki pages in plain txt format.  
+
Besides the configuration there exist the wiki directories which are set up when a new wikis are created. Those folders store all wiki pages in plain txt format.
  
==Zim Tips==
+
== Tips ==
  
 
Specific user tricks to accomplish tasks.
 
Specific user tricks to accomplish tasks.
  
===Plugins===
+
=== Plugins ===
  
Zim provides a lot of useful plugins where many of them are not enabled by default. They can be found at Edit -> Preferences -> Plugins. That is, there is a plugin which provides a tray icon.
+
Zim provides a lot of useful plugins where many of them are not enabled by default. They can be found at ''Edit > Preferences > Plugins''. That is, there is a plugin which provides a tray icon.
 +
 
 +
==== Spell checker ====
  
====Spell Checker====
 
 
The requirements for the Spell Checker plugin are as follows: {{pkg|gtkspell}}, {{pkg|python2-gtkspell}} and {{pkg|aspell-en}}.
 
The requirements for the Spell Checker plugin are as follows: {{pkg|gtkspell}}, {{pkg|python2-gtkspell}} and {{pkg|aspell-en}}.
  
 
Change {{ic|aspell-en}} to your desired language support. Now you can configure the Spell Checker and define the default language, in my case {{ic|en_GB}}.
 
Change {{ic|aspell-en}} to your desired language support. Now you can configure the Spell Checker and define the default language, in my case {{ic|en_GB}}.
  
==Troubleshooting==
+
== Troubleshooting ==
  
===Problems at launch===
+
=== Problems at launch ===
  
A common error is at start up resulting in a error message like the following [https://bbs.archlinux.org/viewtopic.php?id=120139 *]:
+
A common error is at start up resulting in a error message like the following [https://bbs.archlinux.org/viewtopic.php?id=120139 this thread]:
  
 
  UnboundLocalError: local variable 'i' referenced before assignment
 
  UnboundLocalError: local variable 'i' referenced before assignment
Line 49: Line 51:
 
It is often related to a problem with the file path of the wikis stored in {{ic|~/.config/zim/notebooks.list}}. Try to delete or move this file and restart Zim.
 
It is often related to a problem with the file path of the wikis stored in {{ic|~/.config/zim/notebooks.list}}. Try to delete or move this file and restart Zim.
  
===Error: Unable to find or create trash directory===
+
=== Error: Unable to find or create trash directory ===
  
This error message indicates that Zim is not able to find the trash directory [https://bbs.archlinux.org/viewtopic.php?id=126413 *]. This occurs when the wiki is stored on a partition that does not have any trash directory under {{ic|/partition/.local/share/Trash}}. Due to that one is not able to delete pages as Zim tries to move them to the trash. Solutions are either the creation of a trash directory or the installation of the developer snapshot instead of the stable version which permanently deletes a page if no trash directory can be found. Thus, the user does not receive this error message anymore.  
+
This error message indicates that Zim is not able to find the trash directory as in [https://bbs.archlinux.org/viewtopic.php?id=126413 this thread]. This occurs when the wiki is stored on a partition that does not have any trash directory under {{ic|/partition/.local/share/Trash}}. Due to that one is not able to delete pages as Zim tries to move them to the trash. Solutions are either the creation of a trash directory or the installation of the developer snapshot instead of the stable version which permanently deletes a page if no trash directory can be found. Thus, the user does not receive this error message anymore.
  
==See also==
+
== See also ==
 
+
'''Official'''
+
  
 
* [http://www.zim-wiki.org/ Zim homepage]
 
* [http://www.zim-wiki.org/ Zim homepage]
 
* [http://zim-wiki.org/manual/Start.html Zim official manual]
 
* [http://zim-wiki.org/manual/Start.html Zim official manual]
 
'''Tutorials'''
 
 
 
* [http://www.youtube.com/watch?v=yBZpWgzO9Ps A short screencast]
 
* [http://www.youtube.com/watch?v=yBZpWgzO9Ps A short screencast]

Revision as of 09:03, 6 July 2013

Template:Article summary start Template:Article summary text Template:Article summary end From the project home page:

Zim is a graphical text editor used to maintain a collection of wiki pages. Each page can contain links to other pages, simple formatting and images. Pages are stored in a folder structure, like in an outliner, and can have attachments. Creating a new page is as easy as linking to a nonexistent page. All data is stored in plain text files with wiki formatting. Various plugins provide additional functionality, like a task list manager, an equation editor, a tray icon, and support for version control.
Zim can be used to:
  • Keep an archive of notes
  • Take notes during meetings or lectures
  • Organize task lists
  • Draft blog entries and emails
  • Do brainstorming

Installation

You can install zim from the official repositories. There is also an AUR package called zim-bzrAUR which provides the latest developer snapshot.

Usage

The usage of Zim is very self-explanatory. This screencast provides a good overview about the basic functionality.

Configuration

The main configuration file is located in Zim's config directory: ~/.config/zim/preferences.conf. Another important file is located in the same directory: ~/.config/zim/notebooks.list. This file contains a list of all wikis and there file path.

Besides the configuration there exist the wiki directories which are set up when a new wikis are created. Those folders store all wiki pages in plain txt format.

Tips

Specific user tricks to accomplish tasks.

Plugins

Zim provides a lot of useful plugins where many of them are not enabled by default. They can be found at Edit > Preferences > Plugins. That is, there is a plugin which provides a tray icon.

Spell checker

The requirements for the Spell Checker plugin are as follows: gtkspell, python2-gtkspell and aspell-en.

Change aspell-en to your desired language support. Now you can configure the Spell Checker and define the default language, in my case en_GB.

Troubleshooting

Problems at launch

A common error is at start up resulting in a error message like the following this thread:

UnboundLocalError: local variable 'i' referenced before assignment

It is often related to a problem with the file path of the wikis stored in ~/.config/zim/notebooks.list. Try to delete or move this file and restart Zim.

Error: Unable to find or create trash directory

This error message indicates that Zim is not able to find the trash directory as in this thread. This occurs when the wiki is stored on a partition that does not have any trash directory under /partition/.local/share/Trash. Due to that one is not able to delete pages as Zim tries to move them to the trash. Solutions are either the creation of a trash directory or the installation of the developer snapshot instead of the stable version which permanently deletes a page if no trash directory can be found. Thus, the user does not receive this error message anymore.

See also