BibTeX-Ruby 项目技术文档

1. 安装指南

1.1 系统要求

• Ruby 2.7 及以上版本
• 支持的操作系统：Linux, macOS, Windows

1.2 安装步骤

1. 打开终端或命令行工具。
2. 使用以下命令安装 BibTeX-Ruby gem：

   $ [sudo] gem install bibtex-ruby
   

3. 安装完成后，您可以在 IRB 或脚本中加载 BibTeX-Ruby：

   $ irb
   >> require 'bibtex'
   

2. 项目使用说明

2.1 快速开始

1. 安装 BibTeX-Ruby 后，您可以在 IRB 会话中加载并使用它。
2. 打开一个 BibTeX 文件：

   b = BibTeX.open('./ruby.bib')
   

3. 选择一个 BibTeX 条目并访问其字段：

   b['pickaxe'].title
   #=> "Programming Ruby 1.9: The Pragmatic Programmer's Guide"
   

2.2 查询与操作

• 查询 BibTeX 文件中的条目：

  b['@book'].length
  #=> 3 - 表示 BibTeX 文件中有 3 本书
  

• 扩展作者名字的首字母：

  b.extend_initials ['Dave', 'Thomas']
  

2.3 导出与转换

• 将 BibTeX 条目转换为其他格式（如 YAML、JSON、CiteProc/CSL 等）：

  b[:pickaxe].to_yaml
  

• 保存 BibTeX 文件：

  b.save_to('new_file.bib')
  

3. 项目 API 使用文档

3.1 打开与解析 BibTeX 文件

• 使用 BibTeX.open 打开 BibTeX 文件：

  b = BibTeX.open('./ruby.bib')
  

• 使用 BibTeX.parse 解析 BibTeX 字符串：

  b = BibTeX.parse <<-END
  @book{pickaxe,
    address = {Raleigh, North Carolina},
    author = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
    publisher = {The Pragmatic Bookshelf},
    series = {The Facets of Ruby},
    title = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
    year = {2009}
  }
  END
  

3.2 访问与操作 BibTeX 条目

• 访问条目字段：

  b[:pickaxe].author
  #=> "Thomas, Dave and Fowler, Chad and Hunt, Andy"
  

• 修改条目字段：

  b[:pickaxe].title = "New Title"
  

3.3 查询与过滤

• 使用查询语言搜索 BibTeX 条目：

  b.query('@book[year=2009]')
  #=> 返回所有 2009 年出版的书籍
  

3.4 字符串替换

• 替换 BibTeX 文件中的字符串：

  b.replace_strings
  

4. 项目安装方式

4.1 使用 Gem 安装

• 使用以下命令安装 BibTeX-Ruby：

  $ [sudo] gem install bibtex-ruby
  

4.2 手动安装

• 从 GitHub 下载源代码并手动安装：

  $ git clone https://github.com/inukshuk/bibtex-ruby.git
  $ cd bibtex-ruby
  $ gem build bibtex-ruby.gemspec
  $ gem install bibtex-ruby-<version>.gem
  

通过以上步骤，您可以顺利安装并使用 BibTeX-Ruby 项目，进行 BibTeX 文件的解析、查询、操作和导出等操作。