Tech Doc Help

语义标记

本文介绍了 Writerside 主题文件中所有 XML 标记元素的资料。

<a>

<a> 元素用于添加指向另一个主题或任意 URL 的超链接。该链接可以是纯文本、图像、快捷方式或属性值。

链接到主题并将主题标题呈现为链接的文本:

<a href="标记.md"/>

链接到主题并指定链接的文本:

<a href="标记.md">指定标记超链接的文本</a>

链接到目标主题中的特定锚:

锚点是目标主题中的一个标记,用于指定目标主题中的特定位置。锚点的名称由id属性指定。例如在标记 文档当中的Markdown vs 语义标记 标题创建了锚点: ## Markdown vs 语义标记 {id="markdown_vs_semantic_markup"} ,然后在本文中使用锚点:

<a href="标记.md" anchor="markdown_vs_semantic_markup">标记#Markdown vs 语义标记</a>

code

锚点可以是任何元素的 id 属性,也可以是带有名称的显式 <anchor> 元素。

当链接到同一主题内的锚点时,可以省略 href 属性。

设置 nullable="true"后,如果在构建文档时目标主题不可用,则只显示链接文本而不显示实际的超链接。否则,目标主题必须存在。

要添加外部超链接,请在href属性中指定完整的目标URL:

<a href="https://www.jetbrains.com">Link to the JetBrains website</a>
父元素

<category> <chapter> <def> <if> <li> <p> <snippet> <step> <tab> <td> <title> <topic>

子元素

<icon> <img>

属性

anchor

指定目标主题中元素的 ID。例如,如果想链接到特定章节,也可以使用标准的 URL 符号作为锚点:

<a href="语义标记.md#anchor_a"/>
filter

为元素指定自定义过滤器。在定义 <snippet> 时,可根据某些标准筛选出内容,然后在 <include> 上指定 use-filter 属性,以便在不同上下文中重复使用此片段。

href

指定链接目标:主题文件名或外部 URL。

id

为元素指定一个标识符:

这是一个id=intro的锚点.

<p id="intro">这是一个id=intro的锚点.</p>

你可以将此标识符用作链接的锚点:

<a href="语义标记.md" anchor="intro">链接【intro】锚点</a>

<category>

<category> 元素用于指定主题的类别。类别是主题的一种逻辑组织方式,用于帮助用户在文档中快速找到所需的信息。

<chapter>

<chapter> 元素用于指定主题的章节。章节是主题的一种逻辑组织方式,用于帮助用户在文档中快速找到所需的信息。

<def>

<def> 元素用于定义术语。定义术语是指在文档中对术语进行解释和说明。

<if>

<if> 元素用于指定条件。条件是指在文档中对条件进行解释和说明。

<li>

<li> 元素用于指定列表项。列表项是指在文档中对列表项进行解释和说明。

<p>

<p> 元素用于指定段落。段落是指在文档中对段落进行解释和说明。

<snippet>

<snippet> 元素用于指定代码片段。代码片段是指在文档中对代码片段进行解释和说明。

You can change the following settings:

百度[filter_a]

百度[filter_b]

百度[filter_c]

<step>

<step> 元素用于指定步骤。步骤是指在文档中对步骤进行解释和说明。

<tab>

<tab> 元素用于指定选项卡。选项卡是指在文档中对选项卡进行解释和说明。

<td>

<td> 元素用于指定表格单元。表格单元是指在文档中对表格单元进行解释和说明。

<title>

<title> 元素用于指定标题。标题是指在文档中对标题进行解释和说明。

<topic>

<topic> 元素用于指定主题。主题是指在文档中对主题进行解释和说明。

<icon>

<icon> 元素用于指定图标。图标是指在文档中对图标进行解释和说明。

<img>

<img> 元素用于指定图像。图像是指在文档中对图像进行解释和说明。

<include>

<include> 元素用于指定包含。包含是指在文档中对包含进行解释和说明。

You can change the following settings:

百度[filter_a]

百度[filter_c]

Last modified: 16 March 2024