cmdr
Check-in [5e924d81b9]
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 [email protected]
or submit via the online form by Sep 9.

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

Overview
Comment:Filled in the main package documentation (framework entrypoint)
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 5e924d81b92efff98541afbd7042cf6eff50fdd8
User & Date: andreask 2013-11-13 23:33:06
Context
2013-11-14
17:27
Updated embedded documentation check-in: 53634ad6ba user: aku tags: trunk
2013-11-13
23:33
Filled in the main package documentation (framework entrypoint) check-in: 5e924d81b9 user: andreask tags: trunk
22:44
Filled the officer documentation, and tweaked privates a bit. check-in: 65c018615d user: andreask tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to doc/cmdr.man.












































































































































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
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
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT] [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_MAIN]]
[description]
[include parts/welcome.inc]

This is the main package of the framework, its public entry point.

It provides four commands for setup and configuration of command
hierarchies.

[section API]
[list_begin definitions]
[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method new] [arg name] [arg specification]]

This command creates an automatically-named officer instance which is
the root of the command hierarchy given in the [arg specification],
and has the user-visible command [arg name].

[para] The result of the command is the new instance command.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method create] [arg obj] [arg name] [arg specification]]

This command creates the officer instance [arg obj] which is the root
of the command hierarchy given in the [arg specification], and has the
user-visible command [arg name].

[para] The result of the command is the new instance command.

[list_begin arguments]
[arg_def string name]
The user-visible name of the command (hierarchy).

[arg_def script actions]
The specification of the subordinate commands. On the command line
these are the toplevel commands of the application using the
hierarchy.

Please read [term [vset TITLE_DSL]], section --TODO-- for the details.
[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method interactive] [opt [arg enable]]]

This command globally (de)activates the interactive parts of the
framework, as per the value of [arg enable].

[para] By default (initial state) the framework allows interaction.

[list_begin arguments]

[arg_def boolean enable]
If not specified defaults to [const true], globally enabling the
interactive parts of the framework. The value [const false] globally
disables the interactive parts of the framework
[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method interactive?]]

This method returns the state of the global interaction flag.

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

Changes to doc/parts/definitions.inc.

2
3
4
5
6
7
8

9
10
11
12
13
14
15
[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"]






>







2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[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_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"]