avatar
匿名用户
×
创建一个新的页面
输入页面标题:
目前语音维基上有1970个页面。 在上方输入您想创建的页面名称或单击以下标题之一,即可开始撰写!



语音维基

“帮助:Wiki语法入门”的版本间的差异

(更新代码块相关语法以及颜色的示例)
 
(未显示1个用户的7个中间版本)
第1行: 第1行:
欢迎参与语音维基的编辑!在开始编辑前,您需要学习Wiki语法,本文将指导您如何使用Wiki语法。
+
欢迎参与语音维基的编辑!在开始编辑前,您需要学习Wiki语法,本文将指导您如何使用Wiki语法。如果您有HTML语法基础,接下来的学习会轻松很多。
  
 
==字形==
 
==字形==
第27行: 第27行:
  
 
===颜色===
 
===颜色===
在本Wiki中,您可以使用{{tl|color}}模板改变文字前景色,{{tl|bgcolor}}模板改变文字背景色,使用方法请点击模板链接查看。这不是Wiki原有的实现方法,因此在其他Wiki上可能并不适用。
+
在本Wiki中,您可以使用 <code>{{tl|Color}}</code> 模板改变文字前景色,<code>{{tl|Bgcolor}}</code> 模板改变文字背景色,使用方法请点击模板链接查看。这不是 Wiki 原生方法,因此在其他 Wiki 上可能并不适用。
 +
 
 +
例如:
 +
 
 +
