前言
Writerside支持使用Markdown及XML进行主题(Topic)的编写，其中Markdown的语法除了稍作增添(增加了例如style等的参数)没有太大变化，所以这次是列举支持的XML语法~
Topic设置
1.link-summary
用于自定义在其他文章内链接本文章时出现的简述文本。如果不设置此项，默认会使用Topic的最前一部分内容。
用法示例:
<link-summary>示例</link-summary>2.title
用于设定您的Topic标题(会影响其在侧边栏目录显示的标题, 但不会改变其的URL, 因为URL取决于Topic文件名~当然也有相应的方式去设置URL显示的名称, 如xmsh8pro.html)
用法示例:
<title>我不是标题awa</title>3.web-file-name
用于设定Topic生成的HTML的文件名.
用法示例:
<web-file-name>document.html</web-file-name>结构
1.章节<chapter>
字面意思~
属性(常用的, 其他参数参见Jetbrains的文档:jetbrains.com/help/writerside/structural-elements.html)
title 章节的标题(必需)
id 章节的id(用于<a>链接使用anchor链接到此章节)
collapsible 设置章节是否可折叠(建议与下一个参数搭配使用), 仅支持true和false两种值
default-status 设置章节的默认状态(前提是collapsible的值为true), 仅支持true和false两种值.
Tips:章节是可以嵌套的~；你同样可以使用<title>对章节标题进行覆盖(就是似乎没啥用罢了).
以下是一个可折叠的、默认为展开的章节的示例代码:
<chapter title="I'm a chapter" id="chapter1" collapsible="true" default-state="expanded">
</chapter>2.步骤<procedures>
实际上不只是步骤, 你可以通过<procedure>的type属性更改他它的类型, 支持步骤(steps)/选择(choices)两种。
属性
type 更改procedures的类型(支持steps/choices两种值)
title procedures的标题, 可选(但如果使此元素可折叠即collapsible为true的话, 必须设置title)
collapsible 设置procedures是否可折叠(建议与下一个参数搭配使用), 仅支持true和false两种值
default-status 设置procedures的默认状态(前提是collapsible的值为true), 仅支持true和false两种值.
id procedures的ID, 用于anchor链接.
下面是一个类型为"步骤"的procedures示例(来自官方文档):
<procedure title="Add something" id="procedure-id">
<p>Before adding something, create it.</p>
<step>Do this.</step>
<step>Do that.</step>
<p>Congratulation! You've added something.</p>
</procedure>3.段落<p>
段落本身没有什么好说的(你可以直接向其中添加文字), 这里主要讲其内部允许的一些元素.
超链接<a>(非独有, 可用于其他地方)
你可以在段落中插入超链接.其用法稍后讲解.
加粗字体<control>(段落中独有)
这个元素可以将其内的文字加粗显示.如:
<p>
Welcome to <control>Writerside</control>
</p>倾斜字体<emphasis>
这个元素可以用斜体显示其中的文字, 如:
<p>
Welcome to <emphasis>Writerside</emphasis>
</p>用户界面路径<ui-path>
看起来似乎效果和<control>一样.但是细看还是有点不同的awa
使用 | 字符将每个UI步骤分开, 例如(来自官方文档):
<p>
Go to <ui-path>Settings/Preferences | Tools | Writerside</ui-path>.
</p>文件路径<path>
用于强调文件地址或扩展名.
例如:
<p>
Find the <path>index.html</path>
</p>快捷键<shortcut>
用于显示快捷键.
可以通过两种方式实现.
第一种是不依靠预设key, 直接上(示例来自官方)
<p>
Press <shortcut>Ctrl+C</shortcut> to copy.
</p>第二种是依靠key来进行.此处不做过多阐述, 将会单开一期讲解.
示例(来自官方):
<p>
Press <shortcut key="$Copy"/> to copy.
</p>未完待续......
(C)2023-2024, PowerAtom知识共享计划
作者 2minRain@CTWS.APA.
