Mercurial > octave-libtiff
view scripts/miscellaneous/private/__publish_html_output__.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 363fb10055df |
children | 939e69b45601 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{outstr} =} __publish_html_output__ (@var{type}, @var{varargin}) ## ## Internal function. ## ## The first input argument @var{type} defines the required strings ## (@samp{str}) or cell-strings (@samp{cstr}) in @var{varargin} in order ## to produce HTML output. ## ## @var{type} is one of ## ## @itemize @bullet ## @item ## @samp{output_file_extension} () ## ## @item ## @samp{header} (title_str, intro_str, toc_cstr) ## ## @item ## @samp{footer} () ## ## @item ## @samp{code} (str) ## ## @item ## @samp{code_output} (str) ## ## @item ## @samp{section} (str) ## ## @item ## @samp{preformatted_code} (str) ## ## @item ## @samp{preformatted_text} (str) ## ## @item ## @samp{bulleted_list} (cstr) ## ## @item ## @samp{numbered_list} (cstr) ## ## @item ## @samp{graphic} (str) ## ## @item ## @samp{html} (str) ## ## @item ## @samp{latex} (str) ## ## @item ## @samp{text} (str) ## ## @item ## @samp{blockmath} (str) ## ## @item ## @samp{inlinemath} (str) ## ## @item ## @samp{bold} (str) ## ## @item ## @samp{italic} (str) ## ## @item ## @samp{monospaced} (str) ## ## @item ## @samp{link} (url_str, url_str, str) ## ## @item ## @samp{TM} () ## ## @item ## @samp{R} () ## ## @item ## @samp{escape_special_chars} (str) ## @end itemize ## @end deftypefn function outstr = __publish_html_output__ (type, varargin) outstr = feval (["do_" type], varargin{:}); endfunction function outstr = do_output_file_extension () outstr = ".html"; endfunction function outstr = do_header (title_str, intro_str, toc_cstr) mathjax_str = sprintf ("%s\n", '<script type="text/x-mathjax-config">', "MathJax.Hub.Config({", " tex2jax: { inlineMath: [['$','$'], ['\\\\(','\\\\)']] },", " TeX: { equationNumbers: { autoNumber: 'all' } }", "});", "</script>", ['<script type="text/javascript" async ', ... 'src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?', ... 'config=TeX-MML-AM_CHTML"></script>']); stylesheet_str = sprintf ("%s\n", "<style>", "body > * {", " max-width: 42em;", "}", "body {", ' font-family: "Roboto Condensed", sans-serif;', " padding-left: 7.5em;", " padding-right: 7.5em;", "}", "pre, code {", " max-width: 50em;", " font-family: monospace;", "}", "pre.oct-code {", " border: 1px solid Grey;", " padding: 5px;", "}", "pre.oct-code-output {", " margin-left: 2em;", "}", "span.comment {", " color: ForestGreen;", "}",... "span.keyword {", " color: Blue;", "}",... "span.string {", " color: DarkOrchid;", "}",... "footer {", " margin-top: 2em;", " font-size: 80%;", "}", "a, a:visited {", " color: Blue;", "}", "h2 {", ' font-family: "Roboto Condensed", serif;', " margin-top: 1.5em;", "}", "h2 a, h2 a:visited {", " color: Black;", "}", "</style>"); outstr = sprintf ("%s\n", "<!DOCTYPE html>", "<html>", "<head>", '<meta charset="UTF-8">', ["<title>" title_str "</title>"], mathjax_str, stylesheet_str, "</head>", "<body>", ["<h1>" title_str "</h1>"], intro_str); if (! isempty (toc_cstr)) for i = 1:numel (toc_cstr) toc_cstr{i} = do_link (["#node" sprintf("%d", i)], toc_cstr{i}); endfor outstr = [outstr, "<h2>Contents</h2>", do_bulleted_list(toc_cstr)]; endif ## Reset section counter do_section (); endfunction function outstr = do_footer (m_source_str) outstr = sprintf ("%s\n", "", "<footer>", "<hr>", ['<a href="https://www.octave.org">Published with GNU Octave ' version() '</a>'], "</footer>", "<!--", "##### SOURCE BEGIN #####", m_source_str, "##### SOURCE END #####", "-->", "</body>", "</html>"); endfunction function outstr = do_code (str) outstr = ["\n", '<pre class="oct-code">' syntax_highlight(str) "</pre>\n"]; endfunction function outstr = do_code_output (str) str = do_escape_special_chars (str); outstr = ["\n", '<pre class="oct-code-output">' str "</pre>\n"]; endfunction function outstr = do_section (varargin) persistent counter = 1; if (nargin == 0) outstr = ""; counter = 1; return; endif outstr = ['<h2><a id="node' sprintf("%d", counter) '">', ... varargin{1}, ... "</a></h2>"]; counter++; endfunction function outstr = do_preformatted_code (str) outstr = ["\n", '<pre class="pre-code">' syntax_highlight(str) "</pre>\n"]; endfunction function outstr = do_preformatted_text (str) str = do_escape_special_chars (str); outstr = ["\n", '<pre class="pre-text">' str "</pre>\n"]; endfunction function outstr = do_bulleted_list (cstr) outstr = "\n<ul>\n"; for i = 1:numel (cstr) outstr = [outstr, "<li>" cstr{i} "</li>\n"]; endfor outstr = [outstr, "</ul>\n"]; endfunction function outstr = do_numbered_list (cstr) outstr = "\n<ol>\n"; for i = 1:numel (cstr) outstr = [outstr, "<li>" cstr{i} "</li>\n"]; endfor outstr = [outstr, "</ol>\n"]; endfunction function outstr = do_graphic (str) outstr = ['<img src="' str '" alt="' str '">']; endfunction function outstr = do_html (str) outstr = ["\n" str "\n"]; endfunction function outstr = do_latex (str) outstr = ""; endfunction function outstr = do_link (url_str, str) outstr = ['<a href="' url_str '">' str "</a>"]; endfunction function outstr = do_text (str) outstr = ["\n<p>" str "</p>\n"]; endfunction function outstr = do_blockmath (str) outstr = ["$$" str "$$"]; endfunction function outstr = do_inlinemath (str) outstr = ["$" str "$"]; endfunction function outstr = do_bold (str) outstr = ["<b>" str "</b>"]; endfunction function outstr = do_italic (str) outstr = ["<i>" str "</i>"]; endfunction function outstr = do_monospaced (str) outstr = ["<code>" str "</code>"]; endfunction function outstr = do_TM () outstr = "™"; endfunction function outstr = do_R () outstr = "®"; endfunction function str = do_escape_special_chars (str) str = regexprep (str, '&', '&'); str = regexprep (str, '<', '<'); str = regexprep (str, '>', '>'); ## str = regexprep (str, '"', '"'); ## MATLAB R2017a compatibility. endfunction ## SYNTAX_HIGHLIGHT: A primitive parser to highlight syntax via <span> tags. ## FIXME: Needs to be replaced by a better solution. function outstr = syntax_highlight (str) str = do_escape_special_chars (str); outstr = ""; placeholder_cstr = {}; i = 1; plh = 0; while (i <= numel (str)) ## Block comment if (any (strncmp (str(i:end), {"%{", "#{"}, 2))) plh_str = ['<span class="comment">', str(i:i+1)]; i += 2; while (i <= numel (str) && ! (any (strncmp (str(i:end), {"%}", "#}"}, 2)))) plh_str = [plh_str, str(i)]; i += 1; endwhile if (i < numel (str)) plh_str = [plh_str, str(i:i+1), "</span>"]; i += 2; else plh_str = [plh_str, "</span>"]; endif plh += 1; placeholder_cstr{plh} = plh_str; outstr = [outstr, " PUBLISHPLACEHOLDER", sprintf("%d", plh), " "]; ## Line comment elseif (str(i) == "#" || str(i) == "%") plh_str = '<span class="comment">'; idx = find (str(i:end) == "\n", 1); if (isempty (idx)) plh_str = [plh_str, str(i:end)]; i = numel (str) + 1; else plh_str = [plh_str, str(i:i+idx-2)]; i += idx; endif plh_str = [plh_str, "</span>\n"]; plh += 1; placeholder_cstr{plh} = plh_str; outstr = [outstr, " PUBLISHPLACEHOLDER", sprintf("%d", plh), " "]; ## Single quoted string elseif (str(i) == "'") plh_str = "<span class=\"string\">'"; i += 1; while (i <= numel (str)) ## Ignore escaped string terminations if (strncmp (str(i:end), "''", 2)) plh_str = [plh_str, "''"]; i += 2; ## Is char a string termination? elseif (str(i) == "'") plh_str = [plh_str, "'"]; i += 1; break; ## Is string terminated by line break? elseif (str(i) == "\n") break; ## String content else plh_str = [plh_str, str(i)]; i += 1; endif endwhile plh_str = [plh_str, "</span>"]; plh += 1; placeholder_cstr{plh} = plh_str; outstr = [outstr, " PUBLISHPLACEHOLDER", sprintf("%d", plh), " "]; ## Double quoted string elseif (str(i) == '"') plh_str = '<span class="string">"'; i += 1; while (i <= numel (str)) ## Is char a string termination? if (str(i) == '"' && str(i-1) != '\') plh_str = [plh_str, '"']; i += 1; break; ## Is string terminated by line break? elseif (str(i) == "\n") break; ## String content else plh_str = [plh_str, str(i)]; i += 1; endif endwhile plh_str = [plh_str, "</span>"]; plh += 1; placeholder_cstr{plh} = plh_str; outstr = [outstr, " PUBLISHPLACEHOLDER", sprintf("%d", plh), " "]; else outstr = [outstr, str(i)]; i += 1; endif endwhile persistent kword_ptn = strjoin (iskeyword (), '|'); ## FIXME: remove hack for regexprep once bug #38149 is solved outstr = [" ", strrep(outstr, "\n", " \n "), " "]; outstr = regexprep (outstr, ['(\s)(' kword_ptn ')(\s|\()'], ['$1<span class="keyword">$2</span>$3']); ## FIXME: remove hack for regexprep once bug #38149 is solved outstr = strrep (outstr(2:end-1), " \n ", "\n"); ## Restore placeholders for i = plh:-1:1 outstr = strrep (outstr, [" PUBLISHPLACEHOLDER", sprintf("%d", i), " "], placeholder_cstr{i}); endfor endfunction