Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/source/restructuredtext.rst
blob: 0ad3a786c2e690d50608ae7f2db5cb24386f1647 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
===========================
Writing in reStructuredText
===========================

This page is a short primer and cheat sheet for the markup language we are using in :doc:`/how_to_help`. The rst format is easy to create and we are using a part of it only.

.. _my-reference-label:

Titles
::::::

::

 ====================
 This is a main title
 ====================

::

 This is a secondary title
 -------------------------

::

 This is a 3rd level title
 :::::::::::::::::::::::::

Links
:::::

Links like http://activities.sugarlabs.org are automatically created.

To create links where the text displayed in the page is different to the link you should do:

You will find `ASLO <http://activities.sugarlabs.org>`_ here.

Program writing software like Python_.

.. _Python: http://www.python.org/

::

	Links like http://activities.sugarlabs.org are automatically created.

	To create links where the text displayed in the page is different to the link you should do:

	You will find `ASLO <http://activities.sugarlabs.org>`_ here.

	Program writing software like Python_.

	.. _Python: http://www.python.org/

Links within Help
:::::::::::::::::

This link, :ref:`my-reference-label` links to the top paragraph of this document.

 To see how this works, ``.. _my-reference-label:`` appears on line 7 of restructuredtext.rst.

Secondly, this page contains more about terms and words used in sugar. :doc:`/glossary`

::

	This link, :ref:`my-reference-label`, links to the top paragraph of this document.

	 To see how this works, ``.. _my-reference-label:`` appears on line 7 of restructuredtext.rst.

	Secondly, this page contains more about terms and words used in sugar. :doc:`/glossary`


Lists
:::::

Lists are simple

* First item
* Second item
* Last item

or numbered:

1. One item
2. Another item
3. The last one

::

	Lists are simple

	* First item
	* Second item
	* Last item

	or numbered:

	1. One item
	2. Another item
	3. The last one

Simple table
::::::::::::

=====  =====  ======
   Inputs     Output
------------  ------
  A      B    A or B
=====  =====  ======
False  False  False
True   False  True
False  True   True
True   True   True
=====  =====  ======

::

	=====  =====  ======
	   Inputs     Output
	------------  ------
	  A      B    A or B
	=====  =====  ======
	False  False  False
	True   False  True
	False  True   True
	True   True   True
	=====  =====  ======

Images
::::::

An image can be included like this:

.. image :: ../images/Help.png

::

	.. image :: ../images/Help.png

Icons and small images
::::::::::::::::::::::

|Neighborhood_key| This is the sharing option.

.. |Neighborhood_key| image:: ../images/Neighborhood_key_sml.png

|Home_key_f3_small| This is the Private option.

.. |Home_key_f3_small| image:: ../images/Home_key_f3_small.png

::

	|Neighborhood_key| This is the sharing option.

	.. |Neighborhood_key| image:: ../images/Neighborhood_key_sml.png

	|Home_key_f3_small| This is the Private option.

	.. |Home_key_f3_small| image:: ../images/Home_key_f3_small.png

Adding a note
:::::::::::::

.. Note::

   When you are required to place the first readable character at point 3 or 4 in the line, it is recommended to check if you are required to insert spaces or Tab.

And also

.. seealso::

   Notice that first readable character of this note is under the "s", three spaces preceed it.

::

	.. Note::

	   When you are required to place the first readable character at point 3 or 4 in the line, it is recommended to check if you are required to insert spaces or Tab.

	And also

	.. seealso::

	   Notice that first readable character of this note is under the "s", three spaces preceed it.


|more| There are links to :ref:`Further reading` at the foot of the page :doc:`/how_to_help`

.. |more| image:: ../images/more.png