Add information on Sublime Text 3 integration #47

docs/index.html

@@ -32,7 +32,8 @@
   1. [Text Editor Integration](install.html)\\
     a. [Integration with Vim](install.html)\\
 	b. [Integration with Jed](install.html#jed)\\
-	c. [Integration with Emacs](install.html#emacs)
+	c. [Integration with Emacs](install.html#emacs)\\
+	d. [Integration with Sublime Text](install.html#sublime)
 
   1. Development\\
     a. [Contributing]({{ site.baseurl}}/contributing.html)\\

docs/install.html

@@ -5,30 +5,48 @@
 
 # Text Editor Integration
 
-This section assumes you already have a working binary of *boxes*. Binaries for some platforms can be obtained through the [download page]({{ site.baseurl}}/download.html). Should your platform be missing from the list, you can still download the source distribution and compile your own binary. This sounds harder than it is.
+This section assumes you already have a working binary of *boxes*. Binaries for some platforms can be obtained through
+the [download page]({{ site.baseurl}}/download.html). Should your platform be missing from the list, you can still
+download the source distribution and compile your own binary. This sounds harder than it is.
 
-Although *boxes* can be useful when used on the command line, the more frequent use case will be as a filter tied to your editor. So, how can *boxes* be tied to your editor?
+Although *boxes* can be useful when used on the command line, the more frequent use case will be as a filter tied to
+your editor. So, how can *boxes* be tied to your editor?
 
-Example config file entries are featured so far for [Vim](http://www.vim.org/), [Jed](http://www.jedsoft.org/jed/), and [Emacs](http://www.gnu.org/software/emacs/). If you know how to to this in other editors, please drop me a line!
+Example config file entries are featured so far for [Vim](https://www.vim.org/), [Jed](https://www.jedsoft.org/jed/),
+[Emacs](https://www.gnu.org/software/emacs/), and [Sublime Text](https://www.sublimetext.com/). If you know how to to
+this in other editors, please feel free to add that information to this page via GitHub or just let me know in the
+GitHub issues.
 
 ## Integration with Vim
 
-To call filters from vim, you need to press `!` in visual mode or `!!` in normal mode. So the easiest way to tie in *boxes* with vim is by adding the following four lines to your *.vimrc*:
+To call filters from vim, you need to press `!` in visual mode or `!!` in normal mode. So the easiest way to tie in
+*boxes* with vim is by adding the following four lines to your *.vimrc*:
 
     vmap ,mc !boxes -d c-cmt<CR>
     nmap ,mc !!boxes -d c-cmt<CR>
     vmap ,xc !boxes -d c-cmt -r<CR>
     nmap ,xc !!boxes -d c-cmt -r<CR>
 
-`<CR>` should be there literally; just paste the lines directly from your browser window. This would comment out the current line or the lines you have marked when you press `,mc` (for *make comment*). Comments can be removed in the same way by pressing `,xc`. Should you feel that `,mc` is too long a combination to type, feel free to choose a shorter one. The above example assumes you are using the standard boxes config file, which features the *c-cmt* design. Of course, the same technique works for any other designs.
+`<CR>` should be there literally; just paste the lines directly from your browser window. This would comment out the
+current line or the lines you have marked when you press `,mc` (for *make comment*). Comments can be removed in the
+same way by pressing `,xc`. Should you feel that `,mc` is too long a combination to type, feel free to choose a shorter
+one. The above example assumes you are using the standard boxes config file, which features the *c-cmt* design. Of
+course, the same technique works for any other designs.
 
-While the above example is nice, it does not offer much convenience when you are editing different languages a lot, because you need to remember the hotkey for each different box design. Fortunately, vim has a feature called *autocommands*. They can be used to automatically change the meaning of a key combination depending on what file you edit (any many other things too, of course). Autocommand syntax is
+While the above example is nice, it does not offer much convenience when you are editing different languages a lot,
+because you need to remember the hotkey for each different box design. Fortunately, vim has a feature called
+*autocommands*. They can be used to automatically change the meaning of a key combination depending on what file you
+edit (any many other things too, of course). Autocommand syntax is
 
     au[tocmd] [group] {event} {pat} [nested] {cmd}
 
-We can leave out the group. For `{event}`, we choose `BufEnter`, which is generated every time you enter a new buffer, e.g. when starting vim or when switching between open files. `{pat}` is a file glob, and `{cmd}` is our call to *boxes*.
+We can leave out the group. For `{event}`, we choose `BufEnter`, which is generated every time you enter a new buffer,
+e.g. when starting vim or when switching between open files. `{pat}` is a file glob, and `{cmd}` is our call to *boxes*.
 
-The lines below are from the author's *.vimrc*. They can be pasted directly from your browser window. Their effect is that `,mc` and `,xc` always generate the correct comments for many languages, including C, C++, HTML, Java, lex, yacc, shell scripts, Perl, etc. The default key binding is to generate shell comments using a pound sign (file glob of `*` at the start).
+The lines below are from the author's *.vimrc*. They can be pasted directly from your browser window. Their effect is
+that `,mc` and `,xc` always generate the correct comments for many languages, including C, C++, HTML, Java, lex, yacc,
+shell scripts, Perl, etc. The default key binding is to generate shell comments using a pound sign (file glob of `*` at
+the start).
 
     autocmd BufEnter * nmap ,mc !!boxes -d pound-cmt<CR>
     autocmd BufEnter * vmap ,mc !boxes -d pound-cmt<CR>
@@ -100,13 +118,15 @@
        setkey("do_process_region(\"tal\")",	"\et")	% tal on esc-t
     }
 
-I think it calls [tal](http://www.thomasjensen.com/software/tal/) when you press `ESC-t` (second but last line). Thus, you would have to add a similar line to call *boxes*.
+I think it calls [tal](https://thomasjensen.com/software/tal/) when you press `ESC-t` (second but last line). Thus,
+you would have to add a similar line to call *boxes*.
 <a name="emacs">&nbsp;</a>
 
 
 ## Integration with Emacs
 
-[Jason L. Shiffer](https://github.com/zerotao) kindly submitted the following information on integrating *boxes* with Emacs:
+[Jason L. Shiffer](https://github.com/zerotao) kindly submitted the following information on integrating *boxes* with
+Emacs:
 
 The simple interface (only a single box style, but easy):
 
@@ -118,4 +138,36 @@
         (interactive)
         (shell-command-on-region (region-beginning) (region-end) "boxes -r -d c-cmt2" nil 1 nil))
 
-Jason also wrote a [*boxes* mode for Emacs](boxes.el). Remember to update its design list when you add new designs to your config file.
+Jason also wrote a [*boxes* mode for Emacs](boxes.el). Remember to update its design list when you add new designs to
+your config file.
+<a name="sublime">&nbsp;</a>
+
+
+## Integration with Sublime
+
+[Marco Andreolli](https://github.com/drazde) found a way to integrate *boxes* with Sublime Text&nbsp;3
+(from [#47](https://github.com/{{ site.github }}/issues/47)):
+
+1. Open Sublime Text 3
+1. Install [Package Control](https://packagecontrol.io/installation) and restart Sublime.
+1. Choose *Tools &rarr; Command Palette...* from the main menu and select *Package Control: Install Package*, then
+   choose [FilterPipes](https://packagecontrol.io/packages/FilterPipes).
+1. Choose *Tools &rarr; Command Palette...* from the main menu and select *FilterPipes: My Custom Filters Plugin*
+1. In the following file open dialog, open
+   `%APPDATA%\Sublime Text 3\Packages\MyCustomFilterPipes\Default.sublime-commands`. This is the default on Windows,
+   but if you are on other operating systems, the dialog should already be open in the correct folder.
+1. Before the closing `]`, add the following:
+   ```
+   {   /* Boxes stone */
+       "caption": "FilterPipes: Boxes stone",
+       "command": "filter_pipes_process",
+       "args": {
+           "command": ["boxes", "-d", "stone", "-a", "c", "-s", "80"]
+       }
+   }
+   ```
+   Be sure to add a comma after the previous entry, so that the list is continued properly.
+1. Now you have a new command *Boxes stone* which will create a *stone* styled box of 80 characters in width around
+   the selected text. In may be accessed via the command palette like above, or you might want to define a hotkey or
+   a macro to do it.
+1. Add more FilterPipes commands for other designs, or for removing and repairing your ASCII art boxes.