Mercurial > hg > octave-lyh
annotate scripts/help/help.m @ 14363:f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
* wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m,
asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m,
csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m,
accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m,
celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m,
cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m,
flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m,
interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m,
isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m,
narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m,
randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m,
structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m,
griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m,
get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m,
imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m,
textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m,
duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m,
issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m,
qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m,
bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m,
fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m,
ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m,
news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m,
setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m,
warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m,
pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m,
__plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m,
colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m,
ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m,
ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m,
legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m,
orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m,
refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m,
stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m,
deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m,
polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m,
ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m,
autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m,
fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m,
sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m,
pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m,
sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m,
beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m,
nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m,
realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m,
vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m,
iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m,
median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m,
range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m,
statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m,
betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m,
cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m,
chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m,
empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m,
expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m,
gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m,
hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m,
laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m,
logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m,
lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m,
norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m,
poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m,
tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m,
unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m,
wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m,
strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m,
substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m,
asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m,
eomday.m, etime.m, is_leap_year.m, now.m:
Use Octave coding conventions in all m-file %!test blocks
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:29:44 -0800 |
parents | 2fe0f5fa8cc3 |
children | ae42d5a67ed9 |
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 | 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 -*- |
12344
68ac95d2460c
Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
20 ## @deftypefn {Command} {} help @var{name} |
11567 | 21 ## @deftypefnx {Command} {} help @code{--list} |
22 ## Display the help text for @var{name}. For example, the command | |
23 ## @kbd{help help} prints a short message describing the @code{help} | |
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 | 30 ## If invoked without any arguments, @code{help} display instructions |
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" |
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
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 | 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 | 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 | 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 | 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 | 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)) |
8b2a47a99701
help: print message if function not found
John W. Eaton <jwe@octave.org>
parents:
11104
diff
changeset
|
175 msg = sprintf ("`%s' not found", name); |
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 |
14214
2fe0f5fa8cc3
Replace to-be-deprecated findstr occurrences with strfind.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
184 %!assert (! isempty (strfind (help ("ls"), "List directory contents"))) |
13763
85d63b6e49cf
help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents:
12344
diff
changeset
|
185 %!error <invalid input> help (42) |
14214
2fe0f5fa8cc3
Replace to-be-deprecated findstr occurrences with strfind.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
186 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14214
diff
changeset
|
187 |