-
Notifications
You must be signed in to change notification settings - Fork 0
Automatically exported from code.google.com/p/google-code-prettify
License
yuvalherziger/google-code-prettify
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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> <script src="src/lang-css.js" type="text/javascript"></script> <style type="text/css"> body { margin-left: .5in } h1, h2, h3, h4, .footer { margin-left: -.4in; } a.Extension { display: inline-block; width: 5em; height:2.5em; border: 1px solid black; vertical-align: top; text-align: center } </style> </head> <body onload="prettyPrint()" bgcolor="white"> <small style="float: right">Languages : <a href="README-zh-Hans.html">CH</a></small> <h1>Javascript code prettifier</h1> <h2>Setup</h2> <ol> <li><a href="http://code.google.com/p/google-code-prettify/downloads/list">Download</a> a distribution <li>Include the script tag below in your document <pre class="prettyprint"> <script src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script></pre> <li>See <a href="http://code.google.com/p/google-code-prettify/wiki/GettingStarted">Getting Started</a> to configure that URL with options you need.</a> <li>Look at the <a href="http://google-code-prettify.googlecode.com/svn/trunk/styles/index.html">skin gallery</a> and pick styles that suit you.</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 id="langs">For which languages does it work?</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, Makefiles, and Rust. It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl and Ruby, but, because of commenting conventions, but doesn't work on Smalltalk.</p> <p>Other languages are supported via extensions: <div> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-apollo.js">Apollo</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-basic.js">Basic</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-clj.js">Clojure</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-css.js">CSS</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-dart.js">Dart</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-erlang.js">Erlang</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-go.js">Go</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-hs.js">Haskell</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js">Lisp, Scheme</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-llvm.js">Llvm</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lua.js">Lua</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-matlab.js">Matlab</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-ml.js">MLs:F#, Ocaml,SML</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-mumps.js">Mumps</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-n.js">Nemerle</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-pascal.js">Pascal</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js">Protocol buffers</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-r.js">R, S</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-rd.js">RD</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-scala.js">Scala</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js">SQL</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-tcl.js">TCL</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-tex.js">Latek</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vb.js">Visual Basic</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vhdl.js">CHDL</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-wiki.js">Wiki</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-xq.js">XQ</a> <a class="Extension" href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-yaml.js">YAML</a> </div> <p>If you'd like to add an extension for your favorite language, please look at <tt>src/lang-lisp.js</tt> 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 the language of my code?</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. File extensions supported by default include "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html", "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh", "xhtml", "xml", "xsl". </pre></pre> <p>You may also use the <a href="http://dev.w3.org/html5/spec-author-view/the-code-element.html#the-code-element" >HTML 5</a> convention of embedding a <tt>code</tt> element inside the <code>PRE</code> and using <code>language-java</code> style classes. E.g. <xmp class="prettyprint"><pre class="prettyprint"><code class="language-java">...</code></pre></xmp> <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 id="linenums">How do I put line numbers in my code?</h3> <p>You can use the <code>linenums</code> class to turn on line numbering. If your code doesn't start at line number 1, you can add a colon and a line number to the end of that class as in <code>linenums:52</code>. <p>For example <pre class="prettyprint"><pre class="prettyprint linenums:<b>4</b>" >// This is line 4. foo(); bar(); baz(); boo(); far(); faz(); <pre></pre> produces <pre class="prettyprint linenums:4" >// This is line 4. foo(); bar(); baz(); boo(); far(); faz(); </pre> <h3>How do I prevent a portion of markup from being marked as code?</h3> <p>You can use the <code>nocode</code> class to identify a span of markup that is not code. <pre class="prettyprint"><pre class=prettyprint> int x = foo(); /* This is a comment <span class="nocode">This is not code</span> Continuation of comment */ int y = bar(); </pre></pre> produces <pre class="prettyprint"> int x = foo(); /* This is a comment <span class="nocode">This is not code</span> Continuation of comment */ int y = bar(); </pre> <p>For a more complete example see the issue22 <a href="tests/prettify_test.html#issue22">testcase</a>.</p> <h3>I get an error message "a is not a function" or "opt_whenDone is not a function"</h3> <p>If you are calling <code>prettyPrint</code> via an event handler, wrap it in a function. Instead of doing <blockquote> <code class="prettyprint lang-js" >addEventListener('load', prettyPrint, false);</code> </blockquote> wrap it in a closure like <blockquote> <code class="prettyprint lang-js" >addEventListener('load', function (event) { prettyPrint() }, false);</code> </blockquote> so that the browser does not pass an event object to <code>prettyPrint</code> which will confuse it. <h3>How can I customize the colors and styles of my code?</h3> <p> Prettify adds <code><span></code> with <code>class</code>es describing the kind of code. You can create CSS styles to matches these classes. See the <a href="http://google-code-prettify.googlecode.com/svn/trunk/styles/index.html"> theme gallery</a> for examples. </p> <h3>I can't add classes to my code (because it comes from Markdown, etc.)</h3> <p> Instead of <code class="prettyprint"><pre class="prettyprint ..."></code> you can use a comment or processing instructions that survives processing instructions : <code><?prettify ...?></code> works as explained in <a href="http://code.google.com/p/google-code-prettify/wiki/GettingStarted">Getting Started</a></p> <h3>How can I put line numbers on every line instead of just every fifth line?</h3> <p>Prettify puts lines into an HTML list element so that line numbers aren't caught by copy/paste, and the line numbering is controlled by CSS in the default stylesheet, "prettify.css".</p> <pre class="prettyprint"> <style> li.L0, li.L1, li.L2, li.L3, li.L5, li.L6, li.L7, li.L8 { list-style-type: decimal !important } </style></pre> should turn line numbering back on for the other lines. <br><br><br> <div class="footer"> <!-- Created: Tue Oct 3 17:51:56 PDT 2006 --> <!-- hhmts start -->Last modified: Fri Jun 21 15:23:18 EDT 2013 <!-- hhmts end --> </div> </body> </html>
About
Automatically exported from code.google.com/p/google-code-prettify
Resources
License
Stars
Watchers
Forks
Releases
No releases published