BYOK is in stock for the first time ever — orders ship within 1 business day

Toolbox
Runs when you askOfficial

Studio Outline

Build an outline by typing the items. The tool writes the marks Studio needs, so you never have to remember ^ or ---.

Ctrl+Ttheno

Press the letter right after Ctrl+T and it runs at once. Pause instead, and the list appears. Needs a file open.

Get it on your BYOK

Download the tool

studio-outline.lua

  1. 1Download the tool.
  2. 2Put it in the Scripts folder on the BYOK's card.
  3. 3Restart the BYOK, then press Ctrl+T.

Full steps, including how to open it on the BYOK

How to use it

Build an outline by typing the items. The tool writes the marks for you.

Starting

Press Ctrl+T, then o. Choose:

  • Outline block here: an outline that Studio adds to one of your outline files. You can give it a handle.
  • Whole file is an outline: the entire file becomes an outline in Studio. The file must be empty. You can give it a title.

Building

You get a screen with one empty item.

KeyWhat it does
TypeAdds letters to the current item
EnterNew item below, same depth
Right or TabMake this item deeper
LeftMake it shallower
Up / DownMove between items
BackspaceDelete a letter. On an empty item, delete the item
EscapeDone. The outline is written to your page
Ctrl + .Abandon without writing anything

Each item shows the mark Studio will get: ^ for a header, ^^ for a subheader, --- for a detail. There are three levels, and an item can't be more than one level deeper than the one above it.

When you press Escape, something like this lands on your page:

::outline @plot
^ Act I
^^ The village burns
--- Mara escapes through the orchard
^ Act II

Editing an outline you already have

Select an existing outline on your page (the ^ kind or the - bullet kind, header line included), then Ctrl+T o. It opens in the builder. Escape replaces the selection with the updated version.

Good to know
  • Nothing is written to your page until you press Escape.
  • A spare copy is kept until the outline has landed. If it ever does not, run the tool again and your outline comes back.
  • Empty items are left out of the result.
  • Up to 60 items in one outline.
What it can touch

A tool can only do what is listed here. Nothing else. This one can:

  • Take over the screen: Only for tools you run when you ask
  • Read the document: Read your file and what you have selected
  • Change the document: Insert or replace text in your writing
  • Read what it has saved: Read its own notes or shortcuts
  • Save for next time: Remember notes, shortcuts, or a count
  • Show a list: Ask you to pick from a list
  • Ask you to type: Ask for one short line of text
  • Show a message: Put a one-line message on screen

Need help with this tool, or with tools on the BYOK? Contact support. We do not write or create tools for you. We are always open to suggestions for official ones.