ADDED doc/cmdr_help_tcl.man Index: doc/cmdr_help_tcl.man ================================================================== --- /dev/null +++ doc/cmdr_help_tcl.man @@ -0,0 +1,20 @@ +[comment {-*- tcl -*- doctools manpage}] +[include parts/definitions.inc] +[manpage_begin [vset LABEL_HELP_TCL] [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[require cmdr::help::tcl] +[titledesc [vset TITLE_HELP_TCL]] +[description] +[include parts/welcome.inc] + +This package provides a single command implementing the help format +[const tcl]. This format generates help in the form of a nested Tcl +data structure containing all details of the command hierarchy, +including internals. + +[para] To activate the format simply [example { + package require cmdr::help::tcl +}] it. Nothing more is needed. + +[include parts/feedback.inc] +[manpage_end] Index: doc/cmdr_howto_development.man ================================================================== --- doc/cmdr_howto_development.man +++ doc/cmdr_howto_development.man @@ -68,10 +68,11 @@ [def [file cmdr.tcl]] Package [package cmdr]. [def [file config.tcl]] Package [package cmdr::config]. [def [file help.tcl]] Package [package cmdr::help]. [def [file help_json.tcl]] Package [package cmdr::help::json]. [def [file help_sql.tcl]] Package [package cmdr::help::sql]. +[def [file help_tcl.tcl]] Package [package cmdr::help::tcl]. [def [file officer.tcl]] Package [package cmdr::officer]. [def [file parameter.tcl]] Package [package cmdr::parameter]. [def [file private.tcl]] Package [package cmdr::private]. [def [file util.tcl]] Package [package cmdr::util]. [def [file validate.tcl]] Package [package cmdr::validate]. Index: doc/figures/pkg_dependencies.dia ================================================================== --- doc/figures/pkg_dependencies.dia +++ doc/figures/pkg_dependencies.dia @@ -27,11 +27,17 @@ group { down ; ---> 16 ; help } } proc help_sql {} { box cmdr::help::sql width [grid 10] color blue stroke 2 - group { down ; --- ; l ; --- 4 ; r ; ---> 14 ; # help + group { down ; --- ; l ; --- 4.25 ; r ; ---> 14 ; # help + } +} + +proc help_tcl {} { + box cmdr::help::tcl width [grid 10] color blue stroke 2 + group { down ; --- 2 ; l ; --- 9.5 ; r ; ---> 13 ; # help } } proc config {} { box cmdr::config color blue stroke 2 dashed @@ -67,11 +73,13 @@ move move help_json move help_sql + move + help_tcl move } ## ==================================================================== layout Index: doc/figures/pkg_dependencies.png ================================================================== --- doc/figures/pkg_dependencies.png +++ doc/figures/pkg_dependencies.png cannot compute difference between binary files Index: doc/parts/definitions.inc ================================================================== --- doc/parts/definitions.inc +++ doc/parts/definitions.inc @@ -19,10 +19,11 @@ [vset TITLE_DSL_PRIVATE "[vset PTITLE] - Private Specification Language"] [vset TITLE_DSL_PARAMETER "[vset PTITLE] - Parameter Specification Language"] [vset TITLE_HELP "[vset PTITLE] - (Internal) Utilities for help text formatting and setup"] [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_HELP_TCL "[vset PTITLE] - Formatting help as Tcl data structure"] [vset TITLE_OFFICER "[vset PTITLE] - (Internal) Aggregation of multiple commands for dispatch."] [vset TITLE_PARAMETER "[vset PTITLE] - (Partially internal) Command parameters"] [vset TITLE_PRIVATE "[vset PTITLE] - (Internal) Single command handling, options, and arguments"] [vset TITLE_UTIL "[vset PTITLE] - (Internal) General Utilities"] [vset TITLE_VALIDATE "[vset PTITLE] - Standard validation types for parameters"] @@ -49,12 +50,13 @@ [vset LABEL_DSL_PARAMETER [vset PROJECT]-spec-dsl-parameter] [vset LABEL_DSL_PRIVATE [vset PROJECT]-spec-dsl-private] [vset LABEL_HELP [vset PROJECT]::help] [vset LABEL_HELP_JSON [vset PROJECT]::help::json] [vset LABEL_HELP_SQL [vset PROJECT]::help::sql] +[vset LABEL_HELP_TCL [vset PROJECT]::help::tcl] [vset LABEL_OFFICER [vset PROJECT]::officer] [vset LABEL_PARAMETER [vset PROJECT]::parameter] [vset LABEL_PRIVATE [vset PROJECT]::private] [vset LABEL_UTIL [vset PROJECT]::util] [vset LABEL_VALIDATE [vset PROJECT]::validate] [vset LABEL_VCOMMON [vset PROJECT]::validate::common] [vset LABEL_FLOW [vset PROJECT]-spec-flow] ADDED embedded/man/files/cmdr_help_tcl.n Index: embedded/man/files/cmdr_help_tcl.n ================================================================== --- /dev/null +++ embedded/man/files/cmdr_help_tcl.n @@ -0,0 +1,284 @@ +'\" +'\" Generated from file 'cmdr_help_tcl\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2013 Andreas Kupries +'\" Copyright (c) 2013 Documentation, Andreas Kupries +'\" +'\" The definitions below are for supplemental macros used in Tcl/Tk +'\" manual entries. +'\" +'\" .AP type name in/out ?indent? +'\" Start paragraph describing an argument to a library procedure. +'\" type is type of argument (int, etc.), in/out is either "in", "out", +'\" or "in/out" to describe whether procedure reads or modifies arg, +'\" and indent is equivalent to second arg of .IP (shouldn't ever be +'\" needed; use .AS below instead) +'\" +'\" .AS ?type? ?name? +'\" Give maximum sizes of arguments for setting tab stops. Type and +'\" name are examples of largest possible arguments that will be passed +'\" to .AP later. If args are omitted, default tab stops are used. +'\" +'\" .BS +'\" Start box enclosure. From here until next .BE, everything will be +'\" enclosed in one large box. +'\" +'\" .BE +'\" End of box enclosure. +'\" +'\" .CS +'\" Begin code excerpt. +'\" +'\" .CE +'\" End code excerpt. +'\" +'\" .VS ?version? ?br? +'\" Begin vertical sidebar, for use in marking newly-changed parts +'\" of man pages. The first argument is ignored and used for recording +'\" the version when the .VS was added, so that the sidebars can be +'\" found and removed when they reach a certain age. If another argument +'\" is present, then a line break is forced before starting the sidebar. +'\" +'\" .VE +'\" End of vertical sidebar. +'\" +'\" .DS +'\" Begin an indented unfilled display. +'\" +'\" .DE +'\" End of indented unfilled display. +'\" +'\" .SO +'\" Start of list of standard options for a Tk widget. The +'\" options follow on successive lines, in four columns separated +'\" by tabs. +'\" +'\" .SE +'\" End of list of standard options for a Tk widget. +'\" +'\" .OP cmdName dbName dbClass +'\" Start of description of a specific option. cmdName gives the +'\" option's name as specified in the class command, dbName gives +'\" the option's name in the option database, and dbClass gives +'\" the option's class in the option database. +'\" +'\" .UL arg1 arg2 +'\" Print arg1 underlined, then print arg2 normally. +'\" +'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $ +'\" +'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +'\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +'\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +'\" # BS - start boxed text +'\" # ^y = starting y location +'\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +'\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +'\" # VS - start vertical sidebar +'\" # ^Y = starting y location +'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +'\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +'\" # Special macro to handle page bottom: finish off current +'\" # box/sidebar if in box/sidebar mode, then invoked standard +'\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +'\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +'\" # DE - end display +.de DE +.fi +.RE +.sp +.. +'\" # SO - start of list of standard options +.de SO +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 4c 8c 12c +.ft B +.. +'\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\fBoptions\\fR manual entry for details on the standard options. +.. +'\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +'\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +'\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.TH "cmdr::help::tcl" n 1\&.0 doc "Cmdr, a framework for command line parsing and dispatch" +.BS +.SH NAME +cmdr::help::tcl \- Cmdr - Formatting help as Tcl data structure +.SH SYNOPSIS +package require \fBcmdr::help::tcl \fR +.sp +.BE +.SH DESCRIPTION +.PP +Welcome to the Cmdr project, written by Andreas Kupries\&. +.PP +For availability please read \fICmdr - How To Get The Sources\fR\&. +.PP +This package provides a single command implementing the help format +\fBtcl\fR\&. This format generates help in the form of a nested Tcl +data structure containing all details of the command hierarchy, +including internals\&. +.PP +To activate the format simply +.CS + + + package require cmdr::help::tcl + +.CE +it\&. Nothing more is needed\&. +.SH "BUGS, IDEAS, FEEDBACK" +Both the package(s) and this documentation will undoubtedly contain +bugs and other problems\&. +Please report such at +\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&. +.PP +Please also report any ideas you may have for enhancements of +either package(s) and/or documentation\&. +.SH KEYWORDS +arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands +.SH COPYRIGHT +.nf +Copyright (c) 2013 Andreas Kupries +Copyright (c) 2013 Documentation, Andreas Kupries + +.fi Index: embedded/man/files/cmdr_howto_development.n ================================================================== --- embedded/man/files/cmdr_howto_development.n +++ embedded/man/files/cmdr_howto_development.n @@ -337,10 +337,13 @@ Package \fBcmdr::help::json\fR\&. .TP "\fIhelp_sql\&.tcl\fR" Package \fBcmdr::help::sql\fR\&. .TP +"\fIhelp_tcl\&.tcl\fR" +Package \fBcmdr::help::tcl\fR\&. +.TP "\fIofficer\&.tcl\fR" Package \fBcmdr::officer\fR\&. .TP "\fIparameter\&.tcl\fR" Package \fBcmdr::parameter\fR\&. Index: embedded/man/index.n ================================================================== --- embedded/man/index.n +++ embedded/man/index.n @@ -295,10 +295,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -379,10 +382,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -463,10 +469,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -547,10 +556,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -631,10 +643,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -715,10 +730,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -799,10 +817,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -883,10 +904,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -967,10 +991,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -1051,10 +1078,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -1135,10 +1165,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -1219,10 +1252,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -1303,10 +1339,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR @@ -1387,10 +1426,13 @@ \fBfiles/cmdr_help_json\&.n\fR cmdr::help::json .TP \fBfiles/cmdr_help_sql\&.n\fR cmdr::help::sql +.TP +\fBfiles/cmdr_help_tcl\&.n\fR +cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer .TP \fBfiles/cmdr_parameter\&.n\fR Index: embedded/man/toc.n ================================================================== --- embedded/man/toc.n +++ embedded/man/toc.n @@ -294,10 +294,13 @@ \fIfiles/cmdr_help_json\&.n\fR: Cmdr - Formatting help as JSON object .TP \fBcmdr::help::sql\fR \fIfiles/cmdr_help_sql\&.n\fR: Cmdr - Formatting help as series of SQL commands .TP +\fBcmdr::help::tcl\fR +\fIfiles/cmdr_help_tcl\&.n\fR: Cmdr - Formatting help as Tcl data structure +.TP \fBcmdr::officer\fR \fIfiles/cmdr_officer\&.n\fR: Cmdr - (Internal) Aggregation of multiple commands for dispatch\&. .TP \fBcmdr::parameter\fR \fIfiles/cmdr_parameter\&.n\fR: Cmdr - (Partially internal) Command parameters ADDED embedded/www/doc/files/cmdr_help_tcl.html Index: embedded/www/doc/files/cmdr_help_tcl.html ================================================================== --- /dev/null +++ embedded/www/doc/files/cmdr_help_tcl.html @@ -0,0 +1,157 @@ + +
+cmdr::help::tcl - Cmdr - Formatting help as Tcl data structure
+Welcome to the Cmdr project, written by Andreas Kupries.
+For availability please read Cmdr - How To Get The Sources.
+This package provides a single command implementing the help format +tcl. This format generates help in the form of a nested Tcl +data structure containing all details of the command hierarchy, +including internals.
+To activate the format simply
++ package require cmdr::help::tcl ++
it. Nothing more is needed.
+Both the package(s) and this documentation will undoubtedly contain +bugs and other problems. +Please report such at +Cmdr Tickets.
+Please also report any ideas you may have for enhancements of +either package(s) and/or documentation.
+arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
+Copyright © 2013 Andreas Kupries
+Copyright © 2013 Documentation, Andreas Kupries
Package cmdr::help.
Package cmdr::help::json.
Package cmdr::help::sql.
Package cmdr::help::tcl.
Package cmdr::officer.
Package cmdr::parameter.