vendor/plugins/filtered_column_code_macro/Rakefile
vendor/plugins/filtered_column_code_macro/assets/default_codemacro.css
vendor/plugins/filtered_column_code_macro/assets/default_coderay.css
@@ -26,6 +26,30 @@ environment, run:
RAILS_ENV=production rake gems:install
+= Syntax Coloring for code listings
+
+Syntax coloring can be performed on code listings that occur in your articles
+by surrounding them with <macro:code lang="ruby">...</macro:code> tags.
+However, for this to work, your theme must provide CodeRay css styles. If
+you use the <macro:code> tags and don't see syntax coloring then the CodeRay
+styles may be added to your current theme by customizing the theme as follows:
+
+1. Login to Admin (http://localhost:3000/admin)
+2. Select 'Design' tab
+3. Click 'layout.liquid' in the list of templates in the right margin
+4. In the textfield, scroll to the bottom of the {% head %}...{% endhead %}
+ section and insert the following 2 stylesheet link tags:
+
+<link rel="stylesheet" href="/plugin_assets/filtered_column_code_macro/default_codemacro.css" type="text/css" media="screen" charset="utf-8">
+<link rel="stylesheet" href="/plugin_assets/filtered_column_code_macro/default_coderay.css" type="text/css" media="screen" charset="utf-8">
+
+These stylesheets will not only add syntax coloring - but also wrap the code
+listings with a div that will automatically add a horizontal scrollbar and
+dynamically adjust the width of the code listing to fit your layout. You may
+want to update existing themes which already support syntax coloring to use
+these new default stylesheets since existing themes usually only display code
+listings using a static width.
+
= License
Mephisto is distributed under the same license as Ruby on Rails. See
README
@@ -23,18 +23,20 @@ class CodeMacro < FilteredColumn::Macros::Base
options[:line_number_start] = attributes[:line_number_start].to_i unless attributes[:line_number_start].blank?
inner_text = inner_text.gsub(/\A\r?\n/, '').chomp
-
+ html = ""
+
begin
- CodeRay.scan(inner_text, lang.to_sym).html(options)
+ html = CodeRay.scan(inner_text, lang.to_sym).html(options)
rescue ArgumentError
- CodeRay.scan(inner_text, lang.to_sym).html(DEFAULT_OPTIONS)
+ html = CodeRay.scan(inner_text, lang.to_sym).html(DEFAULT_OPTIONS)
rescue
unless lang.blank?
RAILS_DEFAULT_LOGGER.warn "CodeRay Error: #{$!.message}"
RAILS_DEFAULT_LOGGER.debug $!.backtrace.join("\n")
end
- "<pre><code>#{CGI.escapeHTML(inner_text)}</code></pre>"
+ html = "<pre><code>#{CGI.escapeHTML(inner_text)}</code></pre>"
end
+ "<div class=\"CodeMacro\">\n#{html}</div>\n"
end
end
vendor/plugins/filtered_column_code_macro/lib/code_macro.rb
@@ -8,53 +8,49 @@ class CodeMacroTest < Test::Unit::TestCase
def test_code_macro_with_language
html = process_macros '<macro:code lang="ruby">assert_equal 4, 2 + 2</macro:code>'
-
- expected = "<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></pre></td>\n</tr></table>\n"
-
+ expected = "<div class=\"CodeMacro\">\n<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></pre></td>\n</tr></table>\n</div>\n"
assert_equal expected, html
end
def test_code_macro_with_language_and_line_numbers
html = process_macros '<macro:code lang="ruby" line_numbers="list">assert_equal 4, 2 + 2</macro:code>'
-
- expected = "<ol class=\"CodeRay\">\n<li>assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></li>\n</ol>\n"
-
+ expected = "<div class=\"CodeMacro\">\n<ol class=\"CodeRay\">\n<li>assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></li>\n</ol>\n</div>\n"
assert_equal expected, html
end
def test_should_strip_initial_and_trailing_newlines
html = process_macros "<macro:code lang=\"ruby\" line_numbers=\"list\">\nassert_equal 4, 2 + 2\n</macro:code>"
- expected = "<ol class=\"CodeRay\">\n<li>assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></li>\n</ol>\n"
+ expected = "<div class=\"CodeMacro\">\n<ol class=\"CodeRay\">\n<li>assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></li>\n</ol>\n</div>\n"
assert_equal expected, html
end
def test_code_macro_with_invalid_line_numbers
html = process_macros '<macro:code line_numbers="whatever" lang="ruby">assert_equal 4, 2 + 2</macro:code>'
- expected = "<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></pre></td>\n</tr></table>\n"
+ expected = "<div class=\"CodeMacro\">\n<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">assert_equal <span class=\"i\">4</span>, <span class=\"i\">2</span> + <span class=\"i\">2</span></pre></td>\n</tr></table>\n</div>\n"
assert_equal expected, html
end
def test_code_macro_without_language
html = process_macros '<macro:code>assert_equal 4, 2 + 2</macro:code>'
- expected = '<pre><code>assert_equal 4, 2 + 2</code></pre>'
+ expected = "<div class=\"CodeMacro\">\n<pre><code>assert_equal 4, 2 + 2</code></pre></div>\n"
assert_equal expected, html
end
def test_code_macro_with_invalid_line_numbers_and_language
html = process_macros '<macro:code line_numbers="whatever">assert_equal 4, 2 + 2</macro:code>'
- expected = '<pre><code>assert_equal 4, 2 + 2</code></pre>'
+ expected = "<div class=\"CodeMacro\">\n<pre><code>assert_equal 4, 2 + 2</code></pre></div>\n"
assert_equal expected, html
end
def test_code_macro_with_embedded_html_chars
html = process_macros '<macro:code lang="ruby">x < y</macro:code>'
- expected = "<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">x < y</pre></td>\n</tr></table>\n"
+ expected = "<div class=\"CodeMacro\">\n<table class=\"CodeRay\"><tr>\n <td class=\"line_numbers\" title=\"click to toggle\" onclick=\"with (this.firstChild.style) { display = (display == '') ? 'none' : '' }\"><pre><tt>\n</tt></pre></td>\n <td class=\"code\"><pre ondblclick=\"with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }\">x < y</pre></td>\n</tr></table>\n</div>\n"
assert_equal expected, html
end
def test_code_macro_with_embedded_html_chars_and_no_lang
html = process_macros '<macro:code>x < y</macro:code>'
- expected = "<pre><code>x < y</code></pre>"
+ expected = "<div class=\"CodeMacro\">\n<pre><code>x < y</code></pre></div>\n"
assert_equal expected, html
end
vendor/plugins/filtered_column_code_macro/test/code_macro_test.rb
1473acf8307ec21d2002acab94691841d8003580
Dan Lynn
git@danlynn.org
http://github.com/emk/mephisto/commit/b421706d759ee7749e9d448fbce3dc3bf89d0927
b421706d759ee7749e9d448fbce3dc3bf89d0927
2009-02-09T13:21:49-08:00
2009-02-09T13:21:49-08:00
Add default codemacro stylesheets for theme usage.
Updated main README with instructions on how to
link to these stylesheets. A codemacro Rakefile
was added with tasks to test the plugin and
generate a new default_coderay.css stylesheet.
The codemacro plugin now wraps all code listings
in a <div> enabling horizontal scrolling and
dynamic width.
e6b6df2cea1d78ac0a2f9a565f699c7fbfcd198e
Dan Lynn
git@danlynn.org