页面标题就是指出现在浏览器标题栏上的标题, 它需要书写在 viki 文件的第一行, 格式如下:
#TITLE: 标题
例如这张 ViKi 页面的第一行标题定义为:
#TITLE: ViKi 基本语法
大家可以看一下浏览器的标题栏, 体会这条语句的效果。
最左端不出现空格直接以星号开头, 且在连续的一个或多个星号之后紧跟一个空格, 然后再跟一句话, 该行将会被处理为标题。 这句话念起来似乎很拗口, 其实理解起来还是比较简单的, 也就是说: 一个星号开头的代表标题一; 两个星号开头的行代表标题二; 三个星号开头的代表标题三…… 以此类推。 标题前面会被自动使用编号, 标题一是“1”、“2”、“3”等, 标题二是“1.1”、“1.2”、“2.1”等, 以此类推。 例如你现在看到的这张页面, 是这样编写的:
#TITLE: ViKi 基本语法 * 文章基本结构 ** 页面标题 ... ** 文内标题与正文 ...
没有星号开头的就是正文, 正文部分忽略单个换行符, 会将不同行间的内容连起来, 因此你可以随意换行。 滇狐习惯在标点符号出处断行, 这样 viki 源文件中每行都比较短, 容易阅读, 也容易修改。 没有任何内容的空行代表开始一个新的段落。 下面是一个简单的例子:
这里有一段 viki 编写的文字, 虽然这里出现了换行, 但由于 viki 忽略单个换行, 因此这几行文字都会被拼接起来, 成为一个长长的段落。 这里出现了一个空行, 因此 viki 会在这里开启一个新的段落。 由于段落内部的换行符不会影响最终得到的效果, 因此你可以根据自己的习惯任意调整段落内的换行。
这段代码编译后的效果如下:
这里有一段 viki 编写的文字, 虽然这里出现了换行, 但由于 viki 忽略单个换行, 因此这几行文字都会被拼接起来, 成为一个长长的段落。
这里出现了一个空行, 因此 viki 会在这里开启一个新的段落。 由于段落内部的换行符不会影响最终得到的效果, 因此你可以根据自己的习惯任意调整段落内的换行。
理论上讲, 你可以使用任何文本编辑器编辑 ViKi。 但是, 如果你是用 gvim 的话, gvim 针对 ViKi 提供了许多键绑定, 编写工作会变得非常简单而充满趣味。 以下文字都假设你是使用 gvim 编写 ViKi 的。
首先把需要开启超链接的词用方扩号括起来, 像这样:
[我是超链接]
然后, 在它前面放一对方括号, 写上用来保存跳转到的新的文件名。 下面的这个例子就是说, 用“hyperlink”这个文件, 解释“我是超链接”这个词:
[hyperlink][我是超链接]
最后, 用一对方括号将整个东西括起来, 像这样:
[[hyperlink][我是超链接]]
创建了超链接之后, 首先保存当前文件, 然后在超链接上按下“Ctrl + Enter”进入超链接。 如果超链接指向的文件不存在, 会提示是否创建, 选“y”即可。
驼峰词就是说一个单词的第一个字母是大写, 第二个字母是小写, 单词中间也出现一个单独的大写(没有与它相临的大写字母), 单词结尾是小写。 举个例子:
CammelWord
再举一个例子:
ViKi
在 ViKi 系统里, 所有的驼峰词会被自动识别为超链接, 所以:
CammelWord
会被自动识别为:
[[CammelWord][CammelWord]]
当我们输入一个驼峰词的时候, 它会自动被识别为超链接, 直接“Ctrl + Enter”进入就可以了。
滇狐个人并不喜欢驼峰词, 因为它不好看。 如果你不想让让一个驼峰词被识别为超链接, 可以在驼峰词前方加一个斜杠, 禁止识别超链接。 斜杠本身不会被显示出来。 同样的, 我们可以使用斜杠禁止方括号被识别为超链接。
如果你想输入斜杠本身的话, 需要写两遍:“\\”。
当使用“Ctrl + Enter”进入另一个页面编辑, 编辑完毕后可以直接使用“\vb”命令后退回原先的页面。 后退前记得先用“:w”命令保存当前文件。 可以看到, 使用 gvim 编写 ViKi 是非常方便的。
常用的贴图有两种, 一种单独作为一个段落的独立贴图, 另一种是放在段落之中的行内贴图。
独立贴图的命令格式是这样的:
#IMG w=宽度 h=高度: 文件名
其中宽度和高度参数可以省略, 如果不写的话默认使用图片本身的宽度和高度。
例如我们使用这个命令:
#IMG: kittie.png
得到的效果如下:
图片需要事先保存到 HTML 所在目录下。
行内贴图就是把图片贴在段落文字之间, 作为段落的一部分。 行内贴图的命令格式如下:
{img w=宽度 h=高度: 文件名}
其中宽度和高度参数可以省略, 如果不写的话默认使用图片本身的宽度和高度。
例如我们使用这个命令:
我们在这里:{img w=16 h=16: kittie_16x16.png}贴了一张图片。
得到的效果如下:
我们在这里:
贴了一张图片。
ViKi 支持简单的编号功能, 当一行以若干空格开头, 开头第一个字符是 “*”、 “-”、 “+”、 “#” 或 “@”, 然后再跟一个空格, 其后为一段文字, 这行就会被处理为编号或符号项。
在编译得到的结果中, “*”、 “-”、 “+”被处理为符号项, 而“#”与“@”会被处理为编号项, 请看下面的例子:
* 使用星号的例子
* 注意星号之前必须有一定数量的空格
* 否则紧贴在最左边的星号会被处理为大标题
- 使用减号的例子
- 我们可以使用更多的缩进
- 来描述项目之间的某种树形关系
+ 使用加号的例子
+ 以上几种符号没有本质上的区别
# 使用“#”号
# 我们可以得到数字编号项
# 当使用更多的缩进描述树形关系的时候
# 会重新开始编号
# 因此这里的编号是重新从 a 开始的
# 这里恢复原有缩进
# 因此继续原先的编号
@ 使用“@”号
@ 继续刚才的编号
得到的效果如下:
| | | |