add "line 2" file descriptions to most files

latex3 · Nov 18, 2017 · 8b44745 · 8b44745
1 parent 51bcae7
commit 8b44745
Show file tree

Hide file tree

Showing 27 changed files with 69 additions and 49 deletions.
diff --git a/MANIFEST.md b/MANIFEST.md
@@ -1,77 +1,71 @@
 # Manifest for unicode-math
 
 This file is automatically generated with `texlua build.lua manifest`.
-Only ‘source’ files in the repository and derived files are included in this list;
-it does not include ‘generated’ files such as PDF.
 
 ## Source files
 
-* unimath-example.ltx
-* um-code-pkgopt.dtx
-* um-code-opening.dtx
-* unicode-math-code.ltx
-* um-code-usv.dtx
-* unicode-math.ltx
-* unimath-symbols.ltx
-* um-code-epilogue.dtx
-* unicode-math-table.tex
+* um-code-sscript.dtx: Setup for active chars needed to process subscript/superscript input chars.
+* um-code-main.dtx: Definition of `\setmainfont`.
+* um-code-alphabets.dtx: Definitions for setting up the "math symbol alphabets".
+* um-code-ui.dtx: The xparse user interface top-level definitions.
+* um-code-pkgopt.dtx: Package options.
+* um-code-msg.dtx: Definitions of error, warning, and log messages.
+* um-code-api.dtx: The (underdeveloped) API to interface with the package internals.
+* um-code-variables.dtx: Declaration of all code-level variables used in the package.
+* um-code-mathtext.dtx: The "math text" commands such as `\mathbf` and co.
+* um-code-base.dtx: Definition of unicode-math.sty, which splits and loads according to engine.
+* um-code-fontparam.dtx: Interface for font parameters
+* um-code-usv.dtx: Mapping of mathematical unicode slots for alphabets.
+* um-code-fontopt.dtx: Keyval for `\setmathfont`
+* um-code-setchar.dtx: General assignment of maths symbols.
+* um-code-compat.dtx: Compatibility with 3rd party packages.
+* um-code-mathmap.dtx: The "math symbol alphabets" such as `\symbf` and co.
+* unicode-math-table.tex: Source file of the math symbols.
+* um-code-primes.dtx: The definitions needed for the input of primes.
+* unicode-math.ins: Docstrip installer.
+* um-code-epilogue.dtx: Assorted definitions to close up.
+* unicode-math.dtx: Metadata for the package code, including files and versioning
+* um-code-opening.dtx: Assorted initialisation tasks, including some low-level function definitions.
+
+## Typeset documentation source files
+
+* unimath-symbols.ltx: Listing of Unicode mathematics symbols using a variety of fonts.
+* unicode-math-code.ltx: Typeset code.
+* unicode-math.ltx: User documentation.
+* unimath-example.ltx: A minimal example file to demonstrate the package.
+
+## Plain documentation files
+
 * um-doc-style.tex
-* um-code-api.dtx
-* um-code-msg.dtx
-* um-doc.tex
+* LICENSE
 * um-doc-nfsssummary.tex
-* um-code-sscript.dtx
-* um-code-base.dtx
-* um-code-fontopt.dtx
-* um-code-fontparam.dtx
-* um-doc-mathfontdimen.tex
-* um-code-ui.dtx
-* um-code-mathmap.dtx
-* um-code-mathtext.dtx
-* um-doc-legacyfontdimen.tex
-* unicode-math.dtx
-* unicode-math.ins
-* um-code-primes.dtx
-* um-code-compat.dtx
-* um-code-alphabets.dtx
-* um-code-main.dtx
-* um-code-variables.dtx
 * um-doc-stixextract.tex
-* um-code-setchar.dtx
-
-## Text and Documentation files
-
-* README.md
+* um-doc-legacyfontdimen.tex
 * CHANGES.md
+* um-doc-mathfontdimen.tex
+* README.md
 
 ## Derived files
 
-* unicode-math-luatex.sty
 * unicode-math-xetex.sty
+* unicode-math-luatex.sty
 * unicode-math.sty
 
-## Typeset documents
-
-* unicode-math.pdf
-* unimath-example.pdf
-* unicode-math-code.pdf
-* unimath-symbols.pdf
-
 ## Checking-specific support files
 
 * umtest-preamble.tex
 
 ## Test files
 
 * mathit-symit.luatex.tlg
-* mathit-symit.xetex.tlg
-* fontname-log.luatex.tlg
+* mathit-symit.lvt
+* mathit-symit-var.xetex.tlg
 * mathit-symit-var.lvt
-* fontname-log.lvt
 * fontname-log.xetex.tlg
-* aaa-loading.luatex.tlg
-* mathit-symit.lvt
 * aaa-loading.lvt
 * mathit-symit-var.luatex.tlg
-* mathit-symit-var.xetex.tlg
+* aaa-loading.luatex.tlg
+* mathit-symit.xetex.tlg
+* fontname-log.luatex.tlg
 * aaa-loading.xetex.tlg
+* fontname-log.lvt
diff --git a/um-code-alphabets.dtx b/um-code-alphabets.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-alphabets.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Definitions for setting up the "math symbol alphabets".
 
 % \section{Setting up alphabets}
 % \label{sec:setupalphabets}

