| OLD | NEW |
| 1 {{+bindTo:partials.standard_nacl_article}} | 1 {{+bindTo:partials.standard_nacl_article}} |
| 2 | 2 |
| 3 <section id="examples-of-rest-markup-for-chromesite-document-title"> | 3 <section id="examples-of-rest-markup-for-chromesite-document-title"> |
| 4 <h1 id="examples-of-rest-markup-for-chromesite-document-title">Examples of ReST
markup for chromesite (Document title)</h1> | 4 <h1 id="examples-of-rest-markup-for-chromesite-document-title">Examples of ReST
markup for chromesite (Document title)</h1> |
| 5 <section id="document-structure"> | |
| 6 <h2 id="document-structure">Document structure</h2> | 5 <h2 id="document-structure">Document structure</h2> |
| 7 <p>A document starts with a Sphinx target which serves as the document name | 6 <p>A document starts with a Sphinx target which serves as the document name |
| 8 throughout the tree. It can serve as a link target in other documents that want | 7 throughout the tree. It can serve as a link target in other documents that want |
| 9 to link to this one (see the Links section below).</p> | 8 to link to this one (see the Links section below).</p> |
| 10 </section><section id="basic-markup"> | |
| 11 <h2 id="basic-markup">Basic markup</h2> | 9 <h2 id="basic-markup">Basic markup</h2> |
| 12 <p>In general, follow the rules from <a class="reference external" href="http://
sphinx-doc.org/rest.html">http://sphinx-doc.org/rest.html</a></p> | 10 <p>In general, follow the rules from <a class="reference external" href="http://
sphinx-doc.org/rest.html">http://sphinx-doc.org/rest.html</a></p> |
| 13 <p>Some <strong>bold text</strong> and <em>italic text</em> and <code>fixed-font
text</code>. Non marked-up text | 11 <p>Some <strong>bold text</strong> and <em>italic text</em> and <code>fixed-font
text</code>. Non marked-up text |
| 14 can follow these immediately by using a backslash: <strong>pexe</strong>s.</p> | 12 can follow these immediately by using a backslash: <strong>pexe</strong>s.</p> |
| 15 <p>For pleasant collaborative editing, please use the accepted coding guidelines
: | 13 <p>For pleasant collaborative editing, please use the accepted coding guidelines
: |
| 16 wrap at 80 columns, no tabs, etc.</p> | 14 wrap at 80 columns, no tabs, etc.</p> |
| 17 <p>Quotes (<code><blockquote></code>) are created by indenting the paragra
ph:</p> | 15 <p>Quotes (<code><blockquote></code>) are created by indenting the paragra
ph:</p> |
| 18 <blockquote> | 16 <blockquote> |
| 19 <div>Most good programmers do programming not because they expect to get paid or | 17 <div>Most good programmers do programming not because they expect to get paid or |
| 20 get adulation by the public, but because it is fun to program. | 18 get adulation by the public, but because it is fun to program. |
| 21 – Linus Torvalds</div></blockquote> | 19 – Linus Torvalds</div></blockquote> |
| 22 <p>Here’s an en-dash – and an m-dash — too.</p> | 20 <p>Here’s an en-dash – and an m-dash — too.</p> |
| 23 <section id="unicode-samples"> | |
| 24 <h3 id="unicode-samples">Unicode samples</h3> | 21 <h3 id="unicode-samples">Unicode samples</h3> |
| 25 <p>Copyright sign ©, and uacute Ú.</p> | 22 <p>Copyright sign ©, and uacute Ú.</p> |
| 26 </section></section><section id="images"> | |
| 27 <h2 id="images">Images</h2> | 23 <h2 id="images">Images</h2> |
| 28 <p>Please use absolute paths (starting with <code>/</code>) for images:</p> | 24 <p>Please use absolute paths (starting with <code>/</code>) for images:</p> |
| 29 <img alt="/native-client/images/NaclBlock.png" src="/native-client/images/NaclBl
ock.png" /> | 25 <img alt="/native-client/images/NaclBlock.png" src="/native-client/images/NaclBl
ock.png" /> |
| 30 </section><section id="links"> | |
| 31 <h2 id="links">Links</h2> | 26 <h2 id="links">Links</h2> |
| 32 <section id="to-other-documents-within-the-tree"> | |
| 33 <h3 id="to-other-documents-within-the-tree">To other documents within the tree</
h3> | 27 <h3 id="to-other-documents-within-the-tree">To other documents within the tree</
h3> |
| 34 <p>Internal links to other documents are created <a class="reference internal" h
ref="/native-client/overview.html"><em>like this</em></a>. The | 28 <p>Internal links to other documents are created <a class="reference internal" h
ref="/native-client/overview.html"><em>like this</em></a>. The |
| 35 document name within the angle brackets is relative to the root dir of the doc | 29 document name within the angle brackets is relative to the root dir of the doc |
| 36 tree and does not have an extension.</p> | 30 tree and does not have an extension.</p> |
| 37 <p>Here’s a link to a document in a subdirectory: <a class="reference inte
rnal" href="/native-client/devguide/tutorial/tutorial-part1.html"><em>the tutori
al</em></a>. And a link to a subdirectory index page | 31 <p>Here’s a link to a document in a subdirectory: <a class="reference inte
rnal" href="/native-client/devguide/tutorial/tutorial-part1.html"><em>the tutori
al</em></a>. And a link to a subdirectory index page |
| 38 <a class="reference internal" href="/native-client/devguide/index.html"><em>devg
uide index</em></a>.</p> | 32 <a class="reference internal" href="/native-client/devguide/index.html"><em>devg
uide index</em></a>.</p> |
| 39 </section><section id="to-sections-inside-documents"> | |
| 40 <h3 id="to-sections-inside-documents">To sections inside documents</h3> | 33 <h3 id="to-sections-inside-documents">To sections inside documents</h3> |
| 41 <p>To internal locations within documents, labels are used. For example, this li
nk | 34 <p>To internal locations within documents, labels are used. For example, this li
nk |
| 42 goes to the label explicitly placed in this document - | 35 goes to the label explicitly placed in this document - |
| 43 <a class="reference internal" href="#link-for-section-heading"><em>Section headi
ng</em></a>. This works across documents as well. Label | 36 <a class="reference internal" href="#link-for-section-heading"><em>Section headi
ng</em></a>. This works across documents as well. Label |
| 44 names must be unique in the tree, and can refer to anything (like images).</p> | 37 names must be unique in the tree, and can refer to anything (like images).</p> |
| 45 <p>It’s also possible to give such cross-references custom names: <a class
="reference internal" href="#link-for-section-heading"><em>Same | 38 <p>It’s also possible to give such cross-references custom names: <a class
="reference internal" href="#link-for-section-heading"><em>Same |
| 46 Section Heading</em></a>.</p> | 39 Section Heading</em></a>.</p> |
| 47 </section><section id="to-external-locations"> | |
| 48 <h3 id="to-external-locations">To external locations</h3> | 40 <h3 id="to-external-locations">To external locations</h3> |
| 49 <p>Plain links can be placed like this: <a class="reference external" href="http
://google.com">http://google.com</a> and also <a class="reference external" href
="http://google.com">like this</a>.</p> | 41 <p>Plain links can be placed like this: <a class="reference external" href="http
://google.com">http://google.com</a> and also <a class="reference external" href
="http://google.com">like this</a>.</p> |
| 50 </section></section><section id="definition-lists"> | |
| 51 <h2 id="definition-lists">Definition lists</h2> | 42 <h2 id="definition-lists">Definition lists</h2> |
| 52 <p>Can be used to define a group of related terms. Internal formatting is suppor
ted | 43 <p>Can be used to define a group of related terms. Internal formatting is suppor
ted |
| 53 within the definition. No special formatting needs to be done for the definition | 44 within the definition. No special formatting needs to be done for the definition |
| 54 name/title - it’s handled by the chromesite documentation server.</p> | 45 name/title - it’s handled by the chromesite documentation server.</p> |
| 55 <dl class="docutils"> | 46 <dl class="docutils"> |
| 56 <dt>Apple</dt> | 47 <dt>Apple</dt> |
| 57 <dd>The apple is the pomaceous fruit of the apple tree, species Malus domestica
in | 48 <dd>The apple is the pomaceous fruit of the apple tree, species Malus domestica
in |
| 58 the rose family (<strong>Rosaceae</strong>).</dd> | 49 the rose family (<strong>Rosaceae</strong>).</dd> |
| 59 <dt>Fig</dt> | 50 <dt>Fig</dt> |
| 60 <dd>The common fig (<strong>Ficus carica</strong>) is a species of flowering pla
nt in the genus | 51 <dd>The common fig (<strong>Ficus carica</strong>) is a species of flowering pla
nt in the genus |
| 61 Ficus, from the family Moraceae, known as the common fig (or just the fig), | 52 Ficus, from the family Moraceae, known as the common fig (or just the fig), |
| 62 anjeer (Iran, Pakistan), and dumur (Bengali).</dd> | 53 anjeer (Iran, Pakistan), and dumur (Bengali).</dd> |
| 63 <dt>Pear</dt> | 54 <dt>Pear</dt> |
| 64 <dd>The pear is any of several tree and shrub species of genus Pyrus, in the | 55 <dd>The pear is any of several tree and shrub species of genus Pyrus, in the |
| 65 family Rosaceae.</dd> | 56 family Rosaceae.</dd> |
| 66 </dl> | 57 </dl> |
| 67 </section><section id="notes-and-admonitions"> | |
| 68 <h2 id="notes-and-admonitions">Notes and Admonitions</h2> | 58 <h2 id="notes-and-admonitions">Notes and Admonitions</h2> |
| 69 <p>The documentation server supports special “notes” that are indent
ed and have a | 59 <p>The documentation server supports special “notes” that are indent
ed and have a |
| 70 background color. We’ll generate them with the <code>Note</code> directive
, providing | 60 background color. We’ll generate them with the <code>Note</code> directive
, providing |
| 71 the class explicitly. The class is one of <code>note</code>, <code>caution</cod
e>, <code>warning</code>, | 61 the class explicitly. The class is one of <code>note</code>, <code>caution</cod
e>, <code>warning</code>, |
| 72 <code>special</code>.</p> | 62 <code>special</code>.</p> |
| 73 <aside class="note"> | 63 <aside class="note"> |
| 74 <p>This is a note.</p> | 64 <p>This is a note.</p> |
| 75 <p>Foo bar.</p> | 65 <p>Foo bar.</p> |
| 76 | 66 |
| 77 </aside> | 67 </aside> |
| 78 <p>Also:</p> | 68 <p>Also:</p> |
| 79 <aside class="caution"> | 69 <aside class="caution"> |
| 80 Caution – you have been warned. | 70 Caution – you have been warned. |
| 81 </aside> | 71 </aside> |
| 82 </section><section id="source-code"> | |
| 83 <h2 id="source-code">Source code</h2> | 72 <h2 id="source-code">Source code</h2> |
| 84 <p>Here’s source code that will be pretty-printed. It’s just a plain
<code><pre></code> | 73 <p>Here’s source code that will be pretty-printed. It’s just a plain
<code><pre></code> |
| 85 that presents pre-formatted code with coloring:</p> | 74 that presents pre-formatted code with coloring:</p> |
| 86 <pre class="prettyprint"> | 75 <pre class="prettyprint"> |
| 87 #include <iostream> | 76 #include <iostream> |
| 88 | 77 |
| 89 int main() { | 78 int main() { |
| 90 char c = 'x'; | 79 char c = 'x'; |
| 91 std::cout << "Hello world\n"; | 80 std::cout << "Hello world\n"; |
| 92 return 0; | 81 return 0; |
| 93 } | 82 } |
| 94 </pre> | 83 </pre> |
| 95 <p>For some code (like shell samples), we want to disable pretty-printing:</p> | 84 <p>For some code (like shell samples), we want to disable pretty-printing:</p> |
| 96 <pre> | 85 <pre> |
| 97 $ ls | wc | 86 $ ls | wc |
| 98 $ echo "hello world" | 87 $ echo "hello world" |
| 99 </pre> | 88 </pre> |
| 100 <p>By default <code>:prettyprint:</code> is <code>1</code>.</p> | 89 <p>By default <code>:prettyprint:</code> is <code>1</code>.</p> |
| 101 <p>For short inline code, use fixed-formatting like <code>int x = 2;</code>. Not
e that this | 90 <p>For short inline code, use fixed-formatting like <code>int x = 2;</code>. Not
e that this |
| 102 won’t get syntax-highlighted and may be line-wrapped, so keep it very shor
t.</p> | 91 won’t get syntax-highlighted and may be line-wrapped, so keep it very shor
t.</p> |
| 103 </section><section id="section-heading"> | 92 <h2 id="section-heading"><span id="link-for-section-heading"></span>Section head
ing</h2> |
| 104 <span id="link-for-section-heading"></span><h2 id="section-heading"><span id="li
nk-for-section-heading"></span>Section heading</h2> | |
| 105 <p>Here’s a demonstration of heading nesting levels. This is a top-level s
ection in | 93 <p>Here’s a demonstration of heading nesting levels. This is a top-level s
ection in |
| 106 the document. The document title is the first header and it’s delimited by
hash | 94 the document. The document title is the first header and it’s delimited by
hash |
| 107 signes (<code>#</code>) from above and below.</p> | 95 signes (<code>#</code>) from above and below.</p> |
| 108 <section id="subsection-heading"> | |
| 109 <h3 id="subsection-heading">Subsection heading</h3> | 96 <h3 id="subsection-heading">Subsection heading</h3> |
| 110 <p>Subsection.</p> | 97 <p>Subsection.</p> |
| 111 <section id="sub-subsection-heading"> | |
| 112 <h4 id="sub-subsection-heading">Sub-subsection heading</h4> | 98 <h4 id="sub-subsection-heading">Sub-subsection heading</h4> |
| 113 <p>That’s pretty deep...</p> | 99 <p>That’s pretty deep...</p> |
| 114 <section id="sub-sub-subsection-heading"> | |
| 115 <h5 id="sub-sub-subsection-heading">Sub-sub-subsection heading</h5> | 100 <h5 id="sub-sub-subsection-heading">Sub-sub-subsection heading</h5> |
| 116 <p>It’s probably not the best idea to go this far (renders to <code><h5
></code>).</p> | 101 <p>It’s probably not the best idea to go this far (renders to <code><h5
></code>).</p> |
| 117 </section></section></section></section><section id="lists"> | |
| 118 <h2 id="lists">Lists</h2> | 102 <h2 id="lists">Lists</h2> |
| 119 <p>Auto-numbered ordered lists:</p> | 103 <p>Auto-numbered ordered lists:</p> |
| 120 <ol class="arabic simple"> | 104 <ol class="arabic simple"> |
| 121 <li>One</li> | 105 <li>One</li> |
| 122 <li>Two</li> | 106 <li>Two</li> |
| 123 <li>Three</li> | 107 <li>Three</li> |
| 124 </ol> | 108 </ol> |
| 125 <p>Manually numbered ordered lists:</p> | 109 <p>Manually numbered ordered lists:</p> |
| 126 <ol class="arabic simple"> | 110 <ol class="arabic simple"> |
| 127 <li>One</li> | 111 <li>One</li> |
| 128 <li>Two</li> | 112 <li>Two</li> |
| 129 <li>Three</li> | 113 <li>Three</li> |
| 130 </ol> | 114 </ol> |
| 131 <p>Unordered (bullet) lists:</p> | 115 <p>Unordered (bullet) lists:</p> |
| 132 <ul class="small-gap"> | 116 <ul class="small-gap"> |
| 133 <li>One</li> | 117 <li>One</li> |
| 134 <li>Two</li> | 118 <li>Two</li> |
| 135 <li>Three</li> | 119 <li>Three</li> |
| 136 </ul> | 120 </ul> |
| 137 <p>Lists can be nested and mixed too:</p> | 121 <p>Lists can be nested and mixed too:</p> |
| 138 <ul class="small-gap"> | 122 <ul class="small-gap"> |
| 139 <li><p class="first">Toplevel</p> | 123 <li><p class="first">Toplevel</p> |
| 140 <ol class="arabic simple"> | 124 <ol class="arabic simple"> |
| 141 <li>One</li> | 125 <li>One</li> |
| 142 <li>Two</li> | 126 <li>Two</li> |
| 143 </ol> | 127 </ol> |
| 144 </li> | 128 </li> |
| 145 <li>Back to top level</li> | 129 <li>Back to top level</li> |
| 146 </ul> | 130 </ul> |
| 147 </section><section id="tables"> | |
| 148 <h2 id="tables">Tables</h2> | 131 <h2 id="tables">Tables</h2> |
| 149 <p>The full scoop on tables is <a class="reference external" href="http://sphinx
-doc.org/rest.html#tables">http://sphinx-doc.org/rest.html#tables</a> and the | 132 <p>The full scoop on tables is <a class="reference external" href="http://sphinx
-doc.org/rest.html#tables">http://sphinx-doc.org/rest.html#tables</a> and the |
| 150 Docutils pages linked from it.</p> | 133 Docutils pages linked from it.</p> |
| 151 <p>“Simple tables” require less markup but are limited:</p> | 134 <p>“Simple tables” require less markup but are limited:</p> |
| 152 <table border="1" class="docutils"> | 135 <table border="1" class="docutils"> |
| 153 <colgroup> | 136 <colgroup> |
| 154 </colgroup> | 137 </colgroup> |
| 155 <thead valign="bottom"> | 138 <thead valign="bottom"> |
| 156 <tr class="row-odd"><th class="head">A</th> | 139 <tr class="row-odd"><th class="head">A</th> |
| 157 <th class="head">B</th> | 140 <th class="head">B</th> |
| (...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 195 <td>column 3</td> | 178 <td>column 3</td> |
| 196 <td>column 4</td> | 179 <td>column 4</td> |
| 197 </tr> | 180 </tr> |
| 198 <tr class="row-odd"><td>body row 2</td> | 181 <tr class="row-odd"><td>body row 2</td> |
| 199 <td>...</td> | 182 <td>...</td> |
| 200 <td>...</td> | 183 <td>...</td> |
| 201 <td> </td> | 184 <td> </td> |
| 202 </tr> | 185 </tr> |
| 203 </tbody> | 186 </tbody> |
| 204 </table> | 187 </table> |
| 205 </section></section> | 188 </section> |
| 206 | 189 |
| 207 {{/partials.standard_nacl_article}} | 190 {{/partials.standard_nacl_article}} |
| OLD | NEW |