]> git.wincent.com - wikitext.git/commitdiff
Update README for new PRE_START "lang" attribute
authorWincent Colaiuta <win@wincent.com>
Tue, 26 May 2009 20:28:18 +0000 (22:28 +0200)
committerWincent Colaiuta <win@wincent.com>
Tue, 26 May 2009 20:28:18 +0000 (22:28 +0200)
Document the use of the "lang" attribute in PRE_START tags. Note that
contrary to what is said in the commit message for 024870e, uppercase
letters are in fact allowed in the attribute value.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
README.rdoc

index 1028fc89790749ec42523d09fd4b686ac167f4eb..4558b4581d229109258dc6e964205b0d620c9601 100644 (file)
@@ -229,6 +229,20 @@ blocks.
 Note that to avoid ambiguity, the translator will not let you intermix
 the two styles (HTML markup and wikitext markup).
 
++pre+ blocks may also contain a custom +lang+ attribute for the purposes
+of marking up a block for syntax-highlighting (note that the highlighting
+itself would be provided by JavaScript in the browser and is not actually
+part of the wikitext extension). For example:
+
+  <pre lang="ruby">puts @person.name</pre>
+
+Would be translated into:
+
+  <pre class="ruby-syntax">puts @person.name</pre>
+
+The +lang+ attribute may only contain letters, so "Objective-C", for
+example would need to be written as "objc" or similar.
+
 == External links
 
   [http://example.com/ this site]