Mercurial > octave-nkf

annotate doc/interpreter/macros.texi @ 15151:8bba043342ab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move documentation for seealso macro outside of macro definition. Saves 15K in generated HTML. * macros.texi: Move documentation for seealso macro outside of macro definition.
author Rik <rik@octave.org>
date Fri, 10 Aug 2012 16:03:34 -0700
parents 88e67d58b06b
children bf1de4943a5d
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
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 @noindent
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 @strong{See also:} \args\.
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 @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
48 @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
49 @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
50
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 @macro nospell {arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 \arg\
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 @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
56 @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
57 @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
58 @ifinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 @macro xcode{arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 \arg\
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 @end ifinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 @ifnotinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 @macro xcode{arg}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 @code{\arg\}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 @end ifnotinfo