Obsidian-LaTeX 定理方程引用器使用教程

Obsidian-LaTeX 定理方程引用器使用教程

1. 项目目录结构及介绍

obsidian-latex-theorem-equation-referencer 项目目录结构如下：

obsidian-latex-theorem-equation-referencer/
├── src/                      # 源代码文件夹
│   ├── __init__.py           # 初始化文件
│   ├── core.py               # 核心功能实现
│   └── utils.py              # 工具函数
├── tests/                    # 测试文件文件夹
│   ├── __init__.py
│   └── test_core.py
├── .gitignore                # Git 忽略文件
├── README.md                 # 项目说明文件
└── setup.py                  # 安装配置文件

1.1 源代码文件夹（src）

• __init__.py：初始化文件，用于将模块中的类和方法暴露给外部调用。
• core.py：项目的核心功能实现，如解析Obsidian笔记、生成定理方程引用等。
• utils.py：工具函数，如读取配置文件、文件路径处理等。

1.2 测试文件文件夹（tests）

• __init__.py：初始化文件，用于测试模块。
• test_core.py：对核心功能模块进行测试。

1.3 其他文件

• .gitignore：配置Git忽略文件，用于避免将不必要的文件提交到仓库。
• README.md：项目说明文件，详细介绍项目功能、安装和使用方法。
• setup.py：安装配置文件，用于项目的安装和依赖管理。

2. 项目的启动文件介绍

本项目没有特定的启动文件。使用时，你需要将src/core.py中的功能集成到你的Obsidian插件中，并在插件中进行调用。

3. 项目的配置文件介绍

本项目使用Python标准库configparser来管理配置文件。配置文件通常为.ini格式，例如：

[Settings]
path_to_obsidian_notes = /path/to/your/obsidian/notes
latexreffile = theoremreffile.tex

3.1 配置文件示例

以下是配置文件的一个示例：

[Settings]
path_to_obsidian_notes = /Users/yourusername/Documents/Obsidian
latexreffile = theorem_references.tex

3.2 配置文件说明

• path_to_obsidian_notes：指定Obsidian笔记的存储路径。
• latexreffile：指定用于存储定理方程引用的LaTeX文件名。

确保正确配置这些参数后，项目才能正常运行。