File Manager

Editing File: /usr/share/doc/texinfo/html/Conditional-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>Conditional Commands (GNU Texinfo 6.7)</title>

</head>

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

Next: <a href="Conditional-Not-Commands.html" accesskey="n" rel="next">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.1 Conditional Commands</h3>

Texinfo has an <code>@if<var>format</var></code> environment for each output
format, to allow conditional inclusion of text for a particular output
format.


<code>@ifinfo</code> begins segments of text that should be ignored by
TeX when it typesets the printed manual, and by <code>makeinfo</code>
when not producing Info output. The segment of text appears only in
the Info file and, for historical compatibility, the plain text
output.






The environments for the other formats are analogous:

<dl compact="compact">
<dt><code>@ifdocbook &hellip; @end ifdocbook</code></dt>
<dd>Text to appear only in the Docbook output.

</dd>
<dt><code>@ifhtml &hellip; @end ifhtml</code></dt>
<dd>Text to appear only in the HTML output.

</dd>
<dt><code>@ifplaintext &hellip; @end ifplaintext</code></dt>
<dd>Text to appear only in the plain text output.

</dd>
<dt><code>@iftex &hellip; @end iftex</code></dt>
<dd>Text to appear only in the printed manual.

</dd>
<dt><code>@ifxml &hellip; @end ifxml</code></dt>
<dd>Text to appear only in the XML output.
</dd>
</dl>

The <code>@if&hellip;</code> and <code>@end if&hellip;</code> commands must appear
on lines by themselves in your source file. The newlines following
the commands are (more or less) treated as whitespace, so that the
conditional text is flowed normally into a surrounding paragraph.

The <code>@if&hellip;</code> constructs are intended to conditionalize
normal Texinfo source; see <a href="Raw-Formatter-Commands.html">Raw Formatter Commands</a>, for using
underlying format commands directly.

Here is an example showing all these conditionals:

<div class="example">
<pre class="example">@iftex
This text will appear only in the printed manual.
@end iftex
@ifinfo
However, this text will appear only in Info and plain text.
@end ifinfo
@ifhtml
And this text will only appear in HTML.
@end ifhtml
@ifplaintext
Whereas this text will only appear in plain text.
@end ifplaintext
@ifxml
Notwithstanding that this will only appear in XML.
@end ifxml
@ifdocbook
Nevertheless, this will only appear in Docbook.
@end ifdocbook
</pre></div>

The preceding example produces the following line:

And this text will only appear in HTML.

Notice that you only see one of the input lines, depending on which
version of the manual you are reading.


In complex documents, you may want Texinfo to issue an error message
in some conditionals that should not ever be processed. The
<code>@errormsg{<var>text</var>}</code> command will do this; it takes one
argument, the text of the error message.

We mention <code>@errormsg{}</code> here even though it is not strictly
related to conditionals, since in practice it is most likely to be
useful in that context. Technically, it can be used anywhere.
See <a href="External-Macro-Processors.html">External Macro Processors</a>, for a caveat regarding the line
numbers which <code>@errormsg</code> emits in TeX.

<hr>
<div class="header">

Next: <a href="Conditional-Not-Commands.html" accesskey="n" rel="next">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