From richfaces-svn-commits at lists.jboss.org Tue Nov 22 18:04:09 2011 Content-Type: multipart/mixed; boundary="===============0142708641446522252==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r22975 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US. Date: Tue, 22 Nov 2011 18:04:08 -0500 Message-ID: <201111222304.pAMN48H8021832@svn01.web.mwc.hst.phx2.redhat.com> --===============0142708641446522252== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: bleathem Date: 2011-11-22 18:04:07 -0500 (Tue, 22 Nov 2011) New Revision: 22975 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Rich_inputs.xml Log: Grammar cleanup of the editor component documentation Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Rich_inputs.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Rich_inputs.xml 2011-11-22 19:28:59 UTC (rev 22974) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Rich_inputs.xml 2011-11-22 23:04:07 UTC (rev 22975) @@ -814,10 +814,10 @@ - <rich:editor> component is based on C= KEditor implementation. + <rich:editor> component is based on t= he CKEditor implementation. - When rendering <rich:editor>, textare= a is rendered to the page and once the page is completely loaded (ready sta= te), textarea is enhanced using CKEditor script and replaced with full-feat= ured WYSIWYG editor. = + When rendering a <rich:editor>, a tex= tarea is rendered to the page and once the page is completely loaded (ready= state), the textarea is enhanced using a CKEditor script and replaced with= a full-featured WYSIWYG editor. =
@@ -829,45 +829,45 @@ Basic usage of <sgmltag><rich:editor></sgmlta= g> - Note that editor does produce HTML markup and to be ab= le render it's output, markup needs to be output as unescaped (as with <h:outputText> component in example above). + Note that the editor produces HTML markup and to be ab= le to render it's output, the markup needs to be unescaped (as with <h:outputText> component in example above). - Dimensions of editor can be managed using width= and height attributes. + The dimensions of the editor can be managed using width and height attributes. - The readonly attribute can be used = to switch editor into read-only mode. + The readonly attribute can be used = to switch the editor into a read-only mode. The tabindex attribute specifies th= e position of the current element in the tabbing order for the current docu= ment. - ResourceServlet has to be registered for url-pattern /org.richfaces.resources/* in order to se= rve editor resources (JavaScript, CSS, images) correctly. Check = RichFaces Developer's Guide out for details. + The ResourceServlet has to be registered for = the url-pattern /org.richfaces.resources/* in ord= er to serve the editor resources (JavaScript, CSS, images) correctly. Check= the RichFaces Developer's Guide for further details. - The <rich:editor> requires having= <h:body> component present in the view and being = its ancestor for rendering resource dependencies correctly. + The <rich:editor> requires the <h:body> component to be present in the view and mus= t be an ancestor of the editor in order for the resource dependencies to re= nder correctly.
=
Styling - There are several options to customize style of the editor: + There are several options to customize the style of the ed= itor: - style, styleClass: customiz= es style of the editor and underlying textarea + style, styleClass: customiz= es the style of the editor and underlying textarea - editorStyle, editorClass: c= ustomizes style of the CKEditor instance + editorStyle, editorClass: c= ustomizes the style of the CKEditor instance - textareaStyle, textareaClass: customizes style of the underlying textarea + textareaStyle, textareaClass: customizes the style of the underlying textarea @@ -876,10 +876,10 @@
Editor skins - The <rich:editor> comes with skin= nability using attribute skin and two approaches: + The <rich:editor> is skinnable us= ing the skin attribute and either of the two approaches: - At first, <rich:editor> has defau= lt skin called richfaces that is optimized to suit rest of the= component suite look & feel and behaves regarding to which RichFaces s= kin is currently chosen (refer to RichFaces Developer's Guide for details about Skinning and theming). + By default, <rich:editor> has a s= kin called richfaces that is optimized to match rest of the co= mponent suite look & feel and changes to match the active RichFaces ski= n (refer to RichFaces Developer's Guide for details ab= out Skinning and theming). The skin <code>richfaces</code> of <sgmltag><ric= h:editor></sgmltag> @@ -890,17 +890,17 @@ - A <rich:editor> w= ith default richfaces editor skin rendered against several Ric= hFaces Skin options. + A <rich:editor> w= ith the default richfaces editor skin rendered against several= RichFaces Skin options. - A <rich:editor> with default = richfaces editor skin rendered against several RichFaces Skin = options. + A <rich:editor> with the defa= ult richfaces editor skin rendered against several RichFaces S= kin options. - Second option gives you possibility to use any other skin = for CKEditor, either from standard distribution or downloaded one or custom= one. In distribution, there are three skins bundled: kama, v2, offic= e2003. + Alternatively, you can use any other CKeditor skin, either= from the standard distribution, a downloaded skin, or a custom skin. In th= e distribution, there are three skins bundled: kama, v2, office2003. Examples of <sgmltag><rich:editor></sgmltag> = skins in CKEditor distribution @@ -925,23 +925,19 @@
Advanced configuration - Basic set of <rich:editor> attrib= utes allows to support common use-cases for WYSIWYG editor. + The basic set of <rich:editor> at= tributes allows you to support common use-cases for a WYSIWYG editor. + However the underlying CKEditor implementation supports ma= ny more configuration options. - However CKEditor imlementation supports much more configur= ation options. + Use the config attribute to define = any of these advanced configuration options supported by the CKEditor. + This configuration is written in JavaScript object format = and its value is interpolated for EL expressions (making configuration dyna= mic). - Attribute config gives possibility = to define any advanced configuration option which CKEditor supports. + There are two ways to define the configuration: the config attribute or a facet named config. The facet takes precedence over attribute when both are defined. - - Configuration is written in JavaScript object format and i= ts value is interpolated for EL expressions (making configuration dynamic). - - - There are two options to define configuration: = config attribute and facet with name config. Facet takes precedence over attribute when both defined. - - In samples above, <rich:editor> i= s configured to take focus after load of the page regarding to user prefere= nces. Definitions using either attribute or facet are adequate. + In the above samples, the <rich:editor> is configured to take focus after loading the page as defined by the= userPreference bean. Definitions using either attribute or facet are equiv= alent. For further configuration options, refer to CKEditor 3 Developer Guide and CKEditor 3 configuration = reference. @@ -951,14 +947,12 @@
Toolbar customization - <rich:editor> supports toolbar attribute able to switch between configurations of too= lbar's button set. = + The <rich:editor> supports a toolbar attribute, which is able to change the configura= tion of the toolbar's button set. + There are two configurations available: basic= (default), full (enables all of the features). - There are two configurations available: basic= (default), full (enables all of the features). = + It is also possible to define a custom toolbar using the C= KEditor toolbar configuration in a config facet: - - It is possible to define custom toolbar using CKEditor too= lbar configuration in config facet: - Note that toolbar name (CustomToolbar) needs = to match the toolbar_<name> configuration option. @@ -968,9 +962,7 @@
Internationalization and localization - <rich:editor> comes with attribut= e lang which allows to change localization of editor. - - + The <rich:editor> comes with a lang attribute which allows you to change the localiza= tion of the editor. For language configuration options, refer to http://www.w3.org/TR/html4= /struct/dirlang.html. @@ -994,14 +986,12 @@ - However localization of interface is in first place locali= zed using the browser configuration (usually determined by client system se= ttings). + However the interface first localized using the browser co= nfiguration (usually determined by client system settings). + To force the editor to use a specific localization for the= interface, you use the advanced CKEditor configuration option langua= ge, as in following sample: - - To force editor to use specific localization of interface,= you can use advanced CKEditor configuration option language a= s in following sample: - - The sample above force editor to use french interface, sup= ressing the browser preferred settings. + The above sample forces the editor to use a french interfa= ce, suppressing the browser preferred settings.
= @@ -1038,18 +1028,18 @@ - Events can be handled either by registering JavaScript eve= nt handler or by attaching JSF behavior: + Events can be handled either by registering a JavaScript e= vent handler or by attaching JSF behavior: - Example above shows editor and its output, which is update= d each 1 sec after each instant change or immediately after user focus leav= es editor area. + The example above shows the editor and its output, which i= s updated every second after each instant change or immediately after user = focus leaves the editor area.
=
JavaScript API - The <rich:inplaceInput> component c= an be controlled through the JavaScript API. The JavaScript API provides th= e following functions: + The <rich:editor> component can be = controlled through the JavaScript API. The JavaScript API provides the foll= owing functions: --===============0142708641446522252==--