Karchnu
2eae61645c
|
||
|---|---|---|
| bin | ||
| .source-highlight_groff-output-definition | ||
| Makefile | ||
| Makefile.in | ||
| README.md | ||
| are-you.pdf | ||
| bibliography | ||
| grofftut.ms | ||
| header.ms | ||
| macros.ms | ||
README.md
Troff template (batteries included)
This repository is an introduction to the good old tools to produce documents:
roffas the language to describe documents (groffis the implementation)tbland hdtbl for tableseqnfor math equationspicfor drawing imagesgrapfor drawing graphsreferfor 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-highlightsoftware 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:
make
If you have entr on your system, you can also recompile your file each time you modify it:
make serve
Read the makefile for more options.
Preview
https://t.karchnu.fr/doc/grofftut.pdf
(Read this document on a PDF viewer, not directly in your browser!)
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.
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.
TODO
Besides fixing minor problems (image inclusion, browser view), other tools should be tested: