./PaxHeaders/generate_html-0.3.30000644000000000000000000000013114234274056013477 xustar0029 mtime=1651603502.38614879 30 atime=1651603502.421150791 30 ctime=1651603502.421150791 generate_html-0.3.3/0000755000175000017500000000000014234274056014232 5ustar00jadejade00000000000000generate_html-0.3.3/PaxHeaders/Makefile0000644000000000000000000000006214234263413015055 xustar0020 atime=1651599115 30 ctime=1651603502.421150791 generate_html-0.3.3/Makefile0000644000175000017500000001630114234263413015666 0ustar00jadejade00000000000000## Copyright 2015-2016 Carnë Draug ## Copyright 2015-2016 Oliver Heimlich ## Copyright 2017 Julien Bect ## Copyright 2017 Olaf Till ## ## Copying and distribution of this file, with or without modification, ## are permitted in any medium without royalty provided the copyright ## notice and this notice are preserved. This file is offered as-is, ## without any warranty. ## Some basic tools (can be overriden using environment variables) SED ?= sed TAR ?= tar GREP ?= grep CUT ?= cut ## Note the use of ':=' (immediate set) and not just '=' (lazy set). ## http://stackoverflow.com/a/448939/1609556 package := $(shell $(GREP) "^Name: " DESCRIPTION | $(CUT) -f2 -d" ") version := $(shell $(GREP) "^Version: " DESCRIPTION | $(CUT) -f2 -d" ") ## This are the paths that will be created for the releases. Using ## $(realpath ...) avoids problems with symlinks. target_dir := $(realpath .)/target release_dir := $(target_dir)/$(package)-$(version) release_tarball := $(target_dir)/$(package)-$(version).tar.gz html_dir := $(target_dir)/$(package)-html html_tarball := $(target_dir)/$(package)-html.tar.gz installation_dir := $(target_dir)/.installation package_list := $(installation_dir)/.octave_packages install_stamp := $(installation_dir)/.install_stamp ## These can be set by environment variables which allow to easily ## test with different Octave versions. ifndef OCTAVE OCTAVE := octave endif OCTAVE := $(OCTAVE) --no-gui --silent --no-history --norc MKOCTFILE ?= mkoctfile ## Command used to set permissions before creating tarballs FIX_PERMISSIONS ?= chmod -R a+rX,u+w,go-w,ug-s ## Detect which VCS is used vcs := $(if $(wildcard .hg),hg,$(if $(wildcard .git),git,unknown)) ifeq ($(vcs),hg) release_dir_dep := .hg/dirstate endif ifeq ($(vcs),git) release_dir_dep := .git/index endif ## .PHONY indicates targets that are not filenames ## (https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html) .PHONY: help ## make will display the command before runnning them. Use @command ## to not display it (makes specially sense for echo). help: @echo "Targets:" @echo " dist - Create $(release_tarball) for release." @echo " html - Create $(html_tarball) for release." @echo " release - Create both of the above and show md5sums." @echo " install - Install the package in $(installation_dir), where it is not visible in a normal Octave session." @echo " check - Execute package tests." @echo " doctest - Test the help texts with the doctest package." @echo " run - Run Octave with the package installed in $(installation_dir) in the path." @echo " clean - Remove everything made with this Makefile." ## ## Recipes for release tarballs (package + html) ## .PHONY: release dist html clean-tarballs clean-unpacked-release ## To make a release, build the distribution and html tarballs. release: dist html md5sum $(release_tarball) $(html_tarball) @echo "Upload @ https://sourceforge.net/p/octave/package-releases/new/" @echo " and inform to rebuild release with '$$(hg id)'" ## dist and html targets are only PHONY/alias targets to the release ## and html tarballs. dist: $(release_tarball) html: $(html_tarball) ## An implicit rule with a recipe to build the tarballs correctly. %.tar.gz: % $(TAR) -c -f - --posix -C "$(target_dir)/" "$(notdir $<)" | gzip -9n > "$@" clean-tarballs: @echo "## Cleaning release tarballs (package + html)..." -$(RM) $(release_tarball) $(html_tarball) @echo ## Create the unpacked package. ## ## Notes: ## * having ".hg/dirstate" (or ".git/index") as a prerequesite means it is ## only rebuilt if we are at a different commit. ## * the variable RM usually defaults to "rm -f" ## * having this recipe separate from the one that makes the tarball ## makes it easy to have packages in alternative formats (such as zip) ## * note that if a commands needs to be run in a specific directory, ## the command to "cd" needs to be on the same line. Each line restores ## the original working directory. $(release_dir): $(release_dir_dep) -$(RM) -r "$@" ifeq (${vcs},hg) hg archive --exclude ".hg*" --type files "$@" endif ifeq (${vcs},git) git archive --format=tar --prefix="$@/" HEAD | $(TAR) -x $(RM) "$@/.gitignore" endif ## Don't fall back to run the supposed necessary contents of ## 'bootstrap' here. Users are better off if they provide ## 'bootstrap'. Administrators, checking build reproducibility, can ## put in the missing 'bootstrap' file if they feel they know its ## necessary contents. ifneq (,$(wildcard src/bootstrap)) cd "$@/src" && ./bootstrap && $(RM) -r "autom4te.cache" endif ${FIX_PERMISSIONS} "$@" run_in_place = $(OCTAVE) --eval ' pkg ("local_list", "$(package_list)"); ' \ --eval ' pkg ("load", "$(package)"); ' $(html_dir): $(install_stamp) $(RM) -r "$@"; $(run_in_place) \ --eval ' pkg load generate_html; ' \ --eval ' generate_package_html ("$(package)", "$@", "octave-forge"); '; $(FIX_PERMISSIONS) "$@"; clean-unpacked-release: @echo "## Cleaning unpacked release tarballs (package + html)..." -$(RM) -r $(release_dir) $(html_dir) @echo ## ## Recipes for installing the package. ## .PHONY: install clean-install octave_install_commands = \ ' llist_path = pkg ("local_list"); \ mkdir ("$(installation_dir)"); \ load (llist_path); \ local_packages(cellfun (@ (x) strcmp ("$(package)", x.name), local_packages)) = []; \ save ("$(package_list)", "local_packages"); \ pkg ("local_list", "$(package_list)"); \ pkg ("prefix", "$(installation_dir)", "$(installation_dir)"); \ pkg ("install", "-local", "-verbose", "$(release_tarball)"); ' ## Install unconditionally. Maybe useful for testing installation with ## different versions of Octave. install: $(release_tarball) @echo "Installing package under $(installation_dir) ..." $(OCTAVE) --eval $(octave_install_commands) touch $(install_stamp) ## Install only if installation (under target/...) is not current. $(install_stamp): $(release_tarball) @echo "Installing package under $(installation_dir) ..." $(OCTAVE) --eval $(octave_install_commands) touch $(install_stamp) clean-install: @echo "## Cleaning installation under $(installation_dir) ..." -$(RM) -r $(installation_dir) @echo ## ## Recipes for testing purposes ## .PHONY: run doctest check ## Start an Octave session with the package directories on the path for ## interactice test of development sources. run: $(install_stamp) $(run_in_place) --persist ## Test example blocks in the documentation. Needs doctest package ## https://octave.sourceforge.io/doctest/index.html doctest: $(install_stamp) $(run_in_place) --eval 'pkg load doctest;' \ --eval "targets = pkg('list', '$(package)'){1}.dir;" \ --eval "doctest (targets);" ## Test package. octave_test_commands = \ ' pkgs = pkg("list","$(package)"); dirs = { pkgs{1}.dir }; \ __run_test_suite__ (dirs, {}); ' check: $(install_stamp) $(run_in_place) --eval $(octave_test_commands) ## ## CLEAN ## .PHONY: clean clean: clean-tarballs clean-unpacked-release clean-install @echo "## Removing target directory (if empty)..." -rmdir $(target_dir) @echo @echo "## Cleaning done" @echo generate_html-0.3.3/PaxHeaders/inst0000644000000000000000000000013214234274056014320 xustar0030 mtime=1651603502.398149476 30 atime=1651603502.422150848 30 ctime=1651603502.421150791 generate_html-0.3.3/inst/0000755000175000017500000000000014234274056015207 5ustar00jadejade00000000000000generate_html-0.3.3/inst/PaxHeaders/generate_operators.m0000644000000000000000000000006214234263413020440 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/generate_operators.m0000644000175000017500000001037214234263413021253 0ustar00jadejade00000000000000## Copyright (C) 2014 Julien Bect ## Copyright (C) 2008 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} generate_operators (@var{outdir}, @var{options}) ## Generate a HTML page with a list of operators available in GNU Octave. ## @end deftypefn function generate_operators (outdir = "htdocs", options = struct ()) ## Check input if (!ischar (outdir)) error ("First input argument must be a string"); endif ## Process input argument 'options' if (ischar (options)) || (isstruct (options)) options = get_html_options (options); else error ("Second input argument must be a string or a structure"); endif ## Create directories if needed assert_dir (outdir); name = fullfile (outdir, "operators.html"); ## Generate html title = "Operators and Keywords"; options.body_command = 'onload="javascript:fix_top_menu ();"'; ## Initialize setopts. setopts (options, struct ()); vpars = struct ("name", title, "pkgroot", ""); header = getopt ("overview_header", vpars); title = getopt ("overview_title", vpars); footer = getopt ("overview_footer", vpars); fid = fopen (name, "w"); if (fid < 0) error ("Couldn't open file for writing"); endif fprintf (fid, "%s\n", header); fprintf (fid, "

Operators

\n\n"); write_list (__operators__, fid, false); fprintf (fid, "

Keywords

