summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/moodle/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/moodle/README.md')
-rw-r--r--macros/latex/contrib/moodle/README.md37
1 files changed, 25 insertions, 12 deletions
diff --git a/macros/latex/contrib/moodle/README.md b/macros/latex/contrib/moodle/README.md
index 30e1b4a976..f6d06f6f5f 100644
--- a/macros/latex/contrib/moodle/README.md
+++ b/macros/latex/contrib/moodle/README.md
@@ -10,11 +10,11 @@ part of all distributions of LaTeX version 2005/12/01 or later.
Original contents (2016): [Anders O.F. Hendrickson](/author/hendrickson) ([contact](mailto:anders.o.f.hendricksonATgmail.com))
-2019-2021: [Matthieu Guerquin-Kern](/author/guerquin-kern) ([contact](mailto:guerquin-kernATcrans.org))
+2019-2023: [Matthieu Guerquin-Kern](/author/guerquin-kern) ([contact](mailto:guerquin-kernATcrans.org))
# Contents
-This work, under version number 0.8, consists of the files
+This work, under version number 1.0, consists of the files
[`moodle.dtx`](/tex-archive/macros/latex/contrib/moodle/moodle.dtx),
[`moodle.ins`](/tex-archive/macros/latex/contrib/moodle/moodle.ins), and the derived documentation
file [`moodle.pdf`](/tex-archive/macros/latex/contrib/moodle/moodle.pdf).
@@ -24,7 +24,7 @@ Details on how to generate derived files from the sources are given in Section "
A TDS archive [moodle.tds.zip](http://mirrors.ctan.org/install/macros/latex/contrib/moodle.tds.zip) is
also available to be conveniently expanded in your local texmf directory.
-It contains the derived file `moodle.sty` and a set of test files.
+It contains the derived files `moodle.sty`, `moodle.pdf` and a set of test files.
# Requirements
@@ -38,25 +38,35 @@ This package (`moodle.sty`) requires the following packages:
- [`xpatch`](pkg/xpatch),
- [`array`](pkg/array),
- [`ifplatform`](/pkg/ifplatform),
+- [`shellesc`](pkg/shellesc),
+- [`readprov`](pkg/readprov),
- [`fancybox`](pkg/fancybox), and
- [`getitems`](pkg/getitems).
-In order to manipulate images, the package relies on the following external tools:
+The package option `handout` requires:
+- [`randomlist`](pkg/randomlist).
+
+In order to manipulate images, the package relies on the following tools:
+- [`graphics`](pkg/graphics),
- [GhostScript](www.ghostscript.com),
- [ImageMagick](www.imagemagick.org), and
- [optipng](http://optipng.sourceforge.net/).
-In addition, to compile the documentation, the following LaTeX packages are
+Instead, to compile the documentation, the following LaTeX packages are
necessary:
- [`amssymb`](pkg/amssymb),
-- [`metalogo`](pkg/metalogo),
-- [`multirow`](pkg/multirow),
-- [`threeparttable`](pkg/threeparttable),
+- [`babel`](pkg/babel),
- [`booktabs`](pkg/booktabs),
+- [`changelog`](pkg/changelog),
+- [`dtxdescribe`](pkg/dtxdescribe),
+- [`eurosym`](pkg/eurosym),
- [`hyperref`](pkg/hyperref),
+- [`longtable`](pkg/longtable),
+- [`minted`](pkg/minted),
+- [`microtype`](pkg/microtype),
- [`tikz`](pkg/tikz),
-- [`minted`](pkg/minted), and
-- [`microtype`](pkg/microtype).
+- [`threeparttable`](pkg/threeparttable), and
+- [`varioref`](pkg/varioref).
# Building
@@ -64,8 +74,11 @@ The file `moodle.sty` can be generated using the command
```bash
latex moodle.ins
````
-The documentation file `moodle.pdf` can be generated by running twice the command
+The documentation file `moodle.pdf` can be generated by running
+successively the three commands:
```bash
-lualatex -shell-escape moodle.dtx
+lualatex -halt-on-error -shell-escape moodle.dtx
+makeindex -s gglo.ist -o moodle.gls moodle.glo
+lualatex -halt-on-error -shell-escape moodle.dtx
```
(n.b. the requirements in the previous section)