Mercurial > hg > octave-lyh

annotate doc/interpreter/macros.texi @ 17161:96b64a18be13

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Fix building info with new macro fixcontentsmargin. * doc/interpreter/octave.texi: Use @iftex/@end iftex around @fixcontentsmargin call.
author Rik <rik@octave.org>
date Fri, 02 Aug 2013 14:25:24 -0700
parents bf1de4943a5d
children 1c21f264d26f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 @c Copyright (C) 2012 John W. Eaton
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 @c
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 @c This file is part of Octave.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 @c
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 @c under the terms of the GNU General Public License as published by the
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 @c your option) any later version.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 @c
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 @c for more details.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 @c
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 @c You should have received a copy of the GNU General Public License
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 @c <http://www.gnu.org/licenses/>.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
14615
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
19 @c FIXME -- someday, we might replace this with @backslashchar, which
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
20 @c has been added to Texinfo.
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
21
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
22 @macro xbackslashchar
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
23 \\
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
24 @end macro
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
25
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 @c The following macro is used for the on-line help system, but we don't
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 @c want lots of `See also: foo, bar, and baz' strings cluttering the
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 @c printed manual (that information should be in the supporting text for
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 @c each group of functions and variables).
15151
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
30 @c
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
31 @c Implementation Note:
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
32 @c For TeX, @vskip produces a nice separation.
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
33 @c For Texinfo '@sp 1' should work, but in practice produces ugly results
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
34 @c for HTML. We use a simple blank line to produce the correct behavior.
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 @macro seealso {args}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 @iftex
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 @vskip 2pt
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 @end iftex
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 @ifnottex
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 @end ifnottex
16697
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
43 @ifinfo
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
44 @noindent
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
45 See also: \args\.
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
46 @end ifinfo
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
47 @ifnotinfo
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 @noindent
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 @strong{See also:} \args\.
16697
bf1de4943a5d * macros.texi: Don't use @strong for @seealso in info mode.
John W. Eaton <jwe@octave.org>
parents: 15151
diff changeset
50 @end ifnotinfo
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 @c The following macro marks words that aspell should ignore during
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 @c spellchecking. Within Texinfo it has no effect as it merely replaces
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 @c the macro call with the argument itself.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 @macro nospell {arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 \arg\
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 @c The following macro works around a situation where the Info/plain text
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 @c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 @c can be confusing if the code segment itself ends with a transpose operator.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 @ifinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 @macro xcode{arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 \arg\
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 @end ifinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 @ifnotinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 @macro xcode{arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 @code{\arg\}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 @end ifnotinfo