\n\n"); write_list (__keywords__, fid, true); fprintf (fid, "\n%s\n", footer); fclose (fid); endfunction function write_list (list, fid, write_anchors) for k = 1:length (list) elem = list{k}; [text, format] = get_help_text (elem); if (strcmp (format, "texinfo")) text = strip_defs (text); text = __makeinfo__ (text, "plain text"); endif if (write_anchors) fprintf (fid, "\n", elem); endif fprintf (fid, "
%s
\n", elem); fprintf (fid, "
%s
\n", text); # XXX: don't use text if (write_anchors) fprintf (fid, "\n\n"); endif endfor endfunction function text = strip_defs (text) ## Lines ending with "@\n" are continuation lines, so they should be concatenated ## with the following line. text = strrep (text, "@\n", " "); ## Find, and remove, lines that start with @def. This should remove things ## such as @deftypefn, @deftypefnx, @defvar, etc. keep = true (size (text)); def_idx = strfind (text, "@def"); if (!isempty (def_idx)) endl_idx = find (text == "\n"); for k = 1:length (def_idx) endl = endl_idx (find (endl_idx > def_idx (k), 1)); if (isempty (endl)) keep (def_idx (k):end) = false; else keep (def_idx (k):endl) = false; endif endfor ## Remove the @end ... that corresponds to the @def we removed above def1 = def_idx (1); space_idx = find (text == " "); space_idx = space_idx (find (space_idx > def1, 1)); bracket_idx = find (text == "{" | text == "}"); bracket_idx = bracket_idx (find (bracket_idx > def1, 1)); if (isempty (space_idx) && isempty (bracket_idx)) error ("Couldn't parse texinfo"); endif sep_idx = min (space_idx, bracket_idx); def_type = text (def1+1:sep_idx-1); end_idx = strfind (text, sprintf ("@end %s", def_type)); if (isempty (end_idx)) error ("Couldn't parse texinfo"); endif endl = endl_idx (find (endl_idx > end_idx, 1)); if (isempty (endl)) keep (end_idx:end) = false; else keep (end_idx:endl) = false; endif text = text (keep); endif endfunction generate_html-0.3.3/inst/PaxHeaders/private0000644000000000000000000000013214234274056015772 xustar0030 mtime=1651603502.397149419 30 atime=1651603502.422150848 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/0000755000175000017500000000000014234274056016661 5ustar00jadejade00000000000000generate_html-0.3.3/inst/private/PaxHeaders/find_package.m0000644000000000000000000000006214234263413020615 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/find_package.m0000644000175000017500000000221014234263413021420 0ustar00jadejade00000000000000## Copyright (C) 2009 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} find_package () ## undocumented internal function ## @end deftypefn function [package, found] = find_package (name) package = "octave"; p = which (name); found = !isempty (p); l = pkg ("list"); for k = 1:length (l) d = l{k}.dir; idx = strfind (p, d); if (numel (idx) == 1 && idx == 1) package = l{k}.name; break; endif endfor endfunction generate_html-0.3.3/inst/private/PaxHeaders/get_output.m0000644000000000000000000000006214234263413020421 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/get_output.m0000644000175000017500000000600514234263413021232 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014, 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} get_output () ## undocumented internal function ## @end deftypefn function [text, images] = get_output (demo_num, ... code, imagedir, full_imagedir, fileprefix) ### This function must not be a subfunction, since declaring variables ### in eval'ed code is not allowed (anymore). See ### http://savannah.gnu.org/bugs/?52632 ## Clear everything close all diary_file = "__diary__.txt"; if (exist (diary_file, "file")) delete (diary_file); endif unwind_protect ## Hide figures only if gnuplot is in use ## (fltk doesn't currently support offscreen printing; see bug #33180) def = get (0, "defaultfigurevisible"); if strcmp (graphics_toolkit, "gnuplot") set (0, "defaultfigurevisible", "off"); endif ## Pager off more_val = page_screen_output (false); ## Evaluate the code diary (diary_file); eval (code); diary ("off"); ## Read the results fid = fopen (diary_file, "r"); diary_data = char (fread (fid).'); fclose (fid); ## Remove 'diary ("off");' from the diary idx = strfind (diary_data, "diary (\"off\");"); if (isempty (idx)) text = diary_data; else text = diary_data (1:idx (end)-1); endif text = strtrim (text); ## Save figures if (!isempty (get (0, "currentfigure")) && !exist (full_imagedir, "dir")) [succ, msg] = mkdir (full_imagedir); if (!succ) error ("Unable to create directory %s:\n %s", full_imagedir, msg); endif endif ## For @class methods: Clean up fileprefix fileprefix = strrep (fileprefix, filesep (), '_'); images = {}; r = demo_num * 100; while (!isempty (get (0, "currentfigure"))) r = r + 1; fig = gcf (); name = sprintf ("%s_%d.png", fileprefix, r); full_filename = fullfile (full_imagedir, name); filename = fullfile (imagedir, name); print (fig, full_filename); images{end+1} = filename; close (fig); endwhile ## Reverse image list, since we got them latest-first images = images (end:-1:1); unwind_protect_cleanup delete (diary_file); set (0, "defaultfigurevisible", def); page_screen_output (more_val); end_unwind_protect endfunction generate_html-0.3.3/inst/private/PaxHeaders/__texi2html__.m0000644000000000000000000000006214234263413020736 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/__texi2html__.m0000644000175000017500000000727214234263413021556 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} __texi2html__ () ## undocumented internal function ## @end deftypefn function [header, text, footer] = __texi2html__ (text, vpars) ## Add easily recognisable text before and after real text start = "###### OCTAVE START ######"; stop = "###### OCTAVE STOP ######"; text = sprintf ("%s\n%s\n%s\n", start, text, stop); ## Prevent empty
blocks ## (see https://savannah.gnu.org/bugs/?44451) text = regexprep (text, '([\r\n|\n])[ \t]*@group', '$1@group'); text = regexprep (text, '([\r\n|\n])[ \t]*@end', '$1@end'); ## Remove one leading white space. Assuming that all non-empty ## lines start with "## ", this prevents one extra white space ## from showing up in example blocks. text = regexprep (text, '([\r\n|\n])[ \t]', '$1'); ## Run makeinfo orig_text = text; [text, status] = __makeinfo__ (text, ... "html", @(x) getopt ("seealso") (root, x{:})); if (status != 0) error ("__makeinfo__ returned with error code %d\n. Couldn't parse\ texinfo:\n%s", status, orig_text (1:min (200, length (orig_text)))); endif ## Check encoding tmp = regexp (text, "charset\s*=\s*([^\s\"]*)", "tokens"); if (! isempty (tmp)) charset = tmp{1}{1}; if (! strcmp (options_charset = getopt ("charset"), charset)) warning (["makeinfo's output is encoded in %s, but will be " ... "interpreted with options.charset = %s"], charset, options_charset); endif endif ## Extract the body of makeinfo's output p_start = sprintf ('\\s*(

)?\\s*%s\\s*(

)?\\s*', start); p_stop = sprintf ('\\s*(

)?\\s*%s\\s*(

)?\\s*', stop); [i1, i2] = regexp (text, p_start); i3 = regexp (text, p_stop); text = text((i2 + 1):(i3 - 1)); ## Insert class="deftypefn" attribute text = insert_deftypefn_class_attribute (text); ## Read options. header = getopt ("header", vpars); footer = getopt ("footer", vpars); endfunction function text = insert_deftypefn_class_attribute (text) ## @deftypefn pattern for TexInfo 4.x p1 = '—\s*(Function.*?)\s*
'; if ~ isempty (regexp (text, p1, 'once')) ## TexInfo 4.x ##
## — Function File: ...
## — Function File: ...
##
...
##
p2 = sprintf (['\\s*\\s*' ... '((?:%s\\s*)+)
(.*?)\\s*
\\s*\\s*'], p1); text = regexprep (text, p2, '
\n$1
$3\n
'); text = regexprep (text, p1, '
$1
'); else ## TexInfo 5.x ##
##
Function File: ...
##
Function File: ...
##
...
##
## @deftypefn pattern for TexInfo 5.x p1 = '
\s*(()?\s*Function.*?)\s*
'; text = regexprep (text, p1, '
$1
'); endif endfunction generate_html-0.3.3/inst/private/PaxHeaders/__html_help_text__.m0000644000000000000000000000006214234263413022036 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/__html_help_text__.m0000644000175000017500000001051314234263413022646 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014, 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} __html_help_text__ () ## undocumented internal function ## @end deftypefn function __html_help_text__ (outname, vpars) name = vpars.name; ## Get the help text of the function [text, format] = get_help_text (name); ## Take action depending on help text format switch (lower (format)) case "plain text" text = sprintf ("
%s
\n", text); case "texinfo" [~, text] = __texi2html__ (text, vpars); case "not documented" text = sprintf ("
Not documented
\n"); case "not found" error ("`%s' not found\n", name); otherwise error ("Internal error: unsupported help text format '%s' for '%s'", format, name); endswitch ## Read options. header = getopt ("header", vpars); title = getopt ("title", vpars); footer = getopt ("footer", vpars); ## Add demo:// links if requested if (getopt ("include_demos")) ## Determine if we have demos [code, idx] = test (name, "grabdemo"); if (length (idx) > 1) ## Demos to the main text demo_text = ""; outdir = fileparts (outname); imagedir = "images"; full_imagedir = fullfile (outdir, imagedir); num_demos = length (idx) - 1; demo_num = 0; for k = 1:num_demos ## Run demo code_k = code (idx (k):idx (k+1)-1); try [output, images] = get_output (k, ... code_k, imagedir, full_imagedir, name); catch lasterr () continue; end_try_catch has_text = !isempty (output); has_images = !isempty (images); if (length (images) > 1) ft = "figures"; else ft = "figure"; endif ## Create text demo_num++; demo_header = sprintf ("

Demonstration %d

\n
\n", demo_num); demo_footer = "
\n"; demo_k = {}; demo_k{1} = "

The following code

\n"; demo_k{2} = sprintf ("
%s
\n", code_k); if (has_text && has_images) demo_k{3} = "

Produces the following output

\n"; demo_k{4} = sprintf ("
%s
\n", output); demo_k{5} = sprintf ("

and the following %s

\n", ft); demo_k{6} = sprintf ("

%s

\n", images_in_html (images)); elseif (has_text) # no images demo_k{3} = "

Produces the following output

\n"; demo_k{4} = sprintf ("
%s
\n", output); elseif (has_images) # no text demo_k{3} = sprintf ("

Produces the following %s

\n", ft); demo_k{4} = sprintf ("

%s

\n", images_in_html (images)); else # neither text nor images demo_k{3} = sprintf ("

gives an example of how '%s' is used.

\n", name); endif demo_text = strcat (demo_text, demo_header, demo_k{:}, demo_footer); endfor text = strcat (text, demo_text); endif endif ## Write result to disk fid = fopen (outname, "w"); if (fid < 0) error ("Could not open '%s' for writing", outname); endif fprintf (fid, "%s\n%s\n%s", header, text, footer); fclose (fid); endfunction function text = images_in_html (images) header = "\n\n"; footer = "
\n"; headers = sprintf ("Figure %d\n", 1:numel (images)); ims = sprintf ("\n", images{:}); text = strcat (header, headers, "\n", ims, footer); endfunction generate_html-0.3.3/inst/private/PaxHeaders/insert_char_entities.m0000644000000000000000000000006214234263413022427 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/insert_char_entities.m0000644000175000017500000000201514234263413023235 0ustar00jadejade00000000000000## Copyright (C) 2014 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program. If not, see . ## Author: Julien Bect ## Created: 2014-09-01 function s = insert_char_entities (s) # This one has to be first # (otherwise we would get, e.g., < ==> < ==> &lt;) s = regexprep (s, "&", "&"); s = regexprep (s, "<", "<"); s = regexprep (s, ">", ">"); endfunction generate_html-0.3.3/inst/private/PaxHeaders/html_see_also_with_prefix.m0000644000000000000000000000006214234263413023450 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/html_see_also_with_prefix.m0000644000175000017500000000222714234263413024263 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . function expanded = html_see_also_with_prefix (prefix, varargin) header = "@html\n
\nSee also: "; footer = "\n
\n@end html\n"; format = sprintf (" %%s ", prefix); varargin2 = cell (1, 2*length (varargin)); varargin2 (1:2:end) = varargin; varargin2 (2:2:end) = varargin; list = sprintf (format, varargin2{:}); expanded = strcat (header, list, footer); endfunction generate_html-0.3.3/inst/private/PaxHeaders/get_txi_files.m0000644000000000000000000000006214234263413021047 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/get_txi_files.m0000644000175000017500000000354514234263413021666 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . function file_list = get_txi_files (srcdir) txi_dir = fullfile (srcdir, "doc", "interpreter"); octave_texi = fullfile (txi_dir, "octave.texi"); ## Pattern for finding @include lines in octave.texi pat = '^@include\s*(?\S*?)\.texi\s*$'; ## List of *.texi files to be ignored ## Note: version.texi was renamed to version-octave.texi between 4.0 and 4.2 ignore_list = {"macros", "version", "version-octave"}; ## Open octave.texi for reading [fid, errmsg] = fopen (octave_texi, "rt"); if (fid == -1) fprintf (stderr, "\nCannot open %s for reading.\n\n", octave_texi); error (errmsg); endif file_list = {}; while (true) ## Read one more line line = fgetl (fid); if (line == -1) break; endif ## Pattern matching s = regexp (line, pat, "names"); if (isempty (s)) f = {}; else f = s(1).filename; endif ## Add to the file list if (~ isempty (f)) && (~ any (strcmpi (f, ignore_list))) file_list{end+1} = fullfile (txi_dir, [f ".txi"]); endif endwhile fclose (fid); endfunction generate_html-0.3.3/inst/private/PaxHeaders/octave_forge_seealso.m0000644000000000000000000000006214234263413022400 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/octave_forge_seealso.m0000644000175000017500000000274014234263413023213 0ustar00jadejade00000000000000## Copyright (C) 2009 Soren Hauberg ## Copyright (C) 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . function expanded = octave_forge_seealso (root, varargin) header = "@html\n
\nSee also: "; footer = "\n
\n@end html\n"; ## XXX: Deal properly with the root directory format = sprintf (" %%s ", root); kw_format = sprintf (" %%s ", root); keywords = __keywords__ (); help_list = ""; for k = 1:length (varargin) f = varargin{k}; if (any (strcmp (f, keywords))) elem = sprintf (kw_format, f, f); else elem = sprintf (format, f, f); endif help_list = strcat (help_list, elem); endfor expanded = strcat (header, help_list, footer); endfunction generate_html-0.3.3/inst/private/PaxHeaders/setopts.m0000644000000000000000000000006214234263413017723 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/setopts.m0000644000175000017500000000413414234263413020535 0ustar00jadejade00000000000000## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} setopt () ## undocumented internal function ## @end deftypefn function [ret_opts, ret_pars] = setopts (options, desc) ## initialize options with 'setopts (options, pkg_desc)' (options is ## the structure returned by 'get_html_options') ## ## 'setopt ()' without arguments returns the options and the package ## parameters. ## ## The persistent parameters could be directly in 'getopt ()' ## instead, but this triggered a cleanup bug in Octave. ## options persistent opts; ## invariable parameters persistent pars; if (! nargin ()) ret_opts = opts; ret_pars = pars; return; endif ## initialization opts = options; pars = struct (); pars.package = getpar (desc, "name", ""); pars.version = getpar (desc, "version", ""); pars.description = getpar (desc, "description", ""); ## next command and comment moved here from generate_package_html.m ## ## Extract first sentence for a short description, remove period at ## the end. pars.shortdescription = regexprep (pars.description, '\.($| .*)', ''); pars.gen_date = datestr (date (), "yyyy-mm-dd"); pars.ghv = (a = ver ("generate_html")).Version; endfunction function ret = getpar (s, field, default) if (isfield (s, field)) ret = s.(field); else ret = default; endif endfunction generate_html-0.3.3/inst/private/PaxHeaders/getopt.m0000644000000000000000000000006214234263413017524 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/getopt.m0000644000175000017500000000311114234263413020330 0ustar00jadejade00000000000000## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} getopt () ## undocumented internal function ## @end deftypefn function ret = getopt (optname, vpars) ## this function performs the parameterization of options, if ## applicable ## ## get an option with 'getopt ("option_name");', or with 'getopt ## ("option_name", var_pars)', where var_pars is a structure with ## variable parameters like "pkgroot" [opts, pars] = setopts (); if (is_function_handle (opts.(optname))) ## parameterize option if (nargin () < 2) vpars = struct (); endif ## defaults if (! isfield (vpars, "pkgroot")) vpars.pkgroot = ""; endif ## pre-compute 'root' from 'pkgroot' vpars.root = fullfile ("..", vpars.pkgroot); ret = opts.(optname) (opts, pars, vpars); else ## simple option ret = opts.(optname); endif endfunction generate_html-0.3.3/inst/private/PaxHeaders/index_write_homepage_links.m0000644000000000000000000000006214234263413023610 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/private/index_write_homepage_links.m0000644000175000017500000000315214234263413024421 0ustar00jadejade00000000000000## Copyright (C) 2016 Julien Bect ## Copyright (C) 2016 Fernando Pujaico Rivera ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . function index_write_homepage_links (fid, url_list) ## Process url list C = strsplit (url_list, ","); C = cellfun (@strtrim, C, 'UniformOutput', false); L = length (C); for k = 1:L fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n", C{k}); fprintf (fid, " \"Package\n"); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n", C{k}); if L == 1 fprintf (fid, " Homepage\n"); else fprintf (fid, " Homepage #%d\n", k); endif fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n"); endfor endfunction generate_html-0.3.3/inst/PaxHeaders/txi2index.m0000644000000000000000000000006214234263413016466 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/txi2index.m0000644000175000017500000001011114234263413017270 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} {@var{index} =} txi2index (@var{file_pattern}) ## Convert @code{.txi} files in the Octave source into an @t{INDEX} structure ## suitable for generating a functon reference. ## ## @var{file_pattern} must be a string containing either the name of a @code{.txi} ## file, or a pattern for globbing a set of files (e.g. @t{"*.txi"}). The resulting ## cell array @var{index} contains a set of structures corresponding to those ## generated by @code{pkg ("describe")}. These structures can then be given to ## @code{generate_package_html} to produce @t{HTML} content. ## ## As an example, if the Octave source code is located in @t{~/octave_code}, ## then this function can be called with ## ## @example ## octave_source_code = "~/octave_code"; ## index = txi2index (fullfile (octave_source_code, "doc/interpreter", "*.txi")); ## @end example ## @seealso{pkg, generate_package_html} ## @end deftypefn function all_index = txi2index (srcdir) ## Check number of input arguments if (nargin != 1) print_usage (); error ("Not enough input arguments: exactly one argument was expected"); endif if (!ischar (srcdir)) error ("Input argument must be a string"); endif file_list = get_txi_files (srcdir); all_index = cell (size (file_list)); for k = 1:length (file_list) filename = file_list{k}; [not_used, name] = fileparts (filename); index.filename = filename; index.name = name; index.description = ""; index.provides = {}; CHAPTER = "@chapter "; APPENDIX = "@appendix "; SECTION = "@section "; DOCSTRING = "@DOCSTRING"; default_section = "General"; fid = fopen (filename, "r"); if (fid < 0) warning ("txi2index: couldn't open '%s' for reading", filename); continue; endif idx = 0; txi_has_contents = false; while (true) line = fgetl (fid); if (line == -1) break; endif if (strncmpi (CHAPTER, line, length (CHAPTER))) index.name = strtrim (line (length (CHAPTER)+1:end)); elseif (strncmpi (APPENDIX, line, length (APPENDIX))) index.name = strtrim (line (length (APPENDIX)+1:end)); elseif (strncmpi (SECTION, line, length (SECTION))) section = strtrim (line (length (SECTION)+1:end)); if (idx == 0 || !isempty (index.provides{idx}.functions)) idx++; endif index.provides{idx} = struct (); index.provides{idx}.category = section; index.provides{idx}.functions = {}; elseif (strncmpi (DOCSTRING, line, length (DOCSTRING))) if (idx == 0) idx++; index.provides{idx} = struct (); index.provides{idx}.category = default_section; index.provides{idx}.functions = {}; endif start = find (line == "(", 1); stop = find (line == ")", 1); if (isempty (start) || isempty (stop)) warning ("txi2index: invalid @DOCSTRING: %s", line); continue; endif fun = strtrim (line (start+1:stop-1)); index.provides{idx}.functions{end+1} = fun; txi_has_contents = true; endif endwhile fclose (fid); if (idx > 0 && isempty (index.provides{idx}.functions)) index.provides = index.provides (1:idx-1); endif if (txi_has_contents) all_index{k} = index; else all_index{k} = []; endif endfor endfunction generate_html-0.3.3/inst/PaxHeaders/texi2html.m0000644000000000000000000000006214234263413016470 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/texi2html.m0000644000175000017500000000340014234263413017275 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{header}, @var{text}, @var{footer} =} texi2html (@var{text}, @var{options}) ## Converts texinfo function help to a html page. ## ## @seealso{html_help_text} ## @end deftypefn function [header, text, footer] = texi2html (text, options = struct (), root = "../..") ## This function is an interface, to be called as a standalone function. ## Check number of input arguments if (nargin < 1) print_usage (); endif ## Process input argument 'options' if (ischar (options)) || (isstruct (options)) options = get_html_options (options); else error ("Second input argument must be a string or a structure"); endif ## Initialize setopts. setopts (options, struct ()); ## Compute 'pkgroot' from 'root'. pkgroot = fileparts (fullfile (root, "dummy"))(1:end-3); ## Call the actual function, now under private/. [header, text, footer] = ... __texi2html__ (text, struct ("pkgroot", pkgroot)); endfunction generate_html-0.3.3/inst/PaxHeaders/generate_html_manual.m0000644000000000000000000000006214234263413020723 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/generate_html_manual.m0000644000175000017500000000541314234263413021536 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} generate_html_manual (@var{srcdir}, @var{outdir}) ## Generate @t{HTML} documentation for the core functions provided by Octave. ## @seealso{generate_package_html} ## @end deftypefn function generate_html_manual (srcdir, outdir = "htdocs", options = struct ()) ## Check number of input arguments if (nargin < 1) print_usage (); error ("Not enough input arguments: at least one argument was expected."); endif if (! ischar (srcdir)) error ("First input argument must be a string"); endif if (! ischar (outdir)) error ("Second input argument must be a string"); endif ## Process input argument 'options' if (ischar (options)) || (isstruct (options)) options = get_html_options (options); else error ("Third input argument must be a string or a structure"); endif ## Create directories assert_dir (outdir); ################################################### ## Generate reference for individual functions ## ################################################### ## Get INDEX structure indices = txi2index (srcdir); index = struct (); index.provides = {}; index.name = "octave"; index.description = "GNU Octave comes with a large set of general-purpose functions that are listed below. This is the core set of functions that is available without any packages installed."; for k = 1:length (indices) if (! isempty (indices{k})) ikp = indices{k}.provides; index.provides (end+1:end+length (ikp)) = ikp; endif endfor ## Disable options that are specific to packages options.include_package_list_item = false; options.include_package_page = false; options.include_package_license = false; options.include_package_news = false; ## Generate the documentation generate_package_html (index, outdir, options); endfunction function retval = docstring_handler (fun) retval = sprintf ("@ifhtml\n@html\n
See %s
\n@end html\n@end ifhtml\n", fun, fun); endfunction generate_html-0.3.3/inst/PaxHeaders/check_duplicates.m0000644000000000000000000000006214234263413020042 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/check_duplicates.m0000644000175000017500000001513514234263413020657 0ustar00jadejade00000000000000## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} check_duplicates (@var{pkgname}) ## @deftypefnx {Function File} check_duplicates () ## @deftypefnx {Function File} check_duplicates (@var{options}) ## @deftypefnx {Function File} check_duplicates (@var{pkgname}, @var{options}) ## Query Octave Forge website to check for duplicate symbols. ## ## With the name of a locally installed package as argument ## @var{pkgname}, check for symbols (function names except class ## methods and functions under a namespace, class base names, and ## namespace names) of this package which are also used by another ## package at Octave Forge or by Octave. ## ## Without arguments, check for duplications of such symbols among ## Octave and all packages at Octave Forge. ## ## @var{options} is a structure whose fields correspond to the ## following possible options: ## ## @table @code ## @item excl ## Cell array of package names at Octave Forge which are excluded from ## the check. If the argument @var{pkgname} was given, this packages ## symbols are retrieved locally, therefore this package will be ## automatically excluded from the symbol search at Octave Forge. ## ## @item syms ## Cell array of symbols (without any @code{@@} or @code{+} prefix for ## class basenames or namespace names). If given, only these symbols ## are checked. ## ## @item browser ## Use this browser instead of trying to find one. ## ## @item text_only ## If given and true, results are displayed as text and no html ## browser is started. ## ## @item url ## Used instead of the default URL of Octave Forge. ## ## @end table ## ## The result is displayed in the HTML browser specified with option ## @code{browser} or found by this function. The browser must have ## javascript enabled. If option @code{text_only} is given and true, a ## simplified text version of the result is displayed and no HTML ## browser is started. ## ## If an output argument is given, a cell array is returned with the ## symbol names in the first column and the corresponding package ## names in the second column. ## ## Note that checking for class basenames and namespace names at ## Octave Forge requires that the @code{generate_html} package of a ## version greater than 0.1.13 had been used to generate the package ## documentations. ## ## @end deftypefn function ret = check_duplicates (varargin) ## Argument processing. if ((nargs = nargin ()) > 2) print_usage (); endif ## assign arguments pkgn = ""; options = struct (); for id = 1:nargs if (ischar (varargin{id}) && id == 1) pkgn = varargin{id}; elseif (isstruct (varargin{id}) && id == nargs) options = varargin{id}; else print_usage (); endif endfor ## lowercase option names opts = struct (); for [val, key] = options opts.(tolower (key)) = val; endfor clear ("options"); # so we can't erroneously use it later ## check for unknown option names known = {"excl"; "syms"; "text_only"; "url"; "browser"}; if (numel (unknown = setdiff (fieldnames (opts), known))) warning ("unknown option(s):%s", sprintf (" %s", unknown{:})); endif ## set option values astext = setoption (opts, "text_only"); url = setoption (opts, "url"); excl = setoption (opts, "excl"); syms = setoption (opts, "syms"); browser = setoption (opts, "browser"); ## If necessary, retrieve symbol names of local package. psyms = {}; if (! isempty (pkgn)) [desc, flag] = pkg ("describe", pkgn); if (strcmp (flag, "Not installed")) error ("package '%s' not installed", pkgn); else desc = desc{1}; endif psyms_hash = struct (); for c = 1 : numel (desc.provides) for f = 1 : numel (desc.provides{c}.functions) fun = desc.provides{c}.functions{f}; if (any (fun == ".")) ## namespaced function psyms_hash.(strsplit (fun, "."){1}) = []; elseif (fun(1) == "@") ## class method psyms_hash.(strsplit (fun, "/"){1}(2:end)) = []; else ## normal function psyms_hash.(fun) = []; endif endfor endfor psyms = fieldnames (psyms_hash); endif ## Define symbols to check for, if any, and excluded packages, if ## any. if (! isempty (pkgn)) if (isempty (syms)) syms = psyms; else nsyms = numel (syms); syms = intersect (psyms, syms); if (numel (syms) < nsyms) warning ("option 'syms' has been given and package doesn't contain all these symbols -- some symbols in 'syms' not checked"); endif endif excl = union (excl, {pkgn}); endif ## Construct parameter arrays and url for url handlers. pars = cell (0, 1); excl_pars(1 : numel (excl)) = {"exclpkgs[]"}; excl_pars = vertcat (excl_pars, excl(:).'); pars = vertcat (pars, excl_pars(:)); sym_pars(1 : numel (syms)) = {"syms[]"}; sym_pars = vertcat (sym_pars, syms(:).'); pars = vertcat (pars, sym_pars(:)); ## we can't use fullfile() since it removes one '/' in '://' if (url(end) == '/') full_url = [url, "show_duplicates.php"]; else full_url = [url, '/', "show_duplicates.php"]; endif ## Query url. if (astext || nargout ()) [text, succ, msg] = urlread (full_url, "post", vertcat (pars, {"astext"; ""})); if (! succ) error ("urlread returned error message: %s", msg); endif ret = text; endif if (! astext) urlview (full_url, "post", pars, struct ("browser", browser)); endif if (astext) printf (text); endif endfunction function ret = setoption (opts, opt) persistent defaults = {"text_only", false; "url", "http://packages.octave.org"; "excl", {}; "syms", {}; "browser", ""}; persistent defs = cell2struct (defaults(:, 2), defaults(:, 1)); if (isfield (opts, opt)) ret = opts.(opt); else ret = defs.(opt); endif endfunction generate_html-0.3.3/inst/PaxHeaders/generate_package_html.m0000644000000000000000000000006214234263413021041 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/generate_package_html.m0000644000175000017500000007271714234263413021667 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014-2016 Julien Bect ## Copyright (C) 2015 Oliver Heimlich ## Copyright (C) 2016 Fernando Pujaico Rivera ## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} generate_package_html (@var{name}, @var{outdir}, @var{options}) ## Generate @t{HTML} documentation for a package. ## ## The function reads information about package @var{name} using the ## package system. This is then used to generate bunch of ## @t{HTML} files; one for each function in the package, and one overview ## page. The files are all placed in the directory @var{outdir}, which defaults ## to the current directory. The @var{options} structure is used to control ## the design of the web pages. ## ## As an example, the following code generates the web pages for the @t{image} ## package, with a design suitable for the @t{Octave-Forge} project. ## ## @example ## options = get_html_options ("octave-forge"); ## generate_package_html ("image", "image_html", options); ## @end example ## ## The resulting files will be available in the @t{"image_html"} directory. The ## overview page will be called @t{"image_html/overview.html"}. ## ## As a convenience, if @var{options} is a string, a structure will ## be generated by calling @code{get_html_options}. This means the above ## example can be reduced to the following. ## ## @example ## generate_package_html ("image", "image_html", "octave-forge"); ## @end example ## ## If you want to include prepared package documentation in html format, ## you have to set @var{options}.package_doc manually with the filename ## of its texinfo source, which must be in the package "doc" directory. ## Contained images are automatically copied if they are at the paths ## specified in the texinfo source relative to the package "doc" directory. ## Additional arguments can be passed to makeinfo using the optional ## field @var{options}.package_doc_options. ## ## It should be noted that the function only works for installed packages. ## @seealso{get_html_options} ## @end deftypefn function generate_package_html (name = [], outdir = "htdocs", options = struct ()) ## Check input if (isempty (name)) list = pkg ("list"); for k = 1:length (list) generate_package_html (list{k}.name, outdir, options); endfor return; elseif (isstruct (name)) desc = name; if (isfield (name, "name")) packname = desc.name; else packname = ""; endif elseif (ischar (name)) packname = name; pkg ("load", name); desc = (pkg ("describe", name)){1}; else error (["First input must either be the name of a ", ... "package, or a structure giving its description."]); endif ## Get detailed information about the package. ## ## We don't want a dependency on the struct package for ## generate_html, otherwise the following could be: ## ## list = cell2struct (all_list.', {structcat(1, all_list{:}).name}, 1).(packname) ## ## But probably pkg ("list") should not return a cell array of ## structures anyway. all_list = pkg ("list"); list = []; for k = 1:length (all_list) if (strcmp (all_list{k}.name, packname)) list = all_list{k}; break; endif endfor if (isempty (list)) error ("Couldn't locate package '%s'", packname); endif depends = struct (); for k = 1 : numel (list.depends) it_depends = list.depends{k}; if (isfield (it_depends, "operator") && isfield (it_depends, "version")) o = it_depends.operator; v = it_depends.version; depends.(it_depends.package) = sprintf ("%s %s", o, v); else depends.(it_depends.package) = ""; endif endfor ## Note paths used to write html in this variable. paths = struct (); if (isempty (outdir)) outdir = packname; elseif (! ischar (outdir)) error ("Second input argument must be a string"); endif ## Create output directory if needed assert_dir (outdir); ## Create package directory if needed assert_dir (packdir = fullfile (outdir, packname)); ## Process input argument 'options' if (ischar (options)) || (isstruct (options)) options = get_html_options (options); else error ("Third input argument must be a string or a structure"); endif ## Initialize setopts. setopts (options, desc); ## Function directory local_fundir = getopt ("function_dir"); fundir = fullfile (packdir, local_fundir); ## Create function directory if needed assert_dir (fundir); ################################################## ## Generate html pages for individual functions ## ################################################## paths.function_help_dir = local_fundir; ## Since we loop over categories and functions, and now even check ## for both namespaces and classes already here, we use the ## opportunity to prepare some information for other functionality, ## too. num_categories = numel (desc.provides); anchors = links = implemented = first_sentences = ... cell (1, num_categories); ## hash name information, so we needn't go through all names for ## each letter name_hashes = struct (); for k = 1:num_categories F = desc.provides{k}.functions; category = desc.provides{k}.category; ## Create a valid anchor name by keeping only alphabetical characters anchors{k} = regexprep (category, "[^a-zA-Z]", "_"); ## For each function in category num_functions = numel (F); implemented{k} = false (1, num_functions); links{k} = first_sentences{k} = cell (1, num_functions); for l = 1:num_functions fun = F{l}; initial = lower (fun(isalpha (fun))(1)); tree = {}; ## strip and consider namespaces nnsp = sum (fun == "."); [tree{1:nnsp}, fcn] = strsplit (fun, "."){:}; pkgroot = fullfile ({".."}{ones (1, 1 + nnsp)}); assert_dir (tree, fundir); ## strip and consider class name if (fcn(1) == "@") [tree{end + 1}, fcn] = strsplit (fcn, "/"){:}; pkgroot = fullfile (pkgroot, ".."); assert_dir (fullfile (fundir, tree{:})); endif ## consider function name tree{end + 1} = fcn; subpath = fullfile (tree{1:end-1}, sprintf ("%s.html", tree{end})); outname = fullfile (fundir, subpath); if (wrote_html (outname, pkgroot, fun)) implemented{k}(l) = true; links{k}{l} = fullfile (local_fundir, subpath); name_hashes = setfield (name_hashes, initial, tree{:}, [k, l]); first_sentences{k}{l} = try_process_first_help_sentence (fun); endif endfor endfor ######################### ## Write overview file ## ######################### paths.overview_file = ""; if (getopt ("include_overview")) ## Create filename for the overview page overview_filename = getopt ("overview_filename"); overview_filename = strrep (overview_filename, " ", "_"); paths.overview_file = overview_filename; fid = fopen (fullfile (packdir, overview_filename), "w"); if (fid < 0) error ("Couldn't open overview file for writing"); endif vpars = struct ("name", packname, "pkgroot", ""); header = getopt ("overview_header", vpars); title = getopt ("overview_title", vpars); footer = getopt ("overview_footer", vpars); fprintf (fid, "%s\n", header); fprintf (fid, "

%s

\n\n", desc.name); fprintf (fid, "
\n"); fprintf (fid, " %s\n", desc.description); fprintf (fid, "
\n\n"); fprintf (fid, "

Select category:

\n\n"); ## Generate function list by category for k = 1 : numel (first_sentences) F = desc.provides{k}.functions; category = desc.provides{k}.category; fprintf (fid, "

%s

\n\n", anchors{k}, category); ## For each function in category for l = 1 : numel (first_sentences{k}) fun = F{l}; if (! isempty (first_sentences{k}{l})) fprintf (fid, "
%s
\n", links{k}{l}, fun); fprintf (fid, "
%s
\n\n", ... first_sentences{k}{l}); else fprintf (fid, "
%s
\n", fun); fprintf (fid, "
Not implemented.
\n\n"); endif endfor endfor fprintf (fid, "\n%s\n", footer); fclose (fid); endif ################################################ ## Write function data for alphabetical lists ## ################################################ paths.alphabetical_database_dir = ""; if (getopt ("include_alpha")) paths.alphabetical_database_dir = "alpha"; process_alpha_tree (name_hashes, fullfile (packdir, "alpha")); endif ##################################################### ## Write short description for forge overview page ## ##################################################### paths.short_description_file = ""; if (getopt ("include_package_list_item")) pkg_list_item_filename = getopt ("pkg_list_item_filename"); paths.short_description_file = pkg_list_item_filename; vpars = struct ("name", desc.name); text = getopt ("package_list_item", vpars); fileprintf (fullfile (packdir, pkg_list_item_filename), pkg_list_item_filename, text); endif ##################### ## Write NEWS file ## ##################### paths.news_file = ""; if (! getopt ("include_package_news")) write_package_news = false; else ## Read news filename = fullfile (list.dir, "packinfo", "NEWS"); fid = fopen (filename, "r"); if (fid < 0) warning ("generate_package_html: couldn't open NEWS for reading"); write_package_news = false; else write_package_news = true; news_content = char (fread (fid).'); fclose (fid); ## Open output file news_filename = "NEWS.html"; paths.news_file = news_filename; fid = fopen (fullfile (packdir, news_filename), "w"); if (fid < 0) error ("Couldn't open NEWS file for writing"); endif vpars = struct ("name", desc.name, "pkgroot", ""); header = getopt ("news_header", vpars); title = getopt ("news_title", vpars); footer = getopt ("news_footer", vpars); ## Write output fprintf (fid, "%s\n", header); fprintf (fid, "

NEWS for '%s' Package

\n\n", desc.name); fprintf (fid, "

Return to the '%s' package

\n\n", desc.name); fprintf (fid, "
%s
\n\n", insert_char_entities (news_content)); fprintf (fid, "\n%s\n", footer); fclose (fid); endif endif ################################# ## Write package documentation ## ################################# # Is there a package documentation to be included ? write_package_documentation = ! isempty (getopt ("package_doc")); paths.package_doc_dir = ""; if (write_package_documentation) [~, doc_fn, doc_ext] = fileparts (getopt ("package_doc")); doc_root_dir = fullfile (list.dir, "doc"); doc_src = fullfile (doc_root_dir, [doc_fn, doc_ext]); doc_subdir = "package_doc"; doc_out_dir = fullfile (packdir, doc_subdir); paths.package_doc_dir = doc_subdir; mkdir (doc_out_dir); ## Create makeinfo command makeinfo_cmd = sprintf ("%s --html -o %s %s", makeinfo_program (), doc_out_dir, doc_src); if (! isempty (package_doc_options = getopt ("package_doc_options"))) makeinfo_cmd = [makeinfo_cmd, " ", package_doc_options]; endif ## Convert texinfo to HTML using makeinfo status = system (makeinfo_cmd); if (status == 127) error ("Program `%s' not found", makeinfo_program ()); elseif (status) error ("Program `%s' returned failure code %i", makeinfo_program (), status); endif ## Search the name of the main HTML index file. package_doc_index = "index.html"; if (! exist (fullfile (doc_out_dir, package_doc_index), "file")) ## Look for an HTML file with the same name as the texinfo source file [~, doc_fn, doc_ext] = fileparts (doc_src); package_doc_index = [doc_fn, ".html"]; if (! exist (fullfile (doc_out_dir, package_doc_index), "file")) ## If there is only one file, no hesitation html_fn_list = glob (fullfile (doc_out_dir, "*.html")); if (length (html_fn_list) == 1) [~, doc_fn, doc_ext] = fileparts (html_filenames_temp{1}); package_doc_index = [doc_fn, doc_ext]; else error ("Unable to determine the root of the HTML manual."); endif endif endif ## Read image and css references from generated files and copy images filelist = glob (fullfile (doc_out_dir, "*.html")); for id = 1 : numel (filelist) copy_files ("image", filelist{id}, doc_root_dir, doc_out_dir); copy_files ("css", filelist{id}, doc_root_dir, doc_out_dir); endfor endif ###################### ## Write index file ## ###################### paths.index_file = ""; if (getopt ("include_package_page")) ## Open output file index_filename = "index.html"; paths.index_file = index_filename; fid = fopen (fullfile (packdir, index_filename), "w"); if (fid < 0) error ("Couldn't open index file for writing"); endif ## Write output vpars = struct ("name", desc.name, "pkgroot", ""); header = getopt ("index_header", vpars); title = getopt ("index_title", vpars); footer = getopt ("index_footer", vpars); fprintf (fid, "%s\n", header); fprintf (fid, "

%s

\n\n", desc.name); fprintf (fid, "\n"); fprintf (fid, "\n\n"); ## get icon attributions, if any attrib = struct (); attrib.download = '""'; attrib.repository = '""'; attrib.doc = '""'; attrib.manual = '""'; attrib.news = '""'; if (! isempty (website_files = getopt ("website_files"))) directory = fullfile (fileparts (mfilename ("fullpath")), website_files, "icons"); for [~, key] = attrib; attribfile = fullfile (directory, sprintf ("%s.attrib", key)); if (! isempty (stat (attribfile))) val = fileread (attribfile); val(val == "\n") = []; attrib.(key) = val; endif endfor endif fprintf (fid, "\n"); fprintf (fid, "\n"); fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, " \n"); fprintf (fid, " \n", list.version); fprintf (fid, " \n", list.date); fprintf (fid, " \n", insert_char_entities (list.author)); fprintf (fid, " \n", insert_char_entities (list.maintainer)); fprintf (fid, " \n", list.license); else fprintf (fid, "Read license\n"); endif fprintf (fid, "
Package Version:%s
Last Release Date:%s
Package Author:%s
Package Maintainer:%s
License:"); if (isfield (list, "license")) fprintf (fid, "%s
\n"); fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, "		\n"); vpars = struct ("name", desc.name); if (! isempty (link = getopt ("download_link", vpars))) fprintf (fid, "
\n"); fprintf (fid, " \n"); if (! isempty (repository_link = ... getopt ("repository_link", vpars))) fprintf (fid, " \n", attrib.repository); fprintf (fid, " \n"); endif ## The following link will have small text. So capitalize it, ## too, and don't put it in parantheses, otherwise it might be ## mistaken for a verbal attribute to the link above it. if (! isempty (older_versions_download = ... getopt ("older_versions_download", vpars))) fprintf (fid, " \n"); end fprintf (fid, "
\n"); fprintf (fid, " \n", link); fprintf (fid, " \"Package\n", attrib.download); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n", link); fprintf (fid, " Download Package\n"); fprintf (fid, "
\n"); fprintf (fid, " \n", repository_link); fprintf (fid, " \"Repository", repository_link); fprintf (fid, "Repository\n"); fprintf (fid, "
Older versions
\n"); fprintf (fid, "
\n"); endif fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, " \n"); if (write_package_documentation) link = fullfile (doc_subdir, package_doc_index); fprintf (fid, " \n"); endif if (write_package_news) fprintf (fid, " \n"); endif if (isfield (list, "url")) && (! isempty (list.url)) index_write_homepage_links (fid, list.url); endif fprintf (fid, "
\n"); fprintf (fid, " \n", overview_filename); fprintf (fid, " \"Function\n", attrib.doc); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n", overview_filename); fprintf (fid, " Function Reference\n"); fprintf (fid, " \n"); fprintf (fid, "
\n"); fprintf (fid, " \n", link); fprintf (fid, " \"Package\n", attrib.manual); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n", link); fprintf (fid, " Package Documentation\n"); fprintf (fid, " \n"); fprintf (fid, "
\n"); fprintf (fid, " \n"); fprintf (fid, " \"Package\n", attrib.news); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " \n"); fprintf (fid, " NEWS\n"); fprintf (fid, " \n"); fprintf (fid, "
\n"); fprintf (fid, "
\n"); fprintf (fid, "
\n\n"); fprintf (fid, "

Description

\n"); fprintf (fid, "
\n") fprintf (fid, list.description); fprintf (fid, "
\n\n") fprintf (fid, "

Details

\n"); fprintf (fid, " \n"); if (isfield (list, "depends")) fprintf (fid, " \n"); endif if (isfield (list, "systemrequirements")) fprintf (fid, " \n", list.systemrequirements); endif if (isfield (list, "buildrequires")) fprintf (fid, " \n", list.buildrequires); endif fprintf (fid, "
Dependencies: \n"); for [vt, p] = depends if (strcmpi (p, "octave")) fprintf (fid, "Octave "); else fprintf (fid, "%s ", p, p); endif fprintf (fid, vt); endfor fprintf (fid, "
Runtime system dependencies:%s
Build dependencies:%s
\n\n"); fprintf (fid, "\n%s\n", footer); fclose (fid); endif ######################## ## Write COPYING file ## ######################## paths.copying_file = ""; if (getopt ("include_package_license")) ## Read license filename = fullfile (list.dir, "packinfo", "COPYING"); fid = fopen (filename, "r"); if (fid < 0) error ("Couldn't open license for reading"); endif copying_contents = char (fread (fid).'); fclose (fid); ## Open output file copying_filename = "COPYING.html"; paths.copying_file = copying_filename; fid = fopen (fullfile (packdir, copying_filename), "w"); if (fid < 0) error ("Couldn't open COPYING file for writing"); endif vpars = struct ("name", desc.name, "pkgroot", ""); header = getopt ("copying_header", vpars); title = getopt ("copying_title", vpars); footer = getopt ("copying_footer", vpars); ## Write output fprintf (fid, "%s\n", header); fprintf (fid, "

