cmdr
Check-in [daa000e429]
Not logged in

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Split the large DSL document into several smaller pieces: introduction, officer, private, parameter
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:daa000e4293ad64ffb735dddf06899b1f74cb7db
User & Date: andreask 2013-11-15 00:51:27
Context
2013-11-15
07:41
Completed the split of the DSL documents. Regenerated the embedded docs. check-in: b7d756fe00 user: aku tags: trunk
00:51
Split the large DSL document into several smaller pieces: introduction, officer, private, parameter check-in: daa000e429 user: andreask tags: trunk
00:31
Updated embedded documentation check-in: 9223d03cfb user: aku tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to doc/cmdr_dsl.man.

1
2
3
4
5
6
7
8
9
10





11
12
13
14
15
16
17
..
27
28
29
30
31
32
33
34
35
36
37
38
39
40

41
42
43
44
45
46
47
48
49
50
51
52
53
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_dsl [vset MAN_SECTION] [vset VERSION]]
[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
domain-specific language for the specification of command hierarchies
with commands and their parameters (options, and inputs).






[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Introductory examples}]

Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features.
................................................................................
[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Language Reference}]

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]

[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]








|

|
>
>
>
>
>







 







<
<


<
<
<
>

<
<
|
<
<
<
<





1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
..
32
33
34
35
36
37
38


39
40



41
42


43




44
45
46
47
48
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_dsl [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[titledesc [vset TITLE_DSL]]
[description]
[include parts/welcome.inc]

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 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
specification language first a few examples to demonstrate the general
look and feel, plus basic features.
................................................................................
[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Language Reference}]

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.



[include parts/dsl_general.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.











































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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.













































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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.











































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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]

Changes to doc/parts/definitions.inc.

7
8
9
10
11
12
13
14



15
16
17
18
19
20
21
22
23
24
25
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]
[comment {- Custom documents & titles - - -- --- ----- --------}]
[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_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"]
[vset TITLE_PRIVATE   "[vset PTITLE] - Single command handling, options, and arguments"]
[vset TITLE_UTIL      "[vset PTITLE] - General Utilities - Internal"]
[vset TITLE_VALIDATE  "[vset PTITLE] - Standard validation types for parameters"]
[vset TITLE_VCOMMON   "[vset PTITLE] - Utilities for Validation Types"]

[comment {- Miscellanea ............. - - -- --- ----- --------}]







|
>
>
>











7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]
[comment {- Custom documents & titles - - -- --- ----- --------}]
[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] - 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"]
[vset TITLE_PRIVATE   "[vset PTITLE] - Single command handling, options, and arguments"]
[vset TITLE_UTIL      "[vset PTITLE] - General Utilities - Internal"]
[vset TITLE_VALIDATE  "[vset PTITLE] - Standard validation types for parameters"]
[vset TITLE_VCOMMON   "[vset PTITLE] - Utilities for Validation Types"]

[comment {- Miscellanea ............. - - -- --- ----- --------}]

Added doc/parts/related_dsl.inc.

















>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
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]