diff --git a/um-code-api.dtx b/um-code-api.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-api.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% The (underdeveloped) API to interface with the package internals.
 
 % \section{Programmers' interface}
 %

diff --git a/um-code-base.dtx b/um-code-base.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-base.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Definition of unicode-math.sty, which splits and loads according to engine.
 
 % \section{The \texttt{unicode-math.sty} loading file}
 %

diff --git a/um-code-compat.dtx b/um-code-compat.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-compat.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Compatibility with 3rd party packages.
 
 % \section{Compatibility}
 %

diff --git a/um-code-epilogue.dtx b/um-code-epilogue.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-epilogue.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Assorted definitions to close up.
 
 % \section{Epilogue}
 %

diff --git a/um-code-fontopt.dtx b/um-code-fontopt.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-fontopt.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Keyval for `\setmathfont`
 
 % \section{Font loading options}
 %

diff --git a/um-code-fontparam.dtx b/um-code-fontparam.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-fontparam.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Interface for font parameters
 
 % \section{Common interface for font parameters}
 %

diff --git a/um-code-main.dtx b/um-code-main.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-main.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Definition of `\setmainfont`.
 
 % \section{The main \cs{setmathfont} macro}
 %

diff --git a/um-code-mathmap.dtx b/um-code-mathmap.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-mathmap.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% The "math symbol alphabets" such as `\symbf` and co.
 
 % \section{Mapping in maths alphabets}
 % \label{sec:mathmap}

diff --git a/um-code-mathtext.dtx b/um-code-mathtext.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-mathtext.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% The "math text" commands such as `\mathbf` and co.
 
 % \section{Maths text commands}
 %

diff --git a/um-code-msg.dtx b/um-code-msg.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-msg.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Definitions of error, warning, and log messages.
 
 % \section{Error messages}
 % \seclabel{codemsg}

diff --git a/um-code-opening.dtx b/um-code-opening.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-opening.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Assorted initialisation tasks, including some low-level function definitions.
 
 % \section{Start of the package code}
 %

diff --git a/um-code-pkgopt.dtx b/um-code-pkgopt.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-pkgopt.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Package options.
 
 % \section{setup and package options}
 %

diff --git a/um-code-primes.dtx b/um-code-primes.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-primes.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% The definitions needed for the input of primes.
 
 % \section{Primes}
 %

diff --git a/um-code-setchar.dtx b/um-code-setchar.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-setchar.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% General assignment of maths symbols.
 
 % \section{Setting up maths chars}
 %

diff --git a/um-code-sscript.dtx b/um-code-sscript.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-sscript.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Setup for active chars needed to process subscript/superscript input chars.
 
 % \section{Unicode sub- and super-scripts}
 %

diff --git a/um-code-ui.dtx b/um-code-ui.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-ui.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% The xparse user interface top-level definitions.
 
 % \section{The user interface commands}
 %

diff --git a/um-code-usv.dtx b/um-code-usv.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-usv.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Mapping of mathematical unicode slots for alphabets.
 
 % \section{Alphabet Unicode positions}
 %

diff --git a/um-code-variables.dtx b/um-code-variables.dtx
@@ -1,4 +1,5 @@
 %%^^A%% um-code-variables.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Declaration of all code-level variables used in the package.
 
 % \section{Variable initialisation}
 %

diff --git a/unicode-math-code.ltx b/unicode-math-code.ltx
@@ -1,4 +1,5 @@
 %%^^A%% unicode-math-code.ltx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Typeset code.
 
 \documentclass[a4paper]{ltxdoc}
 \input{um-doc-style.tex}

diff --git a/unicode-math-table.tex b/unicode-math-table.tex
@@ -1,4 +1,5 @@
 %%^^A%% unicode-math-table.tex -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Source file of the math symbols.
 
 \UnicodeMathSymbol{"00021}{\mathexclam }{\mathclose}{exclamation mark}%
 \UnicodeMathSymbol{"00023}{\mathoctothorpe }{\mathord}{number sign}%

diff --git a/unicode-math.dtx b/unicode-math.dtx
@@ -1,4 +1,5 @@
 %%^^A%% unicode-math.dtx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Metadata for the package code, including files and versioning
 
 % \section{Package declaration}
 %

diff --git a/unicode-math.ins b/unicode-math.ins
@@ -1,4 +1,5 @@
 %%^^A%% unicode-math.ins -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Docstrip installer.
 
 \ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
 \input unicode-math.dtx\relax

diff --git a/unicode-math.ltx b/unicode-math.ltx
@@ -1,4 +1,5 @@
 %%^^A%% unicode-math.ltx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% User documentation.
 
 \documentclass[a4paper]{ltxdoc}
 \input{um-doc-style.tex}

diff --git a/unimath-example.ltx b/unimath-example.ltx
@@ -1,4 +1,5 @@
 %%^^A%% unimath-example.ltx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% A minimal example file to demonstrate the package.
 
 %%%%%%%%%%%%%%%%%%%%%%%
 % UNICODE-MATH EXAMPLE FILE

diff --git a/unimath-symbols.ltx b/unimath-symbols.ltx
@@ -1,4 +1,5 @@
 %%^^A%% unimath-symbols.ltx -- part of UNICODE-MATH <wspr.io/unicode-math>
+%%^^A%% Listing of Unicode mathematics symbols using a variety of fonts.
 
 %!TEX TS-program = LuaLaTeX