From a436dff623767dd2367900abae70738d1af44386 Mon Sep 17 00:00:00 2001 From: Yan Xia Date: Fri, 29 Mar 2024 00:59:17 +0800 Subject: [PATCH] chore: more natural trans of chap 1 (#20) * chore: more natural trans of chap 1 * chore: better expression * Update 1-writing.md --------- Co-authored-by: OrangeX4 <34951714+OrangeX4@users.noreply.github.com> --- README.md | 2 +- docs/tutorial/1-writing.md | 35 +++++++++++++++++------------------ 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 55d84ffd55c5..1b63951ba304 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Typst 的文档生成是与 Typst 源码紧耦合的, 具体体现在: 本地生成是非必须的, 但是它很适合你在本地查看生成的网页是否正确. -首先你需要 clone 本仓库, 并安装 `cargo` 工具链, 以及 Python 和 Python 包 `jinja2`. +首先你需要 clone 本仓库, 并安装 `cargo` 工具链, 以及 Python 和 Python 包 `jinja2` 和 `pyyaml`. ```sh # 修改了 `./docs/src` 目录则需要运行这两行命令 diff --git a/docs/tutorial/1-writing.md b/docs/tutorial/1-writing.md index 9c0d427ee99b..c0a8093bb1c3 100644 --- a/docs/tutorial/1-writing.md +++ b/docs/tutorial/1-writing.md @@ -23,7 +23,7 @@ behavior of these natural structures. _在本教程中，我们将展示与此类似的代码示例。就像在 App 中一样，第一个面板包含标记文本，第二个面板显示文稿预览。我们缩小了页面以适应示例，以便您看得更清楚。_ 下一步是添加标题并对一些文本进行强调。 -Typst 对最常见的格式使用简单的标记。要添加标题，请输入 `=` 字符，要用斜体强调某些文本，请将其括在 `[_下划线_]` 中。 +Typst 对最常见的格式使用简单的标记（markup）。要添加标题，请输入 `=` 字符，要用斜体强调某些文本，请将其括在 `[_下划线_]` 中。 ```example = Introduction @@ -48,7 +48,7 @@ Typst 将自动对项目进行编号。 + The geology ``` -如果我们想添加一个无序列表，我们使用 `-` 字符而不是 `+` 字符。 +如果我们想添加一个无序列表，则应使用 `-` 字符而非 `+` 字符。 我们还可以嵌套列表： 例如，我们可以通过缩进将无序列表作为一个子列表，添加到上面列表的第一项中。 @@ -62,7 +62,7 @@ Typst 将自动对项目进行编号。 ## 加入图表 -您认为图表对一份优秀的报告至关重要，所以让我们添加一个图表。 +您认为图片对一份优秀的报告至关重要，所以现在让我们添加一个图片。 Typst 支持 PNG、JPEG、GIF 和 SVG 格式的图像。 要将图像文件添加到项目中，请先通过单击左侧边栏中的箱子图标打开 _文件面板_ 。 在这里，您可以看到项目中所有文件的列表。 @@ -73,7 +73,7 @@ Typst 支持 PNG、JPEG、GIF 和 SVG 格式的图像。 ![Upload dialog](1-writing-upload.png) -我们之前已经看到，特定的符号（称为 _标记_ ）在 Typst 中具有特定的含义。 +我们之前已经看到，特定的符号（称为 _标记（markup）_ ）在 Typst 中具有特定的含义。 我们可以使用 `=`、`-`、`+` 和 `_` 分别创建标题、列表和强调文本。 但是，若是为我们想要插入到文档中的所有内容都设置一个特殊符号，很快语法就会变得怪异且笨拙。 为此，Typst 只为最常见的内容保留标记符号。 @@ -85,7 +85,7 @@ Typst 支持 PNG、JPEG、GIF 和 SVG 格式的图像。 ``` 通常，函数会为一组 _参数_ 生成一些输出。 -当您在标记模式中 _调用_ 函数时，读取到您输入的参数后，Typst 会将结果（函数的 _返回值_ ）插入到文档中。 +当您在标记模式中 _调用_ 函数时，在读取到您输入的参数后，Typst 会将结果（函数的 _返回值_ ）插入到文档中。 在我们的例子中， `image` 函数接受一个参数：图像文件的路径。 要在标记模式中调用函数，我们首先需要键入 `#` 字符，并且紧跟函数的名称。 然后，我们将参数括在括号中。 @@ -93,14 +93,14 @@ Typst 可识别参数列表中的许多不同数据类型， 我们的文件路径是一个较短的 [文本字符串]($str)，所以我们需要用双引号括起来。 插入的图像默认宽度为页面宽度。要更改宽度，请将 `width` 参数传递给 `image` 函数。 -这是一个 _命名_ 参数，因此被指定为 `name: value` 对。 +这是一个 _命名（named）_ 参数，因此被指定为 `name: value` 对。 如果有多个参数，则逗号分隔它们，所以我们首先需要在路径参数后面加上一个逗号。 ```example #image("glacier.jpg", width: 70%) ``` -`width` 参数是一个 [相对长度]($relative)。 +`width` 参数传入的参数表示一个 [相对长度]($relative)。 在我们的例子中，我们指定了一个百分比，确定图像应占据页面宽度的 `{70%}`。 我们也可以指定一个绝对值，如 `{1cm}` 或 `{0.7in}`。 @@ -110,7 +110,7 @@ Typst 可识别参数列表中的许多不同数据类型， 在 `figure` 函数的参数列表中，Typst 已经处于代码模式。 这意味着，您现在可以在 `image` 函数调用的前面删除井号。 -井号仅在标记模式中需要（以消除函数调用中的文本歧义）。 +井号仅在标记模式时才用的到（它被用来消除函数调用中的文本歧义）。 标题由任意标记文本组成。 为了给函数提供标记文本，我们将其括在方括号中。此被称为 _内容块_ 。 @@ -166,12 +166,12 @@ we don't take action soon! 此函数需要参考文献文件的路径。 Typst 的原生参考文献格式是 [Hayagriva](https://github.com/typst/hayagriva/blob/main/docs/file-format.md)， -但为了兼容性，您也可以使用 BibLaTeX 文件。 -由于您的同学已经完成了文献调查并向您发送了 `.bib` 文件，因此您将直接使用该文件。 +考虑到兼容性，Typst 同样支持 BibLaTeX 文件。 +由于您的同学已经完成了文献调查并向您发送了 `.bib` 文件，您可以直接使用该文件。 请在文件面板中上传文件，以在 Typst App 中访问它。 一旦文档引入了参考文献，您就可以引用它了。 -引用参考文献的语法与对标签的引用相同。一旦您第一次引用一个来源，它就会出现在您文档的参考文献部分。 +引用参考文献的语法与对标签的引用相同。在您第一次引用一个资料来源后，它就会出现在您文档的参考文献部分。 Typst 支持不同的引用和参考文献样式。有关的详细信息，请阅读 [参考]($bibliography.style)。 ```example @@ -244,7 +244,7 @@ $ 7.32 beta + ``` 并非所有数学结构都有特殊的语法。 -相反，我们使用函数，就像我们之前看到的 `image` 函数一样。 +作为替代，我们会使用函数，就像我们之前看到的 `image` 函数一样。 例如，要插入列向量，我们可以使用 [`vec`]($math.vec) 函数。 在数学模式下，函数调用不需要以 `#` 字符开头。 @@ -254,9 +254,9 @@ $ v := vec(x_1, x_2, x_3) $ 某些函数仅在数学模式下可用。 例如，[`cal`]($math.cal) 函数用于排版通常用于集合论的书法字母。 -[参考的数学部分]($category/math) 提供了数学模式提供的所有函数的完整列表。 +[参考中的数学部分]($category/math) 提供了数学模式支持的所有函数的完整列表。 -还有一件事：许多符号，如箭头，有很多变体。 +还有一件事：许多符号（如箭头）有很多变体。 您可以通过在符号名称后附加点和修饰符名称来选择这些变体： ```example @@ -268,13 +268,12 @@ $ a arrow.squiggly b $ ## 回顾 -您现在已经了解了如何在 Typst 中编写基本的文档。 -您学习了如何强调文本、编写列表、插入图像、对齐内容和排版数学表达式。 -您还了解了 Typst 的函数。 +现在您已经了解了如何在 Typst 中编写基本的文档，包括如何强调文本、编写列表、插入图像、对齐内容和排版数学表达式。 +您还了解了 Typst 的函数机制。 Typst 允许您将更多种类的内容插入到文档中，例如 [表格]($table)、[形状]($category/visualize) 和 [代码块]($raw)。 您可以仔细阅读 [参考]($reference) 以了解有关这些函数和其他函数的更多信息。 目前，您已完成报告的编写。 您已经通过单击右上角的下载按钮保存了 PDF。 -但是，您认为报告看起来不应该那么朴素。 +但您可能认为报告看起来不应该那么朴素。 在下一节中，我们将学习如何自定义文档的外观。