[WIP] writing frontend docs

PrepPipe · Dec 18, 2024 · 969c8f6 · 969c8f6
1 parent 40edc8c
commit 969c8f6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/zh/index.md b/docs/zh/index.md
@@ -10,6 +10,7 @@
 语涵编译器是一个开源免费的项目，除了来自第三方的内容外，所有内容（包括代码和美术素材等）都可以随意使用，可以商用。
 
 进入详细文档请在本页面左侧选择对应标题。
+如果这是您初次阅读阅读本文档，建议按照左侧列表从上到下的顺序进行阅读。十分建议您尝试“快速上手”中的样例来更好地了解本项目。
 
 
 

diff --git a/docs/zh/intro/functionality.md b/docs/zh/intro/functionality.md
@@ -95,3 +95,5 @@ graph LR
   * 前端剧本读取、解析、自动演出：语涵编译器可以读取符合[剧本格式要求](../script/overview.md)的剧本，以此生成游戏工程文件。剧本内可以引用素材库中的内容。
   * 中端分析优化工具：语涵编译器可以分析剧本并生成报告，用以引导制作者进行迭代。详情请见[中端工具总览](../middleend/overview.md)。
   * 后端工程导出：语涵编译器目前可以生成 [Ren'Py](../engine/renpy.md) 或 [WebGal](../engine/webgal.md) 的游戏工程。目前 WebGal 的支持暂时还不完整，部分功能用不了，之后会慢慢完善。
+
+前、中、后端在本文档里都有各自的部分进行介绍，详情请阅读对应章节。关于素材的使用方法将在前端部分介绍。
diff --git a/docs/zh/script/overview.md b/docs/zh/script/overview.md
@@ -1,2 +1,14 @@
 # 总览
 
+该部分将介绍与剧本读取有关的一切，主要包括剧本可以按什么格式写、有哪些命令等。
+
+## 文件读取类型
+
+语涵编译器目前接受以下输入剧本格式：
+
+  * docx 文档 (*.docx)，兼容性以 Office Word 为标准。（读取功能由 [`python-docx`](https://pypi.org/project/python-docx/) 实现。）
+  * odt 文档 (*.odt)，兼容性以 LibreOffice Writer 为标准。（读取功能由 [`odfpy`](https://pypi.org/project/odfpy/) 实现。）
+  * Markdown (*.md)，兼容性以 [GFM](https://github.github.com/gfm/) 为标准。（读取功能由 [`marko`](https://pypi.org/project/marko/) 实现。）
+  * 纯文本 (*.txt)，建议使用 UTF-8 编码。
+
+以上格式的剧本可能包含语涵编译器不支持的功能（比如内嵌文本框、内嵌音视频），程序会忽略所有不支持的功能。程序会使用部分文字样式（加粗、前景色等）、段落样式（背景色，居中）和内嵌图片等，不支持的输入格式（比如纯文本）无法直接使用此类功能，不过涉及到的功能都可以用别的方式实现。
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,6 +10,7 @@
		语涵编译器是一个开源免费的项目，除了来自第三方的内容外，所有内容（包括代码和美术素材等）都可以随意使用，可以商用。

		进入详细文档请在本页面左侧选择对应标题。
		如果这是您初次阅读阅读本文档，建议按照左侧列表从上到下的顺序进行阅读。十分建议您尝试“快速上手”中的样例来更好地了解本项目。



Expand Down