[jboss-svn-commits] JBoss Portal SVN: r5437 - in docs/trunk/userGuide/en: . images/intro modules
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Fri Oct 13 12:16:22 EDT 2006
Author: roy.russo at jboss.com
Date: 2006-10-13 12:16:06 -0400 (Fri, 13 Oct 2006)
New Revision: 5437
Added:
docs/trunk/userGuide/en/images/intro/ico_16_help.gif
docs/trunk/userGuide/en/images/intro/ico_16_maximize.gif
docs/trunk/userGuide/en/images/intro/ico_16_minimize.gif
docs/trunk/userGuide/en/images/intro/ico_16_normal.gif
docs/trunk/userGuide/en/images/intro/ico_16_remove.gif
docs/trunk/userGuide/en/images/intro/ico_cancel.gif
docs/trunk/userGuide/en/images/intro/ico_edit.gif
docs/trunk/userGuide/en/images/intro/login.jpg
docs/trunk/userGuide/en/images/intro/nav2.gif
docs/trunk/userGuide/en/images/intro/window.jpg
Removed:
docs/trunk/userGuide/en/images/intro/edit.gif
docs/trunk/userGuide/en/images/intro/help.gif
docs/trunk/userGuide/en/images/intro/maximize.gif
docs/trunk/userGuide/en/images/intro/minimize.gif
docs/trunk/userGuide/en/images/intro/normal.gif
docs/trunk/userGuide/en/images/intro/view.gif
docs/trunk/userGuide/en/images/intro/window.gif
Modified:
docs/trunk/userGuide/en/images/intro/cms_portlet.gif
docs/trunk/userGuide/en/images/intro/greetings_portlet.gif
docs/trunk/userGuide/en/images/intro/newspage.gif
docs/trunk/userGuide/en/images/intro/newsportlet.gif
docs/trunk/userGuide/en/images/intro/newsportlet_edit.gif
docs/trunk/userGuide/en/images/intro/tabs.gif
docs/trunk/userGuide/en/images/intro/user_portlet.gif
docs/trunk/userGuide/en/images/intro/user_portlet_create.gif
docs/trunk/userGuide/en/images/intro/user_portlet_editinfo.gif
docs/trunk/userGuide/en/images/intro/user_portlet_loggedin.gif
docs/trunk/userGuide/en/images/intro/weather_config4.gif
docs/trunk/userGuide/en/images/intro/weather_config5.gif
docs/trunk/userGuide/en/images/intro/weatherportlet.gif
docs/trunk/userGuide/en/images/intro/weatherportlet_edit.gif
docs/trunk/userGuide/en/master.xml
docs/trunk/userGuide/en/modules/intro.xml
Log:
JBPORTAL-1080 - Update UserGuide for 2.6DR
Modified: docs/trunk/userGuide/en/images/intro/cms_portlet.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/edit.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/greetings_portlet.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/help.gif
===================================================================
(Binary files differ)
Added: docs/trunk/userGuide/en/images/intro/ico_16_help.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_16_help.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_16_maximize.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_16_maximize.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_16_minimize.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_16_minimize.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_16_normal.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_16_normal.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_16_remove.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_16_remove.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_cancel.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_cancel.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/ico_edit.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/ico_edit.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/login.jpg
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/login.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: docs/trunk/userGuide/en/images/intro/maximize.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/minimize.gif
===================================================================
(Binary files differ)
Added: docs/trunk/userGuide/en/images/intro/nav2.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/nav2.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/trunk/userGuide/en/images/intro/newspage.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/newsportlet.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/newsportlet_edit.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/normal.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/tabs.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/user_portlet.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/user_portlet_create.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/user_portlet_editinfo.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/user_portlet_loggedin.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/view.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/weather_config4.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/weather_config5.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/weatherportlet.gif
===================================================================
(Binary files differ)
Modified: docs/trunk/userGuide/en/images/intro/weatherportlet_edit.gif
===================================================================
(Binary files differ)
Deleted: docs/trunk/userGuide/en/images/intro/window.gif
===================================================================
(Binary files differ)
Added: docs/trunk/userGuide/en/images/intro/window.jpg
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/window.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/trunk/userGuide/en/master.xml
===================================================================
--- docs/trunk/userGuide/en/master.xml 2006-10-13 00:55:33 UTC (rev 5436)
+++ docs/trunk/userGuide/en/master.xml 2006-10-13 16:16:06 UTC (rev 5437)
@@ -13,10 +13,10 @@
]>
<book lang="en">
<bookinfo>
- <title>JBoss Portal 2.4</title>
+ <title>JBoss Portal 2.6DR</title>
<subtitle>User Guide</subtitle>
- <releaseinfo>Release 2.4 "Devil"</releaseinfo>
- <releaseinfo>July 2006</releaseinfo>
+ <releaseinfo>Release 2.6DR "Ninja"</releaseinfo>
+ <releaseinfo>October 2006</releaseinfo>
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
Modified: docs/trunk/userGuide/en/modules/intro.xml
===================================================================
--- docs/trunk/userGuide/en/modules/intro.xml 2006-10-13 00:55:33 UTC (rev 5436)
+++ docs/trunk/userGuide/en/modules/intro.xml 2006-10-13 16:16:06 UTC (rev 5437)
@@ -11,7 +11,8 @@
<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>
+ this document.
+ </para>
<sect2>
<title>Portal Instances</title>
<para>JBoss Portal supports mutliple portal instances running within one container. A portal instance can be
@@ -35,13 +36,15 @@
.
</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>
+ 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>
+ 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>
@@ -49,10 +52,12 @@
<emphasis>default</emphasis>
page can be reach by
<ulink url="http://localhost:8080/portal/portal/default">
- http://localhost:8080/portal/portal/default/default</ulink>
+ 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>
+ http://localhost:8080/portal/portal/default/News
+ </ulink>
.
</para>
<para>More, on navigating the portal pages and what they contain can be found in,
@@ -64,7 +69,7 @@
<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"/>
+ <imagedata fileref="images/intro/window.jpg" format="jpg" align="center" valign="middle"/>
</imageobject>
</mediaobject>
The diagram above, shows the default JBoss Portal page with certain window-related items highlited (in red).
@@ -98,7 +103,7 @@
<listitem>
<para>
<imageobject>
- <imagedata fileref="images/intro/normal.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_16_normal.gif" format="gif"/>
</imageobject>
<emphasis role="bold">(Normal)</emphasis>
- Normal window state, is what you see in the illustration above. All portlet
@@ -108,7 +113,7 @@
<listitem>
<para>
<imageobject>
- <imagedata fileref="images/intro/minimize.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_16_minimize.gif" format="gif"/>
</imageobject>
<emphasis role="bold">(Minimized)</emphasis>
- The portlet window renders, minimal-to-no markup.
@@ -116,7 +121,7 @@
</listitem>
<listitem>
<imageobject>
- <imagedata fileref="images/intro/maximize.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_16_maximize.gif" format="gif"/>
</imageobject>
<emphasis role="bold">(Maximized)</emphasis>
- The portlet window takes up a maximum amount of real estate on the page.
@@ -131,17 +136,19 @@
<listitem>
<para>
<imageobject>
- <imagedata fileref="images/intro/view.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_cancel.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.
+ the portlet. The button is labeled 'Cancel', so the user understand he is leaving
+ "Edit Mode" and reverting back to "View Mode". The diagram above has all portlet
+ windows in View mode.
</para>
</listitem>
<listitem>
<para>
<imageobject>
- <imagedata fileref="images/intro/edit.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_edit.gif" format="gif"/>
</imageobject>
<emphasis role="bold">(Edit)</emphasis>
- Allows a user to customize the portlet's behaviour.
@@ -150,7 +157,7 @@
<listitem>
<para>
<imageobject>
- <imagedata fileref="images/intro/help.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_16_help.gif" format="gif"/>
</imageobject>
<emphasis role="bold">(Help)</emphasis>
- A portlet should provide help information to the user.
@@ -178,11 +185,25 @@
<imagedata fileref="images/intro/tabs.gif" format="gif" align="center" valign="middle"/>
</imageobject>
</mediaobject>
+ </para>
+ <para>Altervatively, once logged in, you are able to navigate to your Dashboard or the Admin Portal by using
+ the navigation elements, located in the top-right of the main portal page.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/nav2.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
Each page, in the default installation of JBoss Portal is explained in the following sections, along with
the portlets found
within them.
</para>
</sect2>
+ <sect2 id="logging_ing">
+ <title>Logging in to the Portal</title>
+ <para></para>
+ </sect2>
<sect2>
<title>Default Page</title>
<para>The default page contains the following portlets:
@@ -194,9 +215,6 @@
<xref linkend="intro_user_portlet"/>
</listitem>
<listitem>
- <xref linkend="intro_page_portlet"/>
- </listitem>
- <listitem>
<xref linkend="intro_cms_portlet"/>
</listitem>
<listitem>
@@ -231,37 +249,20 @@
valign="middle"/>
</imageobject>
</mediaobject>
+ </para>
+ <para>
+ Once successfully logged in, the user will have additional functionality at his disposal, that
+ is covered in the following sections.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/user_portlet_loggedin.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
The User Portlet allows a user to:
<itemizedlist>
<listitem>
<para>
- <emphasis role="bold">Login to the Portal</emphasis>
- </para>
- <para>
- 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>
- Once successfully logged in, the user will have additional functionality at his disposal, that
- is covered in the following sections.
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/user_portlet_loggedin.gif" format="gif" align="center"
- valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis role="bold">Create a new account</emphasis>
</para>
<para>
@@ -295,19 +296,6 @@
</itemizedlist>
</para>
</sect3>
- <sect3 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>
- Allows a user to navigate to different Portal Pages, by clicking on the page names. Similar to the
- Navigation Tabs at the top of the page.
- </para>
- </sect3>
<sect3 id="intro_cms_portlet">
<title>CMS Portlet</title>
<para>
@@ -328,7 +316,8 @@
<emphasis>http://localhost:8080/content/default/foo/bar.zip</emphasis>
.
<emphasis role="bold">Notice how the path to the content, is prefixed with the '/content'
- term.</emphasis>
+ term.
+ </emphasis>
Although in this example we are describing binary content retrieval, the same is to be said for text/html
files. Keep in mind, however, that binary files are displayed outside of the portal pages, but text/html
are displayed inside the CMSPortlet Window.
@@ -485,7 +474,7 @@
Edit
Mode (click
<imageobject>
- <imagedata fileref="images/intro/edit.gif" format="gif"/>
+ <imagedata fileref="images/intro/ico_edit.gif" format="gif"/>
</imageobject>
). Once the form is submitted, this property will be saved
in the user's preference, so he will always see the same news source, when logged in.
More information about the jboss-svn-commits
mailing list