gatein SVN: r9147 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-13 20:39:24 -0500 (Wed, 13 Feb 2013)
New Revision: 9147
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
Log:
Review and editing, with grammatical corrections and some DocBook tags changed.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2013-02-13 20:34:04 UTC (rev 9146)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2013-02-14 01:39:24 UTC (rev 9147)
@@ -5,15 +5,9 @@
]>
<chapter id="sid-8094332_GateInManagement-ManagementExtensions">
<title>Management Extensions</title>
- <para>The following management extensions supported in the portal are:</para>
- <itemizedlist>
- <listitem>
- <para>MOP Management Extension</para>
- </listitem>
- </itemizedlist>
<section id="sid-8094332_GateInManagement-MOPManagementExtension">
<title>MOP Management Extension</title>
- <para>The MOP management extension registers the 'mop' managed component which is responsible for managing pages, navigation, and site layout. It primarily supports exporting and importing this data through the export-resource and import-resource operations. It also supports the read-config-as-xml operation to expose the portal meta data as xml.</para>
+ <para>The MOP management extension registers the 'mop' managed component which is responsible for managing pages, navigation, and site layout. It primarily supports exporting and importing this data through the <systemitem>export-resource</systemitem> and <systemitem>import-resource</systemitem> operations. It also supports the read-config-as-xml operation to expose the portal meta data as XML.</para>
<section id="sid-8094332_GateInManagement-Operationsxx">
<title><remark>BZ#794408 </remark>Operations</title>
<section id="sid-8094332_GateInManagement-readconfigasxml">
@@ -21,9 +15,9 @@
<para>
The
<code>read-config-as-xml</code>
- operation can only be executed on the site layout, pages, and navigation managed resources. The xml format returned is that of which is defined in by the
+ operation can only be executed on the site layout, pages, and navigation managed resources. The XML format returned is defined by the
<ulink url="http://www.gatein.org/xml/ns/">gatein-objects</ulink>
- xsd. This means that these resources are exposed in the same format as what a portal extension would accept for importing data into the portal.
+ XSD. These resources are exposed in the same format a portal extension would accept for importing data into the portal.
</para>
</section>
<section id="sid-8094332_GateInManagement-exportresource">
@@ -31,7 +25,7 @@
<para>
The
<code>export-resource</code>
- operation can be executed on any resource of the MOP extension (including the mop component itself). Since the management system recursively searches for all sub-resources that have export-resource defined (which they are defined at the site layout, page, and navigation level), exports can be very granular.
+ operation can be executed on any resource of the MOP extension (including the <systemitem>mop</systemitem> component itself). Since the management system recursively searches for all sub-resources that have export-resource defined (which is defined at the site layout, page, and navigation level), exports can be very granular.
</para>
<para>This operation is accessed through the portal using the <application>Import/Export Site</application> tool. For more information about this tool, refer to the <citetitle>Import and Export</citetitle> section in the <citetitle>User Guide</citetitle>.</para>
</section>
@@ -40,9 +34,9 @@
<para>
The
<code>import-resource</code>
- operation can only be executed at the mop component (root managed resource of the mop extension). This is because the exported zip file contains the path information (like site type and site name). So executing an
+ operation can only be executed at the mop component (root managed resource of the mop extension). This is because the exported Zip file contains path information (like site type and site name). So executing an
<code>import-resource</code>
- operation on a group site, when the zip contains data from a portal site, does not make sense.
+ operation on a group site, when the Zip contains data from a portal site, does not make sense.
</para>
<para>This operation is accessed through the portal using the <application>Import/Export Site</application> tool. For more information about this tool, refer to the <citetitle>Import and Export</citetitle> section in the <citetitle>User Guide</citetitle>.</para>
<para>
@@ -57,7 +51,7 @@
<term>Conserve</term>
<listitem>
<para>
- Import data only if no artifacts exist for that site. For example if one page exists for site 'classic', nothing will be imported.
+ Import data only if no artifacts exist for that site. For example if one page exists for site <citetitle>classic</citetitle>, nothing will be imported.
</para>
</listitem>
@@ -84,9 +78,9 @@
<term>Overwrite</term>
<listitem>
<para>
- Delete all data for that artifact of the site, import new data. For example if the zip file only contains pages for site classic, then
+ Delete all data for that artifact of the site, then import new data. For example if the Zip file only contains pages for site <citetitle>classic</citetitle>, then
- all pages for that site are deleted and imported.
+ all pages for that site are deleted and the contents of the Zip file imported.
</para>
</listitem>
@@ -97,59 +91,54 @@
<section id="sid-8094332_GateInManagement-PathTemplatesx">
<title>Path Templates</title>
<para>Below are the list of path template variables defined in the MOP management extension. These path template variables are used for filtering during export.</para>
- <itemizedlist>
- <listitem>
- <para>
- <code>site-type</code>
-
- These are the site types of the portal to include or exclude. Available values are:
+ <variablelist>
+ <title>Path template variables</title>
+ <varlistentry>
+ <term>site-type</term>
+ <listitem>
+ <para>
+ These are the site types of the portal to include or exclude. Available values are:
<code>portal</code>
,
<code>group</code>
, and
- <code>user</code>
- .
- </para>
- </listitem>
- <listitem>
- <para>
- <code>site-name</code>
-
- The sites to include or exclude. Examples could be
- <code>classic</code>
- and
- <code>/platform/administrators</code>
- .
- </para>
- </listitem>
- <listitem>
- <para>
- <code>site-layout</code>
-
- The name of the site layout depending on the site type. Available values are:
- <code>portal</code>
- ,
- <code>group</code>
- ,
- <code>user</code>
- .
- </para>
- </listitem>
- <listitem>
- <para>
- <code>page-name</code>
-
- The name of the page(s) to include or exclude.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>nav-uri</code>
-
- The URI of the navigation node to include or exclude.
- </para>
- </listitem>
- </itemizedlist>
+ <code>user</code>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>site-name</term>
+ <listitem>
+ <para>
+ The sites to include or exclude. Examples could be <code>classic</code> and <code>/platform/administrators</code>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>site-layout</term>
+ <listitem>
+ <para>
+ The name of the site layout depending on the site type. Available values are: <code>portal</code>, <code>group</code>, <code>user</code>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>page-name</term>
+ <listitem>
+ <para>
+ The name of the page(s) to include or exclude.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nav-uri</term>
+ <listitem>
+ <para>
+ The URI of the navigation node to include or exclude.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sid-8094332_GateInManagement-RESTAPI">
<title>REST API</title>
@@ -168,7 +157,7 @@
<section id="sid-8094332_GateInManagement-MOPComponentResource">
<title>MOP Component Resource</title>
<para>
- The mop managed component resource (root managed resource) is the only resource that accepts the
+ The <systemitem>mop</systemitem> managed component resource (root managed resource) is the only resource that accepts the
<code>import-resource</code>
operation.
</para>
@@ -181,18 +170,18 @@
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK</programlisting>
+ <screen>HTTP/1.1 200 OK</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-SiteLayoutResource">
<title>Site Layout Resource</title>
<para>
- The site layout resource represents the site layout of the portal. It's the data defined in the
- <emphasis role="strong">portal.xml</emphasis>
+ The site layout resource represents the site layout of the portal. It is the data defined in the
+ <filename>portal.xml</filename>
,
- <emphasis role="strong">group.xml</emphasis>
+ <filename>group.xml</filename>
, and
- <emphasis role="strong">user.xml</emphasis>
+ <filename>user.xml</filename>
files (depending on site type) used in portal extensions to configure data.
</para>
<example>
@@ -201,18 +190,18 @@
</example>
<section id="sid-8094332_GateInManagement-readconfigasxmlx">
<title>config-as-xml</title>
- <para>Example of reading the site layout as xml for site classic.</para>
+ <para>Example of reading the site layout as XML for site classic.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/portal.xml
+ <screen>GET /mop/portalsites/classic/portal.xml
or
-GET /mop/portalsites/classic/portal?op=read-config-as-xml</programlisting>
+GET /mop/portalsites/classic/portal?op=read-config-as-xml</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/xml
<portal-config>
@@ -221,7 +210,7 @@
<description>GateIn default portal</description>
<locale>en</locale>
...
-</portal-config></programlisting>
+</portal-config></screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-exportresourcex">
@@ -229,42 +218,42 @@
<para>Example of exporting the site layout for site classic.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/portal.zip
+ <screen>GET /mop/portalsites/classic/portal.zip
or
-GET /mop/portalsites/classic/portal?op=export-resource</programlisting>
+GET /mop/portalsites/classic/portal?op=export-resource</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/zip
-[binary data]</programlisting>
+[binary data]</screen>
</example>
</section>
</section>
<section id="sid-8094332_GateInManagement-PagesResource">
<title>Pages Resource</title>
- <para>The pages resource represents the pages of the portal. It's the data defined in the pages.xml used in portal extensions to configure data.</para>
+ <para>The pages resource represents the pages of the portal. It is the data defined in the <filename>pages.xml</filename> used in portal extensions to configure data.</para>
<example>
<title>URL</title>
<programlisting>URL: /mop/{site-type}sites/{site-name}/pages/{page-name}</programlisting>
</example>
<section id="sid-8094332_GateInManagement-readconfigasxmlxx">
<title>config-as-xml</title>
- <para>Example of reading all pages as xml for site classic.</para>
+ <para>Example of reading all pages as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/pages.xml
+ <screen>GET /mop/portalsites/classic/pages.xml
or
-GET /mop/portalsites/classic/pages?op=read-config-as-xml</programlisting>
+GET /mop/portalsites/classic/pages?op=read-config-as-xml</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/xml
<page-set>
@@ -276,20 +265,20 @@
<show-max-window>false</show-max-window>
<portlet-application>
...
-</page-set></programlisting>
+</page-set></screen>
</example>
- <para>Example of reading the homepage as xml for site classic.</para>
+ <para>Example of reading the homepage as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/pages/homepage.xml
+ <screen>GET /mop/portalsites/classic/pages/homepage.xml
or
-GET /mop/portalsites/classic/pages/homepage?op=read-config-as-xml</programlisting>
+GET /mop/portalsites/classic/pages/homepage?op=read-config-as-xml</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/xml
<page-set>
@@ -301,50 +290,50 @@
<show-max-window>false</show-max-window>
<portlet-application>
...
-</page-set></programlisting>
+</page-set></screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-exportresourcexx">
<title>export-resource</title>
- <para>Example of exporting all pages of site classic.</para>
+ <para>Example of exporting all pages of site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/pages.zip
+ <screen>GET /mop/portalsites/classic/pages.zip
or
-GET /mop/portalsites/classic/pages?op=export-resource</programlisting>
+GET /mop/portalsites/classic/pages?op=export-resource</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/zip
-[binary data]</programlisting>
+[binary data]</screen>
</example>
</section>
</section>
<section id="sid-8094332_GateInManagement-NavigationResource">
<title>Navigation Resource</title>
- <para>The navigation resource represents the navigation of the portal. It's the data defined in the navigation.xml used in portal extensions to configure data.</para>
+ <para>The navigation resource represents the navigation of the portal. It is the data defined in the <filename>navigation.xml</filename> used in portal extensions to configure data.</para>
<example>
<title>URL</title>
<programlisting>URL: /mop/{site-type}sites/{site-name}/navigation/{nav-uri}</programlisting>
</example>
<section id="sid-8094332_GateInManagement-readconfigasxmlxxx">
<title>config-as-xml</title>
- <para>Example of reading all navigation as xml for site classic.</para>
+ <para>Example of reading all navigation as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/navigation.xml
+ <screen>GET /mop/portalsites/classic/navigation.xml
or
-GET /mop/portalsites/classic/navigation?op=read-config-as-xml</programlisting>
+GET /mop/portalsites/classic/navigation?op=read-config-as-xml</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/xml
<node-navigation>
@@ -360,20 +349,20 @@
<node>
<name>sitemap</name>
...
-</node-navigation></programlisting>
+</node-navigation></screen>
</example>
- <para>Example of reading the home node as xml for site classic.</para>
+ <para>Example of reading the home node as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/navigation/home.xml
+ <screen>GET /mop/portalsites/classic/navigation/home.xml
or
-GET /mop/portalsites/classic/navigation/home?op=read-config-as-xml</programlisting>
+GET /mop/portalsites/classic/navigation/home?op=read-config-as-xml</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/xml
<node-navigation>
@@ -388,26 +377,26 @@
<page-reference>portal::classic::homepage</page-reference>
</node>
</page-nodes>
-</node-navigation></programlisting>
+</node-navigation></screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-exportresourcexxx">
<title>export-resource</title>
- <para>Example of exporting all navigation of site classic.</para>
+ <para>Example of exporting all navigation of site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
- <programlisting>GET /mop/portalsites/classic/navigation.zip
+ <screen>GET /mop/portalsites/classic/navigation.zip
or
-GET /mop/portalsites/classic/navigation?op=export-resource</programlisting>
+GET /mop/portalsites/classic/navigation?op=export-resource</screen>
</example>
<example>
<title>HTTP Response</title>
- <programlisting>HTTP/1.1 200 OK
+ <screen>HTTP/1.1 200 OK
Content-Type: application/zip
-[binary data]</programlisting>
+[binary data]</screen>
</example>
</section>
</section>
@@ -421,16 +410,19 @@
operation. The filter attribute is a multi-value attribute that is passed as request parameters of the HTTP request.
</para>
<note>
- <title>Note</title>
<para>You can either include multiple filter parameters (?filter=foo:bar&filter=baz:foo-bar) or separate via ';' character (?filter=foo:bar;baz:foo-bar)</para>
</note>
<example>
<title>Export only registry and pageManagement navigation nodes</title>
- <programlisting>GET /mop/groupsites/platform/administrators/navigation.zip?filter=nav-uri:/administration/registry,/administration/pageManagement</programlisting>
+ <para>
+ <command>GET /mop/groupsites/platform/administrators/navigation.zip?filter=nav-uri:/administration/registry,/administration/pageManagement</command>
+ </para>
</example>
<example>
- <title>Export all site types but user and group</title>
- <programlisting>GET /mop.zip?filter=site-type:!user,group</programlisting>
+ <title>Export all site types but <systemitem>user</systemitem> and <systemitem>group</systemitem></title>
+ <para>
+ <command>GET /mop.zip?filter=site-type:!user,group</command>
+ </para>
</example>
</section>
</section>
@@ -439,17 +431,17 @@
<para>The commands included in the management component provide us the tools to perform management operations on these MOP artifacts: site layout, pages, and navigation.</para>
<section id="sid-8094332_GateInManagement-ResourcePaths">
<title>Resource Paths</title>
- <para>The paths of the MOP resources are exactly the same as the REST URL's (of course without the URL syntax). For example the path of the homepage for the classic site would be:</para>
+ <para>The paths of the MOP resources are exactly the same as the REST URLs (without the URL syntax). For example the path of the homepage for the <citetitle>classic</citetitle> site would be:</para>
<example>
<title>Example</title>
- <programlisting>[ /]% cd /mop/portalsites/classic/pages/homepage
+ <screen>[ /]% cd /mop/portalsites/classic/pages/homepage
[homepage]% pwd
-/mop/portalsites/classic/pages/homepage</programlisting>
+/mop/portalsites/classic/pages/homepage</screen>
</example>
<note>
<title>Note</title>
- <para>All resources/paths can be autocompleted by hitting the tab key.</para>
+ <para>All resources/paths can be autocompleted by pressing the <systemitem>Tab</systemitem> key.</para>
</note>
</section>
<section id="sid-8094332_GateInManagement-ExportandFilteringx">
@@ -467,25 +459,33 @@
</para>
<example>
<title>Export all portal site types</title>
- <programlisting>export --file /tmp/mop.zip --filter site-type:portal /mop</programlisting>
+ <para>
+ <command>export --file /tmp/mop.zip --filter site-type:portal /mop</command>
+ </para>
</example>
<example>
<title>Export all sites types but user</title>
- <programlisting>export --file /tmp/mop.zip --filter site-type:!user /mop</programlisting>
+ <para>
+ <command>export --file /tmp/mop.zip --filter site-type:!user /mop</command>
+ </para>
</example>
<para>The option can be specified multiple times for multiple values.</para>
<example>
<title>Export only the /platform/administrators group site</title>
- <programlisting>export --file /tmp/mop.zip --filter site-type:group --filter site-name:/platform/administrators /mop</programlisting>
+ <para>
+ <command>export --file /tmp/mop.zip --filter site-type:group --filter site-name:/platform/administrators /mop</command>
+ </para>
</example>
<para>
- Also as discussed in the Path Templates section in this document, the filter attribute can separate different path templates by the
+ Also as discussed in the <citetitle>Path Templates</citetitle> section, the filter attribute can separate different path templates by the
<code>;</code>
character.
</para>
<example>
- <title>Export only pages named homepage, navigation named home for site classic</title>
- <programlisting>export --file /tmp/classic.zip --filter page-name:homepage;nav-uri:home /mop/portalsites/classic</programlisting>
+ <title>Export only pages named homepage, navigation named home for site <citetitle>classic</citetitle></title>
+ <para>
+ <command>export --file /tmp/classic.zip --filter page-name:homepage;nav-uri:home /mop/portalsites/classic</command>
+ </para>
</example>
<important>
<title>Important</title>
@@ -502,9 +502,11 @@
</para>
<example>
<title>Export MOP artifacts</title>
- <programlisting>$ scp -P 2000 'root@example.org:portal:/mop/portalsites/classic' classic.zip
-$ scp -P 2000 'root@example.org:portal:/mop/portalsites/classic/pages/homepage' homepage.zip
-$ scp -P 2000 'root@example.org:portal:/mop' mop.zip</programlisting>
+ <para>
+ <screen>$ scp -P 2000 'root@example.org:portal:/mop/portalsites/classic' classic.zip
+ $ scp -P 2000 'root@example.org:portal:/mop/portalsites/classic/pages/homepage' homepage.zip
+ $ scp -P 2000 'root@example.org:portal:/mop' mop.zip</screen>
+ </para>
</example>
<para>
The
@@ -515,9 +517,11 @@
</para>
<example>
<title>Import MOP artifacts</title>
- <programlisting>$ scp -P 2000 classic.zip 'root@example.org:portal:/mop'
-$ scp -P 2000 homepage.zip 'root@example.org:portal:/mop?importMode=overwrite'
-$ scp -P 2000 mop.zip 'root@example.org:portal:/mop'</programlisting>
+ <para>
+ <screen>$ scp -P 2000 classic.zip 'root@example.org:portal:/mop'
+ $ scp -P 2000 homepage.zip 'root@example.org:portal:/mop?importMode=overwrite'
+ $ scp -P 2000 mop.zip 'root@example.org:portal:/mop'</screen>
+ </para>
</example>
</section>
</section>
11 years, 10 months
gatein SVN: r9146 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-13 15:34:04 -0500 (Wed, 13 Feb 2013)
New Revision: 9146
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
Log:
Changed several instances of '<screen>' with '<command>' as appropriate
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:54:53 UTC (rev 9145)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 20:34:04 UTC (rev 9146)
@@ -29,11 +29,15 @@
<para>After deploying the CLI web application you can connect to the CLI over SSH as follows</para>
<example>
<title>SSH Syntax</title>
- <screen>ssh -p <port> <user>@<host></screen>
+ <para>
+ <command>ssh -p <port> <user> @<host></command>
+ </para>
</example>
<example>
<title>SSH Example</title>
- <screen>ssh -p 2000 root@localhost</screen>
+ <para>
+ <command>ssh -p 2000 root@localhost</command>
+ </para>
</example>
<remark>Added full path for clarity.</remark>
<para>
@@ -147,7 +151,7 @@
<title>cat</title>
<para>
The
- <code>cat</code>
+ <command>cat</command>
command executes the
<code>read-config-as-xml</code>
operation on a managed resource and outputs the XML data to the shell. The managed resource must support the
@@ -295,7 +299,7 @@
<title>import</title>
<para>
The
- <code>import</code>
+ <command>import</command>
command executes the
<code>import-resource</code>
operation on a managed resource.
@@ -353,7 +357,9 @@
</para>
<example>
<title>Syntax</title>
- <screen>$ scp -P <port> <user>@<host>:{portal-container}:{path} <file></screen>
+ <para>
+ <command>$ scp -P <port> <user>@<host>:{portal-container}:{path} <file></command>
+ </para>
</example>
<para>
The
@@ -367,12 +373,16 @@
<para>So to export 'foo/bar' resource assuming the CLI is deployed to 'example.org'.</para>
<example>
<title>Export of foo/bar resource</title>
- <screen>$ scp -P 2000 'root@example.org:portal:/foo/bar' bar.zip</screen>
+ <para>
+ <command>$ scp -P 2000 'root@example.org:portal:/foo/bar' bar.zip</command>
+ </para>
</example>
<para>Attributes like 'filter' can be added to the path of the SCP command just as you would add query parameters to a URL.</para>
<example>
<title>Export of foo/bar resource with filter</title>
- <screen>$ scp -P 2000 'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar' foo.zip</screen>
+ <para>
+ <command>$ scp -P 2000 'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar' foo.zip</command>
+ </para>
</example>
</section>
<section id="sid-8094332_GateInManagement-Import">
@@ -384,7 +394,9 @@
</para>
<example>
<title>Syntax</title>
- <screen>$ scp -P <port> <file> <user>@<host>:{portal-container}:{path}</screen>
+ <para>
+ <command>$ scp -P <port> <file> <user>@<host>:{portal-container}:{path}</command>
+ </para>
</example>
<para>
The
@@ -397,7 +409,9 @@
</para>
<example>
<title>Import foo.zip to foo resource</title>
- <screen>$ scp -P 2000 foo.zip 'root@example.org:portal:/foo'</screen>
+ <para>
+ <command>$ scp -P 2000 foo.zip 'root@example.org:portal:/foo'</command>
+ </para>
</example>
<para>More specific examples of the SCP command can be found below pertaining to that particular management extension.</para>
</section>
11 years, 10 months
gatein SVN: r9145 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-13 01:54:53 -0500 (Wed, 13 Feb 2013)
New Revision: 9145
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
Log:
Fixed incomplete 'screen' tag.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:52:29 UTC (rev 9144)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:54:53 UTC (rev 9145)
@@ -29,7 +29,7 @@
<para>After deploying the CLI web application you can connect to the CLI over SSH as follows</para>
<example>
<title>SSH Syntax</title>
- <scree>ssh -p <port> <user>@<host></screen>
+ <screen>ssh -p <port> <user>@<host></screen>
</example>
<example>
<title>SSH Example</title>
11 years, 10 months
gatein SVN: r9144 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-13 01:52:29 -0500 (Wed, 13 Feb 2013)
New Revision: 9144
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
Log:
Removed unnecessary note admonition tag.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:50:29 UTC (rev 9143)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:52:29 UTC (rev 9144)
@@ -399,10 +399,7 @@
<title>Import foo.zip to foo resource</title>
<screen>$ scp -P 2000 foo.zip 'root@example.org:portal:/foo'</screen>
</example>
- <note>
- <title>Note</title>
- <para>More specific examples of the SCP command can be found below pertaining to that particular management extension.</para>
- </note>
+ <para>More specific examples of the SCP command can be found below pertaining to that particular management extension.</para>
</section>
</section>
</section>
11 years, 10 months
gatein SVN: r9143 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-13 01:50:29 -0500 (Wed, 13 Feb 2013)
New Revision: 9143
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
Log:
Grammatical corrections and replacement of 'programlisting' with 'screen' DocBook tag as appropriate.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-12 05:26:16 UTC (rev 9142)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13 06:50:29 UTC (rev 9143)
@@ -29,11 +29,11 @@
<para>After deploying the CLI web application you can connect to the CLI over SSH as follows</para>
<example>
<title>SSH Syntax</title>
- <programlisting>ssh -p <port> <user>@<host></programlisting>
+ <scree>ssh -p <port> <user>@<host></screen>
</example>
<example>
<title>SSH Example</title>
- <programlisting>ssh -p 2000 root@localhost</programlisting>
+ <screen>ssh -p 2000 root@localhost</screen>
</example>
<remark>Added full path for clarity.</remark>
<para>
@@ -76,7 +76,7 @@
</para>
<example>
<title>mgmt help</title>
- <programlisting>% mgmt -h
+ <screen>% mgmt -h
usage: mgmt[-h | --help] COMMAND [ARGS]
The most commonly used mgmt commands are:
@@ -92,7 +92,7 @@
[-p | --password] the user passowrd
[-c | --container] portal container name (default is portal)
-%</programlisting>
+%</screen>
</example>
<para>
The
@@ -101,19 +101,19 @@
</para>
<example>
<title>Connecting to default portal container</title>
- <programlisting>% mgmt connect
+ <screen>% mgmt connect
Password:
Successfully connected to gatein management system: [user=root, container='portal', host='127.0.0.1']
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Connecting to portal container 'sample-portal' as user john</title>
- <programlisting>% mgmt connect -u john -c sample-portal
+ <screen>% mgmt connect -u john -c sample-portal
Password:
Successfully connected to gatein management system: [user=john, container='sample-portal', host='127.0.0.1']
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<para>
The
@@ -122,7 +122,7 @@
</para>
<example>
<title>mgmt exec help</title>
- <programlisting>[ /]% mgmt exec -h
+ <screen>[ /]% mgmt exec -h
usage: mgmt [-h | --help] exec [-c | --contentType] [-f | --file] [-a | --attribute] [-o | --operation] path
[-h | --help] command usage
@@ -132,15 +132,15 @@
[-o | --operation] Operation name
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Executing operation read-config-as-xml on managed component foo</title>
- <programlisting>[ /]% mgmt exec --operation read-config-as-xml --contentType xml /foo
+ <screen>[ /]% mgmt exec --operation read-config-as-xml --contentType xml /foo
<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-cat">
@@ -150,13 +150,13 @@
<code>cat</code>
command executes the
<code>read-config-as-xml</code>
- operation on a managed resource and outputs the xml data to the shell. Obviously the managed resource must support the
+ operation on a managed resource and outputs the XML data to the shell. The managed resource must support the
<code>read-config-as-xml</code>
operation.
</para>
<example>
<title>cat help</title>
- <programlisting>[ /]% cat -h
+ <screen>[ /]% cat -h
usage: cat [-h | --help] path
   [-h | --help] command usage
