-
Notifications
You must be signed in to change notification settings - Fork 8
fork of http://code.google.com/p/google-code-prettify/
License
stuarthalloway/google-code-prettify
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>Javascript code prettifier</title> <link href="src/prettify.css" type="text/css" rel="stylesheet" /> <script src="src/prettify.js" type="text/javascript"></script> <style type="text/css"> body { margin-left: .5in } h1, h2, h3, h4, .footer { margin-left: -.4in; } </style> </head> <body onload="prettyPrint()" bgcolor="white"> <h1>Javascript code prettifier</h1> <h2>Setup</h2> <ol> <li><a href="http://google-code-prettify.googlecode.com/files/prettify-small-5-Jul-2008.zip">Download</a> a distribution <li>Include the script and stylesheets in your document (you will need to make sure the css and js file are on your server, and adjust the paths in the <tt>script</tt> and <tt>link</tt> tag) <pre class="prettyprint"> <link href="prettify.css" type="text/css" rel="stylesheet" /> <script type="text/javascript" src="prettify.js"></script></pre> <li>Add <code class="prettyprint">onload="prettyPrint()"</code> to your document's body tag. <li>Modify the stylesheet to get the coloring you prefer</li> </ol> <h2>Usage</h2> <p>Put code snippets in <tt><pre class="prettyprint">...</pre></tt> or <tt><code class="prettyprint">...</code></tt> and it will automatically be pretty printed. <table summary="code examples"> <tr> <th>The original <th>Prettier <tr> <td><pre style="border: 1px solid #888;padding: 2px" ><a name="voila1"></a>class Voila { public: // Voila static const string VOILA = "Voila"; // will not interfere with embedded <a href="#voila1">tags</a>. }</pre> <td><pre class="prettyprint"><a name="voila2"></a>class Voila { public: // Voila static const string VOILA = "Voila"; // will not interfere with embedded <a href="#voila2">tags</a>. }</pre> </table> <h2>FAQ</h2> <h3>Which languages does it work for?</h3> <p>The comments in <tt>prettify.js</tt> are authoritative but the lexer should work on a number of languages including C and friends, Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles. It works passably on Ruby, PHP and Awk and a decent subset of Perl, but, because of commenting conventions, doesn't work on Smalltalk, or CAML-like languages.</p> <p>LISPy languages are supported via an extension: <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js" ><code>lang-lisp.js</code></a>.</p> <p>And similarly for <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lua.js" ><code>LUA</code></a>, <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-ml.js" ><code>OCAML, SML, F#</code></a>, <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js" ><code>SQL</code></a>, and <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js" ><code>Protocol Buffers</code></a>. <p>If you'd like to add an extension for your favorite language, please look at lang-lisp.js and file an <a href="http://code.google.com/p/google-code-prettify/issues/list" >issue</a> including your language extension, and a testcase.</p> <h3>How do I specify which language my code is in?</h3> <p>You don't need to specify the language since <code>prettyprint()</code> will guess. You can specify a language by specifying the language extension along with the <code>prettyprint</code> class like so:</p> <pre class="prettyprint lang-html" ><pre class="prettyprint <b>lang-html</b>"> The lang-* class specifies the language file extensions. Supported file extensions include "c", "cc", "cpp", "cs", "cyc", "java", "bsh", "csh", "sh", "cv", "py", "perl", "pl", "pm", "rb", "js", "html", "html", "xhtml", "xml", "xsl". </pre></pre> <h3>It doesn't work on <tt><obfuscated code sample></tt>?</h3> <p>Yes. Prettifying obfuscated code is like putting lipstick on a pig — i.e. outside the scope of this tool.</p> <h3>Which browsers does it work with?</h3> <p>It's been tested with IE 6, Firefox 1.5 & 2, and Safari 2.0.4. Look at <a href="tests/prettify_test.html">the test page</a> to see if it works in your browser.</p> <h3>What's changed?</h3> <p>See the <a href="CHANGES.html">change log</a></p> <h3>Why doesn't Prettyprinting of strings work on WordPress?</h3> <p>Apparently wordpress does "smart quoting" which changes close quotes. This causes end quotes to not match up with open quotes. <p>This breaks prettifying as well as copying and pasting of code samples. See <a href="http://wordpress.org/support/topic/125038" >WordPress's help center</a> for info on how to stop smart quoting of code snippets.</p> <h3>How do I put line numbers in my code?</h3> <p>You can use the <code>nocode</code> class to identify a span of markup that is not code. <pre><pre class=prettyprint> <span class="<b>nocode</b>">1:</span> /* This is line 1 of my code <span class="<b>nocode</b>">2:</span> * and here's line 2 */ <span class="<b>nocode</b>">3:</span> print("I'm line number 3"); </pre></pre> produces <pre class=prettyprint> <span class="nocode">1:</span> /* This is line 1 of my code <span class="nocode">2:</span> * and here's line 2 */ <span class="nocode">3:</span> print("I'm line number 3"); </pre> <p>For a more complete example see the issue22 <a href="tests/prettify_test.html#issue22">testcase</a>.</p> <br><br><br> <div class="footer"> <!-- Created: Tue Oct 3 17:51:56 PDT 2006 --> <!-- hhmts start --> Last modified: Fri Jul 4 20:49:30 PDT 2008 <!-- hhmts end --> </div> </body> </html>
Releases
No releases published
Packages 0
No packages published