1 Preface

1.1 About the Documentation

1.2 Philosophy of TextMate

1.3 Terminology

1.4 Limitations

2 Working With Multiple Files

2.1 Creating Projects (With Tabs)

2.1.1 Auto-Updating Projects

2.1.2 Filtering Unwanted Files

2.1.3 Text and Binary Files

2.1.4 Positioning the Project Drawer

2.2 Find and Replace in Projects

2.3 Moving Between Files (With Grace)

3 Navigation / Overview

3.1 Bookmarks

3.2 Collapsing Text Blocks (Foldings)

3.2.1 Customizing Foldings

<?php if(something) { // user is authenticated ?>

   ...

<?php } // user is authenticated ?>

foldingStartMarker = '\{\s*$';
foldingStopMarker = '^\s*\}';

3.3 Function Pop-up

3.3.1 Customizing the List

1. Make sure the language grammar assigns a name to what we want to show.
2. Create a bundle preferences item that sets showInSymbolList to 1 and uses a scope selector that matches the symbols we want to have in the symbol list.

{  name = 'markup.heading.markdown';
   match = '^#{1,9}\s*(.*)$';
},

{  showInSymbolList = 1;   }

{  showInSymbolList = 1;
   symbolTransformation = '
      s/(?<=#)#/ /g;          # change all but first # to m-space
      s/^#( *)\s+(.*)/$1$2/;  # strip first # and space before title
   ';
}

4 Working With Text

4.1 Auto-Paired Characters (Quotes etc.)

1. ⌘↩
   Move to the end of the line and insert a newline.
   For example if you write:

   print("foo
   

   Then you will have ") to the right of the caret and can now use ⌘↩ to skip these two characters and insert a new line.
2. ⇧⌘↩
   Move to the end of the line, insert a ; and then insert a newline.

4.2 Completion

completions = ( 'retain', 'release', 'autorelease', 'description' );

completionCommand = 'find "$TM_DIRECTORY" \
    -name "$TM_CURRENT_WORD*.h" -maxdepth 2 \
    -exec basename "{}" \;|sort';

4.3 Copy and Paste

4.3.1 Clipboard History

4.3.2 Re-indented Paste

4.4 Editing Modes

4.4.1 Freehanded Editing

4.4.2 Overwrite Mode

foo     jaz
bar     sub
fud     dub

printf("Value is         %3d", 37).

4.5 Find and Replace

4.5.1 Inserting Newlines and Tabs in the Find Dialog

4.5.2 Find Clipboard

4.6 Moving Text

4.6.1 Increase/Decrease Indent Level

4.6.2 Move Text Up/Down/Left/Right

4.6.3 Re-indent Text

4.7 Selecting Text

4.7.1 Editing Multiple Lines

4.7.2 Column Selections

4.8 Column Movement / Typing

4.9 Smart Tab Behavior

4.10 Spell Checking

4.11 Using Spaces Instead of Tabs

5 Bundles

5.1 Activation of Bundle Items

5.1.1 Key Equivalents

5.1.2 Tab Triggers

5.2 Editing Default Bundles / Items

5.3 Deleting Default Bundles / Items

defaults read com.macromates.textmate OakBundleManagerDeletedBundles

defaults delete com.macromates.textmate OakBundleManagerDeletedBundles

5.4 Hiding Bundles

5.5 Sharing Bundles and Bundle Items

5.6 Assorted Bundles

• Build (⌘B) — build the current source/project. Normally that means compile it.
• Run (⌘R) — run the current source (script) or product from building a project.
• Documentation for Word (⌃H) — lookup the current word (or “unit”) in the documentation (often online).
• Validate Syntax (⌃⇧V) — run the syntax through whatever form of syntax checker exist for the current document type. Generally show errors as a tool tip, but for more complex validation, HTML output is sometimes used.
• Wrap in «Something» (⌃⇧W) — wrap the selection in what makes sense for the current document type, e.g. open/close tags in HTML, begin/end environment in LaTeX.
• Convert to «Something» (⌃⇧H) — convert the document into something which makes sense, e.g. for HTML run it through tidy, for Markdown convert it to HTML, for an XML property list convert it to the more readable ASCII version, etc. Generally this is done in-place, overwriting the current document.
• Continue «Something» (⌅) — continue the current construct on the next line e.g. a line comment, list item or similar.
• Preview Document (⌃⌥⌘P) — by default this opens the Web Preview, but it has been overloaded for some markup languages for a preview more suited for that language (i.e. doing the HTML conversion and setting up a basic style sheet before showing it).
• Insert Close Element (⌥⌘.) — by default this inserts the appropriate closing tag (HTML) but is overloaded in some contexts to insert whatever constitutes a close element (e.g. \end{environment} in LaTeX).
• Comment Toggle (⌘/) — toggle comment characters around the current line or selection.

5.6.1 Diff

diff -u old_file new_file|mate

5.6.2 HTML

• Insert Open/Close Tag (⌃<) — this command will take the word just typed and change it into <word></word> placing the caret in the middle. It will recognize those tags where a close tag is not allowed (like hr) and instead insert <word> placing the caret after the tag.
• Wrap Selection in Open/Close Tag (⌃⇧W) — this will put <p>…</p> around the selection but allows you to overtype the p (and add arguments). After you are done, press tab to move the caret past the </p> tag.
• Wrap Selection as Link (⌃⇧L) — this turns the selection into link text for an anchor where you can then fill in the URL.

5.6.3 LaTeX

• Typeset & View (PDF) (⌘B) — this will run pdflatex on your current file, or TM_LATEX_MASTER (if that variable is set). If there were errors, these are shown as clickable links, otherwise the resulting PDF will be shown in the HTML output (requires Tiger or Schubert’s PDF Browser PlugIn).
• Insert Environment Based on Current Word (⌘{) — this mimics the HTML bundles ⌃< in that it makes the current word into \begin{word} … \end{word} and places the caret in between. There are various configuration options for this command, for details see the Help command in the LaTeX bundle or the source for the command itself (via the Bundle Editor).
• Insert Command Based on Current Word (⌘}) — like the previous command, but makes word into \word{} with the caret inside the braces.

sudo port install teTeX

5.6.4 Source

5.6.5 SQL

5.6.6 Subversion

5.6.7 Text

• Delete Line (⌃⇧K) — delete the current line.
• Document Statistics (⌃⇧N) — this provides a tool tip which show how many lines, words and characters the current document contains.
• Duplicate Line / Selection (⌃⇧D) — this will duplicate the current line, leaving the caret in the same column on the new line, or if there is a selection, duplicate that.
• Sort Lines in Document / Selection (F5) — this will sort the lines or selection alphabetically.

5.6.8 TextMate

5.6.9 Xcode

5.7 Getting More Bundles

5.7.1 Installing Subversion

• If you have MacPorts then open your terminal and run:

  sudo port install subversion
  

• If you use Fink then install the svn-client package.
• If you have neither Fink or MacPorts you can grab subversion from Martin Ott's homepage or any of the pre-build binaries from here.

5.7.2 Setting LC_CTYPE

export LC_CTYPE=en_US.UTF-8

setenv LC_CTYPE en_US.UTF-8

5.7.3 Installing a Bundle

mkdir -p /Library/Application\ Support/TextMate/Bundles
cd /Library/Application\ Support/TextMate/Bundles
svn co http://macromates.com/svn/Bundles/trunk/Bundles/Haskell.tmbundle

cd /Library/Application\ Support/TextMate/Bundles
svn up *.tmbundle

osascript -e 'tell app "TextMate" to reload bundles'

5.7.4 Support Folder

cd /Library/Application\ Support/TextMate
svn co http://macromates.com/svn/Bundles/trunk/Support

echo "$TM_SUPPORT_PATH"

/Library/Application Support/TextMate/Support

5.7.5 RSS Feed With Bundle Change Log

6 Macros

7 Snippets

7.1 Plain Text

7.2 Variables

\textbf{$TM_SELECTED_TEXT}

\textbf{${TM_SELECTED_TEXT:no text was selected}}

${TM_SELECTED_TEXT/^.+$/• $0/g}

7.3 Interpolated Shell Code

<a href="`pbpaste`">$TM_SELECTED_TEXT</a>

<a href="`
    if [[ $(pbpaste|wc -l) -eq 0 ]]
        then pbpaste
        else echo http://example.com/
    fi
`">$TM_SELECTED_TEXT</a>

7.4 Tab Stops

<div>
    $0
</div>

<div$1>
    $0
</div>

7.5 Placeholders

<div${1: id="${2:some_id}"}>
    $0
</div>

7.6 Mirrors

\begin{${1:enumerate}}
    $0
\end{$1}

7.7 Transformations

- (id)foo
{
    return foo;
}

- (void)setFoo:(id)aValue
{
    [foo autorelease];
    foo = [aValue retain];
}

- (${1:id})${2:foo}
{
    return $2;
}

- (void)set${2/./\u$0/}:($1)aValue
{
    [$2 autorelease];
    $2 = [aValue retain];
}

- (${1:void})${2:methodName}
{${1/void$|(.+)/(?1:\n\treturn nil;)/}
}

8 Shell Commands

8.1 Executing Commands / Filtering Text

1. In the current document, either press ⌃R with no selection to run the current line as a shell command, or select one or more lines and use ⌃R to run the selection as a shell script (it supports shebang as well).
   
2. From the Text menu you can select Filter Through Command… (⌥⌘R) which opens a panel where you can enter a shell command to run and set what should be given as input (stdin) plus what to do with the output of the command (often you want to set input to the selected text and let the output replace the selection).
   
3. Commands via the Bundle Editor. The first two options are mostly for one-shot commands, whereas commands created in the Bundle Editor are for stuff you want to run again later. The options here are the same as those of option 2, i.e. you can set what to do with input/output, even have the output shown as a tool tip (e.g. for commands which lookup help for the current word) or HTML (e.g. for commands which build the project and show results, incrementally). You can also set that documents should be saved before executing the command and give the command a key equivalent or tab trigger.
   

8.2 Search Path

if [ ! -f "$TM_BASH_INIT" ]; then

   # First read system-wide profile
   [ -f /etc/profile ] && . /etc/profile

   # Then find the first local profile
   if   [ -f ~/.bash_profile ]; then . ~/.bash_profile
   elif [ -f ~/.bash_login   ]; then . ~/.bash_login
   elif [ -f ~/.profile      ]; then . ~/.profile
   fi

fi

[ -f /etc/profile ] && . /etc/profile
[ -f ~/.bashrc ]    && . ~/.bashrc

export PATH="$HOME/bin:/opt/local/bin:$PATH"

{ PATH = "/opt/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"; }

9 Environment Variables

• Bash — "$VAR"
• Perl — $ENV{'VAR'}
• PHP — $_ENV['VAR']
• Python — os.environ['VAR'] (remember to import os first)
• Ruby — ENV['VAR']

9.1 Dynamic Variables

• TM_BUNDLE_SUPPORT — shell commands which are (indirectly) triggered from a bundle item (which could be a Command, Drag Command, Macro, or Snippet) will have this variable pointing to the Support folder of the bundle that ran the item, if such a folder exists. In addition, $TM_BUNDLE_SUPPORT/bin will be added to the path.
• TM_CURRENT_LINE — textual content of the current line.
• TM_CURRENT_WORD — the word in which the caret is located.
• TM_DIRECTORY — the folder of the current document (may not be set).
• TM_FILEPATH — path (including file name) for the current document (may not be set).
• TM_LINE_INDEX — the index in the current line which marks the caret’s location. This index is zero-based and takes the utf-8 encoding of the line (e.g. read as TM_CURRENT_LINE) into account. So to split a line into what is to the left and right of the caret you could do:

  echo "Left:  »${TM_CURRENT_LINE:0:TM_LINE_INDEX}«"
  echo "Right: »${TM_CURRENT_LINE:TM_LINE_INDEX}«"
  

• TM_LINE_NUMBER — the carets line position (counting from 1). For example if you need to work with the part of the document above the caret you can set the commands input to “Entire Document” and use the following to cut off the part below and including the current line:

  head -n$((TM_LINE_NUMBER-1))
  

• TM_PROJECT_DIRECTORY — the top-level folder in the project drawer