diff options
| author | eudoxia <uplink@distress.network> | 2023-12-11 06:51:45 -0500 |
|---|---|---|
| committer | eudoxia <uplink@distress.network> | 2023-12-11 06:51:45 -0500 |
| commit | ec1646bbdbbb43d4841b4135cfa69bbc9f53a98d (patch) | |
| tree | 65076dff5bd02bc057c52daddfcaf710a86e8cd8 /software | |
| parent | bc1d4980c354ecea354e2d2b4ede93c07c4bdac7 (diff) | |
Diffstat (limited to 'software')
| -rwxr-xr-x | software/index.html | 9 | ||||
| -rw-r--r-- | software/literary/index.html | 42 | ||||
| -rw-r--r-- | software/web/index.html | 30 |
3 files changed, 43 insertions, 38 deletions
diff --git a/software/index.html b/software/index.html index 40a4aeb..5727870 100755 --- a/software/index.html +++ b/software/index.html @@ -9,20 +9,21 @@ <link rel="icon" type="image/png" sizes="32x32" href="/favicon/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/favicon/favicon-16x16.png"> <link rel="manifest" href="/favicon/site.webmanifest"> -<script src="/js/bg.js"></script> <title>Executable Software Works — DistressNetwork°</title> <meta name="description" content="«EXOCORTICES.» — This directory contains documentation of all software-based works." /> -<meta http-equiv="last-modified" content="2022-04-25 02:08:26-04:00" /> +<meta http-equiv="last-modified" content="2022-04-25 02:10:35-04:00" /> </head> <body> +<!-- <header> <div class="bomber">EXOCORTICES.</div> <hr> <div class="identcontainer"> -<div class="ident"><time datetime="2022-04-25 02:08:26-04:00">220425</time>––––<a href="https://distress.network">DistressNetwork°</a></div> +<div class="ident"><time datetime="2022-04-25 02:10:35-04:00">220425</time>––––<a href="https://distress.network">DistressNetwork°</a></div> <img class="headerlogo" src="/media/distressnetwork-b.svg" alt=""> </div> </header> +--> <div class="contentlevel"> <main> <div class="leading">This directory contains documentation of all software-based works.</div> @@ -61,7 +62,7 @@ </nav> </div> <footer> -<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="/meta/sitemap">Sitemap.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> +<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> <img src="/media/distressnetwork-w.svg" alt=""> </footer> </body> diff --git a/software/literary/index.html b/software/literary/index.html index fd9eb36..e1d6b20 100644 --- a/software/literary/index.html +++ b/software/literary/index.html @@ -10,39 +10,41 @@ <link rel="icon" type="image/png" sizes="16x16" href="/favicon/favicon-16x16.png"> <link rel="manifest" href="/favicon/site.webmanifest"> <title>Literary — DistressNetwork°</title> -<meta http-equiv="last-modified" content="2022-07-21 05:52:07-04:00" /> +<meta http-equiv="last-modified" content="2022-07-21 06:01:01-04:00" /> </head> <body> +<!-- +--> <div class="contentlevel"> <main> <div class="leading">A lightweight, extensible literate programming tool.</div> <hr> <nav class="toc"> <ul> -<li><a href="#overview">Overview</a> +<li><a href="#Overview">Overview</a> <ul> -<li><a href="#usage">Usage</a></li> +<li><a href="#Usage">Usage</a></li> </ul></li> -<li><a href="#dependencies">Dependencies</a></li> -<li><a href="#file-structure">File Structure</a> +<li><a href="#Dependencies">Dependencies</a></li> +<li><a href="#File%20Structure">File Structure</a> <ul> -<li><a href="#section-commands">Section Commands</a></li> -<li><a href="#configuration-commands">Configuration Commands</a></li> +<li><a href="#Section%20Commands">Section Commands</a></li> +<li><a href="#Configuration%20Commands">Configuration Commands</a></li> </ul></li> -<li><a href="#literate-source-code">Literate Source Code</a></li> -<li><a href="#caveats">Caveats</a></li> -<li><a href="#future-work">Future Work</a></li> +<li><a href="#Literate%20Source%20Code">Literate Source Code</a></li> +<li><a href="#Caveats">Caveats</a></li> +<li><a href="#Future%20Work">Future Work</a></li> </ul> </nav> -<h1 id="overview">Overview</h1> +<h1 id="Overview">Overview</h1> <p>This tool consists of two programs, <code>tangle</code> and <code>weave</code>, both of which accept an input file from stdin and write output to stdout. There are no command-line arguments or other sources of input data. The literate programming interface is language-agnostic with respect to both the source code language and the document formatting language used.</p> -<h2 id="usage">Usage</h2> +<h2 id="Usage">Usage</h2> <p>These programs are intended to be intermediary text processing functions, used as components within build automation routines or shell scripts. The build processes for this tool itself, <code>build.sh</code> and <code>gen-docs.sh</code>, serve as example use cases.</p> -<h1 id="dependencies">Dependencies</h1> +<h1 id="Dependencies">Dependencies</h1> <p>For compiling the executables:</p> @@ -57,11 +59,11 @@ <li><a href="https://kristaps.bsd.lv/lowdown">lowdown</a></li> </ul> -<h1 id="file-structure">File Structure</h1> +<h1 id="File%20Structure">File Structure</h1> <p>A literate programming file consists of plain text sections, code sections, and output configuration commands. Inclusion of the top-level code section, named <code>*</code>, is mandatory within input to <code>tangle</code>, and certain configuration commands are mandatory within input to <code>weave</code>, described in a later section.</p> -<h2 id="section-commands">Section Commands</h2> +<h2 id="Section%20Commands">Section Commands</h2> <p>Code sections are created as follows:</p> @@ -84,7 +86,7 @@ <p>References may be prepended by any amount of whitespace, whereas other commands must be placed at the immediate start of the line.</p> -<h2 id="configuration-commands">Configuration Commands</h2> +<h2 id="Configuration%20Commands">Configuration Commands</h2> <p>These commands define the format of the code sections and references as they would appear in the output of <code>weave</code>, written as follows:</p> @@ -124,7 +126,7 @@ <li><code>@@</code>, which represents the name of the current section being defined, if it occurs within the format string for <code>@start</code>, <code>@add</code>, or <code>@end</code>, or the name of the section being referenced, if it occurs within the format string for <code>@ref</code>.</li> </ul> -<h1 id="literate-source-code">Literate Source Code</h1> +<h1 id="Literate%20Source%20Code">Literate Source Code</h1> <p>The source code of this tool is rendered as a set of literate program documents, listed below.</p> @@ -135,7 +137,7 @@ <li><a href="/software/literary/weave.html">weave.lp</a></li> </ul> -<h1 id="caveats">Caveats</h1> +<h1 id="Caveats">Caveats</h1> <ul> <li>The text generation routine performed by <code>weave</code> does not verify the correctness of the section commands within the input file; as such, its output upon receiving malformed input should be considered undefined behaviour. It is therefore recommended to pass newly created or modified files into <code>tangle</code> first, which performs the necessary input validation.</li> @@ -143,7 +145,7 @@ <li>Attempting to use the Texinfo typesetting language in conjunction with this tool results in namespace collisions with multiple command names.</li> </ul> -<h1 id="future-work">Future Work</h1> +<h1 id="Future%20Work">Future Work</h1> <ul> <li>The treatment of whitespace within formatting and configuration commands is currently rather strict, as no trimming of leading or trailing whitespace around the command contents is applied. This may be changed for the sake of convenience, at the expense of added parsing complexity.</li> @@ -169,7 +171,7 @@ </nav> </div> <footer> -<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="/meta/sitemap">Sitemap.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> +<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> <img src="/media/distressnetwork-w.svg" alt=""> </footer> </body> diff --git a/software/web/index.html b/software/web/index.html index 73c4244..3296d73 100644 --- a/software/web/index.html +++ b/software/web/index.html @@ -10,27 +10,29 @@ <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="2022-03-31 23:30:21-04:00" /> +<meta http-equiv="last-modified" content="2022-01-18 02:44:59-05:00" /> </head> <body> +<!-- +--> <div class="contentlevel"> <main> <div class="leading">A collection of tools for the maintenance of this website.</div> <hr> <nav class="toc"> <ul> -<li><a href="#overview">Overview</a></li> +<li><a href="#Overview">Overview</a></li> <li><a href="#md.sh">md.sh</a> <ul> -<li><a href="#dependencies">Dependencies</a></li> -<li><a href="#document-metadata">Document Metadata</a></li> -<li><a href="#math-rendering">Math Rendering</a></li> +<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-title">Page Title</a></li> +<li><a href="#Page%20Title">Page Title</a></li> </ul></li> -<li><a href="#other-tools">Other Tools</a> +<li><a href="#Other%20Tools">Other Tools</a> <ul> <li><a href="#front.sh">front.sh</a></li> <li><a href="#nav.sh">nav.sh</a></li> @@ -40,7 +42,7 @@ </ul></li> </ul> </nav> -<h1 id="overview">Overview</h1> +<h1 id="Overview">Overview</h1> <p>These scripts must be executed from within their residing directory only, and depend on adjacent files within it in order to function. For convenience it is recommended to create symlinks within this directory to all website directories under maintenance.</p> @@ -58,13 +60,13 @@ <pre><code>./md.sh <input md> <output html> </code></pre> -<h2 id="dependencies">Dependencies</h2> +<h2 id="Dependencies">Dependencies</h2> <ul> <li><a href="https://kristaps.bsd.lv/lowdown">lowdown</a></li> </ul> -<h2 id="document-metadata">Document Metadata</h2> +<h2 id="Document%20Metadata">Document Metadata</h2> <p>The input file may begin with metadata key-value declarations, as specified by <a href="https://kristaps.bsd.lv/lowdown/lowdown.5.html#Metadata">lowdown(5)</a>. <code>md.sh</code> recognizes and formats the following:</p> @@ -86,7 +88,7 @@ <p>The table of contents may produce erroneous links if two headers within the page have identical names.</p> -<h2 id="math-rendering">Math Rendering</h2> +<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> @@ -109,7 +111,7 @@ <pre><code>./plain.sh <input txt> <output html> </code></pre> -<h2 id="page-title">Page Title</h2> +<h2 id="Page%20Title">Page Title</h2> <p>The HTML page title may be specified within the input document using the following declaration:</p> @@ -118,7 +120,7 @@ <p>where <code>...</code> is the page title.</p> -<h1 id="other-tools">Other Tools</h1> +<h1 id="Other%20Tools">Other Tools</h1> <h2 id="front.sh">front.sh</h2> @@ -174,7 +176,7 @@ </nav> </div> <footer> -<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="/meta/sitemap">Sitemap.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> +<p><a href="/info">About.</a> <a href="mailto:uplink@distress.network">Contact.</a> <a href="https://git.distress.network">Repository.</a> <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0.</a></p> <img src="/media/distressnetwork-w.svg" alt=""> </footer> </body> |