justaddwater.dk

Happy New Year everybody. Here is a tiny Textmate or E-Texteditor Snippet: Convert HTML entities for viewing code. I created this recently for a HTML cookbook on a project, where we made HTML pages showing HTML example code. It converts

• & to &
• < to &lt;
• > to &gt;

That’s it. Basically, I made a copy of one of the more complex snippets and simplified it. Recently, it has been a real time-saver for me despite it’s simplicity.

In text here is the snippet:

Save:

Nothing

Environment:

Cygwin (generic)

Input:

[Selected Text] or [Document]

Output:

Replace Selected Text

Activation:

[Key Equivalent] Ctrl-Shift-6

Scope Selector:

text.html

Code:

[code]#!/usr/bin/env ruby
# By Jesper Rønn-Jensen, 2007-12-19 (Last update: 2007-12-19)
# escape &,<,> to show in HTML pages
$KCODE = 'U'

$char_to_entity = { }
File.open("#{ENV['TM_BUNDLE_SUPPORT']}/entities.txt").read.scan(/^(\d+)\t(.+)$/) do |key, value|
  $char_to_entity[[key.to_i].pack('U')] = value
end

def encode (text)
  text.gsub(/[<>&]/) do |ch|
    ent = $char_to_entity[ch]
    ent ? "&#{ent};" : sprintf("%02X;", ch.unpack("U")[0])
  end
end

print encode(STDIN.read)[/code]

The blog software messes up single/double quotes, so here is a link to the raw snippet file which I put in /Bundles/HTML.tmbundle/Commands. On my E-texteditor/Windows install that is C:\Documents and Settings\[username]\Application Data\e
\Bundles\HTML.tmbundle\Commands .

Here it is for you to download:
entities-convert-html-for-html-output.tmCommand
(last update: 2007-01-01)

I was very close to modify it further to wrap selection in <pre></pre> element, (because I always use the code that way). But decided not to: It’s only a keyboard shortcut more to wrap the selection:

Alt-Shift-W: Wrap selection in Open/Close Tag

PS. The editor usually messes up on some of the escaped HTML characters. Please refer to the attached file for the correct version. And please let me know if you find errors in the markup.

Technorati Tags: e-texteditor, textmate, , bundle, snippet, command, convert, html, entities

This entry was posted by Jesper Rønn-Jensen on Tuesday, January 1st, 2008 at 12:44 (GMT-1) and is filed under Software, Web Development. You can follow any responses to this entry through the RSS 2.0 feed. Both comments and pings are currently closed.