NASA-LaTeX-Docs使用手册

1. 项目目录结构及介绍

NASA-LaTeX-Docs 是一个旨在简化技术性LaTeX文档编写的开源工具包。其目录结构设计以提高可重用性和自定义能力。以下是核心的目录结构及其功能简介：

• 根目录:

  • LICENSE: 许可证文件，遵循MIT协议。
  • README.md: 项目概述文档。
  • buildPDF.py: 核心脚本，用于构建LaTeX文档，支持OS独立运行。
  • support/: 工具与逻辑目录，包含了自动化构建流程的关键组件，用户通常无需直接修改此目录下的文件。
  • templates/: 存放各种预设的文档模板（如技术报告、技术备忘录等）。

• 示例或新建文档目录（例如在MyDocument/中）：

  • MyDocument.tex: 主LaTeX文件，整个文档的核心。
  • bib/: 参考文献文件夹。
  • fig/: 图像文件夹，存放所有文档相关的图形与图片。
  • tex/: LaTeX片段文件夹，用于组织文档的不同部分。
  • tmp/: 自动生成的临时构建文件夹，存储编译过程中产生的中间文件和日志。

2. 项目的启动文件介绍

建立新文档的主要步骤涉及buildPDF.py

• 功能: 此Python脚本是构建任何LaTeX文档的心脏，它利用latexmk进行高效的编译，并且提供了一键构建的功能，能够自动处理文档、参考文献、图表等的编译，并在完成后汇总警告和错误信息。

• 使用命令:

  path/to/nasa-latex-docs/support/buildPDF.py --new <PATH TO NEW DOCUMENT>
  

  例如:

  path/to/nasa-latex-docs/support/buildPDF.py --new ~/Desktop/MyDocument
  

• 启动示例: 创建后，通过导航到新创建的文档目录并执行以下命令来构建文档：

  /path/to/your/document/support/buildPDF.py MyDocument.tex
  

3. 项目的配置文件介绍

在NASA-LaTeX-Docs中，配置主要通过LaTeX文档本身的参数设定和特定的环境变量或命令行选项实现。尽管没有直接的“配置文件”如同其他软件那样明了，但在LaTeX文档的开头（.tex文件），作者可以设置一系列参数来定制文档的行为和外观，比如：

• 文档类 (\documentclass) 和对应的预设 (classoption)。
• 使用的宏包 (\usepackage) 包含定制模板提供的额外功能。
• 通过定义宏 (\newcommand) 或使用模板内置的指令来调整样式和布局。

此外，buildPDF.py脚本也接受一些命令行参数来控制构建过程，如指定是否清理临时文件，这为构建过程提供了灵活的配置方式。具体参数和选项需查阅该脚本的帮助文档或者官方的快速入门指南。

综上所述，虽然没有传统的集中式配置文件，但通过LaTeX代码的定制和脚本的参数化，实现了灵活的配置和文档个性化设置。