Generated Model Documentation

Home > Model Development Topics > Generated Model Documentation

This topic describes one of the two components of model documentation: the generated Symbol Reference.

This topic is under construction and/or revision.

Related topics

• Model Documentation: Home topic on model documentation
• Authored Model Documentation: The autonomous authored component of model documentation
• Model Symbols: Symbols in model code and in the user interface
• Symbol Labels and Notes: Human-language labels and notes for model symbols

Topic contents

• Introduction and outline
• Symbol Reference - User Edition
• Symbol Reference - Developer Edition
• Customizing the Symbol Reference
• Navigation Aid Topics

Introduction and outline

Human-language labels and notes for model symbols are combined with symbol metadata and cross-reference information to produce a Symbol Reference for a model. There are two versions of the Symbol Reference, one targeted to model users and one to model developers. Both versions can be customized using options statements to include or remove specific portions.

Independent of the Symbol Reference, labels and notes for all symbols accessible from the model UI are published to the database, for all human languages declared in the model.

[back to topic contents]

Symbol Reference - User Edition

By default, a model's Symbol Reference documents only symbols which are visible to end users. Labels and notes for model symbols which are not available to the end user when the model is run are not published. This includes parameters and tables suppressed from the model at build time and associated classifications, ranges, and partitions not used by other published symbols. Information on attributes is published only if the model was built with microdata output enabled.

[back to topic contents]

Symbol Reference - Developer Edition

Content to follow.

[back to topic contents]

Customizing the Symbol Reference

The following table lists options which customize the content of the Symbol Reference.

Option	Default	Effect if changed from default
symref_developer_edition	off	Turns on symbols not exposed to users and appends "(Developer Edition)" to title
symref_unpublished_symbols	off	Turns on unpublished symbols, e.g. those absent due to parameters_retain or tables_retain statements in model code.
symref_main_topic	on	Turns off the main topic including navigation aid links
symref_model_symbol	on	Turns off the topic for the unique model symbol, if declared in the model
symref_parameters_alphabetic	on	Turns off the parameters alphabetic list topic
symref_parameter_major_groups	on	Turns off the parameter major group topic
symref_parameter_hierarchy	on	Turns off the parameter hierarchy topic and parameter hierarchy breadcrumbs in individual parameter topics.
symref_topic_parameters	on	Turns off individual parameter topics and parameter cross-reference sections in other topics
symref_tables_alphabetic	on	Turns off the tables alphabetic list topic
symref_table_major_groups	on	Turns off the table major group topic
symref_table_hierarchy	on	Turns off the table hierarchy topic and table hierarchy breadcrumbs in individual table topics.
symref_topic_tables	on	Turns off individual table topics and table cross-reference sections in other topics
symref_enumerations_alphabetic	on	Turns off the enumerations alphabetic list topic
symref_topic_enumerations	on	Turns off individual enumeration topics and enumeration cross-reference sections in other topics
symref_global_functions	on	Turns off global function cross-reference sections in other topics
symref_entity_functions	on	Turns off entity function cross-reference sections in other topics
symref_identity_attributes	on	Turns off identity attribute cross-reference sections in other topics
symref_topic_modules	on	Turns off module alphabetic list, module individual topics, and module cross-reference sections in other topics
symref_topic_modules_use	off	Includes use modules as well as model code modules (if modules are turned on).
symref_topic_modules_symbols_declared	on	Turns off the alphabetic "symbols declared" section in individual module topics
symref_topic_notes	on	Turns off the note sections of all individual symbol topics

[back to topic contents]

Navigation Aid Topics

The following table lists all possible navigation aid topics in the Symbol Reference.

Navigation aid	Topic name	Description and notes
Symbol Reference	symbol-reference	The Symbol Reference main topic.
Parameters in alphabetic order	parameters-alphabetic
Parameter hierarchy	parameter-hierarchy	Present if the model has at least one parameter group. Can contain a trailing 'Orphan parameters' group.
Parameter Major Groups	parameter-major_groups	Present if parameter hierarchy present.
Tables in alphabetic order	tables-alphabetic
Table hierarchy	table-hierarchy	Present if the model has at least one table group. Can contain a trailing 'Orphan tables' group.
Table Major Groups	table-major-groups	Present if table hierarchy present.
Enumerations in alphabetic order	enumerations-alphabetic
Modules in alphabetic order	modules-alphabetic

Note that derived parameters published as tables group with tables in the navigation aid topics, not with parameters.

[back to topic contents]