License for '%s' Package

\n\n", desc.name); fprintf (fid, "

Return to the '%s' package

\n\n", desc.name); fprintf (fid, "
%s
\n\n", insert_char_entities (copying_contents)); fprintf (fid, "\n%s\n", footer); fclose (fid); endif ######################## ## Copy website files ## ######################## if (! isempty (website_files = getopt ("website_files"))) copyfile (fullfile (fileparts (mfilename ("fullpath")), website_files, "*"), outdir, "f"); endif ############################################## ## write easily parsable informational file ## ############################################## export = struct (); export.generator = "generate_html"; [~, pars] = setopts (); export.generator_version = pars.ghv; export.date_generated = pars.gen_date; export.package.name = pars.package; p_fields = {"version"; "description"; "shortdescription"}; for field = p_fields.' export.package.(field{1}) = pars.(field{1}); endfor l_fields = {"date"; "title"; "author"; "maintainer"; "buildrequires"; "systemrequirements"; "license"; "url"}; for field = l_fields.' if (isfield (list, field{1})) export.package.(field{1}) = list.(field{1}); else export.package.(field{1}) = ""; endif endfor export.package.depends = depends; export.html.config.has_overview = getopt ("include_overview"); export.html.config.has_alphabetical_data = getopt ("include_alpha"); export.html.config.has_short_description = ... getopt ("include_package_list_item"); export.html.config.has_news = getopt ("include_package_news"); export.html.config.has_package_doc = ! isempty (getopt ("package_doc")); export.html.config.has_index = getopt ("include_package_page"); export.html.config.has_license = getopt ("include_package_license"); export.html.config.has_website_files = ! isempty (getopt ("website_files")); export.html.config.has_demos = getopt ("include_demos"); export.html.paths = paths; json = encode_json_object (export); fileprintf (fullfile (packdir, "description.json"), "informational file", sprintf ("%s\n", json)); function process_alpha_tree (tree, path) if (isstruct (tree)) assert_dir (path); for [subtree, name] = tree process_alpha_tree (subtree, fullfile (path, name)); endfor else fileprintf (path, "alphabet_database", [first_sentences{tree(1)}{tree(2)}, "\n"]); endif endfunction endfunction function copy_files (filetype, file, doc_root_dir, doc_out_dir) switch filetype case "image" pattern = "<(?:img.+?src|object.+?data)=""([^""]+)"".*?>"; case "css" pattern = "<(?:link rel=\"stylesheet\".+?href|object.+?data)=""([^""]+)"".*?>"; otherwise error ("copy_files: invalid file type"); endswitch if ((fid = fopen (file)) < 0) error ("Couldn't open %s for reading", file); endif unwind_protect while (! isnumeric (l = fgetl (fid))) m = regexp (l, pattern, "tokens"); for i = 1 : numel (m) url = m{i}{1}; ## exclude external links if (isempty (strfind (url, "//"))) if (! isempty (strfind (url, ".."))) warning ("not copying %s %s because path contains '..'", filetype, url); else if (! isempty (imgdir = fileparts (url)) && ! strcmp (imgdir, "./") && ! exist (imgoutdir = fullfile (doc_out_dir, imgdir), "dir")) [succ, msg] = mkdir (imgoutdir); if (!succ) error ("Unable to create directory %s:\n %s", imgoutdir, msg); endif endif if (isempty (glob (src = fullfile (doc_root_dir, url)))) warning ("%s file %s not present, not copied", filetype, url); elseif (! ([status, msg] = copyfile (src, fullfile (doc_out_dir, url)))) warning ("could not copy %s file %s: %s", filetype, url, msg); endif endif endif endfor endwhile unwind_protect_cleanup fclose (fid); end_unwind_protect endfunction function assert_dir (directory, basepath) if (nargin == 2) ## 'directory' is a string array for id = 1 : numel (directory) assert_dir (basepath = fullfile (basepath, directory{id})); endfor return; endif ## 'directory' is a string if (! exist (directory, "dir")) [succ, msg] = mkdir (directory); if (! succ) error ("Could not create '%s': %s", directory, msg); endif endif endfunction function fileprintf (path, what_file, varargin) if (([fid, msg] = fopen (path, "w")) == -1) error ("Could not open %s for writing", what_file); endif unwind_protect fprintf (fid, varargin{:}); unwind_protect_cleanup fclose (fid); end_unwind_protect endfunction function succ = wrote_html (file, pkgroot, fun) try __html_help_text__ (file, struct ("pkgroot", pkgroot, "name", fun)); succ = true; catch err = lasterror (); if (strfind (err.message, "not found")) warning ("marking '%s' as not implemented", fun); succ = false; else rethrow (err); endif end_try_catch endfunction function text = try_process_first_help_sentence (fun) try ## This will raise an error if the function is undocumented: text = get_first_help_sentence (fun, 200); catch err = lasterror (); if (! isempty (strfind (err.message, "not documented"))) warning (sprintf ("%s is undocumented", fun)); text = "Not documented"; else rethrow (err); endif end_try_catch text = strrep (text, "\n", " "); endfunction function json = encode_json_object (map, indent = "") ## encodes only scalar structures, recursively all values must be ## scalar structures, strings, or booleans; adds no final newline if ((nf = numel (fns = fieldnames (map)))) tmpl = strcat (["\n" indent ' "%s": %s'], repmat ([",\n" indent ' "%s": %s'], 1, nf - 1)); else tmpl = ""; endif for id = 1:nf if (isstruct (map.(fns{id}))) map.(fns{id}) = ... cstrcat ("\n", encode_json_object (map.(fns{id}), [indent " "])); elseif (isbool (map.(fns{id}))) if (map.(fns{id})) map.(fns{id}) = "true"; else map.(fns{id}) = "false"; endif else map.(fns{id}) = cstrcat ('"', map.(fns{id}), '"'); endif endfor json = sprintf ([indent "{" tmpl "\n" indent "}"], vertcat (fns.', struct2cell (map).'){:}); endfunction generate_html-0.3.3/inst/PaxHeaders/txi2reference.m0000644000000000000000000000006214234263413017315 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/txi2reference.m0000644000175000017500000000572614234263413020137 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} {@var{reference} =} txi2reference (@var{file_pattern}) ## Convert @code{.txi} files in the Octave source into a functon reference. ## ## @var{file_pattern} must be a string containing either the name of a @code{.txi} ## file, or a pattern for globbing a set of files (e.g. @t{"*.txi"}). The resulting ## cell array @var{reference} contains a string for each @code{.txi} file. These ## strings can the be passed to @code{makeinfo} to create output in many formats. ## ## As an example, if the Octave source code is located in @t{~/octave_code}, ## then this function can be called with ## ## @example ## octave_source_code = "~/octave_code"; ## reference = txi2reference (fullfile (octave_source_code, "doc/interpreter", "*.txi")); ## @end example ## @seealso{makeinfo, txi2index} ## @end deftypefn function result = txi2reference (filename, docstring_handler = @default_docstring_handler) ## Check number of input arguments if (nargin < 1) print_usage (); error ("Not enough input arguments: at least one argument was expected."); endif if (!ischar (filename)) error ("First input argument must be a string"); endif if (!isa (docstring_handler, "function_handle")) error ("Second input argument must be a function handle"); endif ## Constants for string matching DOCSTRING = "@DOCSTRING"; DS_start = "("; DS_stop = ")"; ## Open and read file fid = fopen (filename, "r"); if (fid < 0) error ("Couldn't open '%s' for reading", filename); endif text = char (fread (fid).'); fclose (fid); ## Search for @DOCSTRING DOCSTRING_idx = strfind (text, DOCSTRING); DS_start_idx = find (text == DS_start); DS_stop_idx = find (text == DS_stop); ## Process search results result = ""; prev = 1; for n = 1:length (DOCSTRING_idx) idx = DOCSTRING_idx (n); start = DS_start_idx (find (DS_start_idx > idx, 1)); stop = DS_stop_idx (find (DS_stop_idx > idx, 1)); fun = text (start+1:stop-1); fun_text = docstring_handler (fun); result = strcat (result, text (prev:idx-1), fun_text); prev = stop + 1; endfor result = strcat (result, text (prev:end)); endfunction function ds = default_docstring_handler (fun) ds = sprintf ("See: @xref{%s}", fun); endfunction generate_html-0.3.3/inst/PaxHeaders/get_html_options.m0000644000000000000000000000006214234263413020126 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/get_html_options.m0000644000175000017500000003665514234263413020755 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014-2017 Julien Bect ## Copyright (C) 2016 Fernando Pujaico Rivera ## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} {@var{options} =} get_html_options (@var{project_name}) ## Returns a structure containing design options for various project web sites. ## ## Given a string @var{project_name}, the function returns a structure containing ## various types of information for generating web pages for the specified project. ## Currently, the accepted values of @var{project_name} are ## ## @table @t ## @item "octave-forge" ## Design corresponding to the pages at @t{http://octave.sf.net}. ## ## @item "octave" ## Design corresponding to the pages at @t{http://octave.org}. The pages are ## meant to be processed with the @code{m4} preprocessor, using the macros for ## the site. ## @end table ## @seealso{generate_package_html, html_help_text} ## @end deftypefn function options = get_html_options (argin) ## If option strings need parameterization, specify them as ## anonymous functions: @ (opts, pars, vpars) ... . The 3 arguments ## will be structures with parameter names as field names. 'opts' ## will contain parameters set as fields of the 'options' structure ## itself (e.g. 'charset'). 'pars' will contain all other parameters ## except the variable parameters. 'vpars' will contain the variable ## parameters, which currently are: 'name', 'pkgroot', 'root' (the ## latter is redundant and always 'fullfile ("..", pkgroot)'). ## ## Within the generate_html package, option values are requested by ## the private 'getopt()' function, which performs parameterization ## of options. ## ## Even within this function, options potentially accepting ## parameters, like the options 'title' and 'body_command', must be ## accessed with 'getopt (, vpars)', i.e. 'getopt ("title", vpars)' ## instead of just 'opts.title'. ## ## This organization avoids the use of replacement strings and ## enables realizing the effect of an option by looking at this file ## only. ## Check number of input arguments if (nargin != 1) print_usage (); error ("Not enough input arguments: exactly one argument was expected."); endif if (isstruct (argin)) options = get_html_options_default (argin); elseif (ischar (argin)) options = get_html_options_default (struct ()); options = get_html_options_project (options, argin); else error ("Input argument must be a string or a structure"); endif endfunction function options = get_html_options_default (options) default = struct (); ## Create data files for alphabetical function lists ? default.include_alpha = false; ## Extract demos ? (this option is used in html_help_text) default.include_demos = false; ## Create overview page ? (list of functions, sorted by category) default.include_overview = false; ## Filename for overview page (used only if include_overview is true) ## %name can be used to denote the name of the package default.overview_filename = "overview.html"; ## Overview page. default.overview_title = @ (opts, pars, vpars) ... sprintf ("List of Functions for the '%s' package", pars.package); default.overview_body_command = @ (opts, pars, vpars) ... getopt ("body_command", vpars); default.overview_header = @ (opts, pars, vpars) ... getopt ("header", vpars); default.overview_footer = @ (opts, pars, vpars) ... getopt ("footer", vpars); ## News page. default.news_title = ... @ (opts, pars, vpars) sprintf ("Recent changes for the '%s' package", pars.package); default.news_body_command = @ (opts, pars, vpars) ... getopt ("body_command", vpars); default.news_header = @ (opts, pars, vpars) ... getopt ("header", vpars); default.news_footer = @ (opts, pars, vpars) ... getopt ("footer", vpars); ## Copying page. default.copying_title = ... @ (opts, pars, vpars) sprintf ("Copying conditions for the '%s' package", pars.package); default.copying_body_command = @ (opts, pars, vpars) ... getopt ("body_command", vpars);; default.copying_header = @ (opts, pars, vpars) ... getopt ("header", vpars); default.copying_footer = @ (opts, pars, vpars) ... getopt ("footer", vpars); ## Create short_package_description files ? (used by packages.php) default.include_package_list_item = false; ## Filename for short_package_description ## (used only if include_package_list_item is true) default.pkg_list_item_filename = "short_package_description"; ## Create main package page ? (index.html) default.include_package_page = false; ## Index page. default.index_title = ... @ (opts, pars, vpars) sprintf ("The '%s' package", pars.package); default.index_body_command = @ (opts, pars, vpars) ... getopt ("body_command", vpars);; default.index_header = @ (opts, pars, vpars) ... getopt ("header", vpars); default.index_footer = @ (opts, pars, vpars) ... getopt ("footer", vpars); ## Download link to be inserted on the main package page (index.html) ## Leave empty for no download link default.download_link = ""; default.older_versions_download = ""; default.repository_link = ""; ## Create package licence page ? default.include_package_license = false; ## Create package news page ? default.include_package_news = false; ## Name of function directory (subdirectory of package directory). ## This directory will contain individual function pages. default.function_dir = "function"; ## Handle to a function for processing "see also" links default.seealso = @ (opts, pars, vpars) @html_see_also_with_prefix; ## Variable values (%title, %body_command...) for individual function pages, ## and for special pages too (index, overview...) if the corresponding ## page-specific option is empty. default.title = @ (opts, pars, vpars) sprintf ("%s", vpars.name); default.body_command = ""; default.header = @ (opts, pars, vpars) sprintf ("\ \n\ \n\ \n\ \n\ \n\ \n\ %s\n\ \n\ ", opts.charset, pars.gen_date, pars.ghv, getopt ("title", vpars)); default.footer = "\n"; ## Style sheet (mandatory if style sheet is accessed in the ## header). Set to struct() by default to throw an error if used ## in strings without explicitly having set it. default.css = struct (); ## Encoding default.charset = "utf-8"; ## Name of package documentation file (user manual). Leave empty if no ## documentation file is to be included. If not empty, the documentation ## file is assumed to be in the 'doc' subdirectory. default.package_doc = ""; default.package_doc_options = ""; ## Name of directory with project website files. default.website_files = ""; default.extension = "tar.gz"; ## TODO: Warn about unknown options ## (to be done once all known options are present in default) ## Provide default values for missing fields fn = fieldnames (default); for i = 1:(length (fn)) if (! isfield (options, fn{i})) options.(fn{i}) = default.(fn{i}); endif endfor endfunction function options = get_html_options_project (options, project_name) ## Generate options depending on project switch (lower (project_name)) case "octave-forge" ## HTML header template. Can be used with different "...title" ## and "...body_command" options. These are indicated in the ## fields "title_option" and "body_command_option", ## respectively, of 'vpars'. options.__header__ = @ (opts, pars, vpars) ["\ \n\ \n\ \n\ \n\ \n\ \n\ \n\ \n\ \n\ " getopt(vpars.title_option, vpars) "\n\ \n\ \n\ \n\ \n\ \n\ \n\ \n\ \n\ \n\
\n"]; options.header = ... @ (opts, pars, vpars) ... getopt ("__header__", setfield ... (setfield (vpars, "body_command_option", "body_command"), "title_option", "title")); ## CSS options.css = "octave-forge.css"; ## Options for alphabetical lists options.include_alpha = true; ## SF logo sf_logo = ""; ## Options for individual function pages options.body_command = 'onload="javascript:fix_top_menu (); javascript:show_left_menu ();"'; options.footer = @ (opts, pars, vpars) sprintf ( ... "

Package: %s

\n%s", fullfile (vpars.pkgroot, "index.html"), pars.package, getopt ("index_footer", vpars)); options.title = @ (opts, pars, vpars) ... sprintf ("Function Reference: %s", vpars.name); options.include_demos = true; options.seealso = @ (opts, pars, vpars) @octave_forge_seealso; ## Options for overview page options.include_overview = true; options.overview_header = ... @ (opts, pars, vpars) ... getopt ("__header__", setfield ... (setfield (vpars, "body_command_option", "overview_body_command"), "title_option", "overview_title")); options.overview_footer = @ (opts, pars, vpars) sprintf ( ... "

Package: %s

\n%s", pars.package, getopt ("index_footer", vpars)); ## Options for the news page. options.news_header = ... @ (opts, pars, vpars) ... getopt ("__header__", setfield ... (setfield (vpars, "body_command_option", "news_body_command"), "title_option", "news_title")); ## Options for the copying page. options.copying_header = ... @ (opts, pars, vpars) ... getopt ("__header__", setfield ... (setfield (vpars, "body_command_option", "copying_body_command"), "title_option", "copying_title")); ## Options for package list page. Don't add new items here, this ## page should ideally be constructed from scratch at the server ## side. options.include_package_list_item = true; options.package_list_item = @ (opts, pars, vpars) [ ... "

" pars.package "

\n\

" pars.shortdescription "

\n\

\n\ details\n\

\n"]; ## Options for index package options.index_title = @ (opts, pars, vpars) ... sprintf ("The '%s' Package", pars.package); options.download_link = @ (opts, pars, vpars) [ ... fullfile(vpars.root, "download.php") "?package=" ... pars.package "-" pars.version "." opts.extension]; options.older_versions_download = @ (opts, pars, vpars) ... fullfile (vpars.root, "released-packages/"); options.repository_link = @ (opts, pars, vpars) ... fullfile (vpars.root, sprintf ("pkg-repository/%s/", pars.package)); options.include_package_page = true; options.include_package_license = true; options.include_package_news = true; options.index_body_command = "onload=\"javascript:fix_top_menu ();\""; options.index_header = ... @ (opts, pars, vpars) ... getopt ("__header__", setfield ... (setfield (vpars, "body_command_option", "index_body_command"), "title_option", "index_title")); options.index_footer = [sf_logo "
\n\n\n"]; ## Package doc options.package_doc = ""; options.package_doc_options = [ ... "--set-customization-variable 'TOP_NODE_UP_URL ../index.html' " ... "--css-ref=\"../../octave-forge.css\" " ... "--set-customization-variable 'AFTER_BODY_OPEN " ... "
\n" "' " ... "--set-customization-variable 'PRE_BODY_CLOSE " ... sf_logo "
\n'"]; ## Name of directory with project website files. options.website_files = "of-website-files"; case "octave" options.header = @ (opts, pars, vpars) ... sprintf ("__HEADER__(`%s')", getopt ("title", vpars)); options.footer = "__OCTAVE_TRAILER__"; options.title = @ (opts, pars, vpars) ... sprintf ("Function Reference: %", vpars.name); options.include_overview = true; otherwise error ("Unknown project name: %s", project_name); endswitch endfunction generate_html-0.3.3/inst/PaxHeaders/html_help_text.m0000644000000000000000000000006214234263413017570 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/html_help_text.m0000644000175000017500000000526514234263413020410 0ustar00jadejade00000000000000## Copyright (C) 2008 Soren Hauberg ## Copyright (C) 2014, 2015 Julien Bect ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} html_help_text (@var{name}, @var{outname}, @var{options}) ## Writes a function help text to disk formatted as @t{HTML}. ## ## The help text of the function @var{name} is written to the file @var{outname} ## formatted as @t{HTML}. The design of the generated @t{HTML} page is controlled ## through the @var{options} variable. This is a structure with the following ## optional fields. ## ## @table @samp ## @item header ## This field contains the @t{HTML} header of the generated file. Through this ## things such as @t{CSS} style sheets can be set. ## @item footer ## This field contains the @t{HTML} footer of the generated file. This should ## match the @samp{header} field to ensure all opened tags get closed. ## @item title ## This field sets the title of the @t{HTML} page. This is enforced even if the ## @samp{header} field contains a title. ## @end table ## ## @var{options} structures for various projects can be with the @code{get_html_options} ## function. As a convenience, if @var{options} is a string, a structure will ## be generated by calling @code{get_html_options}. ## ## @seealso{get_html_options, generate_package_html} ## @end deftypefn function html_help_text ... (name, outname, options = struct (), root = "", pkgroot = "", pkgname = "") ## This function is an interface, to be called as a standalone function. ## Check number of input arguments if (nargin < 2) print_usage (); endif ## Process input argument 'options' if (ischar (options)) || (isstruct (options)) options = get_html_options (options); else error ("Third input argument must be a string or a structure"); endif ## Initialize setopts. setopts (options, struct ("name", pkgname)); ## Call the actual function, now under private/. __html_help_text__ (outname, struct ("name", name, "pkgroot", pkgroot)); endfunction generate_html-0.3.3/inst/PaxHeaders/urlview.m0000644000000000000000000000006214234263413016245 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/urlview.m0000644000175000017500000001176414234263413017066 0ustar00jadejade00000000000000## Copyright (C) 2017 Olaf Till ## ## This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see ## . ## -*- texinfo -*- ## @deftypefn {Function File} urlview (@var{url}) ## @deftypefnx {Function File} urlview (@var{url}, @var{method}, @var{parameters}) ## @deftypefnx {Function File} urlview (@dots{}, @var{options}) ## Asynchroneously view an url. ## ## The given url @var{url} is viewed in a browser in a separate ## process. As with @code{urlread}, parameters can be specified as a ## cell array @var{parameters} of name value pairs, and @var{method} ## can be "post" or "get". The field @code{browser} of a structure ## @var{options}, given as an optional last argument, may specify the ## browser to use instead of the default. The browser must have ## javascript enabled. ## ## @end deftypefn function urlview (url, varargin) if ((nargs = nargin ()) < 1 || nargs > 4) print_usage (); endif options = struct (); method = "get"; pars = {}; for id = 1 : (nvargs = numel (varargin)) if (isstruct (varargin{id}) && id == nvargs) options = varargin{id}; elseif (ischar (varargin{id}) && id == 1) method = tolower (varargin{id}); if (nvargs >= 2 && iscell (varargin{2})) pars = varargin{2}; else print_usage (); endif elseif (iscell (varargin{id}) && id == 2) ## varargin{2} has already been processed else print_usage (); endif endfor if (! any (strcmp (method, {"get", "post"}))) error ("method must be 'get' or 'post'"); endif ## lowercase option names opts = struct (); for [val, key] = options opts.(tolower (key)) = val; endfor clear ("options"); # so we can't erroneously use it later ## check for unknown option names known = {"browser"}; if (numel (unknown = setdiff (fieldnames (opts), known))) warning ("unknown option(s):%s", sprintf (" %s", unknown{:})); endif ## set option values browser = setoption (opts, "browser"); if (isempty (browser)) for cmd = {"firefox", "epiphany"} if (! ([err, path] = system (sprintf ("which %s", cmd{:})))) browser = cmd{:}; break endif endfor if (isempty (browser)) error ("no browser found -- try with specifying option 'browser'"); endif endif if (round (rem (npars = numel (pars), 2))) error ("parameters must be a cell array with an even number of elements"); endif if (strcmp (method, "get") && numel (url) + npars + numel ([pars{:}]) > 2048) error ("url size limit 2048 of method 'get' exceeded") endif pid = -1; ## Relying on Octave to delete the tempfile does not work here. if (([fid, tname, msg] = ... mkstemp (fullfile (tempdir (), "octave-urlview-XXXXXX"))) == -1) error ("could not make temporary file: %s", msg); endif unwind_protect if (npars) data = ... sprintf (' ', pars{:}); else data = ""; endif fprintf (fid, "%s%s%s", header (url, method), data, footer ()); fclose (fid); ## The 'sleep' is necessary since some browsers seem to pass the ## job on to an already running browser, and so may quit before ## the latter browser reads the temporary file. cmd = sprintf ("(%s file://%s > /dev/null 2> /dev/null; sleep 1; rm -f %s) &", browser, tname, tname); pid = system (cmd, false, "async"); unwind_protect_cleanup try fclose (fid); catch end_try_catch if (pid < 0) unlink (tname); else waitpid (pid); endif end_unwind_protect endfunction function ret = header (url, method) ret = ... ['', "\n", ... '', "\n", ... '', "\n", ... '
', "\n"]; endfunction function ret = footer () ret = ... ['
', "\n", ... '', "\n", ... '', "\n", ... '', "\n"]; endfunction function ret = setoption (opts, opt) persistent defaults = {"browser", ""}; persistent defs = cell2struct (defaults(:, 2), defaults(:, 1)); if (isfield (opts, opt)) ret = opts.(opt); else ret = defs.(opt); endif endfunction generate_html-0.3.3/inst/PaxHeaders/of-website-files0000644000000000000000000000013114234274056017463 xustar0029 mtime=1651603502.39314919 30 atime=1651603502.422150848 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/0000755000175000017500000000000014234274056020353 5ustar00jadejade00000000000000generate_html-0.3.3/inst/of-website-files/PaxHeaders/download.png0000644000000000000000000000006214234263413022053 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/download.png0000644000175000017500000000155214234263413022666 0ustar00jadejade00000000000000PNG  IHDRĴl;sBIT|dtEXtSoftwarewww.inkscape.org<IDAT8OlU?LwVm8L4m!i4!8@011^4&4%zE4OrV#6&Dh" Q4* !Ry~vv;]v[9_ͼw~Q"P݋e5M{z{#78o>y K8tۃPU@.?q ǡPk `AXZijR5- ^x_{"qOxHtRb/P+fZr}~?vF!<Ԩ cK<~O.CX,FJN . Q(>V&LY>7O,cff*M *d~6LֆG:')c~FZz-J# DQl/t(x:<ٌ ܹsEr9h!xFQlLNND(J(Z E,C"tJejFgll[nFs||~=zĿw[n1:4@,#|J A 5 a#]|/ҬWQds'irXL<jb6iZrӬr?gyyɏ~#n7(bZ{.z3@|>t:<$ .^HP?)Nboo%* J%x^oJ»=z9L7$#^0ѣ|}^QgzzNC!H`X0ͬ3::J,h4JP8Nz-yd2 0<<-zvx<@?j5l6PM&l6#Y]]ҥK4Mfggix<)hXYYAѰ lmmdh4Mr9c~Ԓ*ţuG45jk/x8N'>DE|> PIӸ\nah4J%&&&C*B$APrj$If3X Պ Jzl6ZɄRDѐL& dYZ-\~ /^dxx!j|G*vRE$  ~vDtN *333dK]|t:bawwAp\e6\͆(<~Evvv0\~A*4 ".h4pV>N<^388H?tTJ `ll\.GD"l6>@*R#t7fVJ$IݻǥK\|V+b… LLL`XxѣG\v ٌB@TbZ999`0PױX,L&A{LpR6OB6:zfÇdA:NNfvvU ]6RՐJrxd2:f>y$ɠAF\ "SjlP(H$F< X,F\ft:M6\.#"cccHR4f-.^Z`0HP@"033C `ffVEZfF* p:q&''v˨T*p8a4 ZF:nrE4jUA ͕+W888  !JQ(DQDQ$t:!J!N?z}7Dr.$gjYCGjJDQΟ?Ͻ{uT*`hhc;t:BBX,FOOϟGVs%DQڵkuBiLLL ɨVf\. htDڂ۠b͔Q=j?ް4jeeKnjp'''z1 ܿ1t:FR)~BA0$Hp8t?rxxLrd2Z-rʇa Vd2b!Hfgg)R)~022ݻwq8dY ׯ_gww^$jA"@py0& VK `{{Jl6vjn GGG$In7W^LLLK__r>ݻG[ a8F.?o42??###ܼy .P׻MMƍr||̫>zjCCCDQ"r۷o#HH$x^r928zȔi'jBZR*NV , juDQ|>O,#jH$VVVfzt:vwwFv;ZNc}}!4Agy&sssL&VWWj EMLZemmq~mΞ=H$(]7>>`vvEw CP(X,999yv3,".l6Rf!| ds188NlŨVe~?FjuZ-:!###c^zgRe82w8|q4`^ODZPK2BhDxhs]hZT**J7z.^6Ry3;;ݻwq:r4LgϲD"2O?3g`0x6-NVܻwc^/o& |ݚʌDŦ~G:LERT!t:T*"˴Z-|>:ɄC*v'.\@Rx8<.\`ooa>#^~e,fLZjQ((@<gaaʥKȗ~LђuFm*b᧌i4n D=}vA 5j|w *V) ]}cǦy`H$B^hp9:&|>O"juE+333[kt:>FFFP|g,..ajjRM /E!z/GOO]G1e%J1GC%miViIU4fL~e{;JEjJCCCdY#L2331( xE 6Nb]{9VVVP(J޽{ }}} f󓿹NTB*ʾQ&m5"[6TBN^c''' G$pddloo#6 &liJMbjjc"SSS<~ę3gկ~sDJNM6v@O3Ͱ{sZN&iQ.T*l6ruxl6355{8{9F#?+{o7j6TR{uX j,}&j7":u Jױ4 y&(RTuxX,7annQ}6/b~}+I4@ͻEh;u%ZBF$Ƙ7՟StW׿5===={;|>q:i"^DFJ󕿛۲ߨW3n|בH$Pz\z3g000~appGT*X,] U8BP~= 4ߊEt\INni4[ΒNjB!fffEw}EVkW||x^l6 oUDcSx2Û f[nNLT*pU^u6Ek[ oNx{K🽈Fի|>j5rZFZԩSs %k_vcY./MӫRthJq ߈dzZN>Ĥ@9ݯ #YMIENDB`generate_html-0.3.3/inst/of-website-files/PaxHeaders/icons0000644000000000000000000000013214234274056020577 xustar0030 mtime=1651603502.392149133 30 atime=1651603502.422150848 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/icons/0000755000175000017500000000000014234274056021466 5ustar00jadejade00000000000000generate_html-0.3.3/inst/of-website-files/icons/PaxHeaders/repository.attrib0000644000000000000000000000006214234263413024277 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/icons/repository.attrib0000644000175000017500000000024314234263413025106 0ustar00jadejade00000000000000"By dracos, George Shuklin (talk), (http://dracos.deviantart.com/#/d2y5ele) [CC BY-SA 3.0 (http://creativecommons.org/licenses/by-sa/3.0)], via Wikimedia Commons" generate_html-0.3.3/inst/of-website-files/PaxHeaders/fixed.js0000644000000000000000000000006214234263413021173 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/fixed.js0000644000175000017500000000060514234263413022004 0ustar00jadejade00000000000000/* Copyright (C) 2009 Søren Hauberg This file licensed under the CC0 license (see ), effectively placing it in the public domain. */ function fix_top_menu() { if (navigator.appVersion.indexOf('MSIE') == -1) { document.getElementById("top-menu").style.position = "fixed"; } // end non-IE } generate_html-0.3.3/inst/of-website-files/PaxHeaders/news.png0000644000000000000000000000006214234263413021220 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/news.png0000644000175000017500000000164414234263413022035 0ustar00jadejade00000000000000PNG  IHDRĴl;sBIT|d pHYsXXtEXtSoftwarewww.inkscape.org<tEXtTitleTask DuetEXtAuthorJakub Steiner/!tEXtSourcehttp://jimmac.musichall.czif^IDAT8KTQǿ缧3㌎jPqZPj#amD7-'*DVTMc crfQ6pf= :p>%0 Mv:(9z|Fm]'&>DB]cccq955`WS}UG:̪<Te4ܬ0maU}gbpkmOy#w>6#J|9]dž(ҧ::m$ڛ-_ M0L~븶D[f`vn )Lh ׅ^izȾp%Rfa`(^.A %e^reh|q,ZkKR߆ϝN_O~ӟ-..6+ϟk-Z89 "mnmm:έ۷ossƍ/VWWvZcjjJJ%Xk [>."hyyaz?Ȃ.i*ְ/"CehZF+1.aii z;;;{.sBA( 4M$ 4EG!1 "Io<΢h@)uRBk=ҔR "!Zzy9gpy<cmiǀܹ @zDQZ)%ztZ퓹9v=(EΝ;ZI( ^0 2dY6J"f-pQ*`#\… "<O>E߇srj^ 5.q_}9 C$Ik-:6Z\<2REs  gZ$1U݋`j:@>uC8[3 @Rӧ!$1DX<[t f\scK|5}ρǣ~m :TWMwgon*2ȪpG[K#%ȲGWpwڭ/>2 M땕:4V!G彏!I @dGWB M2:㻀αy48z[ZB(8@U!k&HDZgGbA$@Ue{h&)=T\Gu ilO$صGk8}ugD2eѳut"6mNuӴXȟIsdhx}G.rY =AY|>O$s~2VLT:MZ)R){wq}Ǻ*>GS\0-LvVI@OK*!vrud7v&s҆-PIENDB`generate_html-0.3.3/inst/of-website-files/PaxHeaders/favicon.ico0000644000000000000000000000006214234263413021657 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/favicon.ico0000644000175000017500000000217614234263413022475 0ustar00jadejade00000000000000 h(  @Ð 7– Ƙǜʟʣ$ϟ0“ ėƛȞʢ"ApUUWֱ-’ ĖƚȜuʢ ?̦&QU)~)~U ÕŘ]U)~)~U ĕƗ1WֱUU:qXכVUUV)dݻDٽKV'|**'|VUۿPU****U߿@ TU****USQXV'|**'|VZ^7XכUUUVXכX5^ɢ#w̤&ͧ*Ҫ--XUZˣ''Ψ+Ϫ/ѭ4߿PU*Uϫ0Ѯ4ӱ9մ>ժUU=\_UWӱ7Ա9մ>ַCػHٽMRW\a7ظBi׻GڽMRV]S߿` generate_html-0.3.3/inst/of-website-files/PaxHeaders/manual.png0000644000000000000000000000006214234263413021521 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/manual.png0000644000175000017500000000212014234263413022324 0ustar00jadejade00000000000000PNG  IHDRĴl;sBIT|d pHYsXXtEXtSoftwarewww.inkscape.org<tEXtTitleDictionary%=tEXtAuthorUlisse PerusinJsIDAT8MkG3;;&il 6$ 8$6*?@C`T| rP)/5֛m!;3=8ƱMgNo~,Z:^ :* p޶'mA(q~/v{?w'RJN2:;;;CF5^__ӎYcáL?{8` (v_RTgwrM>B0B@)p!5RJH)1c\(ֱ~QM0yǯ8GsI|BR`ڎZKk?apr& *)wM+<} Xa*'Ju0B]E8vo 4/ Zcny5~}9GX @3b.sF]p_k3mWżS)g䎟/j'j[- %RJC E]&09Oc#39 z^)\#[^փR f ޣlj@*|D m-m N010 <[,,'7:5)$L$(%  |@2\Db~9Y(d#&Z 8Nse%P"o~c npno잶?t PhЏ_=kѮcm2 BZDZ@iUtnZnnnQ9a)41B(0R,04 c Ғ>6H v@nqmNj7(IENDB`generate_html-0.3.3/inst/of-website-files/PaxHeaders/doc.png0000644000000000000000000000006214234263413021011 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/doc.png0000644000175000017500000000251714234263413021626 0ustar00jadejade00000000000000PNG  IHDRĴl;sBIT|dtEXtSoftwarewww.inkscape.org<IDAT8klTE3mm;l--w* $ &CT"((&F^eIHЈQ#!lr%Re[ 6E(ݶs?v۠8ɛ3̗yD jⱢ'^":`60dZx s&$SFN_KW7%ⱢD1T^[xV>j(m)$!?P8U%'XQC@$jy#Eq{;頔I!2mwWf|0wʪcEo< Ͷ5ۺ$'1}p^Z8 !?9${oqLOV Xdϯ՞J.NJFnO5>uٸYV,*|?z=R录3i_lp3`I}-ؖeXA]] C~![D Q鱗4t]0R߲vd&?{J-40MycH!R(MCi=+^bژT@UtCGHJZ[e@U6!DRRRC}_P\z]ױ-1 ])FT}sItv.tVS7*}[鷿t cJ`\u<\M^]=$]tv%NP0?}pwEt .Q8r޶M2{R(!@iSc}\jX{`ӎ^ֿfb{VdL7Wnq>7ZuQˢ003e ަ/twt !0)2ތ#v̙͟2ãDAT7Ey-+ɳ5mh>vh<`!D60g  YO2rt6'Z[/? mpy^q+|@VZ̴ Ri " >@IENDB`generate_html-0.3.3/inst/of-website-files/PaxHeaders/javascript.js0000644000000000000000000000006214234263413022242 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/javascript.js0000644000175000017500000001034414234263413023054 0ustar00jadejade00000000000000/* Copyright (C) 2008 Soren Hauberg This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see . */ var cookie_name = "octave_forge_cookie"; function set_cookie(val) { if (document.cookie != document.cookie) { index = document.cookie.indexOf(cookie_name); } else { index = -1; } if (index == -1) { var cval = cookie_name + "=" + val + "; "; var d = new Date(); d.setSeconds(d.getSeconds()+30); cval = cval + "expires=" + d.toString() + ";"; document.cookie = cval; } } function get_cookie() { var retval = -1; if (document.cookie) { var index = document.cookie.indexOf(cookie_name); if (index != -1) { var start = document.cookie.indexOf("=", index) + 1; stop = document.cookie.indexOf(";", start); if (stop == -1) { stop = document.cookie.length; } retval = document.cookie.substring(start, stop); } } return retval; } function goto_url (selSelectObject) { if (selSelectObject.options[selSelectObject.selectedIndex].value != "-1") { location.href=selSelectObject.options[selSelectObject.selectedIndex].value; } } function show_left_menu () { document.getElementById ("left-menu").style.display = "block"; } function manual_menu () { // XXX: What should we do here? And do we even need this function? write_left_menu (); } function write_top_menu (prefix) { // default prefix (maybe some old browsers need this way) prefix = (typeof prefix == 'undefined') ? '.' : prefix; document.write (` `); } function write_docs_left_menu (prefix) { // default prefix (maybe some old browsers need this way) prefix = (typeof prefix == 'undefined') ? '.' : prefix; document.write (` `); } generate_html-0.3.3/inst/of-website-files/PaxHeaders/footer.js0000644000000000000000000000006214234263413021372 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/footer.js0000644000175000017500000000202614234263413022202 0ustar00jadejade00000000000000/* Copyright (C) 2008 Soren Hauberg This program is free software; you can redistribute it 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 program 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 program; see the file COPYING. If not, see . */ // This function is in an extra file because it contains code specific // to the hosting service. function write_footer () { document.write (` `); } generate_html-0.3.3/inst/of-website-files/PaxHeaders/octave-forge.css0000644000000000000000000000006214234263413022631 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/inst/of-website-files/octave-forge.css0000644000175000017500000003061114234263413023442 0ustar00jadejade00000000000000/* TOP MENU LAYOUT */ /* Copyright (C) 2009 Søren Hauberg Copyright (C) 2015 Oliver Heimlich Copyright (C) 2016 Julien Bect You can redistribute this program 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 program 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 program; if not, see . */ div.menu { /*background: #8fb171;*/ /* Green3 */ /*background: #6d8861;*/ /* Green2 */ /*background: #577749;*/ /* Green */ /*background: #8789a5;*/ /* Purple */ /*background: #ff6600;*/ /* Bright orange */ /*background: #ea5224;*/ /* Orange */ /*background: #ea9024;*/ /* Puke yellow */ background: #729fcf; /*background: white;*/ color: black; width: 100%; /* position: fixed;*/ position: absolute; top: 0px; left: 0px; padding-bottom: 0em; z-index: 3; /*text-align: center;*/ } table.menu { border: none; /* border-style: hidden; */ width: 100%; height: 4em; padding-left: 2em; padding-right: 0em; padding-top: 0.5em; padding-bottom: 0em; color: #363636; background-color: inherit; } td.menu { border: none; } a.menu { text-decoration: none; color: black; background-color: inherit; font-size: 80%; } a.menu:visited { color: black; background-color: inherit; } a.menu:link { color: black; background-color: inherit; } a.menu:hover { text-decoration: underline; } big.menu { font-style: normal; font-size: 120%; letter-spacing: 0.1em; line-height: 1.2em; font-weight: bold; } small.menu { font-style: italic; font-size: 80%; } /* END TOP MENU LAYOUT */ /* Regular elements */ body { background: white; color: black; font-family: sans-serif; font-weight: normal; font-size: medium; min-width: 500px; max-width: 950px; margin-left: 0em; margin-right: 0em; margin-top: 0em; } a:link { background-color: inherit; /*color: #4e9a06;*/ color: black; } a:visited { background-color: inherit; /*color: #73d216;*/ color: black; } /* Layout of packages page */ div.func { margin-left: 1em; } h3.package_name { background-color: #eeeeec; border: 2px solid #d3d7cf; padding: 2px; } /* the navigation choices at the bottom of the page. */ div#nav { background: white; color: black; float: left; font-family: sans-serif; font-size: 0.8em; margin: 1em 0 0 1em; padding: 1px; position: fixed; /*text-align: left;*/ width: 10em; } div#nav a { background-color: #73d216; border: 1px solid; border-color: #4e9a06; display: block; padding: 0.2em 0.5em 0.2em 0.5em ; text-decoration: none; color: black; } div#nav a:hover { background-color: #4e9a06; color: inherit; } div#nav div#currentnav { background-color: #ccccdd; border: 1px solid; border-color: #4e9a06; display: block; padding: 0.2em 0.5em 0.2em 0.5em ; text-decoration: none; color: black; text-align: right; } /* the navigation choices for function reference. */ div#nav2 { float: right; background-color: #73d216; color: black; padding: 3px; } td.alpha_table { border: 2px solid #d3d7cf; background-color: #eeeeec; text-align: center; padding: 1em; } a.alpha_table { font-weight: bold; text-decoration: none; } /* The style for the function reference sections */ .func { background-color: inherit; color: inherit; text-align: left; display: block; float: left; } .flink { background-color: inherit; color: inherit; text-align: right; display: block; float: right; } .ftext { margin-left: 5ex; margin-bottom: 2ex; clear: both; } /* the page content */ #content, #packagedoccontent { display: block; position: absolute; margin-left: 6em; /*margin-right: 8em;*/ margin-top: 4.5em; padding-top: 1em; width: 70%; } #doccontent { position: absolute; float: left; padding-left: 18em; padding-top: 1em; margin-top: 4.5em; margin-right: 4em; z-index: 1; width: 70%; } div#sf_logo { text-align: right; float: right; } /* NEWS FLASH */ h2.flash { font-style: normal; font-size: 120%; letter-spacing: 0.1em; line-height: 1.2em; font-weight: bold; color: black; background-color: inherit; } div.flash { border: solid 3px black; width: 70%; color: black; background: #fcaf3e; /* Orange */ padding: 0.3em; } /* END NEWS FLASH */ /* the title bar */ div#title { width: 100%; clear: both; position: fixed; top: 0; } div#title h1 { background-color: #ffffff; border-bottom: 4px solid #73d216; font-size: xx-large; color: #73d216; padding: 0; margin: 0; } /* The blue title bar on non-main pages */ /* .header { color: #ffffff; background-color: #10a0ff; font-family: arial,sans-serif; padding: 0; font-size: medium; font-weight: bold; border: 3px solid #10a0ff; } */ /* Changes for Octave Wiki */ /* h1 { background-color: #3465a4; color: #ffffff; font-size: xx-large; padding: 2em; margin: 8em; } */ h3.question { font-size: small; } h4, h5, h6 { background-color: inherit; color: #3465a4; font-size: large; padding: 2px; margin-top: 5px; } /* code { padding: 1px; margin-left: 1em; border: 1px solid; border-color: #babdb6; background-color: #d3d7cf; color: black; } */ table#main_package_table { background-color: #d3d7cf; color: inherit; border: 1px solid; border-color: #babdb6; margin: 1em 0 0; padding: 0.2em 0.5em 0.2em 0.2em; text-decoration: none; } td.package_table { padding-right: 1.5em; } div#description_box { padding-top: 1em; } div.package { margin-top: 0.2em; background-color: #d3d7cf; border: 1px solid; border-color: #babdb6; padding: 0.2em 0.2em 0; color: black; } a.package_head_link { background-color: inherit; color: black; text-decoration: none; } table.package { table-layout: fixed; width: 100%; } p.package_link a { background-color: inherit; color: black; text-decoration: none; } div.see_also { background: #EEEEEC; border: solid 2px #babdb6; padding: 2px; } dt { font-weight: bold; padding-top: 1em; } /* Documentation left menu */ #left-menu { display: none; color: black; border: none; position: fixed; /*position: absolute;*/ float: left; top: 4em; left: 0em; width: 15em; bottom: 0em; background: #EEEEEC; padding-left: 1em; padding-top: 1.5em; padding-bottom: 0.5em; border-left: solid 2px; border-right: solid 2px; border-bottom: solid 2px; border-top: none; margin: -2px; z-index: 2; } p.left-menu { margin-top: 0.5em; margin-bottom: 0.5em; } a.left-menu-link { text-decoration: none; } ul.left-menu-list { list-style: none; text-indent: -2em; margin-top: -0.5em; } /* Headers in the function reference */ h3.category { background: #EEEEEC; border: solid 2px #babdb6; padding: 4px; } /* Doxygen stylesheet */ DIV.tabs { float : left; width : 100%; margin-bottom : 4px; } DIV.tabs UL { margin : 0px; padding-left : 10px; list-style : none; } DIV.tabs LI, DIV.tabs FORM { display : inline; margin : 0px; padding : 0px; } DIV.tabs FORM { float : right; } DIV.tabs A { float : left; border-bottom : 2px solid #d3d7cf; font-size : x-small; font-weight : bold; text-decoration : none; } DIV.tabs A:hover { background-position: 100% -150px; } DIV.tabs A:link, DIV.tabs A:visited, DIV.tabs A:active, DIV.tabs A:hover { color: black; background-color: inherit; } DIV.tabs SPAN { float : left; display : block; padding : 5px 9px; white-space : nowrap; } DIV.tabs INPUT { float : right; display : inline; font-size : 1em; } DIV.tabs TD { font-size : x-small; font-weight : bold; text-decoration : none; } /* Commented Backslash Hack hides rule from IE5-Mac \*/ DIV.tabs SPAN {float : none;} /* End IE5-Mac hack */ DIV.tabs A:hover SPAN { background-position: 0% -150px; } DIV.tabs LI#current A { background-position: 100% -150px; border-width : 0px; } DIV.tabs LI#current SPAN { border-top : 2px solid #d3d7cf; border-right : 2px solid #d3d7cf; border-left : 2px solid #d3d7cf; background-position: 0% -150px; padding-bottom : 5px; background : #eeeeec; color : black; } DIV.nav { background : none; border : none; /* border-bottom : 2px solid #d3d7cf; */ } /* End doxygen */ table.images { width: 90%; border: 2px solid #555753; background: #babdb6; } th.images { } td.images { border: 2px solid #555753; background: white; } img.demo { width: 100%; } td.box_table { padding-right: 5em; } div.package_box { background: #fce94f; border: 2px solid #edd400; -moz-border-radius: 10px; -webkit-border-radius: 10px; } div.package_box_header { font-size: 105%; font-weight: bold; padding: 0.5em; -moz-border-radius-topleft: 10px; -webkit-border-radius-topleft: 10px; -moz-border-radius-topright: 10px; -webkit-border-radius-topright: 10px; background: #edd400; border: 2px solid #edd400; } div.package_box_contents { padding: 0.5em; } div.download_package { background: #8ae234; border: 2px solid #73d216; -moz-border-radius: 10px; -webkit-border-radius: 10px; padding: 1em; font-weight: bold; } a.function_reference_link, a.download_link, a.homepage_link, a.repository_link, a.older_versions_download, a.package_doc, a.news_file { text-decoration: none; } a.older_versions_download { font-size: 8pt; font-weight: normal; text-decoration: none; } div.package_function_reference { background: #729fcf; border: 2px solid #3465a4; -moz-border-radius: 10px; -webkit-border-radius: 10px; padding: 1em; font-weight: bold; } #description_box { width: 80%; } blockquote { margin-left: 0em; } p.functionfile { margin-left: -1em; margin-bottom: -0.8em; font-weight: bold; } DIV.package_display { position: relative; display: inline-block; vertical-align: top; margin-right: 2em; margin-bottom: 1em; width: 23em; padding-left: 108px; min-height: 100px; text-decoration: none; } DIV.package_display > * { padding-left: .8em; } DIV.package_display IMG { display: block; position: absolute; padding: 0; left: 0; top: 0; width: 100px; height: 100px; margin-left: 0; margin-right: 1em; } DIV.package_display H3.package_name { border: none; margin-top: 0; margin-bottom: .5em; background-color: #D3D7CF; -webkit-transition: all .2s ease-out 0s; -moz-transition: all .2s ease-out 0s; -ms-transition: all .2s ease-out 0s; -o-transition: all .2s ease-out 0s; transition: all .2s ease-out 0s; } DIV.package_display:hover H3.package_name { background-color: #729FCF; } DIV.package_display P { margin-top: 0; margin-bottom: 0; } A.package_name { /* display: block; */ text-decoration: none; } A.package_group { /* display: block; */ text-decoration: none; float: right; font-size: 50%; line-height: 166%; color: white; } DIV.package_display A.package_link, DIV.package_display A.download_link, DIV.package_display A.repository_link { color: black; font-weight: bold; font-size: 80%; display: inline-block; text-decoration: none; line-height: 22px; padding: .5em .5em .5em 26px; min-height: 22px; background-repeat: no-repeat; background-position: left center; } DIV.package_display A.download_link { padding-right: .65em; } DIV.package_display A.repository_link { padding-left: 30px; } DIV.package_display A.package_link { background-image: url("pkg-page.png"); } DIV.package_display A.download_link { background-image: url("download.png"); } DIV.package_display A.repository_link { background-image: url("repository.png"); } h4.notice { font-weight: normal; font-size: 100%; color: black; font-style: italic; } p.error { font-weight: normal; font-size: 100%; color: red; } generate_html-0.3.3/PaxHeaders/COPYING0000644000000000000000000000006214234263413014450 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/COPYING0000644000175000017500000010451314234263413015264 0ustar00jadejade00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it 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 program 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 program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . generate_html-0.3.3/PaxHeaders/INDEX0000644000000000000000000000006214234263413014207 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/INDEX0000644000175000017500000000041314234263413015015 0ustar00jadejade00000000000000generate_html >> Generate HTML web page from help texts Main functions html_help_text generate_package_html generate_html_manual generate_operators get_html_options Utility Functions txi2index txi2reference texi2html Website access urlview check_duplicates generate_html-0.3.3/PaxHeaders/DESCRIPTION0000644000000000000000000000006214234263413015123 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/DESCRIPTION0000644000175000017500000000107414234263413015735 0ustar00jadejade00000000000000Name: generate_html Version: 0.3.3 Date: 2022-05-03 Author: Søren Hauberg and others Maintainer: Octave-Forge community Title: Generate HTML web page from help texts Description: This package provides functions for generating HTML pages that contain the help texts for a set of functions. The package is designed to be as general as possible, but also contains convenience functions for generating a set of pages for entire packages. Depends: octave (>= 3.2.0) SystemRequirements: makeinfo [Debian] texinfo License: GPLv3+ generate_html-0.3.3/PaxHeaders/NEWS0000644000000000000000000000006214234263413014114 xustar0020 atime=1651599115 30 ctime=1651603502.422150848 generate_html-0.3.3/NEWS0000644000175000017500000002322214234263413014725 0ustar00jadejade00000000000000Summary of important user-visible changes for generate_html 0.3.3: ------------------------------------------------------------------- ** Fix non-cuddling ++ operators to work with Octave >= 7.. ** Dont duplicate demo figures in following non figure demos. (Bug #58126) Summary of important user-visible changes for generate_html 0.3.2: ------------------------------------------------------------------- ** Fix empty '{}' to work with Octave >= 6.. Summary of important user-visible changes for generate_html 0.3.1: ------------------------------------------------------------------- ** Add lacking information to the informational json file (this file is written since version 0.3.0 of generate_html). Summary of important user-visible changes for generate_html 0.3.0: ------------------------------------------------------------------- ** Nested namespaces and classes under namespaces are now handled in generating the alphabetical function database. ** Toplevel functions are now in separate files of the alphabetic function database, and in the same directory tree as classes and namespaces. ** Function html helptexts are now in a directory tree corresponding to that of the alphabetic function database. ** Add repository link to index page. ** In the individual options, as returned by `get_html_options' and used in html generation, replacement strings ("%...") are not considered anymore. Instead, options can be anonymous functions which use their arguments to configure the output string. So if users manually changed options with replacements, they have to do it differently now; looking into the `get_html_options.m' file will help to figure out the correct way. ** Add Octave Forge stylesheet, icons, and javascript files. ** Page margins of Octave Forge additional package documentation are now configurable with the Octave Forge stylesheet. Summary of important user-visible changes for generate_html 0.2.0: ------------------------------------------------------------------- ** New function `check_duplicates' checks for duplicate symbols by querying a server at Octave Forge. ** New function `urlview' asynchroneously starts a browser for an url, supports sending parameters with POST and GET methods. ** Vectorize generation of alphabetic function database. ** Make alphabetic databases for class methods and namespaced functions, too. Summary of important user-visible changes for generate_html 0.1.13: ------------------------------------------------------------------- ** Changes to the package index page o generate_package_html: Make icons clickable. ** Change URLs o get_html_options: Use the new https URLs for the octave-forge (default) style. ** Bug fixes o html_help_text, generate_package_html: Handle undocumented functions. o generate_html_manual (get_txi_files): Ignore version-octave.texi, which was previously named version.texi. ** Improve release Makefile o Makefile: Make release tarballs reproducible Summary of important user-visible changes for generate_html 0.1.12: ------------------------------------------------------------------- ** New option for generate_package_html o generate_package_html, get_html_options: Add new field 'older_versions_download' to the option structure. This field makes it possible for packages to customize (or suppress) the "older versions" download link, which is actually Octave Forge-specific (patch #8984). ** Changes to the package index page o generate_package_html: The content of the optional "url" field of the DESCRIPTION file is now shown beneath the news link (patch #8990). Summary of important user-visible changes for generate_html 0.1.11: ------------------------------------------------------------------- ** Content of autoload field not shown anymore o generate_package_html: index.html no longer displays autoload information (and there is no other place in the generated HTML with that information). The main reasons for this change are: 1) there are no Octave Forge packages that autoload anymore, 2) support for autoload of packages will be completely removed in Octave 4.2.x. ** New option for generate_package_html o generate_package_html, get_html_options: Add new field 'package_doc_options' to the option structure (patch #9002). This field makes it possible to pass options to makeinfo when building the package documentation. Summary of important user-visible changes for generate_html 0.1.10: ------------------------------------------------------------------- ** Bug fixes o generate_package_html: Fixed title of copying and news page. o generate_package_html: Support multiple image references per line (to copy images into the output directory). ** Other changes o generate_package_html: Short description has been updated for redesign of Octave-Forge package overview page (patch #8787). Short description is made of the first sentence from the full package desription. o generate_package_html: Package documentation may use vector graphics (svg images, bug #45628). Summary of important user-visible changes for generate_html 0.1.9: ------------------------------------------------------------------ ** Bug fixes o generate_package_html: Add missing "alt" attribute to tags in index.html. o html_help_text: Fix crash for demos in @class methods (bug #44972). o generate_package_html: Fix crash when options.include_package_news is false. o texi2html: Fix a bug that caused tex2html to output an empty page with TexInfo 4.x when there is only one @deftypefn and no following @deftypefnx (bug #45530). o generate_package_html: Fix a bug that prevented generate_package_html from being run twice when package_doc contains images (bug #45111). o html_help_text: Use a simple deterministic counter to enumerate images instead of a random number (thus avoiding the risk of having one image overwritten by another one). ** Other changes o generate_package_html: Better-looking "News" and "Package documentation" links (patch #8698). o generate_package_html: Improve dependencies display: also display system requirements (bug #45499). Summary of important user-visible changes for generate_html 0.1.8: ------------------------------------------------------------------ ** Bug fixes o html_help_text.m, texi2html.m: Fix a bug that was the cause of unmatched

tags in the HTML output. o get_html_options.m: Fix default header (add !DOCTYPE, charset, etc.) and Octave Forge header (unordered
lists are not allowed to be nested in

blocks). ** Other changes o html_help_text.m: Now entirely based on texi2html.m o texi2html.m: Use
blocks both with TexInfo 4.x and with TexInfo 5.x. Summary of important user-visible changes for generate_html 0.1.7: ------------------------------------------------------------------ ** Bug fixes o Omit the "News" link if there is no NEWS file, instead of generating an error (the NEWS file is optional, according to the manual) o Fix broken links on the NEWS, COPYING and overview pages (the link that was supposed to point to the index.html of the package) o Protect symbols <, > and & by replacing them with the corresponding HTML entity (<, > and &) everywhere it makes sense o get_txi_files.m: Update the list of ignored *.texi files o generate_package_html.m: Let email addresses appear if they exist in DESCRIPTION (they were previously hidden because of the < > delimiters) o generate_package_html.m: Fix anchor names o html_help_text.m: Hide figures only if gnuplot is in use (see bug #33180) o html_help_text.m: Prevent empty
blocks (bug #44451) ** New features o Introduce a new %charset variable for header template, which defaults to utf-8 (instead of the hard-coded iso-8859-1 that was previously in use) ** Documentation o Add generate_operators to the INDEX o Provide minimal (one-line) help text for generate_html_manual ** Cleanup o Remove obsolete function generate_alphabet o Remove unused "docbrowser" style Summary of important user-visible changes for generate_html 0.1.6: ------------------------------------------------------------------ ** Create page with content of each package NEWS file. ** Create package documentation in html from Texinfo sources in doc/. Note that this is the package documentation/manual, and in addition to the help text of individual functions. ** Fix broken links from the pages of methods of a @class type, to the package index package. ** Link on each page header to the source of Octave Forge now points to the code page of Octave Forge website. It previously pointed to the SVN repository in Sourceforge which has been retired. Summary of important user-visible changes for generate_html 0.1.5: ------------------------------------------------------------------ ** Updated link for the Octave Forge SVN repository. Summary of important user-visible changes for generate_html 0.1.4: ------------------------------------------------------------------ ** HTML pages with documentation of each function now mention the package that the function belongs too and have a link for the package main page. ** Autoload field when generating a package index.html page is now correct. ** keywords on the `See also:' will be interpreted properly (rather than just function names).