Richard Markup 帮助文档

Richard Markup 帮助文档

v1 | v2 | v3 | v4

Richard Markup 只有 v1 不完整地实现过，其他三个版本并未实现。

Richard Markup 是我专为 Richard （@天府灵山行者）的互动式小说设计的一种文本标记语言，它注重剧情逻辑，而数据存储、用户界面由解释器完成。

文件结构

Richard Markup 存储为.richard扩展名的文件，格式与 HTML 和 XML 有些相似，使用 UTF-8 或 GB-18030 编码。

文件的开头是头部信息，它写在<? ?>之间：

<?richard-markup v1?>

其中v1是文件格式的版本号。

随后的内容是正文，由文本、元素、注释组成。

文本是除元素、注释外的文字内容，它会逐字显示在控制台上，一般每显示完一行后用户可以按任意键继续，并可以在逐字显示的过程中按任意键跳过。

元素会改变文本的行为。在 Richard Markup 中，元素有类型、属性、内容，其中只有类型是必须的。

类型可以包含英文字母、横杠-、下划线_、冒号:，但只能以英文字母开头；内容可以是纯文本，也可以包含其他元素。

每个属性有属性键和属性值，属性键是必须的。如果没有值，直接写属性键即可；如果有值，用属性键="属性值"表示，如果属性值中没有换行、空格、大于号>、斜杠/，可以省略引号。

当元素没有内容时，用自闭合标签<类型/>表示，如果有属性，它们依次跟在类型之后，用空格隔开：

<类型 属性=值 属性.../>

如果元素有内容，就把内容写在开始标签<类型>和结束标签</类型>之间，如果有属性，就写在开始标签的类型之后，用空格隔开：

<类型 属性=值 属性...>内容</类型>

当然，也可以让开始标签和结束标签单独占一行：

<类型 属性=值 属性...>
    内容
</类型>

解释器会在运行前先去掉多余的换行和空格：行首的空格会被忽略，并且如果一个自闭合标签、开始标签或结束标签或注释独占一行，那么紧挨在它们后面的换行会被忽略。

在 Richard Markup 中，每种元素要么必须有内容，要么不能有内容。所以对于不能有内容的元素类型， Richard Markup 规定它们的自闭合标签中的斜杠可以省略：<类型>。

注释会被 Richard Markup 解释器直接忽略。与 HTML 和 XML 一样，它这样表示：

<!-- 注释内容 -->

Richard Markup 中的元素

<s>元素

<s>元素代表文本片段，它必须有内容。

可以有一个name属性，指定片段的名称。也可以指定color属性来改变片段中文字的颜色：

<s name="welcome">
    欢迎来到<s color="#33bfab">灵魂小站</s>！
</s>

<a>元素

<a>元素代表锚点（Anchor），它不能有内容。

可以有一个name属性指定锚点的名称。另外也可以设置一个call属性，值是另一个有内容的元素的name，这样来重复使用那个元素。例如：

Love with <s name="richard" color="#baf">Richard</s> under epidemic
8B班同学<a call="richard">。

新增 <def>元素

<def>元素专门用来定义需要重复使用的子程序（函数）。可以直接在它里面写若干个有name属性的元素，然后在其他地方用call属性来调用。如果程序在正常按顺序运行时，中途遇到<def>元素，会直接跳过。

<def>
    <s name="richard" color="#baf">Richard</s>
    <s name="sunny" color="#daf">Sunny</s>
    <s name="separator">
        Love with <a call="richard"> under epidemic
        ♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡♡
    </s>
</def>

<choices>、<choice>和<prompt>元素

<choices>代表一个互动选择题，它的内容是一个可省略的<prompt>和若干个<choice>。可以给<choices>指定name属性。

<prompt>表示选择题的提示文本；<choice>表示一个选项，它的内容是选项的文案。可以有一个goto属性，指定当选项被选定后要跳转到的位置。

<?richard-markup v1?>
Hello, world!
<choices>
    <prompt>Are you...</prompt>
    <choice goto="roy">Roy</choice>
    <choice goto="richard">Richard</choice>
    <choice>Neither</choice>
</choices>
<def>
    <s name="youare_roy">
        Hi, <s color=12>Roy</s>!
    </s>
    <s name="youare_richard">
        Hello <s color=15>Richard</s>!
    </s>
    <s name="youare_neither">
        Hello... whoever you are!
    </s>
</def>

---

另外，还可以用<script>元素来嵌入JavaScript代码。

if、else和set属性

除了上文提到的属性之外，还可以给元素添加if、else和set属性。

set属性用来存储和修改变量。变量名可以由英文字母、数字、下划线组成，但不能以数字开头。目前变量只能是浮点数。set属性像这样表示：set="变量名 = 表达式"。

set属性单独不会对剧情造成影响，要配合if和else属性使用。这两个属性用来控制元素是否会运行。else属性没有值，直接在开始标签中写else即可；if属性的值是一个表达式，像这样：if="表达式"。带else的元素必须跟在带if的元素后面；可以连用else和if来达到“elif”的效果。

如果给定的条件成立（表达式的结果不是0），元素的内容、上面的goto和set属性会正常运行；否则整个元素会被跳过。如果是<choice>，则控制的是这个选项是否会显示。

元素上的属性总是按“else——if——set——call”的顺序执行，无论它们实际出现的顺序。

表达式中可以使用数字字面量（如123）、其他变量、运算符和圆括号。可用的运算符有：

1. 乘除运算符：乘*、除/、取模%；
2. 加减运算符：加+、减-；
3. 比较运算符：等于==、大于>、小于<、大于或等于>=、小于或等于<=、不等于!=；
4. 逻辑运算符：与and、或or。

在不加括号的情况下，运算顺序就按以上四类的顺序进行，且and比or先进行。

如果一个变量还没有创建，默认它的值是0。

<?richard-markup v1?>
<a set="crap = 20">
<choices>
    这是一道选择题
    <choice set="crap = crap + 40">az</choice>
    <choice set="crap = crap * 4">az</choice>
    <choice set="crap = crap - 10">az</choice>
</choices>
<s if="crap < 20">
    crap现在小于20
</s>
<s elif="crap < 60">
    crap现在大于或等于20，小于60
</s>
<s else>
    crap现在大于或等于60
</s>

建议使用一个_choice变量来存储选择的选项，代替goto：

<?richard-markup v1?>
<choices>
    <prompt>Are you...</prompt>
    <choice set="_choice = 1">Roy</choice>
    <choice set="_choice = 2">Richard</choice>
    <choice set="_choice = 3">Neither</choice>
</choices>
<s if="_choice == 1">
Hi, <s color=12>Roy</s>!
</s>
<s elif="_choice == 2">
Hello <s color=15>Richard</s>!
</s>
<s else>
Hello... whoever you are!
</s>

以上就是 Richard Markup 帮助文档的全部内容了。由于解释器还没有完全实现，此文档以后还可能会修改。

---

原文发布于2020年12月8日