A simple todo widget to keep track of things in the editor. Saves to each project. The library allows to import and export the entries in case the cookies that are used to save the data expire or to have different branches of todos.

Installation

The library can be found in the s&box library manager! It is recommended to install the library from there!

How to Use

Tip

All of the widgets can be easily closed by pressing ESC, while they are in focus. This will not save the changes.

Tip

There's a help window located in the more menu to quickly reference!

Once opening the widget (can be found inside of View -> Todos), new entries can be added by using the Add new entry button. There, the todo message can be written and a group can be chosen. Each group is categorised alphabetically and allows to collapse all entries under them.

Once done, clicking on an entry will toggle its completion state. The group the entry is under will display the progress: (currently done/all entries).

Search bar

Flags

The search bar has flags now! All flags follow the same pattern of FLAG_NAME:ARGUMENT. Some do not require an argument but still need the ":" to be recognized as a flag. Multiple flags can be added at the same time, while they're separated by spaces. Anything else that's not a flag will be used to look directly at the message and see if it contains them.

Built-in flags

Name	Argument	For:	Description:
in	Group Name	Manual/Code	Filters entries based on if they're in a group
not	Group Name	Manual/Code	Filters entries based on if they're not in that group
done	None	Manual	Is the entry marked as done
pending	None	Manual	Is the entry marked as not done

Code entries

To look for entries that have a specific code word, all that needs to be done is write down the name of the code word that was defined in the settings and follow it with a ":" if not there already.

For example: todo:

Editing

Entry

To edit an entry Shift + Click on it. A similar window will pop-up where the message can be rewritten and a new group can be picked. The window also allows deleting the same entry if necessary.

Group

To edit a group of entries Shift + Click on the group name itself. This window only allows changing all the entries' group to something else or to delete all of them.

Code

The library now imports code markups ( here, referred to as _code word_s )! By default, they are hidden but can be toggled either with the eye icon, next to the Add new entry button.

Here are a list of default code words:

• todo
• bug
• fixme
• xxx
• note
• optimize
• hack

Can be changed in the Settings.

Example:

// note: this is a class
public sealed class MyClass
{
  public float MyValue { get; set; } = 1f; // todo: change default value

  // fIxMe: fix this really
  // incosistent naming, also this is
  // mutliline!
  public void My_Method_1()
  {
    var myValue; // works even in here
  }

  // TODO: this is a todo
  // that spans mutliple lines
  //
  // I'm just a simple comment
  //
  // TODO: this a different todo
  public void MyMethod1()
  {

  }
}

Settings

There are a couple of settings that can be changed. Most notably, adding or removing code words. Can be found in the more menu, next to the eye icon.

Refresh on Hotload

Redraws everything in the list if Show Code Entries are toggled on hotload.

Widgets Stay on Top

Warning

This setting has been removed since v131258 in favour of the widgets always staying on top of the editor instead!

Makes all widgets to have the stay on top flag. Makes widgets behave more nicely if something needs to be copied to them from a different part of the editor, as they won't go behind the editor.

In return, dialogs will appear behind them!

Uncollapse on Search

Makes all the groups uncollapse when searching and will block all attemps at trying to open or close them.

Default Group Name

Note

If the group is invalid ( empty ) it will still result with the "Default" group

Allows to set a default group name to be used when creating a new entry instead of "Default".

Code Words

Here can all of the code words the library will check against can be edited, removed or added. If required, pressing and confirming Reset All will set the default code words.

Important

When creating a new one, make sure it ends with a ":". They are not required, but makes it consistent with the rest and avoids false positives!

Keybinds

There are a couple of keybinds available right now:

Keybind	Description:
CTRL+W	Opens the create a new entry dialog
CTRL+E	Toggles show manual entries
CTRL+R	Toggles show code entries

Import/Export

Just in case, the library allows importing and exporting its entries in case the cookies that hold the data expire, something else happens or to switch to a different set of todos.

These options can be found in the more menu, next to the eye icon. All entries are encoded as a UTF-8 JSON.