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/23 18:31:42 UTC
svn commit: r239428 - in
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs:
pageflow/tagsJavascript.xml pageflow/tagsXhtml.xml site.xml
Author: dolander
Date: Tue Aug 23 09:31:39 2005
New Revision: 239428
URL: http://svn.apache.org/viewcvs?rev=239428&view=rev
Log:
Updated documentation on the tags.
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsJavascript.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/tagsJavascript.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsJavascript.xml?rev=239428&r1=239427&r2=239428&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsJavascript.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/tagsJavascript.xml Tue Aug 23 09:31:39 2005
@@ -6,7 +6,7 @@
<title>Tags Support for JavaScript</title>
</header>
<body>
- <section id="intro">
+ <section id="Intro">
<title>Introduction</title>
<p>The following topic explains how the NetUI JSP tags provide support for client side
JavaScript development.
@@ -35,7 +35,7 @@
page without modification.
</p>
</section>
- <section id="back_compatability">
+ <section id="BackwardCompatibility">
<title>Backward Compatibility</title>
<p>There are two JavaScript functions intended to support client side JavaScript,
<strong>lookupIdByTagId()</strong> and <strong>lookupNameByTagId()</strong>. These are the public
@@ -48,7 +48,7 @@
<p>
</p>
</section>
- <section>
+ <section id="TagsAndAttributes">
<title>JSP Tags and Attribute</title>
<p>This section describes the primary NetUI JSP tags and attributes used to support JavaScript.</p>
<section id="tagId">
@@ -81,13 +81,9 @@
<strong>tagId</strong>.
</p>
<p> The ScriptContainer tags support two attributes for creating a name,
- <strong>idScope</strong>
- and
- <strong>generateIdScope</strong>. The
- <strong>idScope</strong> sets an explicit value
- for the generated scope. The
- <strong>generateIdScope</strong>, when
- <strong>true</strong>,
+ <strong>idScope</strong> and <strong>generateIdScope</strong>. The
+ <strong>idScope</strong> sets an explicit value for the generated scope. The
+ <strong>generateIdScope</strong>, when <strong>true</strong>,
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.
@@ -113,11 +109,12 @@
<p> The <netui:scriptBlock> tag is used to position user provided JavaScript in relationship
to the framework generated JavaScript. The tag supports inserting JavaScript before or after
the framework generated JavaScript. When you want to create valid XHTML or HTML this tag is
- required. [See the HTML Structure and Valid HTML for further explanation.]
+ required. See the <a href="site:pageflow_tag_xhtml">Valid HTLM and XHTML</a> for more information
+ on creating valid XHTML and HTML using the NetUI JSP tags.
</p>
</section>
</section>
- <section id="simple_example">
+ <section id="SimpleExample">
<title>Simple Example</title>
<p> This section presents a very simple example which demonstrates the use of the
<strong>tagId</strong>
@@ -125,7 +122,7 @@
there is a simple form containing a checkbox. The document is automatically scoped to generate
unique ids within the document.
</p>
- <section id="simple_jsp">
+ <section id="ExampleJspCode">
<title>JSP Code</title>
<p> This JSP file demonstrates the use of
<strong>tagId</strong> and scoping.
@@ -235,7 +232,7 @@
check = form[lookupNameByTagId("check",scope)];
</source>
</section>
- <section id="simple_controller">
+ <section id="ExampleController">
<title>Controller</title>
<p> The Page Flow controller simply supports the sample. It defines the
required begin action and a property bound to by the <netui:checkbox>.
@@ -269,7 +266,7 @@
}
]]></source>
</section>
- <section id="simple_generated_html">
+ <section id="ExampleGeneratedHtml">
<title>Generated HTML</title>
<p> This section contains the generated HTML page sent to the browser. The output of the
NetUI JSP tags and the literal content are contained in the page. The tagId has been used to name
@@ -401,7 +398,7 @@
<html lang="en" <strong>netui:idScope="n0"</strong>>
</source>
</section>
- <section id="simple_famework_generate_javascript">
+ <section id="ExampleFrameworkJavaScript">
<title>Framework Generated JavaScript</title>
<p> This section describes the details of the framework generated JavaScript. This JavaScript
was generated because NetUI tags used the <strong>tagId</strong> attribute. This JavaScript
@@ -479,7 +476,7 @@
in a composite page.
</p>
</section>
- <section id="sample_browser_results">
+ <section id="ExampleBrowserResults">
<title>Browser Results</title>
<p>This section contains a screen shoot of the page from the browser. The dynamically generated
content can be seen.
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=239428&r1=239427&r2=239428&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 Tue Aug 23 09:31:39 2005
@@ -7,10 +7,74 @@
</header>
<body>
<section id="intro">
- <title>Introduction</title>
- <p>The following topic explains the support for creating valid XHTML and HTML from the NetUI tags.
- </p>
+ <title>Introduction</title>
+ <p>The following topic explains the support for creating valid XHTML and HTML from the NetUI tags.
+ The NetUI tags currently support three levels of the XHTML and HTML specs, HTML 4.01 Loose (Transitional DTD),
+ HTML 4.01 Loose Quirks mode and XHTML 1.0 Transitional. The NetUI tags have been designed by
+ default to support HTML 4.01 Loose, Quirks mode.
+ </p>
+ <p> Future versions of NetUI may support HTML 4.01 Strict and XHTML Strict. This is currently not
+ supported because
+ there are a number of visual presentation attributes supported by the NetUI HTML tags, which are not
+ supported by the HTML 4.01 Strict DTD (for example <netui:body>'s bgcolor attribute). In order
+ to support these strict modes, the NetUI tags will report runtime errors when the deprecated
+ attributes are set.
+ </p>
+ </section>
+ <section id="basic_structure">
+ <title>Basic Tag Structure</title>
+ <p>The minimum JSP page should be of the following structure:</p>
+ <p><strong>Basic JSP Page</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"%>
+<netui:html>
+ <head>
+ <title>Page Title</title>
+ <netui:base/>
+ </head>
+ <netui:body>
+ </netui:body>
+</netui:html>
+ ]]></source>
+ <p> There are two primary tags that create the valid HTML structure and provide the core services of
+ the NetUI tag library, <netui:html> and <netui:boyd>. These two tags are related to each
+ 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 <head>
+ contains a title and the <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.
+ </p>
+ <section id="html_tag">
+ <title>Html Tag</title>
+ <p> The <netui:html> JSP tag typically acts as a top level container and in this role is responsible
+ for rendering the result of many of the core services of the tags. These services
+ include gathering up JavaScript and runtime errors and then renders them at the end of the page.
+ For more information on the Html tag see the
+ <a href="site:pageflow_tagsJavascript_ScriptContainer">ScriptContainers</a> topic.
+ </p>
+ <p> Typically if the html tag rendered this content it would be illegal
+ because the end tag </body> imediatly precedes the </html> the end tag and there is
+ no legal content allowed between these two end tags. In order
+ to create legal HTML, the <netui:body> tag defers to the Html tag to render content to the
+ generated page before the body end tag is rendered. If the <netui:body> tag is not present,
+ then the Html tag will render JavaScript and any runtime errors right before the </html> end
+ tag.
+ </p>
+ </section>
+ <section id="body_tag">
+ <title>Body Tag</title>
+ <p> The <netui:body> JSP tag will output the HTML body tag. In addition, it works with the
+ <netui:html> tag to render the JavaScript and runtime errors before the </body> end
+ tag. In addition, it will also work with the <netui:scriptBlock> tag to position any
+ JavaScript that must be position either before or after the framework generated JavaScript.
+ For more information see the
- </section>
-</body>
+ </p>
+ </section>
+ <section id="scriptBlock_tag">
+ <title>ScriptBlock Tag</title>
+ <p></p>
+ </section>
+ </section>
+ </body>
</document>
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=239428&r1=239427&r2=239428&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 Tue Aug 23 09:31:39 2005
@@ -23,9 +23,9 @@
<pageflow_datagrid label="Data Grids" href="pageflow/pageflow_datagrid.html"/>
<pageflow_sharedFlow label="Shared Flow" href="pageflow/sharedFlow.html"/>
<pageflow_popups label="Popup Windows" href="pageflow/popupWindows.html"/>
- <pageflow_tag_valid label="HTML/XHTML Support" href="pageflow/tagsXhtml.html" />
+ <pageflow_tag_xhtml label="HTML/XHTML Support" href="pageflow/tagsXhtml.html" />
<pageflow_tag_javascript label="JavaScript Support" href="pageflow/tagsJavascript.html" />
- <pageflow_tree label="Tree Tags" href="pageflow/treeTags.html" />
+ <pageflow_tag_tree label="Tree Tags" href="pageflow/treeTags.html" />
<pageflow_valid label="Validation" href="pageflow/validation.html"/>
<pageflow_jsf label="Java Server Faces" href="pageflow/jsf.html"/>
<pageflow_servlet_adapter label="Servlet Container Adapters" href="pageflow/servlet_container_adapters.html"/>
@@ -33,6 +33,11 @@
<pageflow_faq label="FAQ" href="pageflow/faq.html"/>
<!--<pageflow_programming label="Page Flow Programming" href="pageflow/guide.html"/>-->
</pageflow>
+ <!-- This is a set of internal links that the tag documentation uses to link between sections -->
+ <pageflow_tag_links>
+ <pageflow_tagsJavascript_ScriptContainer href="pageflow/tagsJavascript.html#ScriptContainer" />
+ <pageflow_tagsJavascript_ScriptBlock href="pageflow/tagsJavascript.html#ScriptBlock" />
+ </pageflow_tag_links>
<controls label="Controls">
<control_getting_started label="Getting Started" href="controls/getting_started.html"/>
<control_overview label="Overview" href="controls/controls_overview.html"/>
@@ -83,19 +88,19 @@
</ws>
<system-controls label="System Controls">
<ejb_control_reference label="EJB">
- <annotations label="Annotations" href="system-controls/ejb/ejb-annotations.html"/>
+ <annotations label="Annotations" href="system-controls/ejb/ejb-annotations.html"/>
<javadoc label="API Javadoc" href="apidocs/classref_systemcontrol/index.html"/>
</ejb_control_reference>
<jdbc_control_reference label="JDBC">
- <annotations label="Annotations" href="system-controls/jdbc/jdbc-annotations.html"/>
+ <annotations label="Annotations" href="system-controls/jdbc/jdbc-annotations.html"/>
<javadoc label="API Javadoc" href="apidocs/classref_systemcontrol/index.html"/>
</jdbc_control_reference>
<jms_control_reference label="JMS">
- <annotations label="Annotations" href="system-controls/jms/jms-annotations.html"/>
+ <annotations label="Annotations" href="system-controls/jms/jms-annotations.html"/>
<javadoc label="API Javadoc" href="apidocs/classref_systemcontrol/index.html"/>
</jms_control_reference>
<ws_control_reference label="Web Service">
- <annotations label="Annotations" href="system-controls/webservices/webservices-annotations.html"/>
+ <annotations label="Annotations" href="system-controls/webservices/webservices-annotations.html"/>
<javadoc label="API Javadoc" href="apidocs/classref_systemcontrol/index.html"/>
</ws_control_reference>
</system-controls>
@@ -113,10 +118,10 @@
<beehive href="http://beehive.apache.org/"/>
<beehive-release href="http://cvs.apache.org/">
<current href="dist/incubator/beehive/v1.0m1"/>
- </beehive-release>
+ </beehive-release>
<jsr181 href="http://jcp.org/en/jsr/detail?id=181"/>
<java5download href="http://java.sun.com/j2se/1.5.0/download.jsp"/>
<ant16download href="http://ant.apache.org/bindownload.cgi"/>
<tomcatdownload href="http://jakarta.apache.org/site/binindex.cgi#tomcat"/>
</external-refs>
-</site>
+</site>