A Sublime Text 2/3 package for MathBook XML files.
- Total 49
- Win 22
- OS X 19
- Linux 8
|Oct 17||Oct 16||Oct 15||Oct 14||Oct 13||Oct 12||Oct 11||Oct 10||Oct 9||Oct 8||Oct 7||Oct 6||Oct 5||Oct 4||Oct 3||Oct 2||Oct 1||Sep 30||Sep 29||Sep 28||Sep 27||Sep 26||Sep 25||Sep 24||Sep 23||Sep 22||Sep 21||Sep 20||Sep 19||Sep 18||Sep 17||Sep 16||Sep 15||Sep 14||Sep 13||Sep 12||Sep 11||Sep 10||Sep 9||Sep 8||Sep 7||Sep 6||Sep 5||Sep 4||Sep 3|
MBXTools: a Sublime Text package for MathBook XML
MBXTools is a Sublime Text package designed to assist authors using MathBook XML. It is very experimental and may behave unexpectedly.
The package is inspired by the excellent LaTeXTools package, which I have enjoyed using for many years. I have borrowed very liberally from the LaTeXTools codebase in order to implement the features I thought would be most useful to MBX authors. Please let me know of any bugs you find or any features you would like to include.
It is recommended to install MBXTools via Package Control. If you have not installed Package Control yet, you should do that first (and restart Sublime Text afterward).
After Package Control is installed, use the
Install Package command to search
for the MBXTools package, and select it from the Quick Panel to install. This
method of installation allows Package Control to automatically update your
installation and show you appropriate release notes.
You may also install MBXTools via
git. Change directories into your
Packages folder. To find the
Packages folder, select Browse Packages from
the Preferences menu (from the Sublime Text 3 menu on OS X). Make sure you are
Packages folder and not
git clone https://github.com/daverosoff/MBXTools.git
and restart Sublime Text (probably not necessary).
MBXTools is inspired by LaTeXTools, and like that package uses a Ctrl+l prefix for many commands. The Expand Selection to Line command is bound to Ctrl+l by default. MBXTools rebinds that command to Ctrl+l, Ctrl+l. Note that this is a keyboard shortcut consisting of two separate keystroke combinations. Most MBXTools shortcuts are like this.
You can activate the package features by enabling the MathBook XML syntax. The
syntax definition looks for
.mbx file extensions, which most of us don't use
(yet?). If your MathBook XML files end with
.xml, you have several choices.
Use the Preferences menu or the Command Palette to run the command
Set MBX File Extensions, and use the input panel to add
.xmlto the comma-separated list. Sublime will look for a project settings file first, then update user preferences if it doesn't find one. If you have multiple MBX projects, or if you edit XML other than MBX, it is best to start using projects so that you can have project-specific settings.
Add a comment “ to the first line of each file (after the XML declaration).
Enable the syntax manually using the command palette. To enable it manually, open an MathBook XML file and press Ctrl+Shift+P (Cmd+Shift+P on OS X) and type
Set Syntax: MathBook XMLfrom the list of options.
You should see the text
MathBook XML in the lower right corner if you have
the status bar visible (command palette: Toggle Status Bar).
There are only a few features implemented so far.
- If you have some subdivisions (with
xml:id) in your MathBook XML file, hit Ctrl+R (Cmd+R on OS X) to run the Goto Symbol command. You should see a panel showing all your available sections. Select one to jump to it in the active view. This tool does not index subdivisions without an
Open your entire source folder as a project and use Goto Symbol in Project (Ctrl+Shift+R/Cmd+Shift+R) to see all the
xml:idfor all the MathBook XML files in the project (must use either
<!-- MBX -->comment in first line of each file for indexing to succeed).
If you have been using
xml:idto label your stuff, try typing
<xref ref="(the beginning of a cross-reference). Sublime Text should show you a panel containing all xml:id values along with the elements they go with. Choose one to insert it at the caret and close the
xreftag. Alternatively, type
refand hit Tab to activate the
xrefsnippet. Then hit Ctrl+L, X or Ctrl+L, Ctrl+Space to bring up the completions menu. There are several variants of the
If you set an MBX root file, then ref completion as described above will recursively search for
xml:idthrough all your
xi:includesstarting with the indicated root file. Run the command "Set MBX Root File” from the Preferences menu or the Command Palette. Be sure to use an absolute path name for the value of the setting.
Tabto activate the subdivision snippets. A blank
titleelement is provided and the cursor positioned within it. As you type, the
xml:idfield for the subdivision is filled with similar text mirroring the title you are entering.
refsnippet does not bring up the quick panel. Should it?
- Nothing has been tested on OS X or Linux.