[richfaces-svn-commits] JBoss Rich Faces SVN: r15767 - in root/docs/trunk: Component_Reference/en-US and 4 other directories.

Author: SeanRogers Date: 2009-10-28 02:29:30 -0400 (Wed, 28 Oct 2009) New Revision: 15767 Added: root/docs/trunk/Migration_Guide/en-US/fallback_content/ root/docs/trunk/Migration_Guide/en-US/fallback_content/Conventions.xml root/docs/trunk/Migration_Guide/en-US/fallback_content/Feedback.xml root/docs/trunk/Migration_Guide/en-US/fallback_content/Legal_Notice.xml root/docs/trunk/Migration_Guide/pom.xml Modified: root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.xml root/docs/trunk/Component_Reference/en-US/Book_Info.xml root/docs/trunk/Component_Reference/en-US/Component_Reference.xml root/docs/trunk/Component_Reference/en-US/Introduction.xml root/docs/trunk/Developer_Guide/en-US/Basic_concepts.xml root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml root/docs/trunk/Developer_Guide/en-US/Introduction.xml root/docs/trunk/Migration_Guide/en-US/Book_Info.xml root/docs/trunk/Migration_Guide/en-US/Changes_and_new_features.xml root/docs/trunk/Migration_Guide/en-US/Preface.xml Log: Started work to allow Maven builds, started Component Ref Modified: root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.xml =================================================================== --- root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -4,7 +4,7 @@ <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!--<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Creating_a_new_component.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> Modified: root/docs/trunk/Component_Reference/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -7,17 +7,16 @@ <subtitle>A reference guide to the components of the RichFaces &VERSION_LONG;<remark> (draft)</remark> framework</subtitle> <productname>RichFaces</productname> - <productnumber>&VERSION;</productnumber> + <productnumber>4.0</productnumber> <edition>0.1</edition> <pubsnumber>0</pubsnumber> <abstract> - <para>This book details each component in the RichFaces &VERSION; framework, -including examples of their use in applications.</para> - </abstract> + <para>This book details each component in the RichFaces &VERSION; +framework, including examples of their use in applications.</para></abstract> <corpauthor> <inlinemediaobject> <imageobject> - <imagedata fileref="./images/rf_logo.png" format="PNG" /> + <imagedata fileref="./images/rf_logo.png" format="PNG" scalefit="1" /> </imageobject> <textobject> <phrase>Logo</phrase> Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -4,8 +4,7 @@ <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Rich_inputs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Panels_and_containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> Modified: root/docs/trunk/Component_Reference/en-US/Introduction.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Introduction.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Component_Reference/en-US/Introduction.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -10,11 +10,18 @@ <para> For full in-depth references for all component classes and properties, refer to the <citetitle>API Reference</citetitle> available from the RichFaces website. </para> - <note> - <title>Note</title> + <section id="sect-Component_Reference-Introduction-Libraries"> + <title>Libraries</title> <para> - All components in the <classname>a4j</classname> library feature built-in Ajax support, so it is unnecessary to add the <classname>&lt;a4j:ajax&gt;</classname> behavior. + The RichFaces framework as it now stands is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents Ajax4jsf, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don&#39;t require additional configuration in order to send requests or update. </para> - </note> + <note> + <title>Note</title> + <para> + All components in the <classname>a4j</classname> library feature built-in Ajax support, so it is unnecessary to add the <classname>&lt;a4j:ajax&gt;</classname> behavior. + </para> + </note> + </section> + </chapter> Modified: root/docs/trunk/Developer_Guide/en-US/Basic_concepts.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Basic_concepts.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Developer_Guide/en-US/Basic_concepts.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -5,7 +5,7 @@ <chapter id="chap-Developer_Guide-Basic_concepts"> <title>Basic concepts</title> <para> - Incomplete + This chapter covers the basic concepts for using RichFaces in conjunction with Ajax and JavaServer Faces. </para> <section id="sect-Developer_Guide-Basic_concepts-Sending_an_Ajax_request"> <title>Sending an Ajax request</title> Modified: root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -4,7 +4,7 @@ <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!--<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Getting_started_with_RichFaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="RichFaces_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> Modified: root/docs/trunk/Developer_Guide/en-US/Introduction.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Introduction.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Developer_Guide/en-US/Introduction.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -5,7 +5,7 @@ <chapter id="chap-Developer_Guide-Introduction"> <title>Introduction</title> <para> - Incomplete + RichFaces is a rich component library for JavaServer Faces (<acronym>JSF</acronym>) built on the open-source Ajax4jsf framework. It allows easy integration of Ajax capabilities into enterprise application development without needing to use Javascript. </para> </chapter> Modified: root/docs/trunk/Migration_Guide/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/Book_Info.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Migration_Guide/en-US/Book_Info.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -30,7 +30,14 @@ <year>&YEAR;</year> <holder>&HOLDER;</holder> </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + + <!--FOR PUBLICAN --> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"> + <!--FOR JDOCBOOK:--> + <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> + </xi:include> <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </bookinfo> Modified: root/docs/trunk/Migration_Guide/en-US/Changes_and_new_features.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/Changes_and_new_features.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Migration_Guide/en-US/Changes_and_new_features.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -1096,14 +1096,14 @@ </section> <section id="sect-Migration_Guide-Server_side_process_and_render_mechanisms-execute"> - <title><code>execute</code></title> + <title>execute</title> <para> The <code>execute</code> property has been extended to include the <literal>@region</literal> keyword, which facilitates the region rendering changes described in <xref linkend="sect-Migration_Guide-Server_side_process_and_render_mechanisms-Regions" />. </para> </section> <section id="sect-Migration_Guide-Server_side_process_and_render_mechanisms-render"> - <title><code>render</code></title> + <title>render</title> <para> The <code>render</code> property can also be defined from the server side, using actions and listeners. </para> @@ -1112,14 +1112,14 @@ </section> <section id="sect-Migration_Guide-Feature_changes-onbegin_event_attribute"> - <title><code>onbegin</code> event attribute</title> + <title>onbegin event attribute</title> <para> The <code>onbegin</code> attribute has been added to support <acronym>JSF</acronym> events with the type <literal>begin</literal>. </para> </section> <section id="sect-Migration_Guide-Feature_changes-a4jcommandButton_and_a4jcommandLink"> - <title><classname>&lt;a4j:commandButton&gt;</classname> and <classname>&lt;a4j:commandLink&gt;</classname></title> + <title>&lt;a4j:commandButton&gt; and &lt;a4j:commandLink&gt;</title> <para> Both the <classname>&lt;a4j:commandButton&gt;</classname> and <classname>&lt;a4j:commandLink&gt;</classname> use the <code>onclick</code> event attribute instead of the <code>onbegin</code> attribute. </para> @@ -1127,14 +1127,14 @@ <!-- <section> - <title><classname>&lt;a4j:jsFunction&gt;</classname></title> + <title>&lt;a4j:jsFunction&gt;</title> <para> </para> </section> --> <section id="sect-Migration_Guide-Feature_changes-a4jlog"> - <title><classname>&lt;a4j:log&gt;</classname></title> + <title>&lt;a4j:log&gt;</title> <para> The <classname>&lt;a4j:log&gt;</classname> behavior has had several features modified. </para> @@ -1158,14 +1158,14 @@ </section> <section id="sect-Migration_Guide-Feature_changes-a4jmessage_and_a4jmessages"> - <title><classname>&lt;a4j:message&gt;</classname> and <classname>&lt;a4j:messages&gt;</classname></title> + <title>&lt;a4j:message&gt; and &lt;a4j:messages&gt;</title> <para> Both the <classname>&lt;a4j:message&gt;</classname> and <classname>&lt;a4j:messages&gt;</classname> components can be automatically updated by any Ajax request, except those requests with <code>limitRender = true</code>. Attributes from previously-passed states are now cleared. </para> </section> <section id="sect-Migration_Guide-Feature_changes-a4joutputPanel"> - <title><classname>&lt;a4j:outputPanel&gt;</classname></title> + <title>&lt;a4j:outputPanel&gt;</title> <para> The <classname>&lt;a4j:outputPanel&gt;</classname> component has had several features modified. </para> @@ -1189,7 +1189,7 @@ </section> <section id="sect-Migration_Guide-Feature_changes-a4jpush_and_a4jpoll"> - <title><classname>&lt;a4j:push&gt;</classname> and <classname>&lt;a4j:poll&gt;</classname></title> + <title>&lt;a4j:push&gt; and &lt;a4j:poll&gt;</title> <para> Both the <classname>&lt;a4j:push&gt;</classname> and <classname>&lt;a4j:poll&gt;</classname> behaviors now raise a client-side event. For <classname>&lt;a4j:push&gt;</classname>, this is the <code>ondataavailable</code> event, while for <classname>&lt;a4j:poll&gt;</classname> it is the <code>ontimeevent</code>. </para> @@ -1197,14 +1197,14 @@ <!-- <section> - <title><classname>&lt;a4j:region&gt;</classname></title> + <title>&lt;a4j:region&gt;</title> <para> </para> </section> --> <section id="sect-Migration_Guide-Feature_changes-a4jstatus"> - <title><classname>&lt;a4j:status&gt;</classname></title> + <title>&lt;a4j:status&gt;</title> <para> In RichFaces &VERSION;, <classname>&lt;a4j:status&gt;</classname> has been implemented as a component rather than a behavior, as it should have a representation in the Document Object Model (<acronym>DOM</acronym>) tree. </para> @@ -1236,28 +1236,28 @@ </section> <section id="sect-Migration_Guide-Feature_changes-richtogglePanel"> - <title><classname>&lt;rich:togglePanel&gt;</classname></title> + <title>&lt;rich:togglePanel&gt;</title> <para> Incomplete. </para> </section> <section id="sect-Migration_Guide-Feature_changes-richtabPanel"> - <title><classname>&lt;rich:tabPanel&gt;</classname></title> + <title>&lt;rich:tabPanel&gt;</title> <para> Incomplete. </para> </section> <section id="sect-Migration_Guide-Feature_changes-richtoolBar"> - <title><classname>&lt;rich:toolBar&gt;</classname></title> + <title>&lt;rich:toolBar&gt;</title> <para> Incomplete. </para> </section> <section id="sect-Migration_Guide-Feature_changes-richtoolTip"> - <title><classname>&lt;rich:toolTip&gt;</classname></title> + <title>&lt;rich:toolTip&gt;</title> <para> Incomplete. </para> @@ -1272,7 +1272,7 @@ </para> <!-- dataTable, dataLists, trees possibly included here as they may be consolidated --> <section id="sect-Migration_Guide-New_components_and_behaviors-a4jajax"> - <title><classname>&lt;a4j:ajax&gt;</classname></title> + <title>&lt;a4j:ajax&gt;</title> <para> The <classname>&lt;a4j:ajax&gt;</classname> behavior replaces the deprecated <classname>&lt;a4j:support&gt;</classname> behavior. </para> @@ -1282,14 +1282,14 @@ </section> <section id="sect-Migration_Guide-New_components_and_behaviors-richbusyBehavior"> - <title><classname>&lt;rich:busyBehavior&gt;</classname></title> + <title>&lt;rich:busyBehavior&gt;</title> <para> <classname>&lt;rich:busyBehavior&gt;</classname> is used when heavy processing takes place to provide feedback to the user. It can be attached to a component&#39;s events to trigger appropriate messages. </para> </section> <section id="sect-Migration_Guide-New_components_and_behaviors-richpopupPanel"> - <title><classname>&lt;rich:popupPanel&gt;</classname></title> + <title>&lt;rich:popupPanel&gt;</title> <para> Incomplete. </para> @@ -1303,21 +1303,21 @@ Some components and behaviors have been deprecated in RichFaces &VERSION;. For the most part these items have their functionality replicated by another component or behavior. </para> <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-a4jpage"> - <title><classname>&lt;a4j:page&gt;</classname></title> + <title>&lt;a4j:page&gt;</title> <para> RichFaces &VERSION; drops support for the <classname>&lt;a4j:page&gt;</classname> component. The component was previously used for solving incompatibility in the JavaServer Pages (<acronym>JSP</acronym>) environment with Apache MyFaces in early Ajax4jsf versions. </para> </section> <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-a4jsupport"> - <title><classname>&lt;a4j:support&gt;</classname></title> + <title>&lt;a4j:support&gt;</title> <para> The <classname>&lt;a4j:support&gt;</classname> component had been deprecated and its functionality replaced by the <classname>&lt;a4j:ajax&gt;</classname> component. Refer to <xref linkend="sect-Migration_Guide-New_components_and_behaviors-a4jajax" /> for details. </para> </section> <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richmodalPanel"> - <title><classname>&lt;rich:modalPanel&gt;</classname></title> + <title>&lt;rich:modalPanel&gt;</title> <para> Incomplete. </para> Modified: root/docs/trunk/Migration_Guide/en-US/Preface.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/Preface.xml 2009-10-27 23:27:13 UTC (rev 15766) +++ root/docs/trunk/Migration_Guide/en-US/Preface.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -4,9 +4,24 @@ <preface id="pref-Migration_Guide-Preface"> <title>Preface</title> - <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - </xi:fallback> + <!--FOR JDOCBOOK--> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Conventions.xml"> + <!--FOR PUBLICAN--> + <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> </xi:include> + + <!--PUBLICAN'S ORIGINAL XINCLUDES--> + <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> + <!--FOR JDOCBOOK--> + <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> + </xi:include> + </xi:fallback> + </xi:include> </preface> Added: root/docs/trunk/Migration_Guide/en-US/fallback_content/Conventions.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/fallback_content/Conventions.xml (rev 0) +++ root/docs/trunk/Migration_Guide/en-US/fallback_content/Conventions.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -0,0 +1,174 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Common_Content.ent"> +%BOOK_ENTITIES; +]> + +<section> + <title>Document Conventions</title> + <para> + This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. + </para> + <para> + In PDF and paper editions, this manual uses typefaces drawn from the <ulink url="https://fedorahosted.org/liberation-fonts/">Liberation Fonts</ulink> set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default. + </para> + <section> + <title>Typographic Conventions</title> + <para> + Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows. + </para> + <para> + <literal>Mono-spaced Bold</literal> + </para> + <para> + Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example: + </para> + <blockquote> + <para> + To see the contents of the file <filename>my_next_bestselling_novel</filename> in your current working directory, enter the <command>cat my_next_bestselling_novel</command> command at the shell prompt and press <keycap>Enter</keycap> to execute the command. + </para> + </blockquote> + <para> + The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context. + </para> + <para> + Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example: + </para> + <blockquote> + <para> + Press <keycap>Enter</keycap> to execute the command. + </para> + <para> + Press <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>F1</keycap></keycombo> to switch to the first virtual terminal. Press <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>F7</keycap></keycombo> to return to your X-Windows session. + </para> + </blockquote> + <para> + The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously. + </para> + <para> + If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in <literal>Mono-spaced Bold</literal>. For example: + </para> + <blockquote> + <para> + File-related classes include <classname>filesystem</classname> for file systems, <classname>file</classname> for files, and <classname>dir</classname> for directories. Each class has its own associated set of permissions. + </para> + </blockquote> + <para> + <application>Proportional Bold</application> + </para> + <para> + This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example: + </para> + <blockquote> + <para> + Choose <guimenu>System &gt; Preferences &gt; Mouse</guimenu> from the main menu bar to launch <application>Mouse Preferences</application>. In the <guilabel>Buttons</guilabel> tab, click the <guilabel>Left-handed mouse</guilabel> check box and click <guibutton>Close</guibutton> to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand). + </para> + <para> + To insert a special character into a <application>gedit</application> file, choose <guimenu>Applications &gt; Accessories &gt; Character Map</guimenu> from the main menu bar. Next, choose <guimenu>Search &gt; Find&hellip;</guimenu> from the <application>Character Map</application> menu bar, type the name of the character in the <guilabel>Search</guilabel> field and click <guibutton>Next</guibutton>. The character you sought will be highlighted in the <guilabel>Character Table</guilabel>. Double-click this highlighted character to place it in the <guilabel>Text to copy</guilabel> field and then click the <guibutton>Copy</guibutton> button. Now switch back to your document and choose <guimenu>Edit &gt; Paste</guimenu> from the <application>gedit</application> menu bar. + </para> + </blockquote> + <para> + The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context. + </para> + <para> + Note the <guimenu>&gt;</guimenu> shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow &#39;Select <guimenuitem>Mouse</guimenuitem> from the <guimenu>Preferences</guimenu> sub-menu in the <guimenu>System</guimenu> menu of the main menu bar&#39; approach. + </para> + <para> + <command><replaceable>Mono-spaced Bold Italic</replaceable></command> or <application><replaceable>Proportional Bold Italic</replaceable></application> + </para> + <para> + Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example: + </para> + <blockquote> + <para> + To connect to a remote machine using ssh, type <command>ssh <replaceable&gt;username&lt;/replaceable&gt;(a)&lt;replaceable&gt;domain.name&lt;/replaceable&gt;&lt;/command&gt; at a shell prompt. If the remote machine is <filename>example.com</filename> and your username on that machine is john, type <command>ssh john(a)example.com&lt;/command&gt;. + </para> + <para> + The <command>mount -o remount <replaceable>file-system</replaceable></command> command remounts the named file system. For example, to remount the <filename>/home</filename> file system, the command is <command>mount -o remount /home</command>. + </para> + <para> + To see the version of a currently installed package, use the <command>rpm -q <replaceable>package</replaceable></command> command. It will return a result as follows: <command><replaceable>package-version-release</replaceable></command>. + </para> + </blockquote> + <para> + Note the words in bold italics above &mdash; username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system. + </para> + <para> + Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example: + </para> + <blockquote> + <para> + When the Apache HTTP Server accepts requests, it dispatches child processes or threads to handle them. This group of child processes or threads is known as a <firstterm>server-pool</firstterm>. Under Apache HTTP Server 2.0, the responsibility for creating and maintaining these server-pools has been abstracted to a group of modules called <firstterm>Multi-Processing Modules</firstterm> (<firstterm>MPMs</firstterm>). Unlike other modules, only one module from the MPM group can be loaded by the Apache HTTP Server. + </para> + </blockquote> + </section> + + <section> + <title>Pull-quote Conventions</title> + <para> + Two, commonly multi-line, data types are set off visually from the surrounding text. + </para> + <para> + Output sent to a terminal is set in <computeroutput>Mono-spaced Roman</computeroutput> and presented thus: + </para> + +<screen> +books Desktop documentation drafts mss photos stuff svn +books_tests Desktop1 downloads images notes scripts svgs +</screen> + <para> + Source-code listings are also set in <computeroutput>Mono-spaced Roman</computeroutput> but are presented and highlighted as follows: + </para> + +<programlisting language="java"> +package org.jboss.book.jca.ex1; + +import javax.naming.InitialContext; + +public class ExClient +{ + public static void main(String args[]) + throws Exception + { + InitialContext iniCtx = new InitialContext(); + Object ref = iniCtx.lookup("EchoBean"); + EchoHome home = (EchoHome) ref; + Echo echo = home.create(); + + System.out.println("Created Echo"); + + System.out.println("Echo.echo(&#39;Hello&#39;) = " + echo.echo("Hello")); + } + +} +</programlisting> + </section> + + <section> + <title>Notes and Warnings</title> + <para> + Finally, we use three visual styles to draw attention to information that might otherwise be overlooked. + </para> + <note> + <title>Note</title> + <para> + A Note is a tip or shortcut or alternative approach to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier. + </para> + </note> + <important> + <title>Important</title> + <para> + Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won&#39;t cause data loss but may cause irritation and frustration. + </para> + </important> + <warning> + <title>Warning</title> + <para> + A Warning should not be ignored. Ignoring warnings will most likely cause data loss. + </para> + </warning> + </section> + +</section> + + Added: root/docs/trunk/Migration_Guide/en-US/fallback_content/Feedback.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/fallback_content/Feedback.xml (rev 0) +++ root/docs/trunk/Migration_Guide/en-US/fallback_content/Feedback.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -0,0 +1,22 @@ +<?xml version='1.0'?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<section> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: <ulink url="http://bugzilla.redhat.com/bugzilla/">http://bugzilla.r... against the product <application>&PRODUCT;.</application> + </para> + <para> + When submitting a bug report, be sure to mention the manual&#39;s identifier: <citetitle>&BOOKID;</citetitle> + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: root/docs/trunk/Migration_Guide/en-US/fallback_content/Legal_Notice.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/fallback_content/Legal_Notice.xml (rev 0) +++ root/docs/trunk/Migration_Guide/en-US/fallback_content/Legal_Notice.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -0,0 +1,29 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<legalnotice> + <para> + Copyright <trademark class="copyright"></trademark> &YEAR; &HOLDER;. This material may only be distributed subject to the terms and conditions set forth in the Open Publication License, V1.0, (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencon...>). + </para> + <para> + Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries. + </para> + <para> + <trademark class="registered">Linux</trademark> is the registered trademark of Linus Torvalds in the United States and other countries. + </para> + <para> + All other trademarks are the property of their respective owners. + </para> + <para> + <address> + <street>1801 Varsity Drive</street> + <city>Raleigh</city>, <state>NC</state> <postcode>27606-2072</postcode> <country>USA</country> + <phone>Phone: +1 919 754 3700</phone> + <phone>Phone: 888 733 4281</phone> + <fax>Fax: +1 919 754 3701</fax> + <pob>PO Box 13588</pob> <city>Research Triangle Park</city>, <state>NC</state> <postcode>27709</postcode> <country>USA</country> + </address> + </para> +</legalnotice> + Added: root/docs/trunk/Migration_Guide/pom.xml =================================================================== --- root/docs/trunk/Migration_Guide/pom.xml (rev 0) +++ root/docs/trunk/Migration_Guide/pom.xml 2009-10-28 06:29:30 UTC (rev 15767) @@ -0,0 +1,321 @@ + +<project + xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>org.jboss.jbossas</groupId> + <artifactId>RichFaces_Migration_Guide-${translation}</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <!--<name>Platform User Guide (${translation})</name>--> + <name>${env.DOCNAME}(${translation})</name> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.3-SNAPSHOT</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <!--minmemory>1024m</minmemory> + <maxmemory>1024m</maxmemory --> + <sourceDocumentName>${env.DOCNAME}.xml</sourceDocumentName> + <!--<sourceDocumentName>${env.DOCNAME}</sourceDocumentName>--> + <sourceDirectory>en-US</sourceDirectory> + <imageResource> + <directory>en-US</directory> + <includes> + <include>images/*</include> + </includes> + </imageResource> + <!--<cssResource> + <directory>src/main/css</directory> + </cssResource>--> + <formats> + <!--format> + <formatName>pdf</formatName> + <note: "main-pdf" changed name to "pdf.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0> + <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${env.DOCNAME}.pdf</finalName> + </format--> + <!--<format> + <formatName>html</formatName>--> + <!--note: "main-html" changed name to "xhtml.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>--> + <!--<stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format>--> + <format> + <formatName>html_single</formatName> + <!--note: "nochunk-html.xsl" changed name to "xhtml-single.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <!--<format> + <formatName>eclipse</formatName>--> + <!--note: "main-eclipse.xsl" changed name to "eclipse.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/main-eclipse.xsl</stylesheetResource>--> + <!--<stylesheetResource>classpath:/xslt/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format>--> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + <!--<javax.xml.parsers.DocumentBuilderFactory>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</javax.xml.parsers.DocumentBuilderFactory> + <javax.xml.parsers.SAXParserFactory>org.apache.xerces.jaxp.SAXParserFactoryImpl</javax.xml.parsers.SAXParserFactory> + <javax.xml.validation.SchemaFactory:http\://www.w3.org/2001/XMLSchema>o... + </transformerParameters> + </options> + </configuration> + </plugin> + </plugins> + </build> + <properties> + <translation>en-US</translation> + </properties> + <pluginRepositories> + <!--original repository--> + <pluginRepository> + <id>jboss</id> + <name>JBoss Plugin Repository</name> + <url>http://repository.jboss.org/maven2</url> + <layout>default</layout> + <releases> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <checksumPolicy>warn</checksumPolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + <checksumPolicy>fail</checksumPolicy> + </snapshots> + </pluginRepository> + <pluginRepository> + <id>jboss</id> + <name>JBoss Plugin Repository</name> + <url>http://repository.jboss.org/maven2</url> + <layout>default</layout> + <releases> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <checksumPolicy>warn</checksumPolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + <checksumPolicy>fail</checksumPolicy> + </snapshots> + </pluginRepository> + <pluginRepository> + <id>snapshots.jboss</id> + <name>JBoss Snapshots</name> + <url>http://snapshots.jboss.org/maven2</url> + <releases> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <checksumPolicy>warn</checksumPolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + <checksumPolicy>fail</checksumPolicy> + </snapshots> + </pluginRepository> + <pluginRepository> + <id>people.apache</id> + <name>People Apache plugin repository</name> + <url>http://people.apache.org/repo/m2-snapshot-repository</url> + <releases> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <checksumPolicy>warn</checksumPolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + <checksumPolicy>fail</checksumPolicy> + </snapshots> + </pluginRepository> + </pluginRepositories> + <profiles> + + <profile> + <id>all</id> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <!--note: "main-pdf" changed name to "pdf.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${env.DOCNAME}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <!--note: "main-html" changed name to "xhtml.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <!--note: "nochunk-html.xsl" changed name to "xhtml-single.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> + + <profile> + <id>hudson</id> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <!--note: "main-html" changed name to "xhtml.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <!--note: "nochunk-html.xsl" changed name to "xhtml-single.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> + + <profile> + <id>html</id> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <!--note: "main-html" changed name to "xhtml.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> + + <profile> + <id>html_single</id> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <configuration> + <formats> + <format> + <formatName>html_single</formatName> + <!--note: "nochunk-html.xsl" changed name to "xhtml-single.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> + + <profile> + <id>pdf</id> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <!--note: "main-pdf" changed name to "pdf.xsl" between jbossorg-docbook-xslt + version 1.0.0 and version 1.1.0 --> + <!--<stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource>--> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${env.DOCNAME}.pdf</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> + + </profiles> +</project>