texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / definfoenclose.html

This file is indexed.

/usr/share/doc/texinfo/html/definfoenclose.html is in texinfo-doc-nonfree 4.13a-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<html lang="en">
<head>
<title>definfoenclose - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Defining-New-Texinfo-Commands.html#Defining-New-Texinfo-Commands" title="Defining New Texinfo Commands">
<link rel="prev" href="alias.html#alias" title="alias">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     ``GNU Free Documentation License.''

     (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="definfoenclose"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="alias.html#alias">alias</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Defining-New-Texinfo-Commands.html#Defining-New-Texinfo-Commands">Defining New Texinfo Commands</a>
<hr>
</div>

<h3 class="section">19.5 &lsquo;<samp><span class="samp">definfoenclose</span></samp>&rsquo;: Customized Highlighting</h3>

<p><a name="index-Highlighting_002c-customized-1093"></a><a name="index-Customized-highlighting-1094"></a><a name="index-definfoenclose-1095"></a>
A <code>@definfoenclose</code> command may be used to define a highlighting
command for Info, but not for TeX.  A command defined using
<code>@definfoenclose</code> marks text by enclosing it in strings that
precede and follow the text.  You can use this to get closer control of
your Info output.

  <p>Presumably, if you define a command with <code>@definfoenclose</code> for Info,
you will create a corresponding command for TeX, either in
<samp><span class="file">texinfo.tex</span></samp>, <samp><span class="file">texinfo.cnf</span></samp>, or within an &lsquo;<samp><span class="samp">@iftex</span></samp>&rsquo; in
your document.

  <p>Write a <code>@definfoenclose</code> command on a line and follow it with
three arguments separated by commas.  The first argument to
<code>@definfoenclose</code> is the @-command name (without the <code>@</code>);
the second argument is the Info start delimiter string; and the third
argument is the Info end delimiter string.  The latter two arguments
enclose the highlighted text in the Info file.  A delimiter string may
contain spaces.  Neither the start nor end delimiter is required.  If
you do not want a start delimiter but do want an end delimiter, you must
follow the command name with two commas in a row; otherwise, the Info
formatting commands will naturally misinterpret the end delimiter string
you intended as the start delimiter string.

  <p>If you do a <code>@definfoenclose</code> on the name of a predefined macro
(such as <code>@emph</code>, <code>@strong</code>, <code>@t</code>, or <code>@i</code>), the
enclosure definition will override the built-in definition.

  <p>An enclosure command defined this way takes one argument in braces; this
is intended for new markup commands (see <a href="Marking-Text.html#Marking-Text">Marking Text</a>).

  <p><a name="index-phoo-1096"></a>For example, you can write:

<pre class="example">     @definfoenclose phoo,//,\\
</pre>
  <p class="noindent">near the beginning of a Texinfo file to define <code>@phoo</code> as an Info
formatting command that inserts `//' before and `\\' after the argument
to <code>@phoo</code>.  You can then write <code>@phoo{bar}</code> wherever you
want `//bar\\' highlighted in Info.

  <p>Also, for TeX formatting, you could write

<pre class="example">     @iftex
     @global@let@phoo=@i
     @end iftex
</pre>
  <p class="noindent">to define <code>@phoo</code> as a command that causes TeX to typeset the
argument to <code>@phoo</code> in italics.

  <p>Each definition applies to its own formatter: one for TeX, the other
for <code>texinfo-format-buffer</code> or <code>texinfo-format-region</code>.  The
<code>@definfoenclose</code> command need not be within &lsquo;<samp><span class="samp">@ifinfo</span></samp>&rsquo;, but
the raw TeX commands do need to be in &lsquo;<samp><span class="samp">@iftex</span></samp>&rsquo;.

  <p><a name="index-headword-1097"></a>Here is another example: write

<pre class="example">     @definfoenclose headword, , :
</pre>
  <p class="noindent">near the beginning of the file, to define <code>@headword</code> as an Info
formatting command that inserts nothing before and a colon after the
argument to <code>@headword</code>.

  <p>&lsquo;<samp><span class="samp">@definfoenclose</span></samp>&rsquo; definitions must not be recursive, directly or
indirectly.

  </body></html>

APT Browse - Built by Thomas Orozco.