a_better_link_to_dialog

2010-07-07T11:45:13+02:00

Proposal This is a proposal to rework the add link dialog to allow more efficient insertion of links by allowing a completely keyboard based usage (but mouse based is still possible too), as well as offering search and suggestions. Comments, ideas, criticism, improvements, alternatives and auggestions are highly appreciated. --- Johannes Reinhardt 2010/07/04 12:58

add_a_mindmap_view

2010-02-24T21:43:30+02:00

Two cases: * Have a mindmap view showing the current page and its “surroundings” - partially implemented since version 0.42 * Have a mindmap view that can be edited interactively creating new topics, which can be turned into pages Related bugs *

add_structured_forms

2011-08-04T20:11:15+02:00

For usage where zim is used like a mini “database” to store data on very similar objects it would be useful to have a “form” on top of the page supporting standard fields for the object type. E.g. for a namesapce “Books” each sub page could have a field for “Title” and a field for “Author”. The “Author” field could in turn link to a page in the “Authors” namespace. The rest of the page would be a free form “Comment” field allowing to add random comments about this books.…

bookmarks

2012-02-03T11:21:09+02:00

This plugin targets fast access to 10 configurable bookmarks. Configuration takes place in the plugin itself, so user has to copy a present location of a page and paste it in the configuration to a corresponding bookmark number. These bookmarks are accessible from a menu “Go” and by key-bindings (Alt+[0-9]).

bug_classification

2011-01-18T20:29:06+02:00

In order to manage the large number of open requests in the tracker we use a number of tags: Papercut bugs are small bugs that can be easily fixed but may be very irritating for the end user or have high visibility in the interface. Bugs tagged with missing are features that can be considered missing for a “finished” release. These need to be worked on in order to get closer to the mythical version 1.0.

copy_to_clipboard_as_plain_text_with_markup_not_rich_text

2011-05-31T23:15:43+02:00

Submitted by Brendan Kidwell This recipe works on a Linux machine. YMMV. You need awk, sed, and xclip. I use this as a quick and dirty (but readable) way copy my daily diary pages into a shared wiki in the office whose rich text editor doesn't handle rich text so well.

couchdb_backend

2010-02-24T22:14:08+02:00

CouchDB is intended to store and synchronize data on a per document base. This is a good match for storing a desktop wiki and it's attachments and automatically sync between several machines. Relatively simple task, but depends heavily on Support Resolving Conflicts

create_tables_using_graphviz

2010-12-07T23:21:38+02:00

