Arelle 开源项目使用与配置教程

1. 项目目录结构及介绍

Arelle 项目是一个完整的开源 XBRL 平台，其目录结构如下：

Arelle/
├── .github/
├── .gitignore/
├── arelle/
│   ├── arelle.pyw
│   ├── arelleCmdLine.py
│   ├── arelleGUI.pyw
│   └── ...
├── docs/
├── scripts/
├── tests/
├── ...
├── CONTRIBUTING.md
├── COPYRIGHT.md
├── LICENSE.md
├── README.md
└── ...

• .github/: 存放 GitHub 专用的配置文件和模板。
• .gitignore/: 定义了在 Git 版本控制中应该忽略的文件和目录。
• arelle/: 包含了 Arelle 平台的主执行文件和相关脚本。
  • arelle.pyw: Arelle 平台的 Python 启动文件。
  • arelleCmdLine.py: 命令行界面的启动脚本。
  • arelleGUI.pyw: 图形用户界面的启动脚本。
• docs/: 存放项目文档和教程。
• scripts/: 存储项目相关的脚本文件。
• tests/: 存放项目的测试代码和测试用例。
• CONTRIBUTING.md: 提供了贡献代码的指南和规范。
• COPYRIGHT.md:说明了项目的版权信息。
• LICENSE.md: 定义了项目的开源协议。
• README.md: 项目的主描述文件，包含了项目的概述和基本使用方法。

2. 项目的启动文件介绍

项目的启动文件位于 arelle/ 目录下，主要包括以下文件：

• arelle.pyw: 这是 Arelle 平台的主 Python 执行文件，用于启动图形用户界面。
• arelleCmdLine.py: 这是用于命令行界面的启动脚本，可以用来执行自动化任务或者在没有图形界面的情况下操作 Arelle。

要启动 Arelle，可以在命令行中运行以下命令：

python arelle.pyw

或者启动命令行界面：

python arelleCmdLine.py

3. 项目的配置文件介绍

Arelle 项目的配置主要通过以下文件进行：

• config.ini: 这是 Arelle 的主要配置文件，存放了用户自定义的设置，例如插件配置、网络设置等。
• messages.pot: 包含了所有翻译模板，用于国际化支持。

配置文件通常位于 Arelle 的安装目录中，用户可以根据自己的需求修改这些文件。

请注意，任何修改都应该谨慎进行，并且在进行修改之前建议备份原配置文件。配置文件的具体修改方法和可配置选项可以参考官方文档中的详细说明。