Skip to content
typst-doc-cnPublic

About

Typst文档本地化——上游迁移文档构建流程至Typst后的新尝试(目前随时可能强制推送,有意参与请先建issue)

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

34 Commits

Folders and files

Repository files navigation

Typst文档本地化——上游迁移文档构建流程至Typst后的新尝试

前辈创建Typst中文文档未满一年,便因更新翻译困难而中途停滞。如今上游官方迁移构建流程(#8138),中文文档业已陈旧过时,这正是再思架构、重启翻译的好时机啊。

Typst文档有以下三种来源。

  • **单独撰写:**以独立Typst文档的形式直接撰写,主要是教程和指南。

    这类文档在locale/content/**/*.typ本地化。

  • **源码注释:**在Rust源代码中以Typst格式添加注释,主要是参考手册中各种函数及其参数的文档。

    这类文档在locale/crates/**/*.rs.typ本地化,与Typst源代码对应,*.rs.typ中每项的数字表示与上一项在*.rs中相差的行数。

  • **程序计算:**由Rust程序根据类型规则推导计算,例如page.page页面尺寸的取值列表。

    这类文档大多无需翻译,不过以防万一,也准备了locale/static.typ。

无论哪类文档,都使用babel函数记录原文和翻译,其用法如下。

#babel(
  en: [
    Welcome to Typst’s documentation!
  ],
  zh-status: "need proofread",
  zh: [
    欢迎阅读Typst的中文文档!
  ],
)
  • en: […]与zh: […]分别填写英文原文与中文翻译。具体写法请参考 Typst documentation: Editing typst.app/docs - General - Typst Forum,例如@counter.display表示链接到counter.display函数。

  • zh-status表示中文翻译的状态,常用取值如下,更多细节请参考i18n-babel.py中的注释。

    flowchart LR
      not-translated[not translated<br>尚未翻译或无需翻译<br>(默认)]
      -->|机器翻译| need-proofread[need proofread<br>待校对]
      -->|人工校对| proofread[proofread<br>已校对]
      -->|另一人校对| validated[validated<br>已核对]
    
    Loading

本地预览

本地预览需要安装just、下载typst-docs CLI等准备工作,相对麻烦;一般使用 pull request 机器人即可。

just setup
just serve

TODO

  • 准备typst-docs CLI下载页面和PR机器人。

  • 统一术语。目前语法大表格、LaTeX指南、术语表并不一致。

  • 镜像链接

  • 翻译stdx.describe的title

About

Typst文档本地化——上游迁移文档构建流程至Typst后的新尝试(目前随时可能强制推送,有意参与请先建issue)

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Contributors

Languages