[jboss-cvs] jboss-portal-docs/userGuide/en/modules ...
Roy Russo
russo at jboss.com
Fri Jul 14 13:42:12 EDT 2006
User: russo
Date: 06/07/14 13:42:12
Modified: userGuide/en/modules intro.xml
Log:
JBPORTAL-873 - first section of intro complete.
Revision Changes Path
1.2 +261 -16 jboss-portal-docs/userGuide/en/modules/intro.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: intro.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- intro.xml 14 Jul 2006 14:32:13 -0000 1.1
+++ intro.xml 14 Jul 2006 17:42:12 -0000 1.2
@@ -10,32 +10,277 @@
<title>JBoss Portal Basics</title>
<sect1>
<title>Portal Concepts - Illustrated</title>
+ <para>This section will introduce the reader to some basic portal concepts and terms, used within JBoss Portal and
+ this document.</para>
<sect2>
+ <title>Portal Instances</title>
+ <para>JBoss Portal supports mutliple portal instances running within one container. A portal instance can be
+ viewed as a 'bucket', containing portal objects such as, Portal Pages, Themes, Layouts, and Portlet Windows.
+ It also manages the
+ relationship between the user and the portal itself. The hierarchy of portal objects is depicted as follows:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/management/tree.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
+ A portal instance is
+ reachable by the url format
+ <emphasis>http://[domain]/[context]/portal/[portal_name]</emphasis>
+ . In a default/local install, the
+ <emphasis>default</emphasis>
+ portal instance can be reach by
+ <ulink url="http://localhost:8080/portal/portal/default">http://localhost:8080/portal/portal/default</ulink>
+ .
+ </para>
+ <note>Consult your portal administrator for information on the available portal instances - some of which may
+ have restricted logins, not found in others.</note>
+ </sect2>
+ <sect2 id="intro_portal_pages">
<title>Portal Pages</title>
+ <para>A Portal Page is an aggregator of Portlet Windows. It is generated by the portal, during the reponse
+ phase. During this phase, the portal aggregates all of the HTML markup created the individual portlets,
+ decorates them with window controls, and presents them to the user as a consolidated page.</para>
+ <para>
+ A portal page is reachable by the url format
+ <emphasis>http://[domain]/[context]/portal/[portal_name]/[page_name]</emphasis>
+ . In a default/local install, the
+ <emphasis>default</emphasis>
+ page can be reach by
+ <ulink url="http://localhost:8080/portal/portal/default">
+ http://localhost:8080/portal/portal/default/default</ulink>
+ . Likewise, the News Page in a default install can be reached by
+ <ulink url="http://localhost:8080/portal/portal/default/News">
+ http://localhost:8080/portal/portal/default/News</ulink>
+ .
+ </para>
+ <para>More, on navigating the portal pages and what they contain can be found in,
+ <xref linkend="contents_pages"/>
+ </para>
</sect2>
<sect2>
<title>Portlet Windows</title>
- </sect2>
- <sect2>
- <title>Portal Instances</title>
+ <para>Portlet Windows are found on Portal Pages and contain the HTML markup for a specific portlet instance.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/window.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The diagram above, shows the default JBoss Portal page with certain window-related items highlited (in red).
+ Lets look at these items:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Window Title</emphasis>
+ Defines the content and purpose of the individual portlet window.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Window Fragment</emphasis>
+ The generated HTML markup produced by the portlet on the server-side.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Window Controls</emphasis>
+ Window controls are divided in to two categories:
+ <emphasis role="bold">Window State</emphasis>
+ and
+ <emphasis role="bold">Portlet Mode</emphasis>
+ .
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Window State:</emphasis>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <imageobject>
+ <imagedata fileref="images/intro/normal.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(Normal)</emphasis>
+ - Normal window state, is what you see in the illustration above. All portlet
+ windows take up a similar amount of space on the page.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <imageobject>
+ <imagedata fileref="images/intro/minimize.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(Minimized)</emphasis>
+ - The portlet window renders, minimal-to-no markup.
+ </para>
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata fileref="images/intro/maximize.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(Maximized)</emphasis>
+ - The portlet window takes up a maximum amount of real estate on the page.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Portlet Mode:</emphasis>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <imageobject>
+ <imagedata fileref="images/intro/view.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(View)</emphasis>
+ - In View mode, the portlet renders markup reflecting the current window state of
+ the portlet. The diagram above has all portlet windows in View mode.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <imageobject>
+ <imagedata fileref="images/intro/edit.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(Edit)</emphasis>
+ - Allows a user to customize the portlet's behaviour.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <imageobject>
+ <imagedata fileref="images/intro/help.gif" format="gif"/>
+ </imageobject>
+ <emphasis role="bold">(Help)</emphasis>
+ - A portlet should provide help information to the user.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
</sect2>
</sect1>
<sect1>
<title>The Portal Contents</title>
- <sect2>
+ <sect2 id="contents_pages">
<title>Navigating the Portal Pages</title>
- </sect2>
- <sect2>
+ <para>Navigating the portal pages is normally performed either by typing in a specific URL (
+ <xref linkend="intro_portal_pages"/>
+ ), or using the Navigation Tabs at the top of the page.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/tabs.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Each page, in the default installation of JBoss Portal is explained here, along with the portlets found
+ within them.
+ </para>
+ <sect3>
<title>Default Page</title>
- </sect2>
- <sect2>
+ <para>The default page contains the following portlets:
+ <itemizedlist>
+ <listitem>
+ <xref linkend="intro_greetings_portlet"/>
+ </listitem>
+ <listitem>
+ <xref linkend="intro_user_portlet"/>
+ </listitem>
+ <listitem>
+ <xref linkend="intro_page_portlet"/>
+ </listitem>
+ <listitem>
+ <xref linkend="intro_cms_portlet"/>
+ </listitem>
+ <listitem>
+ <xref linkend="intro_nav_portlet"/>
+ </listitem>
+ </itemizedlist>
+ <sect4 id="intro_greetings_portlet">
+ <title>Greetings Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/greetings_portlet.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Displays hard-coded links to downloading JBoss Portal, downloading
+ portlets from PortletSwap.com, and the live online JBoss Portal demo. It also contains default
+ information on using the UserPortlet to login.
+ </para>
+ </sect4>
+ <sect4 id="intro_user_portlet">
+ <title>User Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/user_portlet.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Allows you to login using the credentials (by clicking the
+ <emphasis>Standard Login</emphasis>
+ link):
+ <programlisting>
+ Username: user
+ Password: user
+ </programlisting>
+ or
+ <programlisting>
+ Username: admin
+ Password: admin
+ </programlisting>
+ </para>
+ </sect4>
+ <sect4 id="intro_page_portlet">
+ <title>Page Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/page_portlet.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect4>
+ <sect4 id="intro_cms_portlet">
+ <title>CMS Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/cms_portlet.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect4>
+ <sect4 id="intro_nav_portlet">
+ <title>Navigation Portlet</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/tabs.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect4>
+ </para>
+ </sect3>
+ <sect3>
<title>News Page</title>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3>
<title>Test Page</title>
- </sect2>
- <sect2>
+ </sect3>
+ <sect3>
<title>Admin Page</title>
+ </sect3>
</sect2>
</sect1>
</chapter>
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list