Index: doc/cmdr_dsl.man ================================================================== --- doc/cmdr_dsl.man +++ doc/cmdr_dsl.man @@ -3,13 +3,18 @@ [include parts/module.inc] [titledesc [vset TITLE_DSL]] [description] [include parts/welcome.inc] -This document is for users of the cmdr framework. It describes the +This document is for users of the cmdr framework. It introduces the domain-specific language for the specification of command hierarchies -with commands and their parameters (options, and inputs). +with commands and their parameters by way of examples and then +provides links to the detailed reference documents. + +[para] These related documents are: + +[include parts/related_dsl.inc] [comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@] [section {Introductory examples}] Instead of immediately diving into the full syntax of the @@ -29,25 +34,15 @@ With the examples behind us we can now go and specify the entire specification language. If you have skipped here on first reading, ignoring the examples, please go back and read them first. -[comment ================================================] -[subsection General] [include parts/dsl_general.inc] -[comment ================================================] -[subsection Officers] -[include parts/dsl_officer.inc] - -[comment ================================================] -[subsection Privates] -[include parts/dsl_private.inc] - -[comment ================================================] -[subsection Parameters] -[include parts/dsl_parameter.inc] +[para] For the details please continue reading at + +[include parts/related_dsl.inc] [include parts/related.inc] [include parts/feedback.inc] [manpage_end] ADDED doc/cmdr_dsl_officer.man Index: doc/cmdr_dsl_officer.man ================================================================== --- /dev/null +++ doc/cmdr_dsl_officer.man @@ -0,0 +1,21 @@ +[include parts/definitions.inc] +[manpage_begin [vset PROJECT]_dsl_officer [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[titledesc [vset TITLE_DSL_OFFICER]] +[description] +[include parts/welcome.inc] + +This document is for users of the cmdr framework. It introduces the +domain-specific language for the specification of officers in detail. + +[para] Related documents are: + +[include parts/related_dsl.inc] + +[include parts/dsl_officer.inc] + +[include parts/related_dsl.inc] +[include parts/related.inc] +[include parts/feedback.inc] +[manpage_end] + ADDED doc/cmdr_dsl_parameter.man Index: doc/cmdr_dsl_parameter.man ================================================================== --- /dev/null +++ doc/cmdr_dsl_parameter.man @@ -0,0 +1,22 @@ +[include parts/definitions.inc] +[manpage_begin [vset PROJECT]_dsl_parameter [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[titledesc [vset TITLE_DSL_PARAMETER]] +[description] +[include parts/welcome.inc] + +This document is for users of the cmdr framework. It introduces the +domain-specific language for the specification of parameters in +detail. + +[para] Related documents are: + +[include parts/related_dsl.inc] + +[include parts/dsl_parameter.inc] + +[include parts/related_dsl.inc] +[include parts/related.inc] +[include parts/feedback.inc] +[manpage_end] + ADDED doc/cmdr_dsl_private.man Index: doc/cmdr_dsl_private.man ================================================================== --- /dev/null +++ doc/cmdr_dsl_private.man @@ -0,0 +1,21 @@ +[include parts/definitions.inc] +[manpage_begin [vset PROJECT]_dsl_private [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[titledesc [vset TITLE_DSL_PRIVATE]] +[description] +[include parts/welcome.inc] + +This document is for users of the cmdr framework. It introduces the +domain-specific language for the specification of privates in detail. + +[para] Related documents are: + +[include parts/related_dsl.inc] + +[include parts/dsl_private.inc] + +[include parts/related_dsl.inc] +[include parts/related.inc] +[include parts/feedback.inc] +[manpage_end] + Index: doc/parts/definitions.inc ================================================================== --- doc/parts/definitions.inc +++ doc/parts/definitions.inc @@ -9,11 +9,14 @@ [vset TITLE_MAIN "[vset PTITLE] - Main package and API"] [vset TITLE_ACTOR "[vset PTITLE] - Base class for officers and privates - Internal"] [vset TITLE_CONFIG "[vset PTITLE] - Collection of parameters for privates"] [vset TITLE_DEV_HF "[vset PTITLE] - Writing custom help formats"] [vset TITLE_DEV_VT "[vset PTITLE] - Writing custom validation types"] -[vset TITLE_DSL "[vset PTITLE] - Specification Language"] +[vset TITLE_DSL "[vset PTITLE] - Introduction to the Specification Language"] +[vset TITLE_DSL_OFFICER "[vset PTITLE] - Officer Specification Language"] +[vset TITLE_DSL_PRIVATE "[vset PTITLE] - Private Specification Language"] +[vset TITLE_DSL_PARAMETER "[vset PTITLE] - Parameter Specification Language"] [vset TITLE_HELP "[vset PTITLE] - Utilities for help text formatting and setup - Internal"] [vset TITLE_HELP_JSON "[vset PTITLE] - Formatting help as JSON object"] [vset TITLE_HELP_SQL "[vset PTITLE] - Formatting help as series of SQL commands"] [vset TITLE_OFFICER "[vset PTITLE] - Aggregation of multiple commands for dispatch."] [vset TITLE_PARAMETER "[vset PTITLE] - Command parameters"] ADDED doc/parts/related_dsl.inc Index: doc/parts/related_dsl.inc ================================================================== --- /dev/null +++ doc/parts/related_dsl.inc @@ -0,0 +1,8 @@ +[section {Related Specification Documents}] + +[list_begin enum] +[enum] [term [vset TITLE_DSL]] +[enum] [term [vset TITLE_DSL_OFFICER]] +[enum] [term [vset TITLE_DSL_PRIVATE]] +[enum] [term [vset TITLE_DSL_PARAMETER]] +[list_end]