subtleGradient / tea-for-espresso forked from onecrayon/tea-for-espresso

An Espresso Sugar containing Textmate-style Text Editor Actions, written in Python

This URL has Read+Write access

commit  077c98a30d9ce82faca2330b32e4454fdc16f05b
tree    e3a797b8c13a262d3332d038d79d53d2e177add6
parent  7197e6e093a66f7cb013e530bbcd1ec391abaab4
name age message
file README.markdown Wed Apr 22 07:42:09 -0700 2009 Updated bug submission info [onecrayon]
file main.py Loading commit data...
file setup.py
directory src/
README.markdown

Text Editor Actions for Espresso

Text Editor Actions (TEA) for Espresso is an Espresso plugin that provides:

  1. Some of my favorite text actions for HTML, such as Wrap Selection In Tag (inspired mainly by Textmate's excellent HTML bundle)
  2. Generic text manipulation scripts that can be leveraged by any Sugar (or through custom user actions)

TEA has been bundled with Espresso since version 1.0, so you do not need to download it (unless you want to test bleeding edge improvements).

TEA for users

Many people will be content with the default TEA HTML actions, but if you wish you can add your own custom actions by defining them in XML (I plan to add an interface for managing custom actions; until then you'll need to use XML):

Found something about TEA that makes you unhappy? Submit a bug report or feature request (requires free GitHub account) or visit the official TEA forum post. You can, of course, also email me: ian@onecrayon.com. I typically respond within a day.

TEA for Sugar developers

There are three ways to leverage TEA within your own Sugar:

  1. Use TEA's generic internal actions simply by adding XML definitions (syntax is identical to custom user actions above; only difference is you put your actions in your Sugar's TextActions folder). For a full list of available actions, see the generic action API.

  2. Use the TEALoader class to run a custom script in any language supported by the Mac OS X command line. See Running shell scripts for more info.

  3. Code your own Python scripts for TEA, leveraging the numerous built-in helper functions. See Adding or overriding Python scripts for more info.

Errata

The TEA for Espresso wiki is currently the best place for information about extending TEA. I do not yet have any documentation about using TEA's bundled HTML actions; hopefully their names will be self-explanatory to some extent.

If you are interested in coding your own Sugar in Python, the TEA for Espresso project can also serve as an excellent starting point. The code is released under the MIT license, as described in the main bundle file.