├── attrib.png ├── noncomm.png ├── biohazard.png ├── sharealike.png ├── cpmono_v07_plain.ttf ├── magnetic-balls.jpg ├── rst-cheatsheet.pdf ├── README ├── README-cp.txt ├── cheatsheet.style └── rst-cheatsheet.rst /attrib.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/attrib.png -------------------------------------------------------------------------------- /noncomm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/noncomm.png -------------------------------------------------------------------------------- /biohazard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/biohazard.png -------------------------------------------------------------------------------- /sharealike.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/sharealike.png -------------------------------------------------------------------------------- /cpmono_v07_plain.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/cpmono_v07_plain.ttf -------------------------------------------------------------------------------- /magnetic-balls.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/magnetic-balls.jpg -------------------------------------------------------------------------------- /rst-cheatsheet.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brews/rst-cheatsheet/master/rst-cheatsheet.pdf -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | If you just want the PDF, click here: 2 | 3 | http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf 4 | 5 | This project uses: 6 | 7 | CP Font from LiquiType: http://www.liquitype.com/ which you can download from 8 | http://www.fontspace.com/liquitype/cp-mono (converted to TTF and included, license 9 | is CC, you can read it in README-cp.txt) 10 | 11 | Magnetic Balls V2 by fdecomite: http://www.flickr.com/photos/fdecomite/2926556794/ 12 | 13 | To build: 14 | 15 | rst2pdf rst-cheatsheet.rst -s cheatsheet 16 | -------------------------------------------------------------------------------- /README-cp.txt: -------------------------------------------------------------------------------- 1 | You are free: 2 | 3 | * to copy, distribute, display, and perform the work 4 | * to make derivative works 5 | 6 | 7 | Under the following conditions: 8 | 9 | Attribution. You must give the original author credit. 10 | 11 | * For any reuse or distribution, you must make clear to others the licence terms of this work. 12 | * Any of the above conditions can be waived if you get permission from the copyright holder. 13 | * Nothing in this license impairs or restricts the author's moral rights. 14 | 15 | 16 | http://creativecommons.org/licenses/by/3.0/de/deed.en_GB 17 | -------------------------------------------------------------------------------- /cheatsheet.style: -------------------------------------------------------------------------------- 1 | { 2 | "pageSetup": {"margin-left": 0, 3 | "margin-right": 0, 4 | "margin-top": 0, 5 | "margin-bottom": 3, 6 | "spacing-header": 0, 7 | "spacing-footer": 10, 8 | "firstTemplate": "twoColumn", 9 | "width": "29.7cm", 10 | "height": "21cm" 11 | }, 12 | "pageTemplates" : { 13 | "threeColumn": { 14 | "frames": [ 15 | ["2%", "0cm", "29.333%", "100%"], 16 | ["35.333%", "0cm", "29.333%", "100%"], 17 | ["68.666%", "0cm", "29.333%", "100%"] 18 | ] 19 | } 20 | }, 21 | "fontsAlias" : { 22 | "stdMono": "CPMono_v07 Plain" 23 | }, 24 | "styles" : [ 25 | [ "base", { 26 | "kerning" : true, 27 | "fontSize": 6, 28 | "leading": 7.5, 29 | "spaceAfter": 0 30 | } 31 | ], 32 | ["code" , { 33 | "parent": "literal", 34 | "leftIndent": 0, 35 | "spaceBefore": 0, 36 | "spaceAfter": 3, 37 | "backColor": null, 38 | "borderColor": null, 39 | "borderWidth": 0, 40 | "leading":7, 41 | "borderPadding": 0, 42 | "fontSize": 5 43 | }], 44 | ["bodytext" , { 45 | "spaceBefore":0 46 | }], 47 | ["small" , { 48 | "parent": "base", 49 | "fontSize": 6 50 | }], 51 | ["heading1", { 52 | "backColor": "#446885", 53 | "borderColor": "#446885", 54 | "borderWidth": 0.2, 55 | "textColor": "#FFFFFF", 56 | "leading": 10, 57 | "alignment": "TA_CENTER", 58 | "spaceBefore": 4, 59 | "borderPadding": [3,0,1,0], 60 | "leftIndent": 0, 61 | "fontSize": 8, 62 | "fontName": "stdSansBold" 63 | }], 64 | ["faketitle" , { 65 | "borderPadding": [3,0,1,0], 66 | "fontSize": 8, 67 | "spaceBefore": 4, 68 | "spaceAfter": 4, 69 | "fontName": "stdSansBold" 70 | }], 71 | ["nota", { "parent": "heading", 72 | "fontSize": 6, 73 | "fontName": "stdSansBold", 74 | "textColor": "#FFFFFF", 75 | "alignment": "TA_RIGHT" 76 | }], 77 | ["table" , { 78 | "spaceBefore":0, 79 | "spaceAfter":3, 80 | "colWidths": ["50%","50%"], 81 | "commands": [ 82 | [ "VALIGN", [0, 0], [-1, -1], "TOP" ], 83 | [ "BOTTOMPADDING", [0, 0], [-1, -1], 0 ], 84 | [ "TOPPADDING", [0, 0], [-1, -1], 1 ], 85 | [ "LINEBELOW", [0, 0], [-1, -2], 0.2, "#E1E6EA" ] 86 | ] 87 | }], 88 | ["exampletable1" , { 89 | "spaceBefore":0, 90 | "spaceAfter":3, 91 | "colWidths": ["33.3%","33.3%","33.3%"], 92 | "commands": [ 93 | [ "VALIGN", [0, 0], [-1, -1], "TOP" ], 94 | [ "BOTTOMPADDING", [0, 0], [-1, -1], -1 ], 95 | [ "GRID", [0, 0], [-1, -1], 0.2, "#446885" ], 96 | [ "BOX", [0, 0], [-1, -1], 0.2, "#446885" ] 97 | ] 98 | }], 99 | ["faketrans" , { 100 | "spaceBefore":3, 101 | "spaceAfter":3, 102 | "colWidths": ["100%"], 103 | "commands": [ 104 | [ "LINEABOVE", [0, 0], [-1, -1], 0.8, "#446885" ] 105 | ] 106 | }], 107 | ["tablapie" , { 108 | "spaceBefore":0, 109 | "spaceAfter":0, 110 | "colWidths": ["52%","19%","12%","17%"], 111 | "commands": [ 112 | [ "VALIGN", [0, 0], [-1, -1], "TOP" ], 113 | [ "BOTTOMPADDING", [0, 0], [-1, -1], -3 ], 114 | [ "LINEABOVE", [0, 0], [-1, -1], 0.4, "#446885" ] 115 | ] 116 | }], 117 | ["izqfina" , { 118 | "spaceBefore":0, 119 | "spaceAfter":6, 120 | "colWidths": ["10%",null], 121 | "commands": [ 122 | [ "VALIGN", [0, 0], [-1, -1], "MIDDLE" ], 123 | [ "BOTTOMPADDING", [0, 0], [-1, -1], -3 ], 124 | [ "LINEBELOW", [0, 0], [-1, -2], 0.2, "#E1E6EA" ] 125 | ] 126 | }], 127 | ["tablacreditos", { 128 | "parent": "bodytext", 129 | "spaceBefore":-1, 130 | "spaceAfter":0, 131 | "colWidths": ["50%","50%"], 132 | "commands": [ 133 | [ "VALIGN", [0, 0], [-1, -1], "MIDDLE" ], 134 | [ "BOTTOMPADDING", [0, 0], [-1, -1], -1 ], 135 | [ "TOPPADDING", [0, 0], [1, 0], 3 ] 136 | ] 137 | }], 138 | [ "endnote", { 139 | "parent": "bodytext", 140 | "colWidths": [52,null], 141 | "spaceAfter": 4, 142 | "commands": [ 143 | [ "VALIGN", [ 0, 0 ], [ -1, -1 ], "TOP" ], 144 | [ "BOTTOMPADDING", [0, 0], [-1, -1], 0 ], 145 | [ "TOPPADDING", [0, 0], [-1, -1], 1 ], 146 | [ "LINEBEFORE", [0, 0], [0,-1], 1, "#E1E6EA" ] 147 | ] 148 | }], 149 | ["extranote" , { 150 | "spaceBefore":0, 151 | "spaceAfter":0, 152 | "colWidths": [27,null], 153 | "commands": [ 154 | [ "VALIGN", [0, 0], [-1, -1], "MIDDLE" ], 155 | [ "BOTTOMPADDING", [0, 0], [-1, -1], -3 ], 156 | [ "BOX", [0, 0], [-1, -1], 0.2, "#446885" ], 157 | [ "COLBACKGROUNDS", [0,0], [-1,-1], ["#446885", "#FFFFFF"]] 158 | ] 159 | }] 160 | ] 161 | } 162 | -------------------------------------------------------------------------------- /rst-cheatsheet.rst: -------------------------------------------------------------------------------- 1 | .. role:: small 2 | 3 | Inline Markup 4 | ------------- 5 | 6 | Inline markup allows words and phrases within text to have character styles (like italics and boldface) and functionality (like hyperlinks). 7 | 8 | +----------------------------------------------------------+------------------------------------------------+ 9 | | :: | | 10 | | | | 11 | | *emphasis* | *emphasis* | 12 | +----------------------------------------------------------+------------------------------------------------+ 13 | | :: | | 14 | | | | 15 | | **strong emphasis** | **strong emphasis** | 16 | +----------------------------------------------------------+------------------------------------------------+ 17 | | :: | The rendering and meaning of interpreted text | 18 | | | is domain- or application-dependent. | 19 | | `interpreted text` | | 20 | +----------------------------------------------------------+------------------------------------------------+ 21 | | :: | | 22 | | | | 23 | | ``inline literal`` | ``inline literal`` | 24 | +----------------------------------------------------------+------------------------------------------------+ 25 | | :: | | 26 | | | | 27 | | reference_ | reference_ | 28 | +----------------------------------------------------------+------------------------------------------------+ 29 | | :: | | 30 | | | | 31 | | `phrase reference`_ | `phrase reference`_ | 32 | +----------------------------------------------------------+------------------------------------------------+ 33 | | :: | | 34 | | | | 35 | | anonymous__ | anonymous__ | 36 | +----------------------------------------------------------+------------------------------------------------+ 37 | | :: | | 38 | | | | 39 | | _`inline internal target` | _`inline internal target` | 40 | +----------------------------------------------------------+------------------------------------------------+ 41 | | :: | The result is substituted in from the | 42 | | | substitution definition. | 43 | | |substitution reference| | | 44 | +----------------------------------------------------------+------------------------------------------------+ 45 | | :: | | 46 | | | | 47 | | footnote reference [1]_ | footnote reference [1]_ | 48 | +----------------------------------------------------------+------------------------------------------------+ 49 | | :: | | 50 | | | | 51 | | citation reference [CIT2002]_ | citation reference [CIT2002]_ | 52 | +----------------------------------------------------------+------------------------------------------------+ 53 | | :: | | 54 | | | | 55 | | http://docutils.sf.net/ | http://docutils.sf.net/ | 56 | +----------------------------------------------------------+------------------------------------------------+ 57 | 58 | __ http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets 59 | 60 | .. _reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets 61 | 62 | .. _phrase reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets 63 | 64 | Escaping with Backslashes 65 | ------------------------- 66 | 67 | reStructuredText uses backslashes ("\\") to override the special meaning given to markup characters and get 68 | the literal characters themselves. To get a literal backslash, use an escaped backslash ("\\\\"). For example: 69 | 70 | +----------------------------------------------------------+------------------------------------------------+ 71 | | :: | | 72 | | | | 73 | | *escape* ``with`` "\" | *escape* ``with`` "\" | 74 | +----------------------------------------------------------+------------------------------------------------+ 75 | | :: | | 76 | | | | 77 | | \*escape* \``with`` "\\" | \*escape* \``with`` "\\" | 78 | +----------------------------------------------------------+------------------------------------------------+ 79 | 80 | Lists 81 | ----- 82 | 83 | +----------------------------------------------------------+------------------------------------------------------+ 84 | | :: | | 85 | | | | 86 | | - This is item 1. A blank line before the first | - This is item 1. A blank line before the first | 87 | | and last items is required. | and last items is required. | 88 | | - This is item 2 | - This is item 2 | 89 | | | | 90 | | - Item 3: blank lines between items are optional. | - Item 3: blank lines between items are optional. | 91 | | - Item 4: Bullets are "-", "*" or "+". | - Item 4: Bullets are "-", "*" or "+". | 92 | | Continuing text must be aligned after the bullet | Continuing text must be aligned after the bullet| 93 | | and whitespace. | and whitespace. | 94 | +----------------------------------------------------------+------------------------------------------------------+ 95 | | :: | | 96 | | | | 97 | | 3. This is the first item | 3. This is the first item | 98 | | 4. This is the second item | 4. This is the second item | 99 | | 5. Enumerators are arabic numbers, | 5. Enumerators are arabic numbers, | 100 | | single letters, or roman numerals | single letters, or roman numerals | 101 | | 6. List items should be sequentially | 6. List items should be sequentially | 102 | | numbered, but need not start at 1 | numbered, but need not start at 1 | 103 | | (although not all formatters will | (although not all formatters will | 104 | | honour the first index). | honour the first index). | 105 | | #. This item is auto-enumerated | #. This item is auto-enumerated | 106 | +----------------------------------------------------------+------------------------------------------------------+ 107 | | :: | | 108 | | | | 109 | | what | what | 110 | | Definition lists associate a term with | Definition lists associate a term with | 111 | | a definition. | a definition. | 112 | | | | 113 | | how | how | 114 | | The term is a one-line phrase, and the | The term is a one-line phrase, and the | 115 | | definition is one or more paragraphs or | definition is one or more paragraphs or | 116 | | body elements, indented relative to the | body elements, indented relative to the | 117 | | term. Blank lines are not allowed | term. Blank lines are not allowed | 118 | | between term and definition. | between term and definition. | 119 | +----------------------------------------------------------+------------------------------------------------------+ 120 | | :: | | 121 | | | | 122 | | :Authors: | :Authors: | 123 | | Tony J. (Tibs) Ibbs, | Tony J. (Tibs) Ibbs, | 124 | | David Goodger | David Goodger | 125 | | | | 126 | | (and sundry other good-natured folks) | (and sundry other good-natured folks) | 127 | | | | 128 | | :Version: 1.0 of 2001/08/08 | :Version: 1.0 of 2001/08/08 | 129 | | :Dedication: To my father. | :Dedication: To my father. | 130 | +----------------------------------------------------------+------------------------------------------------------+ 131 | | :: | | 132 | | | | 133 | | -a command-line option "a" | -a command-line option "a" | 134 | | -b file options can have arguments | -b file options can have arguments | 135 | | and long descriptions | and long descriptions | 136 | | --long options can be long also | --long options can be long also | 137 | | --input=file long options can also have | --input=file long options can also have | 138 | | arguments | arguments | 139 | | /V DOS/VMS-style options too | /V DOS/VMS-style options too | 140 | +----------------------------------------------------------+------------------------------------------------------+ 141 | 142 | .. raw:: pdf 143 | 144 | Spacer 0 72 145 | 146 | Section Structure 147 | ----------------- 148 | 149 | +----------------------------------------------------------+--------------------------------------------------------+ 150 | | :: | | 151 | | | .. class:: faketitle | 152 | | Title | | 153 | | ===== | Title | 154 | | | | 155 | | Titles are underlined (or over- and underlined) with | Titles are underlined (or over- and underlined) with | 156 | | a nonalphanumeric character at least as long as the | a nonalphanumeric character at least as long as the | 157 | | text. | text. | 158 | | | | 159 | | A lone top-level section is lifted up to be the | A lone top-level section is lifted up to be the | 160 | | document's title. | document's title. | 161 | | | | 162 | | Any non-alphanumeric character can be used, but | Any non-alphanumeric character can be used, but | 163 | | Python convention is: | Python convention is: | 164 | | | | 165 | | * ``#`` with overline, for parts | * ``#`` with overline, for parts | 166 | | * ``*`` with overline, for chapters | * ``*`` with overline, for chapters | 167 | | * ``=``, for sections | * ``=``, for sections | 168 | | * ``-``, for subsections | * ``-``, for subsections | 169 | | * ``^``, for subsubsections | * ``^``, for subsubsections | 170 | | * ``"``, for paragraphs | * ``"``, for paragraphs | 171 | +----------------------------------------------------------+--------------------------------------------------------+ 172 | 173 | Blocks 174 | ------ 175 | 176 | +---------------------------------------------------------------+------------------------------------------------------+ 177 | | :: | | 178 | | | | 179 | | This is a paragraph. | This is a paragraph. | 180 | | | | 181 | | Paragraphs line up at their left edges, and are | Paragraphs line up at their left | 182 | | normally separated by blank lines. | edges, and are normally separated | 183 | | | by blank lines. | 184 | +---------------------------------------------------------------+------------------------------------------------------+ 185 | | :: | | 186 | | | | 187 | | A paragraph containing only two colons indicates | A paragraph containing only two colons | 188 | | the following indented or quoted text is a literal | indicates that the following indented | 189 | | block or quoted text is a literal block. | or quoted text is a literal block. | 190 | | | | 191 | | :: | :: | 192 | | | | 193 | | Whitespace, newlines, blank lines, and all kinds of | Whitespace, newlines, blank lines, and | 194 | | markup (like *this* or \this) is preserved here. | all kinds of markup (like *this* or | 195 | | | \this) is preserved by literal blocks. | 196 | | You can also tack the ``::`` at the end of a | | 197 | | paragraph:: | You can also tack the ``::`` at the end of a | 198 | | | paragraph:: | 199 | | It's very convenient to use this form. | | 200 | | | It's very convenient to use this form. | 201 | | Per-line quoting can also be used for unindented | | 202 | | blocks:: | Per-line quoting can also be used for | 203 | | | unindented blocks:: | 204 | | > Useful for quotes from email and | | 205 | | > for Haskell literate programming. | > Useful for quotes from email and | 206 | | | > for Haskell literate programming. | 207 | +---------------------------------------------------------------+------------------------------------------------------+ 208 | | :: | | 209 | | | | 210 | | | Line blocks are useful for addresses, | | Line blocks are useful for addresses, | 211 | | | verse, and adornment-free lists. | | verse, and adornment-free lists. | 212 | | | | | | 213 | | | Each new line begins with a | | Each new line begins with a | 214 | | | vertical bar ("|"). | | vertical bar ("|"). | 215 | | | Line breaks and initial indents | | Line breaks and initial indents | 216 | | | are preserved. | | are preserved. | 217 | | | Continuation lines are wrapped | | Continuation lines are wrapped | 218 | | portions of long lines; they begin | portions of long lines; they begin | 219 | | with spaces in place of vertical bars. | with spaces in place of vertical bars. | 220 | +---------------------------------------------------------------+------------------------------------------------------+ 221 | | :: | | 222 | | | | 223 | | Block quotes are just: | Block quotes are just: | 224 | | | | 225 | | Indented paragraphs, | Indented paragraphs, | 226 | | | | 227 | | and they may nest. | and they may nest. | 228 | +---------------------------------------------------------------+------------------------------------------------------+ 229 | | :: | | 230 | | | | 231 | | Doctest blocks are interactive | Doctest blocks are interactive | 232 | | Python sessions. They begin with | Python sessions. They begin with | 233 | | "``>>>``" and end with a blank line. | "``>>>``" and end with a blank line. | 234 | | | | 235 | | >>> print "This is a doctest block." | >>> print "This is a doctest block." | 236 | | This is a doctest block. | This is a doctest block. | 237 | +---------------------------------------------------------------+------------------------------------------------------+ 238 | | :: | | 239 | | | | 240 | | A transition marker is a horizontal line | A transition marker is a horizontal line | 241 | | of 4 or more repeated punctuation | of 4 or more repeated punctuation | 242 | | characters. | characters. | 243 | | | | 244 | | ------------ | .. class:: faketrans | 245 | | | | 246 | | A transition should not begin or end a | +-----------+ | 247 | | section or document, nor should two | | | | 248 | | transitions be immediately adjacent. | +-----------+ | 249 | | | | 250 | | | | 251 | | | A transition should not begin or end a | 252 | | | section or document, nor should two | 253 | | | transitions be immediately adjacent. | 254 | +---------------------------------------------------------------+------------------------------------------------------+ 255 | 256 | .. raw:: pdf 257 | 258 | PageBreak 259 | 260 | Tables 261 | ------ 262 | 263 | There are two syntaxes for tables in reStructuredText. Grid tables are complete but cumbersome to create. Simple 264 | tables are easy to create but limited (no row spans, etc.). 265 | 266 | +---------------------------------------------------------------+------------------------------------------------------+ 267 | | :: | | 268 | | | .. class:: exampletable1 | 269 | | | | 270 | | +------------+------------+-----------+ | +------------+------------+-----------+ | 271 | | | Header 1 | Header 2 | Header 3 | | | Header 1 | Header 2 | Header 3 | | 272 | | +============+============+===========+ | +============+============+===========+ | 273 | | | body row 1 | column 2 | column 3 | | | body row 1 | column 2 | column 3 | | 274 | | +------------+------------+-----------+ | +------------+------------+-----------+ | 275 | | | body row 2 | Cells may span columns.| | | body row 2 | Cells may span columns.| | 276 | | +------------+------------+-----------+ | +------------+------------+-----------+ | 277 | | | body row 3 | Cells may | - Cells | | | body row 3 | Cells may | - Cells | | 278 | | +------------+ span rows. | - contain | | +------------+ span rows. | - contain | | 279 | | | body row 4 | | - blocks. | | | body row 4 | | - blocks. | | 280 | | +------------+------------+-----------+ | +------------+------------+-----------+ | 281 | +---------------------------------------------------------------+------------------------------------------------------+ 282 | | :: | | 283 | | | .. class:: exampletable1 | 284 | | | | 285 | | ===== ===== ====== | ===== ===== ====== | 286 | | Inputs Output | Inputs Output | 287 | | ------------ ------ | ------------ ------ | 288 | | A B A or B | A B A or B | 289 | | ===== ===== ====== | ===== ===== ====== | 290 | | False False False | False False False | 291 | | True False True | True False True | 292 | | False True True | False True True | 293 | | True True True | True True True | 294 | | ===== ===== ====== | ===== ===== ====== | 295 | +---------------------------------------------------------------+------------------------------------------------------+ 296 | 297 | Explicit Markup 298 | --------------- 299 | 300 | Explicit markup blocks are used for constructs which float (footnotes), have no direct paper-document representation 301 | (hyperlink targets, comments), or require specialized processing (directives). 302 | They all begin with two periods and whitespace, the "explicit markup start". 303 | 304 | +---------------------------------------------------------------+-------------------------------------------------------------+ 305 | | :: | | 306 | | | | 307 | | Footnote references, like [5]_. | Footnote references, like [5]_. | 308 | | Note that footnotes may get | Note that footnotes may get | 309 | | rearranged, e.g., to the bottom of | rearranged, e.g., to the bottom of | 310 | | the "page". | the "page". | 311 | | | | 312 | | .. [5] A numerical footnote. Note | .. [5] A numerical footnote. Note | 313 | | there's no colon after the ``]``. | there's no colon after the ``]``. | 314 | +---------------------------------------------------------------+-------------------------------------------------------------+ 315 | | :: | | 316 | | | | 317 | | Autonumbered footnotes are | Autonumbered footnotes are | 318 | | possible, like using [#]_ and [#]_. | possible, like using [#]_ and [#]_. | 319 | | | | 320 | | .. [#] This is the first one. | .. [#] This is the first one. | 321 | | .. [#] This is the second one. | .. [#] This is the second one. | 322 | | | | 323 | | They may be assigned 'autonumber | They may be assigned 'autonumber | 324 | | labels' - for instance, | labels' - for instance, | 325 | | [#fourth]_ and [#third]_. | [#fourth]_ and [#third]_. | 326 | | | | 327 | | .. [#third] a.k.a. third_ | .. [#third] a.k.a. third_ | 328 | | | | 329 | | .. [#fourth] a.k.a. fourth_ | .. [#fourth] a.k.a. fourth_ | 330 | +---------------------------------------------------------------+-------------------------------------------------------------+ 331 | | :: | | 332 | | | | 333 | | Auto-symbol footnotes are also | Auto-symbol footnotes are also | 334 | | possible, like this: [*]_ and [*]_. | possible, like this: [*]_ and [*]_. | 335 | | | | 336 | | .. [*] This is the first one. | .. [*] This is the first one. | 337 | | .. [*] This is the second one. | .. [*] This is the second one. | 338 | +---------------------------------------------------------------+-------------------------------------------------------------+ 339 | | :: | | 340 | | | | 341 | | Citation references, like [CIT2002]_. | Citation references, like [CIT2002]_. | 342 | | Note that citations may get | Note that citations may get | 343 | | rearranged, e.g., to the bottom of | rearranged, e.g., to the bottom of | 344 | | the "page". | the "page". | 345 | | | | 346 | | .. [CIT2002] A citation | .. [CIT2002] A citation | 347 | | (as often used in journals). | (as often used in journals). | 348 | | | | 349 | | Citation labels contain alphanumerics, | Citation labels contain alphanumerics, | 350 | | underlines, hyphens and fullstops. | underlines, hyphens and fullstops. | 351 | | Case is not significant. | Case is not significant. | 352 | | | | 353 | | Given a citation like [this]_, one | Given a citation like [this]_, one | 354 | | can also refer to it like this_. | can also refer to it like this_. | 355 | | | | 356 | | .. [this] here. | .. [this] here. | 357 | +---------------------------------------------------------------+-------------------------------------------------------------+ 358 | | :: | | 359 | | | | 360 | | External hyperlinks, like Python_. | External hyperlinks, like Python_. | 361 | | | | 362 | | .. _Python: http://www.python.org/ | .. _Python: http://www.python.org/ | 363 | +---------------------------------------------------------------+-------------------------------------------------------------+ 364 | | :: | | 365 | | | | 366 | | External hyperlinks, like `Python | External hyperlinks, like `Python | 367 | | `_. | `_. | 368 | +---------------------------------------------------------------+-------------------------------------------------------------+ 369 | | :: | | 370 | | | | 371 | | Internal crossreferences, like example_. | Internal crossreferences, like example_. | 372 | | | | 373 | | .. _example: | .. _example: | 374 | | | | 375 | | This is an example crossreference target. | This is an example crossreference target. | 376 | +---------------------------------------------------------------+-------------------------------------------------------------+ 377 | | :: | | 378 | | | | 379 | | Python_ is `my favourite | Python_ is `my favourite | 380 | | programming language`__. | programming language`__. | 381 | | | | 382 | | .. _Python: http://www.python.org/ | .. _Python: http://www.python.org/ | 383 | | | | 384 | | __ Python_ | __ Python_ | 385 | +---------------------------------------------------------------+-------------------------------------------------------------+ 386 | | :: | .. _titles are targets, too: | 387 | | | .. class:: faketitle | 388 | | Titles are targets, too | | 389 | | ======================= | Titles are targets, too | 390 | | | | 391 | | Implict references, like `Titles are targets, too`_. | Implict references, like | 392 | | | `Titles are targets, too`_. | 393 | +---------------------------------------------------------------+-------------------------------------------------------------+ 394 | | | 395 | |Directives are a general-purpose extension mechanism, a way of adding support for new constructs without adding | 396 | |new syntax. For a description of all standard directives, see reStructuredText Directives (http://is.gd/2Ecqh). | 397 | | | 398 | +---------------------------------------------------------------+-------------------------------------------------------------+ 399 | | :: | | 400 | | | | 401 | | For instance: | For instance: | 402 | | | | 403 | | .. image:: magnetic-balls.jpg | .. image:: magnetic-balls.jpg | 404 | | :width: 40pt | :width: 40pt | 405 | | | | 406 | +---------------------------------------------------------------+-------------------------------------------------------------+ 407 | | | 408 | | | 409 | | Substitutions are like inline directives, allowing graphics and arbitrary constructs within text. | 410 | | | 411 | +---------------------------------------------------------------+-------------------------------------------------------------+ 412 | | :: | | 413 | | | | 414 | | The |biohazard| symbol must be used on containers used to | The |biohazard| symbol must be used on containers used to | 415 | | dispose of medical waste. | dispose of medical waste. | 416 | | | | 417 | | .. |biohazard| image:: biohazard.png | .. |biohazard| image:: biohazard.png | 418 | | :align: middle | :align: middle | 419 | | :width: 12 | :width: 12 | 420 | +---------------------------------------------------------------+-------------------------------------------------------------+ 421 | | | 422 | | Any text which begins with an explicit markup start but doesn't use the syntax of any of the constructs above, is a comment.| 423 | | | 424 | +---------------------------------------------------------------+-------------------------------------------------------------+ 425 | | :: | | 426 | | | | 427 | | .. This text will not be shown | .. This text will not be shown | 428 | | (but, for instance, in HTML might be | (but, for instance, in HTML might be | 429 | | rendered as an HTML comment) | rendered as an HTML comment) | 430 | +---------------------------------------------------------------+-------------------------------------------------------------+ 431 | | :: | | 432 | | | | 433 | | An "empty comment" does not | An "empty comment" does not | 434 | | consume following blocks. | consume following blocks. | 435 | | (An empty comment is ".." with | (An empty comment is ".." with | 436 | | blank lines before and after.) | blank lines before and after.) | 437 | | | | 438 | | .. | .. | 439 | | | | 440 | | So this block is not "lost", | So this block is not "lost", | 441 | | despite its indentation. | despite its indentation. | 442 | +---------------------------------------------------------------+-------------------------------------------------------------+ 443 | 444 | Credits 445 | ------- 446 | 447 | .. class:: tablacreditos 448 | 449 | +---------------------------------------+-------------------------------------------------------+ 450 | | CP Font from LiquiType: | http://www.liquitype.com/workshop/type_design/cp-mono | 451 | +---------------------------------------+-------------------------------------------------------+ 452 | | Magnetic Balls V2 image by fdecomite: | http://www.flickr.com/photos/fdecomite/2926556794/ | 453 | +---------------------------------------+-------------------------------------------------------+ 454 | | Sponsored by Net Managers | http://www.netmanagers.com.ar | 455 | +---------------------------------------+-------------------------------------------------------+ 456 | | Typeset using rst2pdf | http://rst2pdf.googlecode.com | 457 | +---------------------------------------+-------------------------------------------------------+ 458 | 459 | 460 | .. footer:: 461 | 462 | .. class:: tablapie 463 | 464 | +-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+----------------------------------+-----------------------------------+ 465 | | |copy| :small:`2009 Roberto Alsina / Creative Commons Attribution-Noncommercial-Share Alike 2.5 Argentina License` | |attrib| :small:`Based on quickref.txt from docutils` | |noncomm| :small:`Non-Commercial`| |sharealike| :small:`Share Alike` | 466 | +-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+----------------------------------+-----------------------------------+ 467 | 468 | .. |attrib| image:: attrib.png 469 | :width: 8pt 470 | :align: middle 471 | 472 | .. |noncomm| image:: noncomm.png 473 | :width: 8pt 474 | :align: middle 475 | 476 | .. |sharealike| image:: sharealike.png 477 | :width: 8pt 478 | :align: middle 479 | 480 | .. |copy| unicode:: U+000A9 481 | --------------------------------------------------------------------------------