xmindparser 技术文档

安装指南

为了使用 xmindparser 库解析XMind文件为可编程的数据类型（如JSON、XML），您需要先确保您的环境中已安装了Python 3.x版本。接下来，通过以下命令进行安装：

pip install xmindparser

如果您计划将解析结果转换为XML格式，还需要额外安装 dicttoxml 库，可以通过这个命令安装：

pip install dicttoxml

项目的使用说明

命令行界面使用

1. 转换为JSON: 将当前目录下的XMind文件转换为JSON格式，只需执行：

   cd /your/xmind/dir
   xmindparser your.xmind -json
   

2. 转换为XML: 类似地，若想转换为XML，执行：

   xmindparser your.xmind -xml
   

通过Python代码使用

您也可以在Python脚本中直接调用 xmindparser 的功能。例如，将XMind文件转换为字典：

from xmindparser import xmind_to_dict

# 指定XMind文件路径
file_path = '/path/to/your/xmind'
data = xmind_to_dict(file_path)
print(data)

项目API使用文档

xmind_to_dict(file_path)

• 参数: file_path (str) - XMind文件的完整路径。
• 返回: 解析后的XMind数据，以字典形式表示。

xmind_to_xml(file_path)

• 依赖: 需要先安装 dicttoxml。
• 参数: file_path (str) - XMind文件的完整路径。
• 返回: 直接生成XML格式的文件，而不是返回字符串。

配置项可以通过定义 config 对象来定制日志记录细节和解析行为，比如显示内部话题ID和是否隐藏空值。

限制说明

对于XMind的旧版本，以下特性不被支持或部分支持：

• 不支持专业版特性，如任务信息、音频注释。
• 不处理浮动主题、链接主题等高级功能。
• 图片和附件仅记录名称，富文本笔记会被转换为纯文本。

支持XMindZen

xmindparser 自动识别由XMind Zen或XMind Pro创建的文件。对Zen文件的处理方式和对传统XMind文件相同，同时考虑到了两者之间的差异，如不再支持的评论功能以及新增的贴纸（作为图像处理）和标注（以列表形式呈现）等特性。

此外，可以直接读取XMind Zen文件中的JSON内容，使用以下代码片段：

from xmindparser import get_xmind_zen_builtin_json

zen_content = get_xmind_zen_builtin_json('path_to_your_xmind_zen_file.xmind')

示例与资源

项目提供了示例文件和输出样例，您可以下载官方提供的XMind Pro和Zen格式的文件进行实践，并查看相应的JSON和XML输出示例。

许可证

项目遵循MIT许可协议，允许广泛的使用和修改。

以上就是使用 xmindparser 来处理XMind文件的基础文档，希望它能帮助您高效地将想法转化为可编程的数据结构。