Skip to content

Commit 882168c

Browse files
gmildegmilde
committed
Update rST parser documentation: preparation
Use a simple table for simple examples. Easier to read and edit. No change to the content and the rendered output.
1 parent b72b4f5 commit 882168c

File tree

1 file changed

+50
-46
lines changed

1 file changed

+50
-46
lines changed

‎src/moin/help/help-en/rst.data‎

Lines changed: 50 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -92,40 +92,44 @@ Text formatting
9292

9393
The following is a table of inline markup that can be used to format text in Moin.
9494

95-
+----------------------------------------+------------------------------------+
96-
|Markup |Result |
97-
+========================================+====================================+
98-
|``**Bold Text**`` |**Bold text** |
99-
+----------------------------------------+------------------------------------+
100-
|``*Italic*`` |*Italic* |
101-
+----------------------------------------+------------------------------------+
102-
|````Inline Literals```` |``Inline Literals`` |
103-
+----------------------------------------+------------------------------------+
104-
|``***nested markup is not supported***``|***nested markup is not supported***|
105-
+----------------------------------------+------------------------------------+
95+
======================================== ====================================
96+
Markup Result
97+
======================================== ====================================
98+
``**Bold Text**`` **Bold text**
99+
100+
``*Italic*`` *Italic*
101+
102+
````Inline Literals```` ``Inline Literals``
103+
104+
``***nested markup is not supported***`` ***nested markup is not supported***
105+
======================================== ====================================
106+
106107

107108
Hyperlinks
108109
==========
109110

110111
External Links
111112
--------------
112113

113-
+----------------------------------------------------------------+------------------------------------------------------------+
114-
|Markup |Result |
115-
+================================================================+============================================================+
116-
|``http://www.python.org/`` |http://www.python.org/ |
117-
+----------------------------------------------------------------+------------------------------------------------------------+
118-
|``External hyperlinks, like `Python <http://www.python.org/>`_``|External hyperlinks, like `Python <http://www.python.org/>`_|
119-
+----------------------------------------------------------------+------------------------------------------------------------+
120-
|``External hyperlinks, like Moin_.`` |External hyperlinks, like Moin_. |
121-
| | |
122-
|``.. _Moin: http://moinmo.in/`` |.. _Moin: http://moinmo.in/ |
123-
+----------------------------------------------------------------+------------------------------------------------------------+
114+
================================================================ =====================================================
115+
Markup Result
116+
================================================================ =====================================================
117+
``http://www.python.org/`` http://www.python.org/
118+
119+
``External hyperlinks, like `Python <http://www.python.org/>`_`` External hyperlinks, like
120+
`Python <http://www.python.org/>`_
121+
122+
``External hyperlinks, like Moin_.`` External hyperlinks, like Moin_.
123+
124+
``.. _Moin: http://moinmo.in/`` .. _Moin: http://moinmo.in/
125+
================================================================ =====================================================
124126

125127
Internal Links
126128
--------------
127129

128-
The examples below use the "help-en" and "help-common" namespaces to separate these help pages from the main wiki content. Some target pages may be missing from the default namespace.
130+
The examples below use the "help-en" and "help-common" namespaces
131+
to separate these help pages from the main wiki content.
132+
Some target pages may be missing from the default namespace.
129133

130134
Within the rst syntax:
131135

@@ -136,29 +140,29 @@ Within the rst syntax:
136140

137141
.. _myanchor:
138142

139-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
140-
|Markup |Result |Comment |
141-
+=============================+=====================================+============================================================+
142-
| ``http:Home`` |http:Home |link to an item in the default namespace of this wiki |
143-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
144-
| ```Home2 <http:Home>`_`` |`Home2 <http:Home>`_ |fancy link to an item in the default namespace of this wiki |
145-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
146-
| ``http:/subitem`` |http:/subitem |link to a subitem of the current item |
147-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
148-
| ```sub <http:/subitem>`_`` |`sub <http:/subitem>`_ |fancy link to a subitem of the current item |
149-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
150-
| ``http:users/Home`` |http:users/Home |link to an item in a different namespace of this wiki |
151-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
152-
| ``http:../moin`` |http:../moin |link to a sibling of this item |
153-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
154-
| ``Headings_`` |Headings_ |link to Headings anchor on this item |
155-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
156-
| ```Internal Links`_`` |`Internal Links`_ |link to a heading with embedded blanks |
157-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
158-
| ``.. _myanchor:`` | |create anchor, real anchor is above this table |
159-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
160-
| ``myanchor_`` |myanchor_ |link to above anchor |
161-
+-----------------------------+-------------------------------------+------------------------------------------------------------+
143+
============================ ============================ ===========================================================
144+
Markup Result Comment
145+
============================ ============================ ===========================================================
146+
``http:Home`` http:Home link to an item in the default namespace of this wiki
147+
148+
```Home2 <http:Home>`_`` `Home2 <http:Home>`_ fancy link to an item in the default namespace of this wiki
149+
150+
``http:/subitem`` http:/subitem link to a subitem of the current item
151+
152+
```sub <http:/subitem>`_`` `sub <http:/subitem>`_ fancy link to a subitem of the current item
153+
154+
``http:users/Home`` http:users/Home link to an item in a different namespace of this wiki
155+
156+
``http:../moin`` http:../moin link to a sibling of this item
157+
158+
``Headings_`` Headings_ link to Headings anchor on this item
159+
160+
```Internal Links`_`` `Internal Links`_ link to a heading with embedded blanks
161+
162+
``.. _myanchor:`` create anchor, real anchor is above this table
163+
164+
``myanchor_`` myanchor_ link to above anchor
165+
============================ ============================ ===========================================================
162166

163167
**Notes:**
164168
- If this page was created by Sphinx, none of the above internal link examples work correctly.

0 commit comments

Comments
 (0)