[portal-commits] JBoss Portal SVN: r5766 - docs/trunk/userGuide/en/modules
portal-commits at lists.jboss.org
portal-commits at lists.jboss.org
Tue Dec 5 13:58:55 EST 2006
Author: roy.russo at jboss.com
Date: 2006-12-05 13:58:54 -0500 (Tue, 05 Dec 2006)
New Revision: 5766
Modified:
docs/trunk/userGuide/en/modules/admincmsPortlet.xml
Log:
JBPORTAL-1113 - cmsadmin chapter redone.
Modified: docs/trunk/userGuide/en/modules/admincmsPortlet.xml
===================================================================
--- docs/trunk/userGuide/en/modules/admincmsPortlet.xml 2006-12-05 18:54:26 UTC (rev 5765)
+++ docs/trunk/userGuide/en/modules/admincmsPortlet.xml 2006-12-05 18:58:54 UTC (rev 5766)
@@ -12,112 +12,26 @@
<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 <xref linkend="adminportal"/> and then the CMS Page tab.</para>
+ navigating to the
+ <xref linkend="adminportal"/>
+ and then the CMS Page tab.
+ </para>
<para>You should then be presented with a page that is similar to this:</para>
<mediaobject>
<imageobject>
<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
- dealing with. All possible actions are listed here:</para>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/edit.gif" format="gif"/>
- </imageobject>
- - Launches HTML WYSIWYG Editor window for HTML files. Launches upload dialog
- windoe for binary type files.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/copy.gif" format="gif"/>
- </imageobject>
- - Opens the copy file/folder dialog window.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/move.gif" format="gif"/>
- </imageobject>
- - Opens the move file/folder dialog window.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/createfile.gif" format="gif"/>
- </imageobject>
- - Launches HTML WYSIWYG Editor window.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/createfolder.gif" format="gif"/>
- </imageobject>
- - Opens the create folder dialog window.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/upload.gif" format="gif"/>
- </imageobject>
- - Opens the upload file dialog window.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/upload_archive.gif" format="gif"/>
- </imageobject>
- - Opens the upload archive dialog window.
- </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.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/view.gif" format="gif"/>
- </imageobject>
- - In the case of files, opens the file properties view. In the case of
- folders, opens the folder listing.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/upfolder.gif" format="gif"/>
- </imageobject>
- - Moves up the folder tree when clicked on.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/plus.gif" format="gif"/>
- </imageobject>
- - Expands directory tree.
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <para>Additionally, there are icons that help describe the types of resources present on the
- page:</para>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/file.gif" format="gif"/>
- </imageobject>
- - Denotes this resource as a file.
- </listitem>
- <listitem>
- <imageobject>
- <imagedata fileref="images/admincms/folder.gif" format="gif"/>
- </imageobject>
- - Denotes this resource as a folder.
- </listitem>
- </itemizedlist>
</sect1>
<sect1>
<title>Actions</title>
- <para>This section describes common actions an administrator can perform from within the AdminCMS Portlet:
+ <para>This section describes common actions an administrator can perform from within the AdminCMS Portlet. All
+ actions are available using the flyout menu.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/admincms/actions_menu.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
<itemizedlist>
<listitem>
<para>
@@ -174,6 +88,11 @@
<xref linkend="edittext"/>
</para>
</listitem>
+ <listitem>
+ <para>
+ <xref linkend="secure"/>
+ </para>
+ </listitem>
</itemizedlist>
</para>
<sect2 id="viewdir">
@@ -181,15 +100,11 @@
<para>
<mediaobject>
<imageobject>
- <imagedata fileref="images/admincms/ss_viewdir.gif" format="gif" align="center" valign="middle"/>
+ <imagedata fileref="images/admincms/ss_viewfile.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>
- icon, or clicking on the directory's "DisplayName". All actions are possible
- from this screen.
+ A user can list directory contents by either clicking on the folder name or selecting "view" from the Action
+ dropdown and clicking "go".
</para>
</sect2>
<sect2 id="viewfileprops">
@@ -200,11 +115,7 @@
<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.
+ Clicking on the "Name" of a file brings up the File Properties page.
</para>
<mediaobject>
<imageobject>
@@ -212,7 +123,8 @@
</imageobject>
</mediaobject>
<para>The File Properties window displays all the possible actions available to perform on a
- file.</para>
+ file.
+ </para>
<para>Version and Locale Information are also contained on this screen. Note that any version
labeled with the
<imageobject>
@@ -223,11 +135,7 @@
</sect2>
<sect2 id="copy">
<title>Copying Files/Directories</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/copy.gif" format="gif"/>
- </imageobject>
- icon displays the copy file/directory dialog window.
+ <para>Clicking on the "Copy" action, displays the copy file/directory dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/resourcecopy.gif" format="gif" align="center" valign="middle"/>
@@ -244,11 +152,7 @@
</sect2>
<sect2 id="move">
<title>Moving Files/Directories</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/move.gif" format="gif"/>
- </imageobject>
- icon displays the move file/directory dialog window.
+ <para>Clicking on the "Move" action, displays the move file/directory dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/resourcemove.gif" format="gif" align="center" valign="middle"/>
@@ -265,43 +169,35 @@
</sect2>
<sect2 id="delete">
<title>Deleting Files/Directories</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/delete.gif" format="gif"/>
- </imageobject>
- icon displays the delete file/directory confirmation window.
+ <para>Clicking on the "Delete" action, displays the delete file/directory confirmation window.
</para>
<imageobject>
<imagedata fileref="images/admincms/resourcedelete.gif" format="gif" align="center" valign="middle"/>
</imageobject>
<para>The delete resource confirmation window allows a user to delete a file, or a directory
on the system. Note that deleting a directory, will delete the entire tree, so all
- directories under the deleted one, will also be deleted.</para>
+ directories under the deleted one, will also be deleted.
+ </para>
<warning>Currently, there is no way to retrieve deleted files/directories! Deleting a file or
- directory is permanent!</warning>
+ directory is permanent!
+ </warning>
</sect2>
<sect2 id="createdir">
<title>Creating Directories</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/createfolder.gif" format="gif"/>
- </imageobject>
- icon displays the create directory dialog window.
+ <para>Clicking on the "Create Folder" action, displays the create directory dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/createdirectory.gif" format="gif" align="center" valign="middle"/>
</imageobject>
<para>The create directory resource window allows a user to create a directory under chosen
path. On this window, a user can specify a name for the new empty directory and assign it a
- description.</para>
+ description.
+ </para>
</sect2>
<sect2 id="createtext">
<title>Creating Text/HTML Files</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/createfile.gif" format="gif"/>
- </imageobject>
- icon displays the create file dialog window with the embedded WYSIWYG editor
+ <para>Clicking on the "Create File" action, displays the create file dialog window with the embedded WYSIWYG
+ editor
and directory browser.
</para>
<imageobject>
@@ -329,17 +225,15 @@
<note>It is important to note here that when creating links to images or other resources
within the system, as user must use the relative file path to that resource. ie:
images/hello.gif. Keep in mind at all times that the document base is
- http://localhost/portal/ by default!</note>
+ http://localhost/portal/ by default!
+ </note>
<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>
+ title bar, and a language for the file, used in serving localized content.
+ </para>
</sect2>
<sect2 id="uploadfile">
<title>Uploading Files</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/upload.gif" format="gif"/>
- </imageobject>
- icon displays the upload file dialog window.
+ <para>Clicking on the "Upload File" action, displays the upload file dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/resourceupload.gif" format="gif" align="center" valign="middle"/>
@@ -359,11 +253,7 @@
</sect2>
<sect2 id="uploadarchive">
<title>Uploading Archives</title>
- <para>Clicking on the
- <imageobject>
- <imagedata fileref="images/admincms/upload_archive.gif" format="gif"/>
- </imageobject>
- icon displays the upload archive dialog window.
+ <para>Clicking on the "Upload Archive" action, displays the upload archive dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/resourceuploadarchive.gif" format="gif" align="center" valign="middle"/>
@@ -382,11 +272,7 @@
</sect2>
<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>Clicking on the "Export Folder" action, displays the export archive dialog window.
</para>
<imageobject>
<imagedata fileref="images/admincms/ss_exportarchive.gif" format="gif" align="center" valign="middle"/>
@@ -412,11 +298,7 @@
<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
+ Clicking on the "text/html"link, displays the edit file dialog window with the embedded WYSIWYG editor
and directory browser.
</para>
<imageobject>
@@ -436,7 +318,12 @@
</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
- as the portlet window title.</para>
+ as the portlet window title.
+ </para>
</sect2>
+ <sect2 id="secure">
+ <title>Securing Resources</title>
+ <para>TODO</para>
+ </sect2>
</sect1>
- </chapter>
+</chapter>
More information about the portal-commits
mailing list