mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-07-07 05:06:15 +00:00
fixed overall formatting of inline.rst
This commit is contained in:
@@ -18,56 +18,62 @@ the roles.
|
||||
acronym can be used without further definition or markup. Do not use
|
||||
abbreviation markup on headings.
|
||||
|
||||
:abbr:`API (Application Program Interface)`
|
||||
:abbr:`API (Application Program Interface)`
|
||||
|
||||
Template:
|
||||
Template:
|
||||
|
||||
``:abbr:`TIA (This Is an Abbreviation)```
|
||||
``:abbr:`TIA (This Is an Abbreviation)```
|
||||
|
||||
* Use the `:command:` role when the name of a specific command is used in a
|
||||
paragraph for emphasis. Use the ``.. code-block::`` directive for fully
|
||||
actionable commands in a series of steps.
|
||||
|
||||
:command:`make`
|
||||
:command:`make`
|
||||
|
||||
Template:
|
||||
Template:
|
||||
|
||||
``:command:`command```
|
||||
``:command:`command```
|
||||
|
||||
* In most cases, use asterisks "*" to emphasize the name of a command
|
||||
option. However, if you have defined an ``.. option::`` directive, you may
|
||||
use the `:option:` role. For example:
|
||||
|
||||
Pandoc Options:
|
||||
Pandoc Options:
|
||||
|
||||
.. option:: -f
|
||||
.. option:: --all
|
||||
.. option:: -o <output.xsl>
|
||||
.. option:: -f
|
||||
.. option:: --all
|
||||
.. option:: -o <output.xsl>
|
||||
|
||||
The :command:`pandoc` command can be used without the :option:`-o`
|
||||
option, creating an output file with the same name as the source
|
||||
but a different extension.
|
||||
The :command:`pandoc` command can be used without the :option:`-o`
|
||||
option, creating an output file with the same name as the source
|
||||
but a different extension.
|
||||
|
||||
Template:
|
||||
Template:
|
||||
|
||||
.. code-block:: rest
|
||||
.. code-block:: rest
|
||||
|
||||
.. option: option
|
||||
|
||||
description of option
|
||||
|
||||
``:option:`option```
|
||||
:option:`option`
|
||||
|
||||
* Use the `:file:` role to emphasize a filename or directory. Do not use the
|
||||
role inside a code-block but use it inside all notices that contain files
|
||||
or directories. Place variable parts of the path or filename in brackets
|
||||
`{}`.
|
||||
|
||||
:file:`collaboration.rst` :file:`doc/{user}/collaboration/figures`
|
||||
:file:`collaboration.rst`
|
||||
|
||||
Template:
|
||||
:file:`doc/{user}/collaboration/figures`
|
||||
|
||||
``:file:`filename.ext` :file:`path/or/directory```
|
||||
Template:
|
||||
|
||||
.. code-block:: rest
|
||||
|
||||
:file:`filename.ext`
|
||||
|
||||
:file:`path/or/directory`
|
||||
|
||||
* Use the `:guilabel:` role to emphasize elements of a graphic
|
||||
user interface within a description. It replaces the use of quotes
|
||||
@@ -75,14 +81,16 @@ the roles.
|
||||
menu elements. Always follow the marked element with the appropriate
|
||||
noun. For example:
|
||||
|
||||
In the :guilabel:`Tools` menu.
|
||||
Press the :guilabel:`OK` button.
|
||||
In the :guilabel:`Settings` window you find the :guilabel:`Hide
|
||||
Content` option.
|
||||
In the :guilabel:`Tools` menu.
|
||||
|
||||
Template:
|
||||
Press the :guilabel:`OK` button.
|
||||
|
||||
``:guilabel:`UI-Label```
|
||||
In the :guilabel:`Settings` window you find
|
||||
the :guilabel:`Hide Content` option.
|
||||
|
||||
Template:
|
||||
|
||||
``:guilabel:`UI-Label```
|
||||
|
||||
* Use the `:menuselection:` role to indicate the navigation through a menu
|
||||
ending with a selection. Every `:menuselection:` element can have up to two
|
||||
@@ -90,37 +98,41 @@ the roles.
|
||||
it can be combined with a `:guilabel:` or with another `:menuselection:`
|
||||
element. For example:
|
||||
|
||||
:menuselection:`File --> Save As --> PDF`
|
||||
Go to :guilabel:`File` and select :menuselection:`Import --> Data
|
||||
Base --> MySQL`.
|
||||
Go to :menuselection:`Window --> View` and select :menuselection:`
|
||||
Perspective --> Other --> C++`
|
||||
:menuselection:`File --> Save As --> PDF`
|
||||
|
||||
Template:
|
||||
Go to :guilabel:`File` and select :menuselection:`Import --> Data
|
||||
Base --> MySQL`.
|
||||
|
||||
Go to :menuselection:`Window --> View` and
|
||||
select :menuselection:`Perspective --> Other --> C++`
|
||||
|
||||
``:menuselection:`1stMenu --> 2ndMenu --> Selection```
|
||||
Template:
|
||||
|
||||
``:menuselection:`1stMenu --> 2ndMenu --> Selection```
|
||||
|
||||
* Use the `:makevar:` role to emphasize the name of a Makefile variable.
|
||||
The role can include only the name of the variable or the variable
|
||||
plus its value.
|
||||
|
||||
:makevar:`PLATFORM_CONFIG`
|
||||
:makevar:`PLATFORM_CONFIG=basic_atom`
|
||||
:makevar:`PLATFORM_CONFIG`
|
||||
|
||||
Template:
|
||||
:makevar:`PLATFORM_CONFIG=basic_atom`
|
||||
|
||||
``:makevar:`VARIABLE```
|
||||
Template:
|
||||
|
||||
``:makevar:`VARIABLE```
|
||||
|
||||
* Use the `:envvar:` role to emphasize the name of environment
|
||||
variables. Just as with `:makevar:`, the markup can include only the
|
||||
name of the variable or the variable plus its value.
|
||||
|
||||
:envvar:`ZEPHYR_BASE`
|
||||
:envvar:`QEMU_BIN_PATH=/usr/local/bin`
|
||||
:envvar:`ZEPHYR_BASE`
|
||||
|
||||
:envvar:`QEMU_BIN_PATH=/usr/local/bin`
|
||||
|
||||
Template:
|
||||
Template:
|
||||
|
||||
``:envvar:`ENVIRONMENT_VARIABLE```
|
||||
``:envvar:`ENVIRONMENT_VARIABLE```
|
||||
|
||||
.. _Sphinx Inline Markup:
|
||||
http://sphinx-doc.org/markup/inline.html#inline-markup
|
||||
|
||||
Reference in New Issue
Block a user