= 整理的《临高启明人物关系网络》 =

== 简介 ==

把临高启明wiki整理的数据开源到 GitHub，便于多人协作——大伙儿群策群力，一起来绘制人物关系网络。

== 下载说明 ==

GitHub 提供了“下载整个项目”的功能。

如果你仅仅想看《临高启明人物关系网络》这份文档，只需在首页上方点击进入 '''download''' 这个目录。

该目录下有 '''pdf''' 和 '''jpg''' 两个子目录，分别存放对应的 '''【文件类型】''' 。你想要看哪一种文件格式，就进入哪个子目录里面。

进入【文件类型】的子目录之后，会看到一个文件列表。先点击你想要的某个文件，会进入该文件的页面。

然后在【右上方】你会看到一个 '''Raw 按钮''' ，在这个按钮上点【右键】，在【右键菜单】里面选“保存”或“另存为”，就可以把这个文件下载到你本机。

== 多人协作说明 ==

非常希望有更多的网友参与该项目，大伙儿一起来完善临高启明人物的资料。

想要参与的同学，可以通过如下方式：

• 到[https://lgqm.gq/] 论坛留言进行反馈，补充信息或反馈错误。

• 在[https://github.com/eiauo/lgqm/issues] 本项目发一个 issue补充信息或反馈错误。

• Fork 该项目，进行修改，然后向发一个 Pull Request

（后面两种方式，你需要有 GitHub 的帐号）

== 数据格式说明 ==

本项目的数据文件，全部采用[https://zh.wikipedia.org/wiki/YAML] YAML 格式。这种格式非常简洁明了，有利于完全不懂技术的网友参与编辑。

而且在每一个 YAML 格式的文件中都写了详细的注释，便于其他网友修改。

== 目录说明 ==

=== data 目录 ===

data 目录用来保存数据文件，该目录下另有如下三个子目录：

• person

这个目录存放个人的资料，每个人一个目录，目录名就是人名。对于偶尔有同名的情况，在目录名末尾追加数字序号来区分。

每个目录下都有一个 brief.yaml 文件，包含此人的简介。

有些目录下还有一个 portrait.png 文件，对应此人的头像。

• company

这个目录存放与临高启明人物有关的组织机构。目录结构与 person 类似。

• family

这个目录存放元老家族关系的信息。每个家族是一个 yaml 格式的文件。

=== bin 目录 ===

该目录存放编译脚本。该脚本的使用参见下面的章节。

=== download 目录 ===

该目录存放制作好的文件，目前先提供 jpg 和 pdf 两种格式。

如果你需要其它格式，可以用 bin 目录下的编译脚本自行搞定（编译脚本的使用，参见下面的章节）。

== 编译脚本使用说明 ==

（在 Windows 上编写该脚本，尚未在 Linux 上进行测试）

如果你在编译上使用碰到问题，可以到[https://lgqm.gq/] 留言进行反馈 也可以在[https://github.com/eiauo/lgqm/issues] 本项目发一个 issue

=== 脚本的命令行参数 ===

使用 python 作为编译脚本，该脚本位于 bin 目录下。

通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式（比如：pdf、jpeg）。

要使用该脚本，先进入 bin 目录运行env.bat，然后在命令行模式下运行如下命令：

（生成 pdf 格式的示例）

'''python make.py pdf'''

（生成 jpg 格式的示例）

'''python make.py jpg'''

=== 依赖的软件 ===

要使用上述脚本，你需要事先安装相关的软件（如下）

• Python 3.7

因为用的是 Python 脚本，所以你需要先安装 python 软件。

目前 Python 有两种大版本——python2 和 python3——的编译脚本,这两种 Python 的大版本。

对于 Python 的版本，本人在 '''3.7''' 上测试通过。

• PyYAML

这是一个基于 python 开发的软件包，专门用来处理 YAML 格式的文件。

你需要在你的 python 环境中安装该软件包。

pip install pyyaml

• Graphviz

这个软件是用来生成【关系图】的。 https://graphviz.gitlab.io/_pages/Download/Download_windows.html