lukas/kata

Fork 0

Refactor the kata environment for more flexibility and better intuition #33

Merged

lukas merged 18 commits from refactor-forced-formatting into main

2026-04-13 08:02:30 +00:00

lukas commented

2026-04-10 10:29:08 +00:00

Owner

solves #32

Topics:

section
marginline
\vfil before the first step

Todos:

(re)write docs for kata and kataRaw
write docs for /kata/kata/styled
add keys for /kata/setup so /kata/kata/styled keys can be set globally too -> use \kataSetup in the examples to make \begin{kata} shorter and also demonstrate how it probably usually looks like (maybe override keys in the extended example though)
think about how to test all the new keys
should \IfBlank* be used in plain newcommand (see beltmargin)?
docs for kataSection (remove the one for section command)

solves https://git.atticus-sullivan.de/lukas/kata/issues/32 Topics: - [x] section - [x] marginline - [x] `\vfil` before the first step Todos: - [x] (re)write docs for `kata` and `kataRaw` - [x] write docs for `/kata/kata/styled` - [x] add keys for `/kata/setup` so `/kata/kata/styled` keys can be set globally too -> use `\kataSetup` in the examples to make `\begin{kata}` shorter and also demonstrate how it probably usually looks like (maybe override keys in the extended example though) - [x] think about how to test all the new keys - [x] should `\IfBlank*` be used in plain `newcommand` (see `beltmargin`)? - [x] docs for `kataSection` (remove the one for `section command`)

lukas self-assigned this

2026-04-10 10:29:08 +00:00

lukas added 3 commits

2026-04-10 10:55:51 +00:00

split kata environment in raw and styled 73bc3e52ae

introduce a counter for the katas to avoid collisions in the label 2ca4774557

update docs (only the pdf not the content) 8de4f82efa

lukas added 1 commit

2026-04-10 11:14:33 +00:00

leverage a 'hook' to inject custom code before the first step (replaces hardcoded \vfil) ddc9179ad6

also now `first` is almost neutral by default and is kinda required to get
the proper grid output.
Thus, remove the `first (step)` key and tie the respective `if` to the
value of the kata@step counter.

lukas added 1 commit

2026-04-10 11:27:20 +00:00

fixup 'before first' and show it in the example 9999b94490

lukas added 2 commits

2026-04-10 23:36:23 +00:00

adjust docs for the recent changes 1f91895f28

add note about ref of step-counter and fixup \refEnv{kata/kataRaw} f28ea62319

lukas added 8 commits

2026-04-11 15:18:22 +00:00

don't use weird suggestion from AI to guard kataSection-command it didn't work anyhow 61447ea944

adjust the testfiles for the new api 1029c4d2b3

update test outputs 74274f9445

update tests regarding the marginline dab2346dc7

don't use IfBlank* in non-NewDocumentCommand definition and avoid marginline if it would be empty 5f3fa5174e

adjust tests for new marginline logic and add part which tests the section keys 5ab4bad2bd

add tests for 'before first' (step) key 7f370e1031

update test-outputs 2dede0a149

lukas commented

2026-04-11 19:06:33 +00:00

Author

Owner

lukas commented

2026-04-11 19:11:32 +00:00

Author

Owner

Idea for later:

use sockets for the "hook" executed before the first step. With the fixed (and guarded) amount of parameters, this is quite the perfect fit for this case (avoids spilling/leaking content if the user-supplied macro takes too few arguments or eating additional tokens if the user-supplied macro takes too many arguments). The only drawback is I want users to easily customize the packet. Right now sockets are not well known which makes it less easier for the user to customize when using sockets over simple macros/pgf-keys
similar case for the \kataSection, but here templates might be a better fit (not quite sure though)

Idea for later: - use [`socket`s](https://tug.ctan.org/macros/latex-dev/base/ltsockets-code.pdf) for the "hook" executed before the first step. With the fixed (and guarded) amount of parameters, this is quite the perfect fit for this case (avoids spilling/leaking content if the user-supplied macro takes too few arguments or eating additional tokens if the user-supplied macro takes too many arguments). The only drawback is I want users to easily customize the packet. Right now `socket`s are not well known which makes it less easier for the user to customize when using sockets over simple macros/pgf-keys - similar case for the `\kataSection`, but here [`template`s](https://tug.ctan.org/macros/latex-dev/base/lttemplates-doc.pdf) might be a better fit (not quite sure though)

lukas added 3 commits

2026-04-12 12:47:14 +00:00

add presets for step helping with alignment 186978011d

no \END before \end{document} 5a376dd110

fixup issues with l3build check (moreover with the isolation) f88e6ad1b4

lukas referenced this pull request

2026-04-13 08:01:52 +00:00

guard hooks / config macros #36

lukas merged commit 8918ffc73e into main

2026-04-13 08:02:30 +00:00

lukas deleted branch refactor-forced-formatting

2026-04-13 08:02:30 +00:00