54 lines
1.5 KiB
Markdown
54 lines
1.5 KiB
Markdown
# Troff template (batteries included)
|
|
|
|
This repository is an introduction to the good old tools to produce documents:
|
|
|
|
- `roff` as the language to describe documents (`groff` is the implementation)
|
|
- `tbl` and **hdtbl** for tables
|
|
- `eqn` for math equations
|
|
- `pic` for drawing images
|
|
- `grap` for drawing graphs
|
|
- `refer` for handling references and bibliography
|
|
- etc.
|
|
|
|
It also includes a few examples of custom macros and images.
|
|
|
|
Furthermore, this repository includes:
|
|
|
|
- UTF-8 characters translation into ms macros (via a script)
|
|
- source code highlight (via the `source-highlight` software and a script)
|
|
- A makefile to automatically call every tool in right order; just type `make`!
|
|
|
|
# How to compile
|
|
|
|
You need `groff` installed on your system, and `source-highlight` (or remove the right line in the makefile).
|
|
|
|
Then:
|
|
```sh
|
|
make
|
|
```
|
|
|
|
If you have `entr` on your system, you can also recompile your file each time you modify it:
|
|
```sh
|
|
make serve
|
|
```
|
|
|
|
Read the makefile for more options.
|
|
|
|
# Preview
|
|
|
|
https://t.karchnu.fr/doc/grofftut.pdf
|
|
|
|
# Limitations
|
|
|
|
Images are poorly handled, and they aren't easily managed with `roff` by default.
|
|
Some macros exist to do it properly, but it still is to include in custom macros then to document.
|
|
|
|
# TODO
|
|
|
|
Besides fixing minor problems (image inclusion), other tools should be tested:
|
|
|
|
- [neatroff][neatroff]: roff but with a modern implementation
|
|
- [SILE][SILE]: not roff, but allows way more complex layouts while still remaining simple
|
|
|
|
[neatroff]: https://github.com/aligrudi/neatroff
|
|
[SILE]: https://sile-typesetter.org/
|