Logo

Zim Wiki 中文文档

ZimWiki中文使用和操作说明

搜索
索引(X) <
配置文件

配置文件

本页面记录了各种使用的配置文件。
另请参阅preferences #首选项 获取首选项对话框的文档。

路径

Freedesktop（Linux等）

Zim使用由http://freedesktop.org 发布的"XDG基本目录规范"所规定的方案。默认路径为：

$XDG_CONFIG_HOME = HOME/.config/
$XDG_DATA_HOME   = HOME/.local/share/
$XDG_DATA_DIRS   = /usr/local/share/:/usr/share/

这些可以通过相应的环境变量进行覆盖。

当zim写入配置文件时，它始终使用$XDG_CONFIG_HOME。数据文件是只读的，会在$XDG_DATA_HOME和$XDG_DATA_DIRS中搜索。配置文件的安装默认值也安装在$XDG_DATA_DIRS中，但这些在首次使用时会复制到$XDG_CONFIG_HOME。

Windows

在Windows上，默认路径为：

$XDG_CONFIG_HOME = %appdata%/zim/config/
$XDG_DATA_HOME   = %appdata%/zim/data/

其中%appdata%是存储应用程序数据的默认Windows路径，通常是类似"%USERPROFILE%\Application Data"的路径。

当在Windows上未定义%HOME%环境参数时，将使用%USERPROFILE%参数或%HOMEDRIVE% + %HOMEPATH%。确保定义%HOME%或%USERPROFILE%包含驱动器号。

便携式安装

对于便携式安装，配置文件相对于安装文件夹查找。默认值为：

$XDG_CONFIG_HOME = ../config/
$XDG_DATA_HOME   = ../data/

../表示配置文件夹与安装文件夹在同一父文件夹中。这是有意为之，这样安装新版本时不会覆盖配置。

如果要更改便携式安装的路径，有一个在应用程序启动时使用的特殊配置文件，称为environ.ini，它允许自定义查找。

macOS

在macOS上，默认路径为：

 $XDG_CONFIG_HOME = ~/Library/Application Support/org.zim-wiki.Zim/
 $XDG_DATA_HOME = ~/Library/Application Support/org.zim-wiki.Zim/share/

全局配置文件

这些配置文件决定了zim行为的各个方面。它们是全局的，意味着它们不特定于一个笔记本。

主配置文件

默认配置文件是$XDG_CONFIG_HOME/zim/preferences.conf。

关闭zim时会自动写入配置文件。所以如果要手动更改它，您需要先关闭所有zim实例。

有一些隐藏选项，您可以直接添加到文件中，但它们不会在首选项对话框中显示：

  • "autosave_timeout"给出了以秒为单位的自动保存间隔，默认值为10
  • "gtk_bell"可以是True或False，如果为False，它会覆盖Gtk设置以关闭编辑器中的提示音，默认为False

跨维基URL列表

文件$XDG_DATA/zim/urls.list提供了用于Links #跨维基 功能的URL列表。查找URL时会读取$XDG_DATA路径中的所有文件，因此您可以使用$XDG_DATA_HOME覆盖安装默认值。

urls.list是一个制表符/空格分隔的文件，第一列是跨维基前缀，第二列是一个https://docs.python.org/3.8/library/stdtypes.html #str.format 兼容字符串，可能包含{NAME}或{URL}作为可能的插值值。
{NAME}将替换为本地链接，例如，https://wikipedia.org/wiki/{NAME}将与链接[[wp?Foo]]变为https://wikipedia.org/wiki/Foo。
{URL}是{NAME}的数据通过wp?urlencode #urlencode 函数处理。
如果在第二列的字符串中找不到任何插值值，本地链接将附加到指定URL的末尾。

您也可以在第二列中使用非标准的"zim+file://"方案链接到计算机上的其他zim笔记本。

urls.list示例如下：

prj zim+file:///home/dvn/project/{NAME}
w2  https://wiki.c2.com/?{URL}
zh    https://zim-wiki.org/manual/Help/

日期格式列表

文件$XDG_DATA/zim/dates.list提供了strftime格式的列表，每行一个，用于填充"插入日期和时间"对话框。使用在$XDG_DATA路径中找到的此文件的第一个实例。

有关strftime格式的文档，请参阅http://docs.python.org/library/time.html%23time.strftime #此链接。

自动挂载配置文件

配置文件$XDG_CONFIG_HOME/zim/automount.conf可用于为特定笔记本路径配置挂载命令。详情请参阅Automount #自动挂载。

Environ.ini配置文件

配置文件environ.ini可用于在加载任何zim模块之前修改环境参数。详情请参阅Portable Install #便携式安装。

GUI样式配置文件

Zim对如何显示样式有某些默认值。例如，它将链接显示为没有下划线的蓝色文本。要更改此样式，请将"/usr/share/zim/style.conf"复制到"~/.config/zim/"并编辑它。每个样式都有自己的部分，以方括号中的样式名称开始，并包含各种显示属性的键值对。

注意：GUI的显示样式在导出为HTML时不使用。如果您希望HTML显示某些自定义样式，您应该编写带有CSS样式表的HTMLTemplates #模板。

示例：

[TextView]
tabs = 40
font = Sans 10

[Tag bold]
weight = PANGO_WEIGHT_BOLD

[Tag italic]
style = italic

TextView的已知属性：

  • indent：整数 - 缩进步长（像素）
  • tabs：整数 - 制表符大小（像素）
  • linespacing：整数 - 行间距（像素），实际上是段落之间的间距
  • wrapped-lines-linespacing：整数 - 换行行之间的行间距（像素）
  • justify：LEFT, RIGHT, CENTER或FILL
  • font：字符串
  • bullet_icon_size：ICON_SIZE_MENU, ICON_SIZE_LARGE_TOOLBAR, ...

