Difference between revisions of "Zim"

From ArchWiki
Jump to: navigation, search
(Plugins)
(various fixes)
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Text editors (English)]]
+
[[Category:Text editors]]
{{i18n|Zim}}
+
 
{{Article summary start}}
 
{{Article summary start}}
 
{{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.
 
''"[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.
 
  
 
==Features==
 
==Features==
Line 17: Line 14:
  
 
==Installation==
 
==Installation==
 
+
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.  
Zim can be found in the community repository.
+
 
+
# pacman -S zim
+
 
+
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==
Line 30: Line 22:
 
==Configuration==
 
==Configuration==
  
The main configuration file is located in Zim's config directory: {{Filename|~/.config/zim/preferences.conf}}. Another important file is located in the same directory: {{Filename|~/.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.  
Line 43: Line 35:
  
 
====Spell Checker====
 
====Spell Checker====
The requirements for the Spell Checker plugin are as follows:  
+
The requirements for the Spell Checker plugin are as follows: {{pkg|gtkspell}}, {{pkg|python2-gtkspell}} and {{pkg|aspell-en}}.
 
+
$ pacman -S gtkspell python2-gtkspell aspell-en
+
  
Change {{filename|aspell-en}} to your desired language support. Now you can configure the Spell Checker and define the default language, in my case {{filename|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==
Line 57: Line 47:
 
  UnboundLocalError: local variable 'i' referenced before assignment
 
  UnboundLocalError: local variable 'i' referenced before assignment
  
It is often related to a problem with the file path of the wikis stored in {{Filename|~/.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 {{Filename|/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 [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.  
  
==Resources==
+
==See also==
  
 
'''Official'''
 
'''Official'''

Revision as of 16:51, 4 November 2012

Template:Article summary start Template:Article summary text Template:Article summary end "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

  • 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-bzr 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.

Zim 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 *:

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 *. 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

Official

Tutorials