Documentation Standard: Model

This document extends the AFSIM Documentation Standard.

The .. model:: directive is used to document a model and its syntax. This directive creates a model index entry and a link target, referenceable with the :model: role. For model commands implemented by a given model, command documentation should be included with the corresponding model documentation.

Model Markup

Example

Markup

 
Command Block with Model Parameter

platform CESSNA_172 WSF_PLATFORM
   side blue # A model sub-command
   ...
end_platform
 
.. model:: platform WSF_PLATFORM

... <model-name>

.. model:: <model-type> <model-name>

Cross-Referencing Models

Markup

Result

 
Model Cross-Reference

See :model:`WSF_GEOMETRIC_SENSOR`

Model Cross-Reference

See WSF_GEOMETRIC_SENSOR

Model Page Structure

The contents of a model page will vary by model. However, each page should be structurally similar. Model pages will be named in lowercase, but the page title and the model documentation itself will be fully capitalized. Some models implement commands specific to the model, while simple models do not. Meaning the documentation for some models may simply note that the model exists and reference its usage in a related script class and/or command.

Example Pages

Page Template

File: <model-name>.rst

<model-name>
============

.. model:: <model-type> <model-name>

.. parsed-literal::

   <block-command> <object-name> <model-name>

      :command:`<model-command-1>`
      :command:`<model-command-2>`

      ...

   end_<block-command>

Overview
--------

...

Commands
--------

...