A Sublime Text 3 plugin for writing Epics and User Stories (in textile markup)
You may install the plugin as any other plugin through package control. Since this repository is not part of the official package control channel, you have to add the url manually, though (see steps 4 & 5).
If you don't know, what package control is or don't even have Sublime Text installed yet, follow these setps:
- Download and install the Sublime Text Editor
- Open Sublime Text and install package control (click tools > Install Package Control)
- Open the Sublime Text Command Palette (tools > Command Palette...)
- Type "Add Repository" and hit enter (Package Control: Add Repository)
- Copy and paste the repository url (https://github.com/RegioHelden/RehQ/) and hit enter
- Open the Sublime Text Command Palette (tools > Command Palette...)
- Type "Install Package" and hit enter (Package Control: Install Package)
- Wait for the plugins to load, search for "RehQ" and hit enter again
The plugin will now be installed.
The package provides you with some snippets to support the process of writing epics, features and user stories (in textile markup language).
Display the list of available snippets via the context menu (right click in your editor and click RehQ > Show available snippets).
To use a snippet, open a textile document, type the trigger and hit tab. With longer snippets, you may navigate through predefined cursor positions by hitting tab repeatedly. If there is no further cursor position available, hitting tab will position your cursor at the end of the snippet.
If you want your own snippets to be listed in the available snippets list, make sure to add them to the SNIPPET_DIR (as configured in the settings.py). Also, to be recognized as valid snippets, they need to have the following attributes: 'title', 'hint', 'tabTrigger', 'scope', 'description'
A check can be run from the context menu, to test if your custom snippets are well-formed (right click > RehQ > Development).
Once the well-form snippets exist in the SNIPPET_DIR, they will be listed in the Show available snippets window. The snippets are shown in alphabetical order.
For furhter info refer to the wiki page.
For easier formatting, several formatting functions can be used. Right click in your editor and open the RehQ menu to see the available format options. When you click one of the options, the highlighted text will be wrapped with the appropriate formatting characters.
Also, the commonly used shortcuts were added to quickly format text:
| Format | Keys |
|---|---|
| bold | Super + b |
| italic | Super + i |
| underline | Super + u |
Note: The quick formatting only works in .textile documents!