summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-11-24 22:11:37 +0000
committerKarl Berry <karl@freefriends.org>2020-11-24 22:11:37 +0000
commit21dd641b3e636daa59b326c76dabbe7b62e535dd (patch)
treec1fb0fa6a717e621fceaec58df89ec84659800e4 /Master/texmf-dist/doc
parenta2cc75654ad7bf2c5fc7d54efe0376c00f16078c (diff)
schemata (24nov20)
git-svn-id: svn://tug.org/texlive/trunk@56994 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/generic/schemata/README117
-rw-r--r--Master/texmf-dist/doc/generic/schemata/README.md164
-rw-r--r--Master/texmf-dist/doc/generic/schemata/README.txt117
-rw-r--r--Master/texmf-dist/doc/generic/schemata/schemata.pdfbin629768 -> 644097 bytes
-rw-r--r--Master/texmf-dist/doc/generic/schemata/schematest.tex63
5 files changed, 194 insertions, 267 deletions
diff --git a/Master/texmf-dist/doc/generic/schemata/README b/Master/texmf-dist/doc/generic/schemata/README
deleted file mode 100644
index 1a7653d9a33..00000000000
--- a/Master/texmf-dist/doc/generic/schemata/README
+++ /dev/null
@@ -1,117 +0,0 @@
-
---------:| ----------------------------------------------------------------
-schemata:| Generic package to aid construction of topical categories
- Author:| Charles P. Schaum
- E-mail:| charles dot schaum@comcast.net
- License:| Released under the LaTeX Project Public License v1.3c or later
- See:| http://www.latex-project.org/lppl.txt
-
-Short description:
-The schemata package helps the creation of topical outlines that illustrate the breakdown of concepts and categories in academic texts from the late medieval to early modern periods.
-
-Files Distribution
-
-README This file
-schemata.pdf Documentation
-schematest.tex Test file for Plain TeX or Eplain
-schemata.png Image file used for the manual
-
-Makefile Automates building with GNU make 3.81
-schemata.dtx Documented LaTeX file containing both code and documentation
-
-Installation
-
-Download the package from
-
-https://www.ctan.org/tex-archive/macros/generic/schemata
-
-Unpack schemata.zip in an appropriate directory.
-
-If you have a make utility compatible with GNU make, either in
-GNU/Linux, a BSD variant, OSX, or Cygwin in Windows you can type
-
-make inst
-
-to install the package into your $TEXMFHOME tree or
-
-make install
-
-to install the package into your $TEXMFLOCAL tree for all users.
-The latter requires sudo privileges.
-
-Other useful targets include:
-
-(release process)
-
-make release The default target, same as just ``make''.
-
-make clean Removes all intermediate files. Left are
-the files listed above plus schemata.sty.
-
-make distclean Leave only schemata.dtx, schematest.tex,
-schemata.png, and Makefile.
-
-make zip Generate a zip file ready for distribution.
-
-(testing process)
-
-make testing Release files, plus compiles schematest.tex.
-
-It is not necessary, however, to use GNU make. One can generate
-the package files manually. Since the files schemata.ins and README.txt
-are contained in the .dtx file itself, the first step is to generate
-the installer driver schemata.ins, plus the file README.txt, which will
-also trigger the extraction of schemata.sty and produce the first pass of
-the package documentation schemata.pdf:
-
-pdflatex -shell-escape -recorder -interaction=batchmode schemata.dtx
-
-Next one adds a table of contents and all cross-references, this also
-should finalize page numbers for glossary and index input files:
-
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-
-The next commands generate the glossary/index output files:
-
-makeindex -q -s gglo.ist -o schemata.gls schemata.glo
-makeindex -q -s gind.ist -o schemata.ind schemata.idx
-
-The final two commands integrate the glossary (changes) and index:
-
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-
-Now one can either keep README.txt or rename it to README, e.g.:
-
-mv README.txt README
-
-Normally one creates the following directories for a user:
-
-$TEXMFHOME/source/generic/schemata dtx file, schemata.png
-$TEXMFHOME/doc/generic/schemata pdf file, README, schematest.tex,
-
-and creates the following directories for the local site:
-
-$TEXMFLOCAL/source/generic/schemata dtx file, schemata.png
-$TEXMFLOCAL/doc/generic/schemata pdf file, README, schematest.tex,
-
-The above environment variables often are /usr/local/texlive/texmf-local for
-$TEXMFLOCAL and ~/texmf for $TEXMFHOME.
-
-The make process normally renames the README.txt file created from the
-dtx file to just README by using mv (move / rename utility in the *nix
-userland). Windows distributions of TeX and LaTeX often keep the txt file
-because of using file extensions instead of ``magic numbers'' to identify
-files.
-
-Run mktexlsr with the appropriate level of permissions to complete the
-install.
-
-This packages works with LaTeX and Plain TeX.
-
-License
-
-This material is subject to the LaTeX Project Public License:
-http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
-
-Happy TeXing!
diff --git a/Master/texmf-dist/doc/generic/schemata/README.md b/Master/texmf-dist/doc/generic/schemata/README.md
new file mode 100644
index 00000000000..f77827815c6
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/schemata/README.md
@@ -0,0 +1,164 @@
+# Short Description
+
+Short description:
+The schemata package helps the creation of topical outlines that illustrate the breakdown of concepts and categories in academic texts from the late medieval to early modern periods.
+
+# Files
+
+|Filename |Description |
+|----------------|---------------------------------------|
+|`schemata.dtx` |commented style file; source file |
+|`Makefile` |For use with GNU make; with source file|
+|`schemata.ins` |installation driver (generated file) |
+|`schemata.pdf` |Documentation (generated file) |
+|`README.md` |This file (generated file) |
+|`schematest.tex`|Test file for Plain TeX or Eplain |
+|`schemata.png` |Image file used for the manual |
+
+# Obtaining the Package
+
+1. Packaged in your current TeX distrbution: See the appropriate documentation.
+
+2. Otherwise, download `schemata.zip` from [CTAN](www.ctan.org/tex-archive/macros/generic/schemata).
+
+3. Unpack `schemata.zip` in an appropriate directory.
+
+4. Change to the directory containing the `schemata` files.
+
+# File Generation
+
+## Automatic Installation
+
+This method requires GNU `make` on a POSIX-compliant environment, such as GNU/Linux, various BSD flavors, perhaps MacOS (e.g., with various porting systems), and even Cygwin on Windows.
+
+0. A quick install in one's home directory using some of the included files from the `zip` archive just requires the following steps:
+
+ tex schemata.dtx
+ make inst
+
+Otherwise we use the LaTeX installation on the host machine to build the package. When using `make`, any `dvi` files that are created will also be converted to `pdf` format.
+
+1. Type `make distclean release` to generate the release files using `pdflatex`.
+
+3. To use another TeX engine, type one of the following:
+ make ENGINE=latex
+ make ENGINE=lualatex
+ make ENGINE=dvilualatex
+ make ENGINE=xelatex
+
+4. Type `make inst` to install the files in the user's personal TDS-compliant directory tree.
+
+5. Type `sudo make install` to install the files in the system-wide, local TDS-compliant directory tree.
+
+## Manual Compilation
+
+Otherwise, the following steps are used for manual installation. See the general information at the [TeX FAQ](https://www.texfaq.org/FAQ-installthings).
+
+0. To use some of the included files from the `zip` archive and only extract files from the `dtx` file, just do the following step and proceed to installation:
+
+ tex schemata.dtx
+
+1. To build the package on the host system, generate the installation files and a copy of the documentation without the table of contents and cross-references. We use `pdflatex` by default:
+
+ pdflatex --shell-escape --recorder --interaction=batchmode schemata.dtx
+
+2. Generate the TOC and cross-references for the documentation:
+
+ pdflatex --recorder --interaction=nonstopmode schemata.dtx
+
+3. Generate the index files using `makeindex`:
+
+ makeindex -q -s gglo.ist -o schemata.gls schemata.glo
+ makeindex -q -s gind.ist -o schemata.ind schemata.idx
+
+4. Integrate the glossary (changes) and index into the documentation. The second run updates the TOC:
+
+ pdflatex --recorder --interaction=nonstopmode schemata.dtx
+ pdflatex --recorder --interaction=nonstopmode schemata.dtx
+
+One can substitute, e.g., `latex`, `xelatex`, `lualatex`, and `dvilualatex` for `pdflatex`, but the documentation may look different in some cases.
+
+## File Installation
+
+Different TeX distributions have somewhat different ways to store TDS-compliant configuration and package data. See, for example, [MikTeX](https://miktex.org/kb/texmf-roots) and the [TeX FAQ](https://www.texfaq.org/FAQ-privinst). Two approaches below conform generally to a Unix-based system:
+
+## User's Home Directory
+
+`TEXMFHOME` is a variable that points to the root of a TDS-compliant directory tree available to a user. Use `kpsewhich --var-value TEXMFHOME` to obtain its value. Quite often it is equivalent to `$HOME/texmf`. The dollar sign in front of the variable denotes the value of the variable instead of its name. So if `$HOME` is `/home/bob`, then `$TEXMFHOME` would be `/home/bob/texmf`, and we can understand the following paths to be under that directory:
+
+|Path |Description |
+|------------------------------------|--------------------------------------------|
+|`$TEXMFHOME/source/generic/schemata`|`ins` and `dtx` files, Makefile, `png` file |
+|`$TEXMFHOME/tex/generic/schemata` |`sty` file |
+|`$TEXMFHOME/doc/generic/schemata` |`pdf` file, `README.md`, `schematest.tex` |
+
+On older TeX distributions, run `mktexlsr` on $TEXMFHOME to complete the install process.
+
+## System-Wide Directory
+
+`TEXMFLOCAL` is a variable that points to the root of a TDS-compliant directory tree available to all users on a local site, system-wide installation. Use `kpsewhich --var-value TEXMFLOCAL` to obtain its value. See the [TeX FAQ](https://www.texfaq.org/FAQ-what-TDS). We can understand the following paths to be under that directory:
+
+|Path |Description |
+|-------------------------------------|--------------------------------------------|
+|`$TEXMFLOCAL/source/generic/schemata`|`ins` and `dtx` files, Makefile, `png` file |
+|`$TEXMFLOCAL/tex/generic/schemata` |`sty` file |
+|`$TEXMFLOCAL/doc/generic/schemata` |`pdf` file, `README.md`, `schematest.tex` |
+
+Run `mktexlsr` with the appropriate permissions on `$TEXMFLOCAL` to complete the install process.
+
+# Testing
+
+## Compiling `schematest.tex`
+
+1. Either go to the directory used when unpacking the `zip` file or copy the file `schematest.tex` from the `doc/generic/schemata` branch of whatever TDS-compliant tree to a directory of your choice.
+
+2. If one has access to GNU `make`, use either `Makefile` in the directory where one unpacked the `zip` file or copy `Makefile` from either `src/generic/schemata` or `doc/generic/schemata` in whatever TDS-compliant tree it exists.
+
+When using `make`, any `dvi` files that are created will also be converted to `pdf` format.
+
+3. To compile the test file using `make` and `pdftex`, simply type `make testing`.
+
+4. For multi-format testing using `make` in addition to that above, one can do the following:
+
+ make testing TESTENGINE=tex
+ make testing TESTENGINE=eplain
+ make testing TESTENGINE=lollipop
+ make testing TESTENGINE=luatex
+ make testing TESTENGINE=dviluatex
+ make testing TESTENGINE=xetex
+ make testing TESTENGINE=pdflatex
+ make testing TESTENGINE=latex
+ make testing TESTENGINE=lualatex
+ make testing TESTENGINE=dvilualatex
+ make testing TESTENGINE=xelatex
+
+5. If one does not have `make`, one can use any one of the following commands:
+
+ pdftex --interaction=nonstopmode schematest
+ tex --interaction=nonstopmode schematest
+ eplain --interaction=nonstopmode schematest
+ lollipop --interaction=nonstopmode schematest
+ luatex --interaction=nonstopmode schematest
+ dviluatex --interaction=nonstopmode schematest
+ xetex --interaction=nonstopmode schematest
+ pdflatex --interaction=nonstopmode schematest
+ lualatex --interaction=nonstopmode schematest
+ dvilualatex --interaction=nonstopmode schematest
+ xelatex --interaction=nonstopmode schematest
+
+The manual is also a test suite.
+
+# Copyright
+
+Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net>
+-------------------------------------------------------
+
+This file may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in:
+
+ [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt)
+
+and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
diff --git a/Master/texmf-dist/doc/generic/schemata/README.txt b/Master/texmf-dist/doc/generic/schemata/README.txt
deleted file mode 100644
index 1a7653d9a33..00000000000
--- a/Master/texmf-dist/doc/generic/schemata/README.txt
+++ /dev/null
@@ -1,117 +0,0 @@
-
---------:| ----------------------------------------------------------------
-schemata:| Generic package to aid construction of topical categories
- Author:| Charles P. Schaum
- E-mail:| charles dot schaum@comcast.net
- License:| Released under the LaTeX Project Public License v1.3c or later
- See:| http://www.latex-project.org/lppl.txt
-
-Short description:
-The schemata package helps the creation of topical outlines that illustrate the breakdown of concepts and categories in academic texts from the late medieval to early modern periods.
-
-Files Distribution
-
-README This file
-schemata.pdf Documentation
-schematest.tex Test file for Plain TeX or Eplain
-schemata.png Image file used for the manual
-
-Makefile Automates building with GNU make 3.81
-schemata.dtx Documented LaTeX file containing both code and documentation
-
-Installation
-
-Download the package from
-
-https://www.ctan.org/tex-archive/macros/generic/schemata
-
-Unpack schemata.zip in an appropriate directory.
-
-If you have a make utility compatible with GNU make, either in
-GNU/Linux, a BSD variant, OSX, or Cygwin in Windows you can type
-
-make inst
-
-to install the package into your $TEXMFHOME tree or
-
-make install
-
-to install the package into your $TEXMFLOCAL tree for all users.
-The latter requires sudo privileges.
-
-Other useful targets include:
-
-(release process)
-
-make release The default target, same as just ``make''.
-
-make clean Removes all intermediate files. Left are
-the files listed above plus schemata.sty.
-
-make distclean Leave only schemata.dtx, schematest.tex,
-schemata.png, and Makefile.
-
-make zip Generate a zip file ready for distribution.
-
-(testing process)
-
-make testing Release files, plus compiles schematest.tex.
-
-It is not necessary, however, to use GNU make. One can generate
-the package files manually. Since the files schemata.ins and README.txt
-are contained in the .dtx file itself, the first step is to generate
-the installer driver schemata.ins, plus the file README.txt, which will
-also trigger the extraction of schemata.sty and produce the first pass of
-the package documentation schemata.pdf:
-
-pdflatex -shell-escape -recorder -interaction=batchmode schemata.dtx
-
-Next one adds a table of contents and all cross-references, this also
-should finalize page numbers for glossary and index input files:
-
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-
-The next commands generate the glossary/index output files:
-
-makeindex -q -s gglo.ist -o schemata.gls schemata.glo
-makeindex -q -s gind.ist -o schemata.ind schemata.idx
-
-The final two commands integrate the glossary (changes) and index:
-
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-pdflatex --recorder --interaction=nonstopmode schemata.dtx
-
-Now one can either keep README.txt or rename it to README, e.g.:
-
-mv README.txt README
-
-Normally one creates the following directories for a user:
-
-$TEXMFHOME/source/generic/schemata dtx file, schemata.png
-$TEXMFHOME/doc/generic/schemata pdf file, README, schematest.tex,
-
-and creates the following directories for the local site:
-
-$TEXMFLOCAL/source/generic/schemata dtx file, schemata.png
-$TEXMFLOCAL/doc/generic/schemata pdf file, README, schematest.tex,
-
-The above environment variables often are /usr/local/texlive/texmf-local for
-$TEXMFLOCAL and ~/texmf for $TEXMFHOME.
-
-The make process normally renames the README.txt file created from the
-dtx file to just README by using mv (move / rename utility in the *nix
-userland). Windows distributions of TeX and LaTeX often keep the txt file
-because of using file extensions instead of ``magic numbers'' to identify
-files.
-
-Run mktexlsr with the appropriate level of permissions to complete the
-install.
-
-This packages works with LaTeX and Plain TeX.
-
-License
-
-This material is subject to the LaTeX Project Public License:
-http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
-
-Happy TeXing!
diff --git a/Master/texmf-dist/doc/generic/schemata/schemata.pdf b/Master/texmf-dist/doc/generic/schemata/schemata.pdf
index 2551bc87b9c..11e531a487a 100644
--- a/Master/texmf-dist/doc/generic/schemata/schemata.pdf
+++ b/Master/texmf-dist/doc/generic/schemata/schemata.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/generic/schemata/schematest.tex b/Master/texmf-dist/doc/generic/schemata/schematest.tex
index 8a853799b21..dfe71801498 100644
--- a/Master/texmf-dist/doc/generic/schemata/schematest.tex
+++ b/Master/texmf-dist/doc/generic/schemata/schematest.tex
@@ -1,40 +1,34 @@
-%--------:| ----------------------------------------------------------------
-%schemata:| Generic package to aid construction of topical categories
-% Author:| Charles P. Schaum
-% E-mail:| charles dot schaum@comcast.net
-% License:| Released under the LaTeX Project Public License 1.3c or later
-% See:| http://www.latex-project.org/lppl.txt
-%
-% This is an example file used with the schemata package.
-% See README and schemata.pdf for copyright info.
-%---------------------------------------------------------------------------
+%%
+%% This is file `schematest.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% schemata.dtx (with options: `examples')
+%%
+%% This is a generated file.
+%%
+%% Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net>
+%%
+%% This file may be distributed and/or modified under the conditions of
+%% the LaTeX Project Public License, either version 1.3 of this license
+%% or (at your option) any later version. The latest version of this
+%% license is in:
+%%
+%% http://www.latex-project.org/lppl.txt
+%%
+%% and version 1.3 or later is part of all distributions of LaTeX version
+%% 2005/12/01 or later.
+%%
\def\nameofplain{plain}
\def\nameofeplain{eplain}
\def\nameoflatex{LaTeX2e}
\def\nameoflollipop{Lollipop}
%
-% To use Plain TeX, do something like the following, substituting
-% tex, xetex, luatex, etc.:
-%
-% pdftex schematest
-%
-% To use Eplain, do something like the following:
-%
-% touch test.tex
-% pdftex test <<< "\\input eplain \\input schematest"
-%
-% To use lollipop, do something like the following:
-%
-% lollipop schematest
-%
-% To use LaTeX, do something like the following, substituting
-% latex, xelatex, lualatex, etc.:
-%
-% pdflatex schematest
+% See README.md for compiling this document.
%
\ifx\fmtname\nameoflatex
\documentclass[10pt]{article}
- %\usepackage[utf8]{inputenc} %Not needed for newer versions
\usepackage[T1]{fontenc}
\usepackage[polutonikogreek,american]{babel}
\newcommand{\gk}[1]{\foreignlanguage{polutonikogreek}{#1}}
@@ -54,6 +48,9 @@
\def\gk#1{\bgroup\it #1\egroup}
\fi
\fi
+
+Format: \fmtname\par
+
$$
\Schema{-1ex}{8.7ex}
{
@@ -291,9 +288,9 @@ $$
\schemabox{Universalis} \smallskip \schemabox{Particularis}
}
\smallskip
- \schemabox{Politi\ae{} ut Magistratuum}
+ \schemabox{Politi\ae, ut Magistratuum}
\smallskip
- \schemabox{\OE{}conomi\ae{} ut privatorum}
+ \schemabox{\OE{}conomi\ae, ut privatorum}
}
}\vskip2ex
}
@@ -410,9 +407,9 @@ $$
\schemabox{Universalis} \smallskip \schemabox{Particularis}
}
\smallskip
- \schemabox{Politi\ae{} ut Magistratuum}
+ \schemabox{Politi\ae, ut Magistratuum}
\smallskip
- \schemabox{\OE{}conomi\ae{} ut privatorum}
+ \schemabox{\OE{}conomi\ae, ut privatorum}
}
}\vskip2ex
}