Mercurial > hg > octave-nkf

comparison doc/interpreter/tips.txi @ 10791:3140cb7a05a1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents c3df189b1b15
children 5b68000faac1
comparison
equal deleted inserted replaced
10790:01f1643dfbb1 10791:3140cb7a05a1
200 @end example 200 @end example
201 201
202 Sometimes the number of items can't be computed in advance, and stack-like operations 202 Sometimes the number of items can't be computed in advance, and stack-like operations
203 are needed. When elements are being repeatedly inserted at/removed from the end of an 203 are needed. When elements are being repeatedly inserted at/removed from the end of an
204 array, Octave detects it as stack usage and attempts to use a smarter memory management 204 array, Octave detects it as stack usage and attempts to use a smarter memory management
205 strategy preallocating the array in bigger chunks. Likewise works for cell and 205 strategy pre-allocating the array in bigger chunks. Likewise works for cell and
206 struct arrays. 206 struct arrays.
207 207
208 @example 208 @example
209 @group 209 @group
210 a = []; 210 a = [];
516 This help string must be commented in user functions, or in the help 516 This help string must be commented in user functions, or in the help
517 string of the @w{@code{DEFUN_DLD}} macro for dynamically loadable 517 string of the @w{@code{DEFUN_DLD}} macro for dynamically loadable
518 functions. The important aspects of the documentation string are 518 functions. The important aspects of the documentation string are
519 519
520 @table @asis 520 @table @asis
521 @item -*- texinfo -*- 521 @item -*- @nospell{texinfo} -*-
522 This string signals Octave that the following text is in Texinfo format, 522 This string signals Octave that the following text is in Texinfo format,
523 and should be the first part of any help string in Texinfo format. 523 and should be the first part of any help string in Texinfo format.
524 @item @@deftypefn@{class@} @dots{} @@end deftypefn 524 @item @@deftypefn@{class@} @dots{} @@end deftypefn
525 The entire help string should be enclosed within the block defined by 525 The entire help string should be enclosed within the block defined by
526 deftypefn. 526 deftypefn.
543 543
544 Texinfo format has been designed to generate output for online viewing 544 Texinfo format has been designed to generate output for online viewing
545 with text terminals as well as generating high-quality printed output. 545 with text terminals as well as generating high-quality printed output.
546 To these ends, Texinfo has commands which control the diversion of parts 546 To these ends, Texinfo has commands which control the diversion of parts
547 of the document into a particular output processor. Three formats are 547 of the document into a particular output processor. Three formats are
548 of importance: info, html and @TeX{}. These are selected with 548 of importance: info, HTML and @TeX{}. These are selected with
549 549
550 @example 550 @example
551 @group 551 @group
552 @@ifinfo 552 @@ifinfo
553 Text area for info only 553 Text area for info only
569 Text area for TeX only 569 Text area for TeX only
570 @@end tex 570 @@end tex
571 @end group 571 @end group
572 @end example 572 @end example
573 573
574 Note that often @TeX{} output can be used in html documents and so often 574 Note that often @TeX{} output can be used in HTML documents and so often
575 the @code{@@ifhtml} blocks are unnecessary. If no specific output 575 the @code{@@ifhtml} blocks are unnecessary. If no specific output
576 processor is chosen, by default, the text goes into all output 576 processor is chosen, by default, the text goes into all output
577 processors. It is usual to have the above blocks in pairs to allow the 577 processors. It is usual to have the above blocks in pairs to allow the
578 same information to be conveyed in all output formats, but with a 578 same information to be conveyed in all output formats, but with a
579 different markup. Currently, most Octave documentation only makes a 579 different markup. Currently, most Octave documentation only makes a