Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 154 lines (85 sloc) 2.314 kb
38ec6a4 @yjacolin improve README file
yjacolin authored
1 ===================================
2 Migration guide / convention style
3 ===================================
4
5 Introduction
6 ============
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
7
8 See also: http://sphinx.pocoo.org/markup/inline.html or convention.rst file.
9
978d924 @capooti Added the Python documentation style guide lines link.
capooti authored
10 In general, when creating rst documentation for the QGIS project, please follow
11 the `Python documentation style guide lines
12 <http://docs.python.org/devguide/documenting.html>`_.
13
38ec6a4 @yjacolin improve README file
yjacolin authored
14 Inline tags
15 ===========
16
17 * Shorcut keyboard:
18 ::
19
20 \keyboard{Ctrl B}
21
22 move to::
23
24 :kbd:`ctrl B`
25
26 will show :kbd:`Ctrl B`
27
da10369 @yjacolin add readme file to help contributors
yjacolin authored
28 * Menu gui::
29
30 \mainmenuopt{menu} \arrow \dropmenuopttwo{submenu}
31
32 move to::
33
34 :menuselection:`menu --> submenu`
38ec6a4 @yjacolin improve README file
yjacolin authored
35
da10369 @yjacolin add readme file to help contributors
yjacolin authored
36 * Filename::
37
38 \filename{file}
39
40 move to::
41
42 :file:``
38ec6a4 @yjacolin improve README file
yjacolin authored
43
da10369 @yjacolin add readme file to help contributors
yjacolin authored
44 * Gui label with icon::
45
46 \toolbtntwo{icon}{label}
47
48 move to::
49
50 |icon| :guilabel:`label`
51
52 (see `image`_ below).
38ec6a4 @yjacolin improve README file
yjacolin authored
53
da10369 @yjacolin add readme file to help contributors
yjacolin authored
54 * Dialog title::
55
56 \dialog{title}
57
58 move to::
59
60 :guilabel:`title`
38ec6a4 @yjacolin improve README file
yjacolin authored
61
da10369 @yjacolin add readme file to help contributors
yjacolin authored
62 * User text::
63
64 \usertext{label}
65
66 move to::
67
68 ``label``
38ec6a4 @yjacolin improve README file
yjacolin authored
69
259e5d0 @Jean-Roc update plugins.rst
Jean-Roc authored
70 Footnotes
71 =========
72
73 This is for creating a footnote::
74
75 blabla [1]_
76
77 Whichi will point to :
78
79 .. [1] Updates of core plugins
80
38ec6a4 @yjacolin improve README file
yjacolin authored
81
82 Label/reference
83 ================
84
85 This is for create a reference somewhere::
86
87 .. _`my_anchor`:
88
a80f076 @yjacolin add more information about internal/external reference
yjacolin authored
89 This is call the reference in the **same page**::
38ec6a4 @yjacolin improve README file
yjacolin authored
90
91 see section `my_anchor`_ for more information
92
a80f076 @yjacolin add more information about internal/external reference
yjacolin authored
93 This is the same thing, but called in another page::
94
95 see section :ref:`my_anchor` for more information.
96
38ec6a4 @yjacolin improve README file
yjacolin authored
97 .. _`image`:
98
99 Figure and image
100 =================
101
102 Figure::
103
104 .. `fig_mylabel`:
105
106 .. figure:: img/en/nix.png
107 :align: center
108 :width: 12 em
109
110 My caption
111
112 To use caption juste insert text after a blanck line in the figure block.
113
114 Pictures
115 --------
116
117 Image::
118
119 .. image:: img/en/nix.png
120 :width: 12 em
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
121
122
38ec6a4 @yjacolin improve README file
yjacolin authored
123 Replacement
124 -----------
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
125
38ec6a4 @yjacolin improve README file
yjacolin authored
126 You can put an image inside text or add an alias to use everywhere. To use an image
127 inside a paragraph, just create an alias somewhere::
128
129 .. |label| image:: img/en/nix.png
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
130
38ec6a4 @yjacolin improve README file
yjacolin authored
131 and call it in your paragraph::
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
132
38ec6a4 @yjacolin improve README file
yjacolin authored
133 my paragraph begins here with a nice picture |label|.
197be2a @yjacolin add new chapter in rst
yjacolin authored
134
38ec6a4 @yjacolin improve README file
yjacolin authored
135 Here is how this exemple become:
197be2a @yjacolin add new chapter in rst
yjacolin authored
136
38ec6a4 @yjacolin improve README file
yjacolin authored
137 .. |label| image:: img/en/nix.png
d4bfc7f @yjacolin add change beofre merge
yjacolin authored
138
38ec6a4 @yjacolin improve README file
yjacolin authored
139 my paragraph begins here with a nice picture |label|.
197be2a @yjacolin add new chapter in rst
yjacolin authored
140
38ec6a4 @yjacolin improve README file
yjacolin authored
141 Index
142 =====
143 Several index tag exists in RST. Here the easiest one::
144
145 .. index:: `my index`
197be2a @yjacolin add new chapter in rst
yjacolin authored
146
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
147 Available
38ec6a4 @yjacolin improve README file
yjacolin authored
148 =========
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
149
38ec6a4 @yjacolin improve README file
yjacolin authored
150 ::
151
152 :download:
e75f9ff @yjacolin first chapter (convention.rst) to add all qgis shortcuts
yjacolin authored
153
Something went wrong with that request. Please try again.