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/09/09 19:46:16 UTC

svn commit: r279836 - in /beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui: tagsJavascript.xml tagsTemplate.xml tagsTree.xml tagsXhtml.xml

Author: dolander
Date: Fri Sep  9 10:46:12 2005
New Revision: 279836

URL: http://svn.apache.org/viewcvs?rev=279836&view=rev
Log:
Additional documentation edits


Modified:
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsJavascript.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTemplate.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTree.xml
    beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsXhtml.xml

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsJavascript.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsJavascript.xml?rev=279836&r1=279835&r2=279836&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsJavascript.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsJavascript.xml Fri Sep  9 10:46:12 2005
@@ -19,7 +19,7 @@
             <p> NetUI owns the value of the
                 <strong>name</strong> attribute generated for the HTML form controls.
                 It's very common to write JavaScript that would like to access these control DOM elements
-                using the name.  The NetUI JavaScript support provides a mapping between the local name to the
+                using the name.  The NetUI JavaScript support provides a mapping between the local name and the
                 generated name.
             </p>
             <p> In addition, NetUI provides scoping facilities that ensure the HTML
@@ -47,7 +47,7 @@
                 on these methods.  All of the other JavaScript methods and the values of the HTML <strong>name</strong>
                 and <strong>id</strong> attributes output into the generated HTML may change over time.  Developers
                 should not build dependencies on these values.  In some cases, this document describes the details
-                of these low level features for explination purposes.
+                of these low level features for explanation purposes.
             </p>
         </section>
         <section id="TagsAndAttributes">
@@ -89,7 +89,7 @@
                     will cause a unique id scope name to be generated.  This value is unique for the request.
                 </p>
                 <p>The NetUI tags dynamically generate JavaScript in certain situations.
-                    The top most ScriptContainer gathers up generated JavaScript then render it into the HTML
+                    The top most ScriptContainer gathers up generated JavaScript then renders it into the HTML
                     document.  There isn't a requirement to have a ScriptContainer for most of the JavaScript
                     enabled features; this includes the lookup methods.  If the ScriptContainer is not present,
                     the generated
@@ -112,7 +112,8 @@
                     to the framework generated JavaScript.  This tag supports inserting JavaScript <strong>before</strong>
                     or <strong>after</strong>
                     the framework generated JavaScript.  When you want to create valid XHTML or HTML this tag is
-                    required. See the <a href="site:pageflow_tagsXhtml_ScriptBlock">Valid HTLM and XHTML</a> for more information
+                    required. See the <a href="site:pageflow_tagsXhtml_ScriptBlock">HTLM and XHTML Support</a> topic
+                    for more information
                     on creating valid XHTML and HTML using the NetUI JSP tags and information on the
                     <a href="site:pageflow_tagsXhtml_ScriptBlock">ScriptBlocks</a> role.
                 </p>
@@ -131,7 +132,7 @@
                 <p> This JSP file demonstrates the use of
                     <strong>tagId</strong> and scoping.
                     It also contains JavaScript that looks up DOM elements and dynamically creates some output
-                    verifying these elements are found.  The screen shot at the end of this page
+                    verifying these elements are found.  The screen shot at the end of this document
                     displays the expected dynamically generated content.
                 </p>
                 <p><strong>tagIdSupport.jsp</strong></p>
@@ -470,18 +471,19 @@
                     <p>These two methods act as the public interface to the framework lookup code.  NetUI will
                         maintain backward compatibility for these two methods.  The other code generated by the
                         framework and the value of the <strong>name</strong> and <strong>id</strong>
-                        attributes may change over time.  Developers should not build dependence on these features
+                        attributes may change over time.  These features should be considered "internal".
+                        Developers should not build dependence on these features
                         of the framework generated JavaScript support.
                     </p>
                     <p> <strong>Note:</strong> In the example, we are using an element found in the document using
                         the <strong>id</strong> attribute value.  This is actually not a typical usage because
                         the id value is not scoped by the framework.  This JSP could not be included twice
-                        in a composite page.
+                        in a composite page because it would result in the same <code>id</code> appearing multiple times.
                     </p>
             </section>
             <section id="ExampleBrowserResults">
                 <title>Browser Results</title>
