Author: jaredmorgs Date: 2012-02-23 18:15:23 -0500 (Thu, 23 Feb 2012) New Revision: 8454 Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml epp/docs/branches/5.2/Admin_Guide/publican.cfg Log: Added link back to User Guide for export-resource and import-resource GUI (Export/Import Site) as part of https://bugzilla.redhat.com/show_bug.cgi?id=794408 Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml 2012-02-22 19:27:28 UTC (rev 8453) +++ epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml 2012-02-23 23:15:23 UTC (rev 8454) @@ -1,15 +1,15 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> %BOOK_ENTITIES; ]> <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="chapter-1-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="chapter-2-REST.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="chapter-3-Command_Line_Interface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="chapter-4-Management_Extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-1-Introduction.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-2-REST.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-3-Command_Line_Interface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-4-Management_Extensions.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> - Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml 2012-02-22 19:27:28 UTC (rev 8453) +++ epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml 2012-02-23 23:15:23 UTC (rev 8454) @@ -1,31 +1,27 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> %BOOK_ENTITIES; ]> <bookinfo id="book-Admin_Guide-Admin_Guide"> - <title>Administration Guide</title> - <subtitle>For use with JBoss Enterprise Portal Platform 5</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>5.2</productnumber> - <edition>5.2.0</edition> - <pubsnumber>100</pubsnumber> - <abstract> - <para> + <title>Administration Guide</title> + <subtitle>For use with JBoss Enterprise Portal Platform 5</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>5.2</productnumber> + <edition>5.2.1</edition> + <pubsnumber>1</pubsnumber> + <abstract> + <para> This document is a guide to administering an implementation of JBoss Enterprise Portal Platform. It is intended for System Administrators and assumes a high level of technical knowledge. </para> - - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/title_logo.png" format="PNG" /> - </imageobject> - - </inlinemediaobject> - - </corpauthor> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/title_logo.png" format="PNG"/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/> </bookinfo> - Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml 2012-02-22 19:27:28 UTC (rev 8453) +++ epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml 2012-02-23 23:15:23 UTC (rev 8454) @@ -1,107 +1,110 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> %BOOK_ENTITIES; ]> <appendix id="appe-Admin_Guide-Revision_History"> - <title>Revision History</title> - <simpara> - <revhistory> - <revision> - <revnumber>5.2.0-100</revnumber> - <date>Wed Dec 14 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>Publication build.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-8</revnumber> - <date>Mon Dec 12 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>JBEPP-1450: Changed gatein-management-cli deploy instructions for production docs.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-7</revnumber> - <date>Wed Dec 7 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>Updated with 'xml-escaping during export' problem fix.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-4</revnumber> - <date>Tue Nov 15 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>Staged for beta release.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-3</revnumber> - <date>Wed Oct 19 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email></email> - - </author> - <revdescription> - <simplelist> - <member>Added to brew system.</member> - - </simplelist> - - </revdescription> - - </revision> - <revision> - <revnumber>5.2.0-1</revnumber> - <date>Wed Oct 12 2011</date> - <author> - <firstname>Nick</firstname> - <surname>Scavelli</surname> - <email&gt;nscavell(a)redhat.com&lt;/email&gt; - - </author> - <revdescription> - <simplelist> - <member>Initial creation of book.</member> - - </simplelist> - - </revdescription> - - </revision> - - </revhistory> - - </simpara> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>5.2.1-1</revnumber> + <date>Fri Feb 24 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Added link back to User Guide for export-resource and import-resource GUI (Export/Import Site) as part of https://bugzilla.redhat.com/show_bug.cgi?id=794408.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-100</revnumber> + <date>Wed Dec 14 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Publication build.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-8</revnumber> + <date>Mon Dec 12 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>JBEPP-1450: Changed gatein-management-cli deploy instructions for production docs.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-7</revnumber> + <date>Wed Dec 7 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Updated with &apos;xml-escaping during export&apos; problem fix.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-4</revnumber> + <date>Tue Nov 15 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Staged for beta release.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-3</revnumber> + <date>Wed Oct 19 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Added to brew system.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-1</revnumber> + <date>Wed Oct 12 2011</date> + <author> + <firstname>Nick</firstname> + <surname>Scavelli</surname> + <email&gt;nscavell(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Initial creation of book.</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> - Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-02-22 19:27:28 UTC (rev 8453) +++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-02-23 23:15:23 UTC (rev 8454) @@ -1,151 +1,102 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> <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> - <section id="sid-8094332_GateInManagement-Operationsxx"> - - <title>Operations</title> - <section id="sid-8094332_GateInManagement-readconfigasxml"> - - <title>config-as-xml</title> - <para> + <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 &apos;mop&apos; 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> + <section id="sid-8094332_GateInManagement-Operationsxx"> + <title><remark>BZ#794408 </remark>Operations</title> + <section id="sid-8094332_GateInManagement-readconfigasxml"> + <title>config-as-xml</title> + <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 <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. </para> - </section> - <section id="sid-8094332_GateInManagement-exportresource"> - - <title>export-resource</title> - <para> + </section> + <section id="sid-8094332_GateInManagement-exportresource"> + <title><remark>BZ#794408 </remark>export-resource</title> + <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. </para> - </section> - <section id="sid-8094332_GateInManagement-importresource"> - - <title>import-resource</title> - <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> + <section id="sid-8094332_GateInManagement-importresource"> + <title><remark>BZ#794408 </remark>import-resource</title> + <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 <code>import-resource</code> - operation on a group site, when the zip contains data from a portal site, doesn't make sense. + operation on a group site, when the zip contains data from a portal site, doesn&apos;t make sense. </para> - <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> The MOP <code>import-resource</code> operation defines the <code>importMode</code> attribute as follows during import. </para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry> - <para> - Mode + <variablelist> + <varlistentry> + <term>Conserve</term> + <listitem> + <para> + Import data only if no artifacts exist for that site. For example if one page exists for site &apos;classic&apos;, nothing will be imported. </para> - </entry> - <entry> - <para> - Description - - </para> - </entry> - </row> - </thead> - <tbody> - <row> - <entry> - <para> - conserve - - </para> - </entry> - <entry> - <para> - Import data only if no artifacts exist for that site. For example if one page exists for site 'classic', nothing will be imported. - - </para> - </entry> - </row> - <row> - <entry> - <para> - insert - - </para> - </entry> - <entry> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Insert</term> + <listitem> + <para> Import data when data does not exist, otherwise do nothing. </para> - </entry> - </row> - <row> - <entry> - <para> - merge - - </para> - </entry> - <entry> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Merge (default)</term> + <listitem> + <para> Import when data does not exist, update data when it does exist. </para> - </entry> - </row> - <row> - <entry> - <para> - overwrite - - </para> - </entry> - <entry> - <para> + </listitem> + </varlistentry> + <varlistentry> + <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 all pages for that site are deleted and imported. </para> - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - <note> - <title>Note</title> - <para>'merge' is the default importMode.</para> - </note> - </section> + </listitem> + </varlistentry> + </variablelist> </section> - <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> + </section> + <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: @@ -156,9 +107,9 @@ <code>user</code> . </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <code>site-name</code> The sites to include or exclude. Examples could be @@ -167,9 +118,9 @@ <code>/platform/administrators</code> . </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <code>site-layout</code> The name of the site layout depending on the site type. Available values are: @@ -180,63 +131,60 @@ <code>user</code> . </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <code>page-name</code> The name of the page(s) to include or exclude. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <code>nav-uri</code> The URI of the navigation node to include or exclude. </para> - </listitem> - </itemizedlist> - </section> - <section id="sid-8094332_GateInManagement-RESTAPI"> - - <title>REST API</title> - <note> - <title>Note</title> - <para>All URL's below are relative to the REST management entry point of the portal container.</para> - </note> - <note> - <title>Note</title> - <para> + </listitem> + </itemizedlist> + </section> + <section id="sid-8094332_GateInManagement-RESTAPI"> + <title>REST API</title> + <note> + <title>Note</title> + <para>All URL&apos;s below are relative to the REST management entry point of the portal container.</para> + </note> + <note> + <title>Note</title> + <para> For all read-config-as-xml refer <ulink url="http://www.gatein.org/xml/ns/gatein_objects_1_2"/> for the format of the XML. </para> - </note> - <section id="sid-8094332_GateInManagement-MOPComponentResource"> - - <title>MOP Component Resource</title> - <para> + </note> + <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 <code>import-resource</code> operation. </para> - <example> - <title>HTTP Request</title> - <programlisting>PUT /mop + <example> + <title>HTTP Request</title> + <programlisting>PUT /mop Headers: Content-Type: application/zip</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK</programlisting> - </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 + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK</programlisting> + </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&apos;s the data defined in the <emphasis role="strong">portal.xml</emphasis> , <emphasis role="strong">group.xml</emphasis> @@ -244,25 +192,24 @@ <emphasis role="strong">user.xml</emphasis> files (depending on site type) used in portal extensions to configure data. </para> + <example> + <title>URL</title> + <programlisting>URL: /mop/{site-type}sites/{site-name}/{site-layout}</programlisting> + </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> <example> - <title>URL</title> - <programlisting>URL: /mop/{site-type}sites/{site-name}/{site-layout}</programlisting> - </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> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/portal.xml + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/portal.xml or GET /mop/portalsites/classic/portal?op=read-config-as-xml</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/xml &lt;portal-config&gt; @@ -272,52 +219,49 @@ &lt;locale&gt;en&lt;/locale&gt; ... &lt;/portal-config&gt;</programlisting> - </example> - </section> - <section id="sid-8094332_GateInManagement-exportresourcex"> - - <title>export-resource</title> - <para>Example of exporting the site layout for site classic.</para> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/portal.zip + </example> + </section> + <section id="sid-8094332_GateInManagement-exportresourcex"> + <title>export-resource</title> + <para>Example of exporting the site layout for site classic.</para> + <example> + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/portal.zip or GET /mop/portalsites/classic/portal?op=export-resource</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/zip [binary data]</programlisting> - </example> - </section> + </example> </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> + </section> + <section id="sid-8094332_GateInManagement-PagesResource"> + <title>Pages Resource</title> + <para>The pages resource represents the pages of the portal. It&apos;s the data defined in the pages.xml 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> <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> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/pages.xml + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/pages.xml or GET /mop/portalsites/classic/pages?op=read-config-as-xml</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/xml &lt;page-set&gt; @@ -330,19 +274,19 @@ &lt;portlet-application&gt; ... &lt;/page-set&gt;</programlisting> - </example> - <para>Example of reading the homepage as xml for site classic.</para> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/pages/homepage.xml + </example> + <para>Example of reading the homepage as xml for site classic.</para> + <example> + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/pages/homepage.xml or GET /mop/portalsites/classic/pages/homepage?op=read-config-as-xml</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/xml &lt;page-set&gt; @@ -355,52 +299,49 @@ &lt;portlet-application&gt; ... &lt;/page-set&gt;</programlisting> - </example> - </section> - <section id="sid-8094332_GateInManagement-exportresourcexx"> - - <title>export-resource</title> - <para>Example of exporting all pages of site classic.</para> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/pages.zip + </example> + </section> + <section id="sid-8094332_GateInManagement-exportresourcexx"> + <title>export-resource</title> + <para>Example of exporting all pages of site classic.</para> + <example> + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/pages.zip or GET /mop/portalsites/classic/pages?op=export-resource</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/zip [binary data]</programlisting> - </example> - </section> + </example> </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> + </section> + <section id="sid-8094332_GateInManagement-NavigationResource"> + <title>Navigation Resource</title> + <para>The navigation resource represents the navigation of the portal. It&apos;s the data defined in the navigation.xml 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> <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> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/navigation.xml + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/navigation.xml or GET /mop/portalsites/classic/navigation?op=read-config-as-xml</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/xml &lt;node-navigation&gt; @@ -408,7 +349,7 @@ &lt;page-nodes&gt; &lt;node&gt; &lt;name&gt;home&lt;/name&gt; - &lt;label xml:lang="en"&gt;Home&lt;/label&gt; + &lt;label xml:lang=&quot;en&quot;&gt;Home&lt;/label&gt; ... &lt;visibility&gt;DISPLAYED&lt;/visibility&gt; &lt;page-reference&gt;portal::classic::homepage&lt;/page-reference&gt; @@ -417,19 +358,19 @@ &lt;name&gt;sitemap&lt;/name&gt; ... &lt;/node-navigation&gt;</programlisting> - </example> - <para>Example of reading the home node as xml for site classic.</para> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/navigation/home.xml + </example> + <para>Example of reading the home node as xml for site classic.</para> + <example> + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/navigation/home.xml or GET /mop/portalsites/classic/navigation/home?op=read-config-as-xml</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/xml &lt;node-navigation&gt; @@ -438,84 +379,79 @@ &lt;parent-uri&gt;&lt;/parent-uri&gt; &lt;node&gt; &lt;name&gt;home&lt;/name&gt; - &lt;label xml:lang="en"&gt;Home&lt;/label&gt; + &lt;label xml:lang=&quot;en&quot;&gt;Home&lt;/label&gt; ... &lt;visibility&gt;DISPLAYED&lt;/visibility&gt; &lt;page-reference&gt;portal::classic::homepage&lt;/page-reference&gt; &lt;/node&gt; &lt;/page-nodes&gt; &lt;/node-navigation&gt;</programlisting> - </example> - </section> - <section id="sid-8094332_GateInManagement-exportresourcexxx"> - - <title>export-resource</title> - <para>Example of exporting all navigation of site classic.</para> - <example> - <title>HTTP Request</title> - <programlisting>GET /mop/portalsites/classic/navigation.zip + </example> + </section> + <section id="sid-8094332_GateInManagement-exportresourcexxx"> + <title>export-resource</title> + <para>Example of exporting all navigation of site classic.</para> + <example> + <title>HTTP Request</title> + <programlisting>GET /mop/portalsites/classic/navigation.zip or GET /mop/portalsites/classic/navigation?op=export-resource</programlisting> - </example> - <example> - <title>HTTP Response</title> - <programlisting>HTTP/1.1 200 OK + </example> + <example> + <title>HTTP Response</title> + <programlisting>HTTP/1.1 200 OK Content-Type: application/zip [binary data]</programlisting> - </example> - </section> + </example> </section> - <section id="sid-8094332_GateInManagement-ExportandFiltering"> - - <title>Export and Filtering</title> - <para> + </section> + <section id="sid-8094332_GateInManagement-ExportandFiltering"> + <title>Export and Filtering</title> + <para> Filtering is activated when the <code>filter</code> attribute is passed to an <code>export-resource</code> 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&amp;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> - </example> - <example> - <title>Export all site types but user and group</title> - <programlisting>GET /mop.zip?filter=site-type:!user,group</programlisting> - </example> - </section> + <note> + <title>Note</title> + <para>You can either include multiple filter parameters (?filter=foo:bar&amp;filter=baz:foo-bar) or separate via &apos;;&apos; 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> + </example> + <example> + <title>Export all site types but user and group</title> + <programlisting>GET /mop.zip?filter=site-type:!user,group</programlisting> + </example> </section> - <section id="sid-8094332_GateInManagement-CommandLineInterfacex"> - - <title>Command Line Interface</title> - <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> - <example> - <title>Example</title> - <programlisting>[ /]% cd /mop/portalsites/classic/pages/homepage + </section> + <section id="sid-8094332_GateInManagement-CommandLineInterfacex"> + <title>Command Line Interface</title> + <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&apos;s (of course without the URL syntax). For example the path of the homepage for the classic site would be:</para> + <example> + <title>Example</title> + <programlisting>[ /]% cd /mop/portalsites/classic/pages/homepage [homepage]% pwd /mop/portalsites/classic/pages/homepage</programlisting> - </example> - <note> - <title>Note</title> - <para>All resources/paths can be autocompleted by hitting the tab key.</para> - </note> - </section> - <section id="sid-8094332_GateInManagement-ExportandFilteringx"> - - <title>Export and Filtering</title> - <para> + </example> + <note> + <title>Note</title> + <para>All resources/paths can be autocompleted by hitting the tab key.</para> + </note> + </section> + <section id="sid-8094332_GateInManagement-ExportandFilteringx"> + <title>Export and Filtering</title> + <para> Filtering is activated when the <code>filter</code> attribute is passed to an @@ -526,33 +462,33 @@ <code>export</code> command. </para> - <example> - <title>Export all portal site types</title> - <programlisting>export --file /tmp/mop.zip --filter site-type:portal /mop</programlisting> - </example> - <example> - <title>Export all sites types but user</title> - <programlisting>export --file /tmp/mop.zip --filter site-type:!user /mop</programlisting> - </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> - </example> - <para> + <example> + <title>Export all portal site types</title> + <programlisting>export --file /tmp/mop.zip --filter site-type:portal /mop</programlisting> + </example> + <example> + <title>Export all sites types but user</title> + <programlisting>export --file /tmp/mop.zip --filter site-type:!user /mop</programlisting> + </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> + </example> + <para> Also as discussed in the Path Templates section in this document, 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> - </example> - <important> - <title>Important</title> - <para>All three artifacts (site layout, navigation, and pages) are included in export by default. In other words if you don't specify their path template in the filter, the data will be included.</para> - </important> - </section> + <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> + </example> + <important> + <title>Important</title> + <para>All three artifacts (site layout, navigation, and pages) are included in export by default. In other words if you don&apos;t specify their path template in the filter, the data will be included.</para> + </important> </section> </section> - </chapter> + </section> +</chapter> Modified: epp/docs/branches/5.2/Admin_Guide/publican.cfg =================================================================== --- epp/docs/branches/5.2/Admin_Guide/publican.cfg 2012-02-22 19:27:28 UTC (rev 8453) +++ epp/docs/branches/5.2/Admin_Guide/publican.cfg 2012-02-23 23:15:23 UTC (rev 8454) @@ -1,13 +1,6 @@ -# Config::Simple 4.59 -# Wed Nov 25 09:17:17 2009 - - xml_lang: en-US type: Book brand: JBoss debug:1 -#show_remarks:1 - -cvs_branch: DOCS-RHEL-6 -cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist -cvs_pkg: JBoss_Enterprise_Portal_Platform-Administration_Guide-5.2-web-__LANG__ \ No newline at end of file +show_remarks:1 +git_branch: docs-rhel-6