You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2006/01/24 05:04:23 UTC
svn commit: r371795 - in
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs: ./
controls/ netui/ wsm/
Author: ekoneil
Date: Mon Jan 23 20:04:18 2006
New Revision: 371795
URL: http://svn.apache.org/viewcvs?rev=371795&view=rev
Log:
Various documentation cleanup including renaming top-level documentation files:
- release_notes.xml -> release-notes.xml
- tutorial_controls.xml -> tutorial.xml
Also fixing up WSM and Controls documentation links to use XPath rather than unique document names in site.xml.
BB: self
Test: forrest clean build pass
Added:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial.xml
- copied, changed from r369175, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/release-notes.xml
- copied unchanged from r369175, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/release_notes.xml
Removed:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/guide.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/release_notes.xml
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/gettingStarted.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/programming.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/wsm/getting_started.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/gettingStarted.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/gettingStarted.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/gettingStarted.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/gettingStarted.xml Mon Jan 23 20:04:18 2006
@@ -9,9 +9,9 @@
To get started developing and using controls, see the <strong>user's guide</strong> topics:
</p>
<ul>
- <li><a href="site:control_overview">Controls Overview</a></li>
- <li><a href="site:control_programming">Control Programming</a></li>
- <li><a href="site:control_containment">Control Containment</a></li>
+ <li><a href="site:docs/controls/overview">Controls Overview</a></li>
+ <li><a href="site:docs/controls/programming">Control Programming</a></li>
+ <li><a href="site:docs/controls/containment">Control Containment</a></li>
</ul>
<p>
The following <strong>project template</strong> will help you get a Control project started:
@@ -23,7 +23,7 @@
The following <strong>tutorial</strong> will familiarize you with the steps for building and testing a Control:
</p>
<ul>
- <li><a href="site:tutorial_control">Controls Tutorial</a></li>
+ <li><a href="site:docs/controls/tutorial">Controls Tutorial</a></li>
</ul>
</body>
<footer>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/programming.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/programming.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/programming.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/programming.xml Mon Jan 23 20:04:18 2006
@@ -42,7 +42,7 @@
</ul>
<p>
An overview of the Control architecture and toolable access models can be found in
- the companion document entitled <a href="site:control_overview">Control Overview:
+ the companion document entitled <a href="site:docs/controls/overview">Control Overview:
Providing Simplified and Unified Access to J2EE Resources</a>
</p>
</section>
@@ -1853,7 +1853,7 @@
resource scope ends.
</p>
<p>
- For more details on resource management, refer to the <a href="site:control_overview">Control Overview</a>.
+ For more details on resource management, refer to the <a href="site:docs/controls/overview">Control Overview</a>.
</p>
</section>
<section>
Copied: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial.xml (from r369175, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml)
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial.xml?p2=beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial.xml&p1=beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml&r1=369175&r2=371795&rev=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial.xml Mon Jan 23 20:04:18 2006
@@ -19,7 +19,7 @@
<li>How to test a Control using JUnit</li>
</ul>
<p>
- For a technical description of Controls, see the <a href="site:control_programming">Controls programming guide</a>.
+ For a technical description of Controls, see the <a href="site:docs/controls/programming">Controls programming guide</a>.
</p>
</section>
<section id="setup">
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml Mon Jan 23 20:04:18 2006
@@ -44,9 +44,9 @@
good starting points:
</p>
<ul>
- <li><a href="site:control_overview">Controls</a></li>
+ <li><a href="site:docs/controls/overview">Controls</a></li>
<li><a href="site:pageflow_overview">NetUI</a></li>
- <li><a href="site:wsm_overview">Web Service Metadata</a></li>
+ <li><a href="site:docs/wsm/overview">Web Service Metadata</a></li>
</ul>
<p>
To get started building Beehive-enabled projects, follow the <a href="site:setup">Setup</a> instructions and look at the
@@ -63,17 +63,17 @@
More detailed information on starting projects is available in the <strong>getting started</strong> guides:
</p>
<ul>
- <li><a href="site:control_getting_started">Controls</a></li>
+ <li><a href="site:docs/controls/getting_started">Controls</a></li>
<li><a href="site:pageflow_getting_started">NetUI</a></li>
- <li><a href="site:wsm_getting_started">Web Service metadata</a></li>
+ <li><a href="site:docs/wsm/getting_started">Web Service metadata</a></li>
</ul>
<p>
The <strong>tutorials</strong> are end-to-end examples of how to build projects with Beehive features:
</p>
<ul>
- <li><a href="site:tutorial_control">Controls</a></li>
+ <li><a href="site:docs/controls/tutorial">Controls</a></li>
<li><a href="site:tutorial_pageflow">NetUI</a></li>
- <li><a href="site:wsm/tutorial">Web Service Metadata</a></li>
+ <li><a href="site:docs/wsm/tutorial">Web Service Metadata</a></li>
</ul>
<p>
The <strong>samples</strong> are another good starting point for learning about Beehive.
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml Mon Jan 23 20:04:18 2006
@@ -43,7 +43,7 @@
<a href="site:docs/pageflow/tags/pageflow_tag_overview">NetUI JSP tag library</a>.
</li>
<li>How page flows help to separate data processing and data presentation.</li>
- <li>How to make a web application a client of a <a href="site:control_overview">Java control</a>.</li>
+ <li>How to make a web application a client of a <a href="site:docs/controls/overview">Java control</a>.</li>
<li>
How to use
<a href="site:docs/pageflow/netuiBasic/validation">declarative validation</a> with data submission.
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml Mon Jan 23 20:04:18 2006
@@ -1,11 +1,12 @@
<?xml version="1.0"?>
+
<site label="Beehive" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="release-svn">
<docs label="Documentation" tab="release-svn">
<setup label="Setup" href="setup.html"/>
<tutorials label="Tutorials">
<tutorial_setup label="Setup" href="tutorial/setup.html"/>
<tutorial_pageflow label="NetUI" href="netui/tutorial_pageflow.html"/>
- <tutorial_control label="Controls" href="controls/tutorial_controls.html"/>
+ <tutorial_control label="Controls" href="controls/tutorial.html"/>
<tutorial_system-controls label="System Controls">
<control label="EJB Control" href="system-controls/ejb/ejbControlTutorial.html"/>
<control label="JDBC Control" href="system-controls/jdbc/jdbcControlTutorial.html"/>
@@ -18,68 +19,69 @@
<pageflow_overview label="NetUI Overview" href="netui/overview.html"/>
<pageflow_controllers label="Controller Classes" href="netui/pageFlowControllers.html"/>
<pageflow_jsp label="JSP Files" href="netui/jspOverview.html">
- <pageflow_jspOverview_SimpleLinking href="#SimpleLinking" />
- <pageflow_jspOverview_StartingJSP href="#StartingJSP" />
+ <pageflow_jspOverview_SimpleLinking href="#SimpleLinking"/>
+ <pageflow_jspOverview_StartingJSP href="#StartingJSP"/>
</pageflow_jsp>
<netuiProjects label="Project Model" href="netui/projects.html">
<sourceOut href="#projectLayoutSourceOut"/>
</netuiProjects>
<pageflow_altering label="Altering a Page Flow" href="netui/alteringPageFlow.html"/>
+ <pageflow_tutorial label="Tutorial" href="netui/tutorial_pageflow.html"/>
</netuiIntro>
<netuiBasic label="Basic Topics">
<actions label="Actions" href="netui/actions.html">
<raising href="#raising"/>
</actions>
<databinding label="Data binding" href="netui/databinding.html">
- <databinding_container href="#implicit-objects-netui-container" />
- <databinding_implicitObjectsNetui href="#implicit-objects-netui" />
- <pageInput href="#implicit-objects-netui-pageInput" />
+ <databinding_container href="#implicit-objects-netui-container"/>
+ <databinding_implicitObjectsNetui href="#implicit-objects-netui"/>
+ <pageInput href="#implicit-objects-netui-pageInput"/>
</databinding>
<exceptionHandling label="Exception Handling" href="netui/exceptionHandling.html"/>
<validation label="Validation" href="netui/validation.html"/>
- <ffdfdfdfd label="Lifecycle and State" href="netui/lifecycleAndState.html"/>
+ <lifecycleAndState label="Lifecycle and State" href="netui/lifecycleAndState.html"/>
<nestedPageFlow label="Nested Page Flows" href="netui/nestedPageFlow.html"/>
<pageflow_jsf label="Java Server Faces" href="netui/jsf.html"/>
</netuiBasic>
<tags label="Tags">
- <pageflow_tag_overview label="Overview" href="netui/tagsOverview.html" />
- <pageflow_tag_htmlMapping label="HTML Mapping" href="netui/tagsHtmlMapping.html" />
+ <pageflow_tag_overview label="Overview" href="netui/tagsOverview.html"/>
+ <pageflow_tag_htmlMapping label="HTML Mapping" href="netui/tagsHtmlMapping.html"/>
<pageflow_tag_formControls label="Form Controls" href="netui/tagsFormControls.html">
- <pageflow_tag_formControls_anchor href="#Anchor" />
- <pageflow_tag_formControls_button href="#Button" />
- <pageflow_tag_formControls_checkbox href="#CheckBox" />
- <pageflow_tag_formControls_checkboxgroup href="#CheckBoxGroup" />
- <pageflow_tag_formControls_checkboxoption href="#CheckBoxOption" />
- <pageflow_tag_formControls_fileupload href="#FileUpload" />
- <pageflow_tag_formControls_form href="#Form" />
- <pageflow_tag_formControls_hidden href="#Hidden" />
- <pageflow_tag_formControls_imagebutton href="#ImageButton" />
- <pageflow_tag_formControls_radiobuttongroup href="#RadioButtonGroup" />
- <pageflow_tag_formControls_radiobuttonoption href="#RadioButtonOption" />
- <pageflow_tag_formControls_select href="#Select" />
- <pageflow_tag_formControls_selectoption href="#SelectOption" />
- <pageflow_tag_formControls_textarea href="#TextArea" />
- <pageflow_tag_formControls_textbox href="#TextBox" />
+ <pageflow_tag_formControls_anchor href="#Anchor"/>
+ <pageflow_tag_formControls_button href="#Button"/>
+ <pageflow_tag_formControls_checkbox href="#CheckBox"/>
+ <pageflow_tag_formControls_checkboxgroup href="#CheckBoxGroup"/>
+ <pageflow_tag_formControls_checkboxoption href="#CheckBoxOption"/>
+ <pageflow_tag_formControls_fileupload href="#FileUpload"/>
+ <pageflow_tag_formControls_form href="#Form"/>
+ <pageflow_tag_formControls_hidden href="#Hidden"/>
+ <pageflow_tag_formControls_imagebutton href="#ImageButton"/>
+ <pageflow_tag_formControls_radiobuttongroup href="#RadioButtonGroup"/>
+ <pageflow_tag_formControls_radiobuttonoption href="#RadioButtonOption"/>
+ <pageflow_tag_formControls_select href="#Select"/>
+ <pageflow_tag_formControls_selectoption href="#SelectOption"/>
+ <pageflow_tag_formControls_textarea href="#TextArea"/>
+ <pageflow_tag_formControls_textbox href="#TextBox"/>
</pageflow_tag_formControls>
<pageflow_tag_formControls_example href="netui/tagsFormControlsExample.html"/>
<pageflow_tag_repeating label="Repeating Form Controls" href="netui/tagsFormRepeating.html">
- <pageflow_tag_repeating_checkboxgroup href="#CheckBoxGroup" />
- <pageflow_tag_repeating_radiobuttongroup href="#RadioButtonGroup" />
- <pageflow_tag_repeating_select href="#Select" />
+ <pageflow_tag_repeating_checkboxgroup href="#CheckBoxGroup"/>
+ <pageflow_tag_repeating_radiobuttongroup href="#RadioButtonGroup"/>
+ <pageflow_tag_repeating_select href="#Select"/>
</pageflow_tag_repeating>
<pageflow_tag_xhtml label="HTML/XHTML Support" href="netui/tagsXhtml.html">
- <pageflow_tagsXhtml_HtmlTag href="#HtmlTag" />
- <pageflow_tagsXhtml_BodyTag href="#BodyTag" />
- <pageflow_tagsXhtml_ScriptBlock href="#scriptBlockTag" />
+ <pageflow_tagsXhtml_HtmlTag href="#HtmlTag"/>
+ <pageflow_tagsXhtml_BodyTag href="#BodyTag"/>
+ <pageflow_tagsXhtml_ScriptBlock href="#scriptBlockTag"/>
</pageflow_tag_xhtml>
<pageflow_tag_javascript label="JavaScript Support" href="netui/tagsJavascript.html">
- <pageflow_tagsJavascript_ScriptContainer href="#ScriptContainer" />
- <pageflow_tagsJavascript_ScriptBlock href="#ScriptBlock" />
+ <pageflow_tagsJavascript_ScriptContainer href="#ScriptContainer"/>
+ <pageflow_tagsJavascript_ScriptBlock href="#ScriptBlock"/>
</pageflow_tag_javascript>
- <pageflow_tag_tree label="Trees" href="netui/tagsTree.html" />
+ <pageflow_tag_tree label="Trees" href="netui/tagsTree.html"/>
<repeater label="Repeating" href="netui/repeater.html"/>
<datagrid label="Data Grids" href="netui/datagrid.html"/>
- <pageflow_template label="Templates" href="netui/tagsTemplate.html" />
+ <pageflow_template label="Templates" href="netui/tagsTemplate.html"/>
</tags>
<pageflow_advanced label="Advanced Topics">
<pageflow_inheritance label="Inheritance" href="netui/pageFlowInheritance.html"/>
@@ -91,27 +93,24 @@
<devmode label="Development Mode" href="netui/dev_mode.html"/>
</pageflow_advanced>
<pageflow_faq label="FAQ" href="netui/faq.html"/>
- <!--<pageflow_programming label="Page Flow Programming" href="netui/guide.html"/>-->
</pageflow>
- <!-- This is a set of internal links that the tag documentation uses to link between sections -->
- <pageflow_tag_links>
- </pageflow_tag_links>
<controls label="Controls">
- <control_getting_started label="Getting Started" href="controls/gettingStarted.html"/>
- <control_overview label="Overview" href="controls/overview.html"/>
- <control_programming label="Programming" href="controls/programming.html"/>
- <control_containment label="Controls Containment" href="controls/containment.html"/>
+ <getting_started label="Getting Started" href="controls/gettingStarted.html"/>
+ <overview label="Overview" href="controls/overview.html"/>
+ <programming label="Programming" href="controls/programming.html"/>
+ <containment label="Container" href="controls/containment.html"/>
<projects label="Project Model" href="controls/projects.html"/>
+ <tutorial label="Tutorial" href="controls/tutorial.html"/>
</controls>
<controls label="System Controls">
- <ejb_control label="EJB Control" href="system-controls/ejb/ejbDoc.html"/>
- <jdbc_control label="JDBC Control" href="system-controls/jdbc/jdbcControlDevGuide.html"/>
- <jms_control label="JMS Control" href="system-controls/jms/jmsDoc.html"/>
- <webservices_control label="Web Services Control" href="system-controls/webservices/webservicesDoc.html"/>
+ <ejb label="EJB Control" href="system-controls/ejb/ejbDoc.html"/>
+ <jdbc label="JDBC Control" href="system-controls/jdbc/jdbcControlDevGuide.html"/>
+ <jms label="JMS Control" href="system-controls/jms/jmsDoc.html"/>
+ <webservices label="Web Services Control" href="system-controls/webservices/webservicesDoc.html"/>
</controls>
<wsm label="Web Services">
- <wsm_getting_started label="Getting Started" href="wsm/getting_started.html"/>
- <wsm_overview label="Overview" href="wsm/wsm_overview.html"/>
+ <getting_started label="Getting Started" href="wsm/getting_started.html"/>
+ <overview label="Overview" href="wsm/wsm_overview.html"/>
<tutorial label="Tutorial" href="wsm/tutorial_wsm.html"/>
<jws_files label="Java Web Services" href="wsm/wsm_JWSFiles.html"/>
<supported_datatypes label="Supported Data Types" href="wsm/datatypes.html"/>
@@ -120,13 +119,13 @@
<sam_index label="Overview" href="samples/index.html"/>
<petstore label="Petstore" href="samples/petstore.html"/>
<netui-samples label="NetUI Samples" href="netui/netui-samples.html"/>
- <netui-jsf label="NetUI: JSF Integration" href="netui/sample_jpf_jsf_integration.html"/>
- <address-enhanced label="Web Service: AddressBook Enhanced" href="wsm/sample_AddressBookEnhanced.html"/>
- <address-wsdl label="Web Service: AddressBook from WSDL" href="wsm/sample_AddressBookFromWSDL.html"/>
+ <netui-jsf label="NetUI + JSF Integration" href="netui/sample_jpf_jsf_integration.html"/>
+ <address-enhanced label="WSM AddressBook Enhanced" href="wsm/sample_AddressBookEnhanced.html"/>
+ <address-wsdl label="WSM AddressBook from WSDL" href="wsm/sample_AddressBookFromWSDL.html"/>
<netui-blank label="Project: NetUI" href="netui/sample_netui-blank.html"/>
<control-blank label="Project: Control" href="controls/sampleControlsBlank.html"/>
<wsm-blank label="Project: Web Service" href="wsm/sample_wsm-blank.html"/>
- <ws-control-blank label="Project: Web Service Control" href="system-controls/webservices/sample-ws-control-blank.html" />
+ <ws-control-blank label="Project: Web Service Control" href="system-controls/webservices/sample-ws-control-blank.html"/>
</samples>
<reference label="Reference">
<infra label="Build Tools">
@@ -143,10 +142,10 @@
<javadoc label="API Javadoc" href="apidocs/classref_netui/index.html"/>
<taglib label="JSP Tags" href="apidocs/taglib/index.html"/>
<netui_config label="beehive-netui-config.xml" href="netui/config/beehive-netui-config.html">
- <config_doctype href="#doctype" />
- <config_description href="#desc" />
- <config_id_javascript href="#id-javascript" />
- <config_tree_renderer_class href="#tree-renderer-class" />
+ <config_doctype href="#doctype"/>
+ <config_description href="#desc"/>
+ <config_id_javascript href="#id-javascript"/>
+ <config_tree_renderer_class href="#tree-renderer-class"/>
</netui_config>
</netui>
<ws label="Web Services">
@@ -178,7 +177,7 @@
<system-controls label="System Controls" href="apidocs/classref_systemcontrols/index.html"/>
</javadoc>
</reference>
- <release_notes label="Release Notes" href="release_notes.html"/>
+ <release_notes label="Release Notes" href="release-notes.html"/>
<gloss label="Glossary" href="glossary.html"/>
</docs>
<external-refs>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/wsm/getting_started.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/wsm/getting_started.xml?rev=371795&r1=371794&r2=371795&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/wsm/getting_started.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/wsm/getting_started.xml Mon Jan 23 20:04:18 2006
@@ -7,14 +7,8 @@
<body>
<p>For an introduction to the <strong>basic concepts</strong> of Web Service technology, see the topic:</p>
<ul>
- <li> <a href="site:wsm_overview">Web Services Overview</a></li>
+ <li> <a href="site:docs/wsm/overview">Web Services Overview</a></li>
</ul>
-<!--
- <p>The following <strong>tutorial</strong> demonstrates the basic development cycle for Beehive web services:</p>
- <ul>
- <li><a href="site:tutorial_wsm">Beehive Web Service Tutorial</a></li>
- </ul>
--->
<p>The following <strong>sample</strong> demonstrates the basic Beehive web service features: </p>
<ul>
<li><a href="site:address-enhanced">Web Service: AddressBook Enhanced</a></li>