@@ -166,7 +166,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-cd">
@@ -174,19 +174,19 @@
<para>The cd command changes the current path of the CLI.</para>
<example>
<title>cd help</title>
- <programlisting>[ /]% cd -h
+ <screen>[ /]% cd -h
usage: cd [-h | --help] path
   [-h | --help] command usage
   path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Change path to /foo/bar</title>
- <programlisting>[ /]% cd /foo/bar
+ <screen>[ /]% cd /foo/bar
-[bar]%</programlisting>
+[bar]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-ls">
@@ -200,7 +200,7 @@
</para>
<example>
<title>ls help</title>
- <programlisting>[ /]% ls -h
+ <screen>[ /]% ls -h
usage: ls [-h | --help] path
[-h | --help] command usage
@@ -213,7 +213,7 @@
[ /]% ls /foo
baz
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-pwd">
@@ -225,7 +225,7 @@
</para>
<example>
<title>pwd help</title>
- <programlisting>[ /]% pwd -h
+ <screen>[ /]% pwd -h
usage: pwd [-h | --help]
[-h | --help] command usage
@@ -237,7 +237,7 @@
[baz]% pwd
/foo/baz
-[baz]%</programlisting>
+[baz]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-export">
@@ -251,11 +251,11 @@
</para>
<important>
<title>Important</title>
- <para>Since the CLI is connected to the portal server over SSH, the export command will write to the servers file system, not the client.</para>
+ <para>Since the CLI is connected to the portal server over SSH, the export command will write to the server's file system, not that of the client.</para>
</important>
<example>
<title>export help</title>
- <programlisting>[ /]% export -h
+ <screen>[ /]% export -h
usage: export [-h | --help] [-f | --file] [-r | --filter] path
[-h | --help] command usage
@@ -263,14 +263,14 @@
[-r | --filter] Specifies the value of the filter to use during an export for example.
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Export resource foo to /tmp directory</title>
- <programlisting>[ /]% export --file /tmp foo
+ <screen>[ /]% export --file /tmp foo
Export complete ! File location: /tmp/foo_2011-10-21_18-29-36.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
<note>
<title>Note</title>
@@ -278,17 +278,17 @@
</note>
<example>
<title>Export resource /foo to /tmp/export-example.zip file</title>
- <programlisting>[ /]% export --file /tmp/export-example.zip foo
+ <screen>[ /]% export --file /tmp/export-example.zip foo
Export complete ! File location: /tmp/export-example.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
<example>
<title>Export resource filtering on path template variable bar</title>
- <programlisting>[ /]% export --file /tmp/export-filter-example.zip --filter bar:baz,foo-bar foo
+ <screen>[ /]% export --file /tmp/export-filter-example.zip --filter bar:baz,foo-bar foo
Export complete ! File location: /tmp/export-filter-example.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-import">
@@ -302,7 +302,7 @@
</para>
<example>
<title>import help</title>
- <programlisting>[ /]% import -h
+ <screen>[ /]% import -h
usage: importfile [-h | --help] [-f | --file] [-m | --importMode] path
[-h | --help] command usage
@@ -310,7 +310,7 @@
[-m | --importMode] The import mode for an import operation
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<important>
<title>Important</title>
@@ -318,21 +318,21 @@
</important>
<example>
<title>Import file /tmp/foo.zip to resource foo</title>
- <programlisting>[ /]% import --file /tmp/foo.zip /foo
+ <screen>[ /]% import --file /tmp/foo.zip /foo
Successfully imported file /tmp/foo.zip
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Import file /tmp/foo.zip to resource foo using importMode overwrite</title>
- <programlisting>[ /]% import --file /tmp/foo.zip --importMode overwrite /foo
+ <screen>[ /]% import --file /tmp/foo.zip --importMode overwrite /foo
Successfully imported file /tmp/foo.zip
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<note>
<title>Note</title>
- <para>You can autocomplete the import modes by typing --importMode and hitting tab.</para>
+ <para>You can autocomplete the import modes by typing --importMode and pressing the Tab key.</para>
</note>
</section>
<section id="sid-8094332_GateInManagement-SecureCopy">
@@ -349,11 +349,11 @@
<para>
To execute the
<code>export-resource</code>
- operation using SCP the source of the SCP command is the portal server and the target is the local file to export to.
+ operation using SCP, the source of the SCP command is the portal server and the target is the local file to which the resource is to be exported.
</para>
<example>
<title>Syntax</title>
- <programlisting>$ scp -P <port> <user>@<host>:{portal-container}:{path} <file></programlisting>
+ <screen>$ scp -P <port> <user>@<host>:{portal-container}:{path} <file></screen>
</example>
<para>
The
@@ -367,12 +367,12 @@
<para>So to export 'foo/bar' resource assuming the CLI is deployed to 'example.org'.</para>
<example>
<title>Export of foo/bar resource</title>
- <programlisting>$ scp -P 2000 'root@example.org:portal:/foo/bar' bar.zip</programlisting>
+ <screen>$ scp -P 2000 'root@example.org:portal:/foo/bar' bar.zip</screen>
</example>
<para>Attributes like 'filter' can be added to the path of the SCP command just as you would add query parameters to a URL.</para>
<example>
<title>Export of foo/bar resource with filter</title>
- <programlisting>$ scp -P 2000 'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar' foo.zip</programlisting>
+ <screen>$ scp -P 2000 'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar' foo.zip</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-Import">
@@ -380,11 +380,11 @@
<para>
To execute the
<code>import-resource</code>
- operation using SCP the source of the SCP command is the local file and the target is the portal server.
+ operation using SCP, the source of the SCP command is the local file and the target is the portal server.
</para>
<example>
<title>Syntax</title>
- <programlisting>$ scp -P <port> <file> <user>@<host>:{portal-container}:{path}</programlisting>
+ <screen>$ scp -P <port> <file> <user>@<host>:{portal-container}:{path}</screen>
</example>
<para>
The
@@ -397,7 +397,7 @@
</para>
<example>
<title>Import foo.zip to foo resource</title>
- <programlisting>$ scp -P 2000 foo.zip 'root@example.org:portal:/foo'</programlisting>
+ <screen>$ scp -P 2000 foo.zip 'root@example.org:portal:/foo'</screen>
</example>
<note>
<title>Note</title>
11 years, 10 months
gatein SVN: r9142 - in epp/docs/branches/6.0: Reference_Guide/en-US/modules/PortalDevelopment and 1 other directory.
by do-not-reply＠jboss.org
Author: jaredmorgs
Date: 2013-02-12 00:26:16 -0500 (Tue, 12 Feb 2013)
New Revision: 9142
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/Portal_Development/Portal_Extension.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
Log:
changes to notes in the Portal Extension quickstart sections for consistency
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Portal_Development/Portal_Extension.xml
===================================================================
(Binary files differ)
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2013-02-12 04:30:32 UTC (rev 9141)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2013-02-12 05:26:16 UTC (rev 9142)
@@ -99,7 +99,7 @@
Once you have created a custom portal container that suits your needs, you may wish to disable a portal container that is no longer required.
</para>
<task>
- <title>Task: Disable a portal in JBoss Portal Platform 5</title>
+ <title>Task: Disable a portal in JBoss Portal Platform 6</title>
<tasksummary>
<para>Disable an unused portal container in a JBoss Portal Platform instance.
</para>
@@ -109,7 +109,7 @@
<itemizedlist>
<listitem>
<para>
-A new portal container is created,
+Nil.
</para>
</listitem>
</itemizedlist>
11 years, 10 months
gatein SVN: r9141 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-11 23:30:32 -0500 (Mon, 11 Feb 2013)
New Revision: 9141
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
Log:
Review and minor editing of chapter 2
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-12 03:45:58 UTC (rev 9140)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-12 04:30:32 UTC (rev 9141)
@@ -6,7 +6,7 @@
<chapter id="sid-8094332_GateInManagement-REST">
<title>REST</title>
- <para>The management REST component is responsible for mapping restful requests to management requests. It does this by locating the managed resource by mapping the request URL to a management address and then invoking an operation on that managed resource. It defines an entry point for RESTful clients, and exposes the registered managed resources and operations over REST.</para>
+ <para>The management REST component is responsible for mapping RESTful requests to management requests. It does this by locating the managed resource, mapping the request URL to a management address, then invoking an operation on that managed resource. It defines an entry point for RESTful clients, and exposes the registered managed resources and operations over REST.</para>
<section id="sid-8094332_GateInManagement-EntryPoint">
<title>Entry Point</title>
@@ -57,7 +57,7 @@
<section id="sid-8094332_GateInManagement-HTTPMethod">
<title>HTTP Method</title>
- <para>The following table shows which HTTP methods map to operation names.</para>
+ <para>The following table maps HTTP methods to operation names.</para>
<informaltable>
<tgroup cols="2">
<thead>
@@ -150,10 +150,10 @@
<title>Custom operation defined in request parameter</title>
<programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?op=some-cus...</programlisting>
</example>
- <para>It's best practice to use the HTTP method to dictate the operation name when it can. However nothing stops a client explicitly setting operation names as request parameters.</para>
+ <para>It's best practice to use the HTTP method to dictate the operation name when it can. However a client can explicitly set operation names as request parameters.</para>
<note>
<title>Note</title>
- <para>The following URL's are equivalent for a GET request:</para>
+ <para>The following URLs are equivalent to a GET request:</para>
<itemizedlist>
<listitem>
<para>
@@ -171,7 +171,7 @@
<section id="sid-8094332_GateInManagement-URLExtension">
<title>URL Extension</title>
- <para>Sometimes it's nice to represent REST resources as files, so two URL extensions have been added to support two common operations: read-config-as-xml and export-resource. By adding the following URL extensions at the end of the URL, you can invoke these two operations.</para>
+ <para>REST resources can be represented as files, so two URL extensions have been added to support two common operations: read-config-as-xml and export-resource. By adding the following URL extensions at the end of the URL, you can invoke these two operations.</para>
<informaltable>
<tgroup cols="3">
<thead>
@@ -241,7 +241,7 @@
<para>This is just a convenient way to specify the operation name as a file extension instead of specifying it as a request parameter.</para>
<note>
<title>Note</title>
- <para>The following URL's are equivalent:</para>
+ <para>The following URLs are equivalent:</para>
<itemizedlist>
<listitem>
<para>
@@ -361,12 +361,12 @@
<title>Browser Content Negotiation</title>
<para>
- To make it easy to control the content type of management requests through the browser, the rest component supports the
+ To make it easy to control the content type of management requests through the browser, the REST component supports the
<code>format</code>
HTTP parameter to dictate the format of the response. This is because most browsers already send an 'Accept' header.
</para>
<example>
- <title>Specifying the response should be returned as xml</title>
+ <title>Specifying the response should be returned as XML</title>
<programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?format=xml</programlisting>
</example>
<para>
@@ -426,7 +426,7 @@
</informaltable>
<important>
<title>Important</title>
- <para>Content negotiation is ignored for content type specific operations such as 'read-config-as-xml' and 'export-resource' since these cannot return different formats.</para>
+ <para>Content negotiation is ignored for content type specific operations such as <systemitem>read-config-as-xml</systemitem> and <systemitem>export-resource</systemitem> since these cannot return different formats.</para>
</important>
</section>
<section id="sid-8094332_GateInManagement-readresource">
@@ -435,7 +435,7 @@
<para>
Since the
<code>read-resource</code>
- operation is a built in operation provided by the management component, as opposed to extensions, below documents the format of the response.
+ operation is a built-in operation provided by the management component, as opposed to extensions, the response is formatted as follows.
</para>
<example>
<title>HTTP Request</title>
@@ -478,7 +478,7 @@
</example>
<example>
<title>Response as XML</title>
- <programlisting>HTTP/1.1 200 OK
+ <programlisting language="XML">HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
11 years, 10 months
gatein SVN: r9140 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-02-11 22:45:58 -0500 (Mon, 11 Feb 2013)
New Revision: 9140
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
Log:
Review and minor editing of chapter 1
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2013-02-11 15:09:40 UTC (rev 9139)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2013-02-12 03:45:58 UTC (rev 9140)
@@ -5,7 +5,7 @@
]>
<chapter id="sid-8094332_GateInManagement-Introduction">
<title>Introduction</title>
- <para>The management component of the portal allows portal resources to be managed over commons interfaces like REST, CLI, and Portlets/Gadgets. This guide will discuss these interfaces as well as general portal management concepts and terms. It will then discuss specific management extensions included in the portal.</para>
+ <para>The management component of the portal allows a portal's resources to be managed over common interfaces such as REST, a CLI, and portlets/gadgets. This guide will discuss these interfaces as well as general portal management concepts and terms. It will then discuss specific management extensions included in the portal.</para>
<section id="sid-8094332_GateInManagement-Terms">
<title>Terms</title>
<informaltable>
@@ -34,8 +34,7 @@
</row>
<row>
<entry>
- <para> Managed Component
-
+ <para>Managed Component
</para>
</entry>
<entry>
@@ -46,13 +45,11 @@
<entry>
<para>
Managed Resource
-
</para>
</entry>
<entry>
<para>
- A managed resource is a uniquely identified self describing 'resource' which can have operations and sub-resources registered to it.
-
+ A managed resource is a uniquely identified self-describing 'resource' which can have operations and sub-resources registered to it.
</para>
</entry>
</row>
@@ -66,7 +63,6 @@
<entry>
<para>
A managed resource whose parent is also a managed resource.
-
</para>
</entry>
</row>
@@ -74,13 +70,11 @@
<entry>
<para>
Address
-
</para>
</entry>
<entry>
<para>
- A management address is just the path of the managed resource with syntax similar to a file on a file system, ie: /foo/bar
-
+ A management address is the path of the managed resource with syntax similar to a file on a file system, ie: /foo/bar
</para>
</entry>
</row>
@@ -88,13 +82,11 @@
<entry>
<para>
Operation
-
</para>
</entry>
<entry>
<para>
An action that can be performed on a managed resource.
-
</para>
</entry>
</row>
@@ -102,13 +94,11 @@
<entry>
<para>
Attributes
-
</para>
</entry>
<entry>
<para>
Custom input parameters available to operations.
-
</para>
</entry>
</row>
@@ -118,14 +108,14 @@
</section>
<section id="sid-8094332_GateInManagement-Goals">
<title>Goals</title>
- <para>The management component provides a foundation for managing portal side components. By doing so it allows management extensions to register resources and operations over a set of API's, which in turn allows us to expose these over common interfaces like REST and CLI. In other words, management extensions do not have to worry about the interfaces in which they will be managed over. This allows us to add additional interfaces without needing to change anything. Also by providing a set of API's to obtain managed resources, interfaces are built in a consistent manner. So managing the same component in one interface should be very similar if you were to manage it in another.</para>
+ <para>The management component provides a foundation for managing portal side components. By doing so it allows management extensions to register resources and operations over a set of APIs, which in turn allows us to expose these over common interfaces such as REST and a CLI. This approach means that management extensions are independent of their interfaces, allowing for additional interfaces to be added without changes to the extensions themselves. Providing a set of APIs to obtain managed resources results in interfaces built in a consistent manner. Managing the same component should be similar, regardless of the interface.</para>
</section>
<section id="sid-8094332_GateInManagement-Operations">
<title>Operations</title>
<para>
- The following operations are operations that have been identified by the management component to be common to most management extensions. The
+ The following operations are common to most management extensions. The
<code>read-resource</code>
- operation is really the only global operation supported in the core framework, all other operations need to be implemented by the extensions, since these would be specific to each extension.
+ operation is the only global operation supported in the core framework. All other operations need to be implemented by the extensions, since they are extension-specific.
</para>
<informaltable>
<tgroup cols="2">
@@ -152,9 +142,9 @@
</entry>
<entry>
<para>
- The read-resource operation is responsible for reading the managed resource; describing itself and listing any operations and/or sub-resources it may contain.
+ The read-resource operation is responsible for reading the managed resource; describing itself and listing any operations and/or sub-resources it may contain.
- This is the primary operation to obtain information about a managed component and it's managed resources.
+ This is the primary operation to obtain information about a managed component and its managed resources.
</para>
</entry>
</row>
@@ -166,7 +156,7 @@
</para>
</entry>
<entry>
- <para>The add-resource operation is responsible for adding/creating additional managed resources.</para>
+ <para>The <systemitem>add-resource</systemitem> operation is responsible for adding/creating additional managed resources.</para>
</entry>
</row>
<row>
@@ -177,7 +167,7 @@
</para>
</entry>
<entry>
- <para>The remove-resource operation is responsible for removing/deleting an existing managed resource.</para>
+ <para>The <systemitem>emove-resource</systemitem> operation is responsible for removing/deleting an existing managed resource.</para>
</entry>
</row>
<row>
@@ -185,7 +175,7 @@
<para>update-resource</para>
</entry>
<entry>
- <para>The update-resource operation is responsible for updating an existing managed resources state.</para>
+ <para>The <systemitem>update-resource</systemitem> operation is responsible for updating an existing managed resource's state.</para>
</entry>
</row>
<row>
@@ -196,7 +186,7 @@
</para>
</entry>
<entry>
- <para>The read-config-as-xml operation is responsible for representing the current managed resource as xml configuration.</para>
+ <para>The <systemitem>read-config-as-xml</systemitem> operation is responsible for representing the current managed resource as an XML configuration.</para>
</entry>
</row>
<row>
@@ -208,11 +198,11 @@
</entry>
<entry>
<para>
- The export-resource operation is responsible for exporting a managed resource in a format that is acceptable and used in an import. The export-resource is special in the
+ The <systemitem>export-resource</systemitem> operation is responsible for exporting a managed resource in a format that is acceptable and used in an import. The export-resource is special in the
- sense that there's built-in functionality to recursively traverse managed resources until it finds one that supports an export-resource operation. In other words you can
+ sense that there is built-in functionality to recursively traverse managed resources until it finds one that supports an export-resource operation. In other words you can
- register an export-resource operation on a sub-resource and it will be executed even by calling export-resource on any of it's ancestors.
+ register an export-resource operation on a sub-resource and it will be executed even by calling export-resource on any of its ancestors.
</para>
</entry>
@@ -226,7 +216,7 @@
</entry>
<entry>
<para>
- The import-resource operation is responsible for importing managed resources previously exported through an export-resource operation.
+ The <systemitem>import-resource</systemitem> operation is responsible for importing managed resources previously exported through an export-resource operation.
</para>
</entry>
@@ -237,12 +227,12 @@
</section>
<section id="sid-8094332_GateInManagement-ContentType">
<title>Content Type</title>
- <para>Content type defines the format of management requests/responses. The three content types supported at the moment are json, xml, and zip. Since read-config-as-xml (xml), export-resource (zip), and import-resource (zip) are content type specific operations, the response must be in that format. Other then that it's up to the extension on which content type is supported for each operation.</para>
+ <para>Content type defines the format of management requests/responses. The three content types supported at the moment are JSON, XML, and Zip. Since read-config-as-xml (XML), export-resource (Zip), and import-resource (Zip) are content type specific operations, the response must be in the same format. Aside from this restriction, it is up to the extension as to which content type is supported for each operation.</para>
</section>
<section id="sid-8094332_GateInManagement-PathTemplates">
<title>Path Templates</title>
<para>
- Path templates are something that management extensions use to define dynamic content when registering resources. These path template variables are used during an export-resource to filter these managed resources. By specifying the
+ Path templates are used by management extensions to define dynamic content when registering resources. These path template variables are used during an export-resource operation to filter these managed resources. By specifying the
<code>filter</code>
attribute of an export-resource operation, managed resources can be explicitly included or excluded during export.
</para>
@@ -253,7 +243,7 @@
</example>
<para>where path-var is the path template variable name, name is the name of a managed-resource, and the '!' char, which is optional, is to exclude that resource rather then include it. Below are some examples that use the path template variable 'foo':</para>
<example>
- <title>Only include managed resource 'bar'</title>
+ <title>Include managed resource 'bar'</title>
<programlisting>foo:bar</programlisting>
</example>
<example>
11 years, 10 months
gatein SVN: r9139 - epp/docs/branches/6.0/Developer_Guide/en-US/JavaScript_Development.
by do-not-reply＠jboss.org
Author: aakanksha_writer
Date: 2013-02-11 10:09:40 -0500 (Mon, 11 Feb 2013)
New Revision: 9139
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/JavaScript_Development/Script_Cookbook.xml
Log:
Reviewed chapter 20
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/JavaScript_Development/Script_Cookbook.xml
===================================================================
(Binary files differ)
11 years, 10 months
gatein SVN: r9138 - in epp/docs/branches/6.0/Developer_Guide/en-US: JavaScript_Development and 1 other directory.
by do-not-reply＠jboss.org
Author: aakanksha_writer
Date: 2013-02-11 09:56:57 -0500 (Mon, 11 Feb 2013)
New Revision: 9138
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
epp/docs/branches/6.0/Developer_Guide/en-US/JavaScript_Development/Module_Cookbook.xml
Log:
Reviewed chapter 19
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-02-11 03:10:58 UTC (rev 9137)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-02-11 14:56:57 UTC (rev 9138)
@@ -37,7 +37,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JavaScript_Development/Scripts_In_JBoss_Portal_Platform.xml" encoding="UTF-8"/>
</part>
<part>
- <title>JavaScript Cookbook</title>
+ <title>JavaScript Code Examples</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JavaScript_Development/Module_Cookbook.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JavaScript_Development/Script_Cookbook.xml" encoding="UTF-8"/>
</part>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/JavaScript_Development/Module_Cookbook.xml
===================================================================
(Binary files differ)
11 years, 10 months