-
You need to compile the manual files with LuaLaTeX, because it is rather slow to compile them with XeLaTeX or PDFLaTeX.
-
The manual
tabularray.tex
is split into subfiles and put in manual folder. You can compile each subfile and see the output. -
Now you can create a pull request for your contribution.
-
Preparation
- Install
l3build
LaTeX package. - Install
pdftoppm
program.- Windows:
tlmgr install wintools.windows
- Ubuntu:
apt-get install poppler-utils
- macOS:
brew install poppler
- Windows:
- (optional) Install ImageMagick.
- Windows: see https://imagemagick.org/script/download.php#windows
- Ubuntu:
apt-get install imagemagick
- macOS:
brew install imagemagick
- Install
-
Run tests
- In the root dir, run
l3build check
to check all tests. - Then in
./tabularray
, runtexlua buildend.lua
to PDF output oftestfiles-old
tests, by comparing md5 of images converted from PDF page by page.- This uses a local
./support/ppmcheckpdf.lua
, instead of the one provided byppmchecmpdf
CTAN package. - On non-Windows systems, when ImageMagick is installed (by checking existence of
magick
orcompare
),.diff.png
diff images are created (under./build/test/config-old
) for failed tests.
- This uses a local
- See also steps in
./.github/workflows/check.yml
.
- In the root dir, run
-
Update test results
- In
./tabularray
or./zutil
, runl3build save [-c<config>] [-e<engine>] <name>...
to update correspondingtestfiles/<name>.[<engine>.]tlg
file(s). Then check if the updates are expected.- Consult the
l3build
doc for more info.
- Consult the
- In
./tabularray
, afterl3build check -cconfig-old
passes, runtexlua buildend.lua save
to update alltestfiles/*.{png,md5}
files which failed the ppm check. Then check if the updated.png
are expected.
- In