Merge branch 'main' of http://shenjack.top:5100/ARS/ARS-docs

readme.md

@@ -22,19 +22,36 @@ git clone http://shenjack.top:5100/ARS/ARS-docs.git
 
 在仓库的`modules`目录中，选择你所需要的模块名称，进入该文件夹，其内就包含了该模块本体。
 
-- 对于扩展名为`nbt`的模块文件，请将其复制或粘贴至`.minecraft/saves/<World Name>/generated/minecraft/structures`目录。然后，~~瑞典原神~~Minecraft，启动！进入世界后，放置结构方块，选择“加载”模式，输入文件名称，点击“加载”后，会出现一个框架，这代表模块将会生成的位置。再点一次“加载”，模块就能正确生成了。
-- 对于扩展名为`schem`的模块文件，你需要下载并启用[World Edit](https://enginehub.org/worldedit)模组。
-  - 模组文件的命名格式为`worldedit-mod-<version>.jar`。请将其复制或粘贴至`.minecraft/mods`目录。这样，进入世界时就可以使用它了。**请注意：必须提前下载并安装[Fabric](https://fabricmc.net)才会出现`mods`文件夹！**
+对于扩展名为`nbt`的模块文件，请将其复制或粘贴至`.minecraft/saves/<World Name>/generated/minecraft/structures`目录。然后，启动Minecraft，进入世界后，放置结构方块，选择“加载”模式，输入文件名称，点击“加载”后，会出现一个框架，这代表模块将会生成的位置。再点一次“加载”，模块就能正确生成了。
 
->待办：亟需完善具体使用步骤，如导入`.litematic`文件到玩家世界的方法。
+对于扩展名为`schem`的模块文件，你需要下载并启用[World Edit](https://enginehub.org/worldedit)模组。模组文件的命名格式为`worldedit-mod-<version>.jar`。请将其复制或粘贴至`.minecraft/mods`目录。这样，进入世界时就可以使用它了。**请注意：必须提前下载并安装[Fabric](https://fabricmc.net)才会出现`mods`文件夹！**
+
+你可以按照以下步骤粘贴：
+
+1. **加载原理图**：输入`/schematic load <fileName>`即可将你准备好的原理图加载。
+2. **粘贴原理图**：输入`/paste`即可完成粘贴。
+
+对于扩展名为`litematic`的模块文件，你需要下载并启用[Litematica](https://www.curseforge.com/minecraft/mc-mods/litematica)模组。模组文件的命名格式为`litematica-<version>.jar`。请将其复制或粘贴至`.minecraft/mods`目录。这样，进入世界时就可以使用它了。**请注意：必须提前下载并安装[Fabric](https://fabricmc.net)才会出现`mods`文件夹！**
+
+一旦你准备好了这些，你可以按照以下步骤使用投影：
+
+1. **打开投影**：在游戏中，默认按键“M”可以打开Litematica界面。
+2. **加载原理图**：选择“加载原理图”选项，然后从你放入的`.minecraft/schematics`目录中选择对应的`.schem`或`.litematic`文件。加载完成后，你将能在世界上预览该模块。
+3. **调整位置**：使用投影工具（通常为木棍），你可以通过按键组合来调整投影的位置和方向。例如，使用“Ctrl”+滚轮可以调整投影的高度；而使用“Alt”+滚轮则可以调整投影的层数。此外，通过手持投影工具并将模式设置为2/5/9（使用“Ctrl”+滚轮进行切换），你可以进一步微调投影的放置方式。
+4. **粘贴投影**：当一切调整完毕后，确保你手持投影工具并将模式设置至5。然后按下你在配置菜单->热键中设置的“执行操作”(execute operation)键。这将把投影粘贴到世界中。**请注意**：新安装的Litematica并没有默认的执行操作键，所以务必先进行设置。
+
+**注意**：如果你开启了版本隔离，那么上述的`.minecraft`目录将变为`.minecraft/versions/<versionName>/`。请根据你的实际游戏版本进行相应的调整。
 
 ## 贡献
 
-欢迎有志人士为这份文档的发展贡献出自己的力量。我们坚信，星星之火，可以燎原。
+我们欢迎所有对红石电路和Minecraft有兴趣的朋友为这份文档贡献自己的力量。您的每一个建议、修改和新增内容，都将帮助这份文档变得更加完善，为更多的玩家提供便利。
 
-为更好地帮助我们发展，我们需要你遵循以下约定：
+在贡献之前，请您仔细阅读以下指南，以确保您的贡献能够被顺利接受并整合到文档中：
 
-- 若有在`tags/tags`目录内添加新标签的需求，文件名应遵循`snake_case`命名法。
-- 若有在`modules`添加模块的需求，存放模块的文件夹名，单词与单词之间用短横隔开，且遵循该命名格式：`<abbr>-<h_or_v>-<lagency>-<(optional)tick>-<(Optional)appendix>`。
-  - 其中，`abbr`代表模块英文名称缩写 (全大写) ；`h_or_v`代表该模块的横竖类别，例如横式模块就写`horizontal`；`lagency`代表模块延迟；`(Optional)tick`表示模块流水周期，有则写之，否则不写；`(Optional)appendix`代表该模块的其它附加信息，同样有则写之。
-- 模块内的`README.md`编写规范详见该[issue](http://shenjack.top:5100/ARS/ARS-docs/issues/4)。其中，模块描述应当言简意赅，避免陈词滥调。
+1. **提交工单**：在添加新标签或模块之前，请先在[我们的工单系统](http://shenjack.top:5100/ARS/ARS-docs/issues)中发起一个工单。工单的标题应按照“添加 标签/模块 申请 <后缀>”的格式进行命名，其中“<后缀>”可以是简短的描述或关键词，以便我们快速了解您的需求。
+2. **说明内容**：在工单中，请详细说明您想要添加的新标签或模块的相关信息。包括标签或模块的名称、描述、用途、使用方法、相关图片等。这将帮助我们更好地理解和评估您的需求，以及后续的整合工作。
+3. **文件格式和命名**：提交的文件应遵循Markdown格式规范，并确保文件名与标签或模块的名称一致。图片文件应存放在与说明文档相同的文件夹中，并以有意义的名称进行命名。
+4. **检查内容**：在提交之前，请仔细检查您的内容，确保没有语法错误、拼写错误或其他问题。这将有助于提高文档的整体质量和可读性。
+5. **等待审核**：提交工单后，我们的团队将对您的申请进行审核。如果申请被接受，我们将尽快将您的贡献整合到文档中，并通过工单系统通知您。
+
+通过遵循以上指南，您将能够更高效地为我们贡献自己的力量，并帮助这份文档不断完善和发展。我们期待您的加入，共同为Minecraft社区做出贡献！

scripts/parse-label.py

@@ -135,7 +135,7 @@ class TagParser(Options):
                 tag_list_start, node = next(tag_list_start)
                 if tag_list_start == -1:
                     continue
-                sub_names = []
+                sub_names = [this_tag]
                 for sub_name in node['children'][1]['children']:
                     sub_names.append(get_text(sub_name))
                 self.logger.debug(f"添加 tag {this_tag} 和别名 {sub_names}")

tags/readme.md

@@ -13,15 +13,29 @@
 - [算术单元](./tags/au.md) : 具有运算功能的模块。
 - [加/减法器](./tags/adder_or_subtractor.md) : 具有加/减法功能的模块。
 - [ALU (算逻单元)](./tags/alu.md) : 算术逻辑单元
+  - 别名
+    - ALU
+    - 算逻单元
 - [显示模块](./tags/display_module.md) : 具备显示功能的模块。
+  - 别名
+    - 显示器
 - [存储模块](./tags/storage_module.md) : 具备存储功能的模块。
+  - 别名
+    - 存储
 - [数码管](./tags/digital_display.md) : 显示数字的专用模块。
 - [成品模块](./tags/completed_module.md) : 已经完成设计的模块，如CPU
 - [一级模块](./tags/primary_module.md) : 组成整个模块的次级模块。如ALU (算术逻辑单元) ，PC (程序计数器) ，MM (主存) 等。
+  - 别名
+    - 次级模块
 - [二级模块](./tags/secondary_module.md) : 次级模块的次级模块。如CCA (进位取消全加器) ，RAM (随机存储器) ，ROM (只读存储器) 等。
 - [子模块](./tags/submodule.md) : 二级模块的次级模块。如单个逻辑门，导线等。
 - [Java版](./tags/je.md) : Java版模块
+  - 别名
+    - Java
 - [基岩版](./tags/be.md) : 基岩版模块。
+  - 别名
+    - 基岩
+    - BE
 - [版本特性](./tags/version_feature.md) : 利用了版本特性的模块。
 - [2rt流水](./tags/2rt_pipeline.md) : 支持2rt流水线的模块。
 - [时序严格](./tags/strict_timing.md) : 对于电路时序要求严格的模块。
@@ -29,8 +43,3 @@
 - [静音](./tags/silent.md) : 不会发出响声的模块。
 - [单片](./tags/single_chip.md) : 1高或1宽的模块。
 - [传统红石](./tags/traditional_redstone.md) : 仅使用红石方块特性，不使用墙电，水电，树电，脚电等其他特性的模块。
-- 测试 tag
-  - 只是用来测试的
-  - 别名
-    - 测试1
-    - 测试2