diff options
| author | eudoxia <uplink@distress.network> | 2021-11-16 11:22:55 -0500 |
|---|---|---|
| committer | eudoxia <uplink@distress.network> | 2021-11-16 11:22:55 -0500 |
| commit | 0c63180af6e1787b695a80768c55fc1620130550 (patch) | |
| tree | 35377554d6243d476650ae3a322f7f095d296835 | |
| parent | ce12a65e8914e0bb327a83c25ea9cd3848d41b02 (diff) | |
software/web: updated math rendering information, adjusted some phrasing
| -rwxr-xr-x | sitemap.xml | 2 | ||||
| -rw-r--r-- | software/web/index.html | 56 | ||||
| -rw-r--r-- | software/web/src.md | 33 |
3 files changed, 56 insertions, 35 deletions
diff --git a/sitemap.xml b/sitemap.xml index 9b6533f..72d7964 100755 --- a/sitemap.xml +++ b/sitemap.xml @@ -16,7 +16,7 @@ xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <url><loc>https://distress.network/software/</loc><lastmod>2021-08-25T00:36:43-04:00</lastmod></url> -<url><loc>https://distress.network/software/web/</loc><lastmod>2021-08-25T00:27:08-04:00</lastmod></url> +<url><loc>https://distress.network/software/web/</loc><lastmod>2021-11-16T11:20:21-05:00</lastmod></url> <url><loc>https://distress.network/visual/</loc><lastmod>2020-12-19T21:03:36-05:00</lastmod></url> diff --git a/software/web/index.html b/software/web/index.html index e831af1..31edade 100644 --- a/software/web/index.html +++ b/software/web/index.html @@ -10,7 +10,7 @@ <link rel="icon" type="image/png" sizes="16x16" href="/favicon/favicon-16x16.png"> <link rel="manifest" href="/favicon/site.webmanifest"> <title>Website Maintenance Tools — DistressNetwork°</title> -<meta http-equiv="last-modified" content="2021-08-25 00:27:08-04:00" /> +<meta http-equiv="last-modified" content="2021-11-16 11:20:21-05:00" /> </head> <body> <div class="contentlevel"> @@ -24,12 +24,12 @@ <ul> <li><a href="#Dependencies">Dependencies</a></li> <li><a href="#Document%20Metadata">Document Metadata</a></li> +<li><a href="#Math%20Rendering">Math Rendering</a></li> </ul></li> <li><a href="#plain.sh">plain.sh</a> <ul> <li><a href="#Page%20Title">Page Title</a></li> </ul></li> -<li><a href="#svgtex.sh">svgtex.sh</a></li> <li><a href="#Other%20Tools">Other Tools</a> <ul> <li><a href="#front.sh">front.sh</a></li> @@ -50,12 +50,12 @@ <p>The script may be executed with a single argument corresponding to the webpage directory containing the input Markdown file, which should be named <code>src.md</code>. The output HTML file, named <code>index.html</code>, will be located in the same directory.</p> -<pre><code>./md.sh <target directory> +<pre><code>./md.sh <target directory> </code></pre> -<p>Alternatively, the script may be given two arguments, pointing to the input file and output file paths respectively.</p> +<p>Alternatively, the script may be given two arguments consisting of the input and output file paths respectively.</p> -<pre><code>./md.sh <input md> <output html> +<pre><code>./md.sh <input md> <output html> </code></pre> <h2 id="Dependencies">Dependencies</h2> @@ -72,7 +72,7 @@ <ul> <li><code>title</code>, for the HTML page title;</li> <li><code>bomber</code>, for the header splash text;</li> -<li><code>leading</code>, for the page's leading phrase;</li> +<li><code>leading</code>, for the page’s leading phrase;</li> <li><code>opts</code>, for further configuration options described below.</li> </ul> @@ -81,16 +81,33 @@ <ul> <li><code>c</code>, to generate a table of contents;</li> <li><code>f</code>, to suppress generation of the page footer;</li> -<li><code>h</code>, to suppress generation of the page header.</li> +<li><code>h</code>, to suppress generation of the page header,</li> +<li><code>m</code>, to enable math rendering (see below).</li> </ul> -<p>The table of contents generation may malfunction if two header names are identical within the page.</p> +<p>The table of contents generation may malfunction if two headers within the page have identical names.</p> + +<h2 id="Math%20Rendering">Math Rendering</h2> + +<p>The rendering of LaTeX math mode expressions given within input files may be enabled by adding the <code>m</code> option. This depends on an installation of <a href="https://katex.org">KaTeX</a> via <code>npm</code>.</p> + +<p>Block expressions are declared as follows:</p> + +<pre><code> +</code></pre> + +<p>Inline expressions are declared as follows:</p> + +<pre><code> +</code></pre> + +<p>where <code>...</code> is the LaTeX expression.</p> <h1 id="plain.sh">plain.sh</h1> <p><code>plain.sh</code> converts plain text files to HTML documents.</p> -<pre><code>./plain.sh <input txt> <output html> +<pre><code>./plain.sh <input txt> <output html> </code></pre> <h2 id="Page%20Title">Page Title</h2> @@ -102,48 +119,41 @@ <p>where <code>...</code> is the page title.</p> -<h1 id="svgtex.sh">svgtex.sh</h1> - -<p><code>svgtex.sh</code> renders LaTeX math mode commands as SVG files.</p> - -<pre><code>echo "<equation>" | ./svgtex.sh <output path> -</code></pre> - <h1 id="Other%20Tools">Other Tools</h1> <h2 id="front.sh">front.sh</h2> <p><code>front.sh</code> generates the <a href="/">front page</a>.</p> -<pre><code>./front.sh <output html> +<pre><code>./front.sh <output html> </code></pre> <h2 id="nav.sh">nav.sh</h2> <p><code>nav.sh</code> generates the sitemap navigation pane. Installation of <a href="http://mama.indstate.edu/users/ice/tree/">tree</a> is required.</p> -<pre><code>./nav.sh <source dir> <output file> +<pre><code>./nav.sh <source dir> <output file> </code></pre> <h2 id="reload.sh">reload.sh</h2> -<p><code>reload.sh</code> is a meta-script which updates the website's front page, navigation listings, and XML sitemap, and can optionally regenerate all of the webpages at once.</p> +<p><code>reload.sh</code> is a meta-script which updates the website’s front page, navigation listings, and XML sitemap, and can optionally regenerate all of the webpages at once.</p> -<pre><code>./reload.sh [-r] +<pre><code>./reload.sh [-r] </code></pre> <h2 id="sitemap.sh">sitemap.sh</h2> -<p><code>sitemap.sh</code> generates the website's <a href="/sitemap.xml">XML sitemap</a>, as specified by <a href="https://www.sitemaps.org/protocol.html">sitemaps.org</a>.</p> +<p><code>sitemap.sh</code> generates the website’s <a href="/sitemap.xml">XML sitemap</a>, as specified by <a href="https://www.sitemaps.org/protocol.html">sitemaps.org</a>.</p> -<pre><code>./sitemap.sh <target dir> <output xml> +<pre><code>./sitemap.sh <target dir> <output xml> </code></pre> <h2 id="urlencode">urlencode</h2> <p><code>urlencode</code> is a small C program which converts a string into a URL-encoded format.</p> -<pre><code>echo "<string>" | ./urlencode +<pre><code>echo "<string>" | ./urlencode </code></pre> </main> <nav> diff --git a/software/web/src.md b/software/web/src.md index 37533f6..53fa14d 100644 --- a/software/web/src.md +++ b/software/web/src.md @@ -16,7 +16,7 @@ The script may be executed with a single argument corresponding to the webpage d ./md.sh <target directory> ``` -Alternatively, the script may be given two arguments, pointing to the input file and output file paths respectively. +Alternatively, the script may be given two arguments consisting of the input and output file paths respectively. ``` ./md.sh <input md> <output html> @@ -40,9 +40,28 @@ Page options are denoted by any combination of the following characters: - `c`, to generate a table of contents; - `f`, to suppress generation of the page footer; -- `h`, to suppress generation of the page header. +- `h`, to suppress generation of the page header, +- `m`, to enable math rendering (see below). -The table of contents generation may malfunction if two header names are identical within the page. +The table of contents generation may malfunction if two headers within the page have identical names. + +## Math Rendering + +The rendering of LaTeX math mode expressions given within input files may be enabled by adding the `m` option. This depends on an installation of [KaTeX](https://katex.org) via `npm`. + +Block expressions are declared as follows: + +``` + +``` + +Inline expressions are declared as follows: + +``` + +``` + +where `...` is the LaTeX expression. # plain.sh @@ -61,14 +80,6 @@ The HTML page title may be specified within the input document using the followi ``` where `...` is the page title. -# svgtex.sh - -`svgtex.sh` renders LaTeX math mode commands as SVG files. - -``` -echo "<equation>" | ./svgtex.sh <output path> -``` - # Other Tools ## front.sh |