Mercurial > octave-nkf
annotate scripts/help/help.m @ 11565:21c3e1370b82
implement --list option for help function
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 19 Jan 2011 05:05:07 -0500 |
parents | 3c6e8aaa9555 |
children | 5c18da80e28a |
rev | line source |
---|---|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
1 ## Copyright (C) 2009-2011 S�ren Hauberg |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
2 ## |
11104 | 3 ## This file is part of Octave. |
4 ## | |
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 | 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 | 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 -*- |
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
20 ## @deftypefn {Command} {} help @var{name} |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
21 ## @deftypefn {Command} {} help @code{--list} |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
22 ## Display the help text for @var{name}. |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
23 ## If invoked without any arguments, @code{help} display instructions |
10625
07933067e4ab
help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents:
10549
diff
changeset
|
24 ## 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
|
25 ## |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
26 ## For example, the command @kbd{help help} prints a short message |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
27 ## describing the @code{help} command. |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
28 ## |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
29 ## 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
|
30 ## 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
|
31 ## in the current session of Octave. |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
32 ## |
10625
07933067e4ab
help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents:
10549
diff
changeset
|
33 ## @deftypefnx {Function File} {@var{text} =} help (@var{name}) |
07933067e4ab
help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents:
10549
diff
changeset
|
34 ## Return the help text for the function, @var{name}. |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
35 ## |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
36 ## 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
|
37 ## 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
|
38 ## 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
|
39 ## @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
|
40 ## @end deftypefn |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
41 |
10632
69a715c81eab
help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents:
10625
diff
changeset
|
42 function retval = help (name) |
8748
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
43 |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
44 if (nargin == 0) |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
45 |
8748
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
46 puts ("\n\ |
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
47 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
|
48 \n\ |
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
49 help NAME\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 (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
|
52 like to learn more about).\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 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
|
55 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
|
56 \n\ |
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
57 doc\n\ |
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
58 \n\ |
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
59 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
|
60 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
|
61 |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
62 elseif (nargin == 1 && ischar (name)) |
8748
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
63 |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
64 if (strcmp (name, "--list")) |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
65 tmp = do_list_functions (); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
66 if (nargout == 0) |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
67 printf ("%s", tmp); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
68 else |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
69 retval = tmp; |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
70 endif |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
71 return; |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
72 endif |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
73 |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
74 ## Get help text |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
75 [text, format] = get_help_text (name); |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
76 |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
77 ## Take action depending on help text format |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
78 switch (lower (format)) |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
79 case "plain text" |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
80 status = 0; |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
81 case "texinfo" |
8768
e0fbf17a17bb
__makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents:
8748
diff
changeset
|
82 [text, status] = __makeinfo__ (text, "plain text"); |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
83 case "html" |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
84 [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
|
85 case "not documented" |
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
86 error ("help: `%s' is not documented\n", name); |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
87 case "not found" |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
88 do_contents (name); |
10549 | 89 return; |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
90 otherwise |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
91 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
|
92 endswitch |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
93 |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
94 ## Print text |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
95 if (status != 0) |
8768
e0fbf17a17bb
__makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents:
8748
diff
changeset
|
96 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
|
97 endif |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
98 |
10625
07933067e4ab
help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents:
10549
diff
changeset
|
99 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
|
100 which (name); |
07933067e4ab
help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents:
10549
diff
changeset
|
101 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
|
102 else |
10632
69a715c81eab
help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents:
10625
diff
changeset
|
103 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
|
104 endif |
8748
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
105 |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
106 else |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
107 error ("help: invalid input\n"); |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
108 endif |
8748
d1eed318100f
help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents:
8746
diff
changeset
|
109 |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
110 endfunction |
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
111 |
11565
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
112 function retval = do_list_functions () |
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 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
|
115 list_in_columns (__operators__ ())); |
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 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
|
118 list_in_columns (__keywords__ ())); |
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 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
|
121 list_in_columns (__builtins__ ())); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
122 |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
123 dirs = strsplit (path, pathsep); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
124 flist = ""; |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
125 for i = 2:numel (dirs) |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
126 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
|
127 dir(fullfile (dirs{i}, "*.oct")).name, ... |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
128 dir(fullfile (dirs{i}, "*.mex")).name}); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
129 |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
130 if (! isempty (files)) |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
131 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
|
132 flist, dirs{i}, list_in_columns (files)); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
133 endif |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
134 endfor |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
135 |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
136 retval = cstrcat (operators, keywords, builtins, flist); |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
137 |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
138 endfunction |
21c3e1370b82
implement --list option for help function
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
139 |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
140 function do_contents (name) |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
141 |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
142 found = false; |
8630
540165304f00
Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents:
8575
diff
changeset
|
143 |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
144 dlist = find_dir_in_path (name, "all"); |
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 for i = 1:numel (dlist) |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
147 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
|
148 |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
149 [text, format] = get_help_text_from_file (fname); |
8630
540165304f00
Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents:
8575
diff
changeset
|
150 |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
151 ## Take action depending on help text format |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
152 switch (lower (format)) |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
153 case "plain text" |
10549 | 154 status = 0; |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
155 case "texinfo" |
10549 | 156 [text, status] = __makeinfo__ (text, "plain text"); |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
157 case "html" |
10549 | 158 [text, status] = strip_html_tags (text); |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
159 endswitch |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
160 |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
161 if (! isempty (text)) |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
162 found = true; |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
163 ## Print text. |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
164 if (status != 0) |
10549 | 165 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
|
166 endif |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
167 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
|
168 endif |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
169 |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
170 endfor |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
171 |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
172 if (found) |
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
173 puts (__additional_help_message__ ()); |
10445
62f8ae5ab2cc
warn about missing matlab funcs in help
Jaroslav Hajek <highegg@gmail.com>
parents:
9806
diff
changeset
|
174 else |
11215
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
175 msg = feval (missing_function_hook, name); |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
176 |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
177 if (isempty (msg)) |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
178 msg = sprintf ("`%s' not found", name); |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
179 endif |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
180 |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
181 error ("help: %s\n", msg); |
8630
540165304f00
Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents:
8575
diff
changeset
|
182 endif |
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9724
diff
changeset
|
183 |
8630
540165304f00
Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents:
8575
diff
changeset
|
184 endfunction |