]> gitweb.michael.orlitzky.com - mjotex.git/commitdiff
examples: rename to examples/article, to make room for others
authorMichael Orlitzky <michael@orlitzky.com>
Fri, 27 Feb 2026 01:20:52 +0000 (20:20 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Fri, 27 Feb 2026 01:20:52 +0000 (20:20 -0500)
README.rst
examples/article/GNUmakefile [moved from examples/GNUmakefile with 85% similarity]
examples/article/article.tex [moved from examples/examples.tex with 99% similarity]
examples/article/local-references.bib [moved from examples/local-references.bib with 100% similarity]
examples/article/sage-listings/example.listing [moved from examples/sage-listings/example.listing with 100% similarity]

index 4c93247281dabcb5c319281cc5ce8e26d8a6a9d1..5341bef26acd82654a14fb9b99f8a7bd2ea49578 100644 (file)
@@ -4,9 +4,9 @@ My personal library of LaTeX macros and operators
 Usage
 =====
 
-There is an example project in the ``examples`` directory that shows
-you how to use the macros; the rest of this section is focused on
-getting them usable.
+There is an example project in the ``examples/article`` directory that
+shows you how to use the macros; the rest of this section is focused
+on getting them usable.
 
 Vanilla
 -------
@@ -42,7 +42,7 @@ from the one described in my `Makeing LaTeX
 <https://michael.orlitzky.com/articles/makeing_latex.xhtml>`_ article.
 It is not meant to be invoked directly; instead, you should create
 your own ``GNUmakefile`` (in your own project) based on the one in
-``examples/GNUmakefile``. This does several things:
+``examples/article/GNUmakefile``. This does several things:
 
 #. Adds this repository to the TeX path.
 #. Declares a few relevant variables.
similarity index 85%
rename from examples/GNUmakefile
rename to examples/article/GNUmakefile
index 06db99bf05ac2d7c20438b950a8536610ffabfc3..4dc382f07a15217535e1bf166773455acc44d5e4 100644 (file)
@@ -8,18 +8,18 @@
 #
 #  * BIBS - BibTeX bibliography
 #  * INDICES - the index, typically singular and named $(PN)
-#  * SAGE_LISTING_SRCS - testable sage code listings
+#  * SAGE_LISTINGS - testable sage code listings
 #  * MJOTEX - macro source files from mjotex
 #
 
 # The repository has to be added to the TeX path, if this is not done
 # in ~/.bashrc or some equivalent place.
-export TEXINPUTS := $(TEXINPUTS):../
-export BSTINPUTS := $(BSTINPUTS):../
+export TEXINPUTS := $(TEXINPUTS):../..
+export BSTINPUTS := $(BSTINPUTS):../..
 
 # The name of the document. Defaults to name of the parent directory
-# which in this case is also "examples", but is usually required.
-PN = examples
+# (which in this case is also "article"), but is usually required.
+PN = article
 
 # Specify the remaining variables only if you use them.
 BIBS = local-references.bib
similarity index 99%
rename from examples/examples.tex
rename to examples/article/article.tex
index 0e6191ddf0ff02764277b370d7d55da40978c091..7c444428bc4b20b0b71b68a3fb1712061ad93d04 100644 (file)
     However, the smart way to display a SageMath listing is to load it
     from an external file (under the ``listings'' subdirectory):
 
-    \sagelisting{example}
+    \sagelisting{sage-listings/example}
 
     Keeping the listings in separate files makes it easy for the build
     system to test them.