Mercurial > octave-nkf

annotate scripts/help/get_first_help_sentence.m @ 20354:227d582fa300 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
build: Sort generated PKG_ADD contents consistently * libinterp/mk-pkg-add: Set LC_COLLATE=C when sorting for consistent output.
author Mike Miller <mtmiller@octave.org>
date Fri, 10 Jul 2015 01:10:30 -0400
parents aa36fb998a4d
children 83792dd9bcc1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 18851
diff changeset
1 ## Copyright (C) 2009-2015 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: 10793
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
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: 10793
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: 10793
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 -*-
20193
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
20 ## @deftypefn {Function File} {@var{text} =} get_first_help_sentence (@var{name})
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
21 ## @deftypefnx {Function File} {@var{text} =} get_first_help_sentence (@var{name}, @var{max_len})
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
22 ## @deftypefnx {Function File} {[@var{text}, @var{status}] =} get_first_help_sentence (@dots{})
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
23 ## Return the first sentence of a function's help text.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
24 ##
20193
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
25 ## The first sentence is defined as the text after the function declaration
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
26 ## until either the first period (".") or the first appearance of two
20216
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20193
diff changeset
27 ## consecutive newlines ("\n\n"). The text is truncated to a maximum length of
20193
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
28 ## @var{max_len}, which defaults to 80.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
29 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
30 ## The optional output argument @var{status} returns the status reported by
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8768
diff changeset
31 ## @code{makeinfo}. If only one output argument is requested, and @var{status}
18851
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage.
Rik <rik@octave.org>
parents: 18191
diff changeset
32 ## is nonzero, a warning is displayed.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
33 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
34 ## As an example, the first sentence of this help text is
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
35 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
36 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8768
diff changeset
37 ## @group
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
38 ## get_first_help_sentence ("get_first_help_sentence")
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
39 ## @print{} ans = Return the first sentence of a function's help text.
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8768
diff changeset
40 ## @end group
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
41 ## @end example
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
42 ## @end deftypefn
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
43
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
44 function [text, status] = get_first_help_sentence (name, max_len = 80)
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
45 ## Check input
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
46 if (nargin < 1 || nargin > 2)
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
47 print_usage ();
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
48 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
49
19867
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
50 if (! ischar (name))
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
51 error ("get_first_help_sentence: NAME must be a string");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
52 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
53
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
54 if (! isnumeric (max_len) || max_len <= 0 || max_len != fix (max_len))
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
55 error ("get_first_help_sentence: MAX_LEN must be positive integer");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
56 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
57
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
58 ## First, we get the raw help text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
59 [help_text, format] = get_help_text (name);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
60
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
61 ## Then, we take action depending on the format
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
62 switch (lower (format))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
63 case "plain text"
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
64 [text, status] = first_sentence_plain_text (help_text, max_len);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
65 case "texinfo"
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
66 [text, status] = first_sentence_texinfo (help_text, max_len);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
67 case "html"
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
68 [text, status] = first_sentence_html (help_text, max_len);
8631
52956d669506 Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
69 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
70 error ("get_first_help_sentence: '%s' is not documented\n", name);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
71 case "not found"
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
72 error ("get_first_help_sentence: '%s' not found\n", name);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
73 otherwise
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
74 error ("get_first_help_sentence: internal error: unsupported help text format: '%s'\n", format);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
75 endswitch
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 if (nargout <= 1 && status != 0)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
78 warning ("get_first_help_sentence: couldn't run makeinfo on '%s'", name);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
79 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
80 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
81
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
82 ## This function extracts the first sentence from a plain text help text
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
83 function [text, status] = first_sentence_plain_text (help_text, max_len)
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
84 ## Extract first line by searching for a period followed by a space class
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
85 ## character (to support periods in numbers or words) ...
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
86 period_idx = regexp (help_text, '\.\s', "once");
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
87 ## ... or a double end-of-line (we subtract 1 because we are not interested
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
88 ## in capturing the first newline).
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
89 line_end_idx = regexp (help_text, "\n\n", "once") - 1;
14763
154c150f6a21 get_first_help_sentence: use period followed by non-word character to indentify end of sentence
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
90 text = help_text (1:min ([period_idx; line_end_idx; max_len; length(help_text)]));
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
91 status = 0;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
92 endfunction
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 ## This function extracts the first sentence from a Texinfo help text.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
95 ## The function works by removing @def* from the texinfo text. After this, we
19867
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
96 ## render the text to plain text using makeinfo, and then extract the first
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
97 ## line.
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
98 function [text, status] = first_sentence_texinfo (help_text, max_len)
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
99 ## Lines ending with "@\n" are continuation lines, so they should be
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
100 ## concatenated with the following line.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
101 help_text = strrep (help_text, "@\n", " ");
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
102
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
103 ## Find, and remove, lines that start with @def. This should remove things
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
104 ## such as @deftypefn, @deftypefnx, @defvar, etc.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
105 keep = true (size (help_text));
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
106 def_idx = strfind (help_text, "@def");
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
107 if (! isempty (def_idx))
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
108 endl_idx = find (help_text == "\n");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
109 for k = 1:length (def_idx)
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14765
diff changeset
110 endl = endl_idx(find (endl_idx > def_idx(k), 1));
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
111 if (isempty (endl))
17591
7c479b7d3aab get_first_help_sentence.m: Fix code for m-files with multiple @deftypefn pairs like gallery (bug #40197).
Rik <rik@octave.org>
parents: 17338
diff changeset
112 endl = numel (keep);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
113 endif
17591
7c479b7d3aab get_first_help_sentence.m: Fix code for m-files with multiple @deftypefn pairs like gallery (bug #40197).
Rik <rik@octave.org>
parents: 17338
diff changeset
114 keep(def_idx(k):endl) = false;
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
115 endfor
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
116
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
117 ## Remove the @end ... that corresponds to the @def we removed above
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
118 def1 = def_idx(1);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
119 space_idx = find (help_text == " ");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
120 space_idx = space_idx (find (space_idx > def1, 1));
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
121 bracket_idx = find (help_text == "{" | help_text == "}");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
122 bracket_idx = bracket_idx (find (bracket_idx > def1, 1));
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
123 if (isempty (space_idx) && isempty (bracket_idx))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
124 error ("get_first_help_sentence: couldn't parse texinfo");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
125 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
126 sep_idx = min (space_idx, bracket_idx);
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
127 def_type = help_text(def1+1:sep_idx-1);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
128
18191
f80d258a2c7d get_first_help_sentence.m: avoid out-of-bound error (bug #41053)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 17744
diff changeset
129 end_idx = strfind (help_text, sprintf ("@end %s", def_type));
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
130 if (isempty (end_idx))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
131 error ("get_first_help_sentence: couldn't parse texinfo");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
132 endif
18191
f80d258a2c7d get_first_help_sentence.m: avoid out-of-bound error (bug #41053)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 17744
diff changeset
133 keep(end_idx(1):end) = false;
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
134
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
135 help_text = help_text(keep);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
136 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
137
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
138 ## Run makeinfo to generate plain text
8768
e0fbf17a17bb __makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents: 8631
diff changeset
139 [help_text, status] = __makeinfo__ (help_text, "plain text");
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
140
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
141 ## Extract first line with plain text method.
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
142 text = first_sentence_plain_text (help_text, max_len);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
143 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
144
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
145 ## This function extracts the first sentence from a html help text.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
146 ## The function simply removes the tags and treats the text as plain text.
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
147 function [text, status] = first_sentence_html (help_text, max_len)
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
148 ## Strip tags
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
149 [help_text, status] = strip_html_tags (help_text);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
150
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
151 ## Extract first line with plain text method.
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
152 text = first_sentence_plain_text (help_text, max_len);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
153 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
154
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
155
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17243
diff changeset
156 %!assert (get_first_help_sentence ('get_first_help_sentence'), ...
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17243
diff changeset
157 %! "Return the first sentence of a function's help text.")
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
158
19867
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
159 ## Test input validation
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
160 %!error get_first_help_sentence ()
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
161 %!error get_first_help_sentence (1, 2, 3)
14765
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
162 %!error <NAME must be a string> get_first_help_sentence (1)
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
163 %!error <MAX_LEN must be positive integer> get_first_help_sentence ("ls", "a")
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
164 %!error <MAX_LEN must be positive integer> get_first_help_sentence ("ls", 0)
1f1777cab828 get_first_help_sentence.m: Use a period followed by any regexp space character as a possible sentence boundary.
Rik <octave@nomad.inbox5.com>
parents: 14764
diff changeset
165 %!error <MAX_LEN must be positive integer> get_first_help_sentence ("ls", 80.1)
12519
91ccd08fe80c Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
166