A row is one line of an outline. This plugin draws the page of every file of rows: the tree, each row’s title, note, mark and properties.1
It also draws the breadcrumbs and the filter box. A note is the text under a row, a mark is To do, Doing, Done or Cancelled, and a property is a key and a value. Every mark is spoken as well as drawn.2
The pages it draws
It draws every kind of file whose contents are rows.3 A single row has its own page at /zoom/#<id>, which the bullet and Zoom in open; /#<id> selects the row where it is.4 Links inside a row belong to Addresses, panes and the command palette.5
The filter bar
Every page whose address can take ?q= draws the box: outline pages, a single row’s page, a day, the Agenda and the Trash.6 It narrows the page.
On an outline the bar also carries the Finished checkbox.7
The row menu
A row’s ••• menu, which a long press opens on a phone, is grouped, with a rule between groups.8 The palette lists the same commands flat, so a mark there reads Mark: Done.9
Preferences, and a directory with no outlines
Two rows under Outlines in the preferences panel (Preferences) set Row density and Show finished.10 With no outlines at all the page says No outlines yet and offers New outline.11
What an agent can read
Two MCP tools, the calls an agent makes, read rows: outlines_read reads one row and its children, outlines_subtree everything under a row.12 Outlines also adds a paragraph to an agent’s instructions (The MCP endpoint for agents outside olai).13 Switching outlines off takes its pages with it.14
What More › holds
Copy link, Copy as text, Expand all and Collapse all, Add property…, Link to…, Wait for…, Remove from here, Clear date and Stop repeating, each where the row can take it.
What a read answers
In fields |
Carries |
|---|---|
title, parent, date, repeat, desc, see, after, custom |
the row’s own fields, exactly as the file holds them |
done, cancelled, doing, todo, created, changed, started, worked |
the times and the marks as the file holds them |
status |
the mark worked out for the row |
took |
how long the work took, in whole seconds, worked out as the answer is made, and absent where there are no times to tell it from |
custom.<key> |
one property. A property named took is custom.took, never the worked-out duration, and a row asked for both carries both |
Every row carries its id whatever you ask for, and anything you did not name is left out, including where the row sits and what its ancestors are. Leave fields out and you get the whole row with its place.
The keys the walk itself adds (children, truncated and placed) are structure rather than fields, so asking for a few fields cannot drop them. The rows inside children, and the shows inside a placed entry, follow fields all the same. A deadLinks list, where it is not empty, comes back whatever you named.
withDesc is outlines_subtree’s switch for notes, and it is on by default, because a read aimed at one row usually wants the note. withDesc: false is the lean read for a table of contents: ids, titles, marks, properties and structure only. A note comes back whole or not at all, never cut short, and depth limits levels rather than prose.
| Refused | What it says |
|---|---|
a name fields does not know |
the refusal quotes the name, lists every legal one, and adds that every row carries its id already |
fields and withDesc together |
that fields is the whole shape of a row, so name desc in it and drop withDesc |
A read never walks into a mirror, because a mirror is a second view of a row that lives elsewhere. A row with mirrors under it carries placed instead, naming the mirror’s own id, where the mirror sits, and shows, the row it stands for. Mirrors are named and never expanded.
What other plugins can add to an outline
| Location | Takes |
|---|---|
outline.row.action |
a command or a choice on a row’s menu. The plugin supplies the words, what the press does, and whether it writes; outlines decides where it goes. Entry ids are <plugin>:<id> |
outline.crumb.aside |
something drawn beside one breadcrumb, given that ancestor’s id |
outline.row.aside, outline.row.fold |
something drawn beside a row, and something drawn inside it when it is open. Chat draws a row’s conversation there, or one line reading Shown beside while a pane holds that conversation (Talking to an agent from a row or a page) |
outline.page.head, outline.page.foot |
something drawn above and below a page’s rows |
outline.row.chip, outline.row.pane, outline.row.block |
how one kind of property is drawn, keyed by kind |
outline.row.placement |
whether a kind of property is drawn among the rows |
outlines.title |
one plugin only, which draws a row’s title |
outlines.dated-row |
one plugin only, which draws a row that has a date |
outlines.page-view |
one plugin only, which wraps a page’s body |
outlines.property-route |
where a property value points, for the meanings that plugin owns |
Outlines adds things elsewhere too: its pages through navigation.content, its new-outline entry through files.types, and its preference rows through preferences.sections under the group Outlines.
outlines.references is how this plugin answers questions about a row: whether it is visible in a pane, selecting it there, and which file it lives in. Navigation uses that to turn a /#id link into a landing, so with outlines off such a link waits and resolves when outlines is back. outlines.browser-state holds the undo stack, what each page read, the two registers used while dragging, and the element the floating menus hang from.
Footnotes
-
Typing in an outline is Typing an outline; moving work about is Moving rows about, and the Trash. ↩
-
olai gives every mark words as well as a shape, so a screen reader reads them aloud. The glyph beside a row reads
Done, zoom in,Doing, zoom in,blocked by …, zoom in, or plainZoom inwhere the row has no mark.⇢before a title says the row is a mirror of a row that lives elsewhere.+N donesays how many finished rows a collapsed row hides.↻ every weekreads asRepeats every week, and a property value that points somewhere, such as a CI run, is drawn as a short label and says its whole value.olai writes these words itself, and a pointer gets the same sentence. ↩
-
Outlines claims those files by registering one bullet glyph and one page, rather than by naming a file format plugin. It also draws the pages other plugins define over a reading of rows, such as the journal’s day page and Agenda. A page a plugin draws for itself belongs to Addresses, panes and the command palette instead. ↩
-
A link written
/#<id>selects the row in the pane that is already showing it. Where no pane shows it, the row’s file opens at that row. ↩ -
A link inside a row, which means the bullet, a link in the title, or a reference written under it, is handled by Addresses, panes and the command palette. These behave the same on an outline page, on a day page and on the Agenda.
Clicking one never also starts editing the title or changes which row is selected, even with
CtrlorCmdheld. A right-click, or a held finger, on a link opens the link menu, while the rest of the row opens the row menu. ↩ -
The box is labelled Filter. Narrowing a page with it is Filtering a page, and the query language is Search.
Click into the box while it is empty and it lists the forms a filter can take. Arrow keys move through that list,
Enteror a click puts the form in the box with its example part selected, andEscapecloses the list and keeps the cursor where it was. Nothing is chosen until you press an arrow key, soEnterin an empty box does nothing. ↩ -
The checkbox is named
Show finished: ticked, the page shows finished work; clear, it hides it. It is also on a single row’s page opened from an outline.The page follows your Show finished preference until you click the box. From then on the page keeps its own answer, and a Reset link beside it, named
Use my default, hands the choice back to the preference.Cmd+Osets the same answer, and the box follows it. A day page and the Agenda have no box, because the choice is not about them. ↩ -
The groups, in order: Zoom in, Mark › and any plugin command that only reads. Then Set date… or Change date…, Set repeat… on a row with a date, and Pin to sidebar or Unpin from sidebar.
Then Move to… and Duplicate, then plugin commands that write, in the order their plugins loaded, then More ›, whose entries are in the closed block below. Move to Trash comes last and on its own, and asks before it moves anything. ↩
-
The density choices are Compact, Cozy and Open. Show finished is on or off, with the hint
Pages can override this. A computer set to reduce motion changes how the tree moves, never what it says. A triangle turns over without animating through the angle, and a row you navigate to appears in the middle of the screen at once rather than scrolling there. Colours do not change, and the row is still selected and still highlighted.What a screen forcing its own colours keeps is Theme: colours, typeface and text size. ↩
-
Pressing New outline opens the box for a new file path (The file list in the sidebar). With the files plugin off there is no box and no button. An address that names nothing says Page not found, names what was asked for, and offers Go home. ↩
-
outlines_readanswers its row in full and lists its immediate children.outlines_subtreeanswers everything under its row, or every top-level row of a file you name, nested todepthlevels;depthis 3 unless you say otherwise.fieldsnames what each row carries: inoutlines_readit shapes the list of children, and inoutlines_subtreeit shapes every row, including the one you asked for. The closed block below lists every namefieldstakes, what a read refuses, andwithDesc, the switch for notes. ↩ -
The MCP plugin puts that paragraph into the instructions an agent receives when it starts. It says that a person reads a row’s note, so an agent writes one as well-formed markdown rather than as a raw tool result or a wall of text. The paragraph is sent along with this plugin, so a serve without outlines says nothing about notes. ↩
-
Switching outlines off also removes the calls it answers on the server, closes the updates it was listening for, and withdraws the way it drew properties. Documents keep working (Markdown documents: the page and the editor), and an address you kept can draw its page again once outlines is back on. Switching it on again reads the directory and your stored preferences afresh. It does not bring back an unsaved draft from before. ↩