EVOLUTION-MANAGER
Edit File: renderer_latex.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: LaTeX renderer</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for space_latex {highlight}"><tr><td>space_latex {highlight}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>LaTeX renderer</h2> <h3>Description</h3> <p>renderer implementation targetting latex markup. The result markup uses the latex <span class="samp">alltt</span> package to achieve true type renderering and therefore does not depend on verbatim-like environments. </p> <h3>Usage</h3> <pre> space_latex() newline_latex() renderer_latex( document = TRUE, boxes = boxes_latex(), translator = translator_latex, formatter = formatter_latex, space = space_latex, newline = newline_latex, stylesheet = "default", styles = styler(stylesheet, "sty", styler_assistant_latex), header = header_latex(document, styles = styles, boxes = boxes, minipage = minipage), footer = footer_latex(document, minipage = minipage), minipage = FALSE, ... ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>document</code></td> <td> <p>logical. Should the renderer create the full document or only the code section, assuming the document is already created. Using FALSE is used by the sweave driver shipped with this package.</p> </td></tr> <tr valign="top"><td><code>boxes</code></td> <td> <p>a function that returns definitions of latex boxes used for non standard characters. The reason for using boxes is that some character need to be escaped to be rendered, and unfortunately, escaping turns alltt off, which does not produce satisfying rendering. This argument is used by the header function when the document argument is TRUE. It is also used in the sweave driver at the very beginning of the document</p> </td></tr> <tr valign="top"><td><code>translator</code></td> <td> <p>translation of characters into latex markup. See <code><a href="translator_latex.html">translator_latex</a></code> for details</p> </td></tr> <tr valign="top"><td><code>formatter</code></td> <td> <p>latex formatter. Tokens are wrapped into a latex command related to the style they should honor.</p> </td></tr> <tr valign="top"><td><code>space</code></td> <td> <p>returns a space character that does not get reduced by latex</p> </td></tr> <tr valign="top"><td><code>newline</code></td> <td> <p>returns a newline character</p> </td></tr> <tr valign="top"><td><code>stylesheet</code></td> <td> <p>stylesheet to use.</p> </td></tr> <tr valign="top"><td><code>styles</code></td> <td> <p>style definitions inferred from the parsing of the stylesheet. See <code><a href="styler.html">styler</a></code> and <code><a href="styler_assistant_latex.html">styler_assistant_latex</a></code>.</p> </td></tr> <tr valign="top"><td><code>header</code></td> <td> <p>returns the header. If the document argument is TRUE, the header contains the style definitions and the boxes definitions. If it is FALSE, a minimal header is produced to turn alltt on. In the latter case, boxes and style definitions are assumed to have been inserted already, latex will not compile the document otherwise.</p> </td></tr> <tr valign="top"><td><code>footer</code></td> <td> <p>returns the footer. Depending on the document argument, either a minimal footer is produced (turning off alltt) or the full latex document is closed.</p> </td></tr> <tr valign="top"><td><code>minipage</code></td> <td> <p>if TRUE, the highlighted latex is included in a minipage environment</p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p>Additional arguments</p> </td></tr> </table> <h3>Value</h3> <p>a <span class="samp">renderer</span> object, suitable for the <span class="samp">renderer</span> argument of <code><a href="highlight.html">highlight</a></code>. </p> <h3>Examples</h3> <pre> ## Not run: r <- renderer_latex(document = T ) r$space() r$newline() r$boxes() r$translator( "# the hash symbol gets a latex box" ) ## End(Not run) </pre> <hr /><div style="text-align: center;">[Package <em>highlight</em> version 0.5.0 <a href="00Index.html">Index</a>]</div> </body></html>