[gatein-commits] gatein SVN: r8078 - epp/docs/branches/5.2/Admin_Guide/en-US.

Author: smumford Date: 2011-11-15 21:48:49 -0500 (Tue, 15 Nov 2011) New Revision: 8078 Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml epp/docs/branches/5.2/Admin_Guide/en-US/chapter-2-REST.xml epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml Log: Fixed errors encountered in Confluence export Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml 2011-11-15 23:23:49 UTC (rev 8077) +++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml 2011-11-16 02:48:49 UTC (rev 8078) @@ -154,7 +154,7 @@ </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. </para> Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-2-REST.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-2-REST.xml 2011-11-15 23:23:49 UTC (rev 8077) +++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-2-REST.xml 2011-11-16 02:48:49 UTC (rev 8078) @@ -10,7 +10,7 @@ <para>To gain access to management resources and operations over REST a RESTful client must know the entry point URL, which is defined as follows:</para> <example> <title>URL Syntax</title> - <programlisting>http(s)://&amp;lt;host&amp;gt;:&amp;lt;port&amp;gt;/&amp;lt;rest-context-name&amp;gt;/private/managed-components</programlisting> + <programlisting>http(s)://&lt;host&gt;:&lt;port&gt;/&lt;rest-context-name&gt;/private/managed-components</programlisting> </example> <para>Where the rest-context-name is the portal container's rest context name. So for the default portal, the rest context name is 'rest', and for a portal running on localhost and port 8080 the URL would be</para> <example> @@ -28,7 +28,7 @@ <para>REST resource URLs are mapped to management addresses, and since every managed resource has a unique management address, every managed resource can be represented by a unique REST URL. The URL for identifying managed resources is as follows:</para> <example> <title>URL Syntax</title> - <programlisting>http://&amp;lt;host&amp;gt;:&amp;lt;port&amp;gt;/&amp;lt;rest-context-name&amp;gt;/private/managed-components/&amp;lt;component-name&amp;gt;/&amp;lt;managed-resource-name&amp;gt;/&amp;lt;sub-resource-name&amp;gt;/.../&amp;lt;sub-resource-name&amp;gt;</programlisting> + <programlisting>http://&lt;host&gt;:&lt;port&gt;/&lt;rest-context-name&gt;/private/managed-components/&lt;component-name&gt;/&lt;managed-resource-name&gt;/&lt;sub-resource-name&gt;/.../&lt;sub-resource-name&gt;</programlisting> </example> <para>The URL below uniquely identifies a managed resource named 'foo-bar', which is a sub-resource of 'bar', and 'bar' being a managed resource of the managed component 'foo'.</para> <example> @@ -260,7 +260,7 @@ <para>Management attributes (which are part of a management request) are mapped by including all request parameters of the HTTP request as attributes. So if an operation supports certain attributes, query parameters can be added to the request URL to be used as attributes of the management request.</para> <example> <title>Attributes first-name and last-name as request parameters</title> - <programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?first-name=john&amp;amp;last-name=doe</programlisting> + <programlisting><![CDATA[http://localhost:8080/rest/private/managed-components/foo/bar?first-name=john&last-name=doe]]></programlisting> </example> <section id="sid-8094332_GateInManagement-MultivalueAttributes"> @@ -268,7 +268,7 @@ <para>Management attributes can be multi-valued (meaning more then one value associated with an attribute). This is easy as HTTP query parameters can be multi-valued as well.</para> <example> <title>Multi-valued attribute colors as request parameters</title> - <programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?colors=red&amp;amp;colors=green&amp;amp;colors=blue</programlisting> + <programlisting><![CDATA[http://localhost:8080/rest/private/managed-components/foo/bar?colors=red&colors=green&colors=blue]]></programlisting> </example> </section> </section> @@ -428,7 +428,7 @@ </section> <section id="sid-8094332_GateInManagement-readresource"> - <title>resource</title> + <title>read-resource</title> <para> Since the <code>read-resource</code> @@ -478,24 +478,24 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&amp;gt; -&amp;lt;resource&amp;gt; - &amp;lt;description&amp;gt;Available operations and children (sub-resources).&amp;lt;/description&amp;gt; - &amp;lt;children&amp;gt; - &amp;lt;child&amp;gt; - &amp;lt;name&amp;gt;foo&amp;lt;/name&amp;gt; - &amp;lt;description&amp;gt;Some description&amp;lt;/description&amp;gt; - &amp;lt;link href="http://localhost:8080/rest/private/managed-components/foo" rel="child"/&amp;gt; - &amp;lt;/child&amp;gt; - &amp;lt;/children&amp;gt; - &amp;lt;operations&amp;gt; - &amp;lt;operation&amp;gt; - &amp;lt;operation-name&amp;gt;read-resource&amp;lt;/operation-name&amp;gt; - &amp;lt;operation-description&amp;gt;Lists information about a managed resource, including available operations and children (sub-resources).&amp;lt;/operation-description&amp;gt; - &amp;lt;link href="http://localhost:8080/rest/private/managed-components" rel="self" type="application/xml" method="get"/&amp;gt; - &amp;lt;/operation&amp;gt; - &amp;lt;/operations&amp;gt; -&amp;lt;/resource&amp;gt;</programlisting> +&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt; +&lt;resource&gt; + &lt;description&gt;Available operations and children (sub-resources).&lt;/description&gt; + &lt;children&gt; + &lt;child&gt; + &lt;name&gt;foo&lt;/name&gt; + &lt;description&gt;Some description&lt;/description&gt; + &lt;link href="http://localhost:8080/rest/private/managed-components/foo" rel="child"/&gt; + &lt;/child&gt; + &lt;/children&gt; + &lt;operations&gt; + &lt;operation&gt; + &lt;operation-name&gt;read-resource&lt;/operation-name&gt; + &lt;operation-description&gt;Lists information about a managed resource, including available operations and children (sub-resources).&lt;/operation-description&gt; + &lt;link href="http://localhost:8080/rest/private/managed-components" rel="self" type="application/xml" method="get"/&gt; + &lt;/operation&gt; + &lt;/operations&gt; +&lt;/resource&gt;</programlisting> </example> </section> </section> Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml =================================================================== --- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2011-11-15 23:23:49 UTC (rev 8077) +++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2011-11-16 02:48:49 UTC (rev 8078) @@ -35,7 +35,7 @@ <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 &amp;lt;port&amp;gt; &amp;lt;user&amp;gt;@&amp;lt;host&amp;gt;</programlisting> + <programlisting>ssh -p &lt;port&gt; &lt;user&gt;@&lt;host&gt;</programlisting> </example> <example> <title>SSH Example</title> @@ -144,8 +144,8 @@ <example> <title>Executing operation read-config-as-xml on managed component foo</title> <programlisting>[ /]% mgmt exec --operation read-config-as-xml --contentType xml /foo -&amp;lt;?xml version='1.0' encoding='UTF-8'?&amp;gt; -&amp;lt;data&amp;gt;...&amp;lt;/data&amp;gt; +&lt;?xml version='1.0' encoding='UTF-8'?&gt; +&lt;data&gt;...&lt;/data&gt; [ /]%</programlisting> </example> @@ -171,8 +171,8 @@    path [ /]% cat /foo -&amp;lt;?xml version='1.0' encoding='UTF-8'?&amp;gt; -&amp;lt;data&amp;gt;...&amp;lt;/data&amp;gt; +&lt;?xml version='1.0' encoding='UTF-8'?&gt; +&lt;data&gt;...&lt;/data&gt; [ /]%</programlisting> </example> 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 2011-11-15 23:23:49 UTC (rev 8077) +++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2011-11-16 02:48:49 UTC (rev 8078) @@ -19,7 +19,7 @@ <title>Operations</title> <section id="sid-8094332_GateInManagement-readconfigasxml"> - <title>config-as-xml</title> + <title>read-config-as-xml</title> <para> The <code>read-config-as-xml</code> @@ -251,7 +251,7 @@ </example> <section id="sid-8094332_GateInManagement-readconfigasxmlx"> - <title>config-as-xml</title> + <title>read-config-as-xml</title> <para>Example of reading the site layout as xml for site classic.</para> <example> <title>HTTP Request</title> @@ -266,13 +266,13 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;portal-config&amp;gt; - &amp;lt;portal-name&amp;gt;classic&amp;lt;/portal-name&amp;gt; - &amp;lt;label&amp;gt;Classic&amp;lt;/label&amp;gt; - &amp;lt;description&amp;gt;GateIn default portal&amp;lt;/description&amp;gt; - &amp;lt;locale&amp;gt;en&amp;lt;/locale&amp;gt; +&lt;portal-config&gt; + &lt;portal-name&gt;classic&lt;/portal-name&gt; + &lt;label&gt;Classic&lt;/label&gt; + &lt;description&gt;GateIn default portal&lt;/description&gt; + &lt;locale&gt;en&lt;/locale&gt; ... -&amp;lt;/portal-config&amp;gt;</programlisting> +&lt;/portal-config&gt;</programlisting> </example> </section> <section id="sid-8094332_GateInManagement-exportresourcex"> @@ -321,16 +321,16 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;page-set&amp;gt; - &amp;lt;page&amp;gt; - &amp;lt;name&amp;gt;homepage&amp;lt;/name&amp;gt; - &amp;lt;title&amp;gt;Home Page&amp;lt;/title&amp;gt; - &amp;lt;access-permissions&amp;gt;Everyone&amp;lt;/access-permissions&amp;gt; - &amp;lt;edit-permission&amp;gt;*:/platform/administrators&amp;lt;/edit-permission&amp;gt; - &amp;lt;show-max-window&amp;gt;false&amp;lt;/show-max-window&amp;gt; - &amp;lt;portlet-application&amp;gt; +&lt;page-set&gt; + &lt;page&gt; + &lt;name&gt;homepage&lt;/name&gt; + &lt;title&gt;Home Page&lt;/title&gt; + &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; + &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; + &lt;show-max-window&gt;false&lt;/show-max-window&gt; + &lt;portlet-application&gt; ... -&amp;lt;/page-set&amp;gt;</programlisting> +&lt;/page-set&gt;</programlisting> </example> <para>Example of reading the homepage as xml for site classic.</para> <example> @@ -346,16 +346,16 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;page-set&amp;gt; - &amp;lt;page&amp;gt; - &amp;lt;name&amp;gt;homepage&amp;lt;/name&amp;gt; - &amp;lt;title&amp;gt;Home Page&amp;lt;/title&amp;gt; - &amp;lt;access-permissions&amp;gt;Everyone&amp;lt;/access-permissions&amp;gt; - &amp;lt;edit-permission&amp;gt;*:/platform/administrators&amp;lt;/edit-permission&amp;gt; - &amp;lt;show-max-window&amp;gt;false&amp;lt;/show-max-window&amp;gt; - &amp;lt;portlet-application&amp;gt; +&lt;page-set&gt; + &lt;page&gt; + &lt;name&gt;homepage&lt;/name&gt; + &lt;title&gt;Home Page&lt;/title&gt; + &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; + &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; + &lt;show-max-window&gt;false&lt;/show-max-window&gt; + &lt;portlet-application&gt; ... -&amp;lt;/page-set&amp;gt;</programlisting> +&lt;/page-set&gt;</programlisting> </example> </section> <section id="sid-8094332_GateInManagement-exportresourcexx"> @@ -385,11 +385,12 @@ <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> <example> <title>URL</title> - <programlisting>URL: /mop/{site-type}sites/{site-name}/navigation/{nav-uri}</programlisting> + <programlisting><![CDATA[ + URL: /mop/{site-type}sites/{site-name}/navigation/{nav-uri}]]></programlisting> </example> <section id="sid-8094332_GateInManagement-readconfigasxmlxxx"> - <title>config-as-xml</title> + <title>read-config-as-xml</title> <para>Example of reading all navigation as xml for site classic.</para> <example> <title>HTTP Request</title> @@ -404,20 +405,20 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;node-navigation&amp;gt; - &amp;lt;priority&amp;gt;1&amp;lt;/priority&amp;gt; - &amp;lt;page-nodes&amp;gt; - &amp;lt;node&amp;gt; - &amp;lt;name&amp;gt;home&amp;lt;/name&amp;gt; - &amp;lt;label xml:lang="en"&amp;gt;Home&amp;lt;/label&amp;gt; +&lt;node-navigation&gt; + &lt;priority&gt;1&lt;/priority&gt; + &lt;page-nodes&gt; + &lt;node&gt; + &lt;name&gt;home&lt;/name&gt; + &lt;label xml:lang="en"&gt;Home&lt;/label&gt; ... - &amp;lt;visibility&amp;gt;DISPLAYED&amp;lt;/visibility&amp;gt; - &amp;lt;page-reference&amp;gt;portal::classic::homepage&amp;lt;/page-reference&amp;gt; - &amp;lt;/node&amp;gt; - &amp;lt;node&amp;gt; - &amp;lt;name&amp;gt;sitemap&amp;lt;/name&amp;gt; + &lt;visibility&gt;DISPLAYED&lt;/visibility&gt; + &lt;page-reference&gt;portal::classic::homepage&lt;/page-reference&gt; + &lt;/node&gt; + &lt;node&gt; + &lt;name&gt;sitemap&lt;/name&gt; ... -&amp;lt;/node-navigation&amp;gt;</programlisting> +&lt;/node-navigation&gt;</programlisting> </example> <para>Example of reading the home node as xml for site classic.</para> <example> @@ -433,19 +434,19 @@ <programlisting>HTTP/1.1 200 OK Content-Type: application/xml -&amp;lt;node-navigation&amp;gt; - &amp;lt;priority&amp;gt;1&amp;lt;/priority&amp;gt; - &amp;lt;page-nodes&amp;gt; - &amp;lt;parent-uri&amp;gt;&amp;lt;/parent-uri&amp;gt; - &amp;lt;node&amp;gt; - &amp;lt;name&amp;gt;home&amp;lt;/name&amp;gt; - &amp;lt;label xml:lang="en"&amp;gt;Home&amp;lt;/label&amp;gt; +&lt;node-navigation&gt; + &lt;priority&gt;1&lt;/priority&gt; + &lt;page-nodes&gt; + &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; ... - &amp;lt;visibility&amp;gt;DISPLAYED&amp;lt;/visibility&amp;gt; - &amp;lt;page-reference&amp;gt;portal::classic::homepage&amp;lt;/page-reference&amp;gt; - &amp;lt;/node&amp;gt; - &amp;lt;/page-nodes&amp;gt; -&amp;lt;/node-navigation&amp;gt;</programlisting> + &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-exportresource_Example">