Author: chris.laprun(a)jboss.com Date: 2007-10-10 18:19:45 -0400 (Wed, 10 Oct 2007) New Revision: 8594 Modified: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/intro.xml docs/trunk/userGuide/en/modules/intro.xml Log: - Fixed typos and grammar errors. Modified: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/intro.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/intro.xml 2007-10-10 22:05:10 UTC (rev 8593) +++ docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/intro.xml 2007-10-10 22:19:45 UTC (rev 8594) @@ -36,7 +36,7 @@ <emphasis>http://[domain]/[context]/portal/[portal_name]</emphasis> . In a default/local install, the <emphasis>default</emphasis> - portal instance can be reach by + portal instance can be reached at <ulink url="http://localhost:8080/portal/portal/default">http://localhost:8080/portal/portal/default</ulink> . </para> @@ -55,11 +55,11 @@ <emphasis>http://[domain]/[context]/portal/[portal_name]/[page_name]</emphasis> . In a default/local install, the <emphasis>default</emphasis> - page can be reach by + page can be reached at <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 + . Likewise, the News Page in a default install can be reached at <ulink url="http://localhost:8080/portal/portal/default/News"> http://localhost:8080/portal/portal/default/News </ulink> @@ -96,11 +96,11 @@ <para> <emphasis role="bold">Window Controls:</emphasis> Window controls are divided into two categories and control different aspects of how the user can - impact the generated markup. Each window control can be click to interact with the window in - specific way. <emphasis role="bold">Window State</emphasis> icons control how much room the window + impact the generated markup. Each window control can be clicked on to interact with the window in + specific ways. <emphasis role="bold">Window State</emphasis> icons control how much room the window will take on the page and how much markup will be shown. <emphasis role="bold">Portlet Mode</emphasis> icons, on the other hand, control the mode in which - the portlet operate, thus impacting the type of generated markup. Note that not all portlets + the portlet operates, thus impacting the type of generated markup. Note that not all portlets support all defined window states and/or portlet modes. <itemizedlist> <listitem> @@ -114,8 +114,8 @@ </imageobject> <emphasis role="bold">(Normal)</emphasis> - Normal window state, is the most common state for portlets (portlets in the - above image are in the normal window state). All portlet - windows occupy a similar amount of space on the page. + above image are in the normal window state). The portlet window will occupy only + enough space to show the portlet content on the page. </para> </listitem> <listitem> @@ -141,7 +141,7 @@ <para> <emphasis role="bold">Portlet Modes and their meaning:</emphasis> Portlet modes are not always available (it depends on the portlet support for a given mode). - Moreover, the Edit mode is only available to logged in users, as in this mode, the portlet + Moreover, the Edit mode is only available to logged-in users, as in this mode, the portlet preferences can be modified to be individually suited to a particular user's needs. <itemizedlist> <listitem> @@ -320,7 +320,7 @@ <mediaobject> <imageobject> <imagedata fileref="images/intro/user_portlet_lost.png" format="png" align="center" - valign="middle"/> + valign="middle"/> </imageobject> </mediaobject> </para> @@ -330,7 +330,7 @@ <emphasis role="bold">View profile</emphasis> </para> <para> - The default page after login is the view profile, which shows a summary of the most important properties of a user. + The default page after login is the view profile, which shows a summary of the most important properties of a user. </para> </listitem> <listitem> @@ -338,7 +338,7 @@ <emphasis role="bold">Edit personal information</emphasis> </para> <para>A user has the ability to edit his personal information, change his password and e-mail address at any time by clicking on the - <emphasis>"Edit profile"</emphasis> link, when logged in. + <emphasis>"Edit profile"</emphasis> link, when logged in. </para> </listitem> </itemizedlist> @@ -359,7 +359,8 @@ 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> + <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. @@ -521,7 +522,7 @@ location, if the administrator allows this functionality. Changes made in this fashion will also be persisted. </para> <para> - It is also possible to copy the content of a shared page to your dashboard so you can customize it to your + It is also possible to copy the content of a shared page to your dashboard so you can customize it to your liking. Just click the <emphasis>'Copy to my dashboard'</emphasis> link at the top right of the page. This will clone the page and add it to your personal dashboard as a page with the same name. <mediaobject> @@ -564,7 +565,8 @@ at the bottom of the screen. We will note that users are not able to delete the default dashboard page. <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard_deletepage.png" format="png" align="center" valign="middle"/> + <imagedata fileref="images/intro/dashboard_deletepage.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> <warning> @@ -592,7 +594,7 @@ <sect1 id="adminportal"> <title>Admin Portal</title> <para> - <note>You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper priviledges + <note>You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper privileges to see this portal. </note> <mediaobject> @@ -600,8 +602,8 @@ <imagedata fileref="images/intro/adminportal.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal (Follow the links - for in-depth reviews of these functions): + The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal. Follow the links + for in-depth reviews of these functions: <itemizedlist> <listitem>Users/Roles (See: <xref linkend="useradmin"/>, <xref linkend="roleadmin"/>)</listitem> <listitem>Content Management System (See: <xref linkend="admincmsPortlet"/>)</listitem> Modified: docs/trunk/userGuide/en/modules/intro.xml =================================================================== --- docs/trunk/userGuide/en/modules/intro.xml 2007-10-10 22:05:10 UTC (rev 8593) +++ docs/trunk/userGuide/en/modules/intro.xml 2007-10-10 22:19:45 UTC (rev 8594) @@ -36,7 +36,7 @@ <emphasis>http://[domain]/[context]/portal/[portal_name]</emphasis> . In a default/local install, the <emphasis>default</emphasis> - portal instance can be reach by + portal instance can be reached at <ulink url="http://localhost:8080/portal/portal/default">http://localhost:8080/portal/portal/default</ulink> . </para> @@ -55,11 +55,11 @@ <emphasis>http://[domain]/[context]/portal/[portal_name]/[page_name]</emphasis> . In a default/local install, the <emphasis>default</emphasis> - page can be reach by + page can be reached at <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 + . Likewise, the News Page in a default install can be reached at <ulink url="http://localhost:8080/portal/portal/default/News"> http://localhost:8080/portal/portal/default/News </ulink> @@ -96,11 +96,11 @@ <para> <emphasis role="bold">Window Controls:</emphasis> Window controls are divided into two categories and control different aspects of how the user can - impact the generated markup. Each window control can be click to interact with the window in - specific way. <emphasis role="bold">Window State</emphasis> icons control how much room the window + impact the generated markup. Each window control can be clicked on to interact with the window in + specific ways. <emphasis role="bold">Window State</emphasis> icons control how much room the window will take on the page and how much markup will be shown. <emphasis role="bold">Portlet Mode</emphasis> icons, on the other hand, control the mode in which - the portlet operate, thus impacting the type of generated markup. Note that not all portlets + the portlet operates, thus impacting the type of generated markup. Note that not all portlets support all defined window states and/or portlet modes. <itemizedlist> <listitem> @@ -114,8 +114,8 @@ </imageobject> <emphasis role="bold">(Normal)</emphasis> - Normal window state, is the most common state for portlets (portlets in the - above image are in the normal window state). All portlet - windows occupy a similar amount of space on the page. + above image are in the normal window state). The portlet window will occupy only + enough space to show the portlet content on the page. </para> </listitem> <listitem> @@ -141,7 +141,7 @@ <para> <emphasis role="bold">Portlet Modes and their meaning:</emphasis> Portlet modes are not always available (it depends on the portlet support for a given mode). - Moreover, the Edit mode is only available to logged in users, as in this mode, the portlet + Moreover, the Edit mode is only available to logged-in users, as in this mode, the portlet preferences can be modified to be individually suited to a particular user's needs. <itemizedlist> <listitem> @@ -320,7 +320,7 @@ <mediaobject> <imageobject> <imagedata fileref="images/intro/user_portlet_lost.png" format="png" align="center" - valign="middle"/> + valign="middle"/> </imageobject> </mediaobject> </para> @@ -359,7 +359,8 @@ 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> + <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. @@ -564,7 +565,8 @@ at the bottom of the screen. We will note that users are not able to delete the default dashboard page. <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard_deletepage.png" format="png" align="center" valign="middle"/> + <imagedata fileref="images/intro/dashboard_deletepage.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> <warning> @@ -592,7 +594,7 @@ <sect1 id="adminportal"> <title>Admin Portal</title> <para> - <note>You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper priviledges + <note>You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper privileges to see this portal. </note> <mediaobject> @@ -600,8 +602,8 @@ <imagedata fileref="images/intro/adminportal.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal (Follow the links - for in-depth reviews of these functions): + The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal. Follow the links + for in-depth reviews of these functions: <itemizedlist> <listitem>Users/Roles (See: <xref linkend="useradmin"/>, <xref linkend="roleadmin"/>)</listitem> <listitem>Content Management System (See: <xref linkend="admincmsPortlet"/>)</listitem>