Instiki 维基引擎的功能与使用

文本格式

Instiki 支持很多种不同的文本格式，每一个不同的 Web （一个Web可以简单的认为是一套系统上面可以建立多个站点中的一个）可以有自己不同的文本格式。

XHTML 友好的标记格式

对于任何一种使用 XHTML 友好标记格式的页面，系统都会将内容以 application/xhtml+xml 标记发送，这表示，你可以直接在页面插入 SVG 图片，如果你想了解更多关于 SVG 的知识，可以查看一下我的另一篇文章《可缩放矢量图形 - Scalable Vector Graphics (SVG)》，所有下面这些标记格式都是基于 Maruku以及它内置的增强版本的 Markdown 语法。

  • Markdown+itex2MML这是Instiki默认使用的文本格式，它使用了 itex2MML ，并且允许你直接在文本中书法 itex 方程式 ，这些方程式会被 MathML 翻译为浏览器可识别的标签，而对于某些不支持MathML的浏览器，MathJax将被用来渲染 MathML。在某些数学公式使用很多页面中可能加载会十分的慢，但是 MathJax 是一个跨浏览器的工具。
  • Markdown+BlahTex/PNG这种文本格式会将你的数学公式编译为 PNG 图片，而不使用 MathML，安装会稍稍复杂一点，而且渲染的效果也没有 MathML的好，但是用户不需要使用支持 MathML 的浏览器即可查看。
  • Markdown如果你不需要数学公式的支持，那么选择这种方式是最好的，这样 $ 这个符号就没有什么特殊的含义了，在前面的两人种格式中，它被用来限定数学公式的范围。

HTML 友好的标记格式

如果你选择了这些格式里面的任何一种，那么内容将被标记为 text/html ，这表示你的网页里面不会有数学公式以及SVG图片，除非必要，我个人不建议你使用这些标记格式。

  • Textile使用 RedCloth 渲染 Textile 文本
  • RDoc支持 RDoc
  • Mixed与 Textile 类似，只是对于一个单独的分行，它不会被解释为 * <br /> *

分类

Instiki可以对所有页面进行归类，要给某个页面加入到一个分类中，只需要在页面中添加下面这一行即可：

category: food

你可以为一个页面添加多个分类，只需要在上面的那一行中写上多个分类即可，分类之间使用英文逗号分开：

category: food,restaurants

你可以将分类放在任何一个位置，但是我们约定将它放在文本的最下方，你还可以将一个页面归入某个类中但是在页面展示时不将其显示出来，只需要下面这样即可：

:category: S5-slideshow

上面这个示例将会让文档成为一个 S5 slideshow 页面.

文件上传

如果你选中了 Allow uploads… 的复选框，那么用户就可以上传文件至服务器，上传的方法是：

  1. 编辑某个需要插入图片的页面，在需要插入图片的地方插入下面这样的代码：
    [[mypic.jpg:pic]]

    或者：
    [[myfile.pdf:file]]

    注意 ： 这里面填写的文件名称将是文件上传之后在服务器上面的名称，它并不需要与用户要地的文件名称一样。
  2. 保存页面，上面的代码会生成一个链接，并提示这里需要上传图片，点击上传链接即可打开文件上传页面。
  3. 在文件上传页面中，可以输入一个 Description ：
+ 对于图片文件，它将是 &lt;image&gt; 标签的 *alt* 属性
+ 对于其它文件，它将作为提示文本，并且同样也是文件链接文本
  1. 当你上传完成之后，图片、视频、文件等会自动的出现在你的页面上。

如果你想为图片或者文件定义与 Description 不一样的文本，你可以使用下面这样的标记：

[[mypic.jpg|alt text:pic]]

或者：

[[myfile.pdf|link text:file]]

除了上面这种维基的格式，你同样还可以使用 Markdown 风格的标记方式：

![alt text](/mywiki/files/mypic.jpg)

或者：

[link text](/mywiki/files/myfile.pdf)

Wolfram CDF 文件

Wolfram Research 定义了一种文件格式名为 Camputable Document Format，这种文件需要浏览器插件的支持，如果你在文本中输入了像下面这样的标记：

[[Voronoi.cdf| 588 x 380 :cdf]]

那么会像 FlashPlayer一样，Instiki为会指向CDF文件的链接创建一个类似Flash获取插件的链接，它像下面这样的：

http://www.wolfram.com/cdf-player/

上面这个标记中，尺寸是可选的。

文件的管理

你可以在管理员界面中查看所有上传至维基的文件，并且可以直接删除他们，但是这里还有一个更快捷的方法，将：

[[myfile.pdf:file]]

修改为：

[[myfile.pdf:delete]]

保存页面之后，会生成一个：

*Delete myfile.pdf*

的链接，点击该链接，然后输入Web密码，即可删除该文件，这种方法可以被用来替换页面中已有的文件：

  1. 首先像上面这样删除该文件。
  2. 重新添加该页面，再加上下面这行标记：[[myfile.pdf:file]]
  3. 保存页面后作前面说过的上传文件的操作。

搜索

每一个页面顶部的搜索框除了支持普通搜索外，你还可以在这里面输入正则表达式，如果你懂正则，那么这个搜索工具将会帮助你更快的检索到你真正想要的内容，默认的，该搜索工具是大小写不敏感的，关于正则的有关知识，我这里不做任何的讲解，如果你想了解它，建议你从这里开始：http://www.regular-expressions.info/quickstart.html，下面只是几个示例：

  • (bzr|bazaar)
  • init[^w]
  • wikis?word

快捷访问键

绝大多数浏览器都支持通过键盘访问网页中的内容，我们称这为快捷键或者访问键，英文名称为AccessKeys，这些快捷键是由网页中的标签定义的，根据你所使用的操作系统或者浏览器的不同，可以通过下面这些方式访问快捷键：

  • Windows ⇒ Alt + AccessKey
  • Macintosh ⇒ Control + AccessKey
  • Opera 浏览器 ⇒ 先按 Shift+ESC ⇒ 然后按 AccessKey
  • GNOME 下的 FireFox ⇒ Alt + Shift + AccessKey

这里有一点需要注意，在Windows的Internet Explorer(IE)浏览器中，如果某个被设置了快捷链的链接指向另一个页面，那么当你击活该快捷键后，只会将焦点移动到该快捷键所定义的链接上，并不会自动的为你转向该链接所指向的页面，你需要再按一次回车键才能算作是点击。

在Instiki中，定义了下面这些快捷键：

  • Alt-E ：编辑当前页面
  • Alt-U ：查看当前版本
  • Alt-H ：回到首页
  • Alt-A ：查看所有页面列表
  • Alt-S ：保存当前正在编辑的页面
  • Alt-C ：显示所有隐藏的分类；退出当前页面的编辑模式
  • Alt-B ：查看上一个版本
  • Alt-F ：查看下一个版本
  • Alt-X ：导出Wiki
  • Alt-W ：编辑Web（当前站点设置）

结语

本文并未对 Instiki 的所有功能及使用方法都作了介绍，仅仅只是对其基本功能的一个说明，我会在更久的使用了它更了解它之后，对其它的一些功能做更深入的说明，比如它的 SVG-EDIT 编辑器（这是一个开源项目，你可以在你的项目中使用），数学公式以及我很喜欢的那个 S3 Slideshow等等。

标签: none

评论已关闭