From 0c63180af6e1787b695a80768c55fc1620130550 Mon Sep 17 00:00:00 2001 From: eudoxia Date: Tue, 16 Nov 2021 11:22:55 -0500 Subject: software/web: updated math rendering information, adjusted some phrasing --- sitemap.xml | 2 +- software/web/index.html | 56 +++++++++++++++++++++++++++++-------------------- 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"> https://distress.network/software/2021-08-25T00:36:43-04:00 -https://distress.network/software/web/2021-08-25T00:27:08-04:00 +https://distress.network/software/web/2021-11-16T11:20:21-05:00 https://distress.network/visual/2020-12-19T21:03:36-05:00 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 @@ Website Maintenance Tools — DistressNetwork° - +
@@ -24,12 +24,12 @@
  • plain.sh
    • -
  • svgtex.sh
  • Other Tools
    • front.sh
      • @@ -50,12 +50,12 @@

      The script may be executed with a single argument corresponding to the webpage directory containing the input Markdown file, which should be named src.md. The output HTML file, named index.html, will be located in the same directory.

      -
      ./md.sh <target directory>
+
      ./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>
+
      ./md.sh <input md> <output html>
 
      
 
 
      Dependencies
      
@@ -72,7 +72,7 @@
 
        
 
      • title, for the HTML page title;
        • 
 
      • bomber, for the header splash text;
        • 
-
      • leading, for the page's leading phrase;
        • 
+
      • leading, for the page’s leading phrase;
        • 
 
      • opts, for further configuration options described below.
        • 
 
      
 
@@ -81,16 +81,33 @@
 
        
 
      • 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 via npm.
      
+
+
      Block expressions are declared as follows:
      
+
+
      ![...](%tex)
+
      
+
+
      Inline expressions are declared as follows:
      
+
+
      ![...](%itex)
+
      
+
+
      where ... is the LaTeX expression.
      
 
 
      plain.sh
      
 
 
      plain.sh converts plain text files to HTML documents.
      
 
-
      ./plain.sh <input txt> <output html>
+
      ./plain.sh <input txt> <output html>
 
      
 
 
      Page Title
      
@@ -102,48 +119,41 @@
 
 
      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
      
 
 
      front.sh generates the front page.
      
 
-
      ./front.sh <output html>
+
      ./front.sh <output html>
 
      
 
 
 
 
      nav.sh generates the sitemap navigation pane. Installation of tree is required.
      
 
-
      ./nav.sh <source dir> <output file>
+
      ./nav.sh <source dir> <output file>
 
      
 
 
      reload.sh
      
 
-
      reload.sh 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.
      
+
      reload.sh 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.
      
 
-
      ./reload.sh [-r]
+
      ./reload.sh [-r]
 
      
 
 
      sitemap.sh
      
 
-
      sitemap.sh generates the website's XML sitemap, as specified by sitemaps.org.
      
+
      sitemap.sh generates the website’s XML sitemap, as specified by sitemaps.org.
      
 
-
      ./sitemap.sh <target dir> <output xml>
+
      ./sitemap.sh <target dir> <output xml>
 
      
 
 
      urlencode
      
 
 
      urlencode is a small C program which converts a string into a URL-encoded format.
      
 
-
      echo "<string>" | ./urlencode
+
      echo "<string>" | ./urlencode