| OLD | NEW |
| 1 {{+bindTo:partials.standard_nacl_article}} | 1 {{+bindTo:partials.standard_nacl_article}} |
| 2 | 2 |
| 3 <section id="examples-of-rest-markup-for-devsite-document-title"> | 3 <section id="examples-of-rest-markup-for-chromesite-document-title"> |
| 4 <h1 id="examples-of-rest-markup-for-devsite-document-title">Examples of ReST mar
kup for devsite (Document title)</h1> | 4 <h1 id="examples-of-rest-markup-for-chromesite-document-title">Examples of ReST
markup for chromesite (Document title)</h1> |
| 5 <p>This is an auto-generated table of contents for this document. <code>:local:<
/code> and | 5 <section id="document-structure"> |
| 6 <code>:backlinks: none</code> are required to make the devsite look consistent; | |
| 7 <code>:depth:</code> level can be controlled.</p> | |
| 8 <div class="contents local" id="contents" style="display: none"> | |
| 9 <ul class="small-gap"> | |
| 10 <li><a class="reference internal" href="#document-structure" id="id1">Document s
tructure</a></li> | |
| 11 <li><p class="first"><a class="reference internal" href="#basic-markup" id="id2"
>Basic markup</a></p> | |
| 12 <ul class="small-gap"> | |
| 13 <li><a class="reference internal" href="#unicode-samples" id="id3">Unicode sampl
es</a></li> | |
| 14 </ul> | |
| 15 </li> | |
| 16 <li><a class="reference internal" href="#images" id="id4">Images</a></li> | |
| 17 <li><p class="first"><a class="reference internal" href="#links" id="id5">Links<
/a></p> | |
| 18 <ul class="small-gap"> | |
| 19 <li><a class="reference internal" href="#to-other-documents-within-the-tree" id=
"id6">To other documents within the tree</a></li> | |
| 20 <li><a class="reference internal" href="#to-sections-inside-documents" id="id7">
To sections inside documents</a></li> | |
| 21 <li><a class="reference internal" href="#to-external-locations" id="id8">To exte
rnal locations</a></li> | |
| 22 </ul> | |
| 23 </li> | |
| 24 <li><a class="reference internal" href="#definition-lists" id="id9">Definition l
ists</a></li> | |
| 25 <li><a class="reference internal" href="#notes-and-admonitions" id="id10">Notes
and Admonitions</a></li> | |
| 26 <li><a class="reference internal" href="#source-code" id="id11">Source code</a><
/li> | |
| 27 <li><p class="first"><a class="reference internal" href="#section-heading" id="i
d12">Section heading</a></p> | |
| 28 <ul class="small-gap"> | |
| 29 <li><a class="reference internal" href="#subsection-heading" id="id13">Subsectio
n heading</a></li> | |
| 30 </ul> | |
| 31 </li> | |
| 32 <li><p class="first"><a class="reference internal" href="#expandable-sections" i
d="id14">Expandable sections</a></p> | |
| 33 <ul class="small-gap"> | |
| 34 <li><a class="reference internal" href="#expandable-section" id="id15">Expandabl
e Section</a></li> | |
| 35 </ul> | |
| 36 </li> | |
| 37 <li><a class="reference internal" href="#lists" id="id16">Lists</a></li> | |
| 38 <li><a class="reference internal" href="#tables" id="id17">Tables</a></li> | |
| 39 </ul> | |
| 40 | |
| 41 </div><section id="document-structure"> | |
| 42 <h2 id="document-structure">Document structure</h2> | 6 <h2 id="document-structure">Document structure</h2> |
| 43 <p>A document starts with a Sphinx target which serves as the document name | 7 <p>A document starts with a Sphinx target which serves as the document name |
| 44 throughout the tree. It can serve as a link target in other documents that want | 8 throughout the tree. It can serve as a link target in other documents that want |
| 45 to link to this one (see the Links section below).</p> | 9 to link to this one (see the Links section below).</p> |
| 46 <p>It follows with the document title (which doesn’t get generated to the
HTML body | |
| 47 in production mode, but is picked up by the devsite from <code><head><t
itle></code>.</p> | |
| 48 </section><section id="basic-markup"> | 10 </section><section id="basic-markup"> |
| 49 <h2 id="basic-markup">Basic markup</h2> | 11 <h2 id="basic-markup">Basic markup</h2> |
| 50 <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> | 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> |
| 51 <p>Some <strong>bold text</strong> and <em>italic text</em> and <code>fixed-font
text</code>. Non marked-up text | 13 <p>Some <strong>bold text</strong> and <em>italic text</em> and <code>fixed-font
text</code>. Non marked-up text |
| 52 can follow these immediately by using a backslash: <strong>pexe</strong>s.</p> | 14 can follow these immediately by using a backslash: <strong>pexe</strong>s.</p> |
| 53 <p>For pleasant collaborative editing, please use the accepted coding guidelines
: | 15 <p>For pleasant collaborative editing, please use the accepted coding guidelines
: |
| 54 wrap at 80 columns, no tabs, etc.</p> | 16 wrap at 80 columns, no tabs, etc.</p> |
| 55 <p>Quotes (<code><blockquote></code>) are created by indenting the paragra
ph:</p> | 17 <p>Quotes (<code><blockquote></code>) are created by indenting the paragra
ph:</p> |
| 56 <blockquote> | 18 <blockquote> |
| 57 <div>Most good programmers do programming not because they expect to get paid or | 19 <div>Most good programmers do programming not because they expect to get paid or |
| 58 get adulation by the public, but because it is fun to program. | 20 get adulation by the public, but because it is fun to program. |
| 59 – Linus Torvalds</div></blockquote> | 21 – Linus Torvalds</div></blockquote> |
| 60 <p>Here’s an en-dash – and an m-dash — too.</p> | 22 <p>Here’s an en-dash – and an m-dash — too.</p> |
| 61 <section id="unicode-samples"> | 23 <section id="unicode-samples"> |
| 62 <h3 id="unicode-samples">Unicode samples</h3> | 24 <h3 id="unicode-samples">Unicode samples</h3> |
| 63 <p>Copyright sign ©, and uacute Ú.</p> | 25 <p>Copyright sign ©, and uacute Ú.</p> |
| 64 </section></section><section id="images"> | 26 </section></section><section id="images"> |
| 65 <h2 id="images">Images</h2> | 27 <h2 id="images">Images</h2> |
| 66 <p>Please use absolute paths (starting with <code>/</code>) for images:</p> | 28 <p>Please use absolute paths (starting with <code>/</code>) for images:</p> |
| 67 <img alt="/native-client/images/NaclBlock.png" src="/native-client/images/NaclBl
ock.png" /> | 29 <img alt="/native-client/images/NaclBlock.png" src="/native-client/images/NaclBl
ock.png" /> |
| 68 </section><section id="links"> | 30 </section><section id="links"> |
| 69 <h2 id="links">Links</h2> | 31 <h2 id="links">Links</h2> |
| 70 <section id="to-other-documents-within-the-tree"> | 32 <section id="to-other-documents-within-the-tree"> |
| 71 <h3 id="to-other-documents-within-the-tree">To other documents within the tree</
h3> | 33 <h3 id="to-other-documents-within-the-tree">To other documents within the tree</
h3> |
| 72 <p>Internal links to other documents are created <a class="reference internal" h
ref="/native-client/overview.html"><em>like this</em></a>. The | 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 |
| 73 document name within the angle brackets is relative to the root dir of the | 35 document name within the angle brackets is relative to the root dir of the doc |
| 74 devsite doc tree and does not have an extension.</p> | 36 tree and does not have an extension.</p> |
| 75 <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 | 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 |
| 76 <a class="reference internal" href="/native-client/devguide/index.html"><em>devg
uide index</em></a>.</p> | 38 <a class="reference internal" href="/native-client/devguide/index.html"><em>devg
uide index</em></a>.</p> |
| 77 </section><section id="to-sections-inside-documents"> | 39 </section><section id="to-sections-inside-documents"> |
| 78 <h3 id="to-sections-inside-documents">To sections inside documents</h3> | 40 <h3 id="to-sections-inside-documents">To sections inside documents</h3> |
| 79 <p>To internal locations within documents, labels are used. For example, this li
nk | 41 <p>To internal locations within documents, labels are used. For example, this li
nk |
| 80 goes to the label explicitly placed in this document - | 42 goes to the label explicitly placed in this document - |
| 81 <a class="reference internal" href="#link-for-section-heading"><em>Section headi
ng</em></a>. This works across documents as well. Label | 43 <a class="reference internal" href="#link-for-section-heading"><em>Section headi
ng</em></a>. This works across documents as well. Label |
| 82 names must be unique in the tree, and can refer to anything (like images).</p> | 44 names must be unique in the tree, and can refer to anything (like images).</p> |
| 83 <p>It’s also possible to give such cross-references custom names: <a class
="reference internal" href="#link-for-section-heading"><em>Same | 45 <p>It’s also possible to give such cross-references custom names: <a class
="reference internal" href="#link-for-section-heading"><em>Same |
| 84 Section Heading</em></a>.</p> | 46 Section Heading</em></a>.</p> |
| 85 </section><section id="to-external-locations"> | 47 </section><section id="to-external-locations"> |
| 86 <h3 id="to-external-locations">To external locations</h3> | 48 <h3 id="to-external-locations">To external locations</h3> |
| 87 <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> | 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> |
| 88 </section></section><section id="definition-lists"> | 50 </section></section><section id="definition-lists"> |
| 89 <h2 id="definition-lists">Definition lists</h2> | 51 <h2 id="definition-lists">Definition lists</h2> |
| 90 <p>Can be used to define a group of related terms. Internal formatting is suppor
ted | 52 <p>Can be used to define a group of related terms. Internal formatting is suppor
ted |
| 91 within the definition. No special formatting needs to be done for the definition | 53 within the definition. No special formatting needs to be done for the definition |
| 92 name/title - it’s handled by the devsite.</p> | 54 name/title - it’s handled by the chromesite documentation server.</p> |
| 93 <dl class="docutils"> | 55 <dl class="docutils"> |
| 94 <dt>Apple</dt> | 56 <dt>Apple</dt> |
| 95 <dd>The apple is the pomaceous fruit of the apple tree, species Malus domestica
in | 57 <dd>The apple is the pomaceous fruit of the apple tree, species Malus domestica
in |
| 96 the rose family (<strong>Rosaceae</strong>).</dd> | 58 the rose family (<strong>Rosaceae</strong>).</dd> |
| 97 <dt>Fig</dt> | 59 <dt>Fig</dt> |
| 98 <dd>The common fig (<strong>Ficus carica</strong>) is a species of flowering pla
nt in the genus | 60 <dd>The common fig (<strong>Ficus carica</strong>) is a species of flowering pla
nt in the genus |
| 99 Ficus, from the family Moraceae, known as the common fig (or just the fig), | 61 Ficus, from the family Moraceae, known as the common fig (or just the fig), |
| 100 anjeer (Iran, Pakistan), and dumur (Bengali).</dd> | 62 anjeer (Iran, Pakistan), and dumur (Bengali).</dd> |
| 101 <dt>Pear</dt> | 63 <dt>Pear</dt> |
| 102 <dd>The pear is any of several tree and shrub species of genus Pyrus, in the | 64 <dd>The pear is any of several tree and shrub species of genus Pyrus, in the |
| 103 family Rosaceae.</dd> | 65 family Rosaceae.</dd> |
| 104 </dl> | 66 </dl> |
| 105 </section><section id="notes-and-admonitions"> | 67 </section><section id="notes-and-admonitions"> |
| 106 <h2 id="notes-and-admonitions">Notes and Admonitions</h2> | 68 <h2 id="notes-and-admonitions">Notes and Admonitions</h2> |
| 107 <p>The devsite supports special “notes” that are indented and have a
background | 69 <p>The documentation server supports special “notes” that are indent
ed and have a |
| 108 color. We’ll generate them with the <code>Note</code> directive, providing
the class | 70 background color. We’ll generate them with the <code>Note</code> directive
, providing |
| 109 explicitly. The class is one of <code>note</code>, <code>caution</code>, <code>
warning</code>, | 71 the class explicitly. The class is one of <code>note</code>, <code>caution</cod
e>, <code>warning</code>, |
| 110 <code>special</code>.</p> | 72 <code>special</code>.</p> |
| 111 <aside class="note"> | 73 <aside class="note"> |
| 112 <p>This is a note.</p> | 74 <p>This is a note.</p> |
| 113 <p>Foo bar.</p> | 75 <p>Foo bar.</p> |
| 114 | 76 |
| 115 </aside> | 77 </aside> |
| 116 <p>Also:</p> | 78 <p>Also:</p> |
| 117 <aside class="caution"> | 79 <aside class="caution"> |
| 118 Caution – you have been warned. | 80 Caution – you have been warned. |
| 119 </aside> | 81 </aside> |
| 120 </section><section id="source-code"> | 82 </section><section id="source-code"> |
| 121 <h2 id="source-code">Source code</h2> | 83 <h2 id="source-code">Source code</h2> |
| 122 <p>Here’s source code that will be pretty-printed on the devsite. Outside | 84 <p>Here’s source code that will be pretty-printed. It’s just a plain
<code><pre></code> |
| 123 production mode, it’s just a plain <code><pre></code> that presents
pre-formatted code | 85 that presents pre-formatted code with coloring:</p> |
| 124 without coloring:</p> | |
| 125 <pre class="prettyprint"> | 86 <pre class="prettyprint"> |
| 126 #include <iostream> | 87 #include <iostream> |
| 127 | 88 |
| 128 int main() { | 89 int main() { |
| 129 char c = 'x'; | 90 char c = 'x'; |
| 130 std::cout << "Hello world\n"; | 91 std::cout << "Hello world\n"; |
| 131 return 0; | 92 return 0; |
| 132 } | 93 } |
| 133 </pre> | 94 </pre> |
| 134 <p>For some code (like shell samples), we want to disable pretty-printing:</p> | 95 <p>For some code (like shell samples), we want to disable pretty-printing:</p> |
| (...skipping 11 matching lines...) Expand all Loading... |
| 146 signes (<code>#</code>) from above and below.</p> | 107 signes (<code>#</code>) from above and below.</p> |
| 147 <section id="subsection-heading"> | 108 <section id="subsection-heading"> |
| 148 <h3 id="subsection-heading">Subsection heading</h3> | 109 <h3 id="subsection-heading">Subsection heading</h3> |
| 149 <p>Subsection.</p> | 110 <p>Subsection.</p> |
| 150 <section id="sub-subsection-heading"> | 111 <section id="sub-subsection-heading"> |
| 151 <h4 id="sub-subsection-heading">Sub-subsection heading</h4> | 112 <h4 id="sub-subsection-heading">Sub-subsection heading</h4> |
| 152 <p>That’s pretty deep...</p> | 113 <p>That’s pretty deep...</p> |
| 153 <section id="sub-sub-subsection-heading"> | 114 <section id="sub-sub-subsection-heading"> |
| 154 <h5 id="sub-sub-subsection-heading">Sub-sub-subsection heading</h5> | 115 <h5 id="sub-sub-subsection-heading">Sub-sub-subsection heading</h5> |
| 155 <p>It’s probably not the best idea to go this far (renders to <code><h5
></code>).</p> | 116 <p>It’s probably not the best idea to go this far (renders to <code><h5
></code>).</p> |
| 156 </section></section></section></section><section id="expandable-sections"> | 117 </section></section></section></section><section id="lists"> |
| 157 <h2 id="expandable-sections">Expandable sections</h2> | |
| 158 <p>The devsite can render expandable sections when a special <code>class</code>
is applied. | |
| 159 This can be achieved by specifying the <code>rst-class</code> immediately before
a | |
| 160 section (or any other element), as follows:</p> | |
| 161 <section class="expandable" id="expandable-section"> | |
| 162 <h3 id="expandable-section">Expandable Section</h3> | |
| 163 <p>Look, ma! I’m expandable!</p> | |
| 164 </section></section><section id="lists"> | |
| 165 <h2 id="lists">Lists</h2> | 118 <h2 id="lists">Lists</h2> |
| 166 <p>Auto-numbered ordered lists:</p> | 119 <p>Auto-numbered ordered lists:</p> |
| 167 <ol class="arabic simple"> | 120 <ol class="arabic simple"> |
| 168 <li>One</li> | 121 <li>One</li> |
| 169 <li>Two</li> | 122 <li>Two</li> |
| 170 <li>Three</li> | 123 <li>Three</li> |
| 171 </ol> | 124 </ol> |
| 172 <p>Manually numbered ordered lists:</p> | 125 <p>Manually numbered ordered lists:</p> |
| 173 <ol class="arabic simple"> | 126 <ol class="arabic simple"> |
| 174 <li>One</li> | 127 <li>One</li> |
| (...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 245 <tr class="row-odd"><td>body row 2</td> | 198 <tr class="row-odd"><td>body row 2</td> |
| 246 <td>...</td> | 199 <td>...</td> |
| 247 <td>...</td> | 200 <td>...</td> |
| 248 <td> </td> | 201 <td> </td> |
| 249 </tr> | 202 </tr> |
| 250 </tbody> | 203 </tbody> |
| 251 </table> | 204 </table> |
| 252 </section></section> | 205 </section></section> |
| 253 | 206 |
| 254 {{/partials.standard_nacl_article}} | 207 {{/partials.standard_nacl_article}} |
| OLD | NEW |