Report
======

*Report* provides a formatted and mostly textual presentation of key
components of your current :doc:`DEXi model <DEXiIntModel>`. After
invoking this command, a small window appears in which you can select
:ref:`elements <DEXiIntReport_elm>` to be included in the report:

.. image:: images/CreRpt.png
   :alt: Create Report

In addition to element selection, you can press one of the buttons:

**Font**: Specify font to be used in the report (the default is Arial,
10pt).

**Settings**: Open :ref:`Settings/Report <DEXiIntSett_rpt>` in order to
specify the format of report and its :ref:`elements <DEXiIntReport_elm>`.

**Report**: Create a report consisting of selected elements and
:doc:`preview <DEXiIntPreview>` it on the screen.

**Cancel**: Close this window without creating a report.

Also, you can right-click on the list and select one of the menu items:

|Select all| **Select all reports**: Select all report elements

|Unselect all| **Unselect all reports**: Clear all current selections.

.. _DEXiIntReport_elm:

Report elements
---------------

**Model description**: Textual description of the current model, which
is optional and used only for documentation.

**Attribute tree**: Displays :doc:`attribute <DEXiGlosAttr>` names and
descriptions. :doc:`Tree structure <DEXiGlosTree>` is indicated by
indenting and connecting attribute names. [See an
:ref:`example <DEXiCarTree_rpt>`.]

**Scales**: Similar to 'Attribute tree', but displays
:doc:`scales <DEXiGlosScale>`. [See an
:doc:`example <DEXiCarScale>`).]

**Scale descriptions**: A long printout of
:doc:`scales <DEXiGlosScale>`. For each scale in your
:doc:`model <DEXiIntModel>`, it prints out the scale name,
corresponding attribute description, and all scale values together with
their own descriptions, if any. [This report element is rarely needed.]

**Function summary**: Displays the :doc:`tree structure <DEXiGlosTree>`
along with the :doc:`status <DEXiGlosFunctDef>` of utility functions.

**Rule tables**: Prints out all :doc:`utility
functions <DEXiGlosFunct>` defined in your
:doc:`model <DEXiIntModel>`. Display format is determined in
:ref:`Settings/Report <DEXiIntSett_rpt>`. [See some
:doc:`examples <DEXiGlosComplex>`].

**Weights**: Similar to 'Attribute tree', but displays attribute
:doc:`weights <DEXiGlosWei>`. You can explicitly select displayed
weight types in :ref:`Settings/Report <DEXiIntSett_rpt>`. [See an
:ref:`example <DEXiGlosWei_rpt>`].

**Evaluation results**: Similar to 'Attribute tree', but displays
:doc:`evaluation <DEXiGlosEval>` results. Only options that are
selected on the :doc:`Charts Page <DEXiIntTabChart>` are included into
this report element. Again, its format can be determined through
:ref:`Settings/Report <DEXiIntSett_rpt>`.

**Chart**: Prints out the chart that is currently displayed on the
:doc:`Charts Page <DEXiIntTabChart>`.

.. |Select all| image:: images/check.png
.. |Unselect all| image:: images/uncheck.png

.. toctree::
  :hidden:
  
  DEXiIntPreview