格式语法与编辑器使用说明

本知识库基于 DokuWiki 及 cfgEditor进行文件编辑。如果你需要测试你可以在 playground 页面任意的编写。本文件只是例出最常见的使用说明。如果你需要详细了解所有的语法规则,你可以参考 DoukuWiki语法说明(英文)

如果你需要编辑修改我们的页面,您除了需要了解本页中的内容以外,您还需要仔细阅读:知识库(WIKI)文件目录结构,以了解我们的规则与规定。

你可以直接使用编辑器完完成正常的排版。

为了获得良好的编辑体验,你应当在全屏模式下完成排版。完成之后再还原到正常模式进行保存。

上传图片

系统提供了多种图片上传的方式,最稳定的方式是从左边栏位中【媒体管理器】中将图片上传到正确的位置(详见:知识库(WIKI)文件目录结构)后。在编辑器中引用图片。

系统截图及逻辑说明图片请尽可能的以png格式进行保存。其它格式可能会在放大缩小时变模糊。

使用WRAP来建立特殊的区域块

使用方法

你可以使用一个大写的WRAP来

<WRAP classes width :language>
"big" content
</WRAP>

效果为

“big” content

你也可以使用小写的wrap来

<wrap classes width :language>"small" content</wrap>

上例的效果为:“small” content

Info 信息,用于提供一些额外说明

<WRAP info></WRAP>

Tip 技巧、提示、思路说明

<WRAP tip></WRAP>

Important 需要额外注意的事项

<WRAP important></WRAP>

Alert 警告

<WRAP alert></WRAP>

Help 帮助

<WRAP round help></WRAP>

Download 下载与文件区

<WRAP download></WRAP>

Todo 后续待办事项

<WRAP todo></WRAP>

Safety Notes:

Danger

<WRAP danger></WRAP>

Warning

<WRAP warning></WRAP>

Caution

<WRAP caution></WRAP>

Notice

<WRAP round notice></WRAP>

Safety

<WRAP round safety></WRAP>

在上面的例子中,实际还加入了一些代码去控制宽度。

Safety

<WRAP round safety column 20%></WRAP>

如果不是全宽的内容,在完成后,需要清理一下,使用以下代码。以恢复全宽模式。

<WRAP clear></WRAP>

after your last column.

你也可以使用小写的标记 效果如下 : info, help, alert, important,tip, download, todo and round box and <warp danger>danger</wrap>, <warp danger>warning</wrap>, <warp danger>caution</wrap>, <warp danger>notice</wrap>, <warp danger>safety</wrap>.

<wrap info>info</wrap>, <wrap help>help</wrap>, ...

You can mark text as highlighted, less significant and especially emphasised.

You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>

标记代码区域(代码高亮显示)

如果需要将JS、PHP、Java代码进行高亮度显示。可以使用

<code java> <code javascript>