自定义工具

Zim允许您定义自定义工具，通过可由外部程序或脚本处理的简单功能来扩展基本功能。自定义工具管理器允许您通过shell脚本或其他外部程序快速扩展zim中的功能。它对于在不必学习插件完整API的情况下原型化插件功能也很有用。

注意："工具"始终是单个可执行命令。要使用更复杂的shell命令，例如带有管道的命令，您应该先编写shell脚本，然后从"工具"中调用该脚本作为可执行文件。

添加自定义工具

要添加自定义工具，请使用菜单项工具 -> 自定义工具打开自定义工具管理器对话框。现在按"添加"图标按钮，zim将提示新工具的属性。

名称用于工具菜单中的此工具，是必填项。

描述应该是对此工具稍微详细的描述。例如，它用作工具栏项的工具提示。

命令...

在定义命令时，您可以使用以下参数为外部程序提供来自zim内部的一些上下文信息：

命令的引用应遵循"XDG桌面条目"规范。有关摘要，请参见Default Applications #默认应用程序。

可选的图标用于工具栏项和菜单项，具体取决于您的Gtk外观设置。

然后是复选框命令不修改数据。如果您的工具只读取数据但不修改数据，请启用此选项。在这种情况下，zim将在后台执行应用程序并继续运行。否则，如果您的工具确实修改数据，zim必须等待它完成并重新加载当前页面。

如果启用了输出应替换当前选择选项（并且上述复选框未启用），则命令的输出将用于替换编辑器窗口中的当前选择。这可用于修改单个单词或句子的自定义命令。

工具始终在主窗口的"工具"菜单中可见。根据它们采用的参数，它们也可能显示在页面的上下文菜单中或编辑器中所选文本的上下文菜单中。

[Plugins:ToolBar|工具栏插件]向主窗口添加一个可以包含自定义工具的工具栏。

如果您开始为自定义工具编写脚本，这些脚本不仅仅是直接调用另一个程序，这里有一些提示：

在测试直接修改笔记本目录的脚本时，请确保您有数据备份。启用版本控制并在运行脚本之前保存笔记本的快照也是一个好主意。

如果您想以自动化方式修改wiki语法，值得考虑用python编写脚本并直接使用zim.formats.wiki模块来解析wiki页面。一旦采取这一步骤，以后将脚本转变为完整的插件模块就相对容易了。

如果您的脚本需要例如自定义对话框来提示用户信息，建议也查看python和gtk。Glade编辑器可能有助于您快速绘制对话框。同样，使用这个框架将使以后将脚本转变为插件变得容易。

这些自定义工具的一个限制是您不能直接与文本缓冲区交互。例如，您不能更改光标位置或应用可撤销的更改。要实现这一点，您需要考虑编写真正的插件并使用文本缓冲区的API。