You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by do...@apache.org on 2005/08/25 19:46:26 UTC

svn commit: r240110 - in /beehive/trunk/docs/forrest/release/src/documentation: content/xdocs/pageflow/jspOverview.xml content/xdocs/pageflow/tagsOverview.xml content/xdocs/pageflow/tagsXhtml.xml content/xdocs/site.xml resources/images/tagErrors.png

Author: dolander
Date: Thu Aug 25 10:46:21 2005
New Revision: 240110

URL: http://svn.apache.org/viewcvs?rev=240110&view=rev
Log:
Update the Tags Overview


Added:
    beehive/trunk/docs/forrest/release/src/documentation/resources/images/tagErrors.png   (with props)
Modified:
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/jspOverview.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsOverview.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsXhtml.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/jspOverview.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/jspOverview.xml?rev=240110&r1=240109&r2=240110&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/jspOverview.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/jspOverview.xml Thu Aug 25 10:46:21 2005
@@ -38,6 +38,7 @@
             for a new page.  Using this template will insure that the structure of the HTML page is valid
             and that all of the features in the tag library are enabled.
         </p>
+        <p><strong>Simple NetUI JSP Template</strong></p>
         <source><![CDATA[
 <%@ page language="java" contentType="text/html;charset=UTF-8"%>
 <%@ taglib prefix="netui" uri="http://beehive.apache.org/netui/tags-html-1.0"%>

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsOverview.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsOverview.xml?rev=240110&r1=240109&r2=240110&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsOverview.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsOverview.xml Thu Aug 25 10:46:21 2005
@@ -9,23 +9,101 @@
         <section id="Overview">
             <title>NetUI Tag Library Overview</title>
             <p> This topic provides an overview of the NetUI JSP tag libraries.  NetUI provides three tag
-                libraries, the core HTML tags, the data grid and a simple set of template tags.
+                libraries, the core HTML tags, the data grid tags and a simple set of template tags.
             </p>
             <table>
                 <tr><th>Tag Library URI</th><th>Prefix</th><th>Description</th></tr>
-                <tr><td><code>http://beehive.apache.org/netui/tags-html-1.0</code></td><td>netui</td><td>
+                <tr><td><code>http://beehive.apache.org/netui/tags-html-1.0</code></td><td><code>netui</code></td><td>
                     This is the primary tag library supporting HTML, including the form controls.  It provides a number
                     of features, used throughout the tag libraries, such as error reporting and base tags.  In addition,
                     it contains the Tree support.</td></tr>
-                <tr><td>http://beehive.apache.org/netui/tags-databinding-1.0</td><td>netui-data</td><td>
+                <tr><td><code>http://beehive.apache.org/netui/tags-databinding-1.0</code></td><td><code>netui-data</code></td><td>
                     This tag library provides binding to relational data, providing the Data Grid.  The feature
                     spans uses from simple tables, to sortable, filterable, pageable and updateable grids.
                     </td></tr>
-                <tr><td>http://beehive.apache.org/netui/tags-template-1.0</td><td>netui-template</td><td>
+                <tr><td><code>http://beehive.apache.org/netui/tags-template-1.0</code></td><td><code>netui-template</code></td><td>
                     This tag library provides a very simple templating facility, allowing common elements such
                     as headers, footers, etc.</td></tr>
             </table>
-            <p></p>
+            <p>The prefix is the prefix used within the documentation set and obviously can be changed.</p>
+            <p>In a typical JSP page, the following lines would be used to include each of the NetUI tag libraries:</p>
+            <source>
+&lt;%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
+&lt;%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
+&lt;%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
+            </source>
+            <p> For more information on JSP pages with Page Flows see the <a href="site:pageflow_jsp">JSP Files</a>
+                topic.  In particular, there is a very simple <a href="site:pageflow_jspOverview_StartingJSP">template</a>
+                providing a starting point for developing NetUI enabled JSP pages.
+            </p>
+            <p> The NetUI tags support binding values from implicit object to attributes through the
+                JSP 2.0 Expression Language (EL).  This
+                support is for <em>read-only</em> data.  In addition, many tags support <em>read-write</em>
+                access to implicit objects. This support is almost always done through the <strong>dataSource</strong>
+                attribute on the tags.  In addition, there are a number of binding contexts introduced to allow
+                binding to Page Flows and other NetUI implicit objects.
+                For more information on data binding see the
+                <a href="site:pageflow_databinding">Data binding to NetUI Implicit Objects</a> topic.
+            </p>
+        </section>
+        <section id="RuntimeErrors">
+            <title>Runtime Error Reporting</title>
+            <p> The Tag Libraries report runtime errors in a common way.  In the page fragment below, a set of
+                anchors have invalid attribute values.  There is an error reported where the tag would normally
+                have rendered HTML.  In addition, there is a table rendered at the end of the document that
+                contains the details of the errors.  In many cases, runtime errors in the tags result in the
+                tag reporting an error and rendering continues on.  This means that multiple errors will be
+                reported.  In addition, many tags will report multiple errors. Typically, errors wouldn't occur in
+                production because they would be fixed during development.  The error reporting is intended to
+                make developing new pages easier by making errors obvious.
+            </p>
+            <p><strong>Runtime Errors Reported in a Rendered Page</strong></p>
+            <p><img src="images/tagErrors.png" alt="Runtime Errors produced by the tags"/></p>
+        </section>
+        <section id="coreHtmlTags">
+            <title>Core HTML Tags</title>
+            <p> The core HTML tag library provides the core HTML elements.  These include both the HTML
+                structure and the HTML form controls.  In addition, the tags provide a number of core
+                features that are used by all of the NetUI tag libraries.
+            </p>
+            <p> The HTML tags have a simple and expected mapping to the HTML elements that they generate.  See
+                the <a href="site:pageflow_tag_htmlMapping">HTML to NetUI Tag Mapping</a> for details.  In addition,
+                the HTML controls, called form controls in this document, have additional details in the
+                <a href="site:pageflow_tag_formControls">NetUI Form Control Tags</a> topic.
+            </p>
+            <p> The HTML tags can support multiple versions of the HTML specifications, including HTML 4.01
+                and XHTML 1.0 Transitional.  The default format is specified for a WebApp and may be overridden
+                for an individual document.  For more information see the
+                <a href="site:pageflow_tag_xhtml">HTLM and XHTML Support</a> topic.
+            </p>
+            <p> NetUI provides the ability to build pages that are part of a larger composite page such as
+                a portal.  Part of this support is the ability to scope the HTML <strong>id</strong> attributes.
+                In order to allow client side JavaScript to run, the core tags provide support for accessing
+                the generated <strong>id</strong> and <strong>name</strong> values based upon a local name.  For
+                more information on JavaScript support see the
+                <a href="site:pageflow_tag_javascript">Tags Support for JavaScript</a> topic.
+            </p>
+            <p> Finally, the core tags provides a set of tags and classes that can be used to build complex
+                tree representations.  See the <a href="site:pageflow_tag_tree">Tree Tags</a> topic for information
+                on creating trees.
+            </p>
+        </section>
+        <section id="dataGridTags">
+            <title>Data Grid Tags</title>
+            <p>The NetUI data grid tag library provides tags to render grids of data in an HTML page.  The library
+                supports a range of features from simple tables to complex data features.  The complex features include
+                sortable columns, filtering, paging and updatable grids.  Styles can be applied to the grids to
+                customize their presentation.   For more information on the grid see the <a href="site:pageflow_datagrid">
+                NetUI Data Grids</a> topic.
+            </p>
+        </section>
+        <section id="templateTags">
+            <title>Template Tags</title>
+            <p> The template tags represent a very simple templating system.  The tags allow for a very simple
+                template page to be created.  Content pages then include their template to for the resulting
+                rendered page.  The content pages are written as sections of content that are inserted into defined
+                points inside the template. [We need to create a document detailing this]
+            </p>
         </section>
     </body>
 </document>

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsXhtml.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsXhtml.xml?rev=240110&r1=240109&r2=240110&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsXhtml.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsXhtml.xml Thu Aug 25 10:46:21 2005
@@ -3,7 +3,7 @@
 	"http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
     <header>
-        <title>Valid HTLM and XHTML</title>
+        <title>HTLM and XHTML Support</title>
     </header>
     <body>
         <section id="Intro">

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=240110&r1=240109&r2=240110&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 Thu Aug 25 10:46:21 2005
@@ -18,6 +18,7 @@
             <pageflow_controllers label="Controller Files" href="pageflow/pageflow_controllers.html"/>
             <pageflow_jsp label="JSP Files" href="pageflow/jspOverview.html">
                 <pageflow_jspOverview_SimpleLinking href="#SimpleLinking" />
+                <pageflow_jspOverview_StartingJSP href="#StartingJSP" />
             </pageflow_jsp>
             <pageflow_building label="Building a Web Project" href="pageflow/pageflow_building.html"/>
             <pageflow_altering label="Altering a Page Flow" href="pageflow/pageflow_altering.html"/>

Added: beehive/trunk/docs/forrest/release/src/documentation/resources/images/tagErrors.png
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/resources/images/tagErrors.png?rev=240110&view=auto
==============================================================================
Binary file - no diff available.

Propchange: beehive/trunk/docs/forrest/release/src/documentation/resources/images/tagErrors.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream