topos-vscode-forester

VSCode support for Forester, a tool for tending forests of evergreen notes. This extension was forked from vscode-forester and developed further by the topos institute

Features

• Navigte between trees: Ctrl+click (or Cmd+click) on tree references like \transclude{tree-id} to navigate to tree

• Language highlight.

  • Use \startverb%tex to retain TeX highlighting (which agrees with whatever TeX language support you happen to have installed) in verbatim environments. Otherwise the verbatim part will not be highlighted.

• Tree ID completion: You can type in a part of the title/ID/taxon to filter for trees. Press tabs to insert the ID (which will replace the title you entered).

• Automatic title hints: will automatically show the title and taxon of a tree beside a transclusion link

• Tree creation: Quick model for adding a new tree. (Hot tip: If you have text selected when you run the command, that text will be moved to the new tree.)

• Tree rename: Easily change the title and taxon of whatever tree is active. (Hot tip: Can also rename via hovering over the link of a tree or double clicking on the tree in the experimental table of contents)

Experimental Features

• Forest status: beta status bar item showing whether or not the forest is in a valid state

• Interactive forest structure view: a new beta panel that shows the transclusion structure of a set of trees going back to the root

Commands

Requirements

You need forester installed, see here for the instructions. Configure the paths in the settings. Since this plugin is in early development, you will often need the HEAD commit of forester to be compatible.

Extension Settings

• Use forester.path to configure the path to forester. It needs to include the name of the executable too.
• Use forester.config to specify the forester config file. This should usually be edited per workspace, instead of globally.
  • In the toml file, add a line prefixes = ["prfx", ...] to specify the prefixes to pick from. This is used when creating new trees.
• Use forester.defaultPrefix to if you set this property you won't be asked for a prefix.
• Use forester.create.author to specify default author for new trees (omitted if not set).
• Use forester.create.random to control whether the tree ID is generated randomly or sequentially.
• Use forester.create.openNewTreeMode to control how newly created trees are opened in the editor:
  • "off": Do not open the new tree
  • "background": Open the new tree in the background (default)
  • "side": Open the new tree to the side in a new editor column
  • "active": Open the new tree as the active editor
• Use forester.completion.showID to toggle whether the tree ID is shown in completions. It is recommended to use smaller fonts when switching on this feature. There are also plugins to create keybindings for setting toggles, in case you need to switch it on and off quickly. VSCode also has a lot of useful settings in the editor.suggest section worth looking at in conjunction.
• Use forester.decorations.enabled to enable or disable inline title hints next to transclude/import/export commands (enabled by default).
• Use forester.taxonCustomization to customize how different taxons are abreviated and how they appear in the tree structure:

{
  "forester.taxonCustomization": {
    "theorem": {
      "emoji": "⭐",
      "abbreviation": "thm"
    },
    "definition": {
      "emoji": "🧪",
      "abbreviation": "def"
    }
  }
}