Tagging Keywords with ()

A keyword will take anything that appears in parentheses at the end of its definition and push the matter to the right-end of its definition in the output and italicize it. So, on something like this:

The main uses of this are for: labeling properties of constitutive models as “advanced” or “read-only” (see below), identifying a command that appears in common but may be applicable only to a certain program (as above), or to identify a command that is applicable in 2d- or 3d-only.

The parenthetical matter must be the final element on the line defining the keyword. In any other position, it will be handled as part of the keyword definition.

Tagging Constitutive Models

Some constitutive models label properties as “ready-only”, “advanced”. See hoek-brown-pac Model Properties for an example of this.

This is done with a bit of customization from fish_domain.py (i.e., Itasca’s extension to Sphinx), none of which is inferable from normal Sphinx usage.

Construct as follows.

1. Tag the keyword with (a) or (r) as shown below. The critical thing in this usage is that the tag appear in parentheses and it must be the last thing on the keyword line:

   .. kwd:: Table-SCI :str:`s` (a)
   

2. At the bottom of the property list, the following text should appear — though only include one of the (a) or the (r) definitions if there are no properties tagged as the other kind:

   **Key**
   
   \(a) Advanced property.
      This property has a default value; simpler applications of the
      model do not need to provide a value for it.
   \(r) Read-only property.
      This property cannot be set by the user. Instead, it can be listed,
      plotted, or accessed through |fish|.
   

The text above should appear before a Notes section, and immediately after the last property (again, see hoek-brown-pac Model Properties for illustration).