Mercurial > octave
changeset 24507:dc25a0dc7800
Correct a host of small formatting issues with Texinfo manual (bug #52774)
basics.txi: Move all of the Octave command line option references that begin
with a hyphen to underneath the concept-index entry "options, Octave command"
using the @sortas command, leaving some indentation space with @ @ . Add
a missing @cindex reference for the --eval option and the -W option. Remove
the deprecated -? help option. Move the ~/.octaverc and .octaverc index
entries to "octaverc" via @sortas. Add an index entry for startup.m. Move
the ~/.inputrc index entry to "inputrc" via @sortas. Move the #! index
entry from concept index to operator index, qualifying with "self-contained
script". Move the #, %, #{ and %{ index entries to the operator index
qualifying with "comment marker" or "block comment marker" accordingly.
expr.tex: Move the ":end" index entry to "end" via the @sortas command and
include "end:" as well.
stmt.txi: Change ... and \ index references from @cindex to @opindex and
position near paragraph reference.
xticks.m: Fix a set of three bogus index entries by supplying a missing field
with {} for examples in which the function does not return output.
xticklabels.m: Ditto.
yticks.m: Ditto.
yticklabels.m: Ditto.
zticks.m: Ditto.
zticklabels.m: Ditto.
rticks.m: Ditto.
thetaticks.m: Ditto.
author | Daniel J Sebald <daniel.sebald@ieee.org> |
---|---|
date | Tue, 02 Jan 2018 04:14:36 -0600 |
parents | 9d0522881498 |
children | 85ace8208635 |
files | doc/interpreter/basics.txi doc/interpreter/expr.txi doc/interpreter/stmt.txi scripts/plot/appearance/rticks.m scripts/plot/appearance/thetaticks.m scripts/plot/appearance/xticklabels.m scripts/plot/appearance/xticks.m scripts/plot/appearance/yticklabels.m scripts/plot/appearance/yticks.m scripts/plot/appearance/zticklabels.m scripts/plot/appearance/zticks.m |
diffstat | 11 files changed, 78 insertions(+), 74 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/basics.txi Mon Jan 01 15:58:36 2018 -0600 +++ b/doc/interpreter/basics.txi Tue Jan 02 04:14:36 2018 -0600 @@ -69,25 +69,25 @@ @table @code @item --built-in-docstrings-file @var{filename} -@cindex @code{--built-in-docstrings-file @var{filename}} +@cindex @sortas{options, Octave command --built-in-docstrings-file} @ @ @code{--built-in-docstrings-file @var{filename}} Specify the name of the file containing documentation strings for the built-in functions of Octave. This value is normally correct and should only need to specified in extraordinary situations. @item --debug @itemx -d -@cindex @code{--debug} -@cindex @code{-d} +@cindex @sortas{options, Octave command --debug} @ @ @code{--debug} +@cindex @sortas{options, Octave command -d} @ @ @code{-d} Enter parser debugging mode. Using this option will cause Octave's parser to print a lot of information about the commands it reads, and is probably only useful if you are actually trying to debug the parser. @item --debug-jit -@cindex @code{--debug-jit} +@cindex @sortas{options, Octave command --debug-jit} @ @ @code{--debug-jit} Enable JIT compiler debugging and tracing. @item --doc-cache-file @var{filename} -@cindex @code{--doc-cache-file @var{filename}} +@cindex @sortas{options, Octave command --doc-cache-file} @ @ @code{--doc-cache-file @var{filename}} Specify the name of the doc cache file to use. The value of @var{filename} specified on the command line will override any value of @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands @@ -96,16 +96,17 @@ @item --echo-commands @itemx -x -@cindex @code{--echo-commands} -@cindex @code{-x} +@cindex @sortas{options, Octave command --echo-commands} @ @ @code{--echo-commands} +@cindex @sortas{options, Octave command -x} @ @ @code{-x} Echo commands as they are executed. @item --eval @var{code} +@cindex @sortas{options, Octave command --eval} @ @ @code{--eval @var{code}} Evaluate @var{code} and exit when finished unless @option{--persist} is also specified. @item --exec-path @var{path} -@cindex @code{--exec-path @var{path}} +@cindex @sortas{options, Octave command --exec-path} @ @ @code{--exec-path @var{path}} Specify the path to search for programs to run. The value of @var{path} specified on the command line will override any value of @w{@env{OCTAVE_EXEC_PATH}} found in the environment, but not any commands @@ -113,19 +114,17 @@ @w{@env{EXEC_PATH}}. @item --force-gui -@cindex @code{--force-gui} +@cindex @sortas{options, Octave command --force-gui} @ @ @code{--force-gui} Force the graphical user interface (GUI) to start. @item --help @itemx -h -@itemx -? -@cindex @code{--help} -@cindex @code{-h} -@cindex @code{-?} +@cindex @sortas{options, Octave command --help} @ @ @code{--help} +@cindex @sortas{options, Octave command -h} @ @ @code{-h} Print short help message and exit. @item --image-path @var{path} -@cindex @code{--image-path @var{path}} +@cindex @sortas{options, Octave command --image-path} @ @ @code{--image-path @var{path}} Add path to the head of the search path for images. The value of @var{path} specified on the command line will override any value of @w{@env{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands @@ -133,7 +132,7 @@ @w{@env{IMAGE_PATH}}. @item --info-file @var{filename} -@cindex @code{--info-file @var{filename}} +@cindex @sortas{options, Octave command --info-file} @ @ @code{--info-file @var{filename}} Specify the name of the info file to use. The value of @var{filename} specified on the command line will override any value of @w{@env{OCTAVE_INFO_FILE}} found in the environment, but not any commands @@ -141,7 +140,7 @@ function. @item --info-program @var{program} -@cindex @code{--info-program @var{program}} +@cindex @sortas{options, Octave command --info-program} @ @ @code{--info-program @var{program}} Specify the name of the info program to use. The value of @var{program} specified on the command line will override any value of @w{@env{OCTAVE_INFO_PROGRAM}} found in the environment, but not any @@ -150,65 +149,69 @@ @item --interactive @itemx -i -@cindex @code{--interactive} -@cindex @code{-i} +@cindex @sortas{options, Octave command --interactive} @ @ @code{--interactive} +@cindex @sortas{options, Octave command -i} @ @ @code{-i} Force interactive behavior. This can be useful for running Octave via a remote shell command or inside an Emacs shell buffer. @item --jit-compiler -@cindex @code{--jit-compiler} +@cindex @sortas{options, Octave command --jit-compiler} @ @ @code{--jit-compiler} Enable the JIT compiler used for accelerating loops. @item --line-editing -@cindex @code{--line-editing} +@cindex @sortas{options, Octave command --line-editing} @ @ @code{--line-editing} Force readline use for command-line editing. @item --no-gui -@cindex @code{--no-gui} +@cindex @sortas{options, Octave command --no-gui} @ @ @code{--no-gui} Disable the graphical user interface (GUI) and use the command line interface (CLI) instead. @item --no-history @itemx -H -@cindex @code{--no-history} -@cindex @code{-H} +@cindex @sortas{options, Octave command --no-history} @ @ @code{--no-history} +@cindex @sortas{options, Octave command -H} @ @ @code{-H} Disable recording of command-line history. @item --no-init-file -@cindex @code{--no-init-file} +@cindex @sortas{options, Octave command --no-init-file} @ @ @code{--no-init-file} +@cindex @sortas{octaverc ~/.octaverc} @code{~/.octaverc} +@cindex @sortas{octaverc .octaverc} @code{.octaverc} Don't read the initialization files @file{~/.octaverc} and @file{.octaverc}. @item --no-init-path -@cindex @code{--no-init-path} +@cindex @sortas{options, Octave command --no-init-path} @ @ @code{--no-init-path} Don't initialize the search path for function files to include default locations. @item --no-line-editing -@cindex @code{--no-line-editing} +@cindex @sortas{options, Octave command --no-line-editing} @ @ @code{--no-line-editing} Disable command-line editing. @item --no-site-file -@cindex @code{--no-site-file} +@cindex @sortas{options, Octave command --no-site-file} @ @ @code{--no-site-file} +@cindex site startup file Don't read the site-wide @file{octaverc} initialization files. @item --no-window-system @itemx -W -@cindex @code{--no-window-system} +@cindex @sortas{options, Octave command --no-window-system} @ @ @code{--no-window-system} +@cindex @sortas{options, Octave command -W} @ @ @code{-W} Disable use of a windowing system including graphics. This forces a strictly terminal-only environment. @item --norc @itemx -f -@cindex @code{--norc} -@cindex @code{-f} +@cindex @sortas{options, Octave command --norc} @ @ @code{--norc} +@cindex @sortas{options, Octave command -f} @ @ @code{-f} Don't read any of the system or user initialization files at startup. This is equivalent to using both of the options @option{--no-init-file} and @option{--no-site-file}. @item --path @var{path} @itemx -p @var{path} -@cindex @code{--path @var{path}} -@cindex @code{-p @var{path}} +@cindex @sortas{options, Octave command --path} @ @ @code{--path @var{path}} +@cindex @sortas{options, Octave command -p} @ @ @code{-p @var{path}} Add path to the head of the search path for function files. The value of @var{path} specified on the command line will override any value of @w{@env{OCTAVE_PATH}} found in the environment, but not any commands in the @@ -216,26 +219,26 @@ of the path functions. @item --persist -@cindex @code{--persist} +@cindex @sortas{options, Octave command --persist} @ @ @code{--persist} Go to interactive mode after @option{--eval} or reading from a file named on the command line. @item --silent @itemx --quiet @itemx -q -@cindex @code{--silent} -@cindex @code{--quiet} -@cindex @code{-q} +@cindex @sortas{options, Octave command --silent} @ @ @code{--silent} +@cindex @sortas{options, Octave command --quie} @ @ @code{--quiet} +@cindex @sortas{options, Octave command -q} @ @ @code{-q} Don't print the usual greeting and version message at startup. @item --texi-macros-file @var{filename} -@cindex @code{--texi-macros-file @var{filename}} +@cindex @sortas{options, Octave command --texi-macros-file} @ @ @code{--texi-macros-file @var{filename}} Specify the name of the file containing Texinfo macros for use by makeinfo. @item --traditional @itemx --braindead -@cindex @code{--traditional} -@cindex @code{--braindead} +@cindex @sortas{options, Octave command --traditional} @ @ @code{--traditional} +@cindex @sortas{options, Octave command --braindead} @ @ @code{--braindead} For compatibility with @sc{matlab}, set initial values for user preferences to the following values @@ -279,14 +282,14 @@ @item --verbose @itemx -V -@cindex @code{--verbose} -@cindex @code{-V} +@cindex @sortas{options, Octave command --verbose} @ @ @code{--verbose} +@cindex @sortas{options, Octave command -V} @ @ @code{-V} Turn on verbose output. @item --version @itemx -v -@cindex @code{--version} -@cindex @code{-v} +@cindex @sortas{options, Octave command --version} @ @ @code{--version} +@cindex @sortas{options, Octave command -v} @ @ @code{-v} Print the program version number and exit. @item @var{file} @@ -358,13 +361,13 @@ @item ~/.octaverc @cindex personal startup file -@cindex @code{~/.octaverc} +@cindex @sortas{octaverc ~/.octaverc} @code{~/.octaverc} This file is used to make personal changes to the default Octave environment. @item .octaverc @cindex project startup file -@cindex @code{.octaverc} +@cindex @sortas{octaverc .octaverc} @code{.octaverc} This file can be used to make changes to the default Octave environment for a particular project. Octave searches for this file in the current directory after it reads @file{~/.octaverc}. Any use of the @code{cd} @@ -375,6 +378,7 @@ @file{~/.octaverc} will only be executed once. @item startup.m +@cindex @code{startup.m} This file is used to make personal changes to the default Octave environment. It is executed for @sc{matlab} compatibility, but @file{~/.octaverc} is the preferred location for configuration changes. @@ -747,7 +751,7 @@ @node Customizing readline @subsection Customizing @code{readline} -@cindex @code{~/.inputrc} +@cindex @sortas{inputrc ~/.inputrc} @code{~/.inputrc} @cindex customizing @code{readline} @cindex @code{readline} customization @@ -937,8 +941,8 @@ @cindex batch processing @cindex self contained programs @cindex program, self contained -@cindex @samp{#!} +@opindex @code{#!} self-contained script Once you have learned Octave, you may want to write self-contained Octave scripts, using the @samp{#!} script mechanism. You can do this on GNU systems and on many Unix systems @footnote{The @samp{#!} @@ -1061,9 +1065,9 @@ @node Single Line Comments @subsection Single Line Comments -@cindex @samp{#} -@cindex @samp{%} +@opindex @code{#} comment marker +@opindex @code{%} comment marker In the Octave language, a comment starts with either the sharp sign character, @samp{#}, or the percent symbol @samp{%} and continues to the end of the line. Any text following the sharp sign or percent symbol is @@ -1086,9 +1090,9 @@ @subsection Block Comments @cindex block comments @cindex multi-line comments -@cindex @samp{#@{} -@cindex @samp{%@{} +@opindex @code{#@{} block comment marker +@opindex @code{%@{} block comment marker Entire blocks of code can be commented by enclosing the code between matching @samp{#@{} and @samp{#@}} or @samp{%@{} and @samp{%@}} markers. For example,
--- a/doc/interpreter/expr.txi Mon Jan 01 15:58:36 2018 -0600 +++ b/doc/interpreter/expr.txi Tue Jan 02 04:14:36 2018 -0600 @@ -106,7 +106,7 @@ @end example @cindex @code{end}, indexing -@cindex :end +@cindex @sortas{end:} @code{end:} and @code{:end} In index expressions the keyword @code{end} automatically refers to the last entry for a particular dimension. This magic index can also
--- a/doc/interpreter/stmt.txi Mon Jan 01 15:58:36 2018 -0600 +++ b/doc/interpreter/stmt.txi Tue Jan 02 04:14:36 2018 -0600 @@ -867,9 +867,8 @@ @node Continuation Lines @section Continuation Lines @cindex continuation lines -@cindex @code{...} continuation marker -@cindex @code{\} continuation marker +@opindex @code{...} continuation marker In the Octave language, most statements end with a newline character and you must tell Octave to ignore the newline character in order to continue a statement from one line to the next. Lines that end with the @@ -901,6 +900,7 @@ @noindent is equivalent to the one shown above. +@opindex @code{\} continuation marker Inside double-quoted string constants, the character @code{\} has to be used as continuation marker. The @code{\} must appear at the end of the line just before the newline character:
--- a/scripts/plot/appearance/rticks.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/rticks.m Tue Jan 02 04:14:36 2018 -0600 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} rticks -## @deftypefnx {} rticks (@var{tickval}) +## @deftypefnx {} {} rticks (@var{tickval}) ## @deftypefnx {} {@dots{} =} rticks (@var{hax}, @dots{}) ## Query or set the tick values on the r-axis of the current axis. ##
--- a/scripts/plot/appearance/thetaticks.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/thetaticks.m Tue Jan 02 04:14:36 2018 -0600 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} thetaticks -## @deftypefnx {} thetaticks (@var{tickval}) +## @deftypefnx {} {} thetaticks (@var{tickval}) ## @deftypefnx {} {@dots{} =} thetaticks (@var{hax}, @dots{}) ## Query or set the tick values on the theta-axis of the current axis. ##
--- a/scripts/plot/appearance/xticklabels.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/xticklabels.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} xticklabels ## @deftypefnx {} {@var{mode} =} xticklabels ("mode") -## @deftypefnx {} xticklabels (@var{tickval}) -## @deftypefnx {} xticklabels ("auto") -## @deftypefnx {} xticklabels ("manual") +## @deftypefnx {} {} xticklabels (@var{tickval}) +## @deftypefnx {} {} xticklabels ("auto") +## @deftypefnx {} {} xticklabels ("manual") ## @deftypefnx {} {@dots{} =} xticklabels (@var{hax}, @dots{}) ## Query or set the tick labels on the x-axis of the current axis. ##
--- a/scripts/plot/appearance/xticks.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/xticks.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} xticks ## @deftypefnx {} {@var{mode} =} xticks ("mode") -## @deftypefnx {} xticks (@var{tickval}) -## @deftypefnx {} xticks ("auto") -## @deftypefnx {} xticks ("manual") +## @deftypefnx {} {} xticks (@var{tickval}) +## @deftypefnx {} {} xticks ("auto") +## @deftypefnx {} {} xticks ("manual") ## @deftypefnx {} {@dots{} =} xticks (@var{hax}, @dots{}) ## Query or set the tick values on the x-axis of the current axis. ##
--- a/scripts/plot/appearance/yticklabels.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/yticklabels.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} yticklabels ## @deftypefnx {} {@var{mode} =} yticklabels ("mode") -## @deftypefnx {} yticklabels (@var{tickval}) -## @deftypefnx {} yticklabels ("auto") -## @deftypefnx {} yticklabels ("manual") +## @deftypefnx {} {} yticklabels (@var{tickval}) +## @deftypefnx {} {} yticklabels ("auto") +## @deftypefnx {} {} yticklabels ("manual") ## @deftypefnx {} {@dots{} =} yticklabels (@var{hax}, @dots{}) ## Query or set the tick labels on the x-axis of the current axis. ##
--- a/scripts/plot/appearance/yticks.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/yticks.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} yticks ## @deftypefnx {} {@var{mode} =} yticks ("mode") -## @deftypefnx {} yticks (@var{tickval}) -## @deftypefnx {} yticks ("auto") -## @deftypefnx {} yticks ("manual") +## @deftypefnx {} {} yticks (@var{tickval}) +## @deftypefnx {} {} yticks ("auto") +## @deftypefnx {} {} yticks ("manual") ## @deftypefnx {} {@dots{} =} yticks (@var{hax}, @dots{}) ## Query or set the tick values on the y-axis of the current axis. ##
--- a/scripts/plot/appearance/zticklabels.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/zticklabels.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} zticklabels ## @deftypefnx {} {@var{mode} =} zticklabels ("mode") -## @deftypefnx {} zticklabels (@var{tickval}) -## @deftypefnx {} zticklabels ("auto") -## @deftypefnx {} zticklabels ("manual") +## @deftypefnx {} {} zticklabels (@var{tickval}) +## @deftypefnx {} {} zticklabels ("auto") +## @deftypefnx {} {} zticklabels ("manual") ## @deftypefnx {} {@dots{} =} zticklabels (@var{hax}, @dots{}) ## Query or set the tick labels on the x-axis of the current axis. ##
--- a/scripts/plot/appearance/zticks.m Mon Jan 01 15:58:36 2018 -0600 +++ b/scripts/plot/appearance/zticks.m Tue Jan 02 04:14:36 2018 -0600 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} zticks ## @deftypefnx {} {@var{mode} =} zticks ("mode") -## @deftypefnx {} zticks (@var{tickval}) -## @deftypefnx {} zticks ("auto") -## @deftypefnx {} zticks ("manual") +## @deftypefnx {} {} zticks (@var{tickval}) +## @deftypefnx {} {} zticks ("auto") +## @deftypefnx {} {} zticks ("manual") ## @deftypefnx {} {@dots{} =} zticks (@var{hax}, @dots{}) ## Query or set the tick values on the z-axis of the current axis. ##