File Manager

Editing File: /usr/share/doc/texinfo/html/Raw-Formatter-Commands.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Raw Formatter Commands (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<div class="header">

Next: <a href="Inline-Conditionals.html" accesskey="n" rel="next">Inline Conditionals</a>, Previous: <a href="Conditional-Not-Commands.html" accesskey="p" rel="prev">Conditional Not Commands</a>, Up: <a href="Conditionals.html" accesskey="u" rel="up">Conditionals</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]
</div>
<hr>
<h3 class="section">16.3 Raw Formatter Commands</h3>

The <code>@if&hellip;</code> conditionals just described must be used only
with normal Texinfo source. For instance, most features of plain
TeX will not work within <code>@iftex</code>. The purpose of
<code>@if&hellip;</code> is to provide conditional processing for Texinfo
source, not provide access to underlying formatting features. For
that, Texinfo provides so-called raw formatter commands. They
should only be used when truly required (most documents do not need
them).



The first raw formatter command is <code>@tex</code>. You can enter plain
TeX completely, and use &lsquo;<samp>\</samp>&rsquo; in the TeX commands, by
delineating a region with the <code>@tex</code> and <code>@end tex</code>
commands. All plain TeX commands and category codes are restored
within a <code>@tex</code> region. The sole exception is that the
<code>@</code> character still introduces a command, so that <code>@end
tex</code> can be recognized. Texinfo processors will not output material
in such a region, unless TeX output is being produced.



In complex cases, you may wish to define new TeX macros within
<code>@tex</code>. You must use <code>\gdef</code> to do this, not <code>\def</code>,
because <code>@tex</code> regions are processed in a TeX group. If you
need to make several definitions, you may wish to set
<code>\globaldefs=1</code> (its value will be restored to zero as usual when
the group ends at <code>@end tex</code>, so it won&rsquo;t cause problems with
the rest of the document).



As an example, here is a displayed equation written in plain TeX:

<div class="example">
<pre class="example">@tex
$$ \chi^2 = \sum_{i=1}^N
 \left (y_i - (a + b x_i)
 \over \sigma_i\right)^2 $$
@end tex
</pre></div>

The output of this example will appear only in a printed manual. If
you are reading this in a format not generated by TeX, you will not
see the equation that appears in the printed manual.

Analogously, you can use <code>@ifhtml &hellip; @end ifhtml</code> to
delimit Texinfo source to be included in HTML output only, and
<code>@html &hellip; @end html</code> for a region of raw HTML.




Likewise, you can use <code>@ifxml &hellip; @end ifxml</code> to delimit
Texinfo source to be included in XML output only, and <code>@xml
&hellip; @end xml</code> for a region of raw XML. Regions of raw text in
other formats will also be present in the XML output, but with
protection of XML characters and within corresponding elements. For
example, the raw HTML text:

<div class="example">
<pre class="example">@html
&lt;br /&gt;
@end html
</pre></div>

will be included in the XML output as:

<div class="example">
<pre class="example">&lt;html&gt;
&amp;lt;br /&amp;gt;
&lt;/html&gt;
</pre></div>

Again likewise, you can use <code>@ifdocbook &hellip; @end ifdocbook</code>
to delimit Texinfo source to be included in Docbook output only, and
<code>@docbook &hellip; @end docbook</code> for a region of raw Docbook.

The behavior of newlines in raw regions is unspecified.

In all cases, in raw processing, <code>@</code> retains the same meaning as
in the remainder of the document. Thus, the Texinfo processors must
recognize and even execute, to some extent, the contents of the raw
regions, regardless of the final output format. Therefore, specifying
changes that globally affect the document inside a raw region leads to
unpredictable and generally undesirable behavior. For example, using
the <code>@kbdinputstyle</code> command inside a raw region is undefined.

The remedy is simple: don&rsquo;t do that. Use the raw formatter commands
for their intended purpose, of providing material directly in the
underlying format. When you simply want to give different Texinfo
specifications for different output formats, use the
<code>@if&hellip;</code> conditionals and stay in Texinfo syntax.

<hr>
<div class="header">

Next: <a href="Inline-Conditionals.html" accesskey="n" rel="next">Inline Conditionals</a>, Previous: <a href="Conditional-Not-Commands.html" accesskey="p" rel="prev">Conditional Not Commands</a>, Up: <a href="Conditionals.html" accesskey="u" rel="up">Conditionals</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]
</div>

</body>
</html>

Back to Directory File Manager