Mercurial > hg > octave-nkf

annotate scripts/help/help.m @ 15466:d174210ce1ec stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use ' instead of ` in error messages, warnings and most comments * intro.txi, io.txi, munge-texi.cc, octave.texi, cmd-edit.cc, data-conv.cc, file-ops.cc, glob-match.h, kpse.cc, oct-env.cc, oct-locbuf.h, oct-md5.cc, oct-rand.cc, general/interp2.m, doc.m, get_first_help_sentence.m, help.m, print_usage.m, __additional_help_message__.m, type.m, unimplemented.m, which.m, cast.m, dir.m, license.m, mkoctfile.m, recycle.m, tempdir.m, optimset.m, pkg/pkg.m, closereq.m, colstyle.m, __fltk_print__.m, __gnuplot_print__.m, __go_draw_figure__.m, __pie__.m, __pltopt__.m, __print_parse_opts__.m, uigetdir.m, uigetfile.m, uiputfile.m, stft.m, mean.m, anova.m, cor_test.m, t_test_regression.m, __magick_read__.cc, dlmread.cc, schur.cc, data.cc, debug.cc, defun-dld.h, defun.cc, defun.h, dynamic-ld.cc, error.cc, error.h, gl-render.cc, graphics.cc, gripes.cc, input.cc, lex.ll, load-path.cc, load-save.cc, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-ascii.cc, ls-oct-binary.cc, oct-hist.cc, oct-parse.yy, oct-stream.cc, oct-stream.h, octave.cc, ov-base-diag.cc, ov-base.cc, ov-class.cc, ov-colon.h, ov-struct.cc, ov-typeinfo.cc, ov.cc, pager.cc, pr-output.cc, pt-binop.cc, pt-eval.cc, pt-id.cc, pt-idx.cc, pt-misc.cc, pt-unop.cc, symtab.cc, symtab.h, toplev.cc, txt-eng-ft.cc, utils.cc, variables.cc, test_eval-catch.m, test_try.m: Use ' instead of ` in error messages, warnings, and most comments.
author John W. Eaton <jwe@octave.org>
date Mon, 01 Oct 2012 17:18:49 -0400
parents 72c96de7a403
children 049e8bbff782
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13763
diff changeset
1 ## Copyright (C) 2009-2012 S�ren Hauberg
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
8 ## your option) any later version.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
9 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
13 ## General Public License for more details.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
14 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
18
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
19 ## -*- texinfo -*-
12344
68ac95d2460c Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
20 ## @deftypefn {Command} {} help @var{name}
11567
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
21 ## @deftypefnx {Command} {} help @code{--list}
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
22 ## Display the help text for @var{name}. For example, the command
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
23 ## @kbd{help help} prints a short message describing the @code{help}
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
24 ## command.
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
25 ##
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
26 ## Given the single argument @code{--list}, list all operators,
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
27 ## keywords, built-in functions, and loadable functions available
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
28 ## in the current session of Octave.
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
29 ##
11567
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
30 ## If invoked without any arguments, @code{help} display instructions
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
31 ## on how to access help from the command line.
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
32 ##
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
33 ## The help command can give you information about operators, but not the
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
34 ## comma and semicolons that are used as command separators. To get help
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
35 ## for those, you must type @kbd{help comma} or @kbd{help semicolon}.
9133
c0cef1436788 Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents: 8768
diff changeset
36 ## @seealso{doc, lookfor, which}
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
37 ## @end deftypefn
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
38
10632
69a715c81eab help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents: 10625
diff changeset
39 function retval = help (name)
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
40
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
41 if (nargin == 0)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
42
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
43 puts ("\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
44 For help with individual commands and functions type\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
45 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
46 help NAME\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
47 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
48 (replace NAME with the name of the command or function you would\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
49 like to learn more about).\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
50 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
51 For a more detailed introduction to GNU Octave, please consult the\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
52 manual. To read the manual from the prompt type\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
53 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
54 doc\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
55 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
56 GNU Octave is supported and developed by its user community.\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
57 For more information visit http://www.octave.org.\n\n");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
58
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
59 elseif (nargin == 1 && ischar (name))
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
60
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
61 if (strcmp (name, "--list"))
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
62 tmp = do_list_functions ();
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
63 if (nargout == 0)
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
64 printf ("%s", tmp);
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
65 else
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
66 retval = tmp;
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
67 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
68 return;
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
69 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
70
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
71 ## Get help text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
72 [text, format] = get_help_text (name);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11567
diff changeset
73
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
74 ## Take action depending on help text format
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
75 switch (lower (format))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
76 case "plain text"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
77 status = 0;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
78 case "texinfo"
8768
e0fbf17a17bb __makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents: 8748
diff changeset
79 [text, status] = __makeinfo__ (text, "plain text");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
80 case "html"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
81 [text, status] = strip_html_tags (text);
8631
52956d669506 Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents: 8630
diff changeset
82 case "not documented"
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
83 error ("help: '%s' is not documented\n", name);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
84 case "not found"
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
85 do_contents (name);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
86 return;
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
87 otherwise
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
88 error ("help: internal error: unsupported help text format: '%s'\n", format);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
89 endswitch
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11567
diff changeset
90
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
91 ## Print text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
92 if (status != 0)
8768
e0fbf17a17bb __makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents: 8748
diff changeset
93 warning ("help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
94 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
95
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
96 if (nargout == 0)
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
97 which (name);
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
98 printf ("\n%s\n%s", text, __additional_help_message__ ());
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
99 else
10632
69a715c81eab help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents: 10625
diff changeset
100 retval = text;
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
101 endif
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
102
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
103 else
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
104 error ("help: invalid input\n");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
105 endif
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
106
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
107 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
108
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
109 function retval = do_list_functions ()
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
110
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
111 operators = sprintf ("*** operators:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
112 list_in_columns (__operators__ ()));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
113
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
114 keywords = sprintf ("*** keywords:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
115 list_in_columns (__keywords__ ()));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
116
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
117 builtins = sprintf ("*** builtins:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
118 list_in_columns (__builtins__ ()));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
119
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
120 dirs = strsplit (path, pathsep);
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
121 flist = "";
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
122 for i = 2:numel (dirs)
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
123 files = sort ({dir(fullfile (dirs{i}, "*.m")).name, ...
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
124 dir(fullfile (dirs{i}, "*.oct")).name, ...
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
125 dir(fullfile (dirs{i}, "*.mex")).name});
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
126
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
127 if (! isempty (files))
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
128 flist = sprintf ("%s*** functions in %s:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
129 flist, dirs{i}, list_in_columns (files));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
130 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
131 endfor
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
132
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
133 retval = cstrcat (operators, keywords, builtins, flist);
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
134
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
135 endfunction
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
136
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
137 function do_contents (name)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
138
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
139 found = false;
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
140
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
141 dlist = find_dir_in_path (name, "all");
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
142
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
143 for i = 1:numel (dlist)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
144 fname = make_absolute_filename (fullfile (dlist{i}, "Contents.m"));
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
145
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
146 [text, format] = get_help_text_from_file (fname);
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
147
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
148 ## Take action depending on help text format
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
149 switch (lower (format))
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
150 case "plain text"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
151 status = 0;
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
152 case "texinfo"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
153 [text, status] = __makeinfo__ (text, "plain text");
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
154 case "html"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
155 [text, status] = strip_html_tags (text);
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
156 endswitch
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
157
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
158 if (! isempty (text))
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
159 found = true;
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
160 ## Print text.
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
161 if (status != 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
162 warning ("help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n");
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
163 endif
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
164 printf ("%s:\n\n%s\n", fname, text);
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
165 endif
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
166
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
167 endfor
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
168
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
169 if (found)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
170 puts (__additional_help_message__ ());
10445
62f8ae5ab2cc warn about missing matlab funcs in help
Jaroslav Hajek <highegg@gmail.com>
parents: 9806
diff changeset
171 else
11215
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
172 msg = feval (missing_function_hook, name);
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
173
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
174 if (isempty (msg))
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
175 msg = sprintf ("'%s' not found", name);
11215
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
176 endif
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
177
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
178 error ("help: %s\n", msg);
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
179 endif
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
180
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
181 endfunction
13763
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
182
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
183
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
184 %!assert (! isempty (findstr (help ("ls"), "List directory contents")))
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
185 %!error <invalid input> help (42)