While we're waiting and hoping for someone to add table support to Zim :^) here's a quick and dirty workaround. Requirements * Graphviz installed in your system * Zim “Insert Diagram” plugin enabled * Basic knowledge of HTML Procedure * Position the cursor where you would like to create a table. * Insert → Diagram * Paste in the following template: digraph structs { node [shape=plaintext] struct1 [label=<

create_tables_using_latex

2011-04-02T23:00:07+02:00

While we're waiting and hoping for someone to add table support to Zim :^) here's a quick and dirty workaround. Requirements * Latex and dvipng installed in your system * Zim “Insert Equation” plugin enabled * Basic knowledge of Latex Procedure * Position the cursor where you would like to create a table. * Insert → Equation * Paste in the following template: \begin{tabular}{|ll|} \hline a & b\\ c & d\\ \hline \end{tabular}

creating_a_todo_item

2010-07-27T18:52:13+02:00

How to create a TODO item (task) Open task with no due date [ ] Answer the mail Open task with priority of 3 [ ] Answer the mail !!! Open task with a due date [ ] [d:25.4.] Answer the mail Open task with a due date and some tags Tags are shown in Tasks dialog

creating_an_android_application

2011-06-18T18:40:19+02:00

Bounty There is a bounty of 100 Euro on this feature. Please contact me if you would like to work on this to discuss the details. Requirements * The app should allow file syncing with the standard zim application * The app should allow browsing the notebook structure similar as in the standard application * Supply an index to find pages by name * Allow following links

custom_sorting_of_the_index

2010-06-09T17:11:19+02:00

Allow non-alphabetical order in side pane. See bug report for discussion and usage example. Additional use case comes from trying to use zim to write a larger document. Need to be able to re-order structure of the document without work around like having each page name start with a number and re-number manually.

custom_tools

2011-12-16T15:25:35+02:00

from the Help: “Zim allows you to define custom tools to extend the basic functionality with simple functions that can be handled by an external program or script. The custom tool manager allows you to quickly extend functionality in zim by shell scripts or other external programs.”

development_planning

2012-03-15T05:59:44+02:00

This page should contain an overview of who is working on what. Implementation drafts, describing the “how”, can be put into pages below this one. PLEASE DO NOT FILE NEW REQUESTS HERE - GO TO THE BUG TRACKER FIRST Trunk Who: Jaap

directory_documentation

2010-10-29T14:24:03+02:00

Document all your digital life in Zim (for the latest version & more information see the project page at http://www.inrim.it/~magni/zimDMS.htm ) Since a lot of time I've been searching for a system able to document all my digital data in a wiki-like way. The purpose being to allow me to orient myself in a huge and ever increasing data structure, where I keep all my digital life.

editable_secondary_windows

2010-07-20T13:51:12+02:00

Having secondary windows (as opened by the “open in new window” menu item) that are actually editable would be really valuable. Details Depends on Refactor interface object tree * Need to refactor part of the UI code to handle multiple open text buffers * Various actions need to be able to act on the right page depending on the window in focus * If both windows show the same page they need to share a TextBuffer - set property on Page object

embedding_custom_objects

2011-02-25T13:25:33+02:00

I have managed to create functional prototype of embedding custom objects into TextView. The related branch is lp:~janousek.jiri/zim/custom-objects Wiki syntax Example 1: tables {{{Table: | foo | bar | baz | | foo | bar | baz | }}} Example 2: source code snippets

escaping_wiki_syntax

2010-07-06T20:59:05+02:00

Problem description When a user is unaware of wiki syntax, re-formatting the page on reload can have unexpected results. Even though all the text is still in the source file, from the point of view of the editor this can be loss of data if the characters were meaningful (e.g. code snippets). Therefore it should be possible to input arbitrary characters in the editor without having them reformatted as wiki syntax.

extra_plugins

2012-05-05T14:40:31+02:00

On this page are extra plugins, which can extend ZIM in various directions. The plugins have to be downloaded and copied to a directory called “plugins” located in installed directory. windows: C:\Program Files\Zim Desktop Wiki\plugins linux: (from a source)

extra_templates

2011-11-14T11:05:40+02:00

This page is intended to hold additional templates for exporting zim notebooks. See the manual for information on the structure of templates, you can find it here: If you want to contribute a template, please attach it here in the wiki and copy the description below to describe your template.

fix_indenting_vs_list_indenting_tags

2010-12-28T14:18:36+02:00

Separate normal indent tag from list indent tag. Will fix multiple related bugs + makes list control more convenient. Separate a tag per bullet type, so we can make formatting of the line dependent on the bullet type, e.g. gray text for checked off checkbox items.

how_to_share_and_sync_notebooks_between_computers

2010-03-14T23:29:47+02:00

How does it work There are programs and services which copy your data from your computer to the web storage and back. You select a data folder and run a daemon in the background. Your data will be copied to the cloud and synchronized all the time. You can read them and update from another computer. That's the way you can share you Zim notebooks between your desktop, notebook and/or netbook. Every time up to date, no flash discs or manual operation needed.

how_to_start_zim_as_icon_in_the_system_tray

2010-04-10T18:12:19+02:00

This is currently not implemented in the python version of zim. But there are workarounds for KDE and GNOME. See To automatically start zim iconified on startup, make sure that * the tray icon plugin is active * the wmctrl command is available

implement_a_toc

2010-02-25T11:48:45+02:00

For larger pages with multiple (sub) headings it makes sense to have a table of contents showing the structure within the page and allowing to jump to a specific heading. TODO * Implement a way to link a specific heading (e.g. anchors) * Implement a widget to show the index of headings * E.g. above page index in side pane, or floating on top of the textbuffer

implement_a_trash_bin

2011-04-14T14:32:55+02:00

Make delete a bit more forgiving. Don't ask for confirmation on delete. Have additional “restore” and “empty thrash” actions. Or maybe a sort of “Archive” functionality that takes notes out of the way, but has them accessible somewhere.

improve_export_function

2010-07-20T11:34:38+02:00

Planned * Refactor export dialog into wizard * Allow selecting multiple pages by search query * Allow export to a single page Optional / later * Export to Latex (for 0.45) * Export to OpenOffice document Related Bugs *

insert_image_from_clipboard

2011-02-28T22:22:17+02:00

Since version 0.50 zim supports the copy and pasting of images. Therefore this custom tool is no longer needed. ---------- Writes an image from the clipboard (e.g. a selection from your preferred pdf viewer) to the attachment directory and inserts it into the current page.

insert_snippet

2012-02-03T01:01:44+02:00

Insert snippet Reusing pages as text templates. This plugin adds a new menu entry “Insert/Text from page...” to enter some page's path to be inserted into the current page. Try it: (both links are broken) * source * french translation

manual_updates

2010-02-24T20:35:31+02:00

This page is intended to post updates that should go into the zim manual. Either make a sub-page per topic or a heading below. ...

performance_improvements

2010-04-19T17:37:22+02:00

Need to speed up zim a bit and make the UI more snappy. * Add callbacks and progress bars for e.g. moving pages, updating links etc. * Hide mainwindow on close before waiting for version cntrol sync etc. * Feedback + stop button while searching * Look into using threading to handle background jobs * Updating the index * Version Control actions * Saving state config files * Auto saving pages

refactor_interface_object_tree

2010-07-28T18:58:48+02:00

Refactoring is needed to allow secondairy editable windows. * Get rid of hard coded links to main window where possible * Add a hook to decorate windows from plugins * Window constructor should request ui actions from the embedded objects and add them instead of objects registering themselves (put responsibility in the factory, not in the components)

refactor_parse_tree

2010-09-12T21:25:36+02:00

Goal: * Get rid of “tail” logic used in etree - separate nodes in the tree for text in between tags * Simplify parse tree manipulation - combine find by element name with linked list to walk through a document * Refine logic with respect to whitespace - DWIM for space and newlines in between headings and paragraphs * Always use paragraph elements * Get rid of on-the-fly reformatting done when getting a tree from the page view - first build the tree, then make it nice (using functions …

refactor_ui_builder_class

2010-12-18T10:30:19+02:00

zim.ui.widgets.Dialog contains code to build forms, also zim.ui.widgets contains some wrapper for creating other widgets. These should be turned into proper Builder or Factory classes (check patterns book for correct jargon). Now the new export dialog contains redundant code from the Dialog class that could use such a common Builder class.

resolving_syncing_conflicts

2012-03-01T21:41:01+02:00

The main bottleneck in implementing synchronization and multi-user use of zim is the lack of a way to resolve version conflicts. E.g. when two users update the same page at the same time there should be a way to resolve that. The implementation model for this is how CouchDB handles it. Just store both versions and flag it as a conflict. Then let the user resolve the conflict. Of course in combination with version control sometimes updates can be merged, but if updates really touch the same para…

run_remotely

2010-04-15T00:55:14+02:00

Suppose you have a main Linux desktop computer on your desk in your office/lab, and you have a laptop you carry around with you and/or a desktop at home. If you don't want to sync, you can just work from one central file storage location. First, make sure you have openssh-server and zim installed on the remote host. To avoid password prompts, create a an SSH key pair on the local host (from inside a terminal window):

script_to_convert_moinmoin_pages_to_zim

2011-02-15T07:08:40+02:00

Convert a moinmoin wiki to Zim As mentioned in the comment of the script, this is a modification of Slim Gaillards moin2doku.py. I've removed some bugs, added the creation of a page header with correct timestamp and modified the formatting regexs. The file attachment conversion isn't removed, but it is neither tested nor adapted to ZIM. Feel free to make modifications or fixes. Just add than to this page.

script_to_convert_notecase_notes

2011-08-29T21:30:18+02:00

#!/usr/bin/python # Simple script to convert NoteCase Document to a Zim notebook folder # # NoteCase reference: # http://notecase.sourceforge.net/ (Free version, discontinued) # http://www.virtual-sky.com/ (Pro version) # # Based on BeautifulSoup (you need to install it before running notecase2zim): # http://www.crummy.com/software/BeautifulSoup/ # # Adapted to my use of NoteCase and Zim => other may want to adapt it # For instance: # Color "red" in NoteCase => I use "italic" in…

script_to_convert_softnote_notes

2011-02-14T21:19:36+02:00

The following script can be used to convert XML exported from softnote into a zim notebook. It does not support all special characters in the RTF data generated by softnote, so some manual editing of the XML may be required for the script to run successfully.

script_to_integrate_zim_with_unity

2011-10-05T00:53:08+02:00

The following script can be executed at system startup (or anytime) and will create a desktop file with all your Zim notebooks and the function to add a quick note, or paste the clipboard as a quick note instantly. This is the script, requires bash and awk (you probably have them already), and xsel for the clipboard functions (it will be automatically removed it you lack xsel). This script is also compatible with KDE's icontasks plasmoid.

script_to_remove_manual_line_breaks_when_pasting_simple_text_emails_in_zim

2011-04-12T05:01:44+02:00

Created by nomnex Case: How to remove the manual line breaks of simple text emails (e.g. Newsgroups, private msg., etc.) you past in Zim. * Download and put the script in your ”/home/user/bin” directory or wherever you like * Make it executable. * Go into Zim Tools --> Custom Tools, and add the script with the ”%f” commandline argument.

side_notes_for_pages

2010-07-07T14:13:35+02:00

This idea is based on the interface used by Scrivener. In Scrivener the main text area of the page is used to write a story / paper / ... Any research notes, todos etc. are not part of the main text bu rather displayed as note cards in a right hand side pane. This has the advantage of separating them from the main flow of the text.

special_new_note_dialog_for_trayicon

2010-07-06T22:47:14+02:00

Dialog has been implemented, can be started with “zim --plugin dropwindow” TODO: * Add in trayicon menu * Add template (e.g. timestamp etc) * Firefox plugin to call this dialog -- in progress -- see * Allow append to page instead of create new page

start

2011-09-02T21:23:15+02:00

:!: This wiki is about zim, it is not a zim wiki itself. :!: Do NOT use this wiki to ask questions, we have a mailing list for that This wiki is intended as a whiteboard for brainstorming about zim, draft new features, and share some documentation work.

support_embedded_gtksourceview

2010-02-24T22:00:55+02:00

When zim is used to store snippets of source code, scripts etc. it would be good to show these with proper syntax highlighting. Since this is not really possible in the zim text buffer itself we can only do this by embedding a gtksourceview into the buffer as a separate object.

support_markdown_syntax

2010-02-24T22:12:13+02:00

Related Bugs *

support_restructuredtext_syntax

2010-02-24T22:13:04+02:00

Related bugs *

support_tables

2011-11-28T17:19:21+02:00

Main missing feature in zim in terms of data organization is support for tables in pages. See notes in HACKING notebook for implementation details being considered. Proposed Specification This is my suggestion for implementing this. See also the bounty that I have put up for this. -- Mike Mulqueen

support_transclusion

2010-02-24T21:58:29+02:00

Allow embedded views that show an external document. Bonus for also updating when the external document is changed. This can be used to e.g. embed the tail of a log file into a zim page or show system scripts inline. Useful extension of use cases supported by Supporting an Embedded GtkSourceView

support_wikicreole_syntax

2010-02-24T22:02:38+02:00

Related Bugs *

supporting_tags

2011-03-17T14:16:08+02:00

Goal is to allow a different non-hierarchical view on the data. Tags will look the same like tags used in the task manager, e.g. ”@foo” will add the tag “foo” to the text where it appears. Tags will be inline in the text, so they are included when you cut-paste a section of text to another page etc. Most functionality will be from having an alternative side pane view showing the pages sorted by tag.

task_list_improvements

2011-08-26T13:16:16+02:00

Ideally the task list should become more flexible to give various views and be configurable to how people want to use it. Bit more support for actionable tasks versus waiting and projects would be good for GTD support. Current plan: * Improve startup time and remove need for “refresh” by caching tasks in the index database * Bring back support for TODO and FIXME tags

task_list_with_dependencies

2011-08-26T13:47:20+02:00

This page is related to and extends it with a usecase description and implementation suggestions. 2011-04-15: I found a similar approach in org-depend.el from Emacs org-mode with a little bit more complicated syntax but similar goal.

text2mindmap

2011-12-16T17:01:15+02:00

* This custom tool allows conversion of indented text (by a TAB) to a diagram (represented as a PNG image). * The solution is an alternative to online service . * The main inspiration and a basic algorithm came from .

tips_and_tricks

2011-10-05T00:47:21+02:00

Using zim * How to share and sync notebooks between computers * Creating a TODO item * Encrypted and Remotely Synced Password List with Zim Desktop Wiki and Friends * Zim clipping script on Ubuntu Linux * How to start zim as icon in the system tray * Multiple Computers and You Don't Want to Sync? Run Zim Remotely * Custom tools * Directory Documentation - document your digital life in Zim * Create tables using GraphViz * Script to convert moinmoin pages to Zim * Script to …

to_tomorrow

2010-09-13T03:18:16+02:00

Move unfinished tasks (not stroked out) to the next day. #!/usr/bin/python # -*- coding: utf-8 -*- # call: # to_tomorrow.py %s %n import sys import os import re import datetime import time # regex to remove deleted = re.compile("(.*)~~.*~~(.*)") empty_item = re.compile("^\*\s*$") def create_folder_structure(notebook_path, namespace): """ creates new year and month folder structures, if tomorrow is in the following month or year and the path does not exists.""" path …

usage_cases

2010-09-21T00:55:34+02:00

This page is intended to document example usage which can in turn be used as an input for feature requests. Please also file any concrete requests in the bug tracker, we are looking for more high level use cases here Blog Tool zim could be used for blogging, by exporting a note to static html. The workflow could be similar to , but better integrated into zim. Maybe use chronicle as a backend?

verbatim_syntax

2010-08-13T17:41:10+02:00

User Interface Indentation When the user presses the tab key: * If the cursor is inside a verbatim block and nothing is selected, insert a tab, even when at the beginning of a line. * If the entire verbatim block is selected, indent the block. * If parts of the block are selected, insert tabs in front of the selected lines.

zimarchivist

2012-05-05T15:05:53+02:00

The problem: If you keeps links to websites (blogs...) in your zim notes, you can be disappointed to have broken links because the webmaster deleted the page, closed the website... A solution: Have a look to webcache like google or But your page might not be archived by this external service.

Zim Documentation Wiki