Seems an odd order for me. I would think a person would want to see it from general to specific. To acheive this, it seems like we'd proceed more like:
0 - Preface 1 - Introduction 2 - web.xml - Some blurbage about the role of this file in Struts operations. 2.1 - Relevant elements of config from here . . . 2.x - ... through here 3 - struts-config.xml - Some blurbage about the role of this file in Struts operations. 3.1 - Elements of config from here . . . 3.x - ... through here. 4 - Getting Started *shrug* The important thing is that there is documentation that accurately reflects the state of the project (like you said). The form, for those really willing to look, is less important. On Mon, 20 Dec 2004 10:23:54 -0500, Ted Husted <[EMAIL PROTECTED]> wrote: > Documentation for 1.3++ has come up in a couple of threads, and I wanted to > jot something down before I forgot. > > In the 1.3.x series, we are moving taglibs to a separate project, which gives > us a chance to revisit the documentation. > > For core, I would like to use the DTD as the basis for the documentation. (We > even have an enhancement ticket to do so.) Sections 0 and 1 of the User Guide > could stay as is, but after that, we could march through each element the > DTD, combining the existing DTD material with stuff we have scattered > throughout sections 2 - 4. (In other words, expand 5 to incorporate 2-4.) > > 0 - Preface > 1 - Introduction > 2 - struts-config.xml > 3 - Form Beans > 4 - Exceptions > 5- Forwards > 6 - Action Mappings > 7 - Action > 8 - Controller > 9 - Messager Resources > 10 - Plug Ins > 11 - web.xml > 12 - Getting Started > > Then do the same for the Validator and Tiles DTDs. > > >From an all-important maintenance perspective, we would update, add, or > >delete User Guide sections as corresponding changes are made to the DTD > >elements. > > When available, we could also link to corresponding Developer Guides (JavaDoc > package descrptions). Right now, we have these for the Validator and Util > package, but we should also have Developer Guides for Action, Config, and > Upload, to help pull people into our very excellent JavaDocs. > > Again, from a maintenance perspective, we would update, add, or delete > Developers Guides as changes are made to the corresponding Java packages. > > * User Guide == DTD > * Developers Guide == Java Packages > > For taglibs, what we have works for me. We could just move the Bean, HTML, > Logic, Nested, and Tiles Developer Guides and API references into the new > subproject, and add an overview. > > -Ted. -- Eddie Bush --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
