WikidPad is a Wiki-like notebook for storing your thoughts, ideas, todo lists, contacts, or anything else you can think of to write down.
Main feature is an automatically updated tree list, which will make page to page navigation fast and easy.
下面是我写的一篇简明教程,希望对大家有用。
由于教程是直接粘贴自我自己的浏览器,因此下面的链接可能已经失效。更重要的是,html格式的文件不能完全表达出教程想要传达的东西。
因此,请到这里下载全部文件,特别是WikidPad格式的原始文件。
--------------教程开始--------------------
parent nodes: MyWiki | WikidPad简明教程
WikidPad简明教程
[作者: Frank Chen]
[版本: 20100509-1]
前言
WikidPad是一款自由软件,是一款用wiki概念组织信息的笔记本软件。本文就是用它写的。
好像最初是在善用佳软上看到关于它的介绍的,由于我这段时间对笔记软件感兴趣,于是玩了一下,觉得还挺有意思的。
目录
说明
- WikidPad是拿来用的,因此读者应当把本文用WikidPad打开,自行修改一些文字,观察修改会带来什么
变化。
- 为了排版方便,本文的某些例子被取消了格式化功能。请读者自行修改本教程,查看对应的预览。
- 本文力求简洁,也是为了方便日常查阅。毕竟中国人还是看中文的帮助方便点,特别是简洁精练的帮助。
软件的特点
- 开源、自由、免费
- 采用Python语言编写,跨平台
- 纯文本编辑,自动转换为富文本预览
- 方便的编辑方式
- 词条之间可以链接
- 词条关系的树状展现
- 多种属性标记,用来控制页面和整个wiki
- 采用多种数据库格式,包括纯文本格式,方便别的程序进行编辑
- 自动保存,动态更新
- 可以导出为html格式的网页文件
- 较好的搜索功能
软件的缺点
- 暂时没有汉化版
- 教程是英文版的,而且比较长,也不容易懂
软件简明使用教程
编辑模式和预览模式
编辑模式就是进行纯文本编辑,预览模式用来预览富文本结果。两种模式在软件中可以很方便的切换。
什么是词条?
WikidPad中,特定的驼峰式大小写英文单词被看做一个词条,会在编辑模式下用下划线表示。如果某词条
已经有相应的页面了,那么颜色会是蓝色的。 对于中文词条或其它不方便写成驼峰式外观的词条,可以用方括号将词条括起来,强制让WikidPad认为它
是一个词条。例如在WikidPad简明教程中的开源词条。 WikidPad中,很多地方都可以用反斜杠取消特定字符(或字符串)的格式化功能,比如“[开源]”现在就不
被当做词条了。
URL链接
WikidPad中可以方便地进行URL链接,还可以对链接对应的图片进行大小等方面的控制。URL链接功能算是
一个基本功能了,具体用法请参考WikidPad帮助中的“Url Linking”词条。
网页锚和脚注
在本文中,就用到了网页锚,比如“WikidPad简明教程”就指向了“软件的特点”所在的位置。[1]
上面的“[1]”就是脚注。
词条树的图标和颜色
WikidPad中可以给词条树加图标和颜色。软件自带了很多图标,自定义了很多颜色。
具体请参考WikidPad帮助中的“TreeIcons”和“TreeNodeColors”词条。
WikidPad中的一些格式化语法
在编辑模式中用特殊的一些符号来进行格式化,可以在预览模式中查看。
加粗
斜体
+ 标题级别1
++ 标题级别2
+++ 标题级别3
++++ 标题级别4
如果你输入了一个很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长
很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长的句子,可以用Ctrl-W快捷键分行,
这样在预览区中也就可以合适地分行了。
不过对中文句子来说,这个特性用起来不一定让人满意。实在不行就手动分行吧。
可以改变属性标记改变分行方式,比如“[wrap: 20]”就将每行设定为20字。“[global.wrap: 70]”为对应的全局属性标记。
取消格式化
取消一段文字的格式化
如果要让一段文字中的特殊符号没有格式化的功能,就用“<<”和“>>”括起来。
例如:
*粗体* [开源]
和
粗体 开源
在“<<”和“>>”所在的行,只有空格是允许存在的,所以本行中的“<<”和“>>”没有格式化的功能。
一段预定义的文字
可以用“<<pre”和“>>”将一段文字括起来,取消这段文字的格式化,同时,在浏览器中将会用
等宽字体显示,也就保留了原始的样式。这在编程中尤其有用。
例如:
^
/ \
/ \
/_____\
( )
| | WWWWWWWWWW
| | llllllllll
| |
| |
L_______j
和
^
/ \
/ \
/_____\
( )
| | WWWWWWWWWW
| | llllllllll
| |
| |
L_______j
以及
-
^
-
/
-
/
-
/___
-
( )
| | WWWWWWWWWW
| | llllllllll
| |
| |
L_______j
Escaping characters
用反斜杠来取消格式化,例如:
\、[开源]、*不是粗体*。
表格
可以用“<<|”和“>>”将一段文字括起来制表。同样,“<<|”和“>>”必须单独占一样。表格的线用“|”绘制。
例如:
开源 | 这是 | 一个表格 |
两行 | 三列 | 用“|”作为划线的符号 还可以用反斜杠延长一行文字,类似很多编程语言的做法。 |
HTML标签和特殊字符
可以用HTML标签和HTML特殊字符,例如“©”就是版权符号。
项目符号
用TAB键缩进一行,然后输入星号,再跟一个空格,就可以输入项目符号了。
- 在本行末尾按回车键试试
用tab键缩进一行,然后输入数字,再跟一个英文点号,就可以输入数字型项目符号了。
- 在本行末尾按回车键试试,也试试按两次回车键
-
- 在本行末尾按回车键试试
- 在本行末尾按回车键试试
-
可以在WikidPad的选项中取消自动添加缩进与项目符号等功能。
也可以在输入了几行文字后再用TAB键增加缩进,用SHIFT-TAB取消缩进。
需要注意一下什么时候该缩进。比如下面一段文字。
* 列表
* 列表继续
其它文字。
属性标记
属性标记有两个目的,一是除了用词条之外还可以用属性标记来索引你的数据,二是属性标记可能会有一些特殊的格式化功能。
在词条树的“Views”节点上可以看到一些属性标记以及对应信息。
具体用法请参考WikidPad帮助中的“Wiki Document Attributes”词条。
下面对一些常用的进行举例说明。
[联系人: 工作]
[联系人: 私人],用来给张三这样的词条做标记
[工作相关: true],标记某词条是与工作相关的
[联系人.私人.小孩子: ture]
[importance: high]
如果同一个属性标记有多个值,例如:
[alias: 别名1]
[alias: 别名2]
[alias: 别名3]
可以这样写:
[alias: 别名1; 别名2; 别名3]
可以用英文双引号把含有特殊字符的指括起来
[contact: Carl [Home]]
三种特殊的属性标记,用来控制节点的外观。
[icon: heli]
[color: red]
[bold: true]
全局属性标记
[global.联系人.color: blue]
当创建新wiki的时候,会自动添加“WikiSettings”词条。
另外一些特殊的属性标记
[priority: 3]
[font: Verdana]
[global.font: Consolas]
[alias: jmjc]
[html.bgcolor: #b9d2ff]
[short_hint: 提示]
WikidPad支持语法的错误检测。
Todo项目
用下面这些特殊的关键词跟踪一些重要事项,可以在“Views”节点中看到。
todo: I have to do this.
done: I have done this.
action: I have action items
track: I am tracking this
issue: I am tracking this
question: This is a question
project: This is my project
可以用反斜杠取消这些特殊关键词的特殊含义。
例如:
-
Interesting CD track: loud music
和
-
Interesting CD track: loud music
这些关键词可以和其它一些词语嵌套。
todo.系统.bug.严重: 关于系统的严重bug
动态插入
例如,要动态插入”开源“词条:
开源
摘自维基百科的一段话:
开放源代码(英语:Open Source)描述了一种在产品的出品和开发中提供最终源材料的做法。一些人 将开放源代码认为是一种哲学思想,另一些人则把它当成一种实用主义。 |
语法
一些可以用的引号如下:
"
'''
//
/////
\
因此,”开源“词条也可以这样插入。
[:page: "开源"]
[:page: '''开源''']
[:page: //开源//]
[:page: /////开源/////]
[:page: \\开源\\]
一些WikidPad自带的插入标记:
- page 例如上面的例子
- rel 插入有关的列表:
- parents: 父词条
- children: 子词条
- parentless: 孤儿词条
- undefined: 没定义的词条
- back: 回到历史记录中的上一个
- savedsearch 已保存的搜索
- toc 目录
- eval Python动态演算
例子
[:rel: parents]
MyWiki
WikidPad简明教程
[:rel: children]
Frank Chen
TreeIcons
TreeNodeColors
WikiSettings
等宽字体
开源
张三
[:rel: children;existingonly;columns 2]
Frank Chen | WikiSettings |
等宽字体 | 开源 |
张三 |
[:savedsearch: 例子; columns 4] (all pages containing "例子")
[:toc:]
[:eval:"5+6*3"]
5 + 6 * 3 == 23
模板
WikidPad提供了模板功能。
todo:研究模板功能的用法。
[1]请参考WikidPad帮助中的“Anchors”和“Footnotes”词条。
--------------教程结束--------------------