Changeset View
Changeset View
Standalone View
Standalone View
contributors_manual/krita_manual_conventions.rst
Context not available. | |||||
28 | * `Directives <http://docutils.sourceforge.net/docs/ref/rst/directives.html>`_ | 28 | * `Directives <http://docutils.sourceforge.net/docs/ref/rst/directives.html>`_ | ||
---|---|---|---|---|---|
29 | * `Roles <http://docutils.sourceforge.net/docs/ref/rst/roles.html>`_ | 29 | * `Roles <http://docutils.sourceforge.net/docs/ref/rst/roles.html>`_ | ||
30 | Sphinx specific docs: | 30 | Sphinx specific docs: | ||
31 | * `Sphinx' page on restrucutred text <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ -- This is useful for the specific sphinx directives and roles it uses to generate for example table of contents. | 31 | * `Sphinx' page on restructured text <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ -- This is useful for the specific sphinx directives and roles it uses to generate for example table of contents. | ||
32 | 32 | | |||
33 | There's between the official reStructuredText and the sphinx docs multiple ways to do things. This document specifies the suggested conventions to go with. | 33 | There's between the official reStructuredText and the sphinx docs multiple ways to do things. This document specifies the suggested conventions to go with. | ||
34 | 34 | | |||
Context not available. | |||||
57 | :license: GNU free documentation license 1.3 or later. | 57 | :license: GNU free documentation license 1.3 or later. | ||
58 | 58 | | |||
59 | 3. Indexing terms. | 59 | 3. Indexing terms. | ||
60 | These are comma-seperated terms under which the page will be indexed in :ref:`genindex`. The generated index is quite useful for both pdf as well as people who are not sure what the exact name is of the term they are looking for. They are defined as following:: | 60 | These are comma-separated terms under which the page will be indexed in :ref:`genindex`. The generated index is quite useful for both pdf as well as people who are not sure what the exact name is of the term they are looking for. They are defined as following:: | ||
61 | 61 | | |||
62 | .. index:: Keyword, Keyword with Spaces, ! Main Definition Keyword | 62 | .. index:: Keyword, Keyword with Spaces, ! Main Definition Keyword | ||
63 | 63 | | |||
Context not available. | |||||
135 | .. [CIT2002] This is the citation. It's just like a footnote, | 135 | .. [CIT2002] This is the citation. It's just like a footnote, | ||
136 | except the label is textual. | 136 | except the label is textual. | ||
137 | 137 | | |||
138 | Citaton can also be referenced with `citation <CIT2002>`_ | 138 | Citation can also be referenced with `citation <CIT2002>`_ | ||
139 | 139 | | |||
140 | We don't actually use footnotes in the manual due to the fact that it is a little bit too academical for our readers. However, we do collect documents and links that give a little bit more information on a topic at the end of a page. Sphinx has the ``.. seealso::`` directive for linking to external links, while reStructuredText suggests to use ``.. rubic:: Footnotes`` for specifically collecting footnotes as that plays nice with LaTeX. | 140 | We don't actually use footnotes in the manual due to the fact that it is a little bit too academical for our readers. However, we do collect documents and links that give a little bit more information on a topic at the end of a page. Sphinx has the ``.. seealso::`` directive for linking to external links, while reStructuredText suggests to use ``.. rubic:: Footnotes`` for specifically collecting footnotes as that plays nice with LaTeX. | ||
141 | 141 | | |||
Context not available. | |||||
182 | 182 | | |||
183 | You can :sub:`subscript text` and :sup:`superscript text` by using ``:sub:`text``` and ``:sup:`text``` | 183 | You can :sub:`subscript text` and :sup:`superscript text` by using ``:sub:`text``` and ``:sup:`text``` | ||
184 | 184 | | |||
185 | However, use these super-sparingly! It is preffered to use the existing semantic markup in sphinx in any case, because that makes it easier for translators to make decisions about the nature of the text:: | 185 | However, use these super-sparingly! It is preferred to use the existing semantic markup in sphinx in any case, because that makes it easier for translators to make decisions about the nature of the text:: | ||
186 | 186 | | |||
187 | :menuselection:`settings --> configure Krita` | 187 | :menuselection:`settings --> configure Krita` | ||
188 | :guilabel:`File` | 188 | :guilabel:`File` | ||
Context not available. | |||||
287 | Definition Lists | 287 | Definition Lists | ||
288 | ~~~~~~~~~~~~~~~~ | 288 | ~~~~~~~~~~~~~~~~ | ||
289 | 289 | | |||
290 | A favourite! Definition lists are especially useful when dealing with ennumerating all the options in a docker and trying to add a simple explaination behind them. | 290 | A favourite! Definition lists are especially useful when dealing with enumerating all the options in a docker and trying to add a simple explanation behind them. | ||
291 | 291 | | |||
292 | Definition | 292 | Definition | ||
293 | explaination. | 293 | explanation. | ||
294 | Another option | 294 | Another option | ||
295 | Explaination. | 295 | Explanation. | ||
296 | 296 | | |||
297 | To make them. | 297 | To make them. | ||
298 | You can make them like this:: | 298 | You can make them like this:: | ||
299 | 299 | | |||
300 | Definition | 300 | Definition | ||
301 | explaination. | 301 | explanation. | ||
302 | Another option | 302 | Another option | ||
303 | Explaination. | 303 | Explanation. | ||
304 | 304 | | |||
305 | Tables | 305 | Tables | ||
306 | ------ | 306 | ------ | ||
Context not available. | |||||
352 | 352 | | |||
353 | .. note:: | 353 | .. note:: | ||
354 | 354 | | |||
355 | Admonishments are sort of like a seperate section that the reader needs to pay attention to. | 355 | Admonishments are sort of like a separate section that the reader needs to pay attention to. | ||
356 | 356 | | |||
357 | Admonishments that can be used are the following(in order of seriousness): | 357 | Admonishments that can be used are the following(in order of seriousness): | ||
358 | 358 | | |||
Context not available. | |||||
426 | Only use them when you think the subject is too minor to have a proper heading. | 426 | Only use them when you think the subject is too minor to have a proper heading. | ||
427 | 427 | | |||
428 | Topic | 428 | Topic | ||
429 | When the text is seperated from the flow, so it goes into a different subject than the text itself is naturally going to. | 429 | When the text is separated from the flow, so it goes into a different subject than the text itself is naturally going to. | ||
430 | Rubric | 430 | Rubric | ||
431 | When the text isn't seperated from the flow, but it does not need a header either. | 431 | When the text isn't separated from the flow, but it does not need a header either. | ||
432 | Admonishments | 432 | Admonishments | ||
433 | Only when they fit semantically. This is especially necessary for the danger and warning admonishments, as seeing them too often can make users blind to them. | 433 | Only when they fit semantically. This is especially necessary for the danger and warning admonishments, as seeing them too often can make users blind to them. | ||
434 | 434 | | |||
Context not available. | |||||
441 | 441 | | |||
442 | This is a paragraph, and we define a preformated snippet like so:: | 442 | This is a paragraph, and we define a preformated snippet like so:: | ||
443 | 443 | | |||
444 | Be sure to add a white space and a tab afterwards befor starting the snippet. | 444 | Be sure to add a white space and a tab afterwards before starting the snippet. | ||
445 | 445 | | |||
446 | You can also use the ``.. code::`` directive. If you add the language name after it, it'll do the appropriate syntax highlighting:: | 446 | You can also use the ``.. code::`` directive. If you add the language name after it, it'll do the appropriate syntax highlighting:: | ||
447 | 447 | | |||
Context not available. |