Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Moar.

  • Loading branch information...
commit 08b9b9ecadea763af6335a3c13c304c69a6f2578 1 parent 327f27d
Steve Losh authored September 25, 2012
1  bin/ffind
1  dotcss/amara.readthedocs.org.css
8  dotcss/readthedocs.org.css
... ...
@@ -0,0 +1,8 @@
  1
+span.pre {
  2
+    padding: 1px 4px;
  3
+    border: 1px solid #ccc;
  4
+    border-radius: 2px;
  5
+    background: #f5f5f5;
  6
+    font-family: Menlo, Monaco, monospaced;
  7
+    font-size: 14px;
  8
+}
BIN  moom/com.manytricks.Moom.plist
Binary file not shown
374  vim/bundle/restdammit/doc/restdammit.txt
... ...
@@ -0,0 +1,374 @@
  1
+restdammit.txt   A ReStructuredText Primer
  2
+
  3
+==============================================================================
  4
+CONTENTS                                                 *restdammit-contents*
  5
+
  6
+    1. Intro .......................... |rest-intro|
  7
+
  8
+==============================================================================
  9
+0. Quick Reference                                                  *rest-ref*
  10
+
  11
+Taken from http://docutils.sourceforge.net/docs/user/rst/quickref.html
  12
+
  13
+Inline Markup: >
  14
+
  15
+    *emphasis*                    Normally rendered as italics.
  16
+    **strong emphasis**           Normally rendered as boldface.
  17
+    `interpreted text`            The rendering and meaning of interpreted text
  18
+                                  is domain- or application-dependent. It can
  19
+                                  be used for things like index entries or
  20
+                                  explicit descriptive markup (like program
  21
+                                  identifiers).
  22
+    ``inline literal``            Normally rendered as monospaced text. Spaces
  23
+                                  should be preserved, but line breaks will
  24
+                                  not be.
  25
+    reference_                    A simple, one-word hyperlink reference.
  26
+    `phrase reference`_           A hyperlink reference with spaces or
  27
+                                  punctuation needs to be quoted with
  28
+                                  backquotes.
  29
+    anonymous__                   With two underscores instead of one, both
  30
+                                  simple and phrase references may be
  31
+                                  anonymous (the reference text is not
  32
+                                  repeated at the target).
  33
+    _`inline internal target`     A crossreference target within text.
  34
+    |substitution reference|      The result is substituted in from the
  35
+                                  substitution definition. It could be text,
  36
+                                  an image, a hyperlink, or a combination of
  37
+                                  these and others.
  38
+    footnote reference [1]_       Footnote reference.
  39
+    citation reference [CIT2002]_ Citation Reference
  40
+    http://docutils.sf.net/       A standalone hyperlink.
  41
+
  42
+External links: >
  43
+
  44
+    External hyperlinks, like Python_.
  45
+
  46
+    .. _Python: http://www.python.org/
  47
+
  48
+==============================================================================
  49
+1. Intro                                                          *rest-intro*
  50
+
  51
+This document was taken from
  52
+http://docutils.sourceforge.net/docs/user/rst/quickstart.txt
  53
+and manually converted to Vim's help format.
  54
+
  55
+==============================================================================
  56
+2. Structure                                                  *rest-structure*
  57
+
  58
+From the outset, let me say that "Structured Text" is probably a bit of
  59
+a misnomer.  It's more like "Relaxed Text" that uses certain consistent
  60
+patterns.  These patterns are interpreted by a HTML converter to produce "Very
  61
+Structured Text" that can be used by a web browser.
  62
+
  63
+The most basic pattern recognised is a **paragraph**.  That's a chunk of text
  64
+that is separated by blank lines (one is enough).  Paragraphs must have the
  65
+same indentation -- that is, line up at their left edge.  Paragraphs that
  66
+start indented will result in indented quote paragraphs. For example: >
  67
+
  68
+  This is a paragraph.  It's quite
  69
+  short.
  70
+
  71
+     This paragraph will result in an indented block of
  72
+     text, typically used for quoting other text.
  73
+
  74
+  This is another one.
  75
+
  76
+Results in: >
  77
+
  78
+  This is a paragraph.  It's quite
  79
+  short.
  80
+
  81
+     This paragraph will result in an indented block of
  82
+     text, typically used for quoting other text.
  83
+
  84
+  This is another one.
  85
+
  86
+==============================================================================
  87
+3. Text styles                                                   *rest-styles*
  88
+
  89
+Inside paragraphs and other bodies of text, you may additionally mark text for
  90
+italics with "*italics*" or bold with "**bold**".  This is called "inline
  91
+markup".
  92
+
  93
+If you want something to appear as a fixed-space literal, use "``double
  94
+back-quotes``".  Note that no further fiddling is done inside the double
  95
+back-quotes -- so asterisks "*" etc. are left alone.
  96
+
  97
