2022-01-07 09:40:44 +01:00
|
|
|
# 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
|
2022-01-07 10:36:37 +01:00
|
|
|
- `eqn` for math equations
|
2022-01-07 09:40:44 +01:00
|
|
|
- `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`!
|
|
|
|
|
|
|
|
|
|
# Preview
|
|
|
|
|
|
|
|
|
|
https://t.karchnu.fr/doc/grofftut.pdf
|
|
|
|
|
|
2022-01-07 10:36:37 +01:00
|
|
|
(Read this document on a PDF viewer, not directly in your browser!)
|
|
|
|
|
|
2022-01-07 09:40:44 +01:00
|
|
|
# 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.
|
2022-01-07 10:36:37 +01:00
|
|
|
|
|
|
|
|
Browser preview is ugly as fuck.
|
|
|
|
|
It may have something to do with font embedding, I have to investigate, but right now you just can't have a nice preview on a browser.
|
