Skip to content

Ask_questions

Jump to bottom
sikouhjw edited this page Mar 11, 2022 · 4 revisions

为什么要有提问流程？

为了更好的解决问题，请按提问流程准备信息，不足的信息可能导致问题解决不了。

MWE（minimal working example，最小可用例）的标准准备过程

  1. LaTeX 具体问题的提问，最好能提供 MWE

    • 安装问题，例如「任何文件都无法编译」，不需要提供 MWE。
    • 提问不能只有 MWE：以文字、截图等各种方式对问题和需求的描述，也很重要。

  2. MWE (minimal working example) 的定义

    • 完整：是一个完整的、在你电脑上能编译的 LaTeX 文档（以下简称「文档」）
      • 以 \documentclass 开始，以 \end{document} 结束
    • 可复现：在你电脑上的编译结果，能复现你的问题，或体现你的需求。
    • 最小化：文档的长度尽可能短、设置尽可能简单。
      • 尽可能用发行版提供的文档类、宏包、示例图片，少依赖外部文件（见第 3 点）。
      • 尽可能使用标准文档类、调用尽量少的宏包、包含尽量少的自定义命令和正文。
    • 小结：他人复制粘贴后直接能编译、编译后能复现问题的简短例子。
    • 补充说明
      • 完整、可复现和最小化，这三点是 MWE 的构成要素。
      • 可复现最重要，其次是完整性。
      • 能力不足（而非时间不足时）时，可适当放宽对最小化的要求。
      • 准备 MWE 需要花费时间精力，但它能切实提高沟通效率，让问题更快解决。

  3. 外部文件

    • 此处指无法通过发行版安装、复现问题又必须依赖的文件。
    • 外部文件也是 MWE 的一部分，应一并提供，或它们的下载链接。
    • 常见的外部文件
      • 网上下载、他人发送的模板文件
      • 图片
      • .bib、.bst 和其他

  4. 提供方式

    • 推荐的提供方式
      • LaTeX 文档：必须为文本形式，不接受截图和照片。
      • 屏幕输出：只接受截图和屏幕录像，原则上不接受对着屏幕拍的照片。
      • 非屏幕输出：书影、手绘示意图等，接受照片。
    • 补充建议
      • 在即时通讯工具中不发过长代码。 10 行以上的代码，建议先粘贴到 https://paste.ubuntu.com/，然后提供返回的链接。
      • 提供截图和照片时，注意圈出重点，原则上不接受纯图片的提问。
      • MWE 包含多个文件时，以 zip 压缩包形式提供。

  5. 在准备 MWE 时能帮上忙的宏包

    • lipsum 和 zhlipsum，方便地输出多段预设的西文和中文文本。
    • mwe（ctan.org/pkg/mwe），提供示例图片（如 example-image.pdf）。

对于本模板的提问流程

  1. 查看 issues、discussions 和 wiki 里有无已提问的问题
  2. 提供模板版本、发行版版本、编译方式、操作系统等信息
    • 模板版本：发行版、最新版、xx-yy 日更新的版本
    • 发行版版本：texlive 2021（未更新）、texlive 2021（最新版）、texlive 2021（xx-yy 日更新全部宏包）、Overleaf
    • 编译方式：xelatex、lualatex
    • 操作系统：win 10、mac、ubuntu
  3. 描述问题
Clone this wiki locally