[jboss-cvs] jboss-portal-docs/userGuide/en/modules ...
Roy Russo
russo at jboss.com
Mon Jul 17 10:29:10 EDT 2006
User: russo
Date: 06/07/17 10:29:10
Modified: userGuide/en/modules admincmsPortlet.xml intro.xml
Log:
JBPORTAL-873 - finished cms
Revision Changes Path
1.14 +137 -27 jboss-portal-docs/userGuide/en/modules/admincmsPortlet.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: admincmsPortlet.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/userGuide/en/modules/admincmsPortlet.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- admincmsPortlet.xml 14 Jul 2006 21:15:28 -0000 1.13
+++ admincmsPortlet.xml 17 Jul 2006 14:29:10 -0000 1.14
@@ -4,7 +4,7 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy @ jboss dot org</email>
+ <email>roy at jboss.org</email>
</author>
</chapterinfo>
<title>Administration - Content Management System</title>
@@ -12,11 +12,13 @@
<title>Introduction</title>
<para>The CMSAdmin Portlet allows control over the content management system.</para>
<para>Viewing the CMSAdmin Portlet is accomplished by logging in as an admin (admin/admin) and
- navigating to the CMSManager page.</para>
- <para>You should then be presented with a portlet that is similar to this:</para>
+ navigating to the Admin page.</para>
+ <para>You should then be presented with a page that is similar to this:</para>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/admincms/directoryview.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/admincms/cms_adminpage.gif" format="gif" align="center" valign="middle"/>
</imageobject>
+ </mediaobject>
<itemizedlist>
<para>It is important for a user to note the action icons used throughout the portlet and
their meanings. The action options change depending on what type of resource the user is
@@ -66,6 +68,12 @@
</listitem>
<listitem>
<imageobject>
+ <imagedata fileref="images/admincms/export_archive.gif" format="gif"/>
+ </imageobject>
+ - Opens the export archive dialog window.
+ </listitem>
+ <listitem>
+ <imageobject>
<imagedata fileref="images/admincms/delete.gif" format="gif"/>
</imageobject>
- Opens the delete confirmation dialog window.
@@ -108,11 +116,75 @@
</itemizedlist>
</sect1>
<sect1>
- <title>Features</title>
- <para>This section describes common actions a user can perform from within the AdminCMS Portlet.</para>
- <sect2>
+ <title>Actions</title>
+ <para>This section describes common actions an administrator can perform from within the AdminCMS Portlet:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="viewdir"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="viewfileprops"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="copy"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="move"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="delete"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="createdir"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="createtext"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="uploadfile"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="uploadarchive"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="exportarchive"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="edittext"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <sect2 id="viewdir">
<title>Viewing Directories</title>
- <para>A user can list directory contents by either clicking on the
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/admincms/ss_viewdir.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ A user can list directory contents by either clicking on the
<imageobject>
<imagedata fileref="images/admincms/view.gif" format="gif"/>
</imageobject>
@@ -120,17 +192,25 @@
from this screen.
</para>
</sect2>
- <sect2>
+ <sect2 id="viewfileprops">
<title>Viewing File Properties</title>
- <para>Clicking on the
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/admincms/ss_viewfile.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Clicking on the
<imageobject>
<imagedata fileref="images/admincms/view.gif" format="gif"/>
</imageobject>
icon or the "DisplayName" of a file brings up the File Properties page.
</para>
+ <mediaobject>
<imageobject>
<imagedata fileref="images/admincms/fileproperties.gif" format="gif" align="center" valign="middle"/>
</imageobject>
+ </mediaobject>
<para>The File Properties window displays all the possible actions available to perform on a
file.</para>
<para>Version and Locale Information are also contained on this screen. Note that any version
@@ -141,7 +221,7 @@
is the current "live" version shown to users.
</para>
</sect2>
- <sect2>
+ <sect2 id="copy">
<title>Copying Files/Directories</title>
<para>Clicking on the
<imageobject>
@@ -162,7 +242,7 @@
the tree, sets it as the destination directory for the copied resource.
</para>
</sect2>
- <sect2>
+ <sect2 id="move">
<title>Moving Files/Directories</title>
<para>Clicking on the
<imageobject>
@@ -183,7 +263,7 @@
the tree, sets it as the destination directory for the moved resource.
</para>
</sect2>
- <sect2>
+ <sect2 id="delete">
<title>Deleting Files/Directories</title>
<para>Clicking on the
<imageobject>
@@ -200,7 +280,7 @@
<warning>Currently, there is no way to retrieve deleted files/directories! Deleting a file or
directory is permanent!</warning>
</sect2>
- <sect2>
+ <sect2 id="createdir">
<title>Creating Directories</title>
<para>Clicking on the
<imageobject>
@@ -215,7 +295,7 @@
path. On this window, a user can specify a name for the new empty directory and assign it a
description.</para>
</sect2>
- <sect2>
+ <sect2 id="createtext">
<title>Creating Text/HTML Files</title>
<para>Clicking on the
<imageobject>
@@ -235,7 +315,7 @@
</imageobject>
button and a source view
<imageobject>
- <imagedata fileref="images/admincms/editorsource.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/admincms/editorsource.gif" format="gif"/>
</imageobject>
button.
</para>
@@ -253,7 +333,7 @@
<para>Additionally, a user can set a title for the file that will be used in the portlet
title bar, and a language for the file, used in serving localized content.</para>
</sect2>
- <sect2>
+ <sect2 id="uploadfile">
<title>Uploading Files</title>
<para>Clicking on the
<imageobject>
@@ -277,7 +357,7 @@
for the file, used in serving localized content.
</para>
</sect2>
- <sect2>
+ <sect2 id="uploadarchive">
<title>Uploading Archives</title>
<para>Clicking on the
<imageobject>
@@ -300,10 +380,40 @@
user can set a language for the archive files, used in serving localized content.
</para>
</sect2>
- <sect2>
- <title>Editing Text/HTML Files</title>
+ <sect2 id="exportarchive">
+ <title>Exporting Archives</title>
<para>Clicking on the
<imageobject>
+ <imagedata fileref="images/admincms/export_archive.gif" format="gif"/>
+ </imageobject>
+ icon displays the export archive dialog window.
+ </para>
+ <imageobject>
+ <imagedata fileref="images/admincms/ss_exportarchive.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ <para>The export archive window allows a user to export entire directory structures as zip files. The system
+ will aggregate all contents of a specific directory, and present to the user to download it.
+ A user can select which source directory to export the resources from,
+ by using the directory browser. Clicking the
+ <imageobject>
+ <imagedata fileref="images/admincms/plus.gif" format="gif"/>
+ </imageobject>
+ icon expands the directory tree. Clicking on the name of the directory within
+ the tree, sets it as the source directory for the export resource. Additionally, a
+ user can set a language for the files to be exported.
+ </para>
+ <note>Version information is not exported. Only versions labeled "Live" are exported!</note>
+ </sect2>
+ <sect2 id="edittext">
+ <title>Editing Text/HTML Files</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/admincms/ss_editfile.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ Clicking on the
+ <imageobject>
<imagedata fileref="images/admincms/edit.gif" format="gif"/>
</imageobject>
icon displays the edit file dialog window with the embedded WYSIWYG editor
@@ -326,7 +436,7 @@
</para>
<para>A user may specify at this point if he would like to make the new edit "live", or
available in production. Additionally, a user can set a title for the file that will be used
- in the portlet title bar.</para>
+ as the portlet window title.</para>
</sect2>
</sect1>
-</chapter>
+ </chapter>
1.4 +20 -0 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.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- intro.xml 14 Jul 2006 21:15:28 -0000 1.3
+++ intro.xml 17 Jul 2006 14:29:10 -0000 1.4
@@ -320,6 +320,26 @@
Renders data from the Content Management System embedded with the Portal. Users are able to
navigate the content, view images, binary files, etc.. via this portlet.
</para>
+ <para>
+ Displaying content is done by the portal using a path mapper. For example, if we wanted to display a zip
+ file, located in
+ <emphasis>/default/foo/bar.zip</emphasis>
+ , we would type in the URL
+ <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>
+ 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.
+ </para>
+ <para>
+ <emphasis role="bold">Serving Logic:</emphasis>
+ The CMS Portlet now serves content based on the user's locale setting. For example: if a user's locale is
+ set to Spanish in his browser, and he requests URL: default/index.html , the CMSPortlet will first try
+ and retrieve the Spanish version of that file. If a Spanish version is not found, it will then try and
+ retrieve the default language version set for the CMSPortlet (set to English, by default).
+ </para>
<note>Administrators should view,
<xref linkend="admincmsPortlet"/>
, for managing the data in the CMS.
More information about the jboss-cvs-commits
mailing list