+If you find that you want to use one of the "special" characters in text, it
  98
+will generally be OK -- reStructuredText is pretty smart.  For example, this
  99
+lone asterisk * is handled just fine, as is the asterisk in this equation:
  100
+5*6=30.  If you actually want text \*surrounded by asterisks* to not be
  101
+italicised, then you need to indicate that the asterisk is not special.  You
  102
+do this by placing a backslash just before it, like so "\*", or by enclosing
  103
+it in double back-quotes (inline literals), like this: >
  104
+
  105
+  ``*``
  106
+
  107
+==============================================================================
  108
+4. Lists                                                          *rest-lists*
  109
+
  110
+Lists of items come in three main flavours: enumerated, bulleted and
  111
+definitions.  In all list cases, you may have as many paragraphs, sublists,
  112
+etc. as you want, as long as the left-hand side of the paragraph or whatever
  113
+aligns with the first line of text in the list item.
  114
+
  115
+Lists must always start a new paragraph -- that is, they must appear
  116
+after a blank line.
  117
+
  118
+------------------------------------------------------------------------------
  119
+4.1 Enumerated Lists                                         *rest-lists-enum*
  120
+
  121
+Start a line off with a number or letter followed by a period ".", right
  122
+bracket ")" or surrounded by brackets "( )" -- whatever you're comfortable
  123
+with.  All of the following forms are recognised: >
  124
+
  125
+  1. numbers
  126
+
  127
+  A. upper-case letters
  128
+     and it goes over many lines
  129
+
  130
+     with two paragraphs and all!
  131
+
  132
+  a. lower-case letters
  133
+
  134
+     3. with a sub-list starting at a different number
  135
+     4. make sure the numbers are in the correct sequence though!
  136
+
  137
+  I. upper-case roman numerals
  138
+
  139
+  i. lower-case roman numerals
  140
+
  141
+  (1) numbers again
  142
+
  143
+  1) and again
  144
+
  145
+Results in (note: the different enumerated list styles are not always
  146
+supported by every web browser, so you may not get the full effect here): >
  147
+
  148
+  1. numbers
  149
+
  150
+  A. upper-case letters
  151
+     and it goes over many lines
  152
+
  153
+     with two paragraphs and all!
  154
+
  155
+  a. lower-case letters
  156
+
  157
+     3. with a sub-list starting at a different number
  158
+     4. make sure the numbers are in the correct sequence though!
  159
+
  160
+  I. upper-case roman numerals
  161
+
  162
+  i. lower-case roman numerals
  163
+
  164
+  (1) numbers again
  165
+
  166
+  1) and again
  167
+
  168
+------------------------------------------------------------------------------
  169
+4.2 Bulleted Lists                                           *rest-lists-bull*
  170
+
  171
+Just like enumerated lists, start the line off with a bullet point character
  172
+- either "-", "+" or "*": >
  173
+
  174
+  * a bullet point using "*"
  175
+
  176
+    - a sub-list using "-"
  177
+
  178
+      + yet another sub-list
  179
+
  180
+    - another item
  181
+
  182
+Results in: >
  183
+
  184
+  * a bullet point using "*"
  185
+
  186
+    - a sub-list using "-"
  187
+
  188
+      + yet another sub-list
  189
+
  190
+    - another item
  191
+
  192
+------------------------------------------------------------------------------
  193
+4.3 Definition Lists                                          *rest-lists-def*
  194
+
  195
+Unlike the other two, the definition lists consist of a term, and
  196
+the definition of that term.  The format of a definition list is: >
  197
+
  198
+  what
  199
+    Definition lists associate a term with a definition.
  200
+
  201
+  *how*
  202
+    The term is a one-line phrase, and the definition is one or more
  203
+    paragraphs or body elements, indented relative to the term.
  204
+    Blank lines are not allowed between term and definition.
  205
+
  206
+Results in: >
  207
+
  208
+  what
  209
+    Definition lists associate a term with a definition.
  210
+
  211
+  *how*
  212
+    The term is a one-line phrase, and the definition is one or more
  213
+    paragraphs or body elements, indented relative to the term.
  214
+    Blank lines are not allowed between term and definition.
  215
+
  216
+
  217
+==============================================================================
  218
+5. Preformatting                                                   *rest-code*
  219
+
  220
+To just include a chunk of preformatted, never-to-be-fiddled-with text, finish
  221
+the prior paragraph with "::".  The preformatted block is finished when the
  222
+text falls back to the same indentation level as a paragraph prior to the
  223
+preformatted block.  For example: >
  224
+
  225
+  An example::
  226
+
  227
+      Whitespace, newlines, blank lines, and all kinds of markup
  228
+        (like *this* or \this) is preserved by literal blocks.
  229
+    Lookie here, I've dropped an indentation level
  230
+    (but not far enough)
  231
+
  232
+  no more example
  233
+
  234
+Results in: >
  235
+
  236