已知样式标签：

  • h1, h2, h3, h4, h5, h6：各种标题
  • emphasis：强调或斜体文本
  • strong：强烈或粗体文本
  • mark：高亮或下划线文本
  • strike：删除线文本
  • code：内联逐字文本
  • pre：作为段落的逐字文本
  • sub：下标文本
  • sup：上标文本
  • link：超链接文本
  • indent：缩进行
  • bullet-list：项目符号列表中的行
  • numbered-list：编号列表中的行
  • unchecked-checkbox：带有打开复选框的行
  • checked-checkbox：带有"v-选中"复选框的行
  • xchecked-checkbox：带有"x-选中"复选框的行

标签的已知属性：

  • family：monospace, sans, ...
  • foreground：grey, blue, #cccccc, 等。
  • background：yellow, #cccccc, 等。
  • paragraph-background：red, #cccccc, 等。
  • weight：PANGO_WEIGHT_BOLD, ...
  • scale：整数
  • style：italic, ...
  • underline：single, ...
  • strikethrough：true, false
  • wrap-mode："none", ...
  • indent：整数
  • linespacing：整数
  • rise：整数 (相对于行中心的偏移，用于"sup"和"sub")

Gtk配置

要更改应用程序的外观，超出可以使用style.conf文件完成的范围，您需要修改Gtk主题。使用Gtk3，这可以使用CSS语言完成，类似于样式化网页的方式。

此配置的文件位置是：$XDG_CONFIG_HOME/gtk-3.0/gtk.css。您需要重新启动zim才能看到效果。对于常见内容（如更改字体或颜色）的示例，请使用您选择的搜索引擎。开发者文档在这里：https://developer.gnome.org/gtk3/stable/GtkCssProvider.html

此外，一些设置不在CSS中，但可以通过$XDG_CONFIG_HOME/gtk-3.0/settings.ini配置。开发者文档在这里：https://developer.gnome.org/gtk3/stable/GtkSettings.html

注意：如果您使用安装程序在Windows上安装了zim，则这些文件的位置分别为<zim-installation-dir>\etc\gtk-3.0\gtk.css和<zim-installation-dir>\etc\gtk-3.0\settings.ini。

具体来说，Gtk主题可以通过settings.ini文件设置gtk-theme-name来配置，在系统上安装自定义主题后。

此外，settings.ini可以用来请求任何主题的暗版本，如下所示：

[Settings]
gtk-application-prefer-dark-theme=1

注意：对于windows安装程序，您可以使用.\etc\gtk-3.0\settings.ini，相对于应用程序的安装文件夹。

zim中有一些小部件设置了名称，因此可以使用id选择器（"#name"）从CSS样式中特别指定它们。

具体的有：

  • zim-sidepane：用于应用程序窗口的任何侧边栏
  • zim-pageview：用于显示页面的文本视图
  • zim-inserted-object-inline：用于在行中间插入文本中的对象
  • zim-inserted-object：用于作为块插入文本中的对象；默认是渲染一个小边框线
  • zim-inserted-object-head：用于此类对象的顶部栏；默认是在底部渲染一个小边框线

更多名称记录在特定插件的手册页面中。

要在代码中识别这些，搜索widget_set_css(...)和widget.set_name(...)的使用。所使用的名称将从CSS配置中作为"id"访问。

识别CSS选择器ID的另一种方法是使用GTK检查器，可以在从命令行调用Zim时调用，如下所示：

GTK_DEBUG=interactive zim

CSS配置示例

以下片段可直接在~/.config/gtk-3.0/gtk.css中使用

#zim-pageview text {
    background-color: #1A2E38;  /* 更改Zim页面编辑器的背景颜色 */
    color: #BABABA; /* 前景文本颜色 */
  }

#zim-toc-widget {
  color: #2b2b2b;  /* 设置目录插件边框线的颜色 */
  opacity: 0.9;    /* 为目录添加一些透明度 */
  font-size: 12px; /* 目录字体大小 */
  }

#zim-toc-widget scrolledwindow treeview {
  color: #BABABA;  /* 设置目录插件内文本的颜色 */
  opacity: 1;
  }

笔记本配置文件

有一个特定于笔记本的配置文件，称为"notebook.zim"，应该在笔记本文件夹中。该文件包含一个"[Notebook]"部分，其中包含可以在properties #属性对话框 中设置的属性。

一个隐藏属性是"end_of_line"，它决定了zim在此笔记本范围内写入文件的行尾约定。值可以是"dos"或"unix"。对于新创建的笔记本，此值根据zim运行的平台设置。此属性的主要目的是确保在Linux和Windows机器之间共享的笔记本不会在每次写入时更改整个文件。如果需要，可以手动更改属性，这将影响更改后编辑的所有页面。

第二个隐藏选项是"disable_trash"，默认为False。如果启用，zim将避免为此笔记本使用系统垃圾箱，请参阅Pages #页面 中关于删除的部分。

第三个隐藏选项是"shared"，默认为True（但对于较旧的笔记本将为False）。如果为True，zim将笔记本缓存存储在主文件夹中（$XDG_CACHE_HOME）。通常，这是您想要的，但在特殊情况下，例如当笔记本位于加密文件夹中时，您可能希望将其设置为False，以确保缓存实际上存储在笔记本文件夹中（使用".zim"隐藏文件夹）。

目录(K)
链接(B)
任务(O)

这篇文章中没有任务列表。