Mercurial > octave
view test/pkg/mfile-basic-test/doc/example-package.txi @ 33416:48c2df4bb207
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 |
line wrap: on
line source
\input texinfo @c %**start of header @setfilename example-package.info @settitle example-package_doc @c %**end of header @c Nowadays the predined function index has entries for each @deftypefn @c in additiont to each @findex. @defcodeindex mfn @copying Manual for the example-package for Octave. Copyright @copyright{} 2017-2018 @email{Olaf Till <i7tiol@@t-online.de>} You can redistribute this documentation and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this documentation; if not, see <http://www.gnu.org/licenses/>. @end copying @include macros.texi @titlepage @title Manual for the example-package for Octave @page @vskip 0pt plus 1filll @insertcopying @end titlepage @c No table of contents. The table would occupy most of the top node in @c html and IMHO misleads the user to use the table instead of the menu @c structure of the nodes, which would let some information unused. @c @c @contents @c ------------------------------------------------------------------ @node Top @top Manual for the example-package for Octave This documentation applies to version @PACKAGEVERSION of the example-package. This is a template simple m-file based package for users. Normally, a package manual should be structured and should contain more than just the helptexts of the functions. @menu Functions * example_mfile:: Placeholder for an mfile. Indices * Function index:: Index of functions. * Concept index:: Concept index. @end menu @c ------------------------------------------------------------------ @node example_mfile @chapter Placeholder for an mfile @mfnindex example_mfile @c include function helptext here @DOCSTRING(example_mfile) @c ------------------------------------------------------------------ @node Function index @unnumbered Index of functions in example-package @printindex mfn @c ------------------------------------------------------------------ @node Concept index @unnumbered Concept index @printindex cp @bye