<code><nowiki>{{Color|#0af|天蓝色的文字}}</nowiki></code> 显示为:{{Color|#0af|天蓝色的文字}}
 +
<br />
 +
<code><nowiki>{{Bgcolor|#707|紫色的背景}}</nowiki></code> 显示为:{{Bgcolor|#707|紫色的背景}}
 +
 
 +
===行内代码和代码块===
 +
在 Wiki 中没有对应的便捷语法,只能通过 HTML 标签进行定义。
 +
 
 +
使用 HTML <nowiki><code></nowiki> 标签定义行内代码:
 +
 
 +
<pre>
 +
这是一段行内代码 <code>This is an inline code</code>
 +
</pre>
 +
 
 +
效果为:
 +
 
 +
这是一段行内代码 <code>This is an inline code</code>
 +
 
 +
 
 +
使用 HTML <nowiki><pre></nowiki> 标签定义一个多行代码块:
 +
 
 +
<pre>
 +
&lt;pre&gt;
 +
这是一个代码块
 +
&lt;/pre&gt;
 +
</pre>
 +
 
 +
效果:
 +
<pre>
 +
这是一个代码块
 +
</pre>
 +
 
  
 
==换行与换段==
 
==换行与换段==
第82行: 第116行:
 
需要特别注意的是:一级标题(<code><nowiki>= 一级标题 =</nowiki></code>)是给条目大标题使用的,不要随意使用。
 
需要特别注意的是:一级标题(<code><nowiki>= 一级标题 =</nowiki></code>)是给条目大标题使用的,不要随意使用。
  
(待补充)
+
当正文内容与标题足够多的情况下,系统会自动在第一个标题之前生成一个目录。
 +
 
 +
==源代码注释==
 +
如果您需要为其他编辑者留下一些信息,或者暂时删掉一段不用的代码,可以使用源代码注释功能。和HTML一样,Wiki使用这种格式注释内容:
 +
<pre>
 +
<!-- 注释内容 -->
 +
</pre>
 +
 
 +
放入注释中的内容不会被显示出来,您可以点击本页的【编辑/查看源代码】来阅读这里的隐藏信息。
 +
<!-- 恭喜您看到这里的隐藏信息了! -->
 +
 
 +
==注释&引用&参考文献==
 +
{{Main|帮助:插入注释}}
 +
 
 +
和上面的源代码注释意义不同,这里是真正意义上的注释。在Wiki中,如果要对某处添加注释,可以使用<code><nowiki><ref></nowiki></code>标签,简单使用方法如下:
 +
<pre><ref>注释内容</ref></pre>
 +
 
 +
插入注释以后,注释内容会自动在页面底部生成,当然您也可以使用<code><nowiki><references /></nowiki></code>标签手动指定注释列表生成的位置,一般放置在页面底部。
 +
 
 +
在注释中,您可以插入一段话,也可以插入一个链接。例如:
 +
 
 +
<pre>
 +
您可以点击右上角的注释角标定位到注释列表。<ref>也可以点击左侧的箭头返回注释的位置。</ref>您也可以在注释中插入链接。<ref>[https://en.wikipedia.org/ 维基百科]</ref>
 +
</pre>
 +
 
 +
您可以点击右上角的注释角标定位到注释列表。<ref>也可以点击左侧的箭头返回注释的位置。</ref>您也可以在注释中插入链接。<ref>[https://en.wikipedia.org/ 维基百科]</ref>
 +
 
 +
==注释示例==
 +
<references />
 +
 
 +
==模板==
 +
繁琐重复的代码不利于理解和维护,如果将其包装为一个模板,就可以方便的使用,同时也更利于理解。在语音维基中,模板是一种重要的工具。
 +
 
 +
上文中提到的{{tl|Color}}就是一种模板。同样的,把这个模板以特定格式显示在这里的{{tl|tl}}模板也是一种模板。如果点击前面的模板链接,可以看到模板的页面地址格式是“模板:''模板名''”。
 +
 
 +
如果我们把{{tl|tl}}拆开来可以看到以下代码:
 +
<pre>
 +
&#123;&#123;{{ {{{|safesubst:}}}#if:{{{3|}}}|{{{3|}}}:|}}[[{{ {{{|safesubst:}}}ns:Template}}:{{{1}}}|{{{1}}}]]{{ {{{|safesubst:}}}#if:{{{2|{{{arg|}}}}}}|{{!}}{{{2|{{{arg}}}}}}}}&#125;&#125;
 +
</pre>
 +
 
 +
显然这段代码十分不利于阅读、使用和维护,而模板的作用就是简化这一过程。
 +
 
 +
事实上,如果你急于完成入门学习的话,这个章节可以以后再看,因为模板文档会告诉你如何使用模板,例如{{tl|color}}。
 +
 
 +
===使用模板和赋予参数===
 +
 
 +
例如,我们可以这样使用这个模板:<code><nowiki>{{tl|color}}</nowiki></code> 来显示这样的效果:{{tl|color}}
 +
 
 +
在上面这个例子中,名为tl的模板接受了一个参数:color
 +
 
 +
当然模板还可以接受更多的参数,例如:<code><nowiki>{{tl|Color|#fff}}</nowiki></code> 显示为:{{tl|Color|#fff}}
 +
 
 +
模板也可以不接受参数,就像这样:{{tl|color}}
 +
 
 +
当然,这么做对于一些必须接受参数的模板来说会出现问题,不过也有些模板不需要接受参数就可以使用。
 +
 
 +
那么问题来了:我不想指定第一个参数,只想指定第二个参数,该如何编写呢?方法很简单:<code><nowiki>{{tl|2=#FFF}}</nowiki></code>
 +
 
 +
“2”代表第二个参数,因为这个参数没有被命名,所以称之为匿名参数。使用等于号将右侧的内容赋值给这个参数。
 +
 
 +
总而言之,使用匿名参数的模板的使用方式可总结为:
 +
 
 +
<pre>
 +
{{模板名}}
 +
{{模板名|参数1}}
 +
{{模板名|参数1|参数2}}
 +
{{模板名|1=参数1|2=参数2}}
 +
{{模板名|参数1|参数2|...|参数N}}
 +
</pre>
 +
 
 +
有匿名参数,当然也会有非匿名参数。
 +
 
 +
例如,在{{tl|Info}}模板中,定义了width、title、text等参数。使用方法为:
 +
<pre>
 +
{{info|width=50%|title=标题|text=文本}}
 +
</pre>
 +
 
 +
也可以写成多行样式,易于阅读:
 +
<pre>
 +
{{info
 +
|width=50%
 +
|title=标题
 +
|text=文本
 +
}}
 +
</pre>
 +
 
 +
需要注意的是,这些参数不能以匿名参数的方式使用,例如你不能用“1”或不填写参数名的第一个参数去指代“width”,这些模板在设计的时候可能会考虑快速使用的情况,因此具体如何使用还需阅读随附于模板页面的模板文档。
 +
 
 +
总而言之,使用非匿名参数的模板的使用方式可总结为:
 +
<pre>
 +
{{模板名}}
 +
{{模板名|参数名1=参数值1}}
 +
{{模板名|参数名1=参数值1|参数名2=参数值2}}
 +
{{模板名|参数名1=参数值1|参数名2=参数值2|...|参数名N=参数值N}}
 +
</pre>
 +
 
 +
===关于模板的一些细节===
 +
* 同一个页面中重复使用同一个模板不会产生参数冲突。<s>除非模板的设计者干了件蠢事。</s>
 +
* 模板参数支持输入多行数据。
 +
* 如果你发现匿名参数在处理多行数据时出现了点小问题,试试给他加上参数名。
 +
 
 +
==另见==
 +
* [[帮助:索引]]
 +
* [[帮助:Wiki名词解释]]
  
[[分类:编辑帮助]]
+
[[分类:Wiki帮助]]

2022年12月9日 (五) 15:31的最新版本

欢迎参与语音维基的编辑!在开始编辑前,您需要学习Wiki语法,本文将指导您如何使用Wiki语法。如果您有HTML语法基础,接下来的学习会轻松很多。

字形

粗体与斜体

粗体与斜体使用英文单引号标记,粗体是三个单引号,斜体是两个单引号,使用方法如下所示:

'''粗体'''
''斜体''
'''''粗体和斜体'''''

其表现效果为: 粗体 斜体 粗体和斜体

下划线和删除线

在Wiki中,下划线和删除线使用HTML标签:

<u>下划线</u>
<s>删除线</s>

效果为: 下划线 删除线

颜色

在本Wiki中,您可以使用 {{Color}} 模板改变文字前景色,{{Bgcolor}} 模板改变文字背景色,使用方法请点击模板链接查看。这不是 Wiki 原生方法,因此在其他 Wiki 上可能并不适用。

例如:

{{Color|#0af|天蓝色的文字}} 显示为:天蓝色的文字
{{Bgcolor|#707|紫色的背景}} 显示为:紫色的背景

行内代码和代码块

在 Wiki 中没有对应的便捷语法,只能通过 HTML 标签进行定义。

使用 HTML <code> 标签定义行内代码:

这是一段行内代码 <code>This is an inline code</code>

效果为:

这是一段行内代码 This is an inline code


使用 HTML <pre> 标签定义一个多行代码块:

<pre>
这是一个代码块
</pre>

效果:

这是一个代码块


换行与换段

在Wiki上,需要使用<br>标签换行,但不会起一个新的段落,这不适用于一般的文章换行。因此,更多情况下应该使用两次回车换行:

第一段落  <-- 这里一个回车
  <-- 这里又一个回车
第二段落

换行与换段的区别可以在垂直间距上看出来:

你看现在这里起了一个新的段落。
这里换行了,但是没有起一个新的段落。

这又是一个新的段落。

链接

主页面:帮助:插入链接

内部链接

如果需要引用Wiki内部的链接,需要使用两对方括号[[]],具体操作方法如下:

[[页面完整名称]]
[[页面完整名称|显示名称]]

例如在这里插入一个首页的链接:首页

还是首页链接,但是改一下显示名称:Mainpage

外部链接

和插入外部链接类似,仅需使用一对方括号[[]],具体操作方法如下:

[URL地址]
[URL地址 显示名称]

例如插入维基百科的链接:[1] ←如果不写任何名称,链接将会开始编号。

为其添加显示名称:维基百科

另外,外部链接也可以直接插入不做任何修饰:https://en.wikipedia.org/

标题&章节

如您所见,这篇文章的层次结构清晰,正是因为↑↑↑这个标题的功劳。您可以使用英文等号制作标题,方法如下:

== 二级标题 ==
=== 三级标题 ===
==== 四级标题 ====
===== 五级标题 =====

等号与内容之间的空格仅仅是为了代码好看,没有实际作用。

需要特别注意的是:一级标题(= 一级标题 =)是给条目大标题使用的,不要随意使用。

当正文内容与标题足够多的情况下,系统会自动在第一个标题之前生成一个目录。

源代码注释

如果您需要为其他编辑者留下一些信息,或者暂时删掉一段不用的代码,可以使用源代码注释功能。和HTML一样,Wiki使用这种格式注释内容:

<!-- 注释内容 -->

放入注释中的内容不会被显示出来,您可以点击本页的【编辑/查看源代码】来阅读这里的隐藏信息。

注释&引用&参考文献

主页面:帮助:插入注释

和上面的源代码注释意义不同,这里是真正意义上的注释。在Wiki中,如果要对某处添加注释,可以使用<ref>标签,简单使用方法如下:

<ref>注释内容</ref>

插入注释以后,注释内容会自动在页面底部生成,当然您也可以使用<references />标签手动指定注释列表生成的位置,一般放置在页面底部。

在注释中,您可以插入一段话,也可以插入一个链接。例如:

您可以点击右上角的注释角标定位到注释列表。<ref>也可以点击左侧的箭头返回注释的位置。</ref>您也可以在注释中插入链接。<ref>[https://en.wikipedia.org/ 维基百科]</ref>

您可以点击右上角的注释角标定位到注释列表。[1]您也可以在注释中插入链接。[2]

注释示例

  1. 也可以点击左侧的箭头返回注释的位置。
  2. 维基百科

模板

繁琐重复的代码不利于理解和维护,如果将其包装为一个模板,就可以方便的使用,同时也更利于理解。在语音维基中,模板是一种重要的工具。

上文中提到的{{Color}}就是一种模板。同样的,把这个模板以特定格式显示在这里的{{tl}}模板也是一种模板。如果点击前面的模板链接,可以看到模板的页面地址格式是“模板:模板名”。

如果我们把{{tl}}拆开来可以看到以下代码:

{{{{ {{{|safesubst:}}}#if:{{{3|}}}|{{{3|}}}:|}}[[{{ {{{|safesubst:}}}ns:Template}}:{{{1}}}|{{{1}}}]]{{ {{{|safesubst:}}}#if:{{{2|{{{arg|}}}}}}|{{!}}{{{2|{{{arg}}}}}}}}}}

显然这段代码十分不利于阅读、使用和维护,而模板的作用就是简化这一过程。

事实上,如果你急于完成入门学习的话,这个章节可以以后再看,因为模板文档会告诉你如何使用模板,例如{{color}}。

使用模板和赋予参数

例如,我们可以这样使用这个模板:{{tl|color}} 来显示这样的效果:{{color}}

在上面这个例子中,名为tl的模板接受了一个参数:color

当然模板还可以接受更多的参数,例如:{{tl|Color|#fff}} 显示为:{{Color|#fff}}

模板也可以不接受参数,就像这样:{{color}}

当然,这么做对于一些必须接受参数的模板来说会出现问题,不过也有些模板不需要接受参数就可以使用。

那么问题来了:我不想指定第一个参数,只想指定第二个参数,该如何编写呢?方法很简单:{{tl|2=#FFF}}

“2”代表第二个参数,因为这个参数没有被命名,所以称之为匿名参数。使用等于号将右侧的内容赋值给这个参数。

总而言之,使用匿名参数的模板的使用方式可总结为:

{{模板名}}
{{模板名|参数1}}
{{模板名|参数1|参数2}}
{{模板名|1=参数1|2=参数2}}
{{模板名|参数1|参数2|...|参数N}}

有匿名参数,当然也会有非匿名参数。

例如,在{{Info}}模板中,定义了width、title、text等参数。使用方法为:

{{info|width=50%|title=标题|text=文本}}

也可以写成多行样式,易于阅读:

{{info
|width=50%
|title=标题
|text=文本
}}

需要注意的是,这些参数不能以匿名参数的方式使用,例如你不能用“1”或不填写参数名的第一个参数去指代“width”,这些模板在设计的时候可能会考虑快速使用的情况,因此具体如何使用还需阅读随附于模板页面的模板文档。

总而言之,使用非匿名参数的模板的使用方式可总结为:

{{模板名}}
{{模板名|参数名1=参数值1}}
{{模板名|参数名1=参数值1|参数名2=参数值2}}
{{模板名|参数名1=参数值1|参数名2=参数值2|...|参数名N=参数值N}}

关于模板的一些细节

  • 同一个页面中重复使用同一个模板不会产生参数冲突。除非模板的设计者干了件蠢事。
  • 模板参数支持输入多行数据。
  • 如果你发现匿名参数在处理多行数据时出现了点小问题,试试给他加上参数名。

另见