|
| Summary: | [Chameleon - doc builder] Automating tag code structure. | ||
|---|---|---|---|
| Product: | Chameleon | Reporter: | Chris Thorne <cthorne@dmsolutions.ca> |
| Component: | AutoDoc | Assignee: | William Bronsema <wbronsema@dmsolutions.ca> |
| Status: | NEW | ||
| Severity: | enhancement | CC: | chameleon-dev@lists.maptools.org |
| Priority: | P2 | ||
| Version: | 1.99 | ||
| Target Milestone: | FUTURE | ||
| Hardware: | PC | ||
| OS: | Windows 2000 | ||
| Whiteboard: | Task For Discussion - 20041102 | ||
oops please us this tag structure example not the last one (copy/paste mistake): <cham:widgetdoc> <cham:tagstructures> <cham:tagstructure> <cham:code> <cham:codeblock bold="true" > <cham:line><CWC2 TYPE="Cursorpos"</cham:line> </cham:codeblock> <cham:codeblock bold="false"> <cham:line> ENABLED="[TRUE|FALSE]"</cham:line> <cham:line> FORMINDEX="[0 < integer]"</cham:line> <cham:line> VISIBLE="[TRUE|FALSE]"</cham:line> <cham:line></cham:line> <cham:line> <!-- CursorPos Attributes--></cham:line> </cham:codeblock> <cham:codeblock bold="true"> <cham:line> AXIS="[X|Y]"</cham:line> </cham:codeblock> <cham:codeblock bold="false"> <cham:line> TEXTFIELDSIZE="[0 < integer]"</cham:line> <cham:line> WIDGETCLASS="[string]"</cham:line> <cham:line> WIDGETSTYLE="[string]"</cham:line> <cham:line></cham:line> <cham:line> <!-- Label Attribute Group--></cham:line> <cham:line></cham:line> <cham:line> LABEL="[string]"</cham:line> <cham:line> LABELPOSITION="[0 < integer < 8]"</cham:line> <cham:line> LABELHALIGN="[LEFT|CENTER|RIGHT]"</cham:line> <cham:line> LABELVALIGN="[TOP|MIDDLE|BOTTOM]"</cham:line> <cham:line> LABELCLASS="[string]"</cham:line> <cham:line> LABELSTYLE="[string]"/></cham:line> </cham:codeblock> </cham:code> </cham:tagstructure> </cham:tagstructures> </cham:widgetdoc>
bill please read comment 1 and make comments on this.... I cannot descide its importants without your input. Personnelly it will make the job easier to create the widget docs. The issue here is about the effort required to do this. there is code from the old doc builder process could this be reused?
Chris, are you asking if it is possible for doc_builder to automatically add "<cham:line>" whereever you want <cr>? Technically this is possible (all though fairly complex), but the codeblock is built manually anyway so it doesn't make a lot of sense to require you to run doc_builder, edit the file, then run doc builder again, does it? No, there is no code that can be reused for this, it would be written from scratch.
ok, I think I know how to create tag syntax based on the values entered in the <ca:widgettag> setion using xslt to edit the xml doc itself. This will probably a future enhancement to doc builder. Setting Target to FUTURE.
As a result of fixing bug 742, this opened up the possibility to re incorparate the old automated tag structure code. The reason why it was not added before what the simple fact that the old tag structure code did not format the widget tag string. Currently to add these tag structures to the widget doc is a manual process. Below is an example of an xml structure: <cham:widgetdoc> <cham:tagstructures> <cham:tagstructure> <cham:code> <cham:codeblock bold="true" > <cham:line><CWC2 TYPE="MapSize"</cham:line> </cham:codeblock> <cham:codeblock bold="false"> <cham:line> ENABLED="[TRUE|FALSE]"</cham:line> <cham:line> FORMINDEX="[0 < integer]"</cham:line> <cham:line> VISIBLE="[TRUE|FALSE]"</cham:line> <cham:line></cham:line> <cham:line> <!-- MapSize Attributes --></cham:line> <cham:line></cham:line> <cham:line> EMBEDDED="[TRUE|FALSE]"</cham:line> <cham:line></cham:line> <cham:line> <!-- Popup Attribute Group --></cham:line> <cham:line></cham:line> </cham:codeblock> <cham:codeblock bold="true" > <cham:line><CWC2 TYPE="Cursorpos"</cham:line> </cham:codeblock> <cham:codeblock bold="false"> <cham:line> ENABLED="[TRUE|FALSE]"</cham:line> <cham:line> FORMINDEX="[0 < integer]"</cham:line> <cham:line> VISIBLE="[TRUE|FALSE]"</cham:line> <cham:line></cham:line> <cham:line> <!-- CursorPos Attributes--></cham:line> </cham:codeblock> <cham:codeblock bold="true"> <cham:line> AXIS="[X|Y]"</cham:line> </cham:codeblock> <cham:codeblock bold="false"> <cham:line> TEXTFIELDSIZE="[0 < integer]"</cham:line> <cham:line> WIDGETCLASS="[string]"</cham:line> <cham:line> WIDGETSTYLE="[string]"</cham:line> <cham:line></cham:line> <cham:line> <!-- Label Attribute Group--></cham:line> <cham:line></cham:line> <cham:line> LABEL="[string]"</cham:line> <cham:line> LABELPOSITION="[0 < integer < 8]"</cham:line> <cham:line> LABELHALIGN="[LEFT|CENTER|RIGHT]"</cham:line> <cham:line> LABELVALIGN="[TOP|MIDDLE|BOTTOM]"</cham:line> <cham:line> LABELCLASS="[string]"</cham:line> <cham:line> LABELSTYLE="[string]"/></cham:line> </cham:codeblock> </cham:code> </cham:tagstructure> </cham:tagstructures> </cham:widgetdoc> Things to make note of: * bold="true|false" define what is a require tag feature of the tag structure: * each<cham:line> represents a <br>. * It is important that the spaces between <cham:line> </cham:line> are added and maintained. These spaces allow indentation and proper formatting of the code. The next questions are: * how much effort would this be, (bill)? * when should this be implemented, (darren/paul)?