cmdr
Check-in [1a9bcfb664]
Not logged in
Myself Home DocumentationDownloads Tickets | Timeline Branches Tags Wiki Login

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

Overview
Comment:Added early mention and reference to custom validation types and help formats to the main intro
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 1a9bcfb66465e0199d972eb2e901f5090b1a0e12
User & Date: andreask 2013-11-29 19:36:28.515
Original Comment: Added early mention and reference to cutom val. types and help formaats to the main intro
Context
2013-11-30
02:34
Regenerated embedded docs. check-in: e0642cf6ae user: aku tags: trunk
2013-11-29
19:36
Added early mention and reference to custom validation types and help formats to the main intro check-in: 1a9bcfb664 user: andreask tags: trunk
06:41
Image tweak, regenerated embedded. check-in: f244dccfb4 user: aku tags: trunk
Changes
Unified Diff Ignore Whitespace Patch
Changes to doc/cmdr_introduction.man.
︙︙
24
25
26
27
28
29
30

































31
32
33
34
35

[section {System Architecture}]
[include parts/architecture.inc]

[section {Command Hierarchy Specifications}]

This is a bit large for this document, and can be found in the
separate [term [vset TITLE_DSL]].


































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









>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>






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

[section {System Architecture}]
[include parts/architecture.inc]

[section {Command Hierarchy Specifications}]

This is a bit large for this document, and can be found in the
separate [term [vset TITLE_DSL]].

[section {Extensibility}]

While the framework as is should cover most to all of the common cases
where is always the possibility of encountering unanticipated
situations.

Because of that the framework has two places where it can be extended
to make it fit uncommon requirements.

And while the DSL document chain referenced in the previous section
does mention these as well in the appropriate places this is a bit
hidden.

So, for better visibility, an early mention:

[list_begin enumerated]

[enum] While the framework has a set of standard validation types for
checking and converting inputs these handle only very generic types of
input.

Applications often have special input requiring bespoke validation.

How to write such is explained in [term [vset TITLE_DEV_VT]].

[enum] Less often an application may require a special format for help
generated from its command hierarchy, beyond the standard formats made
available by the framework.

How to write such is explained in [term [vset TITLE_DEV_HF]].

[list_end]

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