Need help with rails-latex?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

132 Stars 46 Forks MIT License 122 Commits 4 Opened issues


rails-latex is a renderer for rails which allows tex files with erb to be turned into an inline pdf

Services available


Need anything else?

Contributors list

{Build Status}[]

= Rails-LaTeX

  • Git:
  • Original author: Geoff Jacobsen
  • Copyright: 2010-2015 Geoff Jacobsen, Jan Baier and contributors
  • License: MIT-LICENSE

== Description

rails-latex is a renderer for rails, which allows tex files with erb to be turned into an inline pdf.

== Synopsis

app/helpers/applicationhelper.rb: def lesc(text) LatexToPdf.escapelatex(text) end

app/views/stories/show.html.erb: ... <%= linkto "print", storypath(@story,:format => :pdf) %>

app/views/stories/show.pdf.erb: ... <%= lesc % >

app/views/layouts/application.pdf.erbtex: \documentclass[12pt,a4paper,sloppy,< %= @landscape % >]{article} ... < %= yield % > \end{document}

config/initializers/mime_types.rb: ... Mime::Type.register "application/pdf", :pdf, ['text/pdf'], ['pdf']

Only the file containing the \documentclass should be of type: .pdf.erbtex . Partials and views (when there is a layout) should be of type .pdf.erb .

If a LaTeX package requires more than one parser run add the following to the .pdf.erbtex file:

<% @latexconfig={:parseruns => 3} %>

You can override the defaults like so:

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

or to change just the arguments:


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

The last log file is moved to tmp/rails-latex/input.log , and the corresponding source TeX file to tmp/rails-latex/input.tex . If the PDF is not produced the build directory is not removed; an archive script should be written to occasionally clean up the tmp/rails-latex directory.

See the rails application under examples/rails-latex-demo/ for a working example.

=== Generating a String

If you need to generate the LaTeX document as a string you can use the +rendertostring+ method. You will probably need to pass the :layout => true option to invoke the PDF generator. Here is an example to generate an email attachment:

In the controller you will have something along the lines of:

def sendemailmethod output = rendertostring(:template => "/yourmodel/yourview.pdf.erb", :layout => true) MyMailer.emailsender(currentuser, output).deliver end

The thing to note is the :layout => true which is needed so that the pdf template can grab the application erbtex layout. Then in your mailer:

def emailsender(user, pdfattachment) @user = user attachments["attachmentname.pdf"] = {:mimetype => 'application/pdf', :content => pdf_attachment} mail( .... ) end

=== Exception handling and debugging

When LaTeX render fails, +RailsLatex::ProcessingError+ is thrown. In your code, you can catch it and react according to your needs. To make your life easier, TeX source and log are attached to the exception as instance variables +src+ and +log+.

== Requirements

  • ruby 1.8 or 1.9
  • rails 3 or later

== Install

  • gem install rails-latex

== Development

Developing rails-latex requires bundler and RedCloth

  • rake test
  • rake build

== Contributions

  • Geoff Jacobsen
  • Tommaso Patrizi
  • Klaus Reske
  • Jan Baier
  • Jakub Cerny

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.