-                <p>This section contains a screen shoot of the page from the browser.  The dynamically generated
+                <p>This section contains a screen shot of the page from the browser.  The dynamically generated
                     content can be seen.
                 </p>
                 <p>

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTemplate.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTemplate.xml?rev=279836&r1=279835&r2=279836&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTemplate.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTemplate.xml Fri Sep  9 10:46:12 2005
@@ -90,6 +90,11 @@
                 This content page will define a set of links which are displayed in the <code>left</code>
                 section and some content that is displayed in the <code>right</code> section.
             </p>
+            <p> The template page may be located anywhere in the site.  It does not have to be located in
+                the same location as the content page.  The <code>templatePage</code> attribute specifies the
+                template page an may be either absolute to the webapp root or relative to content page.
+
+            </p>
             <p><strong>index.jsp</strong></p>
             <source><![CDATA[
 <%@ page language="java"%>
@@ -168,7 +173,7 @@
    private String content =
             "&lt;h4>Today's Content&lt;/h4>" +
             "&lt;p>This is some content that would be found in a database or content managment system of some" +
-            "type.  For this example it's just hardwire into the page flow.";
+            "type.  For this example it's just hardwired into the page flow.";
 
     protected void onCreate()
     {

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTree.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTree.xml?rev=279836&r1=279835&r2=279836&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTree.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsTree.xml Fri Sep  9 10:46:12 2005
@@ -60,8 +60,8 @@
                     in a tree structure.  In this simple case, the tree has a root (0) with three children (0.0,
                     0.1, and 0.2).
                 </p>
-                <p> There are two required attributes on the <code>&lt;netui:tree></code> tag,
-                    <code>dataSource</code>
+                <p> There are three required attributes on the <code>&lt;netui:tree></code> tag,
+                    <code>dataSource</code>, <code>tagId</code>
                     and
                     <code>selectionAction</code>.  The <code>dataSource</code> is used to bind to a
                     <code>TreeElement</code> based data structure representing the tree to be displayed.
@@ -77,7 +77,7 @@
                     children (0.1 and 0.2) are defined with the label as the body of the <code>&lt;netui:treeItem></code>. The
                     <code>&lt;netui:treeItem></code> supports setting the label value from the body of the
                     <code>&lt;netui:treeItem></code> if it is a leaf in the tree.  You are required to use
-                    the <code>&lt;netui:treeLabel></code> for all interior nodes.  In other
+                    the <code>&lt;netui:treeLabel></code> for all interior nodes or nodes with children.  In other
                     words, <code>&lt;netui:treeItem></code> does not support mixed content; meaning that interior nodes must use
                     <code>&lt;netui:treeLabel></code> to set the label value and all text inside the body is ignored.
                 </p>
@@ -118,7 +118,7 @@
                     <code>begin</code> action and the
                     <code>postback</code>
                 action.  The
-                    <code>postback</code> action is called when a selection or expand link is selected
+                    <code>postback</code> action is called when a selection or expansion link is selected
                 in the rendered tree.
                 </p>
             </section>

Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsXhtml.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsXhtml.xml?rev=279836&r1=279835&r2=279836&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsXhtml.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tagsXhtml.xml Fri Sep  9 10:46:12 2005
@@ -18,7 +18,7 @@
                  supported because
                  there are a number of visual presentation attributes supported by the NetUI HTML tags, which are not
                  supported by HTML 4.01 Strict DTD (for example &lt;netui:body>'s bgcolor attribute).  In order
-                 to support these strict modes, the NetUI tags will report runtime errors when the deprecated
+                 to support these strict modes, the NetUI tags would need to report runtime errors when the deprecated
                  attributes are set.
              </p>
          </section>
@@ -43,7 +43,7 @@
                  other.  Together they work together to create valid HTML.  The page above represents the typical
                  minimum page.  The <strong>html</strong> tag will output the HTML html element.  The &lt;head>
                  contains a title and the &lt;netui:base> tag which is used to locate resources and links on the page.
-                 the <strong>body</strong> tag will then output the HTML body element.
+                 The <strong>body</strong> tag will then output the HTML body element.
              </p>
              <section id="HtmlTag">
                  <title>Html Tag</title>
@@ -86,7 +86,7 @@
         <section id="HtmlFormats">
             <title>Specifying the HTML Format</title>
             <p>This section describes the methods for setting the default HTML format for a WebApp.  Further, the
-               format can be set on JSP to override the WebApp default.
+               format can be set on a JSP to override the WebApp default.
             </p>
             <section id="FormatIdentifiers">
                 <title>Format Identifiers</title>