ACL文献库

此仓库包含：

使用acl-anthology-py Python包

以下是生成https://aclanthology.org/上看到的ACL文献库网站的基本说明。

要构建文献库网站，您需要：

GitHub有一个直接从GitHub执行部署的Actions操作。要使用它，你需要在仓库设置中定义以下变量(网页界面: settings -> secrets):

每当master分支发生变更时，GitHub将自动构建并部署当前的master。这是通过Makefile中的upload目标完成的。

将Anthology仓库克隆到本地机器:

$ git clone https://github.com/acl-org/acl-anthology

如果你已正确安装所有要求，构建网站应该只需在克隆仓库的目录中运行make即可。

之后完整生成的网站将位于build/anthology中。如果在此步骤中出现任何错误，你可以查阅详细README以获取有关构建网站的各个步骤的更多信息。你可以通过运行make serve启动本地web服务器来查看生成的网站，它将在http://localhost:8000上提供服务。

请注意，构建网站是一个相当耗费资源的过程；特别是最后一步调用Hugo，大约需要18GB的系统内存。在配备SSD的笔记本电脑上构建anthology大约需要10分钟。

(注意: 这并不意味着你的系统需要这么多RAM；事实上，在8GB RAM的笔记本电脑上也可以正常构建网站。但是，由于交换内存的原因，系统可能会暂时变慢。大约18GB是运行hugo --minify --stepAnalysis时报告的最大RAM使用量。)

通过在hugo/目录中运行hugo server可以在本地查看anthology。请注意，它会重新构建网站，因此需要大约一分钟才能启动。

首先，创建镜像是一个缓慢的过程，并且会给ACL Anthology基础设施带来压力，因为在初始设置时你必须从官方网络服务器下载anthology的每一个文件。无论你的连接速度有多快，这可能需要长达8小时的时间。因此请不要仅仅出于好奇而尝试。

如果你想托管镜像，你必须设置两个环境变量:

ANTHOLOGY_PREFIX 你的镜像将可访问的http前缀例如 https://example.com/my-awesome-mirror 或 http://aclanthology.lst.uni-saarland.de (注意末尾没有斜杠!)
ANTHOLOGYFILES 论文、附件等将存放在你的网络服务器上的目录。这个目录需要对你的网络服务器可读(显然)，但不应该是 anthology镜像目录的子目录。

设置这些变量后，运行make创建页面，运行make mirror将所有额外文件镜像到build/anthology-files目录。如果你之前已经创建过镜像，它只会下载缺失的文件。

如果你想镜像论文但不包括所有附件，你可以运行make mirror-no-attachments来代替。

然后你将build/website/目录rsync到你的网络服务器，或者如果你在子目录FOO中提供镜像，则镜像build/website/FOO。build/anthology-files目录需要rsync到你网络服务器的ANTHOLOGYFILES目录。

如果你想保持镜像更新，可以根据需要修改shell脚本bin/acl-mirror-cronjob.sh。

你需要在服务器上安装以下软件