summaryrefslogtreecommitdiff
path: root/docs/typ/cheatsheet-a4.pdf
Commit message (Collapse)AuthorAge
* Docs for 0.24: Ctrl-i's fallbacks (SPC j i, SPC j o, the side buttons), a ↵Gabriel Schneider66 min.
| | | | | | terminal's text edited as a copy, a tag's typed path surviving Esc, Get's order of refusals, the init file's errors when saved, --wait and --detach in words; the CHANGELOG's 0.24 section, the directory window moved there from 0.23 Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Round 40's doc findings: tutor 3.1 comes back with Esc from +Help, 5.2 ↵Gabriel Schneider72 min.
| | | | | | sweeps an anchored regex to Part 7's heading, 6.1 selects a name with m i W, 1.3 says a new terminal lists its directory; the guide's search row says n walks +Search and Enter moves the pane; a pane ctl's line has no newline, as acme's; a TODO(round40) on editing a tag's path Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The reference takes rounds 38 and 39: a file read's directory, permission ↵Gabriel Schneider3 hours
| | | | | | and device refusals, an Undo back to unsaved edits being no change on disk, an Edit filter writing its own ctl without truncating, n in a command pane, a name write's one line, Putall's Zerox pair, bare Tab from the root ctl, and Get and e over a small scratch Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The reference gains Coming from acme, one table of what differs for acme ↵Gabriel Schneider10 hours
| | | | | | users and scripts; the intros say modelled on acme's; Look says it has no plumber; the guide compares Esc with acme's and answers the acme question fairly; the OTRUNC sentence reads Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The guide answers a first session: n walks a build's errors from its command ↵Gabriel Schneider11 hours
| | | | | | pane, a finished one is already normal, why make wants the project root, opening beside, a builtin's argument by mouse, 12G, and SPC ? is Help everywhere; the tutor's tagline and button names match the site, and the cheatsheet's tree gains data, look and exec Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The guide's Modes tables draw each mode's box, the unsaved pane's filled box ↵Gabriel Schneider11 hours
| | | | | | too, and Questions says what the name pardes names Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing's words jump to their recordings, the casts open on their ↵Gabriel Schneider12 hours
| | | | | | | | | | | | | | | | | | | | | | | telling frame, and #mode-box draws the box Each recording on the landing has an anchor (rec-<name>); the "What's in it" words jump to theirs (Terminals, PDFs, Images, Diff review, Scripting) and the recording's caption ends in a link to the docs; Language servers and Themes, with no recording, link to the docs. A cast's `poster_at` in casts.toml picks the frame it shows until it plays: live-text at the error, terminals at the copied line, petscii on the Mandelbrot; the casts wait for the in-view script to play them. A caption may hold markup: the 9P clip links 9ns to setup. The downloads give their size, read from project.download, and the footer links the changes (project.changes). The guide's annotated pane has alt text, pin 1 beside the workspace tag rather than on Changelog, and pin 5 on the body's text; pin positions are written with repr, since str puts a U+2212 minus CSS cannot read. #mode-box(mark, unsaved:) draws a pane's box as it looks, in print and HTML. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing shows each thing once, lists what is in pardes, and the guide ↵Gabriel Schneider13 hours
| | | | | | | | | | | | | | | | | | | | | | | | | opens on an annotated pane The window shelf drops terminals-are-panes (`landing = false` in clips.toml; the casts show it) and keeps the PDF, image, make, diff and 9P clips. Captions say what happens: the live-text cast renames a variable, runs make and lands on the error; the 9P clip is a shell under 9ns where the session is a directory. Casts stack one per row at the page's width, each showing a frame of itself until it plays. Under the lead, a row of linked chips names what is in pardes: terminals, PDFs, images, language servers, diff review, scripting, themes. Install says how long the first build takes (62 s from a clean cache on 16 cores, measured with the dependencies already fetched), and `project` in style.typ has a `download` slot (url, sha256, arch) install.typ shows once a binary exists. #annotated draws a screenshot with numbered pins and their labels as text beside it; the guide opens with one of the orchard theme's shot: the workspace tag, a column's tag, a pane's tag, the box, the body and the scrollbar, before its glossary. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Show, don't tell: the guide, the tutor, scripting, setup and the landing ↵Gabriel Schneider13 hours
| | | | | | lead show an example first and cut the prose it makes redundant; the reference's 9P tree and REPLs name Look and Exec Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The guide, the cheatsheet and the tutor point to helix's keymap for every ↵Gabriel Schneider13 hours
| | | | | | key, and say where pardes differs Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The remaining builtins in the reference, setup and the cheatsheet's 9P tree ↵Gabriel Schneider14 hours
| | | | | | are written as #word, the window-only ones included, so each links to its glossary entry Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Builtins are chips that link to a glossary generated from the registry, and ↵Gabriel Schneider14 hours
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | the virtual filesystem is drawn as a tree #word draws a builtin as a chip on the tag's ground over a rule (Look and Exec in acme's look green and exec red), a <code class="word"> in HTML, and links it to its entry in a new Builtins chapter wherever that chapter is in the same output (the book, the site). The chapter is drawn from docs/typ/builtins-tty.json and builtins-gui.json, which `zig build builtins-json -Dplatform=tty|gui` writes from the registry and the Help rows (src/builtins_json.zig, tools/gen_builtins_json.zig; summaryOf in ninep/ctl.zig is now pub); style.typ merges them, marking the window-only words. The doc steps refresh their build's file first, and each build's unit-test fails when its file is stale. Everyday words first (`everyday` in style.typ), then groups by leader prefix as Help has them, then settings, the words with no path, debugging and internals, and last an A-Z index of every word. `zig build book` joins the doc steps. #fstree draws a directory tree with its connectors, a description column and links to the sections that document each file; reference.typ draws the served tree with it, each pane, pty and column file on its own line, and a test in config.zig checks it against ninep/tree.zig's files both ways. The cheatsheet has a two-level version. On the site the tree reads as `tree` text in w3m and wraps descriptions under the names on a phone. The site's tutor draws its B1, B2, B3 and 1-2 chords as mouse glyphs; the landing credits Plan 9 and acme, as does the book's title page; install.typ no longer lists the mirrors (the footer does). Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Builtins are written by name: each chapter and the tutor define Look and ↵Gabriel Schneider14 hours
| | | | | | Exec once and then say Look and Exec; the cheatsheet draws every mouse button as its icon; one-button clicks (Alt is B2, Super is B3) are in the guide and cheatsheet; building says how to send patches to the list Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Prose that names a mouse button in words drops the glyph beside it, so a ↵Gabriel Schneider14 hours
| | | | | | screen reader or text browser reads each click once Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs call pardes's scripting interface a virtual filesystem, served over ↵Gabriel Schneider14 hours
| | | | | | 9P, and the guide opens on look and execute as the core idea Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Scripts find the session as m=\$PARDES_MOUNT, else 9p; SPC q quits; upper ↵Gabriel Schneider14 hours
| | | | | | keeps a selection's newline and its tag words once; the reference takes line files, init errors, dumps, dials and Save on +Tutor Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs give back the day-one lines the trim cut, the tutor becomes ↵Gabriel Schneider15 hours
| | | | | | exercises on a +Tutor copy, the README builds the GUI and says what a terminal needs, and Shift-Esc says it needs the kitty keyboard protocol Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs trimmed to their path: a guide with Words you'll see and one Where ↵Gabriel Schneider15 hours
| | | | | | commands run and panes go table, scripting's first tag word Fmt and eight traps, setup as the one home of the pager and the servers, a scannable cheatsheet, an honest README, the edge cases moved to the reference, and the pager's colours Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Recipes work through a pane of their own, its look and exec, and keep a ↵Gabriel Schneider21 hours
| | | | | | command pane while their open lasts; the docs give cmd panes, the err grep, alt-screen prompts, /pager's refusals, Tty+ on a ctl, --, and theme failures in words Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs say Grep is a literal search, that a write's own status comes ↵Gabriel Schneider23 hours
| | | | | | before the log's last err, and that Delcol opens no +Unsaved Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs take round 31: one +Pager per directory and how pardes - cleans its ↵Gabriel Schneider25 hours
| | | | | | text, SYSTEMD_PAGER, a paged diff drawn as one, event reads in pieces, sel, write-back origins, +PdfSections rows, a PDF body by lines, bare :N looks and quoted bad values Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The book and the HTML gain "Setting up your environment" after the guideGabriel Schneider27 hours
| | | | | | | | | chapters lists setup.typ second and #doc takes a setup id. Shell lines (#cmd) follow the density too: roomy in the book and the HTML, with a tint and space around them, tight on the A4 sheet; the book sets code blocks on the same tint. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs take the 9P agent's round 30: log stats 0, names escape every ↵Gabriel Schneider27 hours
| | | | | | control byte, $winid and the pager defaults, the one client rule, and Shift-Esc said one way in the guide and the cheatsheet Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The book and the HTML set #pairs tables roomy, the A4 sheet tightGabriel Schneider27 hours
| | | | | | | | | A pairs-density state, set to tight by cheatsheet-a4.typ and roomy otherwise, gives book and HTML tables more row padding and room between the key and the meaning. The book sets its body at 10pt with more space around sections and between paragraphs and list items. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The book and the HTML hold every topic, and #doc links to its chapter or sectionGabriel Schneider27 hours
| | | | | | | | | | | | | chapters now names guide, cheatsheet, scripting, reference, themes and building. #doc takes the chapter ids, keeps the old ones mapped onto them (tags and fs to the guide and the reference, config, keys and detached to their guide sections), and links in the book and the HTML, where a doc-links state says every chapter is there; on the A4 sheet it names the chapter and section. The reference points at the scripting and building chapters by #doc instead of in words, and the guide heading for pardes FILE and --wait keeps its two dashes. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The cheatsheet draws mouse buttons as a mouse, keys as chips, and pairs as ↵Gabriel Schneider27 hours
| | | | | | | | | | | | | | | | | | | | | | | | tables #btn and #chord draw a mouse (left button, wheel, right button) with the pressed part filled; the wheel is a narrow slot on a paper halo, hollow or filled, so it never reads as a button. A chord is the held button, then for each click the held one and that one down, with arrows between; #btn(.., shift: true) adds a ⇧. HTML gets a span with an aria-label. A key is one soft pill with no border: a combination (Ctrl-w) reads Ctrl + w and a sequence (g g, SPC f c) g › g, separators muted inside it; #keys("h", "j", ...) sets alternatives as separate pills. The drift test reads every key a #keys call names. #pairs sets key | meaning content as a two-column table on alternating tints; split: 2 sets the leader map as two such tables side by side. The mouse chords get their own table: cut, paste, copy (B1-B2 then B1-B3, one B1 hold, as mouse.zig says), 2-1 with an argument, 2-3 cancelling. The A4 page draws its own title and drops the content's level-1 heading. docs/typ/README is the function contract for content files. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* A one-page A4 cheatsheet, the first file of a Typst docs corpus in docs/typGabriel Schneider27 hours
docs/typ/cheatsheet.typ holds the facts as semantic calls (#key, #btn, #chord, #word, #tag, #addr, #file, #cmd, #doc); docs/typ/style.typ defines those once, drawing them for paged output and emitting HTML elements under --features html; docs/typ/cheatsheet-a4.typ is the page. `zig build cheatsheet` renders it when typst is on PATH. A config.zig test reads every .typ in docs/typ and fails when one names a builtin, key binding or default tag pardes no longer has. Co-Authored-By: Claude Opus 5.5 <[email protected]>
generated by cgit v1.3 (git 2.53.0) at 2026-10-02 05:55:04 +0000