view doc/interpreter/macros.texi @ 14615:88e67d58b06b

avoid makeinfo problem with backslash in macro argument * macros.texi (xbackslashchar): New macro. * data.cc (Fmldivide, Fldivide): Use it.
author John W. Eaton <jwe@octave.org>
date Thu, 10 May 2012 11:48:48 -0400
parents 4e9dc46d4125
children 8bba043342ab
line wrap: on
line source

@c Copyright (C) 2012 John W. Eaton
@c
@c This file is part of Octave.
@c
@c Octave is free software; you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c 
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c for more details.
@c 
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <http://www.gnu.org/licenses/>.

@c FIXME -- someday, we might replace this with @backslashchar, which
@c has been added to Texinfo.

@macro xbackslashchar
\\
@end macro

@c The following macro is used for the on-line help system, but we don't
@c want lots of `See also: foo, bar, and baz' strings cluttering the
@c printed manual (that information should be in the supporting text for
@c each group of functions and variables).

@macro seealso {args}
@iftex
@vskip 2pt
@end iftex
@ifnottex
@c Texinfo @sp should work but in practice produces ugly results for HTML.
@c A simple blank line produces the correct behavior. 
@c @sp 1

@end ifnottex
@noindent
@strong{See also:} \args\.
@end macro

@c The following macro marks words that aspell should ignore during
@c spellchecking.  Within Texinfo it has no effect as it merely replaces
@c the macro call with the argument itself.

@macro nospell {arg}
\arg\
@end macro

@c The following macro works around a situation where the Info/plain text
@c expansion of the @code{XXX} macro is `XXX'.  The use of the apostrophe
@c can be confusing if the code segment itself ends with a transpose operator.
@ifinfo
@macro xcode{arg}
\arg\
@end macro
@end ifinfo
@ifnotinfo
@macro xcode{arg}
@code{\arg\}
@end macro
@end ifnotinfo