| 20 | 20 | [16, u"A First Level Header\r\n====================\r\n\r\nA Second Level Header\r\n---------------------\r\n\r\nNow is the time for all good men to come to\r\nthe aid of their country. This is just a\r\nregular paragraph.\r\n\r\nThe quick brown fox jumped over the lazy\r\ndog's back.\r\n\r\n### Header 3\r\n\r\n> This is a blockquote.\r\n> \r\n> This is the second paragraph in the blockquote.\r\n>\r\n> ## This is an H2 in a blockquote", 13, 0, u'Markdown', u'Markdown', u'', 1, 1, 4, u'', u'', '2007-06-26 01:38:42', '2007-06-26 01:38:42', 1, 1, True, True, None, None] |
| 21 | 21 | [17, u'A ReStructuredText Primer\r\n=========================\r\n\r\n:Author: Richard Jones\r\n:Version: $Revision: 4350 $\r\n:Copyright: This document has been placed in the public domain.\r\n\r\n.. contents::\r\n\r\n\r\nThe text below contains links that look like "(quickref__)". These\r\nare relative links that point to the `Quick reStructuredText`_ user\r\nreference. If these links don\'t work, please refer to the `master\r\nquick reference`_ document.\r\n\r\n__\r\n.. _Quick reStructuredText: quickref.html\r\n.. _master quick reference:\r\n http://docutils.sourceforge.net/docs/user/rst/quickref.html\r\n\r\n\r\nStructure\r\n---------\r\n\r\nFrom the outset, let me say that "Structured Text" is probably a bit\r\nof a misnomer. It\'s more like "Relaxed Text" that uses certain\r\nconsistent patterns. These patterns are interpreted by a HTML\r\nconverter to produce "Very Structured Text" that can be used by a web\r\nbrowser.\r\n\r\nThe most basic pattern recognised is a **paragraph** (quickref__).\r\nThat\'s a chunk of text that is separated by blank lines (one is\r\nenough). Paragraphs must have the same indentation -- that is, line\r\nup at their left edge. Paragraphs that start indented will result in\r\nindented quote paragraphs. For example::\r\n\r\n This is a paragraph. It\'s quite\r\n short.\r\n\r\n This paragraph will result in an indented block of\r\n text, typically used for quoting other text.\r\n\r\n This is another one.\r\n\r\nResults in:\r\n\r\n This is a paragraph. It\'s quite\r\n short.\r\n\r\n This paragraph will result in an indented block of\r\n text, typically used for quoting other text.\r\n\r\n This is another one.\r\n\r\n__ quickref.html#paragraphs\r\n\r\n\r\nText styles\r\n-----------\r\n\r\n(quickref__)\r\n\r\n__ quickref.html#inline-markup\r\n\r\nInside paragraphs and other bodies of text, you may additionally mark\r\ntext for *italics* with "``*italics*``" or **bold** with\r\n"``**bold**``".\r\n\r\nIf you want something to appear as a fixed-space literal, use\r\n"````double back-quotes````". Note that no further fiddling is done\r\ninside the double back-quotes -- so asterisks "``*``" etc. are left\r\nalone.\r\n\r\nIf you find that you want to use one of the "special" characters in\r\ntext, it will generally be OK -- reStructuredText is pretty smart.\r\nFor example, this * asterisk is handled just fine. If you actually\r\nwant text \\*surrounded by asterisks* to **not** be italicised, then\r\nyou need to indicate that the asterisk is not special. You do this by\r\nplacing a backslash just before it, like so "``\\*``" (quickref__), or\r\nby enclosing it in double back-quotes (inline literals), like this::\r\n\r\n ``\\*``\r\n\r\n__ quickref.html#escaping\r\n\r\n\r\nLists\r\n-----\r\n\r\nLists of items come in three main flavours: **enumerated**,\r\n**bulleted** and **definitions**. In all list cases, you may have as\r\nmany paragraphs, sublists, etc. as you want, as long as the left-hand\r\nside of the paragraph or whatever aligns with the first line of text\r\nin the list item.\r\n\r\nLists must always start a new paragraph -- that is, they must appear\r\nafter a blank line.\r\n\r\n**enumerated** lists (numbers, letters or roman numerals; quickref__)\r\n __ quickref.html#enumerated-lists\r\n\r\n Start a line off with a number or letter followed by a period ".",\r\n right bracket ")" or surrounded by brackets "( )" -- whatever you\'re\r\n comfortable with. All of the following forms are recognised::\r\n\r\n 1. numbers\r\n\r\n A. upper-case letters\r\n and it goes over many lines\r\n\r\n with two paragraphs and all!\r\n\r\n a. lower-case letters\r\n\r\n 3. with a sub-list starting at a different number\r\n 4. make sure the numbers are in the correct sequence though!\r\n\r\n I. upper-case roman numerals\r\n\r\n i. lower-case roman numerals\r\n\r\n (1) numbers again\r\n\r\n 1) and again\r\n\r\n Results in (note: the different enumerated list styles are not\r\n always supported by every web browser, so you may not get the full\r\n effect here):\r\n\r\n 1. numbers\r\n\r\n A. upper-case letters\r\n and it goes over many lines\r\n\r\n with two paragraphs and all!\r\n\r\n a. lower-case letters\r\n\r\n 3. with a sub-list starting at a different number\r\n 4. make sure the numbers are in the correct sequence though!\r\n\r\n I. upper-case roman numerals\r\n\r\n i. lower-case roman numerals\r\n\r\n (1) numbers again\r\n\r\n 1) and again\r\n\r\n**bulleted** lists (quickref__)\r\n __ quickref.html#bullet-lists\r\n\r\n Just like enumerated lists, start the line off with a bullet point\r\n character - either "-", "+" or "*"::\r\n\r\n * a bullet point using "*"\r\n\r\n - a sub-list using "-"\r\n\r\n + yet another sub-list\r\n\r\n - another item\r\n\r\n Results in:\r\n\r\n * a bullet point using "*"\r\n\r\n - a sub-list using "-"\r\n\r\n + yet another sub-list\r\n\r\n - another item\r\n\r\n**definition** lists (quickref__)\r\n __ quickref.html#definition-lists\r\n\r\n Unlike the other two, the definition lists consist of a term, and\r\n the definition of that term. The format of a definition list is::\r\n\r\n what\r\n Definition lists associate a term with a definition.\r\n\r\n *how*\r\n The term is a one-line phrase, and the definition is one or more\r\n paragraphs or body elements, indented relative to the term.\r\n Blank lines are not allowed between term and definition.\r\n\r\n Results in:\r\n\r\n what\r\n Definition lists associate a term with a definition.\r\n\r\n *how*\r\n The term is a one-line phrase, and the definition is one or more\r\n paragraphs or body elements, indented relative to the term.\r\n Blank lines are not allowed between term and definition.\r\n\r\n\r\nPreformatting (code samples)\r\n----------------------------\r\n(quickref__)\r\n\r\n__ quickref.html#literal-blocks\r\n\r\nTo just include a chunk of preformatted, never-to-be-fiddled-with\r\ntext, finish the prior paragraph with "``::``". The preformatted\r\nblock is finished when the text falls back to the same indentation\r\nlevel as a paragraph prior to the preformatted block. For example::\r\n\r\n An example::\r\n\r\n Whitespace, newlines, blank lines, and all kinds of markup\r\n (like *this* or \\this) is preserved by literal blocks.\r\n Lookie here, I\'ve dropped an indentation level\r\n (but not far enough)\r\n\r\n no more example\r\n\r\nResults in:\r\n\r\n An example::\r\n\r\n Whitespace, newlines, blank lines, and all kinds of markup\r\n (like *this* or \\this) is preserved by literal blocks.\r\n Lookie here, I\'ve dropped an indentation level\r\n (but not far enough)\r\n\r\n no more example\r\n\r\nNote that if a paragraph consists only of "``::``", then it\'s removed\r\nfrom the output::\r\n\r\n ::\r\n\r\n This is preformatted text, and the\r\n last "::" paragraph is removed\r\n\r\nResults in:\r\n\r\n::\r\n\r\n This is preformatted text, and the\r\n last "::" paragraph is removed\r\n\r\n\r\nSections\r\n--------\r\n\r\n(quickref__)\r\n\r\n__ quickref.html#section-structure\r\n\r\nTo break longer text up into sections, you use **section headers**.\r\nThese are a single line of text (one or more words) with adornment: an\r\nunderline alone, or an underline and an overline together, in dashes\r\n"``-----``", equals "``======``", tildes "``~~~~~~``" or any of the\r\nnon-alphanumeric characters ``= - ` : \' " ~ ^ _ * + # < >`` that you\r\nfeel comfortable with. An underline-only adornment is distinct from\r\nan overline-and-underline adornment using the same character. The\r\nunderline/overline must be at least as long as the title text. Be\r\nconsistent, since all sections marked with the same adornment style\r\nare deemed to be at the same level::\r\n\r\n Chapter 1 Title\r\n ===============\r\n\r\n Section 1.1 Title\r\n -----------------\r\n\r\n Subsection 1.1.1 Title\r\n ~~~~~~~~~~~~~~~~~~~~~~\r\n\r\n Section 1.2 Title\r\n -----------------\r\n\r\n Chapter 2 Title\r\n ===============\r\n\r\nThis results in the following structure, illustrated by simplified\r\npseudo-XML::\r\n\r\n <section>\r\n <title>\r\n Chapter 1 Title\r\n <section>\r\n <title>\r\n Section 1.1 Title\r\n <section>\r\n <title>\r\n Subsection 1.1.1 Title\r\n <section>\r\n <title>\r\n Section 1.2 Title\r\n <section>\r\n <title>\r\n Chapter 2 Title\r\n\r\n(Pseudo-XML uses indentation for nesting and has no end-tags. It\'s\r\nnot possible to show actual processed output, as in the other\r\nexamples, because sections cannot exist inside block quotes. For a\r\nconcrete example, compare the section structure of this document\'s\r\nsource text and processed output.)\r\n\r\nNote that section headers are available as link targets, just using\r\ntheir name. To link to the Lists_ heading, I write "``Lists_``". If\r\nthe heading has a space in it like `text styles`_, we need to quote\r\nthe heading "```text styles`_``".\r\n\r\n\r\nDocument Title / Subtitle\r\n`````````````````````````\r\n\r\nThe title of the whole document is distinct from section titles and\r\nmay be formatted somewhat differently (e.g. the HTML writer by default\r\nshows it as a centered heading).\r\n\r\nTo indicate the document title in reStructuredText, use a unique adornment\r\nstyle at the beginning of the document. To indicate the document subtitle,\r\nuse another unique adornment style immediately after the document title. For\r\nexample::\r\n\r\n ================\r\n Document Title\r\n ================\r\n ----------\r\n Subtitle\r\n ----------\r\n\r\n Section Title\r\n =============\r\n\r\n ...\r\n\r\nNote that "Document Title" and "Section Title" above both use equals\r\nsigns, but are distict and unrelated styles. The text of\r\noverline-and-underlined titles (but not underlined-only) may be inset\r\nfor aesthetics.\r\n\r\n\r\nImages\r\n------\r\n\r\n(quickref__)\r\n\r\n__ quickref.html#directives\r\n\r\nTo include an image in your document, you use the the ``image`` directive__.\r\nFor example::\r\n\r\n .. image:: images/biohazard.png\r\n\r\nresults in:\r\n\r\n.. image:: images/biohazard.png\r\n\r\nThe ``images/biohazard.png`` part indicates the filename of the image\r\nyou wish to appear in the document. There\'s no restriction placed on\r\nthe image (format, size etc). If the image is to appear in HTML and\r\nyou wish to supply additional information, you may::\r\n\r\n .. image:: images/biohazard.png\r\n :height: 100\r\n :width: 200\r\n :scale: 50\r\n :alt: alternate text\r\n\r\nSee the full `image directive documentation`__ for more info.\r\n\r\n__ ../../ref/rst/directives.html\r\n__ ../../ref/rst/directives.html#images\r\n\r\n\r\nWhat Next?\r\n----------\r\n\r\nThis primer introduces the most common features of reStructuredText,\r\nbut there are a lot more to explore. The `Quick reStructuredText`_\r\nuser reference is a good place to go next. For complete details, the\r\n`reStructuredText Markup Specification`_ is the place to go [#]_.\r\n\r\nUsers who have questions or need assistance with Docutils or\r\nreStructuredText should post a message to the Docutils-users_ mailing\r\nlist.\r\n\r\n.. [#] If that relative link doesn\'t work, try the master document:\r\n http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.\r\n\r\n.. _reStructuredText Markup Specification:\r\n ../../ref/rst/restructuredtext.html\r\n.. _Docutils-users: ../mailing-lists.html#docutils-users\r\n.. _Docutils project web site: http://docutils.sourceforge.net/\r\n', 13, 0, u'reStructuredText', u'ReStructuredText', u'', 1, 1, 5, u'', u'', '2007-06-26 01:42:59', '2007-06-26 01:42:59', 1, 1, True, True, None, None] |
