Inline Roles

This page demonstrates the interpreted text roles supported by Rinx.

Supported Roles

Currently, we support the following interpreted text roles:

• Program Name (:program:): Used to mark the name of an executable program or command-line tool. For example, the rustc compiler and the cargo tool make up the core of Rust development.

Examples

Here are some more examples of program names in different contexts:

• Program name as a single word: Use curl to fetch webpage source.

• Program name with internal spaces: Run git status to see unstaged changes.

• Program name adjacent to punctuation: Run (wget), or search for tar.

• Multiple program names in one sentence: You can use either gzip or bzip2 to compress the output.

Term References (:term:)

The :term: role creates a cross-reference to a term defined in a .. glossary:: directive.

• Basic term reference: The environment stores document metadata.

• Multi-word term: The configuration directory holds project settings.

• Custom display text: the build tool processes the RST files.

Reference Role (:ref:)

The :ref: role creates a cross-reference to a labeled location elsewhere in the site.

• Basic reference: See Rinx Example Site for the project overview. With no explicit title, the link shows the title of the section the label sits above, as in Sphinx.

• Custom display text: the site home links back to the same page under different link text.