Mercurial > octave

annotate test/pkg/mfile-basic-test/doc/example-package.txi @ 33416:48c2df4bb207

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rename some files for consistency Prefer hyphens over underscores in filenames. Use 'pl' extension for Perl scripts. * build-aux/inplace-edit.pl: Rename from build-aux/inplace_edit.pl. * build-aux/module.mk: Update. * doc/interpreter/doccheck/add-to-aspell-dict.pl: Rename from doc/interpreter/doccheck/add_to_aspell_dict. * doc/interpreter/doccheck/mk-undocumented-list.pl: Rename from doc/interpreter/doccheck/mk_undocumented_list. * doc/interpreter/graphics-properties.mk: Rename from doc/interpreter/graphics_properties.mk. * doc/interpreter/octave-logo.eps: Rename from doc/interpreter/octave_logo.eps. * doc/interpreter/octave-logo.pdf: Rename from doc/interpreter/octave_logo.pdf. * doc/interpreter/octave.texi: Update. * doc/interpreter/module.mk: Update. * etc/RELEASE-CHECKLIST.md: Rename from etc/RELEASE_CHECKLIST.md. * etc/icons/octave-branding-samples.svg: Rename from etc/icons/octave_branding_samples.svg. * etc/module.mk: Update. * scripts/profiler/html/flat-entry.html: Rename from scripts/profiler/html/flat_entry.html. * scripts/profiler/html/hierarchical-entry.htmle: Rename from scripts/profiler/html/hierarchical_entry.html. * scripts/profiler/module.mk, scripts/profiler/profexport.m: Update. * scripts/testfun/private/html-plot-demos-template.html: Rename from scripts/testfun/private/html_plot_demos_template.html. * scripts/testfun/module.mk: Update. * test/classdef-debug/test-classdef-breakpoints.tst: Rename from test/classdef-debug/test_classdef_breakpoints.tst. * scripts/testfun/private/html_compare_plot_demos.m * test/json/jsondecode.tst: Rename from test/json/jsondecode_BIST.tst. * test/classdef-debug/module.mk: Update. * test/json/jsonencode.tst: Rename from test/json/jsonencode_BIST.tst. * test/json/module.mk: Update * test/jupyter-notebook/octave-kernel.ipynb: Rename from test/jupyter-notebook/octave_kernel.ipynb. * test/jupyter-notebook/plot-magic-and-errors.ipynb: Rename from test/jupyter-notebook/plot_magic_and_errors.ipynb. * test/jupyter-notebook/jupyter-notebook.tst, test/jupyter-notebook/module.mk: Update. * test/local-functions/local-functions.tst: Rename from test/local-functions/local_functions.tst. * test/local-functions/module.mk: Update. * test/pkg/pkg/mfile-basic-test: Rename from test/pkg/mfile_basic_test. * test/pkg/mfile-minimal-test: Rename from test/pkg/mfile_minimal_test. * test/pkg/module.mk, test/pkg/pkg.tst: Update.
author John W. Eaton <jwe@octave.org>
date Tue, 16 Apr 2024 12:36:15 -0400
parents test/pkg/mfile_basic_test/doc/example-package.txi@dcd14fd0c5db
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24968
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
1 \input texinfo
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
2 @c %**start of header
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
3 @setfilename example-package.info
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
4 @settitle example-package_doc
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
5 @c %**end of header
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
6
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
7 @c Nowadays the predined function index has entries for each @deftypefn
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
8 @c in additiont to each @findex.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
9 @defcodeindex mfn
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
10
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
11 @copying
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
12 Manual for the example-package for Octave.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
13
25176
dcd14fd0c5db update copyright dates in files in new test/pkg directory
John W. Eaton <jwe@octave.org>
parents: 24968
diff changeset
14 Copyright @copyright{} 2017-2018 @email{Olaf Till <i7tiol@@t-online.de>}
24968
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
15
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
16 You can redistribute this documentation and/or modify it under the terms
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
17 of the GNU General Public License as published by the Free Software
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
18 Foundation; either version 3 of the License, or (at your option) any
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
19 later version.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
20
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
21 This documentation is distributed in the hope that it will be useful,
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
24 Public License for more details.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
25
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
26 You should have received a copy of the GNU General Public License along
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
27 with this documentation; if not, see <http://www.gnu.org/licenses/>.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
28 @end copying
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
29
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
30 @include macros.texi
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
31
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
32 @titlepage
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
33 @title Manual for the example-package for Octave
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
34 @page
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
35 @vskip 0pt plus 1filll
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
36 @insertcopying
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
37 @end titlepage
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
38
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
39 @c No table of contents. The table would occupy most of the top node in
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
40 @c html and IMHO misleads the user to use the table instead of the menu
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
41 @c structure of the nodes, which would let some information unused.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
42 @c
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
43 @c @contents
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
44
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
45 @c ------------------------------------------------------------------
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
46
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
47 @node Top
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
48 @top Manual for the example-package for Octave
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
49
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
50 This documentation applies to version @PACKAGEVERSION of the
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
51 example-package.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
52
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
53 This is a template simple m-file based package for users.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
54
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
55 Normally, a package manual should be structured and should contain more
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
56 than just the helptexts of the functions.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
57
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
58 @menu
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
59 Functions
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
60 * example_mfile:: Placeholder for an mfile.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
61 Indices
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
62 * Function index:: Index of functions.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
63 * Concept index:: Concept index.
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
64 @end menu
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
65
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
66 @c ------------------------------------------------------------------
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
67
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
68 @node example_mfile
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
69 @chapter Placeholder for an mfile
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
70 @mfnindex example_mfile
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
71
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
72 @c include function helptext here
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
73 @DOCSTRING(example_mfile)
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
74
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
75 @c ------------------------------------------------------------------
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
76
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
77 @node Function index
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
78 @unnumbered Index of functions in example-package
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
79
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
80 @printindex mfn
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
81
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
82 @c ------------------------------------------------------------------
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
83
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
84 @node Concept index
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
85 @unnumbered Concept index
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
86
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
87 @printindex cp
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
88
30c7aa427506 test: first pkg test suite
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
89 @bye