+  An example::
  237
+
  238
+      Whitespace, newlines, blank lines, and all kinds of markup
  239
+        (like *this* or \this) is preserved by literal blocks.
  240
+    Lookie here, I've dropped an indentation level
  241
+    (but not far enough)
  242
+
  243
+  no more example
  244
+
  245
+Note that if a paragraph consists only of "::", then it's removed from the
  246
+output: >
  247
+
  248
+  ::
  249
+
  250
+      This is preformatted text, and the
  251
+      last "::" paragraph is removed
  252
+
  253
+Results in: >
  254
+
  255
+    This is preformatted text, and the
  256
+    last "::" paragraph is removed
  257
+
  258
+==============================================================================
  259
+6. Sections                                                    *rest-sections*
  260
+
  261
+To break longer text up into sections, you use section headers.  These are
  262
+a single line of text (one or more words) with adornment:
  263
+
  264
+    1. an underline alone
  265
+    2. an underline and an overline together
  266
+
  267
+in:
  268
+
  269
+    1. dashes "------"
  270
+    2. equals "======"
  271
+    3. tildes "~~~~~~"
  272
+    4. any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < >
  273
+
  274
+An underline-only adornment is distinct from an overline-and-underline
  275
+adornment using the same character.  The underline/overline must be at least
  276
+as long as the title text.  Be consistent, since all sections marked with the
  277
+same adornment style are deemed to be at the same level: >
  278
+
  279
+  Chapter 1 Title
  280
+  ===============
  281
+
  282
+  Section 1.1 Title
  283
+  -----------------
  284
+
  285
+  Subsection 1.1.1 Title
  286
+  ~~~~~~~~~~~~~~~~~~~~~~
  287
+
  288
+  Section 1.2 Title
  289
+  -----------------
  290
+
  291
+  Chapter 2 Title
  292
+  ===============
  293
+
  294
+This results in the following structure, illustrated by simplified
  295
+pseudo-XML: >
  296
+
  297
+  <section>
  298
+      <title>
  299
+          Chapter 1 Title
  300
+      <section>
  301
+          <title>
  302
+              Section 1.1 Title
  303
+          <section>
  304
+              <title>
  305
+                  Subsection 1.1.1 Title
  306
+      <section>
  307
+          <title>
  308
+              Section 1.2 Title
  309
+  <section>
  310
+      <title>
  311
+          Chapter 2 Title
  312
+
  313
+(Pseudo-XML uses indentation for nesting and has no end-tags.  It's not
  314
+possible to show actual processed output, as in the other examples, because
  315
+sections cannot exist inside block quotes.  For a concrete example, compare
  316
+the section structure of this document's source text and processed output.)
  317
+
  318
+Note that section headers are available as link targets, just using their
  319
+name.  To link to the Lists heading, I write "Lists_".  If the heading has
  320
+a space in it like "text styles", we need to quote
  321
+the heading "`text styles`_".
  322
+
  323
+------------------------------------------------------------------------------
  324
+6.1 Document Title / Subtitle                                     *rest-title*
  325
+
  326
+The title of the whole document is distinct from section titles and may be
  327
+formatted somewhat differently (e.g. the HTML writer by default shows it as
  328
+a centered heading).
  329
+
  330
+To indicate the document title in reStructuredText, use a unique adornment
  331
+style at the beginning of the document.  To indicate the document subtitle,
  332
+use another unique adornment style immediately after the document title.  For
  333
+example: >
  334
+
  335
+  ================
  336
+   Document Title
  337
+  ================
  338
+  ----------
  339
+   Subtitle
  340
+  ----------
  341
+
  342
+  Section Title
  343
+  =============
  344
+
  345
+  ...
  346
+
  347
+Note that "Document Title" and "Section Title" above both use equals signs,
  348
+but are distict and unrelated styles.  The text of overline-and-underlined
  349
+titles (but not underlined-only) may be inset for aesthetics.
  350
+
  351
+==============================================================================
  352
+7.0 Images                               *rest-images* *rest-image* *rest-img*
  353
+
  354
+To include an image in your document, you use the the image directive.
  355
+For example: >
  356
+
  357
+  .. image:: images/biohazard.png
  358
+
  359
+results in: >
  360
+
  361
+  <img src="images/biohazarg.png"/>
  362
+
  363
+The "images/biohazard.png" part indicates the filename of the image you wish
  364
+to appear in the document. There's no restriction placed on the image (format,
  365
+size etc).  If the image is to appear in HTML and you wish to supply
  366
+additional information, you may: >
  367
+
  368
+  .. image:: images/biohazard.png
  369
+     :height: 100
  370
+     :width: 200
  371
+     :scale: 50
  372
+     :alt: alternate text
  373
+
  374
+See the full image directive documentation for more info.

0 notes on commit 08b9b9e

Please sign in to comment.
Something went wrong with that request. Please try again.