TimelineSetter 技术文档

1. 安装指南

TimelineSetter 是一个用于从电子表格生成 HTML 时间线的工具。以下是安装步骤：

1. 安装依赖：

   • 确保系统中已安装 Node.js 和 npm。
   • 安装 Ruby 和 Bundler。

2. 下载项目：

   • 从 GitHub 仓库克隆项目到本地：

     git clone https://github.com/propublica/timeline-setter.git
     

3. 安装依赖包：

   • 进入项目目录并安装所需的 Ruby 依赖：

     cd timeline-setter
     bundle install
     

4. 验证安装：

   • 运行以下命令以确保安装成功：

     ruby timeline-setter.rb --version
     

2. 项目的使用说明

TimelineSetter 的主要功能是从电子表格中提取事件数据，并生成一个 HTML 时间线。以下是使用步骤：

1. 准备数据：

   • 创建一个包含事件数据的电子表格文件（如 CSV 或 Excel 文件）。
   • 确保数据包含以下字段：date, title, description 等。

2. 生成时间线：

   • 使用以下命令生成时间线：

     ruby timeline-setter.rb -f events.csv -o timeline.html
     

   • 其中 events.csv 是输入的电子表格文件，timeline.html 是输出的 HTML 文件。

3. 查看时间线：

   • 打开生成的 timeline.html 文件，即可在浏览器中查看时间线。

3. 项目API使用文档

TimelineSetter 提供了简单的命令行接口，以下是主要的 API 使用说明：

• timeline-setter.rb：

  • 主程序入口，用于生成时间线。
  • 常用参数：
    • -f, --file FILE：指定输入的电子表格文件。
    • -o, --output FILE：指定输出的 HTML 文件。
    • --version：显示当前版本。

• 示例：

  ruby timeline-setter.rb -f events.csv -o timeline.html
  

4. 项目安装方式

TimelineSetter 的安装方式如下：

1. 通过 Git 安装：

   • 克隆项目到本地：

     git clone https://github.com/propublica/timeline-setter.git
     

   • 进入项目目录并安装依赖：

     cd timeline-setter
     bundle install
     

2. 通过 RubyGems 安装（可选）：

   • 如果项目发布到 RubyGems，可以使用以下命令安装：

     gem install timeline-setter
     

通过以上步骤，您可以成功安装并使用 TimelineSetter 工具来生成 HTML 时间线。