cmdr
Check-in [d1574f44fb]
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to tclconference@googlegroups.com
or submit via the online form by Sep 9.

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

Overview
Comment:Moved all title setup into definitions.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:d1574f44fbe3d81cb4de6350411e958041f8416f
User & Date: andreask 2013-11-04 22:45:48
Context
2013-11-05
00:40
Another placeholder, for the DSL spec, and filled out actor reference check-in: 67f83ccddb user: andreask tags: trunk
2013-11-04
22:45
Moved all title setup into definitions. check-in: d1574f44fb user: andreask tags: trunk
22:45
Added placeholders for missing reference docs check-in: 89659bfd6c user: andreask tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to doc/cmdr_help.man.

1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help]
[titledesc {Utilities for help text formatting and setup - Internal}]
[description]
[include parts/welcome.inc]

This internal package implements the four standard help formats
[const full], [const short], [const list], and [const by-category].

[para] It provides a single utility command used by the other parts of





|







1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help]
[titledesc [vset TITLE_HELP]]
[description]
[include parts/welcome.inc]

This internal package implements the four standard help formats
[const full], [const short], [const list], and [const by-category].

[para] It provides a single utility command used by the other parts of

Changes to doc/cmdr_help_json.man.

1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_json [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::json]
[titledesc {Formatting help as JSON object}]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format
[const json]. This format generates help in the form of a nested JSON
object containing all details of the command hierarchy, including
internals.





|







1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_json [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::json]
[titledesc [vset TITLE_HELP_JSON]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format
[const json]. This format generates help in the form of a nested JSON
object containing all details of the command hierarchy, including
internals.

Changes to doc/cmdr_help_sql.man.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_sql [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::sql]
[titledesc {Formatting help as series of SQL commands}]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format
[const sql]. This format generates help as a series of SQL commands
filling a simple database with the command hierarchy.

[para] To activate the format simply [example {
    package require cmdr::help::sql
}] it. Nothing more is needed.

[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
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_sql [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::sql]
[titledesc [vset TITLE_HELP_SQL]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format
[const sql]. This format generates help as a series of SQL commands
filling a simple database with the command hierarchy.

[para] To activate the format simply [example {
    package require cmdr::help::sql
}] it. Nothing more is needed.

[include parts/feedback.inc]
[manpage_end]

Changes to doc/cmdr_parameter.man.

1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_private [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_PRIVATE]]
[description]
[include parts/welcome.inc]

This package implements [emph parameters], collections of which (see
[package cmdr::config]) serve as the configuration of privates (see
[package cmdr::private]).



|


|







1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_parameter [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_PARAMETER]]
[description]
[include parts/welcome.inc]

This package implements [emph parameters], collections of which (see
[package cmdr::config]) serve as the configuration of privates (see
[package cmdr::private]).

Changes to doc/cmdr_vcommon.man.

1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_validate_common [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate::common]
[titledesc {Utilities for Validation Types}]
[description]
[include parts/welcome.inc]

This package publicly exports three commands for use in the
implementation of validation types.

The standard validation types defined in package





|







1
2
3
4
5
6
7
8
9
10
11
12
13
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_validate_common [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate::common]
[titledesc [vset TITLE_VCOMMON]]
[description]
[include parts/welcome.inc]

This package publicly exports three commands for use in the
implementation of validation types.

The standard validation types defined in package

Changes to doc/parts/definitions.inc.

2
3
4
5
6
7
8
9
10
11
12






13
14
15
16
17
18

19
20
21
22
[vset TITLE_INTRO    "[vset PTITLE] - Introduction to the project"]
[vset TITLE_LICENSE  "[vset PTITLE] - License"			 ]
[vset TITLE_CHANGES  "[vset PTITLE] - Log of Changes"    	 ]
[vset TITLE_SOURCES  "[vset PTITLE] - How To Get The Sources"	 ]
[vset TITLE_INSTALL  "[vset PTITLE] - The Installer's Guide"	 ]
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]
[comment {- Custom documents & titles - - -- --- ----- --------}]
[vset TITLE_DEV_HF    "[vset PTITLE] - Writing custom help formats"]
[vset TITLE_DEV_VT    "[vset PTITLE] - Writing custom validation types"]
[vset TITLE_ACTOR     "[vset PTITLE] - Base class for officers and privates - Internal"]
[vset TITLE_CONFIG    "[vset PTITLE] - Collection of parameters for privates"]






[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_DSL       "[vset PTITLE] - Specification Language"]

[comment {- Miscellanea ............. - - -- --- ----- --------}]
[comment {
	TODO - DSL introduction, examples, reference
}]







<
<


>
>
>
>
>
>





|
>




2
3
4
5
6
7
8


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
[vset TITLE_INTRO    "[vset PTITLE] - Introduction to the project"]
[vset TITLE_LICENSE  "[vset PTITLE] - License"			 ]
[vset TITLE_CHANGES  "[vset PTITLE] - Log of Changes"    	 ]
[vset TITLE_SOURCES  "[vset PTITLE] - How To Get The Sources"	 ]
[vset TITLE_INSTALL  "[vset PTITLE] - The Installer's Guide"	 ]
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]
[comment {- Custom documents & titles - - -- --- ----- --------}]


[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 ............. - - -- --- ----- --------}]
[comment {
	TODO - DSL introduction, examples, reference
}]