Mercurial > hg > octave-nkf

comparison doc/interpreter/macros.texi @ 14614:4e9dc46d4125

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
handle texinfo macros consistently in help system and manual * macros.texi: New file. Move macro definitions here from octave.texi. * doc/interpreter/Makefile.am (octetc_DATA): Include it in the list. (doc-cache): Pass macros.texi to mk_doc_cache.m. * octave.texi: Include macros.texi. * mk_doc_cache.m, __makeinfo__.m: Copy macros file to makeinfo input instead of handling macros specially. * configure.ac (texi_macros_file): New variable. * build-aux/common.mk (texi_macros_file, do_subst_default_vals): Substitute it. * run-octave.in (TEXIMACROSFILE): New variable. Pass --texi-macros-file to Octave. * defaults.in.h (OCTAVE_DEFAULT_TEXI_MACROS_FILE): New variable. * default.cc (set_default_texi_macros_file): New function. (install_defaults): Call it. * help.cc (Vtexi_macros_file): New variable. (Ftexi_macros_file): New function. * help.h (Vtexi_macros_file): Provide decl. * octave.cc (TEXI_MACROS_FILE_OPTION): New long option value. (long_opts): Include --texi-macros-file in the list. (octave_main): Handle TEXI_MACROS_FILE_OPTION.
author John W. Eaton <jwe@octave.org>
date Thu, 10 May 2012 12:01:42 -0400
parents
children 88e67d58b06b
comparison
equal deleted inserted replaced
14613:e7c8e31f8e5d 14614:4e9dc46d4125
1 @c Copyright (C) 2012 John W. Eaton
2 @c
3 @c This file is part of Octave.
4 @c
5 @c Octave is free software; you can redistribute it and/or modify it
6 @c under the terms of the GNU General Public License as published by the
7 @c Free Software Foundation; either version 3 of the License, or (at
8 @c your option) any later version.
9 @c
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 @c for more details.
14 @c
15 @c You should have received a copy of the GNU General Public License
16 @c along with Octave; see the file COPYING. If not, see
17 @c <http://www.gnu.org/licenses/>.
18
19 @c The following macro is used for the on-line help system, but we don't
20 @c want lots of `See also: foo, bar, and baz' strings cluttering the
21 @c printed manual (that information should be in the supporting text for
22 @c each group of functions and variables).
23
24 @macro seealso {args}
25 @iftex
26 @vskip 2pt
27 @end iftex
28 @ifnottex
29 @c Texinfo @sp should work but in practice produces ugly results for HTML.
30 @c A simple blank line produces the correct behavior.
31 @c @sp 1
32
33 @end ifnottex
34 @noindent
35 @strong{See also:} \args\.
36 @end macro
37
38 @c The following macro marks words that aspell should ignore during
39 @c spellchecking. Within Texinfo it has no effect as it merely replaces
40 @c the macro call with the argument itself.
41
42 @macro nospell {arg}
43 \arg\
44 @end macro
45
46 @c The following macro works around a situation where the Info/plain text
47 @c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe
48 @c can be confusing if the code segment itself ends with a transpose operator.
49 @ifinfo
50 @macro xcode{arg}
51 \arg\
52 @end macro
53 @end ifinfo
54 @ifnotinfo
55 @macro xcode{arg}
56 @code{\arg\}
57 @end macro
58 @end ifnotinfo