Scrivener Starter 项目常见问题解决方案

Scrivener Starter 项目常见问题解决方案

scrivener_starter a Scrivener starter project that is Git friendly 项目地址: https://gitcode.com/gh_mirrors/sc/scrivener_starter

项目基础介绍

Scrivener Starter 是一个为 Scrivener 写作应用程序设计的开源项目，旨在帮助用户更好地使用 Git 进行版本控制。Scrivener 是一个面向结构化和编辑长篇作品（如小说和论文）的应用程序，主要用于组织和管理这些作品。Scrivener Starter 项目通过提供一个 Git 友好的 Scrivener 项目模板，帮助用户避免版本控制中的常见问题，如元数据污染和文件混乱。

该项目的主要编程语言是 RTF（Rich Text Format），因为 Scrivener 内部文本资产是以 ASCII 编码的 RTF 格式存储的。

新手使用注意事项及解决方案

1. 项目重命名问题

问题描述：
新手在使用 Scrivener Starter 项目时，可能会遇到项目重命名后无法正确跟踪更改的问题。

解决步骤：

1. 重命名项目文件：
   首先，将 starter.scriv 文件重命名为你自己的项目名称，例如 my_project.scriv。

2. 使用 Git 命令重命名：
   在终端中运行以下命令，确保 Git 正确跟踪重命名操作：

   git mv -- starter.scriv my_project.scriv
   git mv -- my_project.scriv/starter.scrivx my_project.scriv/my_project.scrivx
   

3. 提交更改：
   提交重命名操作，确保 Git 记录了这一更改：

   git add -u
   git commit -m "Rename the project"
   

2. 元数据污染问题

问题描述：
Scrivener 项目中包含一些临时元数据文件，这些文件可能会被误提交到 Git 仓库中，导致版本历史混乱。

解决步骤：

1. 检查 .gitignore 文件：
   确保项目中的 .gitignore 文件已经正确配置，排除不需要跟踪的元数据文件。

2. 手动清理：
   如果发现有不需要的文件被提交，可以使用以下命令手动清理：

   git rm --cached <file_name>
   

3. 提交清理操作：
   提交清理操作，确保版本历史干净：

   git commit -m "Remove unwanted metadata files"
   

3. LaTeX 构建问题

问题描述：
新手在使用 LaTeX 构建管道时，可能会遇到编译错误或样式问题。

解决步骤：

1. 检查 MultiMarkdown 编译设置：
   在 Scrivener 中，选择 File → Compile → Compile For → MultiMarkdown，确保编译设置正确。

2. 使用 Makefile 进行进一步处理：
   使用项目中提供的 Makefile 文件，将 MultiMarkdown 文件进一步处理为 PDF：

   make
   

3. 自定义 LaTeX 样式：
   如果需要自定义样式，可以编辑 mmd/preamble.mmd 文件和 tex/latex 目录中的支持文件，确保样式符合需求。

通过以上步骤，新手可以更好地使用 Scrivener Starter 项目，避免常见问题，提高工作效率。

scrivener_starter a Scrivener starter project that is Git friendly 项目地址: https://gitcode.com/gh_mirrors/sc/scrivener_starter