Notr

Notr is a Sublime Text application plugin for managing and displaying collections of text notes. It is a plain text format with some similarity to markdown. However there is no rendering-for-publication step: the text itself is the whole point.

The markup syntax provides file and section navigation and colorizing to provide visual clues for things like sections, links, tables, lists, etc.

Built for ST4 on Windows. Linux and OSX should be ok but are minimally tested - PRs welcome.

Features

• Notr files have the extension .ntr
• Multiple notr projects.
• Sections are identified like markdown # ## ### etc.
• Sections with tags and simple (non-hierarchal) folding.
• Lists with several bullet types.
• Markdown-like quotes and raw text, toggle like comments.
• Tables with insert/delete column, fit, sort. Loosely based on https://github.com/wadetb/Sublime-Text-Advanced-CSV. Could be ported for general purpose use.
• Targets and references - targets can be section, file (image or other), uri.
• Navigation to targets via quick panel. Has MRU and sticky entries.
• Navigation to notr file errors.
• Search in all project notr files.
• Auto highlight - supplements Highlight Token (recommended).
• Render to html with Render View (recommended).

Example

The spec provides an example of the features. It will look something like this:

To run the example: - Install the plugin. - Select Preferences->Package Settings->Notr. - Add this project name to your settings:

"project_files":
[
    "$APPDATA\\Sublime Text\\Packages\\Notr\\example\\notr-demo.nproj",
]

• Implement color scheme per section Color Scheme.
• Now open example\notr-spec.ntr. Test drive the various context menu selections.

Commands and Menus

There is no default Context.sublime-menu file in this plugin. Add the commands you like to your own User\Context.sublime-menu file. Typical entries are:

{ "caption": "Notr",
    "children":
    [
        { "caption": "Open Project", "command": "notr_open_project" },
        { "caption": "Edit Project", "command": "notr_edit_project" },
        { "caption": "-" },
        { "caption": "Find in Notr Files", "command": "notr_find_in_files" },
        { "caption": "Goto Target", "command": "notr_goto_target", "args" : {"filter_by_tag" : false} },
        { "caption": "Goto Target by Tag", "command": "notr_goto_target", "args" : {"filter_by_tag" : true} },
        { "caption": "Insert Target From Clipboard", "command": "notr_insert_target_from_clip" },
        { "caption": "Insert Ref", "command": "notr_insert_ref" },
        { "caption": "Insert HRule", "command": "notr_insert_hrule", "args" : {"fill_str" : "=", "reps": 60} },
        { "caption": "-" },
        { "caption": "Fit Table", "command": "table_fit" },
        { "caption": "Insert Column", "command": "table_insert_col" },
        { "caption": "Delete Column", "command": "table_delete_col" },
        { "caption": "Sort Asc", "command": "table_sort_col", "args" : {"asc" : true} },
        { "caption": "Sort Desc", "command": "table_sort_col", "args" : {"asc" : false} },
    ]
}

Settings

Project File

A notr project file contains these elements. See demo project

Color Scheme

New scopes have been added to support this application. Adjust the values in notr scopes to taste and add them to your Packages\User\your.sublime-color-scheme file. Note that markup.fixed_hl* and markup.user_hl* are also used by other members of the sbot family.

After editing your color-scheme, you need to close and reopen affected views.

Caveats

• ST uses a custom line-oriented regex engine. Some things pertaining to normal line endings don't quite work as expected.
• Note that coloring should stop at the right edge of a table. This is also how ST renders MD tables. Something to do with meta-scope.
• Coloring for markup.user_hls and markup.fixed_hls only supports fore and back colors, not font_style.
• view.add_regions() apparently only supports colors, annotations, and icon. It does not support font style and region flags. Also they are not available via extract_scope().
• Doesn't handle targets with embedded parentheses (i.e. C:\Program Files (x86)\SomeApp). It exceeds my meager regex skills.
• If you move or rename a .ntr file you need to restart Notr.

Notes

• sbot_common.py contains miscellaneous common components primarily for internal use by the sbot family. This includes a very simple logger primarily for user-facing information, syntax errors and the like. Log file is in $APPDATA\Sublime Text\Packages\User\Notr\Notr.log.

Future

• Publish somewhere for web access. Probably rendered html.
• Fancy stuff like image thumbnail phantom/hover, annotations, hover/popups, etc.
• Unicode picker/inserter for symbols.