summaryrefslogtreecommitdiff
path: root/macros/generic/schemata/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/generic/schemata/README.md')
-rw-r--r--macros/generic/schemata/README.md100
1 files changed, 63 insertions, 37 deletions
diff --git a/macros/generic/schemata/README.md b/macros/generic/schemata/README.md
index f77827815c..ecf34f9142 100644
--- a/macros/generic/schemata/README.md
+++ b/macros/generic/schemata/README.md
@@ -10,10 +10,10 @@ The schemata package helps the creation of topical outlines that illustrate the
|`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 |
+|`schemata.pdf` |Documentation (generated file) |
+|`README.md` |This file (generated file) |
+|`schematest.tex`|Test file (generated file) |
+|`schemata.eps` |Image file used for the manual |
# Obtaining the Package
@@ -31,54 +31,59 @@ The schemata package helps the creation of topical outlines that illustrate the
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:
+ * Building and testing with `xelatex` and `lualatex` requires one to have the font `GFSDidot.otf` in a system or user font path. The GFS fonts are available in most Linux distributions and may be downloaded from the [Greek Font Society](https://www.greekfontsociety-gfs.gr/).
- tex schemata.dtx
- make inst
+ * The package can be built and used with `dvilualatex` only when one can use modern testing packages (but `dvipdf` fails). The test file fails with `dvilualatex`, but it works with `dviluatex`.
-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.
+ * We now use an Encapsulated PostScript graphics file instead of a Portable Network Graphics file to permit all LaTeX variants to build the package.
-1. Type `make distclean release` to generate the release files using `pdflatex`.
+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.
-3. To use another TeX engine, type one of the following:
- make ENGINE=latex
+1. Type `make` to generate the release files using `pdflatex`.
+
+2. To use another LaTeX engine, type one of the following:
+
+ make ENGINE=xelatex
make ENGINE=lualatex
make ENGINE=dvilualatex
- make ENGINE=xelatex
+ make ENGINE=latex
-4. Type `make inst` to install the files in the user's personal TDS-compliant directory tree.
+3. 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.
+4. 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:
+2. This will generate the following files:
+
+ schemata.ins (complete)
+ schemata.pdf (incomplete; do steps 3 through 5)
+ README.md (complete)
+ schematest.tex (complete)
+
+3. Generate the TOC and cross-references for the documentation:
pdflatex --recorder --interaction=nonstopmode schemata.dtx
-3. Generate the index files using `makeindex`:
+4. 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:
+5. 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.
+One can substitute, e.g., `xelatex`, `lualatex`, `dvilualatex`, and `latex`, for `pdflatex`, but the documentation may look different in some cases.
-## File Installation
+## Manual 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:
@@ -88,7 +93,7 @@ Different TeX distributions have somewhat different ways to store TDS-compliant
|Path |Description |
|------------------------------------|--------------------------------------------|
-|`$TEXMFHOME/source/generic/schemata`|`ins` and `dtx` files, Makefile, `png` file |
+|`$TEXMFHOME/source/generic/schemata`|`ins` and `dtx` files, Makefile, `eps` file |
|`$TEXMFHOME/tex/generic/schemata` |`sty` file |
|`$TEXMFHOME/doc/generic/schemata` |`pdf` file, `README.md`, `schematest.tex` |
@@ -100,7 +105,7 @@ On older TeX distributions, run `mktexlsr` on $TEXMFHOME to complete the install
|Path |Description |
|-------------------------------------|--------------------------------------------|
-|`$TEXMFLOCAL/source/generic/schemata`|`ins` and `dtx` files, Makefile, `png` file |
+|`$TEXMFLOCAL/source/generic/schemata`|`ins` and `dtx` files, Makefile, `eps` file |
|`$TEXMFLOCAL/tex/generic/schemata` |`sty` file |
|`$TEXMFLOCAL/doc/generic/schemata` |`pdf` file, `README.md`, `schematest.tex` |
@@ -114,36 +119,57 @@ Run `mktexlsr` with the appropriate permissions on `$TEXMFLOCAL` to complete the
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.
+ 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:
-3. To compile the test file using `make` and `pdftex`, simply type `make testing`.
+ make testing
-4. For multi-format testing using `make` in addition to that above, one can do the following:
+4. For multi-format testing using `make` in addition to that above, one can do the following. The comments should not be typed; they tell one what to expect:
+ Comment: Shows transliterated Latin for Greek
+ ---------------------------------------------
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=eplain
+ ---------------------------------------------
+ make testing TESTENGINE=lollipop
+ ---------------------------------------------
+ Comment: Shows Greek text via babel
+ ---------------------------------------------
make testing TESTENGINE=latex
+ make testing TESTENGINE=pdflatex
+ ---------------------------------------------
+ Comment: Shows Greek text via polyglossia
+ ---------------------------------------------
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:
+5. If one does not have `make`, one can use any one of the following commands. The comments should not be typed; they tell one what to expect:
- pdftex --interaction=nonstopmode schematest
+ Comment: Shows transliterated Latin for Greek
+ ---------------------------------------------
tex --interaction=nonstopmode schematest
- eplain --interaction=nonstopmode schematest
- lollipop --interaction=nonstopmode schematest
+ pdftex --interaction=nonstopmode schematest
luatex --interaction=nonstopmode schematest
dviluatex --interaction=nonstopmode schematest
xetex --interaction=nonstopmode schematest
+ ---------------------------------------------
+ eplain --interaction=nonstopmode schematest
+ ---------------------------------------------
+ lollipop --interaction=nonstopmode schematest
+ ---------------------------------------------
+ Comment: Shows Greek text via babel
+ ---------------------------------------------
+ latex --interaction=nonstopmode schematest
pdflatex --interaction=nonstopmode schematest
+ ---------------------------------------------
+ Comment: Shows Greek text via polyglossia
+ ---------------------------------------------
lualatex --interaction=nonstopmode schematest
- dvilualatex --interaction=nonstopmode schematest
xelatex --interaction=nonstopmode schematest
The manual is also a test suite.