Rails-LaTeX 技术文档

1. 安装指南

环境要求

• Ruby 1.8 或 1.9
• Rails 3 或更高版本
• TeX、LaTeX 或 XeTeX（默认使用 pdflatex）

安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 rails-latex gem：

   gem install rails-latex
   

2. 项目的使用说明

概述

rails-latex 是一个用于 Rails 的渲染器，允许将包含 ERB 的 TeX 文件转换为内联 PDF。它主要用于在 Rails 应用中生成 PDF 文档。

基本使用

1. 在 app/helpers/application_helper.rb 中定义一个辅助方法 lesc，用于转义 LaTeX 文本：

   def lesc(text)
     LatexToPdf.escape_latex(text)
   end
   

2. 在视图文件中使用 lesc 方法来转义 LaTeX 文本。例如，在 app/views/stories/show.html.erb 中：

   <%= link_to "print", story_path(@story, :format => :pdf) %>
   

3. 创建 PDF 视图文件 app/views/stories/show.pdf.erb：

   <%= lesc @story.name %>
   

4. 创建 PDF 布局文件 app/views/layouts/application.pdf.erbtex：

   \documentclass[12pt,a4paper,sloppy,<%= @landscape % >]{article}
   ...
   <%= yield %>
   \end{document}
   

5. 在 config/initializers/mime_types.rb 中注册 PDF MIME 类型：

   Mime::Type.register "application/pdf", :pdf, ['text/pdf'], ['pdf']
   

高级配置

• 如果 LaTeX 包需要多次解析，可以在 .pdf.erbtex 文件中添加以下内容：

  <% @latex_config = { :parse_runs => 3 } %>
  

• 可以覆盖默认配置，例如：

  LatexToPdf.config.merge! :command => 'xetex', :arguments => ['-etex'], :parse_runs => 2
  

• 默认配置如下：

  command: 'pdflatex'
  arguments: ['-halt-on-error']
  parse_runs: 1
  

3. 项目API使用文档

LatexToPdf 配置

• command: 指定 LaTeX 命令，默认为 pdflatex。
• arguments: 传递给 LaTeX 命令的参数，默认为 ['-halt-on-error']。
• parse_runs: 解析运行次数，默认为 1。

render_to_string 方法

• 用于生成 LaTeX 文档的字符串。例如：

  output = render_to_string(:template => "/your_model/your_view.pdf.erb", :layout => true)
  

异常处理

• 当 LaTeX 渲染失败时，会抛出 RailsLatex::ProcessingError 异常。可以通过捕获该异常来进行调试：

  begin
    # 渲染 PDF
  rescue RailsLatex::ProcessingError => e
    # 处理异常
    puts e.src
    puts e.log
  end
  

4. 项目安装方式

通过 Gem 安装

gem install rails-latex

开发环境安装

1. 确保已安装 bundler 和 RedCloth。
2. 运行测试：

   rake test
   

3. 构建项目：

   rake build
   

通过以上步骤，您可以顺利安装并使用 rails-latex 项目，生成 PDF 文档并在 Rails 应用中进行集成。