practice/README.md

# PRACTICE GUIDE

A generic version of the Practice Guide for Computer 
without the dependency on LaTeX.

View original here:
https://codeberg.org/oneirophage/practice-guide-for-computer

## YOU WILL NEED

- m4: change MUSIC to COMPUTER. (Note to self: Why not just use sed?) https://www.gnu.org/software/m4/manual/m4.html
- groff: pdf output. https://www.gnu.org/software/groff/manual/groff.html
- mustache: for templating. https://mustache.github.io/
- xq: a wrapper for jq that adds support for xml. https://kislyuk.github.io/yq/#xml-support

## YOU WILL FIND HERE

```
.
├── README.md
├── guide.pdf
├── justfile
└── src
    ├── guide.tmac
    ├── guide.tmpl
    └── guide.xml

2 directories, 6 files
```

1. README.md: you're reading it!
2. guide.pdf: the output
3. justfile: build command
4. guide.tmac: some groff helper macros
5. guide.tmpl: the mustache template that creates the groff
6. guide.xml: the actual document source
lots of changes ended up making this a lot more complex: - moved the document itself to `src/guide.xml` - added dependency: `xq` converts xml to json - added dependency: mustache converts json to groff - moved helper groff macros to `src/guide.tmac` learned some groff after reading Unix Text Processing https://www.oreilly.com/openbook/utp/ - made the `ul` macro a conditional toggle - fixed the formatting issues i had with the section headers and also moved the section numbering to a global number register, and just formatted it as an Alpha character - the numbering issue with the item list was simply that i wasn't escaping the register name enough times 2024-01-22 17:28:25 +00:00			`# PRACTICE GUIDE`
COMPUTER 2023-11-29 00:39:29 +00:00
			`A generic version of the Practice Guide for Computer`
			`without the dependency on LaTeX.`

lots of changes ended up making this a lot more complex: - moved the document itself to `src/guide.xml` - added dependency: `xq` converts xml to json - added dependency: mustache converts json to groff - moved helper groff macros to `src/guide.tmac` learned some groff after reading Unix Text Processing https://www.oreilly.com/openbook/utp/ - made the `ul` macro a conditional toggle - fixed the formatting issues i had with the section headers and also moved the section numbering to a global number register, and just formatted it as an Alpha character - the numbering issue with the item list was simply that i wasn't escaping the register name enough times 2024-01-22 17:28:25 +00:00			`View original here:`
			`https://codeberg.org/oneirophage/practice-guide-for-computer`
COMPUTER 2023-11-29 00:39:29 +00:00
lots of changes ended up making this a lot more complex: - moved the document itself to `src/guide.xml` - added dependency: `xq` converts xml to json - added dependency: mustache converts json to groff - moved helper groff macros to `src/guide.tmac` learned some groff after reading Unix Text Processing https://www.oreilly.com/openbook/utp/ - made the `ul` macro a conditional toggle - fixed the formatting issues i had with the section headers and also moved the section numbering to a global number register, and just formatted it as an Alpha character - the numbering issue with the item list was simply that i wasn't escaping the register name enough times 2024-01-22 17:28:25 +00:00			`## YOU WILL NEED`

			`- m4: change MUSIC to COMPUTER. (Note to self: Why not just use sed?) https://www.gnu.org/software/m4/manual/m4.html`
			`- groff: pdf output. https://www.gnu.org/software/groff/manual/groff.html`
			`- mustache: for templating. https://mustache.github.io/`
			`- xq: a wrapper for jq that adds support for xml. https://kislyuk.github.io/yq/#xml-support`

			`## YOU WILL FIND HERE`

			```
			`.`
			`├── README.md`
			`├── guide.pdf`
			`├── justfile`
			`└── src`
			`├── guide.tmac`
			`├── guide.tmpl`
			`└── guide.xml`

			`2 directories, 6 files`
			```

			`1. README.md: you're reading it!`
			`2. guide.pdf: the output`
			`3. justfile: build command`
			`4. guide.tmac: some groff helper macros`
			`5. guide.tmpl: the mustache template that creates the groff`
			`6. guide.xml: the actual document source`