Author: julien(a)jboss.com Date: 2007-04-28 04:33:26 -0400 (Sat, 28 Apr 2007) New Revision: 7122 Added: docs/trunk/referenceGuide/en/modules/portalapi.xml Log: started to add chapter on portal API Added: docs/trunk/referenceGuide/en/modules/portalapi.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/portalapi.xml (rev 0) +++ docs/trunk/referenceGuide/en/modules/portalapi.xml 2007-04-28 08:33:26 UTC (rev 7122) @@ -0,0 +1,39 @@ +<chapter id="portalapi"> + <chapterinfo> + <author> + <firstname>Julien</firstname> + <surname>Viet</surname> + <email&gt;julien(a)jboss.org&lt;/email&gt; + </author> + </chapterinfo> + <title>Portal API</title> + <sect1> + <title>Introduction</title> + <para>JBoss Portal provides an Application Programming Interface (API) which allows to write code + that interacts with the portal. The life time of the API is tied to the major version which means + that no changes should be required when code is written against the API provided by the JBoss Portal + 2.x versions and used in a later version of JBoss Portal 2.x.</para> + </sect1> + <sect1> + <title>Portal session</title> + </sect1> + <sect1> + <title>Portal URL</title> + </sect1> + <sect1> + <title>Portal nodes</title> + <para>The portal structure is a tree formed by nodes. It is possible to access that tree in order to + </para> + <itemizedlist> + <listitem>discover the tree structure of the portal</listitem> + <listitem>create URL that will render the different portal nodes</listitem> + <listitem>access the properties of a specific node</listitem> + </itemizedlist> + <programlisting><![CDATA[ + +]]></programlisting> + </sect1> + <sect1> + <title>Portal events</title> + </sect1> +</chapter>