zim - This is the development documentation of zim.zim.actions - Action interface classes.zim.applications - This module contains helper classes for running external applications.zim.config - No package docstring; 0/1 variable, 4/4 functions, 2/3 modules documentedzim.config.basedirs - This module defines the search path for zim config files following the freedesktop.org (XDG) Base Dir specification.zim.config.dicts - This module contains base classes to map config files to dictszim.config.manager - No module docstring; 0/2 variable, 0/2 function, 6/6 classes documentedzim.datetimetz - Thin wrapper for 'datetime' module from the standard library. Provides timezone info for the local time. Based on example code from standard library datetime documentation.zim.errors - This module contains the base class for all errors in zimzim.export - This module contains the framework for exporting data from zim.zim.export.__main__ - Undocumentedzim.export.exporters - The exporters are the main public objects for exporting, they control the execution of the whole process. Each exporter implements a different export style.zim.export.exporters.files - No module docstring; 0/1 variable, 3/3 classes documentedzim.export.exporters.mhtml - No module docstring; 1/2 class documentedzim.export.layouts - The ExportLayout object determines the mapping of pages to files when exporting. The subclasses give alternative file layouts.zim.export.linker - The ExportLinker object translates links in zim pages to URLS for the export contentzim.export.selections - PageSelection objects wrap the list of pages to be exportedzim.export.template - This module defines the ExportTemplateContext, which is a dictionary used to set the template parameters when exporting.zim.formats - Package with source formats for pages.zim.formats.__main__ - No summaryzim.formats.html - This module supports dumping to HTMLzim.formats.latex - This modules handles export of LaTeX Codezim.formats.markdown - This module handles dumping markdown text with pandoc extensionszim.formats.plain - This module handles parsing and dumping input in plain textzim.formats.rst - This module handles dumping reStructuredText with sphinx extensionszim.formats.wiki - This module handles parsing and dumping wiki textzim.fs - Module with basic filesystem objects.zim.gui - No package docstring; 0/1 variable, 1/2 function, 6/18 modules, 1/1 package documentedzim.gui.actionextension - No module docstring; 1/1 class documentedzim.gui.applications - This module contains utilities to work with external applications it is based on the Freedesktop.org (XDG) Desktop Entry specification with some additional logic based on status quo on Gnome / XFCE.zim.gui.clipboard - Utilities to work with the clipboard for copy-pastingzim.gui.customtools - This module contains code for defining and managing custom commands.zim.gui.exportdialog - No module docstring; 0/1 variable, 4/8 classes documentedzim.gui.insertedobjects - No module docstring; 0/2 constant, 0/1 function, 1/9 class documentedzim.gui.mainwindow - No module docstring; 0/2 variable, 0/1 constant, 1/1 function, 4/6 classes documentedzim.gui.navigation - No module docstring; 1/1 class documentedzim.gui.notebookdialog - No summaryzim.gui.notebookview - No module docstring; 2/2 classes documentedzim.gui.pageview - This module contains the main text editor widget. It includes all classes needed to display and edit a single page as well as related dialogs like the dialogs to insert images, links etc.zim.gui.pageview.editbar - No module docstring; 1/2 class documentedzim.gui.preferencesdialog - Undocumentedzim.gui.propertiesdialog - Undocumentedzim.gui.recentchangesdialog - Undocumentedzim.gui.searchdialog - Undocumentedzim.gui.server - This module stands apart from the rest of the gui modules as it is not part from the main Gtk interface. It defines a Gtk interface that can be used to start/stop the WWW server.zim.gui.templateeditordialog - No module docstring; 1/3 class documentedzim.gui.uiactions - No module docstring; 0/1 variable, 0/3 constant, 0/1 function, 2/9 classes documentedzim.gui.widgets - This module contains a number of custom gtk widgets that are used in the zim gui modules.zim.history - This module implements the history for navigating pages in the notebook.zim.import_files - No module docstring; 0/1 variable, 2/2 functions documentedzim.inc - This package contains third party libraries to be packaged with zim. See the respective files for the copyright and license notices.zim.inc.arithmetic - No module docstring; 0/11 variable, 5/5 functions, 5/5 classes documentedzim.insertedobjects - No module docstring; 1/1 class documentedzim.main - No summaryzim.main.command - This module is responsible for commandline parsing. It provides a base class for the commandline commands defined in zim.mainzim.main.ipc - This module is responsible for the inter-process communication (ipc) between zim instances.zim.newfs - Module which contains all classes to deal with the filesystemzim.newfs.base - Base classes for filesystem and storage implementationzim.newfs.helpers - Helper classes for file system related functionszim.newfs.local - Local file system objectzim.newfs.mock - Mock objects for file system classeszim.notebook - This module contains the main Notebook class and related classes.zim.notebook.content_updater - No module docstring; 0/1 variable, 3/10 functions documentedzim.notebook.index - No package docstring; 0/2 variable, 0/2 constant, 0/1 function, 1/5 class, 1/5 module documentedzim.notebook.index.base - No module docstring; 0/1 variable, 5/6 classes documentedzim.notebook.index.files - No module docstring; 0/1 variable, 0/6 constant, 1/3 class documentedzim.notebook.index.links - No summaryzim.notebook.index.pages - No module docstring; 0/2 variable, 0/6 constant, 0/1 function, 4/6 classes documentedzim.notebook.index.tags - No module docstring; 0/1 variable, 0/1 constant, 3/6 classes documentedzim.notebook.info - No module docstring; 0/1 variable, 4/4 functions, 2/3 classes documentedzim.notebook.layout - No module docstring; 0/2 variable, 0/2 constant, 2/3 functions, 1/3 class documentedzim.notebook.notebook - No module docstring; 0/1 variable, 0/2 constant, 0/4 function, 3/9 classes documentedzim.notebook.operations - This module contains classes and functions needed for concurrent use of the notebook data.zim.notebook.page - No module docstring; 0/3 variable, 0/3 constant, 1/1 function, 3/4 classes documentedzim.parser - Generic parser for wiki formatszim.parsing - This module contains utilities for parsing strings and textzim.plugins - API documentation of the zim plugin framework.zim.plugins.arithmetic - Undocumentedzim.plugins.attachmentbrowser - Zim plugin to display files in attachments folder.zim.plugins.attachmentbrowser.filebrowser - No module docstring; 0/1 variable, 0/5 constant, 2/3 functions, 0/1 class documentedzim.plugins.attachmentbrowser.filerenamedialog - No module docstring; 1/1 class documentedzim.plugins.attachmentbrowser.thumbnailer - No module docstring; 0/1 variable, 0/5 constant, 1/1 function, 2/3 classes documentedzim.plugins.backlinkpane - Undocumentedzim.plugins.base - No package docstring; 1/1 module documentedzim.plugins.base.imagegenerator - This module contains the base classes used by all plugins that create an image from text based input. Like the equation editor, the diagram editor etc.zim.plugins.bookmarksbar - No module docstring; 0/1 variable, 0/2 constant, 1/4 class documentedzim.plugins.commandpalette - No module docstring; 0/1 variable, 3/4 classes documentedzim.plugins.diagrameditor - Undocumentedzim.plugins.distractionfree - Undocumentedzim.plugins.ditaaeditor - Undocumentedzim.plugins.equationeditor - Undocumentedzim.plugins.gnu_r_ploteditor - Undocumentedzim.plugins.gnuplot_ploteditor - Undocumentedzim.plugins.inlinecalculator - No module docstring; 0/2 variable, 0/1 constant, 15/18 functions, 0/3 class documentedzim.plugins.insertsymbol - Undocumentedzim.plugins.journal - No module docstring; 0/5 variable, 0/2 constant, 2/2 functions, 3/6 classes documentedzim.plugins.linesorter - Undocumentedzim.plugins.linkmap - Plugin showing a map of links between pages based on GraphVizzim.plugins.osx_menubar - Undocumentedzim.plugins.pageindex - No package docstring; 0/1 variable, 0/9 constant, 2/6 classes, 0/1 module documentedzim.plugins.pageindex.generictreemodel - No module docstring; 1/2 function, 1/2 class documentedzim.plugins.pathbar - No module docstring; 0/4 variable, 0/10 constant, 3/13 classes documentedzim.plugins.printtobrowser - Plugin to serve as work-around for the lack of printing supportzim.plugins.quicknote - No module docstring; 0/2 variable, 1/4 class documentedzim.plugins.scoreeditor - Undocumentedzim.plugins.screenshot - Undocumentedzim.plugins.sequencediagrameditor - Undocumentedzim.plugins.sourceview - Undocumentedzim.plugins.spell - Spell check plugin based on gtkspellzim.plugins.tableeditor - No module docstring; 0/1 variable, 0/5 constant, 1/1 function, 4/6 classes documentedzim.plugins.tableofcontents - No module docstring; 0/1 variable, 0/2 constant, 2/4 functions, 0/8 class documentedzim.plugins.tags - No module docstring; 0/1 variable, 6/9 classes documentedzim.plugins.tasklist - No package docstring; 0/3 class, 1/3 module documentedzim.plugins.tasklist.dates - Functions to match and parse dates in wiki pageszim.plugins.tasklist.gui - No module docstring; 0/2 variable, 0/23 constant, 0/1 function, 2/7 classes documentedzim.plugins.tasklist.indexer - No module docstring; 0/11 variable, 0/10 constant, 0/3 function, 2/8 classes documentedzim.plugins.toolbar - Undocumentedzim.plugins.trayicon - No module docstring; 0/2 variable, 0/2 constant, 0/1 function, 4/6 classes documentedzim.plugins.versioncontrol - No package docstring; 0/1 variable, 0/1 constant, 0/1 function, 2/11 classes, 0/4 module documentedzim.plugins.versioncontrol.bzr - Undocumentedzim.plugins.versioncontrol.fossil - Undocumentedzim.plugins.versioncontrol.git - Undocumentedzim.plugins.versioncontrol.hg - Undocumentedzim.plugins.zeitgeist-logger - Push events to the Zeitgeist daemonzim.search - This module contains the logic for searching in a notebook.zim.signals - No module docstring; 0/1 variable, 0/5 constant, 1/2 function, 5/9 classes documentedzim.templates - No package docstring; 0/1 variable, 3/4 functions, 1/1 class, 5/5 modules documentedzim.templates.expression - Module that contains the logic for evaluating expressions in the template.zim.templates.expressionparser - This module contains the parser to parse expressions in templates and returns an Expression object.zim.templates.functions - This module contains generic template functions.zim.templates.parser - This module defines the main parser for template text.zim.templates.processor - This module contains the main object to "execute" a template and fill in the parameters, call functions etc. The TemplateProcessor defined here takes care of the template control flow ('IF', 'FOR', etc.).zim.tokenparser - Undocumentedzim.utils - Module with assorted useful classes and functions used in the zim codezim.www - This module contains a web interface for zim. This is an alternative to the GUI application.