命令行参数
最后更新于：2022-04-01 23:14:14
## [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#asciidoc命令参数)asciidoc命令参数
~~~
--htlp 帮助
-n 自动生成标题前面的编号
~~~
';
宏
最后更新于：2022-04-01 23:14:12
## [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#宏)宏
~~~
{include:} 得到``的内容。
{sys:} 得到执行脚本命令``的标准输出。
{sys2:} 得到执行脚本命令``的标准输出和标准错误。
{sys3:} 直接输出结果不进行任何处理。
{amp} 显示字符 (&)
{asciidoc-dir} asciidoc(1)程序文件夹
{asciidoc-file} asciidoc(1)脚本的完整路径
{asciidoc-version} asciidoc(1)的版本
{author} 作者姓名
{authored} 空字符串 '' 如果 {author} 或 {email} 已经指定,
{authorinitials} 作者缩写 (from document header)
{backend-} 空字符串 ''
{-} 空字符串 ''
{backend} document backend specified by `-b` option
{backslash} 反斜杠
{basebackend-} 空字符串 ''
{doctype} 文档类型使用`-d`设置指定
{email} 作者email (from document header)
{empty} 空字符串 ''
{encoding} 指定输入输出编码
{filetype-} 空字符串 ''
{filetype} 输出文件的扩展名
{firstname} 作者名字 (from document header)
{gt} 大于号 (>)
{id} running block id generated by BlockId elements
{indir} 输出文件的文件夹名称 (note 2,5)
{infile} 输入文件名称 (note 2,5)
{lastname} 作者姓氏 (from document header)
{level} 标题级别 1..4 (in section titles)
{listindex} the list index (1..) of the most recent list item
{localdate} 当前日期
{localtime} 当期时间
{lt} 小于号 (<)
{manname} manpage name (defined in NAME section)
{manpurpose} manpage (defined in NAME section)
{mantitle} document title minus the manpage volume number
{manvolnum} manpage volume number (1..8) (from document header)
{middlename} 作者中间名 (from document header)
{nbsp} 空格
{outdir} 文档输出文件夹名 (note 2)
{outfile} 输出文件名 (note 2)
{reftext} running block xreflabel generated by BlockId elements
{revnumber} 文档修订版本号 (from document header)
{sectnum} formatted section number (in section titles)
{showcomments} 在输出文件中显示注释行
{title} 章节标题 (in titled elements)
{two_colons} 双冒号
{two_semicolons} 双分号
{user-dir} ~/.asciidoc文件夹 (如果存在)
{verbose} defined as '' if --verbose command option specified
~~~
';
标签
最后更新于：2022-04-01 23:14:10
## 标签
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#标题)标题
需要靠左边顶格
~~~
= 文档标题 (0级) =
== 段落标题 (1级) ==
=== 段落标题 (2级) ===
==== 段落标题 (3级) ====
===== 段落标题 (4级) =====
~~~
~~~
.段落，列表，表格或区块标题
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#文字格式)文字格式
下面的格式标签前后要有空格，没有空格的时候需要是双符号。
_强调_ *强调*
\'强调' '强调'
*粗体* **粗体**
+等宽字体+ 等宽字体
`等宽字体` `等宽字体` 里面的格式命令无效
\`单引号引用' `单引号引用'
\``双引号引用'' ``双引号引用''
#无格式文本# 无格式文本 里面的格式命令无效
[字体CSS颜色,背景CSS颜色,文字em大小] 使用在格式前面可以显示颜色和大小可以使用[,,2]的形式
^上标\^ 上标
~下标\~ 下标
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#特殊符号)特殊符号
(C) © 版权
(TM) ™ 商标
(R) ® 注册商标
-- -- 破折号
... …省略号
-> → 右箭头
<- ← 左箭头
=> ⇒ 右双箭头
<= ⇐ 左双箭头
➊ ➊
¶ ¶
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#文本块样式)文本块样式
~~~
////
CommentBlock（注释块）不输出到目标文件
////
~~~
~~~
++++
PassthroughBlock，不转换内部的特殊字符
++++
~~~
~~~
----
ListingBlock（清单块）
用于计算机的输出和文件列表。也可用于程序代码。里面特殊字符不替换。
----
~~~
~~~
....
LiteralBlock（文字块）
就像普通文字段落，保留了空格，使用[listing]块标题可以在内部引用其他块样式。
....
~~~
~~~
****
SidebarBlock（侧边栏）
有边框和背景
****
~~~
~~~
____
QuoteBlock（引用块）
____
~~~
~~~
====
ExampleBlock（例子块）
会使用数字编号的例子标题[caption="例1: "]
可以使用NOTE, TIP, IMPORTANT, WARNING, CAUTION标题[NOTE]表示提示块
====
~~~
~~~
--
OpenBlock（开放块）
--
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#提示段落)提示段落
'Tip’提示, 'Note’注意, 'Important’重要, 'Warning’警告 和 'Caution’警示。例子：
~~~
NOTE: 这是一个注意的例子。
~~~
或使用替代语法:
~~~
[NOTE]
这是一个注意的例子。
~~~
|
提示
| 如果警告多于一个段落使用警告段落替代. |
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#警告图标和标题)警告图标和标题
|
注意
| 警告可以定制 `icons`, `iconsdir`, `icon` 和 `caption` 参数。 |
默认生成文本标题替换图标链接，生成图标链接需要使用`-a icons`命令行参数。 你可以使用`icon`参数制定图标的路径。例如：
~~~
[icon="./images/icons/wink.png"]
NOTE: What lovely war.
~~~
使用 `caption` 参数定义警告标题下例屏蔽图标并定义了注释警告的标题（在警告图标设置为可用时`icons` 参数必须设置为`icons=None`）：
~~~
[icons=None, caption="特殊提示"]
NOTE: This is my special note.
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#列表)列表
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#无序列表)无序列表
~~~
- List item.
* List item.
** List item.
*** List item.
**** List item.
***** List item.
~~~
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#有序列表)有序列表
手动序号序号使用下面一种
~~~
1\. 阿拉伯数字标注的列表项目.
a. 小写字母标注的列表项目.
F. 大写字母标注的列表项目.
iii) 小写罗马数字标注的列表项目.
IX) 大写罗马数字标注的列表项目.
~~~
自动符号列表项目是1-5个句点，跟着是一些空格和文本。句点个数表示级别。例如：
~~~
. 阿拉伯数字标注的列表项目.
.. 小写字母标注的列表项目.
... 小写罗马数字标注的列表项目.
.... 大写字母标注的列表项目.
..... 大写罗马数字标注的列表项目.
~~~
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#定义列表)定义列表
字母或数字开始1-4个冒号或两个分号结束。
~~~
项目1::
项目2::
项目说明.
项目说明.
项目3:: 项目说明.
* 列表项.
* 列表项.
项目4::
说明1.
二级项目;;
二级说明.
二级项目;;
二级说明.
二级项目;;
二级说明.
三级项目::: 三级说明.
三级项目::: 三级说明.
*水平项目*:: 水平说明.
水平说明.
~~~
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#问答列表)问答列表
~~~
[qanda]
问题1::
答案1.
问题2::
答案2.
~~~
#### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#专业术语列表)专业术语列表
~~~
[glossary]
术语1::
解释1.
术语2::
解释2.
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#脚注)脚注
~~~
A footnote footnote:[An example footnote.];
a second footnote with a reference ID footnoteref:[note2,Second footnote.];
finally a reference to the second footnote footnoteref:[note2].
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#超链接)超链接
'http'，'https'，'ftp'，'file'，'mailto’和’callto’超链接。直接书写就行，参数是显示名称，空格使用%20。
~~~
http://www.methods.co.nz/asciidoc/[The AsciiDoc home page]
http://www.methods.co.nz/asciidoc/
mailto:joe.bloggs@foobar.com[email Joe Bloggs]
joe.bloggs@foobar.com
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#锚点)锚点
~~~
锚点：[[A88]]
~~~
~~~
链接：<>
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#图片)图片
~~~
image:images/logo.png["Company Logo",height=32,link="screen.png",scaledwidth="75%"align="left"]
~~~
### [](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#表格)表格
~~~
[width="40%",cols="^,2m",frame="topbot",options="header,footer"]
|======================
|Column 1 |Column 2
|1 |Item 1
|2 |Item 2
|3 |Item 3
|6 |Three items
|======================
~~~
~~~
表格参数：
~~~
~~~
frame边框topbot(上和下)，all(全部边，默认), none and sides (左和右)。
align对齐left，right和center。
options选项header（有标题）footer（有底部）
width宽度1-99%
~~~
~~~
行参数：
~~~
~~~
[*][][][