`
hit1983
  • 浏览: 38161 次
  • 性别: Icon_minigender_1
  • 来自: 西安
社区版块
存档分类
最新评论

Wiki语法快速参考

    博客分类:
  • Wiki
阅读更多

Wiki语法快速参考 for more

----       = 创建水平线.
\\         = 换行, \\\=force line break and clear.

[link]     = 创建一个链接,指向内部的wiki页面'Link'.
[this is also a link] = 创建一个链接,指向内部的wiki页面'ThisIsAlsoALink'.
[click here|link] = 创建一个链接,指向内部的wiki页面'Link', 链接文字是'click here'.
[1]        = Makes a reference to a footnote numbered 1.
[#1]       = Marks the footnote number 1.
[[link]    = 不创建链接而是输出文字'[link]'.

!heading   = 小号标题
!!heading  = 中号标题
!!!heading = 大号标题

''text''   = 将text斜体.
__text__   = 将text粗体.
{{text}}   = prints 'text' in monospaced font.

* text     = 无符号列表
# text     = 有符号列表
;term:ex   = 名词定义,用'ex'定义名字'term'

文字相关语法

在写wiki页面时可以不懂任何wiki语法,只需要像写信那样写自己的wiki页面,用空行来分割不同的段落,这样输出的页面跟你输入时的格式是类似的.

标题'!'

!text    = 用于定义小号标题
!!text   = 用于定义中号标题
!!!text  = 用于定义大号标题
除了用于定义页面输出样式,标题还有两个增值用法

书签:

所有标题都会自动生成一个页面书签, 这样我们可以在其他页面定义一个链接到这个页面某个书签的链接. 举例, 在本页有下面这样的标题,

!!This is my heading
那么生成的HTML代码将如下,

This is my heading

在其他页面可以通过如下文字链接到这个书签,

[TextFormattingRules#ThisIsMyHeading]
or [Bookmark Text|TextFormattingRules#ThisIsMyHeading]

生成索引和目录:

Table Of Contents Plugin将会把标题生成对应的索引和目录

无符号列表'*'

'*'生成无符号列表,多个'*'生成多级无符号列表. 举例:
* One
* Two
* Three
** Three.One

生成列表如下

  • One
  • Two
  • Three
    • Three.One

有符号列表'#'

类似无符号列表, 只是使用'#'. 举例如下:
# One
# Two
# Three
## Three.One

生成列表如下

  1. One
  2. Two
  3. Three
    1. Three.One

名词定义与注释';:'

';term:ex'用于名词定义,名词construct的定义举例如下:

;__Construct__:''Something you use to do something with''
将生成如下格式,
Construct
Something you use to do something with

term为空时用于生成注释,举例如下:

;:''Comment here.''
将生成如下格式,
Comment here.

文字效果(粗体和斜体)

__text__      生成粗体文字
''text''      生成斜体文字

预格式化文本(Preformatted text)

三个'{'可以起到HTML标签里PRE的作用,这个功能在输出程序代码等文字时会非常有用.

在Wiki页面里添加图片

Inlined Image

最简单的方式是使用Inlined Image,写法和一般的链接写法类似,举例: [http://www.ecyrd.com/~jalkanen/test.png]可显示图片http://www.ecyrd.com/~jalkanen/test.png

也可以为图片指定ALT时的文字,格式为[this one here|http://example.com/example.png]. 例如[Hello All|http://www.ecyrd.com/~jalkanen/test.png]显示结果:Hello All

图片可以位于Web上任意可以访问的位置,也可以是某个页面的附件,显示时使用不同的链接地址就行,譬如完整URL(http://example.com/example.png)或者附件URL(WikiPage/AttachmentName).

Inline Image有一个局限,就是只支持特定类型的图片格式,JSPWiki默认支持的图片格式是PNG,我们也可以修改配置文件jspwiki.properties来配置支持的图片类型,配置格式举例如下:

jspwiki.translatorReader.inlinePattern.1 = *.jpg
jspwiki.translatorReader.inlinePattern.2 = *.png
当前JSPWiki支持的Inline Image的格式可以参考SystemInfo.

Image Plugin

Inline Image使用简单,但没有格式控制,图片类型也受限制,另一种输出图片的方法是使用Plugin机制,具体用法参考Image Plugin.

创建超级链接

基本应用

语法: [Like this] or [Like this|link]

link可以是某个wiki页面, 例如[Rain Zhao]或[link sample to page Rain Zhao|RainZhao].

link也可以是一个完整的URL, 链接地址以下面的协议开头的将被视为外部链接, http:, ftp:, mailto:, https:, or news:. 举例, 语句 [http://java.sun.com], 将显示 http://java.sun.com/, 语句 [Java home page|http://java.sun.com], 将显示 Java home page.

页脚注释(Footnotes)

超链地址使用数字将创建一个Footnote, 例如 footnote[1], 将创建footnote[1], 也可以命名一个footnote, 格式与命名一个普通超链一样. 例如 [Footnote number 1|1]将生成[Footnote number 1], 这是另一个 footnote[2].

使用 [#1] 定义footnote, 也可以使用[footnote 1|#1]定义footnote, 上文的两个footnote定义在本页最后.

InterWiki

我们还可以定义一个超链链接到其他wiki里的某个页面. 系统里支持哪些InterWiki是在配置文件里配置的, 配置格式举例如下:

jspwiki.interWikiRef.JSPWiki = http://www.jspwiki.org/Wiki.jsp?page=%s
jspwiki.interWikiRef.Edit = Edit.jsp?page=%s
jspwiki.interWikiRef.WikiWikiWeb = http://c2.com/cgi/wiki?%s
jspwiki.interWikiRef.Google = http://www.google.com/search?q=%s
应用举例如下:
[TextFormattingRules on JSPWiki.org|JSPWiki:TextFormattingRules]
[Edit:TextFormattingRules]
输入如下:TextFormattingRules on JSPWiki.org, Edit:TextFormattingRules

InterWiki其实就是输出替换, 通过InterWiki机制我们除了链接其他wiki页面, 还可以实现一些有趣的功能, 譬如实现在新窗口里打开链接:

首先在jspwiki.properties里加入如下配置:

jspwiki.interWikiRef.newhttp=http:%s" TARGET="_new
jspwiki.interWikiRef.new = Wiki.jsp?page=%s" target="_new
然后我们在写wiki页面时,就可以选择是否在新窗口里打开新页面了,
[Foster Schucker]  -- open this wiki page in this window
[new:Foster Schucker] -- open this wiki page in a new window
[http://www.jspwiki.org] -- open this external link in this window
[newhttp://www.jspwiki.org]] -- open this external link in a new window

SystemInfo 里列出了可用的wiki.

表格相关语法

使用管道符号('|')生成表格. 使用双管道符号生成表格标题. 举例:

|| Heading 1 || Heading 2
| ''Gobble'' | Bar
| [Main]     | [SandBox]

生成表格如下,

 

Heading 1 Heading 2
Gobble Bar
Main SandBox

使用CSS样式表

Hi there!
这是一个使用CSS样式表的示例. 这里使用了样式 "commentbox", 样式定义在 "jspwiki.css" 文件里. 使用格式为 %%commentbox %%.
我们可以使用CSS样式来输出丰富的字体颜色等各种效果,CSS可以是jspwiki.css已经定义好的样式,也可以自己定义的样式,下面是使用标准样式定义的示例:
%%small
This is small text
%%
样式 "small" 必须在文件 jspwiki.css 里定义. 这种用法要求wiki页面作者清楚管理员提供了哪些CSS样式, 提供的CSS样式在各个站点可能是不同的.

下面是使用自己定义的CSS样式:

%%( font-size: 150%; color: red; )
Hello, world!
%%
输出如下:
Hello, world!

使用变量

在JSPWiki里,有一些系统定义好的或者用户自定义的变量,我们可以在自己的Wiki页面里读取并显示这些变量. 基本格式为: [{$variablename}]

除了在页面里显示一个已有变量, 还可以在页面里使用SET定义页面变量, 基本格式为: [{SET name=value}]

JSPWiki Variables介绍了关于变量的详细信息, JSPWiki MetaData介绍了SET的详细用法.

注意: 变量名是不区分大小写的, "paGeNamE" 与 "PageName" 表示相同的变量.

使用Plugin

使用Plugin的基本格式如下:

[{INSERT <plugin class=""></plugin> WHERE param1=value, param2=value, ...}]

JSPWiki Plugins详细介绍了Plugin的用法.


[#1] Here's the footnote I mentioned.

[The other footnote] The other footnote. Note how it's name is different?

 


分享到:
评论

相关推荐

    基于Wiki协作系统的学科知识库构建

    在收集阶段, Wiki 协作系统可以快速聚集大量社群知识;在组织阶段, Wiki 协作系统可以自动对信息进行分类和索引;在共享阶段, Wiki 协作系统可以提供个性化的信息服务,实现知识的共享和传播。 此外,文章还对 ...

    vimwiki使用参考

    Vimwiki是一个强大的文本编辑器 Vim 的插件,它允许用户创建个人的...提供的"vimwiki参考"文件将帮助你深入理解并熟练运用vimwiki的各项功能。在实际操作中,不断探索和调整设置,使其完全适应自己的工作和学习需求。

    Google语法高亮JavaScript功能

    3. **教程文档**:Wiki教程文档详细介绍了如何配置和自定义语法高亮,包括选择主题、添加新的语言支持、处理代码折叠等功能,对于开发者来说是十分宝贵的参考资料。 **使用方法** 要使用Google语法高亮JavaScript...

    DokuWiki v2023.04.04.tgz

    DokuWiki以其无数据库依赖、强大的文本格式化和高度可定制化的特点,成为构建在线文档、毕业设计论文参考资料库和计算机案例研究的理想工具。 首先,让我们深入了解DokuWiki的核心特性。这个系统采用PHP编写,无需...

    Ansible-Wiki:Ansible Wiki

    **Ansible-Wiki:Ansible Wiki** ...总之,Ansible-Wiki是学习和研究Ansible的重要资源,它帮助用户快速上手,提升自动化技能,提高IT运维效率。无论你是初学者还是经验丰富的管理员,都能从中获益良多。

    mdwiki:简单的静态Markdown Wiki

    比如facebook,gist,google map,如果你需要这些特性,请参照原版将JS代码copy到static/js/mdwiki.js中就可以了这个wiki代码采用了marked库作为markdown的解析 See支持语法高亮和公式请参考content/index.md文件如果...

    Tcler's wiki data-开源

    Tcler's Wiki作为Tcl社区的重要组成部分,积累了大量关于Tcl的教程、示例、API文档和问题解决方案,是学习和研究Tcl不可或缺的参考资料。 项目的压缩包文件“wikit-20130705.tkd”是这个数据库的一个特定时间点快照...

    matlab教程、wiki和模板的集合,帮助您开始创建符合BIDS的数据集.zip

    MATLAB教程可能涵盖了基础语法、数据类型、控制结构、函数、绘图等方面,帮助初学者快速上手。对于高级用户,教程可能还会涉及面向对象编程、并行计算、以及如何创建自定义函数和工具箱。 接下来,BIDS标准是神经...

    wiki-list-maker:自动生成维基列表的工具

    3. **教育材料制作**:教师制作教学资源时,快速生成课程大纲或参考书目。 4. **数据分析展示**:将分析结果以清晰的列表形式呈现,便于理解和分享。 ### 结论 `wiki-list-maker`通过JavaScript的强大功能,解决...

    Private Wiki-开源

    其次,Private Wiki具备Wiki风格的编辑功能,用户可以通过简单的Markdown语法创建和编辑页面,支持链接、图片、列表等多种元素,让笔记的格式化更加轻松。同时,其内置的全文搜索功能,能够快速定位到所需的信息,极...

    luatos-wiki:luatos文档

    在 `luatos-wiki-master` 文件中,可能包含了关于 Luatos 的详细文档,如用户手册、API 参考、示例代码和教程等,这些资料将帮助你深入理解和使用 Luatos。通过阅读这些文档,你可以学习如何创建任务、使用中断、...

    D2-ReModded-Wiki:D2的公共Wiki进行了修改

    这个改造主要涉及到对原有公共Wiki的全面修订和优化,旨在提供一个更加丰富、详细且用户友好的资源平台,供玩家和开发者参考。 首先,我们要理解Wiki的本质。Wiki是一种多人协作编辑的网站系统,允许用户自由添加、...

    notes:这些是我使用Vimwiki的笔记

    Vimwiki将这种效率带入了笔记和知识管理领域,让用户能够快速创建和链接Wiki页面,这对于个人项目管理、学习笔记或日常记录都非常有用。 在Vimwiki中,你可以创建.md或.txt文件来创建新的Wiki页面。每一页都是纯...

    witzepedia:小型Wiki软件

    Go以其简洁的语法、高效的性能和内置并发支持而受到青睐,特别适合构建网络服务和轻量级应用,如`witzepedia`这样的Wiki系统。 **3. 主要特性** - **轻量级**: `witzepedia`体积小,启动快速,对硬件资源的需求较低...

    deplate:deplate是用于将类似Wiki的标记转换为乳胶,docbook,html或“ html-slides”的工具。 它支持嵌入式LaTeX代码,脚注,引文,参考书目,自动生成索引等

    Deplate是一款强大的文本转换工具,特别适用于那些熟悉Wiki标记语法的用户。它的主要功能是将这类标记语言转换成多种格式,如LaTeX、DocBook、HTML以及“html-slides”。这款工具的设计理念是为了方便用户在不同的...

    SMW quick reference

    SMW(Semantic MediaWiki)是一个扩展模块,它使得...综上所述,本文档为Semantic MediaWiki提供了一个快速参考,帮助用户快速上手并有效使用SMW扩展的各种功能,从而提高wiki站点的结构化数据管理和查询能力。

    Confluence_7-4-0用户指导和管理员手册

    - **页面编辑**:学习如何创建、编辑和版本控制wiki页面,使用富文本编辑器或Markdown语法。 - **协同编辑**:了解实时协同编辑功能,查看编辑历史,解决编辑冲突。 - **搜索与导航**:掌握Confluence的智能搜索...

    General-Resources:Wiki上的真实交易

    由于JavaScript的重要性,这个存储库中的链接和资源可能会覆盖JavaScript的基础语法、高级特性、框架(如React, Angular, Vue)、库(如jQuery, Lodash)、调试技巧、性能优化、测试策略等多个方面。 【压缩包子...

    01_Dai_ 1.Tcl_Tk 快速上手

    - **Equi4**、**SFTclproject**、**TclDeveloperSite**、**Tcler's Wiki**、**TkDoc**等站点提供了丰富的文档资料和技术交流平台。 - **ActiveTcl 8.5** 和 **Tcl/Tk 8.6** 的官方手册是学习Tcl/Tk的重要参考资料...

Global site tag (gtag.js) - Google Analytics