Mercurial > octave-nkf

annotate doc/interpreter/macros.texi @ 19628:fe689210525c gui-release

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Periodic merge of stable to gui-release.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 10:05:42 -0500
parents 8cf2b8617e85 446c46af4b42
children 0e1f5a750d00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
1 @c Copyright (C) 2012-2013 John W. Eaton
14614
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.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
9 @c
14614
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.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
14 @c
14614
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
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
19 @c The following macro marks words that aspell should ignore during
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
20 @c spellchecking. Within Texinfo it has no effect as it merely replaces
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
21 @c the macro call with the argument itself.
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
22
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
23 @macro nospell {arg}
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
24 \arg\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
25 @end macro
14615
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
26
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
27 @c The following macro works around the Info/plain text expansion of @code{XXX}
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
28 @c which is `XXX'. This looks particularly bad when the macro body is
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
29 @c single or double-quoted text, such as a property value `"position"'
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
30 @ifinfo
18092
8cf2b8617e85 also check for xtest in __run_test_suite__
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
31 @rmacro qcode{arg}
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
32 \arg\
18092
8cf2b8617e85 also check for xtest in __run_test_suite__
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
33 @end rmacro
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
34 @end ifinfo
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
35 @ifnotinfo
18092
8cf2b8617e85 also check for xtest in __run_test_suite__
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
36 @rmacro qcode{arg}
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
37 @code{\arg\}
18092
8cf2b8617e85 also check for xtest in __run_test_suite__
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
38 @end rmacro
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
39 @end ifnotinfo
14615
88e67d58b06b avoid makeinfo problem with backslash in macro argument
John W. Eaton <jwe@octave.org>
parents: 14614
diff changeset
40
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 @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
42 @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
43 @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
44 @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
45 @c
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
46 @c Implementation Note:
8bba043342ab Move documentation for seealso macro outside of macro definition.
Rik <rik@octave.org>
parents: 14615
diff changeset
47 @c For TeX, @vskip produces a nice separation.
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
48 @c For Texinfo, '@sp 1' should work, but in practice produces ugly results
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
49 @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
50
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 @macro seealso {args}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 @iftex
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 @vskip 2pt
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 @end iftex
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 @ifnottex
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 @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
58 @ifnotinfo
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 @noindent
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 @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
61 @end ifnotinfo
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
62 @ifinfo
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
63 @noindent
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
64 See also: \args\.
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
65 @end ifinfo
14614
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
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 @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
69 @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
70 @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
71 @ifinfo
17268
1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity.
Rik <rik@octave.org>
parents: 16697
diff changeset
72 @macro tcode{arg}
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 \arg\
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75 @end ifinfo
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 @ifnotinfo
17268
1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity.
Rik <rik@octave.org>
parents: 16697
diff changeset
77 @macro tcode{arg}
14614
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 @code{\arg\}
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79 @end macro
4e9dc46d4125 handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 @end ifnotinfo
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
81
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
82 @c FIXME: someday, when Texinfo 5.X is standard, we might replace this with
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
83 @c @backslashchar, which is a new addition to Texinfo.
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
84
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
85 @macro xbackslashchar
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
86 \\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
87 @end macro
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17268
diff changeset
88