Skip to content
This repository
Browse code

remove TM bundle doc - it's on web site

  • Loading branch information...
commit 9b4c60c00302ea1b7430fe9135f3f09b23b965ea 1 parent 747c924
Fletcher T. Penney authored

Showing 1 changed file with 0 additions and 229 deletions. Show diff stats Hide diff stats

  1. +0 229 Documentation/TextMate Bundle Readme.md
229 Documentation/TextMate Bundle Readme.md
Source Rendered
... ... @@ -1,229 +0,0 @@
1   -Title: MultiMarkdown Bundle for TextMate
2   -Author: Fletcher T. Penney
3   -Web: http://fletcherpenney.net/
4   -Copyright: 2006-2009 Fletcher T. Penney.
5   - This work is licensed under a Creative Commons License.
6   - http://creativecommons.org/licenses/by-sa/2.5/
7   -Keywords: MultiMarkdown
8   - TextMate
9   - Markdown
10   - PDF
11   - XHTML
12   - Markdown
13   - LaTeX
14   -XMP: CCAttributionShareAlike
15   -Revision: $Id: TextMate Bundle Readme.md 525 2009-06-15 18:45:44Z fletcher $
16   -Version: 2.0.b6
17   -CSS: http://fletcherpenney.net/document.css
18   -
19   -# Introduction #
20   -
21   -[TextMate](http://macromates.com) is a wonderfully useful text editor for Mac
22   -OS X. Of particular interest to me is the ability to extend it with add-on
23   -Bundles for particular uses, either programming languages or document types.
24   -Allan Odgaard created a Bundle for Markdown, and included some basic support
25   -for MultiMarkdown.
26   -
27   -To me, however, the job felt halfway done. First - the support for
28   -MultiMarkdown was outdated, so at the very least it needed to be updated with
29   -newer versions of the MultiMarkdown software. More importantly, however, the
30   -Bundle didn't take advantage of all the features that TextMate offered that
31   -could be used to make document creation and publishing easier. And that was
32   -the whole reason for creating MultiMarkdown in the first place.
33   -
34   -# What's the difference between this Bundle and the Markdown Bundle? #
35   -
36   -The basic Markdown bundle that is included with TextMate is great, and I was
37   -pleased when I learned that they added MultiMarkdown support. The problem was
38   -that even I couldn't get a pdf to compile using it. The MultiMarkdown support
39   -was limited, and didn't take full advantage of the features that TextMate had
40   -to offer.
41   -
42   -So I wrote this bundle to add those features back.
43   -
44   -I attempted to simply build my bundle on top of the existing Markdown bundle,
45   -as much of the grammar is the same. Unfortunately, this doesn't work, as a few
46   -rules had to be rewritten in order to be compatible with MultiMarkdown. I am
47   -more than happy to work together with the maintainers of the other bundle to
48   -create one "super-bundle" that contains the best features of both, but so far
49   -this hasn't happened. So instead, I periodically try to update my bundle to
50   -match the language improvements made in the Markdown bundle.
51   -
52   -If you just use regular Markdown, the other bundle may be sufficient. But if
53   -you use MultiMarkdown, I believe you'll find this version to be indispensable.
54   -
55   -# Where can you get a copy #
56   -
57   -You can download a copy of the latest version from my web site:
58   -
59   -* [MultiMarkdown Bundle for TextMate](http://files.fletcherpenney.net/MultiMarkdownForTextMate.zip)
60   -
61   -
62   -# Why use this Bundle #
63   -
64   -If you are interested in using some of the more advanced features of
65   -MultiMarkdown, specifically the XSLT transforms and the MultiMarkdownMath
66   -features, it can get cumbersome typing complicated command lines to process
67   -your files. There are some predefined shell commands available for
68   -MultiMarkdownMath to do basic processing that can be customized to your needs.
69   -
70   -The TextMate Bundle makes this easier for you by having several different
71   -work-flows available with a simple keystroke. You can, of course, create your
72   -own commands or customize the default work-flows. But you are not required to
73   -mess around with shell scripts if you have no desire to.
74   -
75   -Obviously, you must have a working "common" installation of MultiMarkdown in
76   -order to use this bundle.
77   -
78   -# Getting it to work #
79   -
80   -To install this bundle:
81   -
82   -1. Install this bundle by double clicking it in the Finder.
83   -2. (optional) - I suggest installing my MultiMarkdown TextMate theme as well
84   -(included in this package).
85   -3. If your MultiMarkdown installation is not in your user's Library directory,
86   -you also need to set the Shell Variable `TM_MULTIMARKDOWN_PATH` appropriately.
87   -For example, you would set it to `/Library/Application Support/MultiMarkdown`
88   -for a system-wide installation.
89   -4. Create a MultiMarkdown document.
90   -5. Process it into the file type of your choice - XHTML, LaTeX, RTF, etc.
91   -
92   -The above should be sufficient to use the bundle to edit documents, and to
93   -convert MultiMarkdown into the above file types. But if you wish to convert
94   -LaTeX into a pdf, you will need to do a few more things (if you haven't
95   -already):
96   -
97   -1. You will need the LaTeX Bundle for TextMate (should be installed by
98   -default).
99   -2. You will need a working installation of pdflatex (beyond the scope of this
100   -document, but I suggest using [MacTeX](http://www.tug.org/mactex/).
101   -3. Set your TextMate Preferences->Advanced->Shell Variables. Specifically, set
102   -`TM_LATEX_COMPILER` to `latexmk.pl` and set `TM_LATEX_VIEWER` to `Preview` if
103   -you wish to use the Preview application to view PDF's rather than TextMate
104   -itself (I highly recommend that you set this).
105   -4. If you create a LaTeX document, you can then use the `Typeset & View (PDF)`
106   -command to create and open a pdf, assuming that you have installed the
107   -TextMate LaTeX bundle.
108   -
109   -
110   -# Features #
111   -
112   -## Metadata ##
113   -
114   -* Automatically clean up metadata section to align the data
115   -
116   -* hitting return aligns you to continue entering metadata within the same key.
117   - hit return again to enter a new key. hit return again to insert a blank line
118   - and begin the body
119   -
120   -* hitting tab after typing the colon for the key aligns you to the right tab
121   - width to start entering data
122   -
123   -* If using the *Memoir* class, you can set the `chapterstyle` and `pagestyle`
124   - in the metadata within the document, or as part of your command using
125   - `addmetadata.pl`. See the companion style example.
126   -
127   -* When creating a new document, you can pre-populate it with default metadata
128   - using the new file template, or by using the `Insert default metadata`
129   - snippet. Both of these can be customized to your fit your needs. The
130   - advantage of the snippet approach is that you can tab between all of the
131   - values to easily make changes.
132   -
133   -## Headers ##
134   -
135   -* you can use a keystroke to increase or decrease the level of the header
136   -* hitting enter automatically adds trailing #'s to the header and skips some
137   - space
138   -
139   -## Lists ##
140   -
141   -* indent and outdent with a keystroke
142   -* convert from numbered to unnumbered list with a keystroke
143   -* clean up the spacing of your list automatically with a single keystroke
144   -
145   -## Blockquotes ##
146   -
147   -* hitting return automatically starts the next line with the proper level of ">"
148   -* use a keystroke to increase or decrease quote level
149   -
150   -## Tables ##
151   -
152   -* Clean up ascii spacing of tables automatically
153   -* navigate left and right across cells with a single keystroke
154   -
155   -
156   -## Text Formatting ##
157   -
158   -Key commands to toggle italics and bold
159   -
160   -## Completions ##
161   -
162   -Automatically complete:
163   -
164   -* links by reference
165   -* citations
166   -* footnotes
167   -* automatic cross-refs
168   -* equation labels
169   -* table labels
170   -* autocomplete image filenames located in same folder as your document
171   -* autocomplete BibTeX cite keys from .bib files located in the same folder as
172   -your document
173   -
174   -## Document Conversion ##
175   -
176   -Run the following with one menu selection (or keystroke):
177   -
178   -* Preview XHTML - run MultiMarkdownMath (optionally), MultiMarkdown, SmartyPants
179   -* View XHTML source
180   -* Convert XHTML into LaTeX using article, memoir, report, science or other XSLT file of your choice
181   -* Convert to S5 for presentations
182   -* Convert to RTF or Word format
183   -
184   -**Note**: You can convert either the entire document or just a selection. If
185   -you choose to convert just a section, make sure that the section begins with a
186   -blank line in order to differentiate it from the metadata that will be added
187   -automatically. If this doesn't make sense, just stick with previewing the
188   -entire document until it does. ;)
189   -
190   -## Image Preview ##
191   -
192   -Thanks to a suggestion from Andrew Nanton, images now work properly when XHTML
193   -is previewed within TextMate.
194   -
195   -# Limitations #
196   -
197   -## Language Grammar ##
198   -
199   -There are a few situations where the language matching grammar is too limited
200   -to properly match MultiMarkdown documents:
201   -
202   -* TextMate can't tell the difference between an anchor by reference on a line
203   - by itself, and the caption and optional label at the start of a table. If
204   - you are trying to use an anchor, you may need to add some non-whitespace
205   - characters to the end of the line to force the scope to change. I am open to
206   - suggestions on how to improve this.
207   -
208   -* TextMate doesn't include the character after a scope as part of the scope.
209   - For example, Markdown anchors can consist of square brackets surrounding a
210   - label. The only way to allow customized autocompletion to work properly on
211   - the label is if you include the brackets in the scope of interest. I would
212   - like the cursor at the end of a scope to be considered part of that scope,
213   - until one types a character that is no longer part of that scope. (This idea
214   - makes sense to me as a type it, but I will be quite surprised if many people
215   - understood the gibberish I just typed :)
216   -
217   -
218   -## Completions ##
219   -
220   -Unfortunately, completions are apparently case sensitive. So if you have a
221   -header `Introduction`, it will not show up as a completion for `i`. I suppose
222   -you can make the best of this and label all references with lower case, and
223   -use upper case for headers, allowing you to restrict your completion search by
224   -using upper or lower case, but this seems like a limitation of TextMate.
225   -
226   -# More to Come ... #
227   -
228   -This document needs more work. I am welcome to contributions, suggestions,
229   -rewrites, etc.

0 comments on commit 9b4c60c

Please sign in to comment.
Something went wrong with that request. Please try again.