Views
Restructured Text
The following will serve as a quick start guide to editing with reStructured Text (reST), an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. For more detailed information please see the quick reStructuredText documentation written by David Goodger.
Inline Markup
| Plain Text | Desired Result | Notes |
|---|---|---|
| *italics* | italics | Single asterisks surrounding text |
| **bold** | bold | Double asterisks surrounding text |
| ``inline monospace`` | inline monospace | Double backticks surrounding text |
Linking
Link to Existing Wiki Page
Create a New Wiki Page
Label a link to a Wiki Page
Insert an internal link (standard webpage on mifos.org)
Insert an external link (page outside of mifos.org)
Unlabelled hyperlink
Creating Tables
There are a number of ways to create tables within reStructured Text, the simplest and suggested on to use is the csv-table directive. All three markups are displayed below:
csv-tables
.. csv-table:: Table Name :header: "Column One", "Column Two", "Column Three" :widths: 20, 10, 30 "Text goes here", 15.85, "Enter it now!" "interesting row", 21.47, "indeed." "Look an empty cell", 19.34, " "
produces
| Column One | Column Two | Column Three |
|---|---|---|
| Text goes here | 15.85 | Enter it now! |
| interesting row | 21.47 | indeed. |
| Look! an empty cell | 19.34 |
Further information on the csv-table and other directives within reStructured Text can be found here
Complex but Clunky Tables
+------------+------------+-----------+ | Header 1 | Header 2 | Header 3 | +============+============+===========+ | body row 1 | column 2 | column 3 | +------------+------------+-----------+ | body row 2 | Cells may span columns.| +------------+------------+-----------+ | body row 3 | Cells may | - Cells | +------------+ span rows. | - contain | | body row 4 | | - blocks. | +------------+------------+-----------+
produces:
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| body row 1 | column 2 | column 3 |
| body row 2 | Cells may span columns. | |
| body row 3 | Cells may span rows. |
|
| body row 4 | ||
Simple but limited tables
===== ===== ====== Inputs Output ------------ ------ A B A or B ===== ===== ====== False False False True False True False True True True True True ===== ===== ======
produces
| Inputs | Output | |
|---|---|---|
| A | B | A or B |
| False | False | False |
| True | False | True |
| False | True | True |
| True | True | True |
Lists
For both bulleted (*, -, +) and enumerated lists (1. a.) there must be a space after the symbol. In addition there must be a blank line before and after the bulleted text
Bulleted Lists
Look at these bullets * First bullet * Second bullet * First sub-bullet * Second sub-bullet
produces
Look at these bullets
- First bullet
- Second bullet
- First sub-bullet
- Second sub-bullet
Miscellaneous
Literal Blocks
::
This text should be preserved with
all spacing and white space.
It is useful for entering blocks
of code.
produces
This text should be preserved with
all spacing and white space.
It is useful for entering blocks
of code.
Line Breaks
Useful for formatting addresses and the like:
| Grameen Technology Center | 909 NE Boat Street, Suite 300 | Seattle, WA 98105
Sections/Headers
Top Level ========= Second Level ++++++++++++ Third Level ----------- Fourth Level ~~~~~~~~~~~~
- Any character of the following =, +, -, ~, can be repeated to form
