[gatein-commits] gatein SVN: r877 - in portal/trunk/docs: reference-guide and 9 other directories.

Author: thomas.heute(a)jboss.com Date: 2009-11-30 16:17:17 -0500 (Mon, 30 Nov 2009) New Revision: 877 Added: portal/trunk/docs/user-guide/en/modules/Further_Documentation.xml Removed: portal/trunk/docs/user-guide/en/images/A.png portal/trunk/docs/user-guide/en/images/AAANavigation.png portal/trunk/docs/user-guide/en/images/Abort.png portal/trunk/docs/user-guide/en/images/Access1.png portal/trunk/docs/user-guide/en/images/AccountProfiles.png portal/trunk/docs/user-guide/en/images/AccountProfiles1.png portal/trunk/docs/user-guide/en/images/AddCategory.png portal/trunk/docs/user-guide/en/images/AddGadget.png portal/trunk/docs/user-guide/en/images/AddGadget1.png portal/trunk/docs/user-guide/en/images/AddGadget2.png portal/trunk/docs/user-guide/en/images/AddGadget3.png portal/trunk/docs/user-guide/en/images/AddGadget4.png portal/trunk/docs/user-guide/en/images/AddGadget5.png portal/trunk/docs/user-guide/en/images/AddIcon.png portal/trunk/docs/user-guide/en/images/AddIcon1.png portal/trunk/docs/user-guide/en/images/AddMember.png portal/trunk/docs/user-guide/en/images/AddNode.png portal/trunk/docs/user-guide/en/images/AddPortalButton.png portal/trunk/docs/user-guide/en/images/Administration2.png portal/trunk/docs/user-guide/en/images/Administrator2.6.png portal/trunk/docs/user-guide/en/images/ArrowIcon.png portal/trunk/docs/user-guide/en/images/Auto1.png portal/trunk/docs/user-guide/en/images/AutoImport.png portal/trunk/docs/user-guide/en/images/Back.png portal/trunk/docs/user-guide/en/images/BannerPortlet.png portal/trunk/docs/user-guide/en/images/Breadcumbs.png portal/trunk/docs/user-guide/en/images/ChangeLanguage1.png portal/trunk/docs/user-guide/en/images/ChangeLanguage3.png portal/trunk/docs/user-guide/en/images/CheckIcon.png portal/trunk/docs/user-guide/en/images/ComboBox.png portal/trunk/docs/user-guide/en/images/Console.png portal/trunk/docs/user-guide/en/images/CopyNode1.png portal/trunk/docs/user-guide/en/images/CopyNode2.png portal/trunk/docs/user-guide/en/images/CreationWizard.png portal/trunk/docs/user-guide/en/images/Dashboad1.png portal/trunk/docs/user-guide/en/images/Dashboard.png portal/trunk/docs/user-guide/en/images/Dashboard2.png portal/trunk/docs/user-guide/en/images/DashboardPortlet1.png portal/trunk/docs/user-guide/en/images/DeleIcon.png portal/trunk/docs/user-guide/en/images/DeleteGadget.png portal/trunk/docs/user-guide/en/images/DeleteIcon.png portal/trunk/docs/user-guide/en/images/DeletePortal2.6.png portal/trunk/docs/user-guide/en/images/DiskIcon.png portal/trunk/docs/user-guide/en/images/DownIcon.png portal/trunk/docs/user-guide/en/images/EditGadget.png portal/trunk/docs/user-guide/en/images/EditIcon.png portal/trunk/docs/user-guide/en/images/EditIcon1.png portal/trunk/docs/user-guide/en/images/EditImportedOnline.png portal/trunk/docs/user-guide/en/images/EditImportedWebDAV.png portal/trunk/docs/user-guide/en/images/EditLayoutPortal.png portal/trunk/docs/user-guide/en/images/EditNavigationPortal.png portal/trunk/docs/user-guide/en/images/EditPage.png portal/trunk/docs/user-guide/en/images/EditPermission.png portal/trunk/docs/user-guide/en/images/EditPermission2.6.png portal/trunk/docs/user-guide/en/images/EditPropertiesPortal.png portal/trunk/docs/user-guide/en/images/Finish.png portal/trunk/docs/user-guide/en/images/Finish1.png portal/trunk/docs/user-guide/en/images/FinishIcon.png portal/trunk/docs/user-guide/en/images/Footer.png portal/trunk/docs/user-guide/en/images/French.png portal/trunk/docs/user-guide/en/images/FunctionBar.png portal/trunk/docs/user-guide/en/images/Gadget1.png portal/trunk/docs/user-guide/en/images/Gadget2.png portal/trunk/docs/user-guide/en/images/GlassIcon.png portal/trunk/docs/user-guide/en/images/GroupPath.png portal/trunk/docs/user-guide/en/images/HomepagePortal.png portal/trunk/docs/user-guide/en/images/IFrame.png portal/trunk/docs/user-guide/en/images/Import.png portal/trunk/docs/user-guide/en/images/Imported.png portal/trunk/docs/user-guide/en/images/Internal1.png portal/trunk/docs/user-guide/en/images/LinkIcon.png portal/trunk/docs/user-guide/en/images/ListIcon.png portal/trunk/docs/user-guide/en/images/Liste.png portal/trunk/docs/user-guide/en/images/MagnifyIcon.png portal/trunk/docs/user-guide/en/images/ManagePage1.png portal/trunk/docs/user-guide/en/images/ManagePages.png portal/trunk/docs/user-guide/en/images/ManagePortal.png portal/trunk/docs/user-guide/en/images/ManagePortal2.6.png portal/trunk/docs/user-guide/en/images/MarkIcon.png portal/trunk/docs/user-guide/en/images/MarkedIcon.png portal/trunk/docs/user-guide/en/images/MembershipManagement.png portal/trunk/docs/user-guide/en/images/NavigationPortlet.png portal/trunk/docs/user-guide/en/images/New.png portal/trunk/docs/user-guide/en/images/NewGlassIcon.png portal/trunk/docs/user-guide/en/images/NewOkIcon.png portal/trunk/docs/user-guide/en/images/OKIcon.png portal/trunk/docs/user-guide/en/images/OkButton.png portal/trunk/docs/user-guide/en/images/OpenUserWorkspace1.png portal/trunk/docs/user-guide/en/images/PageCreation.png portal/trunk/docs/user-guide/en/images/PageNavigation.png portal/trunk/docs/user-guide/en/images/PageNodeSetting1.png portal/trunk/docs/user-guide/en/images/PageSelector2.png portal/trunk/docs/user-guide/en/images/PasteCloneNode.png portal/trunk/docs/user-guide/en/images/PasteCutNode3.png portal/trunk/docs/user-guide/en/images/PasteNode.png portal/trunk/docs/user-guide/en/images/PermissionSetting.png portal/trunk/docs/user-guide/en/images/PlusIcon.png portal/trunk/docs/user-guide/en/images/PortalLogin.png portal/trunk/docs/user-guide/en/images/PortalLogo.png portal/trunk/docs/user-guide/en/images/PortalName.png portal/trunk/docs/user-guide/en/images/PortalProperties.png portal/trunk/docs/user-guide/en/images/PortalSetting.png portal/trunk/docs/user-guide/en/images/PortalTemplate.png portal/trunk/docs/user-guide/en/images/PortalTemplate2.5.png portal/trunk/docs/user-guide/en/images/PortletHome2.png portal/trunk/docs/user-guide/en/images/PotalTemplate.png portal/trunk/docs/user-guide/en/images/PreviewPage.png portal/trunk/docs/user-guide/en/images/RSS.png portal/trunk/docs/user-guide/en/images/Refresh.png portal/trunk/docs/user-guide/en/images/RefreshIcon.png portal/trunk/docs/user-guide/en/images/RemoveIcon.png portal/trunk/docs/user-guide/en/images/Resource.png portal/trunk/docs/user-guide/en/images/ResourceData.png portal/trunk/docs/user-guide/en/images/RollBack.png portal/trunk/docs/user-guide/en/images/SavePage.png portal/trunk/docs/user-guide/en/images/Search1.png portal/trunk/docs/user-guide/en/images/Search2.png portal/trunk/docs/user-guide/en/images/SearchIcon.png portal/trunk/docs/user-guide/en/images/SelectPortal1.png portal/trunk/docs/user-guide/en/images/SelectUser4.png portal/trunk/docs/user-guide/en/images/SelectUser5.png portal/trunk/docs/user-guide/en/images/SelectUsernew1.png portal/trunk/docs/user-guide/en/images/SetPortlet.png portal/trunk/docs/user-guide/en/images/ShowContainer.png portal/trunk/docs/user-guide/en/images/ShowPortlet.png portal/trunk/docs/user-guide/en/images/SiteMap3.png portal/trunk/docs/user-guide/en/images/StarPortlet.png portal/trunk/docs/user-guide/en/images/String.png portal/trunk/docs/user-guide/en/images/Switch.png portal/trunk/docs/user-guide/en/images/Tool.png portal/trunk/docs/user-guide/en/images/URL.png portal/trunk/docs/user-guide/en/images/UpIcon.png portal/trunk/docs/user-guide/en/images/UserToolbar.png portal/trunk/docs/user-guide/en/images/View.png portal/trunk/docs/user-guide/en/images/Workspace.png portal/trunk/docs/user-guide/en/images/app-registry-01.png portal/trunk/docs/user-guide/en/images/archisolutionapache.jpg portal/trunk/docs/user-guide/en/images/exo-menu.png portal/trunk/docs/user-guide/en/images/image3.jpg portal/trunk/docs/user-guide/en/images/key1.png portal/trunk/docs/user-guide/en/images/mainscreen.png portal/trunk/docs/user-guide/en/images/number.png portal/trunk/docs/user-guide/en/images/portal-change-skin.png portal/trunk/docs/user-guide/en/images/portal.gif portal/trunk/docs/user-guide/en/images/portal.png portal/trunk/docs/user-guide/en/images/preview.png portal/trunk/docs/user-guide/en/modules/Configuration.xml portal/trunk/docs/user-guide/en/modules/Configure_Portal_Default_Persmissions.xml portal/trunk/docs/user-guide/en/modules/Development.xml portal/trunk/docs/user-guide/en/modules/Gadgets.xml portal/trunk/docs/user-guide/en/modules/Portlets.xml portal/trunk/docs/user-guide/en/modules/SSO.xml portal/trunk/docs/user-guide/en/modules/Security.xml portal/trunk/docs/user-guide/en/modules/_archive/ portal/trunk/docs/user-guide/en/modules/_orphans/ portal/trunk/docs/user-guide/en/modules/configuration/ portal/trunk/docs/user-guide/en/modules/development/ portal/trunk/docs/user-guide/en/modules/gadgets/ portal/trunk/docs/user-guide/en/modules/portlets/ portal/trunk/docs/user-guide/en/modules/security/ Modified: portal/trunk/docs/pom.xml portal/trunk/docs/reference-guide/ portal/trunk/docs/user-guide/en/master.xml portal/trunk/docs/user-guide/en/modules/Account.xml portal/trunk/docs/user-guide/en/modules/GadgetsAdmin.xml portal/trunk/docs/user-guide/en/modules/Introduction.xml portal/trunk/docs/user-guide/en/modules/Language.xml portal/trunk/docs/user-guide/en/modules/Portal.xml portal/trunk/docs/user-guide/en/modules/PortletsUser.xml portal/trunk/docs/user-guide/en/modules/Terms.xml portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml portal/trunk/docs/user-guide/en/modules/account/Change_User_Password.xml portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Import_Portlets_and_Gadgets.xml portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml portal/trunk/docs/user-guide/en/modules/portal/Drag_and_Drop_the_Page_Body.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Pages.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Permission.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml portal/trunk/docs/user-guide/en/modules/portal/Page_Creation_Wizard.xml portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml portal/trunk/docs/user-guide/en/modules/portal/Toolbar.xml portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml portal/trunk/docs/user-guide/en/modules/portletsUser/FCK_Portlet.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Navigation_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Portlet_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml Log: Modifying user guide Modified: portal/trunk/docs/pom.xml =================================================================== --- portal/trunk/docs/pom.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/pom.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -31,6 +31,7 @@ <modules> <module>user-guide</module> + <module>reference-guide</module> </modules> </project> Property changes on: portal/trunk/docs/reference-guide ___________________________________________________________________ Name: svn:ignore + target Deleted: portal/trunk/docs/user-guide/en/images/A.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AAANavigation.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Abort.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Access1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AccountProfiles.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AccountProfiles1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddCategory.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget3.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget4.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddGadget5.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddIcon1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddMember.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddNode.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AddPortalButton.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Administration2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Administrator2.6.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ArrowIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Auto1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/AutoImport.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Back.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/BannerPortlet.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Breadcumbs.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ChangeLanguage1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ChangeLanguage3.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/CheckIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ComboBox.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Console.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/CopyNode1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/CopyNode2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/CreationWizard.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Dashboad1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Dashboard.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Dashboard2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DashboardPortlet1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DeleIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DeleteGadget.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DeleteIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DeletePortal2.6.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DiskIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/DownIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditGadget.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditIcon1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditImportedOnline.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditImportedWebDAV.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditLayoutPortal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditNavigationPortal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditPage.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditPermission.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditPermission2.6.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/EditPropertiesPortal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Finish.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Finish1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/FinishIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Footer.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/French.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/FunctionBar.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Gadget1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Gadget2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/GlassIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/GroupPath.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/HomepagePortal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/IFrame.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Import.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Imported.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Internal1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/LinkIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ListIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Liste.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/MagnifyIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ManagePage1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ManagePages.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ManagePortal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ManagePortal2.6.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/MarkIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/MarkedIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/MembershipManagement.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/NavigationPortlet.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/New.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/NewGlassIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/NewOkIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/OKIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/OkButton.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/OpenUserWorkspace1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PageCreation.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PageNavigation.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PageNodeSetting1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PageSelector2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PasteCloneNode.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PasteCutNode3.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PasteNode.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PermissionSetting.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PlusIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalLogin.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalLogo.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalName.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalProperties.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalSetting.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalTemplate.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortalTemplate2.5.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PortletHome2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PotalTemplate.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/PreviewPage.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/RSS.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Refresh.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/RefreshIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/RemoveIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Resource.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ResourceData.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/RollBack.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SavePage.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Search1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Search2.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SearchIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SelectPortal1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SelectUser4.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SelectUser5.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SelectUsernew1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SetPortlet.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ShowContainer.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/ShowPortlet.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/SiteMap3.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/StarPortlet.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/String.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Switch.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Tool.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/URL.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/UpIcon.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/UserToolbar.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/View.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/Workspace.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/app-registry-01.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/archisolutionapache.jpg =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/exo-menu.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/image3.jpg =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/key1.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/mainscreen.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/number.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/portal-change-skin.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/portal.gif =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/portal.png =================================================================== (Binary files differ) Deleted: portal/trunk/docs/user-guide/en/images/preview.png =================================================================== (Binary files differ) Modified: portal/trunk/docs/user-guide/en/master.xml =================================================================== --- portal/trunk/docs/user-guide/en/master.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/master.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -68,80 +68,13 @@ <!-- GadgetsAdmin --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/GadgetsAdmin.xml" /> - - <!-- 4_Configuration --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Configuration.xml" /> - - - <!-- 5_Security --> - - <!-- Core/Security_Service --> <!-- - Outdated <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/Security.xml" /> - --> - - <!-- 6_Integration --> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Integration.xml" /> - - - <!-- 8_Migration --> - <!-- - Archived <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/Migration_from_2-1_to_2-2.xml" /> <xi:include - xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/Migration_from_2-2_to_2-5.xml" /> <xi:include - xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/Export-Import_Portal_Configuration.xml" /> - --> - - <!-- 9_Technical_Foundations --> - - <!-- Main/Overall_Architecture --> - <!-- Kernel/Inversion_of_Control --> - <!-- Portlet_Container --> - <!-- Java_Content_Repository --> - <!-- Web_Services --> - <!-- GateIn_Core --> - <!-- GateIn_Kernel --> - - <!-- 10_Development_ --> - - <!-- Main/Developers --> - <!-- http://docs.exoplatform.org --> - <!-- Products_Tech_Overview/Components_Registry --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Development.xml" /> - - <!-- Portlets --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Portlets.xml" /> - - <!-- Gadgets --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Gadgets.xml" /> - - <!-- Single Sign On --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/SSO.xml" /> - - - <!-- 11_Support http://www.exoplatform.com/portal/public/en/forum?portal:componentId=foru... http://faq.exoplatform.com/ http://jira.exoplatform.org/browse/Portal --> - <!-- Orphan from XWiki site --> - <chapter> - <title>Orphans chapters: TODO: move and integrate those</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/_orphans/Setup_GadgetServer.xml" /> - <!-- - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="modules/_orphans/Internationalization_Guidelines.xml" /> - --> - </chapter> - - <!-- Deprecated <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced_User_Guide.xml" /> <xi:include Modified: portal/trunk/docs/user-guide/en/modules/Account.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Account.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Account.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Account"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,17 +21,12 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Account</title> + <xi:include href="account/Register_New_Accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="account/Change_User_Password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="account/Change_Account_Settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="account/Sign_in_and_Sign_out.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="account/Account_and_Password_Retrieval.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="account/Remember_User_Account.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Account</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Register_New_Accounts.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Change_User_Password.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Change_Account_Settings.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Sign_in_and_Sign_out.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Account_and_Password_Retrieval.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="account/Remember_User_Account.xml" /> - -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/Configuration.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Configuration.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Configuration.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,45 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Configuration</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/IDM_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Default_Portal_Configuration.xml" /> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Portal_Navigation_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Predefined_User_Configuration.xml" /> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/User_Workspace_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Portal_Default_Permission_Configuration.xml" /> -<!-- Kernel/Service_Configuration_for_Beginners --> -<!-- Kernel/Service_Configuration_in_Detail --> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Database_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Data_Injector_Configuration.xml" /> -<!-- Core/LDAP_Configuration --> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Skin_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/JavaScript_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Dashboard_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Authentication_Token_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration/Varnish_Configuration.xml" /> - -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/Configure_Portal_Default_Persmissions.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Configure_Portal_Default_Persmissions.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Configure_Portal_Default_Persmissions.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,79 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter><title>Configure Portal Default Permissions</title> -<para>The permission configuration for the portal is defined in the file portal/WEB-INF/conf/portal/portal-configuration.xml. The component UserACL is described there along with other portal component configurations.</para><para>It defines 5 permissions types:</para><itemizedlist><listitem><emphasis role="bold">super.user</emphasis>: The super user has all the rights on the platform, by default this user is called root</listitem></itemizedlist><itemizedlist><listitem><emphasis role="bold">portal.creator.groups</emphasis>: This list defines all groups that will be able to manage the different portals, they also have the permission to create new portals. The format is &quot;membership:/group/subgroup&quot;.</listitem></itemizedlist><itemizedlist><listitem><emphasis role="bold">navigation.creator.membership.type</emphasis>: Defines the membership type of the group managers. The group managers have the permission to create and edit group pages and they can modify the group navi! gation.</listitem></itemizedlist><itemizedlist><listitem><emphasis role="bold">guests.group</emphasis>: Contains the name of the group that is used as guest group. Any anonymous user becomes automatically member of this group when he enters the public pages.</listitem></itemizedlist><itemizedlist><listitem><emphasis role="bold">access.control.workspace</emphasis>: Defines the users that have access to the control workspace. In the demo version the control workspace is accessible only to 'root' and 'john'. They can expand/collapse the workspace at the left hand side. The format is &quot;membership:/group/subgroup&quot;, An asterisk '' gives permission to all memberships.</listitem></itemizedlist><programlisting> &lt;component&gt; - &lt;key&gt;org.exoplatform.portal.config.UserACL&lt;/key&gt; - &lt;type&gt;org.exoplatform.portal.config.UserACL&lt;/type&gt; - &lt;init-params&gt; - &lt;value-param&gt; - &lt;name&gt;super.user&lt;/name&gt; - &lt;description&gt;administrator&lt;/description&gt; - &lt;value&gt;root&lt;/value&gt; - &lt;/value-param&gt; - - &lt;value-param&gt; - &lt;name&gt;portal.creator.groups&lt;/name&gt; - &lt;description&gt;groups with membership type have permission to manage portal&lt;/description&gt; - &lt;value&gt;*:/platform/administrators,*:/organization/management/executive-board&lt;/value&gt; - &lt;/value-param&gt; - - &lt;value-param&gt; - &lt;name&gt;navigation.creator.membership.type&lt;/name&gt; - &lt;description&gt;specific membership type have full permission with group navigation&lt;/description&gt; - &lt;value&gt;manager&lt;/value&gt; - &lt;/value-param&gt; - &lt;value-param&gt; - &lt;name&gt;guests.group&lt;/name&gt; - &lt;description&gt;guests group&lt;/description&gt; - &lt;value&gt;/platform/guests&lt;/value&gt; - &lt;/value-param&gt; - &lt;value-param&gt; - &lt;name&gt;access.control.workspace&lt;/name&gt; - &lt;description&gt;groups with memberships that have the right to access the User Control Workspace&lt;/description&gt; - &lt;value&gt;*:/platform/administrators,*:/organization/management/executive-board&lt;/value&gt; - &lt;/value-param&gt; - &lt;/init-params&gt; - &lt;/component&gt; -</programlisting><para>1 Overwrite Portal Default Permissions In GateIn Portal 2.5 and later the UserACL component supports adding a PortalACLPlugin plugin that allows to overwrite portal default permissions.</para><programlisting> &lt;external-component-plugins&gt; - &lt;target-component&gt;org.exoplatform.portal.config.UserACL&lt;/target-component&gt; - &lt;component-plugin&gt; - &lt;name&gt;addPortalACLPlugin&lt;/name&gt; - &lt;set-method&gt;addPortalACLPlugin&lt;/set-method&gt; - &lt;type&gt;org.exoplatform.portal.config.PortalACLPlugin&lt;/type&gt; - &lt;description&gt;setting some permission for portal&lt;/description&gt; - &lt;init-params&gt; - &lt;values-param&gt; - &lt;name&gt;access.control.workspace.roles&lt;/name&gt; - &lt;value&gt;*:/platform/administrators&lt;/value&gt; - &lt;value&gt;*:/organization/management/executive-board&lt;/value&gt; - &lt;/values-param&gt; - &lt;values-param&gt; - &lt;name&gt;portal.creation.roles&lt;/name&gt; - &lt;value&gt;*:/platform/administrators&lt;/value&gt; - &lt;value&gt;*:/organization/management/executive-board&lt;/value&gt; - &lt;/values-param&gt; - &lt;/init-params&gt; - &lt;/component-plugin&gt; - &lt;/external-component-plugins&gt; -</programlisting> -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/Development.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Development.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Development.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,36 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Development</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Portal_Lifecycle.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Right_To_Left_Framework.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Internationalization_Configuration.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/XML_Resource_Bundles.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Dynamic_Layouts.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/JavaScript_Inter_Application_Communication.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Upload_Component.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Ajax_Loading_Mask_Layer_Deactivation.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="development/Accessing_User_Profile.xml" /> - -</chapter> \ No newline at end of file Added: portal/trunk/docs/user-guide/en/modules/Further_Documentation.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Further_Documentation.xml (rev 0) +++ portal/trunk/docs/user-guide/en/modules/Further_Documentation.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -0,0 +1,31 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Further_Documentation"> + <!-- + + Copyright (C) 2009 eXo Platform SAS. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. + + --><title>Futher Documentation</title> + + <para> + Further documentation about using and configuring the GateIn Portal can be found in the GateIn Portal Install Guide or the GateIn Portal Reference Guide which are hosted at <ulink type="http" url="www.redhat.com/docs">www.redhat.com/docs</ulink>;. + </para> + +</chapter> + Deleted: portal/trunk/docs/user-guide/en/modules/Gadgets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Gadgets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Gadgets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,29 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Gadget development</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gadgets/Gadgets.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gadgets/Setup_a_Gadget_Server.xml" /> - -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/GadgetsAdmin.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/GadgetsAdmin.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/GadgetsAdmin.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Gadgets_Administration"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,14 +21,9 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Gadgets Administration</title> + <xi:include href="gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="gadgetsAdmin/Import_Portlets_and_Gadgets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="gadgetsAdmin/Manage_Portlets_and_Gadgets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Gadgets Administration</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gadgetsAdmin/Import_Portlets_and_Gadgets.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gadgetsAdmin/Manage_Portlets_and_Gadgets.xml" /> - -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/Introduction.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Introduction.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Introduction.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Introduction"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,49 +21,40 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> - <title>Introduction</title> + --><title>Introduction</title> <mediaobject> <imageobject> - <imagedata fileref="images/Frontpage.png" scalefit="1" /> + <imagedata fileref="images/Frontpage.png" format="PNG" scalefit="1" /> </imageobject> </mediaobject> - - <para>GateIn portal is a merge of two mature projects that have - been around for a while, JBoss Portal and GateIn Portal. It takes the - best of both into a single new project. The aim is to provide both an - intuitive portal to use as-is and a portal framework to build upon - depending on your needs.</para> - <section> + <para> + Enterprise Portal Platform (<acronym>EPP</acronym>) 5.0 is a merge of two mature projects; the JBoss Portal and the eXo Portal. It takes the best of both offerings and incorporates them into a single new project. The aim is to provide an intuitive portal for as-is use and a framework to build upon depending on your needs. + </para> + <section id="sect-User_Guide-Introduction-Links"> <title>Links</title> <itemizedlist> <listitem> <para> - GateIn homepage: - <ulink url="http://www.gatein.org">www.gatein.org</ulink> + GateIn project homepage. GateIn 3.0 is the community project that Enterprise Portal Platform 5.0 is based on. <ulink url="http://www.gatein.org">www.gatein.org</ulink> </para> </listitem> - <listitem> +<!-- <listitem> <para> - GateIn videos: - <ulink url="http://www.jboss.org/gatein/videos.html">www.jboss.org/... + GateIn videos. Various video clips created by the GateIn community leads that provide a guide to the usage and features of the GateIn portal, many of wh <ulink url="http://www.jboss.org/gatein/videos.html">www.jboss.org/... </para> </listitem> <listitem> <para> - GateIn documentation: - <ulink url="http://www.jboss.org/gatein/documentation.html">www.jbo... + GateIn documentation: <ulink url="http://www.jboss.org/gatein/documentation.html">www.jbo... </para> </listitem> <listitem> <para> - GateIn downloads: - <ulink url="http://www.jboss.org/gatein/downloads.html">www.jboss.o... + GateIn downloads: <ulink url="http://www.jboss.org/gatein/downloads.html">www.jboss.o... </para> - </listitem> + </listitem> --> </itemizedlist> </section> + </chapter> + Modified: portal/trunk/docs/user-guide/en/modules/Language.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Language.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Language.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Language_administration"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,15 +21,10 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Language administration</title> + <xi:include href="language/Change_Interface_Language.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="language/Right_To_Left_Support_(RTL).xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="language/Multi-Language_Navigation_Nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="language/Internationalization_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Language administration</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Change_Interface_Language.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Right_To_Left_Support_(RTL).xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Multi-Language_Navigation_Nodes.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Internationalization_Portlet.xml" /> - -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/Portal.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Portal.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Portal.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Portal_Administration"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,26 +21,21 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Portal Administration</title> + +<!-- xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/User_Workspace.xml" /> --> + <xi:include href="portal/Toolbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/User_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Manage_Permission.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Change_Portal_Skins.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Manage_Page_Navigation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +<!-- <xi:include href="portal/Manage_Navigation_Nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Change_Node_Order.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> To be includeed in Reference Guide--> + <xi:include href="portal/Manage_Pages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Page_Creation_Wizard.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Drag_and_Drop_the_Page_Body.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Create_a_New_Portal.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Manage_Portals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portal/Switching_between_Portals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Portal Administration</title> -<!-- -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/User_Workspace.xml" /> - --> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Toolbar.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/User_Management.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Manage_Permission.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Change_Portal_Skins.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Manage_Page_Navigation.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Manage_Navigation_Nodes.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Change_Node_Order.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Manage_Pages.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Page_Creation_Wizard.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Drag_and_Drop_the_Page_Body.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Create_a_New_Portal.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Manage_Portals.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portal/Switching_between_Portals.xml" /> - -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/Portlets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Portlets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Portlets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,34 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Portlet development</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/WebUI.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/AJAX_in_GateIn_Framework.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/Groovy_Templates.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/Create_a_WebUI_Portlet.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/Portlet_Lifecycle.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portlets/Sample_Basic_Portlet.xml" /> - - -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/PortletsUser.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/PortletsUser.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/PortletsUser.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Portlets"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,15 +21,10 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Portlets</title> + <xi:include href="portletsUser/Functional_Portlets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portletsUser/Interface_Portlets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portletsUser/Dashboard_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="portletsUser/FCK_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Portlets</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portletsUser/Functional_Portlets.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portletsUser/Interface_Portlets.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portletsUser/Dashboard_Portlet.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="portletsUser/FCK_Portlet.xml" /> - -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/SSO.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/SSO.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/SSO.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,173 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Single Sign On</title> - - <section> - <title>Overview of SSO</title> - <para>Portal as an integration and aggregation platform provides some form of SSO by itself. When you log into - the portal you gain access to many systems through portlets using a single identity. Still in many cases you - need to integrate the portal infrastructure with other SSO enabled systems. There are many different Identity Management - solutions on the market. In most cases each SSO framework provides its own way to plug into Java EE application. - </para> - </section> - - <section> - <title>CAS - Central Authentication Service</title> - <para>This Single Sign On plugin enables seamless integration between GateIn Portal and the CAS Single Sign On Framework. - Details about CAS can be found <ulink url="http://www.ja-sig.org/products/cas/">here</ulink> - </para> - <section> - <title>Integration</title> - <section> - <title>From source</title> - <itemizedlist> - <listitem> - <para> - Check out the GateIn SSO component from SVN using the following command: - <programlisting> - <![CDATA[ -svn co http://anonsvn.jboss.org/repos/gatein/components/sso/tags/<appropriate sso component version> - ]]> - </programlisting> - </para> - </listitem> - <listitem> - <para> - Update <emphasis>packaging/profiles.xml</emphasis> to reflect the directories where your local JBoss AS 5.1.0.GA and Tomcat 6.0.2 are installed - </para> - </listitem> - </itemizedlist> - </section> - <section> - <title>Install CAS plugin into a designated CAS (3.3.4) server</title> - <itemizedlist> - <listitem> - <para> - <programlisting> - <![CDATA[ - mvn -Pplugin-cas-install install - ]]> - </programlisting> - </para> - </listitem> - </itemizedlist> - </section> - <section> - <title>Install CAS GateIn Agent into the designated GateIn server</title> - <itemizedlist> - <listitem> - <para> - <programlisting> - <![CDATA[ - mvn -Pgatein-cas-install install - ]]> - </programlisting> - </para> - </listitem> - </itemizedlist> - </section> - </section> - <section> - <title>CAS Server Plugin Configuration</title> - <para> - The CAS Server Plugin makes secure authentication callbacks to a RESTful service installed on the remote GateIn server in order to authenticate a user. - In order for the plugin to function correctly, it needs to be properly configured to connect to this service. This configuration is done via the - <emphasis>cas.war/WEB-INF/deployerConfigContext.xml</emphasis> file. - </para> - <para> - <programlisting> - <![CDATA[ - <!-- - Note: Modify the Plugin Configuration based on the actual information of a GateIn instance. - The instance can be anywhere on the internet...Not on localhost where CAS is running - --> - <bean class="org.gatein.sso.cas.plugin.AuthenticationPlugin"> - <property name="gateInHost"><value>localhost</value></property> - <property name="gateInPort"><value>8080</value></property> - <property name="gateInContext"><value>portal</value></property> - </bean> - ]]> - </programlisting> - </para> - </section> - <section> - <title>GateIn Agent Configuration</title> - <para> - In a Single Sign On usecase, the GateIn server re-directs all "private" resource requests to the CAS server for authentication first. The CAS server can be - located anywhere on the Internet, and this information must be properly configured within the GateIn instance. This configuration needs to be done in 3 files - <itemizedlist> - <listitem> - <emphasis>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</emphasis> - <para> - <programlisting> - <![CDATA[ - <script> - <%=uicomponent.event("Close");%> - window.location = 'http://localhost:8888/cas/login?service=http://localhost:8080/portal/private/classic'; - </script> - ]]> - </programlisting> - </para> - </listitem> - <listitem> - <emphasis>gatein.ear/02portal.war/login/jsp/login.jsp</emphasis> - <para> - <programlisting> - <![CDATA[ - <html> - <head> - <script type="text/javascript"> - window.location = 'http://localhost:8888/cas/login?service=http://localhost:8080/portal/private/classic'; - </script> - </head> - <body> - </body> - </html> - ]]> - </programlisting> - </para> - </listitem> - <listitem> - <emphasis>gatein.ear/02portal.war/WEB-INF/web.xml</emphasis> - <para> - <programlisting> - <![CDATA[ - <servlet> - <servlet-name>InitiateLoginServlet</servlet-name> - <servlet-class>org.gatein.sso.agent.GenericSSOAgent</servlet-class> - <init-param> - <param-name>casServerUrl</param-name> - <param-value>http://localhost:8888/cas</param-value> - </init-param> - </servlet> - ]]> - </programlisting> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - </section> -</chapter> \ No newline at end of file Deleted: portal/trunk/docs/user-guide/en/modules/Security.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Security.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Security.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,28 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Security</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security/Use_Spring_Security.xml" /> - -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/Terms.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Terms.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/Terms.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter id="chap-User_Guide-Terms"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,21 +21,15 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> -<title>Terms</title> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Portal_concept.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Portlet_concept.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Navigation_concept.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Gadget_concept.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Public_mode_and_Private_mode.xml" /> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Permission_levels.xml" /> -<!-- Deprecated + --><title>Terms</title> + <xi:include href="terms/Portal_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="terms/Portlet_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="terms/Navigation_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="terms/Gadget_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="terms/Public_mode_and_Private_mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="terms/Permission_levels.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- Deprecated <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Workspace_concept.xml" /> - --> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="terms/Toolbar_concept.xml" /> + --><xi:include href="terms/Toolbar_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> -</chapter> \ No newline at end of file Modified: portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Account_and_Password_Retrieval"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,92 +21,92 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Account and Password Retrieval</title> - <para>This feature is really - useful when you forget your account or password by recovering it - quickly through following simple steps:</para> + --><title>Account and Password Retrieval</title> <para> - 1. Show the form that guides you step by step in recovering your User - name/ Password by clicking the link 'Forget your User Name/Password?' - beneath the - <emphasis role="bold">Password</emphasis> - field of the - <emphasis role="bold">Sign in</emphasis> - form. + This feature is really useful when you forget your account or password by recovering it quickly through following simple steps: </para> + <para> + 1. Show the form that guides you step by step in recovering your User name/ Password by clicking the link 'Forget your User Name/Password?' beneath the <emphasis role="bold">Password</emphasis> field of the <emphasis role="bold">Sign in</emphasis> form. + </para> <mediaobject> <imageobject> - <imagedata fileref="images/SignIn1.png" format="PNG"></imagedata> + <imagedata fileref="images/SignIn1.png" format="PNG" /> </imageobject> </mediaobject> - <para>This form offers two options to select:</para> + <para> + This form offers two options to select: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/Forgot1.png" format="PNG"></imagedata> + <imagedata fileref="images/Forgot1.png" format="PNG" /> </imageobject> </mediaobject> <itemizedlist> <listitem> - <emphasis role="bold">Forgot my password</emphasis> - : If you forget your password, you need to select this option. + <para> + <emphasis role="bold">Forgot my password</emphasis> : If you forget your password, you need to select this option. + </para> </listitem> <listitem> - <emphasis role="bold">Forgot my username</emphasis> - : If you forget your username, you need to select this option. + <para> + <emphasis role="bold">Forgot my username</emphasis> : If you forget your username, you need to select this option. + </para> </listitem> </itemizedlist> - <para>2. Select one of two options in this form.</para> <para> - 3. Click the - <emphasis role="bold">Next</emphasis> - button to go to the next step: + 2. Select one of two options in this form. </para> + <para> + 3. Click the <emphasis role="bold">Next</emphasis> button to go to the next step: + </para> <itemizedlist> <listitem> - If you selected - <emphasis role="bold">Forgot my password</emphasis> - option: + <para> + If you selected <emphasis role="bold">Forgot my password</emphasis> option: + </para> </listitem> </itemizedlist> <mediaobject> <imageobject> - <imagedata fileref="images/ForgotUserName1.png" format="PNG"></imagedata> + <imagedata fileref="images/ForgotUserName1.png" format="PNG" /> </imageobject> </mediaobject> <itemizedlist> <listitem> - If you selected - <emphasis role="bold">Forgot my username</emphasis> - option: + <para> + If you selected <emphasis role="bold">Forgot my username</emphasis> option: + </para> </listitem> </itemizedlist> <mediaobject> <imageobject> - <imagedata fileref="images/ForgotEmail1.png" format="PNG"></imagedata> + <imagedata fileref="images/ForgotEmail1.png" format="PNG" /> </imageobject> </mediaobject> - <para>4. Enter a value in the field of this form.</para> <para> - 5. Click the - <emphasis role="bold">Send</emphasis> - button to send the entered values. + 4. Enter a value in the field of this form. </para> - <para>After information is sent, you will be received an email - with your User name/ Password in your email address that you - registered.</para> + <para> + 5. Click the <emphasis role="bold">Send</emphasis> button to send the entered values. + </para> + <para> + After information is sent, you will be received an email with your User name/ Password in your email address that you registered. + </para> <itemizedlist> - <listitem>If you forget user name: when retrieving user name, your - old user name still is remained and reused.</listitem> - <listitem>If you forget old password: you will be set a new password - (as temporary). Then you will be directed to change password the next - time you sign in.</listitem> + <listitem> + <para> + If you forget user name: when retrieving user name, your old user name still is remained and reused. + </para> + </listitem> + <listitem> + <para> + If you forget old password: you will be set a new password (as temporary). Then you will be directed to change password the next time you sign in. + </para> + </listitem> </itemizedlist> - <para>The User name/Password that you received only have effect on 1 - day. It means if current date is over 1 day from received date, you - can not use the received User name/ Password thus you have to get - another email active.</para> -</section> \ No newline at end of file + <para> + The User name/Password that you received only have effect on 1 day. It means if current date is over 1 day from received date, you can not use the received User name/ Password thus you have to get another email active. + </para> +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Change_Account_Settings"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,93 +21,69 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Change Account Settings</title> - <para>There are two ways to change the account information:</para> - <section> -<!-- <title>The 1^st^ way</title> --> - <para>All users can follow this guides to change your account - information.</para> - <para>To change your account information, you just - click on your - account:</para> + --><title>Change Account Settings</title> + <!-- <para> + There are two ways to change the account information: + </para> + <title>The 1^st^ way</title> --> + <para> + All users can follow this guides to change your account information. + </para> + <para> + To change your account information, you just click on your account: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/ChangeAccount.png" format="PNG"></imagedata> + <imagedata fileref="images/ChangeAccount.png" format="PNG" /> </imageobject> </mediaobject> <para> - The - <emphasis role="bold">Account Profiles</emphasis> - form will appear: + The <emphasis role="bold">Account Profiles</emphasis> form will appear: </para> <mediaobject> <imageobject> - <imagedata fileref="images/AccountProfiles3.png" format="PNG"></imagedata> + <imagedata fileref="images/AccountProfiles3.png" format="PNG" /> </imageobject> </mediaobject> <para> - If you want to change your - <emphasis role="bold">Account Profiles</emphasis> - : + If you want to change your <emphasis role="bold">Account Profiles</emphasis> : </para> <para> - 1. Select the - <emphasis role="bold">Account Profiles</emphasis> - tab. It will display your current basic information. + 1. Select the <emphasis role="bold">Account Profiles</emphasis> tab. It will display your current basic information. </para> <para> - 2. Your - <emphasis role="bold">User Name</emphasis> - can not be changed. You can change these fields: - <emphasis role="bold">First Name</emphasis> - , - <emphasis role="bold">Last Name</emphasis> - and - <emphasis role="bold">Email</emphasis> - . + 2. Your <emphasis role="bold">User Name</emphasis> can not be changed. You can change these fields: <emphasis role="bold">First Name</emphasis> , <emphasis role="bold">Last Name</emphasis> and <emphasis role="bold">Email</emphasis> . </para> <para> - 3. Click the - <emphasis role="bold">Save</emphasis> - button to accept changes. + 3. Click the <emphasis role="bold">Save</emphasis> button to accept changes. </para> <para> - If you want to change your - <emphasis role="bold">Password</emphasis> - : + If you want to change your <emphasis role="bold">Password</emphasis> : </para> <para> - 1. Select the - <emphasis role="bold">Change Password</emphasis> - tab, it will display a form: + 1. Select the <emphasis role="bold">Change Password</emphasis> tab, it will display a form: </para> <mediaobject> <imageobject> - <imagedata fileref="images/ChangePassword.png" format="PNG"></imagedata> + <imagedata fileref="images/ChangePassword.png" format="PNG" /> </imageobject> </mediaobject> - <para>2. Input your current password to identify that you are the - owner of this account.</para> - <para>3. Input your new password, it must have at least 6 characters</para> <para> - 4. Reinput your password in the - <emphasis role="bold">Confirm New Password</emphasis> - field. + 2. Input your current password to identify that you are the owner of this account. </para> <para> - 5. Click the - <emphasis role="bold">Save</emphasis> - button to accept changes. + 3. Input your new password, it must have at least 6 characters </para> - </section> -<!-- + <para> + 4. Reinput your password in the <emphasis role="bold">Confirm New Password</emphasis> field. + </para> + <para> + 5. Click the <emphasis role="bold">Save</emphasis> button to accept changes. + </para> + <!-- <section> <title>The 2^nd^ way</title> - </section> + <para>Only users who have the permission to access GateIn start in the User Workspace can follow this way.</para> @@ -111,5 +91,7 @@ Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Account Settings</emphasis></para><mediaobject><imageobject><imagedata fileref="images/ChangeLanguage3.png" format="PNG"></imagedata></imageobject></mediaobject><para>It will also open the <emphasis role="bold">Account Profiles</emphasis> form.</para><mediaobject><imageobject><imagedata fileref="images/AccountProfiles1.png" format="PNG"></imagedata></imageobject></mediaobject><para>You can change your information in the <emphasis role="bold">Account Profiles</emphasis> tab and the <emphasis role="bold">Change Password</emphasis> tab as the same as the first way.</para> - --> -</section> \ No newline at end of file + </section> --> +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/account/Change_User_Password.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Change_User_Password.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Change_User_Password.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Changing_Password"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,17 +21,18 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <para>TODO</para> -<!-- + --><title>Changing Password</title> + <para> + TODO + </para> + <!-- <title>Change User Password</title> <para>This video shows you how to change the user password step by step:</para> <itemizedlist> <listitem>changepasswordexo.swf</listitem> </itemizedlist> ---> -</section> \ No newline at end of file + --> +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Register_New_Accounts"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,48 +21,37 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Register New Accounts</title> - <para>If you are a visitor of GateIn Portal, you only may read news - or - take some normal actions. Thus to access and get more actions, you - should register and contact with administrators to get more - permissions!</para> - <para>GateIn Portal supports users to register a new account by - themselves quickly and easily. Just by completing the steps below, you - will have a new account that helps you access more pages and take more - actions in GateIn Portal:</para> + --><title>Register New Accounts</title> + <para> + If you are a visitor of GateIn Portal, you only may read news or take some normal actions. Thus to access and get more actions, you should register and contact with administrators to get more permissions! + </para> + <para> + GateIn Portal supports users to register a new account by themselves quickly and easily. Just by completing the steps below, you will have a new account that helps you access more pages and take more actions in GateIn Portal: + </para> <orderedlist> <listitem> <para> - Go to a portal by typing the URL in the address bar (e.g: - http://localhost:8080/portal). + Go to a portal by typing the URL in the address bar (e.g: http://localhost:8080/portal). <mediaobject> <imageobject> - <imagedata fileref="images/Frontpage.png" format="PNG"></imagedata> + <imagedata fileref="images/Frontpage.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> - <para>Click - <emphasis role="bold">Register</emphasis> - on the Navigation bar. The Register page will appear: + <para> + Click <emphasis role="bold">Register</emphasis> on the Navigation bar. The Register page will appear: <mediaobject> <imageobject> - <imagedata fileref="images/AccountSetting.png" format="PNG"></imagedata> + <imagedata fileref="images/AccountSetting.png" format="PNG" /> </imageobject> </mediaobject> </para> <para> - The - <emphasis role="bold">Account Setting</emphasis> - information includes: + The <emphasis role="bold">Account Setting</emphasis> information includes: </para> - <informaltable frame="none" rowsep="0" colsep="0"> + <informaltable colsep="0" frame="none" rowsep="0"> <tgroup cols="2"> <colspec align="center"></colspec> <colspec align="center"></colspec> @@ -72,103 +65,122 @@ </entry> </row> <row> - <entry> User Name </entry> - <entry> the name that the user uses to login. This field must be - unique and start with a character </entry> + <entry> + User Name + </entry> + <entry> + the name that the user uses to login. This field must be unique and start with a character + </entry> </row> <row> - <entry> Password </entry> - <entry> The *Password* must be between 6 and 30 characters and - can - contain space characters. Since Portal 2.6, space characters are - either at the beginning or in the end can be counted. </entry> + <entry> + Password + </entry> + <entry> + The *Password* must be between 6 and 30 characters and can contain space characters. Since Portal 2.6, space characters are either at the beginning or in the end can be counted. + </entry> </row> <row> - <entry> Confirm Password </entry> - <entry> re-type the password above. *Password* and *Confirm - Password* must be the same. </entry> + <entry> + Confirm Password + </entry> + <entry> + re-type the password above. *Password* and *Confirm Password* must be the same. + </entry> </row> <row> - <entry> First Name </entry> - <entry> the first name of a user. </entry> + <entry> + First Name + </entry> + <entry> + the first name of a user. + </entry> </row> <row> - <entry> Last Name </entry> - <entry> the last name of a user. </entry> + <entry> + Last Name + </entry> + <entry> + the last name of a user. + </entry> </row> <row> - <entry> Email Address </entry> - <entry> the email of a user. It must be in the right format likes - username(a)abc.com </entry> + <entry> + Email Address + </entry> + <entry> + the email of a user. It must be in the right format likes username(a)abc.com + </entry> </row> </tbody> </tgroup> </informaltable> </listitem> <listitem> - <para>Fill in the form.</para> + <para> + Fill in the form. + </para> </listitem> <listitem> - <para>Click the magnifying glass icon !images/magnifyIcon.png! - to - search and check if the chosen username is available.</para> + <para> + Click the magnifying glass icon !images/magnifyIcon.png! to search and check if the chosen username is available. + </para> </listitem> <listitem> - <para>Input values in the - <emphasis role="bold">User Profile</emphasis> - tab, include: Profile information, Home information, Business - information. These fields are not required. + <para> + Input values in the <emphasis role="bold">User Profile</emphasis> tab, include: Profile information, Home information, Business information. These fields are not required. </para> <para> - GateIn Portal facilitates users with 4 commonly used languagues: - English, - French, Vietnamese and Arabic in the - <emphasis role="bold">Language</emphasis> - field. You can select one of these languages to work with. + GateIn Portal facilitates users with 4 commonly used languagues: English, French, Vietnamese and Arabic in the <emphasis role="bold">Language</emphasis> field. You can select one of these languages to work with. </para> <mediaobject> <imageobject> - <imagedata fileref="images/UserProfile.png" format="PNG"></imagedata> + <imagedata fileref="images/UserProfile.png" format="PNG" /> </imageobject> </mediaobject> </listitem> <listitem> - <para>Click - <emphasis role="bold">Save</emphasis> - to register a new account or - <emphasis role="bold">Reset</emphasis> - to refresh all entered values. There will be an alert message and - you - can not add a new account if one of these cases occurs: + <para> + Click <emphasis role="bold">Save</emphasis> to register a new account or <emphasis role="bold">Reset</emphasis> to refresh all entered values. There will be an alert message and you can not add a new account if one of these cases occurs: </para> <itemizedlist> <listitem> - <emphasis role="bold">User name</emphasis> - already exists or user name is invalid. + <para> + <emphasis role="bold">User name</emphasis> already exists or user name is invalid. + </para> </listitem> <listitem> - <emphasis role="bold">Password</emphasis> - has less than 6 characters or more than 30 characters. + <para> + <emphasis role="bold">Password</emphasis> has less than 6 characters or more than 30 characters. + </para> </listitem> <listitem> - <emphasis role="bold">Password</emphasis> - and - <emphasis role="bold">Confirm Password</emphasis> - are not the same. + <para> + <emphasis role="bold">Password</emphasis> and <emphasis role="bold">Confirm Password</emphasis> are not the same. + </para> </listitem> <listitem> - <emphasis role="bold">Email Address</emphasis> - format is not valid + <para> + <emphasis role="bold">Email Address</emphasis> format is not valid + </para> </listitem> - <listitem>Required fields are blank (empty).</listitem> + <listitem> + <para> + Required fields are blank (empty). + </para> + </listitem> </itemizedlist> </listitem> </orderedlist> <para> - After adding a new account, you should either contact the - administrator to get more permissions or you are only a visitor user. - <note>You should enter your email address carefully because - when you forget your user name or password, you can recover it by - using this email address.</note> + After adding a new account, you should either contact the administrator to get more permissions or you are only a visitor user. + <note> + <title>Note</title> + <para> + You should enter your email address carefully because when you forget your user name or password, you can recover it by using this email address. + </para> + </note> </para> </section> + + Modified: portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Remember_User_Account"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,38 +21,27 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Remember User Account</title> - <para>This feature allows users to return to the GateIn Portal and be - automatically authenticated based on the value of a cookie provided by - the browser. Thus users do not have to perform an explicit - authentication again.</para> + --><title>Remember User Account</title> + <para> + This feature allows users to return to the GateIn Portal and be automatically authenticated based on the value of a cookie provided by the browser. Thus users do not have to perform an explicit authentication again. + </para> <mediaobject> <imageobject> - <imagedata fileref="images/RememberMe2.6.png" format="PNG"></imagedata> + <imagedata fileref="images/RememberMe2.6.png" format="PNG" /> </imageobject> </mediaobject> <para> - 1. Input your registered - <emphasis role="bold">User name</emphasis> - and - <emphasis role="bold">Password</emphasis> - . + 1. Input your registered <emphasis role="bold">User name</emphasis> and <emphasis role="bold">Password</emphasis> . </para> <para> - 2. Select the - <emphasis role="bold">Remember My Login</emphasis> - check box when logging in GateIn Portal at the first time. + 2. Select the <emphasis role="bold">Remember My Login</emphasis> check box when logging in GateIn Portal at the first time. </para> <para> - 3. Click the - <emphasis role="bold">Sign in</emphasis> - button to sign in the portal. + 3. Click the <emphasis role="bold">Sign in</emphasis> button to sign in the portal. </para> - <para>You must remember escaping the browser without signing out. - The next time, you can automatically sign in the portal without - signing in again with your first/last name welcome.</para> -</section> \ No newline at end of file + <para> + You must remember escaping the browser without signing out. The next time, you can automatically sign in the portal without signing in again with your first/last name welcome. + </para> +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Sign_In_and_Sign_Out"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,140 +21,130 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Sign In and Sign Out</title> - <section> + --><title>Sign In and Sign Out</title> + <section id="sect-User_Guide-Sign_In_and_Sign_Out-Sign_In"> <title>Sign In</title> + <para> + After registering your account, you can easily sign in GateIn Portal to go into your private mode: + </para> + <para> + 1. Go to a Portal in the public mode by inputting URL in the address bar (e.g: http://localhost:8080/portal) + </para> + <para> + 2. Click the <emphasis role="bold">Sign in</emphasis> link at the top right of a page if you are current in the Classic portal. The <emphasis role="bold">Sign in</emphasis> form appears: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SignIn2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 3. Input your registered <emphasis role="bold">User name</emphasis> and <emphasis role="bold">Password</emphasis> . + </para> + <para> + 2. Select the <emphasis role="bold">Remember My Login</emphasis> check box when you sign in GateIn Portal at the first time if you want to automatically return to GateIn Portal without signing in again. You can see <xref linkend="sect-User_Guide-Remember_User_Account" /> for more details. + </para> + <para> + 3.Click the <emphasis role="bold">Sign in</emphasis> button to accept or <emphasis role="bold">Discard</emphasis> to escape the <emphasis role="bold">Sign in</emphasis> form. + </para> + <para> + Details: + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Field </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + User name + </entry> + <entry> + The registered user name. + </entry> + </row> + <row> + <entry> + Password + </entry> + <entry> + The registered password. + </entry> + </row> + <row> + <entry> + Remember My Login + </entry> + <entry> + This option allows users to return to GateIn Portal and be automatically authenticated based on the value of a cookie provided by the browser. Thus users do not have to perform an explicit authentication again. + </entry> + </row> + <row> + <entry> + Forgot your User Name/Password? + </entry> + <entry> + To follow some steps to get the forgotten user name or password. Please refer [Portal:Account and Password Retrieval] for more details. + </entry> + </row> + <row> + <entry> + Sign in + </entry> + <entry> + To sign into GateIn Portal with user name and password. + </entry> + </row> + <row> + <entry> + Discard + </entry> + <entry> + To close the *Sign In* form. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + In case, <emphasis role="bold">User Name</emphasis> does not exist or the inputted User name/Password is invalid, there will be an alert message requires you to input the right value. To login again, you click the <emphasis role="bold">OK</emphasis> button on the alert message and enter <emphasis role="bold">User Name</emphasis> and <emphasis role="bold">Password</emphasis> again. + </para> + <para> + After signing in, you will be redirected to the authenticated homepage: + </para> + <para> + After signing in, you will be redirected to the authenticated homepage and welcomed with your full First Name and Last Name: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PortalHome.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>After registering your account, you can easily sign in GateIn - Portal to go into your private mode:</para> - <para>1. Go to a Portal in the public mode by inputting URL in the - address bar (e.g: http://localhost:8080/portal)</para> - <para> - 2. Click the - <emphasis role="bold">Sign in</emphasis> - link at the top right of a page if you are current in the Classic - portal. The - <emphasis role="bold">Sign in</emphasis> - form appears: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/SignIn2.6.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - 3. Input your registered - <emphasis role="bold">User name</emphasis> - and - <emphasis role="bold">Password</emphasis> - . - </para> - <para> - 2. Select the - <emphasis role="bold">Remember My Login</emphasis> - check box when you sign in GateIn Portal at the first time if you want to - automatically return to GateIn Portal without signing in again. You can - see - <link linkend="Remember User Account">Remember User Account</link> - for more details. - </para> - <para> - 3.Click the - <emphasis role="bold">Sign in</emphasis> - button to accept or - <emphasis role="bold">Discard</emphasis> - to escape the - <emphasis role="bold">Sign in</emphasis> - form. - </para> - <para>Details:</para> - <informaltable frame="none" rowsep="0" colsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Field </emphasis> - </entry> - <entry> - <emphasis role="bold"> Description </emphasis> - </entry> - </row> - <row> - <entry> User name </entry> - <entry> The registered user name. </entry> - </row> - <row> - <entry> Password </entry> - <entry> The registered password. </entry> - </row> - <row> - <entry> Remember My Login </entry> - <entry> This option allows users to return - to GateIn Portal and be automatically authenticated based on the - value of a cookie provided by the browser. Thus users do not have - to perform an explicit authentication again. </entry> - </row> - <row> - <entry> Forgot your User Name/Password? </entry> - <entry> To follow some steps to get the - forgotten user name or password. Please refer [Portal:Account and - Password Retrieval] for more details. </entry> - </row> - <row> - <entry> Sign in </entry> - <entry> To sign into GateIn Portal with user name and password.</entry> - </row> - <row> - <entry> Discard </entry> - <entry> To close the *Sign In* form. </entry> - </row> - </tbody> - </tgroup> - </informaltable> - <para> - In case, - <emphasis role="bold">User Name</emphasis> - does not exist or the inputted User name/Password is invalid, there - will be an alert message requires you to input the right value. To - login again, you click the - <emphasis role="bold">OK</emphasis> - button on the alert message and enter - <emphasis role="bold">User Name</emphasis> - and - <emphasis role="bold">Password</emphasis> - again. - </para> - <para>After signing in, you will be redirected to the - authenticated homepage:</para> - - <para>After signing in, you will be redirected to the - authenticated homepage and welcomed with your full First Name and Last - Name:</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/PortalHome.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Sign_In_and_Sign_Out-Sign_Out"> <title>Sign Out</title> + <para> + This function lets you get back to the anonymous portal. It ends your current portal session. + </para> + <para> + In the upper left corner of the screen, click <emphasis role="bold">Sign out</emphasis> : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SignOut.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This function lets you get back to the anonymous portal. It - ends your current portal session.</para> - <para> - In the upper left corner of the screen, click - <emphasis role="bold">Sign out</emphasis> - : - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/SignOut.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Import_Portlets_and_Gadgets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Import_Portlets_and_Gadgets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Import_Portlets_and_Gadgets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Import_Portlets_and_Gadgets"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,14 +21,36 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Import Portlets and Gadgets</title> + <para> + This convenient feature that helps you import default portlets/gadgets automatically in different categories and these portlets/gadgets will be listed on the left pane. + </para> + <orderedlist numeration="arabic"> + <listitem> + <para> + info("Technical Information about the Portlet Import: The Application Registry looks in all webapps of your application server for a file located at WEB-INF/portlet.xml and registers the portlets found there. When the user clicks on "Auto Import" the portlets of all webapps are imported. If there is a portlet.xml file in a webapp a new category is created whose name is the webapp war name (or the webapp folder name). All the portlets that are configured in the portlet.xml file are added to the new category.") + </para> + </listitem> + </orderedlist> + <para> + 1. Go to <emphasis role="bold">Administration</emphasis>-&gt; <emphasis role="bold">Application Registry</emphasis> page-&gt; <emphasis role="bold">Organize</emphasis> item on the navigation bar. A form for organizing portlets/gadgets will be displayed: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Org1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Click the <emphasis role="bold">Auto Import</emphasis> button!images/Auto1.png! at upper right corner on the action bar. A pop up will be shown: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/local.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Click the <emphasis role="bold">OK</emphasis> button to accept importing gadgets automatically. All portlets/gadgets categories will be imported and listed on the left pane. + </para> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Import Portlets and Gadgets</title> - <para>This convenient feature that helps you import default - portlets/gadgets automatically in different categories and these - portlets/gadgets will be listed on the left pane.</para> - <orderedlist numeration="arabic"> - <listitem>info(&quot;Technical Information about the Portlet Import: The Application Registry looks in all webapps of your application server for a file located at WEB-INF/portlet.xml and registers the portlets found there. When the user clicks on &quot;Auto Import&quot; the portlets of all webapps are imported. If there is a portlet.xml file in a webapp a new category is created whose name is the webapp war name (or the webapp folder name). All the portlets that are configured in the portlet.xml file are added to the new category.&quot;)</listitem></orderedlist><para>1. Go to <emphasis role="bold">Administration</emphasis>-&gt; <emphasis role="bold">Application Registry</emphasis> page-&gt; <emphasis role="bold">Organize</emphasis> item on the navigation bar. A form for organizing portlets/gadgets will be displayed:</para><mediaobject><imageobject><imagedata fileref="images/Org1.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click the <emphasis role=! "bold">Auto Import</emphasis> button!images/Auto1.png! at upper right corner on the action bar. A pop up will be shown:</para><mediaobject><imageobject><imagedata fileref="images/local.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click the <emphasis role="bold">OK</emphasis> button to accept importing gadgets automatically. All portlets/gadgets categories will be imported and listed on the left pane.</para> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,164 +21,139 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Gadgets in User Workspace</title> + --><title>Manage Gadgets in User Workspace</title> <orderedlist numeration="arabic"> - <listitem>gadget is a small convenient application that helps - you perform private actions. GateIn Portal provides you with some - useful gadgets: todo, calendar, calculator and RSS Reader. Besides - using ready-to-use gadgets in your User Workspace. You can easily add - gadgets organized in categories in your User Workspace to meet the - need of your work :</listitem> + <listitem> + <para> + gadget is a small convenient application that helps you perform private actions. GateIn Portal provides you with some useful gadgets: todo, calendar, calculator and RSS Reader. Besides using ready-to-use gadgets in your User Workspace. You can easily add gadgets organized in categories in your User Workspace to meet the need of your work : + </para> + </listitem> </orderedlist> - <section> + <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Add_a_Gadget"> <title>Add a Gadget</title> + <para> + To add a gadget, you can follow these steps: + </para> + <para> + 1. Open the User Workspace on your left pane. + </para> + <para> + 2. Click the tool!images/Tool.png! icon to add a new category + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/UserWorkspace.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Gadget Containers Management</emphasis> dialog appears: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/GadgetManagement.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + Click the add icon !images/AddIcon.png! to show the <emphasis role="bold">Gadget Container Form</emphasis> . + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/GadgetContainer.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Label + </entry> + <entry> + The display name of the category. This field is required and must have at least 3 characters. + </entry> + </row> + <row> + <entry> + Description + </entry> + <entry> + The brief description of the category.A length from 0 to 255 characters is allowed. This field is not required. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + Enter values for fields in the <emphasis role="bold">Gadget Container Form</emphasis> . + </para> + <para> + Click on the <emphasis role="bold">Save</emphasis> button to accept adding a new category or click <emphasis role="bold">Cancel</emphasis> to quit. After you added the new category you will see it in the dialog : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/GadgetManagement1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + Edit the information of an existing category by selecting it from the left pane, the selected category is marked by a symbol. Then click the edit icon to show the edit form. Change the current category information and click on the <emphasis role="bold">button</emphasis> to accept changes. + </para> + <para> + Delete an existing category by selecting it from the left pane. In the message box Click on the <emphasis role="bold">OK</emphasis> button to confirm the deletion or click the <emphasis role="bold">Cancel</emphasis> button. + </para> + <para> + 3. Click on the <emphasis role="bold">Save</emphasis> button in the <emphasis role="bold">Gadget Containers Management</emphasis> dialog to accept or on the <emphasis role="bold">Cancel</emphasis> button to quit. Added categories will be displayed in list in the User Workspace. + </para> + <para> + 4. Click the list icon!images/ListIcon.png! to see category list and select one in list. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/UserWorkspace1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 5. Click the add icon!images/AddIcon1.png! at the bottom of the User Workspace to open the <emphasis role="bold">Add Application</emphasis> dialog: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/AddApplication.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 6. Select a gadget by clicking the add icon !images/PlusIcon.png! that is located next to the the gadget. The selected gadget is displayed immediately in the user workspace. Normally, you can see only two gadgets in the User Workspace. When there are more gadgets, some gadgets are not visible. + </para> + <para> + 7. Click the scroll down icon !images/DownIcon.png!images/ or the scroll up icon!images/ UpIcon.png! at the bottom of the User Workspace to see the other gadgets. If there are no more gadgets to scroll to, the color of the scroll down and scroll up icon switches to gray color. + </para> </section> - <para>To add a gadget, you can follow these steps:</para> - <para>1. Open the User Workspace on your left pane.</para> - <para>2. Click the tool!images/Tool.png! icon to add a new category</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserWorkspace.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - The - <emphasis role="bold">Gadget Containers Management</emphasis> - dialog appears: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/GadgetManagement.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - Click the add icon !images/AddIcon.png! to show the - <emphasis role="bold">Gadget Container Form</emphasis> - . - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/GadgetContainer.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <informaltable frame="none" rowsep="0" colsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Name </emphasis> - </entry> - <entry> - <emphasis role="bold"> Description </emphasis> - </entry> - </row> - <row> - <entry> Label </entry> - <entry> The display name of the category. This field is required - and must have at least 3 characters. </entry> - </row> - <row> - <entry> Description </entry> - <entry> The brief description of the category.A length from 0 to - 255 characters is allowed. This field is not required. </entry> - </row> - </tbody> - </tgroup> - </informaltable> - <para> - Enter values for fields in the - <emphasis role="bold">Gadget Container Form</emphasis> - . - </para> - <para> - Click on the - <emphasis role="bold">Save</emphasis> - button to accept adding a new category or click - <emphasis role="bold">Cancel</emphasis> - to quit. After you added the new category you will see it in the - dialog : - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/GadgetManagement1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - Edit the information of an existing category by selecting it from the - left pane, the selected category is marked by a symbol. Then click the - edit icon to show the edit form. Change the current category - information and click on the - <emphasis role="bold">button</emphasis> - to accept changes. - </para> - <para> - Delete an existing category by selecting it from the left pane. In the - message box Click on the - <emphasis role="bold">OK</emphasis> - button to confirm the deletion or click the - <emphasis role="bold">Cancel</emphasis> - button. - </para> - <para> - 3. Click on the - <emphasis role="bold">Save</emphasis> - button in the - <emphasis role="bold">Gadget Containers Management</emphasis> - dialog to accept or on the - <emphasis role="bold">Cancel</emphasis> - button to quit. Added categories will be displayed in list in the User - Workspace. - </para> - <para>4. Click the list icon!images/ListIcon.png! to see category - list and select one in list.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserWorkspace1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - 5. Click the add icon!images/AddIcon1.png! at the bottom of the User - Workspace to open the - <emphasis role="bold">Add Application</emphasis> - dialog: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/AddApplication.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>6. Select a gadget by clicking the add icon - !images/PlusIcon.png! that is located next to the the gadget. The - selected gadget is displayed immediately in the user workspace. - Normally, you can see only two gadgets in the User Workspace. When - there are more gadgets, some gadgets are not visible.</para> - <para>7. Click the scroll down icon !images/DownIcon.png!images/ or - the scroll up icon!images/ UpIcon.png! at the bottom of the User - Workspace to see the other gadgets. If there are no more gadgets to - scroll to, the color of the scroll down and scroll up icon switches to - gray color.</para> - <section> + + <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Edit_a_Gadget"> <title>Edit a Gadget</title> + <para> + To edit a gadget, click !images/EditIcon.png! icon. + </para> </section> - <para>To edit a gadget, click !images/EditIcon.png! icon.</para> - <section> + + <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Remove_a_Gadget"> <title>Remove a Gadget</title> + <para> + Remove a gadget from the User Workspace by using the functional bar!images/FunctionBar.png! at the upper right corner of that gadget. + </para> + <para> + Click the remove icon !images/RemoveIcon.png! . When the confirmation message appears, click the <emphasis role="bold">OK</emphasis> button to accept or the <emphasis role="bold">Cancel</emphasis> to quit. + </para> </section> - <para>Remove a gadget from the User Workspace by using the - functional bar!images/FunctionBar.png! at the upper right corner of - that gadget.</para> - <para> - Click the remove icon !images/RemoveIcon.png! . When the confirmation - message appears, click the - <emphasis role="bold">OK</emphasis> - button to accept or the - <emphasis role="bold">Cancel</emphasis> - to quit. - </para> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,6 +1,9 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Portlets_and_Gadgets"> + <!-- - <!-- - Copyright (C) 2009 eXo Platform SAS. This is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; @@ -13,254 +16,407 @@ this software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. - --> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Portlets and Gadgets</title> - <section> + --><title>Manage Portlets and Gadgets</title> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Introduction"> <title>Introduction</title> <para> - Portlets and gadgets are organized in different categories. Each - category contains one or several portlets or gadgets. You can also - mix - portlets and gadgets into one category. By default all gadgets are - placed in the - <emphasis>ExoGadgets</emphasis> - category. + Portlets and gadgets are organized in different categories. Each category contains one or several portlets or gadgets. You can also mix portlets and gadgets into one category. By default all gadgets are placed in the <emphasis>ExoGadgets</emphasis> category. </para> </section> - <section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Category"> <title>Add a new Category</title> + <para> + You easily add a new category by following these guides: + </para> + <para> + Go to <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Application Registry</emphasis> page -&gt; <emphasis role="bold">Organize</emphasis> item. + </para> + <para> + 1. Open a form to add a new category on the right pane by clicking the <emphasis role="bold">Add Category</emphasis> button on the action bar: + <mediaobject> + <imageobject> + <imagedata fileref="images/AddCategory1.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> + <para> + The <emphasis role="bold">Category Setting</emphasis> tab: includes common information about a category. + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Category name + </entry> + <entry> + The name of the category which you want to add. This field is required and its length must be between 3 and 30 characters. + </entry> + </row> + <row> + <entry> + Display name + </entry> + <entry> + The display name of the category in list and its length must be between 3 and 30 characters. + </entry> + </row> + <row> + <entry> + Description + </entry> + <entry> + A brief description of the category. Any length from 0 to 255 characters is allowed. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + The <emphasis role="bold">Permission Setting</emphasis> tab: used to set the access permission for a category. + </para> + <figure id="figu-User_Guide-Add_a_new_Category-info_This_access_permission_enters_the_game_whenever_a_user_creates_or_modifies_a_page._In_that_moment_the_user_only_can_see_and_use_portlets_in_those_categories_on_which_he_or_she_has_access_permission_defined_by_groups_and_memberships._info"> + <title>{info} This access permission enters the game whenever a user creates or modifies a page. In that moment the user only can see and use portlets in those categories on which he or she has access permission (defined by groups and memberships). {info}</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Permission2.png" format="PNG" /> + </imageobject> + </mediaobject> + </figure> + <para> + 2. Enter values for required fields in this form. + </para> + <para> + 3. Click the <emphasis role="bold">Save</emphasis> button to accept adding a new category into a category list. The new category will be added into a list on the left pane. + </para> </section> - <para>You easily add a new category by following these guides:</para> - <para> - Go to - <emphasis role="bold">Administration</emphasis> - -&gt; - <emphasis role="bold">Application Registry</emphasis> - page -&gt; <emphasis role="bold">Organize</emphasis> item. + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Edit_a_Category"> + <title>Edit a Category</title> + <para> + You can edit a category in list by following: </para> - <para>1. Open a form to add a new category on the right pane by clicking the - <emphasis role="bold">Add Category</emphasis> button on the action bar: + <para> + 1. Click the edit icon!images/EditIcon1.png! on the title bar of a category that you want to edit. + </para> + <para> + 2. Change the information of the selected category. + </para> + <para> + 3. Click the <emphasis role="bold">Save</emphasis> button to accept changes. + </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Delete_a_Category"> + <title>Delete a Category</title> + <para> + You also easily remove a category from a list: + </para> + <para> + 1. Click the trash can icon!images/DeleteIcon.png! on the Title bar of the category that you want to delete. + </para> + <para> + 2. Click on the <emphasis role="bold">OK</emphasis> button on the message to accept deleting or click on the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_PortletsGadgets_to_the_specific_Category"> + <title>Add Portlets/Gadgets to the specific Category</title> + <para> + You can follow these steps to add a portlet/gadget to your prefered category : + </para> + <para> + 1. Click the "add" icon!images/AddIcon.png! on the title bar of a category to which you want to add portlets. An interface will appear in the right pane as you can see below: + <mediaobject> + <imageobject> + <imagedata fileref="images/AddPortlet2.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="left"></colspec> + <colspec align="left"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold">Name</emphasis> + </entry> + <entry> + <emphasis role="bold">Description</emphasis> + </entry> + </row> + <row> + <entry> + Display name + </entry> + <entry> + The display name of a portlet/gadget that you want to add to a category. + </entry> + </row> + <row> + <entry> + Application Type + </entry> + <entry> + the type of selected object. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + 2. Enter the display name and select a type for the selected portlet/gadget. + </para> + <para> + 3. Select a portlet/gadget by checking the radio button. + </para> + <para> + 4. Click the <emphasis role="bold">Save</emphasis> button to accept adding a portlet/gadget to a category. + </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Set_Access_Permission_on_Portlets"> + <title>Set Access Permission on Portlets</title> + <para> + You easily set an access permission on a portlet by following these guides: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigations</emphasis> -&gt; select <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Application Registry</emphasis> + <mediaobject> + <imageobject> + <imagedata fileref="images/PortletPermission.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> + <para> + 2. Select a category on the left pane that includes the portlet you want to set right. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane. + </para> + <para> + 3. To set permission for a portlet: + <itemizedlist> + <listitem> + <para> + Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups. + </para> + </listitem> + <listitem> + <para> + Or check the <emphasis role="bold">Make it public</emphasis> check box to allow everyone to access. + </para> + </listitem> + </itemizedlist> + Whenever the user creates or modifies a page he or she can only see and use portlets that fulfill two conditions: the portlet is in a <emphasis role="bold">category</emphasis> on which the user has access permission (see category section above) and the user has access permission on the <emphasis role="bold">portlet</emphasis> + </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-View_detail_information_of_the_specific_Portlets"> + <title>View detail information of the specific Portlets</title> + <para> + You easily view detail information of all specific portlets by following these guides: + </para> + <para> + 1. On the navigation bar, go to the <emphasis role="bold">Administration</emphasis>-&gt; <emphasis role="bold">Application Registry</emphasis> page-&gt; <emphasis role="bold">Portlet</emphasis> item . A form to view all portlets will appear: + </para> <mediaobject> - <imageobject> - <imagedata fileref="images/AddCategory1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - </para> - <para>The <emphasis role="bold">Category Setting</emphasis> tab: includes common information about a category.</para> - <informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Category name </entry><entry> The name of the category which you want to add. This field is required and its length must be between 3 and 30 characters. </entry></row><row><entry> Display name </entry><entry> The display name of the category in list and its length must be between 3 and 30 characters. </entry></row><row><entry> Description </entry><entry> A brief description of the category. Any length from 0 to 255 characters is allowed. </entry></row></tbody></tgroup></informaltable><para>The <emphasis role="bold">Permission Setting</emphasis> tab: used to set the access permission for a category.</para><figure><title>{info} This access permission enters the game whenever a user creates! or modifies a page. In that moment the user only can see and use portlets in those categories on which he or she has access permission (defined by groups and memberships). {info}</title><mediaobject><imageobject><imagedata fileref="images/Permission2.png" format="PNG"></imagedata></imageobject></mediaobject></figure><para>2. Enter values for required fields in this form.</para><para>3. Click the <emphasis role="bold">Save</emphasis> button to accept adding a new category into a category list. The new category will be added into a list on the left pane.</para> -<section> - <title>Edit a Category</title> - <para>You can edit a category in list by following:</para><para>1. Click the edit icon!images/EditIcon1.png! on the title bar of a category that you want to edit.</para><para>2. Change the information of the selected category.</para><para>3. Click the <emphasis role="bold">Save</emphasis> button to accept changes.</para> -</section> -<section><title>Delete a Category</title> -<para>You also easily remove a category from a list:</para><para>1. Click the trash can icon!images/DeleteIcon.png! on the Title bar of the category that you want to delete.</para><para>2. Click on the <emphasis role="bold">OK</emphasis> button on the message to accept deleting or click on the <emphasis role="bold">Cancel</emphasis> button to quit.</para> -</section> -<section><title>Add Portlets/Gadgets to the specific Category</title> -<para>You can follow these steps to add a portlet/gadget to your prefered category :</para> -<para>1. Click the &quot;add&quot; icon!images/AddIcon.png! on the title bar of a category to which you want to add portlets. An interface will appear in the right pane as you can see below: - <mediaobject><imageobject><imagedata fileref="images/AddPortlet2.png" format="PNG"></imagedata></imageobject></mediaobject> - <informaltable frame="none" rowsep="0" colsep="0"> - <tgroup cols="2"> - <colspec align="left"></colspec> - <colspec align="left"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold">Name</emphasis> - </entry> - <entry> - <emphasis role="bold">Description</emphasis> - </entry> - </row> - <row> - <entry>Display name</entry> - <entry>The display name of a portlet/gadget that you want to add to a category.</entry> - </row> - <row> - <entry>Application Type</entry> - <entry>the type of selected object.</entry> - </row></tbody></tgroup></informaltable> - </para> - <para>2. Enter the display name and select a type for the selected portlet/gadget.</para><para>3. Select a portlet/gadget by checking the radio button.</para><para>4. Click the <emphasis role="bold">Save</emphasis> button to accept adding a portlet/gadget to a category.</para> -</section> -<section> - <title>Set Access Permission on Portlets</title> - <para>You easily set an access permission on a portlet by following - these guides:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Page Navigations</emphasis> -&gt; select <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Application Registry</emphasis> -<mediaobject><imageobject><imagedata fileref="images/PortletPermission.png" format="PNG"></imagedata></imageobject></mediaobject></para> -<para>2. Select a category on the left pane that includes the portlet you want to set right. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane.</para> -<para>3. To set permission for a portlet: - <itemizedlist> - <listitem>Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups.</listitem> - <listitem>Or check the <emphasis role="bold">Make it public</emphasis> check box to allow everyone to access.</listitem> - </itemizedlist> - Whenever the user creates or modifies a page he or she can only see and use portlets that fulfill two conditions: - the portlet is in a <emphasis role="bold">category</emphasis> on which the user has access permission (see category section above) and the user has access permission on the <emphasis role="bold">portlet</emphasis></para> -</section> -<section> - <title>View detail information of the specific Portlets</title> - <para>You easily view detail information of all specific portlets by - following these guides:</para> - <para> - 1. On the navigation bar, go to the - <emphasis role="bold">Administration</emphasis>-&gt; <emphasis role="bold">Application Registry</emphasis> page-&gt; <emphasis role="bold">Portlet</emphasis> item . A form to view all portlets will appear:</para><mediaobject><imageobject><imagedata fileref="images/Portlet.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Left pane </entry><entry> lists all portlets in two parts: Local and Remote </entry></row><row><entry> Right pane </entry><entry> shows detail information about a portlet: Name, Display name, Description and Portlet preferences. </entry></row></tbody></tgroup></informaltable><para>2. Select one portlet in the list on the left pane. The detail information of that portlet a! ppears on the right pane.</para> -</section> -<section> - <title>Add a Gadget</title> - <para>You can follow these steps to add a gadget to the gadget list - :</para> - <para> - 1. Go to the - <emphasis role="bold">Administration</emphasis> - --&gt; <emphasis role="bold">Application Registry</emphasis> and click on <emphasis role="bold">Gadget</emphasis> :</para><mediaobject><imageobject><imagedata fileref="images/Gadgetnew.png" format="PNG"></imagedata></imageobject></mediaobject><para>There are two ways to add gadgets:</para> -</section> -<section> - <title>Add a remote Gadget</title> - <para> - 1. Open the form to add a remote gadget by clicking - <emphasis role="bold">Add a remote gadget</emphasis> - : - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/AddGadgetnew.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - 2. Enter a link to an .xml file in the - <emphasis role="bold">URL</emphasis> - field. - </para> - <para> - 3. Click on the - <emphasis role="bold">Add</emphasis> - button to accept the entered URL or on the - <emphasis role="bold">Cancel</emphasis> - button to quit. The added gadget will be added into gadget list on - left pane of the Dashboard portlet. - </para> -</section> - <section> - <title>Create a new Gadget</title> + <imageobject> + <imagedata fileref="images/Portlet.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Left pane + </entry> + <entry> + lists all portlets in two parts: Local and Remote + </entry> + </row> + <row> + <entry> + Right pane + </entry> + <entry> + shows detail information about a portlet: Name, Display name, Description and Portlet preferences. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> <para> - 1. Show the form to add a new gadget by clicking - <emphasis role="bold">Create a new gadget</emphasis> - : + 2. Select one portlet in the list on the left pane. The detail information of that portlet appears on the right pane. </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_Gadget"> + <title>Add a Gadget</title> + <para> + You can follow these steps to add a gadget to the gadget list : + </para> + <para> + 1. Go to the <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Application Registry</emphasis> and click on <emphasis role="bold">Gadget</emphasis> : + </para> <mediaobject> <imageobject> - <imagedata fileref="images/CreateGadget1.png" format="PNG"></imagedata> + <imagedata fileref="images/Gadgetnew.png" format="PNG" /> </imageobject> </mediaobject> - <para>Source: The source code to create a new gadget. This - source will be a .xml file.</para> <para> - 2. Enter a value for the - <emphasis role="bold">Source</emphasis> - field in this form. + There are two ways to add gadgets: </para> + </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_remote_Gadget"> + <title>Add a remote Gadget</title> <para> - 3. Click the - <emphasis role="bold">Save</emphasis> - button to create a new gadget. The created gadget will be added to - the gadget list on the left pane of the Dashboard Portlet. + 1. Open the form to add a remote gadget by clicking <emphasis role="bold">Add a remote gadget</emphasis> : </para> - <para>You also edit, refresh and delete a local gadget as well as a - remote gadget:</para> <mediaobject> <imageobject> - <imagedata fileref="images/ActionGadget.png" format="PNG"></imagedata> + <imagedata fileref="images/AddGadgetnew.png" format="PNG" /> </imageobject> </mediaobject> + <para> + 2. Enter a link to an .xml file in the <emphasis role="bold">URL</emphasis> field. + </para> + <para> + 3. Click on the <emphasis role="bold">Add</emphasis> button to accept the entered URL or on the <emphasis role="bold">Cancel</emphasis> button to quit. The added gadget will be added into gadget list on left pane of the Dashboard portlet. + </para> </section> - <section> - <title>Add a new Gadget to the Dashboard Portlet</title> - <para>You can add a new gadget to the gadget list in the Dashboard - portlet :</para> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Create_a_new_Gadget"> + <title>Create a new Gadget</title> <para> - 1. Go to the Dashboard on the navigation bar. Click on the - <emphasis role="bold">Add Gadgets</emphasis> - link : + 1. Show the form to add a new gadget by clicking <emphasis role="bold">Create a new gadget</emphasis> : </para> <mediaobject> <imageobject> - <imagedata fileref="images/Add.png" format="PNG"></imagedata> + <imagedata fileref="images/CreateGadget1.png" format="PNG" /> </imageobject> </mediaobject> - <orderedlist numeration="arabic"> - <listitem>dialog to add a new gadget will appear :</listitem> - </orderedlist> + <para> + Source: The source code to create a new gadget. This source will be a .xml file. + </para> + <para> + 2. Enter a value for the <emphasis role="bold">Source</emphasis> field in this form. + </para> + <para> + 3. Click the <emphasis role="bold">Save</emphasis> button to create a new gadget. The created gadget will be added to the gadget list on the left pane of the Dashboard Portlet. + </para> + <para> + You also edit, refresh and delete a local gadget as well as a remote gadget: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/Add3.png" format="PNG"></imagedata> + <imagedata fileref="images/ActionGadget.png" format="PNG" /> </imageobject> </mediaobject> - <para>2. Enter a link (a .xml file or RSS) in the text box on the - left pane.</para> - <para>3. Click on the icon!images/PlusIcon.png! to add a new gadget - to the gadget list beneath.</para> </section> -<section> - <title>Manage Gadgets</title> - <section> - <title>Edit a Gadget</title> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Gadget_to_the_Dashboard_Portlet"> + <title>Add a new Gadget to the Dashboard Portlet</title> <para> - 1. Click the edit icon!images/EditGadget.png! . It will display a - dialog: - <mediaobject> - <imageobject> - <imagedata fileref="images/Source.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> + You can add a new gadget to the gadget list in the Dashboard portlet : </para> <para> - 2. After editing , click the - <emphasis role="bold">Save</emphasis> - button to accept changing or - <emphasis role="bold">Cancel</emphasis> - button to quit. + 1. Go to the Dashboard on the navigation bar. Click on the <emphasis role="bold">Add Gadgets</emphasis> link : </para> - </section> - <section> - <title>Refresh a Gadget</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Add.png" format="PNG" /> + </imageobject> + </mediaobject> <para> - <itemizedlist> - <listitem>Local gadget: After editing information about the - gadget that you want to, click the icon!images/Refresh.png! to - refresh all information of that gadget.</listitem> - <listitem>Remote gadget: When information of a remote gadget - has been changed by another server, click the - icon!images/Refresh.png! means it will update information of a - remote gadget from that server.</listitem> - </itemizedlist> + The dialog to add a new gadget will appear : </para> - </section> - <section> - <title>Delete a Gadget</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Add3.png" format="PNG" /> + </imageobject> + </mediaobject> <para> - 1. Click the trash can icon!images/DeleteGadget.png! on the row of - the gadget that you want to delete. It will display an alert message - : - <mediaobject> - <imageobject> - <imagedata fileref="images/Delete.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> + 2. Enter a link (a .xml file or RSS) in the text box on the left pane. </para> <para> - 2. Click the - <emphasis role="bold">OK</emphasis> - button to accept deleting or - <emphasis role="bold">Cancel</emphasis> - button to quit without deleting. + 3. Click on the icon!images/PlusIcon.png! to add a new gadget to the gadget list beneath. </para> </section> + + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Manage_Gadgets"> + <title>Manage Gadgets</title> + <section id="sect-User_Guide-Manage_Gadgets-Edit_a_Gadget"> + <title>Edit a Gadget</title> + <para> + 1. Click the edit icon!images/EditGadget.png! . It will display a dialog: + <mediaobject> + <imageobject> + <imagedata fileref="images/Source.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> + <para> + 2. After editing , click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </section> + + <section id="sect-User_Guide-Manage_Gadgets-Refresh_a_Gadget"> + <title>Refresh a Gadget</title> + <para> + <itemizedlist> + <listitem> + <para> + Local gadget: After editing information about the gadget that you want to, click the icon!images/Refresh.png! to refresh all information of that gadget. + </para> + </listitem> + <listitem> + <para> + Remote gadget: When information of a remote gadget has been changed by another server, click the icon!images/Refresh.png! means it will update information of a remote gadget from that server. + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="sect-User_Guide-Manage_Gadgets-Delete_a_Gadget"> + <title>Delete a Gadget</title> + <para> + 1. Click the trash can icon!images/DeleteGadget.png! on the row of the gadget that you want to delete. It will display an alert message : + <mediaobject> + <imageobject> + <imagedata fileref="images/Delete.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> + <para> + 2. Click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting. + </para> + </section> + + </section> + </section> -</section> + + Modified: portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Change_Interface_Language"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,32 +21,176 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Change Interface Language</title> - <para>GateIn Portal provides users with the most familiar interface - language to work with and perform all actions efficiently. The - priority of the interface language is 1. User's language 2. Browser's - language 3. Portal 's language. Thus to display your prefer language, - you should pay attention to this order to change the language type - appropriately.</para> - <para>You can change the interface language permanently by three - ways :</para> - <section> + --><title>Change Interface Language</title> + <para> + GateIn Portal provides users with the most familiar interface language to work with and perform all actions efficiently. The priority of the interface language is 1. User's language 2. Browser's language 3. Portal 's language. Thus to display your prefer language, you should pay attention to this order to change the language type appropriately. + </para> + <para> + You can change the interface language permanently by three ways : + </para> + <section id="sect-User_Guide-Change_Interface_Language-The_1st_way"> <title>The 1^st^ way</title> + <para> + This way supports you to change the interface language of the current Portal. + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis>. + </para> + <para> + 2. Click !images/EditIcon.png! icon to edit portal's properties. + </para> + <para> + 3. In the <emphasis role="bold">Portal Setting</emphasis> tab: You can change display language of Portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field. + </para> + <para> + 4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/FinishIcon.png! icon to take affect. + </para> + <para> + For Portal 2.6 + </para> + <para> + You easily change the interface language of the current Portal by following guides: + </para> + <para> + 1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar --&gt; click <emphasis role="bold">Edit Page</emphasis>. The <emphasis role="bold">Edit Inline Composer</emphasis> popup will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditInline.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Click on <emphasis role="bold">Portal Properties</emphasis> to edit portal's properties. + </para> + <para> + 3. In the <emphasis role="bold">Portal Setting</emphasis> tab: You can change display language of Portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field. + </para> + <para> + 4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/DiskIcon.png! icon to take affect. + </para> </section> - <para>This way supports you to change the interface language of the - current Portal.</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis>.</para><para>2. Click !images/EditIcon.png! icon to edit portal's properties.</para><para>3. In the <emphasis role="bold">Portal Setting</emphasis> tab: You can change display language of Portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field.</para><para>4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/FinishIcon.png! icon to take affect.</para><variablelist><listitem>For Portal 2.6</listitem></variablelist><para>You easily change the interface language of the current Portal by following guides:</para><para>1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar --&gt; click <emphasis role="bold">Edit Page</emphasis>. The <emphasis role="bold">Edit Inline Composer</emphasis> popup will appear:</para><mediaobject><image! object><imagedata fileref="images/EditInline.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click on <emphasis role="bold">Portal Properties</emphasis> to edit portal's properties.</para><para>3. In the <emphasis role="bold">Portal Setting</emphasis> tab: You can change display language of Portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field.</para><para>4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/DiskIcon.png! icon to take affect.</para> -<section><title>The 2^nd^ way</title></section> -<para>If you can access GateIn Start, you can do this way to set interface language for yourself, not for interface language of Portal by these following steps:</para><para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Language Settings</emphasis></para><mediaobject><imageobject><imagedata fileref="images/InterfaceLanguage.png" format="PNG"></imagedata></imageobject></mediaobject><para>The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked by!images/MarkedIcon.png! icon.</para><para>2. Select another one by clicking on the name of language.</para><para>3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect.</para><variablelist><listitem>For Portal 2.6</listitem></variablelist><para>You can set the interface language for yourself by follo! wing guides:</para><para>1. Go to GateIn on the Toolbar --&gt; click <emphasis role="bold">Change Language</emphasis></para><mediaobject><imageobject><imagedata fileref="images/InterfaceLanguage2.6.png" format="PNG"></imagedata></imageobject></mediaobject><para>The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked by!images/MarkedIcon.png! icon.</para><para>2. Select another one by clicking on the name of language.</para><para>3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect.</para> -<section><title>The 3^rd^ way</title></section> -<para>You also set interface language for yourself, not for interface language of the Portal by this way.</para><para>1. Click <emphasis role="bold">Change Language</emphasis> on the right corner to show the <emphasis role="bold">Interface Language Setting</emphasis> form:</para><mediaobject><imageobject><imagedata fileref="images/Root1.png" format="PNG"></imagedata></imageobject></mediaobject><para>The <emphasis role="bold">Interface Language Setting</emphasis> form will appear:</para><mediaobject><imageobject><imagedata fileref="images/InterfaceLanguage.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Select another language in list. The selected language will be marked by !images/MarkedIcon.png! icon.</para><para>3. Click the <emphasis role="bold">Apply</emphasis> button to change the interface language and wait for few seconds to take affect or click the <emphasis role="bold">Cancel</emphasis> button to quit without changes.</para> -<section><title>Set language for a user</title></section> -<para>There are two modes to set displaying language for a user.</para><itemizedlist><listitem><emphasis role="bold">Public Mode</emphasis>: Displaying language of this mode depends on the language of browser that you are using.</listitem></itemizedlist><itemizedlist><listitem>If you set language of browser that Portal does not support, the displaying language will be the language of Portal.</listitem><listitem>If you set language of browser that Portal supports, the displaying language will be the language of browser.</listitem></itemizedlist><itemizedlist><listitem><emphasis role="bold">Private Mode</emphasis>: Displaying language of this mode belongs to the language of each user which is set when registering.</listitem></itemizedlist><itemizedlist><listitem>When you sign in by a default account (root, john, demo, marry): the displaying language of these users are none, so it will belong to browser's language. If you change value in the <emphasis role="bold">Language</emp! hasis> field in the <emphasis role="bold">User Profile</emphasis> tab (only default user: root and john can change this value by access 'Management' page: Go to <emphasis role="bold">Organization</emphasis>--&gt; <emphasis role="bold">Management</emphasis> page), your displaying language will be the set value. Your displaying language has also directly affect when you change language by other ways.</listitem><listitem>When you sign in by a new registered user: by default, your displaying language is English. However, if you set by another language in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab when you register a new account, your displaying language is the set language.</listitem></itemizedlist> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Change_Interface_Language-The_2nd_way"> + <title>The 2^nd^ way</title> + <para> + If you can access GateIn Start, you can do this way to set interface language for yourself, not for interface language of Portal by these following steps: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Language Settings</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InterfaceLanguage.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked by!images/MarkedIcon.png! icon. + </para> + <para> + 2. Select another one by clicking on the name of language. + </para> + <para> + 3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect. + </para> + <para> + For Portal 2.6 + </para> + <para> + You can set the interface language for yourself by following guides: + </para> + <para> + 1. Go to GateIn on the Toolbar --&gt; click <emphasis role="bold">Change Language</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InterfaceLanguage2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked by!images/MarkedIcon.png! icon. + </para> + <para> + 2. Select another one by clicking on the name of language. + </para> + <para> + 3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect. + </para> + </section> + + <section id="sect-User_Guide-Change_Interface_Language-The_3rd_way"> + <title>The 3^rd^ way</title> + <para> + You also set interface language for yourself, not for interface language of the Portal by this way. + </para> + <para> + 1. Click <emphasis role="bold">Change Language</emphasis> on the right corner to show the <emphasis role="bold">Interface Language Setting</emphasis> form: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Root1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Interface Language Setting</emphasis> form will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InterfaceLanguage.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Select another language in list. The selected language will be marked by !images/MarkedIcon.png! icon. + </para> + <para> + 3. Click the <emphasis role="bold">Apply</emphasis> button to change the interface language and wait for few seconds to take affect or click the <emphasis role="bold">Cancel</emphasis> button to quit without changes. + </para> + </section> + + <section id="sect-User_Guide-Change_Interface_Language-Set_language_for_a_user"> + <title>Set language for a user</title> + <para> + There are two modes to set displaying language for a user. + </para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">Public Mode</emphasis>: Displaying language of this mode depends on the language of browser that you are using. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + If you set language of browser that Portal does not support, the displaying language will be the language of Portal. + </para> + </listitem> + <listitem> + <para> + If you set language of browser that Portal supports, the displaying language will be the language of browser. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">Private Mode</emphasis>: Displaying language of this mode belongs to the language of each user which is set when registering. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + When you sign in by a default account (root, john, demo, marry): the displaying language of these users are none, so it will belong to browser's language. If you change value in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab (only default user: root and john can change this value by access 'Management' page: Go to <emphasis role="bold">Organization</emphasis>--&gt; <emphasis role="bold">Management</emphasis> page), your displaying language will be the set value. Your displaying language has also directly affect when you change language by other ways. + </para> + </listitem> + <listitem> + <para> + When you sign in by a new registered user: by default, your displaying language is English. However, if you set by another language in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab when you register a new account, your displaying language is the set language. + </para> + </listitem> + </itemizedlist> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Internationalization_Portlet"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,127 +21,110 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Internationalization Portlet</title> - <para>This portlet is used to define a word or a phrase of the - current language to an expected language. The form of this portlet is - like:</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Inter2.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>Each resource supports a language. So, you can define a word - or a phrase according to the supported language.</para> - <section> - <title>Add a new Resource</title> - </section> + --><title>Internationalization Portlet</title> <para> - 1. Select the - <emphasis role="bold">New Resource</emphasis> - button in the - <emphasis role="bold">Internationalization - Portlet</emphasis> - form. The - <emphasis role="bold">Resource Data</emphasis> - form will appear: + This portlet is used to define a word or a phrase of the current language to an expected language. The form of this portlet is like: </para> <mediaobject> <imageobject> - <imagedata fileref="images/ResourceData1.png" format="PNG"></imagedata> + <imagedata fileref="images/Inter2.png" format="PNG" /> </imageobject> </mediaobject> - <informaltable frame="none" rowsep="0" colsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Name </emphasis> - </entry> - <entry> - <emphasis role="bold"> Description </emphasis> - </entry> - </row> - <row> - <entry> Name </entry> - <entry> The name of Resource. This field is required. </entry> - </row> - <row> - <entry> Language </entry> - <entry> The language that this resource 'll support. This field is - required. </entry> - </row> - <row> - <entry> Resource </entry> - <entry> The word or the phrase which you want to define. </entry> - </row> - </tbody> - </tgroup> - </informaltable> - <para>2. Enter values into required fields.</para> <para> - 3. Click the - <emphasis role="bold">Save</emphasis> - button to accept adding a new resource or the - <emphasis role="bold">Cancel</emphasis> - button to quit. + Each resource supports a language. So, you can define a word or a phrase according to the supported language. </para> - <section> + <section id="sect-User_Guide-Internationalization_Portlet-Add_a_new_Resource"> + <title>Add a new Resource</title> + <para> + 1. Select the <emphasis role="bold">New Resource</emphasis> button in the <emphasis role="bold">Internationalization Portlet</emphasis> form. The <emphasis role="bold">Resource Data</emphasis> form will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ResourceData1.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Name + </entry> + <entry> + The name of Resource. This field is required. + </entry> + </row> + <row> + <entry> + Language + </entry> + <entry> + The language that this resource 'll support. This field is required. + </entry> + </row> + <row> + <entry> + Resource + </entry> + <entry> + The word or the phrase which you want to define. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + 2. Enter values into required fields. + </para> + <para> + 3. Click the <emphasis role="bold">Save</emphasis> button to accept adding a new resource or the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </section> + + <section id="sect-User_Guide-Internationalization_Portlet-View_and_Edit_a_Resource"> <title>View and Edit a Resource</title> + <para> + Click the magnifying icon !images/GlassIcon.png! corresponding to resource which you want to view. On the view form, you also can edit information again by clicking the <emphasis role="bold">Edit</emphasis> button. You only can change <emphasis role="bold">Resource</emphasis> field, then click the <emphasis role="bold">Save</emphasis> button to accept changes or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any changes. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Resource2.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para> - Click the magnifying icon !images/GlassIcon.png! corresponding to - resource which you want to view. On the view form, you also can edit - information again by clicking the - <emphasis role="bold">Edit</emphasis> - button. You only can change - <emphasis role="bold">Resource</emphasis> - field, then click the - <emphasis role="bold">Save</emphasis> - button to accept changes or click the - <emphasis role="bold">Cancel</emphasis> - button to quit without saving any changes. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Resource2.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Internationalization_Portlet-Delete_a_Resource"> <title>Delete a Resource</title> + <para> + Click the trash can icon!images/DeleIcon.png! corresponding to the resource which you want to delete. There 'll be a confirmation message, click the <emphasis role="bold">OK</emphasis> button to confirm deleting and the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> </section> - <para> - Click the trash can icon!images/DeleIcon.png! corresponding to the - resource which you want to delete. There 'll be a confirmation - message, click the - <emphasis role="bold">OK</emphasis> - button to confirm deleting and the - <emphasis role="bold">Cancel</emphasis> - button to quit. - </para> - <section> + + <section id="sect-User_Guide-Internationalization_Portlet-Search_a_Resource"> <title>Search a Resource</title> + <para> + The <emphasis role="bold">Search Resource</emphasis> form displays directly on the portlet: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Resource3.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + Enter the name of the resource which you want to search and select the supported language. Click the <emphasis role="bold">Search</emphasis> button to perform searching and displaying a list of the expected Resource. + </para> </section> - <para> - The - <emphasis role="bold">Search Resource</emphasis> - form displays directly on the portlet: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Resource3.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - Enter the name of the resource which you want to search and select the - supported language. Click the - <emphasis role="bold">Search</emphasis> - button to perform searching and displaying a list of the expected - Resource. - </para> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Multi_Language_Navigation_Nodes"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,56 +21,270 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Multi-Language Navigation Nodes</title> - <section> + --><title>Multi-Language Navigation Nodes</title> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Overview"> <title>Overview</title> + <para> + Exo Portal supports a multi-language environment for your portal. You can internationalize any menu entry on the navigation. As the navigation bar is composed by nodes so you have to modify the display names of the nodes. Instead of entering the display name in English you have to use a so called resource key. This resource key is used to define the label that is shown on the navigation bar, the menu, and the breadcrumb. + </para> </section> - <para>Exo Portal supports a multi-language environment for your - portal. You can internationalize any menu entry on the navigation. As - the navigation bar is composed by nodes so you have to modify the - display names of the nodes. Instead of entering the display name in - English you have to use a so called resource key. This resource key is - used to define the label that is shown on the navigation bar, the - menu, and the breadcrumb.</para> - <section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Key_Format"> <title>Key Format</title> + <para> + The resource key format is: <emphasis role="bold">#{key}</emphasis> + </para> + <para> + The resource key is the can contain any text that you consider to be fine. It should be human-readable and must not contain spaces. + </para> </section> - <para> - The resource key format is: - <emphasis role="bold">#{key}</emphasis> - </para> - <para>The resource key is the can contain any text that you consider - to be fine. It should be human-readable and must not contain spaces.</para> - <section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys"> <title>Creating Keys</title> + <para> + There are three ways to create a key for a node: using the <emphasis role="bold">Create Page Wizard</emphasis> or using the <emphasis role="bold">Edit Page Wizard</emphasis> or the <emphasis role="bold">Edit Page and Navigation</emphasis> dialog. + </para> </section> - <para> - There are three ways to create a key for a node: using the - <emphasis role="bold">Create Page Wizard</emphasis> - or using the - <emphasis role="bold">Edit Page Wizard</emphasis> - or the - <emphasis role="bold">Edit Page and Navigation</emphasis> - dialog. - </para> - <section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys_using_the_Create_Page_Wizard"> <title>Creating Keys using the *Create Page Wizard*</title> + <para> + You can follow these steps: + </para> + <procedure> + <step> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Create Page Wizard</emphasis> + </para> + </step> + <step> + <para> + 2. Click <emphasis role="bold">Next</emphasis> to move to step 1 + </para> + </step> + <step> + <para> + 3. At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. + <mediaobject> + <imageobject> + <imagedata fileref="images/PageWizard.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> + </step> + <step> + <para> + 4. Click on the <emphasis role="bold">Next</emphasis> button and continue and click on the <emphasis role="bold">Save</emphasis> button. For example, create a key named "AAA". + </para> + </step> + </procedure> + </section> - <para>You can follow these steps:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Create Page Wizard</emphasis></para><para>2. Click <emphasis role="bold">Next</emphasis> to move to step 1</para><para>3. At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field.</para><mediaobject><imageobject><imagedata fileref="images/PageWizard.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Click on the <emphasis role="bold">Next</emphasis> button and continue and click on the <emphasis role="bold">Save</emphasis> button. For example, create a key named &quot;AAA&quot;.</para> -<section><title>Creating/Editing Keys by *Edit Page Wizard*</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Edit Page Wizard</emphasis></para><para>2. Click on the <emphasis role="bold">Next</emphasis> button to move to step 1</para><para>3. At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field.</para> -<section><title>Creating/Editing Keys using the *Edit Page and Navigation*</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>.</para><para>2. There are two alternatives:</para><itemizedlist><listitem>Create a new node: Select the parent path, right click and click on <emphasis role="bold">Add new node</emphasis> option .</listitem><listitem>Edit an existing node: Right click on the node you want to create/edit key and click on <emphasis role="bold">Edit this node</emphasis> in the pop-up menu.</listitem></itemizedlist><para>3. A Create/Edit node dialog appears, enter a resource key in the <emphasis role="bold">Label</emphasis> field</para><para>+Note:+ You can reuse the same resource key in several nodes.</para> -<section><title>Internationalize Resource Keys</title></section> -<para>Exo Portal organizes resource keys in resource files. Each file contains a list of keys and their meanings (translations) in one specific language. Normally one resource file has one language supported by Portal. This helps to structure the resource keys. Each resource file has a name and a language attribute. One resource file only can contain translations for one single language.</para><para>Do as follows: 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigation</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Internationalization</emphasis></para><mediaobject><imageobject><imagedata fileref="images/Internal2.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Select a data resource that you want to internationalize. You also may search the desired resource name with a specific language:</para><itemizedlist><listitem>Enter a resource name in the <emphasis role="bold! ">Name</emphasis> field in the <emphasis role="bold">Search Resource</emphasis> form</listitem><listitem>Select a corresponding language of the resource.</listitem><listitem>Click on the <emphasis role="bold">Search</emphasis> button to match all data resource and display the result on the table above.</listitem><listitem>If you want to define a key for a node which belongs to a specific portal, search for a resource like:locale.navigation.portal.portal name]</listitem></itemizedlist><para>+Example:+ if you want to define a key of a node of portal &quot;classic&quot; in language French, search resource: locale.navigation.portal.classic with value in the <emphasis role="bold">Language</emphasis> field is &quot;fr&quot;</para><itemizedlist><listitem>If you want to define a key for the node that belongs to a specific group, search resource like: locale.navigation.group.group path]</listitem></itemizedlist><para>+Example:+ if you want to define a key for a node on navigation o! f &quot;administrators&quot; group that is the sub one of the! &quot;p latform&quot; group in language French, search resource: locale.navigation.group.platform.administrators with the value in the <emphasis role="bold">Language</emphasis> field is &quot;fr&quot;</para><para>3. Click the magnifying glass!images/MagnifyIcon.png! icon corresponding to a data resource to see details of the resource file. Click the <emphasis role="bold">Edit</emphasis> button in order to modify the content.</para><para>4. Enter the resource key with the string that will be displayed as node name on the navigation bar .</para><para>5. Click on the <emphasis role="bold">Save</emphasis> button.</para> -<section><title>Example</title></section> -<itemizedlist><listitem>The current language is English</listitem><listitem>Go to <emphasis role="bold">Create Page Wizard</emphasis>, at step 1, select navigation and enter values like in the figure below:</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/PageWizard.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Click <emphasis role="bold">Next</emphasis>, at step 2 and 3, set layout for page Test button.</listitem><listitem>After creating page with that key, the node on the navigation bar will be displayed with name #{AAA}</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/AAANavi.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>And now you have to define what to display instead of displaying the key. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigation</emphasis> -&gt; <emphasis role="bold">Administration</e! mphasis> --&gt; <emphasis role="bold">Internationalization</emphasis>.</listitem><listitem>Search resource locale.navigation.portal.classic with language French (fr)</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/Search.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Click the magnifying icon!images/MagnifyIcon.png! to see the content.</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/ResourceData1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Click on the <emphasis role="bold">Edit</emphasis> button to modify. In the <emphasis role="bold">Resource</emphasis> field, enter the key and assign the string to display.</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/AfterEdit1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Click on the <emphasis role="bold">Save</emphasis> button.</listite! m><listitem>Go to GateIn <emphasis role="bold">Start</emphasis! <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Language Settings</emphasis>: select French --&gt; Apply.</listitem><listitem>The French translation of your new resource key appears on the menu.</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/Nouvel.png" format="PNG"></imagedata></imageobject></mediaobject> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_by_Edit_Page_Wizard"> + <title>Creating/Editing Keys by *Edit Page Wizard*</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Edit Page Wizard</emphasis> + </para> + <para> + 2. Click on the <emphasis role="bold">Next</emphasis> button to move to step 1 + </para> + <para> + 3. At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. + </para> + </section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"> + <title>Creating/Editing Keys using the *Edit Page and Navigation*</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>. + </para> + <para> + 2. There are two alternatives: + </para> + <itemizedlist> + <listitem> + <para> + Create a new node: Select the parent path, right click and click on <emphasis role="bold">Add new node</emphasis> option . + </para> + </listitem> + <listitem> + <para> + Edit an existing node: Right click on the node you want to create/edit key and click on <emphasis role="bold">Edit this node</emphasis> in the pop-up menu. + </para> + </listitem> + </itemizedlist> + <para> + 3. A Create/Edit node dialog appears, enter a resource key in the <emphasis role="bold">Label</emphasis> field + </para> + <para> + +Note:+ You can reuse the same resource key in several nodes. + </para> + </section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Internationalize_Resource_Keys"> + <title>Internationalize Resource Keys</title> + <para> + Exo Portal organizes resource keys in resource files. Each file contains a list of keys and their meanings (translations) in one specific language. Normally one resource file has one language supported by Portal. This helps to structure the resource keys. Each resource file has a name and a language attribute. One resource file only can contain translations for one single language. + </para> + <para> + Do as follows: 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigation</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Internationalization</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Internal2.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Select a data resource that you want to internationalize. You also may search the desired resource name with a specific language: + </para> + <itemizedlist> + <listitem> + <para> + Enter a resource name in the <emphasis role="bold">Name</emphasis> field in the <emphasis role="bold">Search Resource</emphasis> form + </para> + </listitem> + <listitem> + <para> + Select a corresponding language of the resource. + </para> + </listitem> + <listitem> + <para> + Click on the <emphasis role="bold">Search</emphasis> button to match all data resource and display the result on the table above. + </para> + </listitem> + <listitem> + <para> + If you want to define a key for a node which belongs to a specific portal, search for a resource like:locale.navigation.portal.portal name] + </para> + </listitem> + </itemizedlist> + <para> + +Example:+ if you want to define a key of a node of portal "classic" in language French, search resource: locale.navigation.portal.classic with value in the <emphasis role="bold">Language</emphasis> field is "fr" + </para> + <itemizedlist> + <listitem> + <para> + If you want to define a key for the node that belongs to a specific group, search resource like: locale.navigation.group.group path] + </para> + </listitem> + </itemizedlist> + <para> + +Example:+ if you want to define a key for a node on navigation of "administrators" group that is the sub one of the "platform" group in language French, search resource: locale.navigation.group.platform.administrators with the value in the <emphasis role="bold">Language</emphasis> field is "fr" + </para> + <para> + 3. Click the magnifying glass!images/MagnifyIcon.png! icon corresponding to a data resource to see details of the resource file. Click the <emphasis role="bold">Edit</emphasis> button in order to modify the content. + </para> + <para> + 4. Enter the resource key with the string that will be displayed as node name on the navigation bar . + </para> + <para> + 5. Click on the <emphasis role="bold">Save</emphasis> button. + </para> + </section> + + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Example"> + <title>Example</title> + <itemizedlist> + <listitem> + <para> + The current language is English + </para> + </listitem> + <listitem> + <para> + Go to <emphasis role="bold">Create Page Wizard</emphasis>, at step 1, select navigation and enter values like in the figure below: + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageWizard.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Click <emphasis role="bold">Next</emphasis>, at step 2 and 3, set layout for page Test button. + </para> + </listitem> + <listitem> + <para> + After creating page with that key, the node on the navigation bar will be displayed with name #{AAA} + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/AAANavi.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + And now you have to define what to display instead of displaying the key. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigation</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Internationalization</emphasis>. + </para> + </listitem> + <listitem> + <para> + Search resource locale.navigation.portal.classic with language French (fr) + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/Search.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Click the magnifying icon!images/MagnifyIcon.png! to see the content. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/ResourceData1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Click on the <emphasis role="bold">Edit</emphasis> button to modify. In the <emphasis role="bold">Resource</emphasis> field, enter the key and assign the string to display. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/AfterEdit1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Click on the <emphasis role="bold">Save</emphasis> button. + </para> + </listitem> + <listitem> + <para> + Go to GateIn <emphasis role="bold">Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Language Settings</emphasis>: select French --&gt; Apply. + </para> + </listitem> + <listitem> + <para> + The French translation of your new resource key appears on the menu. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/Nouvel.png" format="PNG" /> + </imageobject> + </mediaobject> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-RTL_Support_Right_To_Left"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,64 +21,63 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>RTL Support (Right To Left)</title> - <para>GateIn Portal supports RTL (Right to Left) to meet the demand of - Arabian customers who want to use the Portal by their own language for - more convenient and easy to use. When you change from other languages - to Arabic or set the displaying language as Arabic, the displaying on - Portal will be changed to Right to Left (RTL) direction because - Arabian usually read from Right to Left.</para> - <para>Some screen shots of Portal with RTL:</para> + --><title>RTL Support (Right To Left)</title> + <para> + GateIn Portal supports RTL (Right to Left) to meet the demand of Arabian customers who want to use the Portal by their own language for more convenient and easy to use. When you change from other languages to Arabic or set the displaying language as Arabic, the displaying on Portal will be changed to Right to Left (RTL) direction because Arabian usually read from Right to Left. + </para> + <para> + Some screen shots of Portal with RTL: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/HomePage2.png" format="PNG"></imagedata> + <imagedata fileref="images/HomePage2.png" format="PNG" /> </imageobject> </mediaobject> - <section> + <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_Account_Portlet"> <title>The Account Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/NewAccount3.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/NewAccount3.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_Application_Registry_Portlet"> <title>The Application Registry Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/ApplicationRegistry2.png" - format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_Internationalization_Portlet"> <title>The Internationalization Portlet:</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/In3.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/In3.png" - format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_Organization_Portlet"> <title>The Organization Portlet:</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Organization5.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/Organization5.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_User_Workspace"> <title>The User Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/UserWorkspace2.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserWorkspace2.png" - format="PNG"></imagedata> - </imageobject> - </mediaobject> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Change_Node_Order"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,15 +21,32 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Change Node Order</title> + <para> + You can easily change the position of node on the navigation bar on their own convenient order by following these steps: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>. + </para> + <para> + 2. Select a navigation from the navigation list. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Navigation.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 3. Select the node that you want to move. Right click on the selected node and then click on <emphasis role="bold">Move up</emphasis> or <emphasis role="bold">Move down</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/MoveUpDown.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The selected node will be moved up/down. + </para> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Change Node Order</title> - <para>You can easily change the position of node on the navigation - bar on their own convenient order by following these steps:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>.</para><para>2. Select a navigation from the navigation list.</para><mediaobject><imageobject><imagedata fileref="images/Navigation.png" format="PNG"></imagedata></imageobject></mediaobject><para>3. Select the node that you want to move. Right click on the selected node and then click on <emphasis role="bold">Move up</emphasis> or <emphasis role="bold">Move down</emphasis></para><mediaobject><imageobject><imagedata fileref="images/MoveUpDown.png" format="PNG"></imagedata></imageobject></mediaobject><para>The selected node will be moved up/down.</para> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Change_Portal_Skins"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,31 +21,113 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Change Portal Skins</title> - <section> + --><title>Change Portal Skins</title> + <section id="sect-User_Guide-Change_Portal_Skins-Overview"> <title>Overview</title> + <para> + GateIn Portal skins are graphic styles that help users display an attractive user interface. Each skin has its own characteristics with different backgrounds, icons, etc. In order to be user-friendly and flexible in use, users are allowed to change their skins without having edit rights on the portal. + </para> + <para> + skin switch that takes only effect on the user's current session until he signs out. You can change the skin permanently or temporarily. + </para> </section> - <para>GateIn Portal skins are graphic styles that help users display an - attractive user interface. Each skin has its own characteristics with - different backgrounds, icons, etc. In order to be user-friendly and - flexible in use, users are allowed to change their skins without - having edit rights on the portal.</para> - <orderedlist numeration="arabic"> - <listitem>skin switch that takes only effect on the user's current - session until he signs out. You can change the skin permanently or - temporarily.</listitem> - </orderedlist> - <section> + + <section id="sect-User_Guide-Change_Portal_Skins-Change_the_skin_permanently"> <title>Change the skin permanently</title> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis> + </para> + </listitem> + <listitem> + <para> + 2. Click the edit icon!images/EditIcon.png! to edit portal properties. + </para> + </listitem> + <listitem> + <para> + 3. In the <emphasis role="bold">Portal Setting</emphasis> tab: select one skin type in the <emphasis role="bold">Skin</emphasis> list field to change and display a skin. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Skin1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis> icon !images/Finish1.png! so that the modification can take effect. + </para> + </listitem> + </orderedlist> + <para> + For Portal 2.6 + </para> + <orderedlist> + <listitem> + <para> + 1. Click <emphasis role="bold">Edit Inline</emphasis> on the Toolbar. The <emphasis role="bold">Edit Inline Composer</emphasis> will appear. + </para> + </listitem> + <listitem> + <para> + 2. Click <emphasis role="bold">Portal Properties</emphasis> to edit portal's properties. + </para> + </listitem> + <listitem> + <para> + 3. In the <emphasis role="bold">Portal Setting</emphasis> tab: select one skin type in the <emphasis role="bold">Skin</emphasis> list field to change and display a skin. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PortalSet.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 4. Click <emphasis role="bold">Save</emphasis> and the !images/DiskIcon.png! icon so that the modification can take effect. + </para> + </listitem> + </orderedlist> </section> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis></para><para>2. Click the edit icon!images/EditIcon.png! to edit portal properties.</para><para>3. In the <emphasis role="bold">Portal Setting</emphasis> tab: select one skin type in the <emphasis role="bold">Skin</emphasis> list field to change and display a skin.</para><mediaobject><imageobject><imagedata fileref="images/Skin1.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis> icon !images/Finish1.png! so that the modification can take effect.</para><variablelist><listitem>For Portal 2.6</listitem></variablelist><para>1. Click <emphasis role="bold">Edit Inline</emphasis> on the Toolbar. The <emphasis role="bold">Edit Inline Composer</emphasis> will appear.</para><para>2. Click <emphasis role="bold">Portal P! roperties</emphasis> to edit portal's properties.</para><para>3. In the <emphasis role="bold">Portal Setting</emphasis> tab: select one skin type in the <emphasis role="bold">Skin</emphasis> list field to change and display a skin.</para><mediaobject><imageobject><imagedata fileref="images/PortalSet.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Click <emphasis role="bold">Save</emphasis> and the !images/DiskIcon.png! icon so that the modification can take effect.</para> -<section><title>Change the skin temporarily</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Skin Settings</emphasis>.</para><variablelist><listitem>For GateIn Portal 2.6</listitem></variablelist><para>1. Go to <emphasis role="bold">GateIn</emphasis> on the Toolbar --&gt; click <emphasis role="bold">Change Skin</emphasis>.</para><para>The <emphasis role="bold">Skin Setting</emphasis> form is displayed with a list of all supported skins. The left pane contains the skin list and the right pane is used to display the template of the selected skin.</para><para>2. Select one by clicking on the skin's name.</para><para>3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take effect.</para><mediaobject><imageobject><imagedata fileref="images/SkinSet1.png" format="PNG"></imagedata></imageobject></mediaobject> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Change_Portal_Skins-Change_the_skin_temporarily"> + <title>Change the skin temporarily</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Skin Settings</emphasis>. + </para> + <para> + For GateIn Portal 2.6 + </para> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">GateIn</emphasis> on the Toolbar --&gt; click <emphasis role="bold">Change Skin</emphasis>. + </para> + <para> + The <emphasis role="bold">Skin Setting</emphasis> form is displayed with a list of all supported skins. The left pane contains the skin list and the right pane is used to display the template of the selected skin. + </para> + </listitem> + <listitem> + <para> + 2. Select one by clicking on the skin's name. + </para> + </listitem> + <listitem> + <para> + 3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take effect. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SkinSet1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + </orderedlist> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Create_a_New_Portal"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,126 +21,90 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Create a New Portal</title> - <para>Creating a new portal requires you to have a special - permission - that only an administrator can give you. You need follow - these guides - to create a new portal.</para> + --><title>Create a New Portal</title> <para> + Creating a new portal requires you to have a special permission that only an administrator can give you. You need follow these guides to create a new portal. + </para> + <para> <orderedlist> <listitem> <para> - Click on - <emphasis role="bold">Site</emphasis> - in the toolbar. + Click on <emphasis role="bold">Site</emphasis> in the toolbar. </para> </listitem> <listitem> <para> - Click the - <emphasis role="bold">Add New Portal</emphasis> - button. - By default, the - <emphasis role="bold">Create New Portal</emphasis> - form is shown with the - <emphasis role="bold">Portal Templates</emphasis> - tab. + Click the <emphasis role="bold">Add New Portal</emphasis> button. By default, the <emphasis role="bold">Create New Portal</emphasis> form is shown with the <emphasis role="bold">Portal Templates</emphasis> tab. <mediaobject> <imageobject> - <imagedata fileref="images/PortalTemplate2.6.png" - format="PNG"></imagedata> + <imagedata fileref="images/PortalTemplate2.6.png" format="PNG" /> </imageobject> </mediaobject> </para> <para> - <para> - By default, Portal template is Classic. Select the - <emphasis role="bold">Portal Setting</emphasis> - tab. - </para> + By default, Portal template is Classic. Select the <emphasis role="bold">Portal Setting</emphasis> tab. <mediaobject> <imageobject> - <imagedata fileref="images/PortalSetting2.5.png" - format="PNG"></imagedata> + <imagedata fileref="images/PortalSetting2.5.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> <para> - Enter a value for the - <emphasis role="bold">Portal Name</emphasis> - field. This field is required and must be unique. Only alpha, digit - and underscore characters are allowed for this field and it must - have at least 3 characters. + Enter a value for the <emphasis role="bold">Portal Name</emphasis> field. This field is required and must be unique. Only alpha, digit and underscore characters are allowed for this field and it must have at least 3 characters. </para> </listitem> <listitem> - <para>Select a display language for the portal by selecting a - language - from the list.</para> + <para> + Select a display language for the portal by selecting a language from the list. + </para> </listitem> <listitem> - <para>Select a skin for a portal by selecting one from the skin - list.</para> + <para> + Select a skin for a portal by selecting one from the skin list. + </para> </listitem> <listitem> <para> - Click on the - <emphasis role="bold">Properties</emphasis> - tab to fill in the - <emphasis role="bold">Keep session alive</emphasis> - property. - Keeping the working session for a long time to avoid a - time out. There are - 3 - options: + Click on the <emphasis role="bold">Properties</emphasis> tab to fill in the <emphasis role="bold">Keep session alive</emphasis> property. Keeping the working session for a long time to avoid a time out. There are 3 options: <itemizedlist> <listitem> - <para>never : it never happens even if an application requests it</para> + <para> + never : it never happens even if an application requests it + </para> </listitem> <listitem> - <para>on-demand : it starts to be used as soon as an application - requests it</para> + <para> + on-demand : it starts to be used as soon as an application requests it + </para> </listitem> <listitem> - <para>always : it's always enabled (which has a cost but the - administrator will be aware of that)</para> + <para> + always : it's always enabled (which has a cost but the administrator will be aware of that) + </para> </listitem> </itemizedlist> </para> </listitem> <listitem> <para> - Click on the - <emphasis role="bold">Permission Setting</emphasis> - tab and set the permissions for the Portal. + Click on the <emphasis role="bold">Permission Setting</emphasis> tab and set the permissions for the Portal. </para> <para> - By default the access permissions list for the portal is empty. You - have to select at least one or tick on the - <emphasis role="bold">Make it public</emphasis> - check box to assign access permission to everyone. + By default the access permissions list for the portal is empty. You have to select at least one or tick on the <emphasis role="bold">Make it public</emphasis> check box to assign access permission to everyone. </para> </listitem> <listitem> <para> - Click on - <emphasis role="bold">Save</emphasis> - to accept creating a new portal. + Click on <emphasis role="bold">Save</emphasis> to accept creating a new portal. </para> </listitem> </orderedlist> </para> - - <para> - You also can edit or delete a portal, see more details on - <link linkend="Manage Portals">Manage Portals</link> + You also can edit or delete a portal, see more details on <xref linkend="sect-User_Guide-Manage_Portals" /> </para> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Drag_and_Drop_the_Page_Body.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Drag_and_Drop_the_Page_Body.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Drag_and_Drop_the_Page_Body.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Drag_and_Drop_the_Page_Body"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,15 +21,26 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Drag and Drop the Page Body</title> + <para> + You can easily drag and drop page body to the specific place where you want to in the page by following guides: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis>. It will display : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/DragPage1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 2. Click on the <emphasis role="bold">Portal Page</emphasis>, drag and drop to another reasonable places which you want to in this page. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/DragPage3.png" format="PNG" /> + </imageobject> + </mediaobject> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Drag and Drop the Page Body</title> - <para>You can easily drag and drop page body to the specific place - where you want to in the page by following guides:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis>. It will display :</para><mediaobject><imageobject><imagedata fileref="images/DragPage1.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click on the <emphasis role="bold">Portal Page</emphasis>, drag and drop to another reasonable places which you want to in this page.</para><mediaobject><imageobject><imagedata fileref="images/DragPage3.png" format="PNG"></imagedata></imageobject></mediaobject> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Navigation_Nodes"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,32 +21,395 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Navigation Nodes</title> - <section> + --><title>Manage Navigation Nodes</title> + <section id="sect-User_Guide-Manage_Navigation_Nodes-Overview"> <title>Overview</title> + <para> + If you are allowed to access GateIn Start in the User Workspace, you can take all actions related to a node such as : add a new node, edit, copy, cut, delete and clone node. + </para> </section> - <para>If you are allowed to access GateIn Start in the User Workspace, - you can take all actions related to a node such as : add a new node, - edit, copy, cut, delete and clone node.</para> - <section> + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Add_a_new_node"> <title>Add a new node</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + <para> + 2. Select a navigation from the navigation list. + </para> + <para> + 3. Select a node from list (to create a new node like sub-node of the selected node) or click the icon!images/UpIcon.png! to create a new node on root + </para> + <para> + 4. Right-click on the selected navigation or node and select <emphasis role="bold">Add new Node</emphasis> option. Add new node form appears: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/AddNode4.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Page Node Setting</emphasis> tab includes: + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Uri + </entry> + <entry> + An identification of the node. The Uri is automatically created after adding a new node + </entry> + </row> + <row> + <entry> + Node name + </entry> + <entry> + The name of the node. This field is required and must be unique. Only alpha, digit and underscore characters are allowed for this field and it must have at least 3 characters. + </entry> + </row> + <row> + <entry> + Label + </entry> + <entry> + The display name of the node on the screen. This field is not required and may be changed. This field must have a length between 3 and 120 characters. + </entry> + </row> + <row> + <entry> + Visible + </entry> + <entry> + This check box allow to hide (and show) the page and its node at the navigation bar, the page navigation and the site map + </entry> + </row> + <row> + <entry> + Publication date &amp; time + </entry> + <entry> + This option allows publishing this node for a period of time. *Start Publication Date* and *End Publication Date* only appear when this option is selected. + </entry> + </row> + <row> + <entry> + Start Publication Date + </entry> + <entry> + The start date and time to publish the node. + </entry> + </row> + <row> + <entry> + End Publication Date + </entry> + <entry> + The end date and time to publish the node. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + In the <emphasis role="bold">Page Selector</emphasis> tab, you can select a page or not for this node. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageSelector.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Page Id + </entry> + <entry> + The identification string of the page. + </entry> + </row> + <row> + <entry> + Name + </entry> + <entry> + The selected page's name. + </entry> + </row> + <row> + <entry> + Title + </entry> + <entry> + The selected page's title. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + You do not have to input values in these fields. It is automatically displayed after selecting an existing page by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. The <emphasis role="bold">Select a page</emphasis> form appears like: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SelectPage1.png" format="PNG" /> + </imageobject> + </mediaobject> + <orderedlist numeration="arabic"> + <listitem> + <para> + list of all existing pages is displayed with basic information. You can follow these guides to select a page for creating a node: + </para> + </listitem> + <listitem> + <para> + Select a page from list or search a specific page : + </para> + </listitem> + </orderedlist> + <itemizedlist> + <listitem> + <para> + Enter a search term related to the page which you want to search: + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/NewSearch1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Choose the field you wish to search in: + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/NewSearch2.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Click the magnifying glass!images/NewGlassIcon.png! icon to perform searching. All pages matching with search term will be listed. + </para> + </listitem> + <listitem> + <para> + Click the OK!images/NewOkIcon.png! icon on the row of the page to select. + </para> + </listitem> + <listitem> + <para> + After selecting a page, the details of this page will be displayed in the <emphasis role="bold">Page Selector</emphasis> form. + </para> + </listitem> + </itemizedlist> + <para> + After configuring the page node settings, the page selector and the node's icon, click the <emphasis role="bold">Save</emphasis> button to accept or the <emphasis role="bold">Cancel</emphasis> button to quit without creating a new node. + </para> </section> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Select a node from list (to create a new node like sub-node of the selected node) or click the icon!images/UpIcon.png! to create a new node on root</para><para>4. Right-click on the selected navigation or node and select <emphasis role="bold">Add new Node</emphasis> option. Add new node form appears:</para><mediaobject><imageobject><imagedata fileref="images/AddNode4.png" format="PNG"></imagedata></imageobject></mediaobject><para>The <emphasis role="bold">Page Node Setting</emphasis> tab includes:</para><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Des! cription </emphasis></entry></row><row><entry> Uri </entry><entry> An identification of the node. The Uri is automatically created after adding a new node </entry></row><row><entry> Node name </entry><entry> The name of the node. This field is required and must be unique. Only alpha, digit and underscore characters are allowed for this field and it must have at least 3 characters. </entry></row><row><entry> Label </entry><entry> The display name of the node on the screen. This field is not required and may be changed. This field must have a length between 3 and 120 characters. </entry></row><row><entry> Visible </entry><entry> This check box allow to hide (and show) the page and its node at the navigation bar, the page navigation and the site map </entry></row><row><entry> Publication date &amp; time </entry><entry> This option allows publishing this node for a period of time. *Start Publication Date* and *End Publication Date* only appear when this option is sele! cted. </entry></row><row><entry> Start Publication Date </ent! ry><entr y> The start date and time to publish the node. </entry></row><row><entry> End Publication Date </entry><entry> The end date and time to publish the node. </entry></row></tbody></tgroup></informaltable><para>In the <emphasis role="bold">Page Selector</emphasis> tab, you can select a page or not for this node.</para><mediaobject><imageobject><imagedata fileref="images/PageSelector.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Page Id </entry><entry> The identification string of the page. </entry></row><row><entry> Name </entry><entry> The selected page's name. </entry></row><row><entry> Title </entry><entry> The selected page's title. </entry></row><! /tbody></tgroup></informaltable><para>You do not have to input values in these fields. It is automatically displayed after selecting an existing page by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. The <emphasis role="bold">Select a page</emphasis> form appears like:</para><mediaobject><imageobject><imagedata fileref="images/SelectPage1.png" format="PNG"></imagedata></imageobject></mediaobject><orderedlist numeration="arabic"><listitem>list of all existing pages is displayed with basic information. You can follow these guides to select a page for creating a node:</listitem><listitem>Select a page from list or search a specific page :</listitem></orderedlist><itemizedlist><listitem>Enter a search term related to the page which you want to search:</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/NewSearch1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Choose the field you wish to ! search in:</listitem></itemizedlist><mediaobject><imageobject>! <imageda ta fileref="images/NewSearch2.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Click the magnifying glass!images/NewGlassIcon.png! icon to perform searching. All pages matching with search term will be listed.</listitem><listitem>Click the OK!images/NewOkIcon.png! icon on the row of the page to select.</listitem><listitem>After selecting a page, the details of this page will be displayed in the <emphasis role="bold">Page Selector</emphasis> form.</listitem></itemizedlist><para>After configuring the page node settings, the page selector and the node's icon, click the <emphasis role="bold">Save</emphasis> button to accept or the <emphasis role="bold">Cancel</emphasis> button to quit without creating a new node.</para> -<section><title>Edit a node</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Right-click on the selected node and select <emphasis role="bold">Edit this Node</emphasis> option.</para><mediaobject><imageobject><imagedata fileref="images/EditNode1.png" format="PNG"></imagedata></imageobject></mediaobject><para>It will displays a form to edit this node:</para><mediaobject><imageobject><imagedata fileref="images/PageNodeSetting.png" format="PNG"></imagedata></imageobject></mediaobject><para>In the <emphasis role="bold">Page Node Setting</emphasis> tab: you can change the value of these fields: Label, Visible and Publication Date &amp; time. After finish changing, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="! bold">Cancel</emphasis> button to refuse it.</para><mediaobject><imageobject><imagedata fileref="images/PageSelector6.png" format="PNG"></imagedata></imageobject></mediaobject><para>In the <emphasis role="bold">Page Selector</emphasis> tab : you also search and select another page for this node by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. You can see more details on how to select a page for a node on the above <emphasis role="bold">Add a new node</emphasis> section. After finish changing another page for this node, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to leave without saving any changes.</para> -<section><title>Copy a node</title></section> -<para>You also easily copy a node by following these steps:</para><para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Right-click on the selected node and select <emphasis role="bold">Copy node</emphasis> option.</para><mediaobject><imageobject><imagedata fileref="images/CopyNode3.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>.</para><mediaobject><imageobject><imagedata fileref="images/PasteNode3.png" format="PNG"></imagedata></imageobject></mediaobject> -<section><title>Clone nodes</title></section> -<itemizedlist><listitem>Clone node<emphasis role="bold">function allows you to copy the node. However, the differences between</emphasis>copy node<emphasis role="bold">and</emphasis>clone node<emphasis role="bold">is that the clone node has its own page and this page has the same content as the selected node, so there will be a new page that has the same name with the selected node's page, is shown in the page list when you access</emphasis>Manage Pages.</listitem></itemizedlist><para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Right-click on selected node and select <emphasis role="bold">Clone node</emphasis> option.</para><mediaobject><imageobject><imagedata fileref="images/CloneNode2.png" format="PNG"></imagedata></imageo! bject></mediaobject><para>4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>.</para><mediaobject><imageobject><imagedata fileref="images/PasteCloneNode2.png" format="PNG"></imagedata></imageobject></mediaobject><para>In <emphasis role="bold">Manage Pages</emphasis> you will see:</para><mediaobject><imageobject><imagedata fileref="images/ManagePage2.png" format="PNG"></imagedata></imageobject></mediaobject> -<section><title>Cut a node</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Right-click on the selected node and select <emphasis role="bold">Cut node</emphasis> option.</para><mediaobject><imageobject><imagedata fileref="images/CutNode4.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>.</para><mediaobject><imageobject><imagedata fileref="images/PasteCutNode4.png" format="PNG"></imagedata></imageobject></mediaobject> -<section><title>Delete a node</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis></para><para>2. Select a navigation from the navigation list.</para><para>3. Right-click on the selected node and select <emphasis role="bold">Delete node</emphasis> option.</para><mediaobject><imageobject><imagedata fileref="images/DeleteNode2.png" format="PNG"></imagedata></imageobject></mediaobject><para>It will display an alert message, click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting a node.</para><mediaobject><imageobject><imagedata fileref="images/http.png" format="PNG"></imagedata></imageobject></mediaobject> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Edit_a_node"> + <title>Edit a node</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + <para> + 2. Select a navigation from the navigation list. + </para> + <para> + 3. Right-click on the selected node and select <emphasis role="bold">Edit this Node</emphasis> option. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditNode1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + It will displays a form to edit this node: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageNodeSetting.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + In the <emphasis role="bold">Page Node Setting</emphasis> tab: you can change the value of these fields: Label, Visible and Publication Date &amp; time. After finish changing, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to refuse it. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageSelector6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + In the <emphasis role="bold">Page Selector</emphasis> tab : you also search and select another page for this node by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. You can see more details on how to select a page for a node on the above <emphasis role="bold">Add a new node</emphasis> section. After finish changing another page for this node, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to leave without saving any changes. + </para> + </section> + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Copy_a_node"> + <title>Copy a node</title> + <para> + You also easily copy a node by following these steps: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + <para> + 2. Select a navigation from the navigation list. + </para> + <para> + 3. Right-click on the selected node and select <emphasis role="bold">Copy node</emphasis> option. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/CopyNode3.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PasteNode3.png" format="PNG" /> + </imageobject> + </mediaobject> + </section> + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Clone_nodes"> + <title>Clone nodes</title> + <para> + Clone node<emphasis role="bold">function allows you to copy the node. However, the differences between</emphasis>copy node<emphasis role="bold">and</emphasis>clone node<emphasis role="bold">is that the clone node has its own page and this page has the same content as the selected node, so there will be a new page that has the same name with the selected node's page, is shown in the page list when you access</emphasis>Manage Pages. + </para> + <itemizedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + </listitem> + <listitem> + <para> + 2. Select a navigation from the navigation list. + </para> + </listitem> + <listitem> + <para> + 3. Right-click on selected node and select <emphasis role="bold">Clone node</emphasis> option. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/CloneNode2.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PasteCloneNode2.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + In <emphasis role="bold">Manage Pages</emphasis> you will see: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ManagePage2.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + </itemizedlist> + </section> + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Cut_a_node"> + <title>Cut a node</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + <para> + 2. Select a navigation from the navigation list. + </para> + <para> + 3. Right-click on the selected node and select <emphasis role="bold">Cut node</emphasis> option. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/CutNode4.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 4. Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PasteCutNode4.png" format="PNG" /> + </imageobject> + </mediaobject> + </section> + + <section id="sect-User_Guide-Manage_Navigation_Nodes-Delete_a_node"> + <title>Delete a node</title> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis> + </para> + </listitem> + <listitem> + <para> + 2. Select a navigation from the navigation list. + </para> + </listitem> + <listitem> + <para> + 3. Right-click on the selected node and select <emphasis role="bold">Delete node</emphasis> option. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/DeleteNode2.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + It will display an alert message, click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting a node. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/http.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + </orderedlist> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Page_Navigation"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,50 +21,158 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Page Navigation</title> - <section> + --><title>Manage Page Navigation</title> + <section id="sect-User_Guide-Manage_Page_Navigation-Overview"> <title>Overview</title> + <para> + In order to understand clearly about what the navigation is and navigation types that GateIn Portal supports, please refer the <xref linkend="sect-User_Guide-Navigation_concept" /> page. + </para> </section> - <para> - In order to understand clearly about what the navigation is and - navigation types that GateIn Portal supports, please refer the - <link linkend="Navigation concept">Navigation concept</link> - page. - </para> - <section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Portals_page_navigation"> <title>Portal's page navigation</title> + <para> + Stuff Goes here? + </para> </section> - - <section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Creating_a_portals_navigation"> <title>Creating a portal's navigation</title> + <para> + The page navigation of a portal is created automatically when a portal is created. + </para> </section> - <para>The page navigation of a portal is created automatically when - a portal is created.</para> - <section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Editing_a_portals_navigation"> <title>Editing a portal's navigation</title> + <para> + Only users who have the edit right on a portal can perform this action. + </para> + <para> + Follows these below guides to edit a portal 's navigation: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis>-&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis>--&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>. + </para> + <para> + 2. Select Portal navigation in list on the left pane (eg: portal: classic's Nav). + </para> + <para> + 3. Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the menu: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortalNavigation.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The form for editing the portal navigation will be opened: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortalNavigation2.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + <emphasis><emphasis role="bold">Notice</emphasis></emphasis>: The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar. + </para> + <para> + 4. Make changes to fields in this form: <emphasis role="bold">Description</emphasis>, <emphasis role="bold">Priority</emphasis>. + </para> + <para> + 5. Click the <emphasis role="bold">Save</emphasis> button to accept changes. + </para> + <para> + 6. Click the!images/OKIcon.png! to take effect of new changes. + </para> + <para> + Or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change. + </para> </section> - <para>Only users who have the edit right on a portal can perform - this action.</para> - <para>Follows these below guides to edit a portal 's navigation:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis>-&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis>--&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>.</para><para>2. Select Portal navigation in list on the left pane (eg: portal: classic's Nav).</para><para>3. Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the menu:</para><mediaobject><imageobject><imagedata fileref="images/EditPortalNavigation.png" format="PNG"></imagedata></imageobject></mediaobject><para>The form for editing the portal navigation will be opened:</para><mediaobject><imageobject><imagedata fileref="images/EditPortalNavigation2.png" format="PNG"></imagedata></imageobject></mediaobject><para><emphasis><emphasis role="bold">Notice</emphasis></emphasis>: The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigatio! n bar.</para><para>4. Make changes to fields in this form: <emphasis role="bold">Description</emphasis>, <emphasis role="bold">Priority</emphasis>.</para><para>5. Click the <emphasis role="bold">Save</emphasis> button to accept changes.</para><para>6. Click the!images/OKIcon.png! to take effect of new changes.</para><para>Or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change.</para> -<section><title>Deleting a portal's navigation</title></section> -<para>No one can create the portal's page navigation so no one can delete it. A navigation is deleted automatically after you delete its portal.</para> -<section><title>Group's page navigation</title></section> -<para>Each group has only one page navigation. Only users of that group have the &quot;manager&quot; membership can create/edit/delete navigation for that group</para> -<section><title>Editing a group's navigation</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>.</para><para>2. Select a Group navigation in the list on the left pane (eg: group:platform/administrator's Nav). All pages of this group will be listed underneath.</para><para>3. Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the context menu:</para><mediaobject><imageobject><imagedata fileref="images/EditGroupNavigation.png" format="PNG"></imagedata></imageobject></mediaobject><para>The form for editing the group navigation will be opened:</para><mediaobject><imageobject><imagedata fileref="images/EditGroupNavigation2.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Make changes for two fields: <emphasis role="bold">Description</emphasis> and <emphasis role="bold">Priorit! y</emphasis>.</para><para><emphasis><emphasis role="bold">Notice</emphasis></emphasis>: The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar.</para><para>5. Click the <emphasis role="bold">Save</emphasis> button to accept any changes.</para><para>6. Click the!images/OKIcon.png! to take effect new changes on the Navigation bar.</para><para>Or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change.</para> -<section><title>User's page navigation</title></section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Deleting_a_portals_navigation"> + <title>Deleting a portal's navigation</title> + <para> + No one can create the portal's page navigation so no one can delete it. A navigation is deleted automatically after you delete its portal. + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Groups_page_navigation"> + <title>Group's page navigation</title> + <para> + Each group has only one page navigation. Only users of that group have the "manager" membership can create/edit/delete navigation for that group + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Editing_a_groups_navigation"> + <title>Editing a group's navigation</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Page and Navigation</emphasis>. + </para> + <para> + 2. Select a Group navigation in the list on the left pane (eg: group:platform/administrator's Nav). All pages of this group will be listed underneath. + </para> + <para> + 3. Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the context menu: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditGroupNavigation.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + The form for editing the group navigation will be opened: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditGroupNavigation2.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 4. Make changes for two fields: <emphasis role="bold">Description</emphasis> and <emphasis role="bold">Priority</emphasis>. + </para> + <para> + <emphasis><emphasis role="bold">Notice</emphasis></emphasis>: The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar. + </para> + <para> + 5. Click the <emphasis role="bold">Save</emphasis> button to accept any changes. + </para> + <para> + 6. Click the!images/OKIcon.png! to take effect new changes on the Navigation bar. + </para> + <para> + Or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change. + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Users_page_navigation"> + <title>User's page navigation</title> + <para> + Stuff Goes here? + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Creating_a_users_navigation"> + <title>Creating a user's navigation</title> + <para> + The page navigation of a user is created automatically when a user is created (registered). So an administrator don't have to create it. + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Editing_a_users_navigation"> + <title>Editing a user's navigation</title> + <para> + Only the user who is the owner of the user page navigation can edit it. + </para> + </section> + + <section id="sect-User_Guide-Manage_Page_Navigation-Deleting_a_users_navigation"> + <title>Deleting a user's navigation</title> + <para> + No one can create user's page navigation so that no one can delete it. A user's navigation is deleted automatically when its user is deleted. + </para> + </section> -<section><title>Creating a user's navigation</title></section> -<para>The page navigation of a user is created automatically when a user is created (registered). So an administrator don't have to create it.</para> -<section><title>Editing a user's navigation</title></section> -<para>Only the user who is the owner of the user page navigation can edit it.</para> -<section><title>Deleting a user's navigation</title></section> -<para>No one can create user's page navigation so that no one can delete it. A user's navigation is deleted automatically when its user is deleted.</para> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Pages.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Pages.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Pages.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Pages"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,26 +21,466 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Pages</title> - <para>Only by using one page list can users add, edit, delete and - view quickly and easily which pages you like to. Following these - guides to manage pages:</para> - <section> + --><title>Manage Pages</title> + <para> + Only by using one page list can users add, edit, delete and view quickly and easily which pages you like to. Following these guides to manage pages: + </para> + <section id="sect-User_Guide-Manage_Pages-Add_a_new_Page_in_the_Page_List"> <title>Add a new Page in the Page List</title> + <para> + You easily add a new page by following these simple steps: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn</emphasis> -&gt;<emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ManagePage.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + For GateIn Portal 2.6 + </para> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">Administrator</emphasis> on the Toolbar --&gt; <emphasis role="bold">Manage Pages</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ManagePage2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + Details + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Button </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Add New Page + </entry> + <entry> + allows you to add a new page. + </entry> + </row> + <row> + <entry> + Back + </entry> + <entry> + allows you to return to home page. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem> + <para> + 2. Click the <emphasis role="bold">Add New Page</emphasis> button. + </para> + </listitem> + <listitem> + <para> + 3. Enter values for fields in the <emphasis role="bold">Page Setting</emphasis> tab + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageSetting.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Page Id + </entry> + <entry> + The string to identify the page. It is automatically generated when you will finish creating page. + </entry> + </row> + <row> + <entry> + Owner type + </entry> + <entry> + The owner type of the the page (portal, group or user). The "User" type is displayed by default. You can change the owner type by clicking on the icon. + </entry> + </row> + <row> + <entry> + Owner Id + </entry> + <entry> + The identification name of page owner. When the owner type is "group", there will be a list of groups of which you have to select one. + </entry> + </row> + <row> + <entry> + Page Name + </entry> + <entry> + The name of the page. This is a required field and must be unique. Only alpha, digit and underscore characters are allowed to be used for this field and it must have a length between 3 and 30 characters + </entry> + </row> + <row> + <entry> + Page title + </entry> + <entry> + The title of the the page. This field is not required and must have a length between 3 and 30 characters. + </entry> + </row> + <row> + <entry> + Show Max Window + </entry> + <entry> + The option allows to choose whether showing the page in maximum size or not. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + If the <emphasis role="bold">Owner type</emphasis> is "portal" or "group": + </para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">Owner type</emphasis> is 'portal': it means you create a page for a portal. Thus only users who have edit permissions on the portal can create this page type. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">Owner type</emphasis> is 'group': it means you create a page for a group. Thus only users who are 'manager' of a group can create this page type. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageSetting1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Permission Setting is initialized + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/PermissionSetting1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + With <emphasis role="bold">Access Permission</emphasis>: The content of this tab is identical to the <emphasis role="bold">Owner type</emphasis> field in the <emphasis role="bold">Page Setting</emphasis> tab. Thus, all users have access rights of the page type selected in the <emphasis role="bold">Owner type</emphasis> field will appear in this tab. But you also can change the value of this tab as follows: + </para> + </listitem> + <listitem> + <para> + Check the check box if you want to share access with everyone + </para> + </listitem> + <listitem> + <para> + Or click the <emphasis role="bold">Add Permission</emphasis> button to assign permission on group level, then select a group and membership. + </para> + </listitem> + <listitem> + <para> + Or click the trash can icon to remove a group from the list. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + With <emphasis role="bold">Edit Permission</emphasis>: The content of this tab depends on the value of the <emphasis role="bold">Owner type</emphasis> field in the <emphasis role="bold">Page Setting</emphasis> tab. + </para> + </listitem> + <listitem> + <para> + If the <emphasis role="bold">Owner type</emphasis> is "group", edit permission is assigned to users who are "manager" of the group that is selected in <emphasis role="bold">Owner id</emphasis>. You only can change this value when editing the page. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPermission1.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + If the <emphasis role="bold">Owner type</emphasis> is "portal": The name of the current portal is automatically selected for <emphasis role="bold">Owner id</emphasis> so that the edit permissions are assigned to users who can edit the current portal. Users only can change this value when editing the page. + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPermission2.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 4. Click the <emphasis role="bold">Save</emphasis> button to accept creating a new page or the <emphasis role="bold">Cancel</emphasis> button to quit the form. + </para> + </listitem> + </orderedlist> </section> - <para>You easily add a new page by following these simple steps:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn</emphasis> - -&gt;<emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis></para><mediaobject><imageobject><imagedata fileref="images/ManagePage.png" format="PNG"></imagedata></imageobject></mediaobject><variablelist><listitem>For GateIn Portal 2.6</listitem></variablelist><para>1. Go to <emphasis role="bold">Administrator</emphasis> on the Toolbar --&gt; <emphasis role="bold">Manage Pages</emphasis></para><mediaobject><imageobject><imagedata fileref="images/ManagePage2.6.png" format="PNG"></imagedata></imageobject></mediaobject><para>Details</para><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Button </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Add New Page </entry><entry> allows you to add a new page. </e! ntry></row><row><entry> Back </entry><entry> allows you to return to home page. </entry></row></tbody></tgroup></informaltable><para>2. Click the <emphasis role="bold">Add New Page</emphasis> button.</para><para>3. Enter values for fields in the <emphasis role="bold">Page Setting</emphasis> tab</para><mediaobject><imageobject><imagedata fileref="images/PageSetting.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Page Id </entry><entry> The string to identify the page. It is automatically generated when you will finish creating page. </entry></row><row><entry> Owner type </entry><entry> The owner type of the the page (portal, group or user). The &quot;User&quot; type is displayed ! by default. You can change the owner type by clicking on the ! icon. </ entry></row><row><entry> Owner Id </entry><entry> The identification name of page owner. When the owner type is &quot;group&quot;, there will be a list of groups of which you have to select one. </entry></row><row><entry> Page Name </entry><entry> The name of the page. This is a required field and must be unique. Only alpha, digit and underscore characters are allowed to be used for this field and it must have a length between 3 and 30 characters </entry></row><row><entry> Page title </entry><entry> The title of the the page. This field is not required and must have a length between 3 and 30 characters. </entry></row><row><entry> Show Max Window </entry><entry> The option allows to choose whether showing the page in maximum size or not. </entry></row></tbody></tgroup></informaltable><para>If the <emphasis role="bold">Owner type</emphasis> is &quot;portal&quot; or &quot;group&quot;:</para><itemizedlist><listitem><emphasis role="bold">Owner type</emphasis> is 'portal': it mea! ns you create a page for a portal. Thus only users who have edit permissions on the portal can create this page type.</listitem><listitem><emphasis role="bold">Owner type</emphasis> is 'group': it means you create a page for a group. Thus only users who are 'manager' of a group can create this page type.</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/PageSetting1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Permission Setting is initialized</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/PermissionSetting1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>With <emphasis role="bold">Access Permission</emphasis>: The content of this tab is identical to the <emphasis role="bold">Owner type</emphasis> field in the <emphasis role="bold">Page Setting</emphasis> tab. Thus, all users have access rights of the page type selected in the <emphasis role="bo! ld">Owner type</emphasis> field will appear in this tab. But y! ou also can change the value of this tab as follows:</listitem><listitem>Check the check box if you want to share access with everyone</listitem><listitem>Or click the <emphasis role="bold">Add Permission</emphasis> button to assign permission on group level, then select a group and membership.</listitem><listitem>Or click the trash can icon to remove a group from the list.</listitem></itemizedlist><itemizedlist><listitem>With <emphasis role="bold">Edit Permission</emphasis>: The content of this tab depends on the value of the <emphasis role="bold">Owner type</emphasis> field in the <emphasis role="bold">Page Setting</emphasis> tab.</listitem><listitem>If the <emphasis role="bold">Owner type</emphasis> is &quot;group&quot;, edit permission is assigned to users who are &quot;manager&quot; of the group that is selected in <emphasis role="bold">Owner id</emphasis>. You only can change this value when editing the page.</listitem></itemizedlist><mediaobject><imageobject><imagedata filere! f="images/EditPermission1.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>If the <emphasis role="bold">Owner type</emphasis> is &quot;portal&quot;: The name of the current portal is automatically selected for <emphasis role="bold">Owner id</emphasis> so that the edit permissions are assigned to users who can edit the current portal. Users only can change this value when editing the page.</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/EditPermission2.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Click the <emphasis role="bold">Save</emphasis> button to accept creating a new page or the <emphasis role="bold">Cancel</emphasis> button to quit the form.</para> -<section><title>Edit a Page</title></section> -<para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis></para><para>2. In the existing pages list: click the edit icon on the row of page you want to edit.</para><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Indicator </emphasis></entry><entry><emphasis role="bold"> Meaning </emphasis></entry></row><row><entry>!images/PreviewPage.png! </entry><entry> Preview page: allows viewing node's page with preview mode in a Normal Page </entry></row><row><entry>!images/EditPage.png! </entry><entry> Edit page properties: allows editing node's page properties </entry></row><row><entry>!images/ShowContainer.png! </entry><entry> Show container: allows to list all existing containers that will b! e used to change the layout of a selected page </entry></row><row><entry>!images/ShowPortlet.png! </entry><entry> Show portlet: allows to list all existing portlets that will be used to re-arrange the content of selected page. </entry></row><row><entry>!images/SavePage.png! </entry><entry> Save page: allows saving changes of a page </entry></row><row><entry>!images/Back.png! </entry><entry> Back: allows returning to the page list without saving </entry></row><row><entry>!images/Finish.png! </entry><entry> Finish:allows saving and returning to the page list </entry></row></tbody></tgroup></informaltable><itemizedlist><listitem>Edit page properties Click the edit!images/EditPage.png! icon to show a form to edit page properties.</listitem></itemizedlist><para>In the <emphasis role="bold">Page Setting</emphasis> tab:</para><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry! is role= "bold"> Description </emphasis></entry></row><row><entry> Page Id </entry><entry> The string to identify editing page. This string is generated automatically, user can not change. </entry></row><row><entry> Owner type </entry><entry> The type of editing page. User can not change. </entry></row><row><entry> Owner Id </entry><entry> The identification name of page's owner. User can not change. </entry></row><row><entry> Page name </entry><entry> The name of the page. User can not change. </entry></row><row><entry> Page title </entry><entry> The title of page. User can change and it must have length from 3 to 30 characters. </entry></row><row><entry> Show Max Window </entry><entry> The option allows whether showing page in maximum size or not. User should check this option for desktop page only. </entry></row></tbody></tgroup></informaltable><itemizedlist><listitem>Permission Setting: This form is supported for pages of a group or a portal. Because page of an user is private, n! o one else can access or edit user's page except the creator, so you do not have to set permission for it. Permission on each page is set in two levels: Access right and Edit right.</listitem><listitem><emphasis role="bold">Access right</emphasis>: Page Access right can be set to some user groups or set to everyone (also includes unregistered users). There is a list of current access permissions on page. You can click delete icon to remove permission or click the <emphasis role="bold">Add Permission</emphasis> button to add more or tick on <emphasis role="bold">Make it public</emphasis> option check box to allow all users to access.</listitem><listitem><emphasis role="bold">Edit right</emphasis>: It allows users to change information of page. Edit right only is set for a group of users. Edit right on a page can be set for one group with one specific membership type (or <emphasis role="bold">means every membership types in group). If you want to re-assign this right to anot! her group, click</emphasis>Select Permission to choose another! one.</l istitem></itemizedlist><itemizedlist><listitem>Editing page container layout</listitem></itemizedlist><para>Click !images/ShowContainer.png! icon to show current container layout of selected page on your right and all the container layouts list on the left pane.</para><para>If you want to change current layout, select a layout type from the list on the left pane, then left click on the template you want and drag and drop it into the right pane. New container will be displayed on the right pane. You can change position of current container by left click and drag and drop it to another place on the right pane or remove current container by clicking delete icon on the right corner.</para><itemizedlist><listitem>Editing page portlet layout</listitem></itemizedlist><para>Click !images/ShowPortlet.png! icon to show current portlet layout of page.</para><para>If you want to change current layout, select layout type from the list on the left pane, then left click on the temp! late you want and drag and drop it into the right pane. New portlet will be added and displayed in the right pane. You can change position of current portlet by left click and drag and drop it to the place you want on the right pane or remove current portlet by clicking delete icon.</para> -<section><title>View a Page</title></section> -<para>You easily view a page by clicking on the!images/View.png! icon on the row of the page you want to view in the existing pages list.</para> -<section><title>Delete a Page</title></section> -<para>1. Go to <emphasis role="bold">GateIn Admin</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis></para><para>2. There is a list of all existing pages, click the trash can icon !images/DeleteIcon.png! on row of the page you want to delete. It will display the confirmation message.</para><mediaobject><imageobject><imagedata fileref="images/http.png" format="PNG"></imagedata></imageobject></mediaobject><para>3. Click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting this page.</para> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Manage_Pages-Edit_a_Page"> + <title>Edit a Page</title> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis> + </para> + <para> + 2. In the existing pages list: click the edit icon on the row of page you want to edit. + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Indicator </emphasis> + </entry> + <entry> + <emphasis role="bold"> Meaning </emphasis> + </entry> + </row> + <row> + <entry> + !images/PreviewPage.png! + </entry> + <entry> + Preview page: allows viewing node's page with preview mode in a Normal Page + </entry> + </row> + <row> + <entry> + !images/EditPage.png! + </entry> + <entry> + Edit page properties: allows editing node's page properties + </entry> + </row> + <row> + <entry> + !images/ShowContainer.png! + </entry> + <entry> + Show container: allows to list all existing containers that will be used to change the layout of a selected page + </entry> + </row> + <row> + <entry> + !images/ShowPortlet.png! + </entry> + <entry> + Show portlet: allows to list all existing portlets that will be used to re-arrange the content of selected page. + </entry> + </row> + <row> + <entry> + !images/SavePage.png! + </entry> + <entry> + Save page: allows saving changes of a page + </entry> + </row> + <row> + <entry> + !images/Back.png! + </entry> + <entry> + Back: allows returning to the page list without saving + </entry> + </row> + <row> + <entry> + !images/Finish.png! + </entry> + <entry> + Finish:allows saving and returning to the page list + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <itemizedlist> + <listitem> + <para> + Edit page properties Click the edit!images/EditPage.png! icon to show a form to edit page properties. + </para> + </listitem> + </itemizedlist> + <para> + In the <emphasis role="bold">Page Setting</emphasis> tab: + </para> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Page Id + </entry> + <entry> + The string to identify editing page. This string is generated automatically, user can not change. + </entry> + </row> + <row> + <entry> + Owner type + </entry> + <entry> + The type of editing page. User can not change. + </entry> + </row> + <row> + <entry> + Owner Id + </entry> + <entry> + The identification name of page's owner. User can not change. + </entry> + </row> + <row> + <entry> + Page name + </entry> + <entry> + The name of the page. User can not change. + </entry> + </row> + <row> + <entry> + Page title + </entry> + <entry> + The title of page. User can change and it must have length from 3 to 30 characters. + </entry> + </row> + <row> + <entry> + Show Max Window + </entry> + <entry> + The option allows whether showing page in maximum size or not. User should check this option for desktop page only. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <itemizedlist> + <listitem> + <para> + Permission Setting: This form is supported for pages of a group or a portal. Because page of an user is private, no one else can access or edit user's page except the creator, so you do not have to set permission for it. Permission on each page is set in two levels: Access right and Edit right. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">Access right</emphasis>: Page Access right can be set to some user groups or set to everyone (also includes unregistered users). There is a list of current access permissions on page. You can click delete icon to remove permission or click the <emphasis role="bold">Add Permission</emphasis> button to add more or tick on <emphasis role="bold">Make it public</emphasis> option check box to allow all users to access. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">Edit right</emphasis>: It allows users to change information of page. Edit right only is set for a group of users. Edit right on a page can be set for one group with one specific membership type (or <emphasis role="bold">means every membership types in group). If you want to re-assign this right to another group, click</emphasis>Select Permission to choose another one. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + Editing page container layout + </para> + </listitem> + </itemizedlist> + <para> + Click !images/ShowContainer.png! icon to show current container layout of selected page on your right and all the container layouts list on the left pane. + </para> + <para> + If you want to change current layout, select a layout type from the list on the left pane, then left click on the template you want and drag and drop it into the right pane. New container will be displayed on the right pane. You can change position of current container by left click and drag and drop it to another place on the right pane or remove current container by clicking delete icon on the right corner. + </para> + <itemizedlist> + <listitem> + <para> + Editing page portlet layout + </para> + </listitem> + </itemizedlist> + <para> + Click !images/ShowPortlet.png! icon to show current portlet layout of page. + </para> + <para> + If you want to change current layout, select layout type from the list on the left pane, then left click on the template you want and drag and drop it into the right pane. New portlet will be added and displayed in the right pane. You can change position of current portlet by left click and drag and drop it to the place you want on the right pane or remove current portlet by clicking delete icon. + </para> + </section> + + <section id="sect-User_Guide-Manage_Pages-View_a_Page"> + <title>View a Page</title> + <para> + You easily view a page by clicking on the!images/View.png! icon on the row of the page you want to view in the existing pages list. + </para> + </section> + + <section id="sect-User_Guide-Manage_Pages-Delete_a_Page"> + <title>Delete a Page</title> + <para> + 1. Go to <emphasis role="bold">GateIn Admin</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Pages</emphasis> + </para> + <para> + 2. There is a list of all existing pages, click the trash can icon !images/DeleteIcon.png! on row of the page you want to delete. It will display the confirmation message. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/http.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + 3. Click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting this page. + </para> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Permission.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Permission.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Permission.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Permission"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,189 +21,131 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Permission</title> - <para>Permissions play an important part in accessing and - performing - actions in the Portal. Depending on permissions assigned by - an - administrator, users can either access or edit portals, pages and - portlets. GateIn Portal have applied several permission levels:</para> + --><title>Manage Permission</title> + <para> + Permissions play an important part in accessing and performing actions in the Portal. Depending on permissions assigned by an administrator, users can either access or edit portals, pages and portlets. GateIn Portal have applied several permission levels: + </para> <itemizedlist> <listitem> - <emphasis role="bold">Portal</emphasis> - : The portal includes all pages, pages only can be accessed if the - user has also access the Portal. + <para> + <emphasis role="bold">Portal</emphasis> : The portal includes all pages, pages only can be accessed if the user has also access the Portal. + </para> </listitem> <listitem> - <emphasis role="bold">Page</emphasis> - : You can restrict the access to single pages. Users can change page - information (properties, layout) if they have the edit right. + <para> + <emphasis role="bold">Page</emphasis> : You can restrict the access to single pages. Users can change page information (properties, layout) if they have the edit right. + </para> </listitem> <listitem> - <emphasis role="bold">Portlet</emphasis> - : When users create a page, they need to drag and drop portlets into - a page to create the page content. Some portlets are only used for - administrators, some are used for individual needs of a group thus - you have to set the appropriate access permission. + <para> + <emphasis role="bold">Portlet</emphasis> : When users create a page, they need to drag and drop portlets into a page to create the page content. Some portlets are only used for administrators, some are used for individual needs of a group thus you have to set the appropriate access permission. + </para> </listitem> </itemizedlist> - <para>The three above permission levels helps users assign access - and - edit permissions clearly and flexibly.</para> - <section> + <para> + The three above permission levels helps users assign access and edit permissions clearly and flexibly. + </para> + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portal"> <title>Set the Access Permission on a Portal</title> - <para>You have to set permission for new portals as well as existing - portals:</para> + <para> + You have to set permission for new portals as well as existing portals: + </para> <itemizedlist> <listitem> <para> - For new portals: on the Toolbar select - <emphasis role="bold">Site</emphasis> - then click on the - <emphasis role="bold">Add New Portal</emphasis> - button, select the - <emphasis role="bold">Permission Setting</emphasis> - tab then the - <emphasis role="bold">Access Permission Setting</emphasis> - sub tab. - + For new portals: on the Toolbar select <emphasis role="bold">Site</emphasis> then click on the <emphasis role="bold">Add New Portal</emphasis> button, select the <emphasis role="bold">Permission Setting</emphasis> tab then the <emphasis role="bold">Access Permission Setting</emphasis> sub tab. <mediaobject> <imageobject> - <imagedata fileref="images/Access2.6.png" format="PNG"></imagedata> + <imagedata fileref="images/Access2.6.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> <para> - For existing portals: on the Toolbar click - <emphasis role="bold">Site Editor</emphasis> - then - <emphasis role="bold">Edit Page</emphasis> - . Click on - <emphasis role="bold">View Page properties</emphasis> - then select the - <emphasis role="bold">Permission Setting</emphasis> - tab. + For existing portals: on the Toolbar click <emphasis role="bold">Site Editor</emphasis> then <emphasis role="bold">Edit Page</emphasis> . Click on <emphasis role="bold">View Page properties</emphasis> then select the <emphasis role="bold">Permission Setting</emphasis> tab. <mediaobject> <imageobject> - <imagedata fileref="images/PortalPermission.png" - format="PNG"></imagedata> + <imagedata fileref="images/PortalPermission.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> </itemizedlist> <para> - If you do not want everyone to access the Portal, do not select the - <emphasis role="bold">Make it public</emphasis> - check box and you have to select group by group. Do as follows: + If you do not want everyone to access the Portal, do not select the <emphasis role="bold">Make it public</emphasis> check box and you have to select group by group. Do as follows: <itemizedlist> <listitem> <para> - Click the - <emphasis role="bold">Add Permission</emphasis> - button. + Click the <emphasis role="bold">Add Permission</emphasis> button. </para> </listitem> - <listitem>Select the group you want to add on the left and then - select a membership type on the right. In the membership types - list, means allowing any membership type.</listitem> <listitem> <para> - After selecting a membership type, the selected permission is - displayed in the access permission list. Each time, you only can - select one group with one membership type. If you want to add - more, click - <emphasis role="bold">Add Permission</emphasis> - and select again. + Select the group you want to add on the left and then select a membership type on the right. In the membership types list, means allowing any membership type. + </para> + </listitem> + <listitem> + <para> + After selecting a membership type, the selected permission is displayed in the access permission list. Each time, you only can select one group with one membership type. If you want to add more, click <emphasis role="bold">Add Permission</emphasis> and select again. <mediaobject> <imageobject> - <imagedata fileref="images/PermissionSetting2.png" - format="PNG"></imagedata> + <imagedata fileref="images/PermissionSetting2.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> </itemizedlist> </para> - </section> - <section> + + <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Portal"> <title>Set the Edit Permission on a Portal</title> - <para>Only users who are in the portal editor group can edit that - portal. Access rights can be given to several groups but edit rights - can only be given to a group with a membership type (or every - membership type by select ). To assign an edit permission to a user, - you must add him to the editor group of the respective portal.</para> <para> + Only users who are in the portal editor group can edit that portal. Access rights can be given to several groups but edit rights can only be given to a group with a membership type (or every membership type by select ). To assign an edit permission to a user, you must add him to the editor group of the respective portal. + </para> + <para> <orderedlist> <listitem> <para> - Use one of these following paths to assign permissions on a - portal: + Use one of these following paths to assign permissions on a portal: <itemizedlist> <listitem> - On the Toolbar select - <emphasis role="bold">Site</emphasis> - -&gt; - <emphasis role="bold">Add New Portal</emphasis> - -&gt; - <emphasis role="bold">Permission Setting</emphasis> - tab --&gt; - <emphasis role="bold">Edit Permission Setting</emphasis> - sub tab. + <para> + On the Toolbar select <emphasis role="bold">Site</emphasis> -&gt; <emphasis role="bold">Add New Portal</emphasis> -&gt; <emphasis role="bold">Permission Setting</emphasis> tab --&gt; <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. + </para> </listitem> </itemizedlist> <itemizedlist> <listitem> - On the Toolbar click - <emphasis role="bold">Site Editor</emphasis> - -&gt; - <emphasis role="bold">Edit Page</emphasis> - -&gt; - <emphasis role="bold">View Page properties</emphasis> - -&gt; - <emphasis role="bold">Permission Setting</emphasis> - tab --&gt; - <emphasis role="bold">Edit Permission Setting</emphasis> - sub tab. + <para> + On the Toolbar click <emphasis role="bold">Site Editor</emphasis> -&gt; <emphasis role="bold">Edit Page</emphasis> -&gt; <emphasis role="bold">View Page properties</emphasis> -&gt; <emphasis role="bold">Permission Setting</emphasis> tab --&gt; <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. + </para> </listitem> </itemizedlist> <mediaobject> <imageobject> - <imagedata fileref="images/Edit2.6.png" format="PNG"></imagedata> + <imagedata fileref="images/Edit2.6.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> <para> - Click - <emphasis role="bold">Select Permission</emphasis> - to choose a group. + Click <emphasis role="bold">Select Permission</emphasis> to choose a group. </para> </listitem> <listitem> - <para>Select a group and a membership type (select if you want to - assign all membership types for the selected group). After - selecting - the membership from the right, the selected information - is displayed.</para> + <para> + Select a group and a membership type (select if you want to assign all membership types for the selected group). After selecting the membership from the right, the selected information is displayed. + </para> </listitem> <listitem> <para> - 4. Click on the - <emphasis role="bold">Save</emphasis> - button to accept. + 4. Click on the <emphasis role="bold">Save</emphasis> button to accept. <mediaobject> <imageobject> - <imagedata fileref="images/PermissionSetting1.png" - format="PNG"></imagedata> + <imagedata fileref="images/PermissionSetting1.png" format="PNG" /> </imageobject> </mediaobject> </para> @@ -207,187 +153,169 @@ </orderedlist> </para> </section> - <section> + + <section id="sect-User_Guide-Manage_Permission-Initialize_a_Permission_on_a_Page"> <title>Initialize a Permission on a Page</title> - <para>In some cases, permissions on a page are initialized and users - who have the edit permission can change the page.</para> + <para> + In some cases, permissions on a page are initialized and users who have the edit permission can change the page. + </para> <itemizedlist> - <listitem>If the owner type of a page is &quot;user&quot;, you don't - have to set permissions, no one except the creator has access and - edit permissions.</listitem> + <listitem> + <para> + If the owner type of a page is "user", you don't have to set permissions, no one except the creator has access and edit permissions. + </para> + </listitem> + <listitem> + <para> + If the Owner type of a page is "group", initial permissions on page are: + </para> + </listitem> + <listitem> + <para> + Access permission: everyone in that group. + </para> + </listitem> + <listitem> + <para> + Edit permission: the manager of that group. + </para> + </listitem> </itemizedlist> <itemizedlist> - <listitem>If the Owner type of a page is &quot;group&quot;, initial - permissions on page are:</listitem> - <listitem>Access permission: everyone in that group.</listitem> - <listitem>Edit permission: the manager of that group.</listitem> - </itemizedlist> - <itemizedlist> - <listitem>If the Owner type of a page is portal, initial permissions - are:</listitem> - <listitem>Access permission: users who can access that portal.</listitem> - <listitem>Edit permission: users who can edit that portal.</listitem> - </itemizedlist> - </section> - <section> - <title>Set the Access Permission on a Page</title> - <para>When you have access permission on a specific page, you can - access that page which other users can't access it because they are - not given that permission.</para> - <para>These following path help you quickly set access permission for - a page:</para> - <itemizedlist> <listitem> - Select - <emphasis role="bold">Site Editor</emphasis> - on the Toolbar -&gt; - <emphasis role="bold">Edit Page</emphasis> - -&gt; - <emphasis role="bold">View Page Properties</emphasis> - tab -&gt; - <emphasis role="bold">Access Permission Setting (default)</emphasis> - sub tab. + <para> + If the Owner type of a page is portal, initial permissions are: + </para> </listitem> + <listitem> + <para> + Access permission: users who can access that portal. + </para> + </listitem> + <listitem> + <para> + Edit permission: users who can edit that portal. + </para> + </listitem> </itemizedlist> - <para>To be able to access a page (read the page content or take an - action on the page), users have to be in one of the groups that have - access permission to that page. There may be several groups that have - access right to a page.</para> + </section> + + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Page"> + <title>Set the Access Permission on a Page</title> <para> - If you allow anyone to access the page tick on - <emphasis role="bold">Make it public</emphasis> - , otherwise, you have to select the groups one by one. + When you have access permission on a specific page, you can access that page which other users can't access it because they are not given that permission. </para> + <para> + These following path help you quickly set access permission for a page: + </para> + <para> + Select <emphasis role="bold">Site Editor</emphasis> on the Toolbar -&gt; <emphasis role="bold">Edit Page</emphasis> -&gt; <emphasis role="bold">View Page Properties</emphasis> tab -&gt; <emphasis role="bold">Access Permission Setting (default)</emphasis> sub tab. + </para> + <para> + To be able to access a page (read the page content or take an action on the page), users have to be in one of the groups that have access permission to that page. There may be several groups that have access right to a page. + </para> + <para> + If you allow anyone to access the page tick on <emphasis role="bold">Make it public</emphasis> , otherwise, you have to select the groups one by one. + </para> <itemizedlist> <listitem> - Click the - <emphasis role="bold">Add Permission</emphasis> - button + <para> + Click the <emphasis role="bold">Add Permission</emphasis> button + </para> </listitem> - <listitem>Select a group you want to add on the left and then select - a - membership type on the right. In a membership types list, means - allowing any membership type.</listitem> <listitem> - After selecting a membership type, the selected permission is - displayed in the access right list. Each time, you can only select - one group with one membership type. If you want to add more, click - the - <emphasis role="bold">Add Permission</emphasis> - button and select again. + <para> + Select a group you want to add on the left and then select a membership type on the right. In a membership types list, means allowing any membership type. + </para> </listitem> + <listitem> + <para> + After selecting a membership type, the selected permission is displayed in the access right list. Each time, you can only select one group with one membership type. If you want to add more, click the <emphasis role="bold">Add Permission</emphasis> button and select again. + </para> + </listitem> </itemizedlist> </section> - <section> + + <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Page"> <title>Set the Edit Permission on a Page</title> - <para>Only users who are in the page's editor group can edit it. The - access right can be set for several groups but the edit right only - can - be set for one single group. To give a user the edit permission, - you - must add him to the editors group of that page.</para> <para> + Only users who are in the page's editor group can edit it. The access right can be set for several groups but the edit right only can be set for one single group. To give a user the edit permission, you must add him to the editors group of that page. + </para> + <para> <orderedlist> <listitem> <para> <itemizedlist> <listitem> - Select - <emphasis role="bold">Site Editor</emphasis> - on the Toolbar -&gt; - <emphasis role="bold">Edit Page</emphasis> - -&gt; - <emphasis role="bold">View Page Properties</emphasis> - tab -&gt; - <emphasis role="bold">Edit Permission Setting</emphasis> - sub tab. + <para> + Select <emphasis role="bold">Site Editor</emphasis> on the Toolbar -&gt; <emphasis role="bold">Edit Page</emphasis> -&gt; <emphasis role="bold">View Page Properties</emphasis> tab -&gt; <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. + </para> </listitem> <listitem> - Or, select - <emphasis role="bold">Group</emphasis> - on the Toolbar -&gt; - <emphasis role="bold">Administration</emphasis> - -&gt; - <emphasis role="bold">Page Management</emphasis> - -&gt; - <emphasis role="bold">Edit Page icon</emphasis> - -&gt; - <emphasis role="bold">View Page Properties</emphasis> - tab -&gt; - <emphasis role="bold">Edit Permission Setting</emphasis> - sub tab. + <para> + Or, select <emphasis role="bold">Group</emphasis> on the Toolbar -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Page Management</emphasis> -&gt; <emphasis role="bold">Edit Page icon</emphasis> -&gt; <emphasis role="bold">View Page Properties</emphasis> tab -&gt; <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. + </para> </listitem> </itemizedlist> </para> </listitem> <listitem> <para> - Click the - <emphasis role="bold">Select Permission</emphasis> - button to set new or change another group. + Click the <emphasis role="bold">Select Permission</emphasis> button to set new or change another group. </para> </listitem> <listitem> - <para>Select a group with a membership type (select if you want all - membership types in a selected group)</para> + <para> + Select a group with a membership type (select if you want all membership types in a selected group) + </para> </listitem> <listitem> - <para>After selecting a specific membership from the right, the - selected information is displayed.</para> + <para> + After selecting a specific membership from the right, the selected information is displayed. + </para> </listitem> <listitem> <para> - Click the - <emphasis role="bold">Save</emphasis> - button to accept. + Click the <emphasis role="bold">Save</emphasis> button to accept. </para> </listitem> </orderedlist> </para> - </section> - <section> + + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portlet"> <title>Set the Access Permission on a Portlet</title> <para> - Follow these below steps to set access permission on a portlet: + Follow these below steps to set access permission on a portlet: <orderedlist> <listitem> <para> - Select - <emphasis role="bold">Group</emphasis> - --&gt; - <emphasis role="bold">Administration</emphasis> - --&gt; - <emphasis role="bold">Application Registry</emphasis> - on the navigation bar + Select <emphasis role="bold">Group</emphasis> --&gt; <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Application Registry</emphasis> on the navigation bar <mediaobject> <imageobject> - <imagedata fileref="images/Application1.png" format="PNG"></imagedata> + <imagedata fileref="images/Application1.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> - <para>Select a category on the left pane that includes the portlet - you want to set right. Then all portlets of the selected category - are - listed immediately and detail information of each portlet is - displayed - on the right pane.</para> + <para> + Select a category on the left pane that includes the portlet you want to set right. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane. + </para> </listitem> <listitem> <para> - To set permissions for a portlet: + To set permissions for a portlet: <itemizedlist> <listitem> - Click the - <emphasis role="bold">Add Permission</emphasis> - button to add access permissions to more groups . + <para> + Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups . + </para> </listitem> <listitem> - Or select the - <emphasis role="bold">Make it public</emphasis> - check box to allow everyone to access. + <para> + Or select the <emphasis role="bold">Make it public</emphasis> check box to allow everyone to access. + </para> </listitem> </itemizedlist> </para> @@ -395,4 +323,7 @@ </orderedlist> </para> </section> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Manage_Portals"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,23 +21,236 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Manage Portals</title> - <para>You can easily manage a portal by editing or deleting it.</para> - <section> + --><title>Manage Portals</title> + <para> + You can easily manage a portal by editing or deleting it. + </para> + <section id="sect-User_Guide-Manage_Portals-Edit_a_Portal"> <title>Edit a Portal</title> + <para> + You can change information of the current using portal such as properties or layout. However, you must have the edit right given by an Admininstrator. When you have edit right, follow these steps to edit the current portal: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current Portal</emphasis>. A form to edit the current portal will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditCurrentPortal.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Indicator </emphasis> + </entry> + <entry> + <emphasis role="bold"> Meaning </emphasis> + </entry> + </row> + <row> + <entry> + !images/preview.png! + </entry> + <entry> + *Preview page*: allows viewing node's page in preview mode. + </entry> + </row> + <row> + <entry> + !images/EditPage.png! + </entry> + <entry> + *Edit page properties*: allows editing node's page properties. + </entry> + </row> + <row> + <entry> + !images/ShowContainer.png! + </entry> + <entry> + *Show container*: allows listing all existing containers when editing node's page. + </entry> + </row> + <row> + <entry> + !images/ShowPortlet.png! + </entry> + <entry> + *Show portlet*: allows listing all existing portlets when editing node's page. + </entry> + </row> + <row> + <entry> + !images/Savepage.png! + </entry> + <entry> + *Save page*: allows saving changes of page when editing node's page. + </entry> + </row> + <row> + <entry> + !images/RollBack.png! + </entry> + <entry> + *Rollback*: allows canceling all changes that have not been saved. + </entry> + </row> + <row> + <entry> + !images/Abort.png! + </entry> + <entry> + *Abort*: allows canceling all changes that have not been saved and escaping Edit page and navigation form. + </entry> + </row> + <row> + <entry> + !images/Finish1.png! + </entry> + <entry> + *Finish*: allows saving all changes and escaping Edit page and navigation form. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + 2. Click!images/EditPage.png! icon to edit portal properties. + </para> + <para> + 3. Click!images/ShowContainer.png! icon to edit portal container layout. + </para> + <para> + 4. Click!images/ShowPortlet.png! icon to edit portal portlet layout. + </para> + <para> + 5. Click!images/Savepage.png! icon to save changes. + </para> + <orderedlist id="orde-User_Guide-Edit_a_Portal-For_GateIn_Portal_2.6"> + <title>For GateIn Portal 2.6</title> + <para> + You must have the edit right to change information of the current using portal: + </para> + <listitem> + <para> + 1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar -&gt;click <emphasis role="bold">Edit Site Layout</emphasis>. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortal.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Click the!images/PortalProperties.png! button in the <emphasis role="bold">Edit Inline Composer</emphasis>. The edit Form of the portal will be shown: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortal2.6New.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 3. Change the properties of the current portal. + </para> + </listitem> + <listitem> + <para> + 4. Click the <emphasis role="bold">Propertites</emphasis> tab. Select an option for <emphasis role="bold">Keep session alive</emphasis> that means keeping the working session for a long time to avoid the working time out. There are 3 options: + </para> + <itemizedlist> + <listitem> + <para> + Never : it never happens even if an application requests it. + </para> + </listitem> + <listitem> + <para> + On-demand : it starts to be used as soon as an application requests it. + </para> + </listitem> + <listitem> + <para> + Always: it's always enabled (which has a cost but the administrator will be aware of that). + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + 5. Set permissions for a portal: + </para> + <para> + To change any permission, click the <emphasis role="bold">Select Permission</emphasis> button and then select a group with the Membership type you want. Only one group can have the Edit Permission of the portal. + </para> + <para> + You can set the Edit Permission for the portal when you create or edit it. + </para> + </listitem> + <listitem> + <para> + 6. Click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </listitem> + </orderedlist> </section> - <para>You can change information of the current using portal such as - properties or layout. However, you must have the edit right given by - an Admininstrator. When you have edit right, follow these steps to - edit the current portal:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current Portal</emphasis>. A form to edit the current portal will appear:</para><mediaobject><imageobject><imagedata fileref="images/EditCurrentPortal.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Indicator </emphasis></entry><entry><emphasis role="bold"> Meaning </emphasis></entry></row><row><entry>!images/preview.png! </entry><entry> *Preview page*: allows viewing node's page in preview mode. </entry></row><row><entry>!images/EditPage.png! </entry><entry> *Edit page properties*: allows editing node's page properties. </entry></row><row><entry>!images/ShowContainer.png! </entry><entry> *Show container*: allows listing all existing containers when e! diting node's page. </entry></row><row><entry>!images/ShowPortlet.png! </entry><entry> *Show portlet*: allows listing all existing portlets when editing node's page. </entry></row><row><entry>!images/Savepage.png! </entry><entry> *Save page*: allows saving changes of page when editing node's page. </entry></row><row><entry>!images/RollBack.png! </entry><entry> *Rollback*: allows canceling all changes that have not been saved. </entry></row><row><entry> !images/Abort.png! </entry><entry> *Abort*: allows canceling all changes that have not been saved and escaping Edit page and navigation form. </entry></row><row><entry> !images/Finish1.png! </entry><entry> *Finish*: allows saving all changes and escaping Edit page and navigation form. </entry></row></tbody></tgroup></informaltable><para>2. Click!images/EditPage.png! icon to edit portal properties.</para><para>3. Click!images/ShowContainer.png! icon to edit portal container layout.</para><para>4. Click!! images/ShowPortlet.png! icon to edit portal portlet layout.</p! ara><par a>5. Click!images/Savepage.png! icon to save changes.</para><variablelist><listitem>For GateIn Portal 2.6</listitem></variablelist><para>You must have the edit right to change information of the current using portal:</para><para>1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar -&gt;click <emphasis role="bold">Edit Site Layout</emphasis>.</para><mediaobject><imageobject><imagedata fileref="images/EditPortal.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click the!images/PortalProperties.png! button in the <emphasis role="bold">Edit Inline Composer</emphasis>. The edit Form of the portal will be shown:</para><mediaobject><imageobject><imagedata fileref="images/EditPortal2.6New.png" format="PNG"></imagedata></imageobject></mediaobject><para>3. Change the properties of the current portal.</para><para>4. Click the <emphasis role="bold">Propertites</emphasis> tab. Select an option for <emphasis role="bold">Keep session alive</emphasis> that mea! ns keeping the working session for a long time to avoid the working time out. There are 3 options:</para><itemizedlist><listitem>Never : it never happens even if an application requests it.</listitem><listitem>On-demand : it starts to be used as soon as an application requests it.</listitem><listitem>Always: it's always enabled (which has a cost but the administrator will be aware of that).</listitem></itemizedlist><para>5. Set permissions for a portal:</para><para>To change any permission, click the <emphasis role="bold">Select Permission</emphasis> button and then select a group with the Membership type you want. Only one group can have the Edit Permission of the portal.</para><para>You can set the Edit Permission for the portal when you create or edit it.</para><para>6. Click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to quit.</para> -<section><title>Delete a Portal</title></section> -<para>You can easily delete a portal by following these guides:</para><para>1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Portals</emphasis></para><variablelist><listitem>For Portal 2.6</listitem></variablelist><para>+The 1^st^ way+:</para><para>1. Go to <emphasis role="bold">Administrator</emphasis> on the Toolbar --&gt; <emphasis role="bold">Manage Portals</emphasis>. List of all portals will be shown.</para><para>2. Click the trash can !images/deleteIcon.png! icon in the row of the portal you want to delete in the portal list.</para><para>3. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to delete.</para><para>+The 2^nd^ way+:</para><para>1. Click on <emphasis role="bold">Site</emphasis> in the Toolbar --&gt; click on!images/DeletePortal2.6.png! .The confirmation message will appear:</para><m! ediaobject><imageobject><imagedata fileref="images/SureDelete.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click <emphasis role="bold">OK</emphasis> to accept deleting a portal or <emphasis role="bold">Cancel</emphasis> to quit without deleting it.</para> -</section> \ No newline at end of file + + <section id="sect-User_Guide-Manage_Portals-Delete_a_Portal"> + <title>Delete a Portal</title> + <para> + You can easily delete a portal by following these guides: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Manage Portals</emphasis> + </para> + <para> + +The 1^st^ way+: + </para> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">Administrator</emphasis> on the Toolbar --&gt; <emphasis role="bold">Manage Portals</emphasis>. List of all portals will be shown. + </para> + </listitem> + <listitem> + <para> + 2. Click the trash can !images/deleteIcon.png! icon in the row of the portal you want to delete in the portal list. + </para> + </listitem> + <listitem> + <para> + 3. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to delete. + </para> + </listitem> + </orderedlist> + <para> + +The 2^nd^ way+: + </para> + <orderedlist> + <listitem> + <para> + 1. Click on <emphasis role="bold">Site</emphasis> in the Toolbar --&gt; click on!images/DeletePortal2.6.png! .The confirmation message will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SureDelete.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Click <emphasis role="bold">OK</emphasis> to accept deleting a portal or <emphasis role="bold">Cancel</emphasis> to quit without deleting it. + </para> + </listitem> + </orderedlist> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Page_Creation_Wizard.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Page_Creation_Wizard.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Page_Creation_Wizard.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Page_Creation_Wizard"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,15 +21,231 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Page Creation Wizard</title> + <para> + Only by following there simple steps can you create a page quickly by using a wizard and publish this page on the Navigation bar: + </para> + <para> + 1. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt;<emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Create page wizard</emphasis>. <emphasis role="bold">Welcome to Page Creation Wizard</emphasis> appears: + </para> + <para> + For GateIn Portal 2.6 + </para> + <orderedlist> + <listitem> + <para> + 1. Go to <emphasis role="bold">Editor</emphasis> --&gt; <emphasis role="bold">Add New Page</emphasis> on the Toolbar. <emphasis role="bold">Create page wizard</emphasis>: <emphasis role="bold">Welcome to Page Creation Wizard</emphasis> appears: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Welcome.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Click the <emphasis role="bold">Next</emphasis> button or number '1' of the wizard steps in order to go to step 1. This step allows users to set up page setting such as :the navigation path, the node name, the display name, etc. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Wizard1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + There are two parts: the left pane is used to show a small description that will guide you what to do in this step. And the main wizard includes two parts: the left pane contains a list of navigations and shows the page list of each selected navigation, the right pane displays main information of a page. + </para> + </listitem> + <listitem> + <para> + 3. On the left of wizard: Click the combo box icon !images/ComboBox.png! to see the navigations list. Select a navigation from the list that you want to create page. The pages list of selected navigation are displayed. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageList.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 4. Select a page from the above list or click on arrow up icon !images/ArrowIcon.png! to add a page at root. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Pagewizard1.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Current Selected Page Node + </entry> + <entry> + The path of the selected node to add a new sub page + </entry> + </row> + <row> + <entry> + Node Name + </entry> + <entry> + The node name of the added page. It is required field. This field must start with a character and must have a length between 3 and 30 characters. + </entry> + </row> + <row> + <entry> + Display Name + </entry> + <entry> + The display name of the node which contains the added page and must have a length between 3 and 30 characters. + </entry> + </row> + <row> + <entry> + Visible + </entry> + <entry> + This check box allows to hide this page. If not checked the page is under no circumstances shown, even if the publication period is OK. If checked the page or the page node appears on on the navigation bar, the page navigation and the site map. If "visible" is checked the visibility can depend on the "publication date &amp; time" option. + </entry> + </row> + <row> + <entry> + Publication date&amp;time + </entry> + <entry> + This option allows publishing the page for a period of time. If this option is checked the visibility of the page depends on the publication period start and end date. + </entry> + </row> + <row> + <entry> + Start Publication Date + </entry> + <entry> + The start date and time to publish the page + </entry> + </row> + <row> + <entry> + End Publication Date + </entry> + <entry> + The end date and time to publish the page + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> + +<emphasis role="bold">Note:</emphasis>+You can set date and time by clicking the <emphasis role="bold">Start Publication Date</emphasis> field and <emphasis role="bold">End Publication Date</emphasis> field and select a date in the calendar pop up + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Calendar.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 5. Click <emphasis role="bold">Next</emphasis> or number '2' of the wizard steps to go to step 2. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageWizard2.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 6. Select <emphasis role="bold">Empty Layout</emphasis> or click the icon to see more templates to select. + </para> + </listitem> + <listitem> + <para> + 7. Click the <emphasis role="bold">Next</emphasis> button or number '3' of the wizard step to go to step 3. You can drag portlets on the left pane and drop it on the right pane to constitute the content of this page. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/PageWizard3.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Indicator </emphasis> + </entry> + <entry> + <emphasis role="bold"> Meaning </emphasis> + </entry> + </row> + <row> + <entry> + !images/preview.png! + </entry> + <entry> + *Preview Page*: allows viewing a page in preview mode + </entry> + </row> + <row> + <entry> + !images/ShowContainer.png! + </entry> + <entry> + *Show Container*: allows listing all existing containers + </entry> + </row> + <row> + <entry> + !images/ShowPortlet.png! + </entry> + <entry> + *Show Portlets*: allows listing all existing portlets + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem> + <para> + 8. Click the <emphasis role="bold">Show Container</emphasis> icon !images/ShowContainer.png! if you want to see the existing containers and re-select the layout of the page. There will be a category list which contains specific containers when clicking the icon. + </para> + </listitem> + </orderedlist> + <para> + for GateIn Portal 2.6 + </para> + <para> + The step 2 of creating a page by wizard is the same as the above + </para> + <para> + In the step 3, you can drag portlets from the Edit Inline Composer popup and drag it to the constitute the content of this page + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Step32.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + You can click on!images/Switch.png! to view the content of this page. + </para> + <para> + Click <emphasis role="bold">Save</emphasis> to accept creating a new page, the <emphasis role="bold">Back</emphasis> button to return the previous step or the <emphasis role="bold">Abort</emphasis> button to quit without creating a new page. + </para> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Page Creation Wizard</title> - <para>Only by following there simple steps can you create a page - quickly by using a wizard and publish this page on the Navigation bar:</para> - <para> - 1. Go to - <emphasis role="bold">GateIn Start</emphasis> - -&gt;<emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> --&gt; <emphasis role="bold">Create page wizard</emphasis>. <emphasis role="bold">Welcome to Page Creation Wizard</emphasis> appears:</para><variablelist><listitem>For GateIn Portal 2.6</listitem></variablelist><para>1. Go to <emphasis role="bold">Editor</emphasis> --&gt; <emphasis role="bold">Add New Page</emphasis> on the Toolbar. <emphasis role="bold">Create page wizard</emphasis>: <emphasis role="bold">Welcome to Page Creation Wizard</emphasis> appears:</para><mediaobject><imageobject><imagedata fileref="images/Welcome.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click the <emphasis role="bold">Next</emphasis> button or number '1' of the wizard steps in order to go to step 1. This step allows users to set up page setting such as :the navigation path, the node name, the display name, etc.</para><mediaobject><imageobject><imagedata fileref="images/Wiz! ard1.png" format="PNG"></imagedata></imageobject></mediaobject><para>There are two parts: the left pane is used to show a small description that will guide you what to do in this step. And the main wizard includes two parts: the left pane contains a list of navigations and shows the page list of each selected navigation, the right pane displays main information of a page.</para><para>3. On the left of wizard: Click the combo box icon !images/ComboBox.png! to see the navigations list. Select a navigation from the list that you want to create page. The pages list of selected navigation are displayed.</para><mediaobject><imageobject><imagedata fileref="images/PageList.png" format="PNG"></imagedata></imageobject></mediaobject><para>4. Select a page from the above list or click on arrow up icon !images/ArrowIcon.png! to add a page at root.</para><mediaobject><imageobject><imagedata fileref="images/Pagewizard1.png" format="PNG"></imagedata></imageobject></mediaobject><informal! table frame="none" rowsep="0" colsep="0"><tgroup cols="2"><col! spec ali gn="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Current Selected Page Node </entry><entry> The path of the selected node to add a new sub page </entry></row><row><entry> Node Name </entry><entry> The node name of the added page. It is required field. This field must start with a character and must have a length between 3 and 30 characters. </entry></row><row><entry> Display Name </entry><entry> The display name of the node which contains the added page and must have a length between 3 and 30 characters. </entry></row><row><entry> Visible </entry><entry> This check box allows to hide this page. If not checked the page is under no circumstances shown, even if the publication period is OK. If checked the page or the page node appears on on the navigation bar, the page navigation and the site map. If &quot;visible&quot; ! is checked the visibility can depend on the &quot;publication date &amp; time&quot; option. </entry></row><row><entry> Publication date&amp;time </entry><entry> This option allows publishing the page for a period of time. If this option is checked the visibility of the page depends on the publication period start and end date. </entry></row><row><entry> Start Publication Date </entry><entry> The start date and time to publish the page </entry></row><row><entry> End Publication Date </entry><entry> The end date and time to publish the page </entry></row></tbody></tgroup></informaltable><para>+<emphasis role="bold">Note:</emphasis>+You can set date and time by clicking the <emphasis role="bold">Start Publication Date</emphasis> field and <emphasis role="bold">End Publication Date</emphasis> field and select a date in the calendar pop up</para><mediaobject><imageobject><imagedata fileref="images/Calendar.png" format="PNG"></imagedata></imageobject></mediaobject><para>5. Clic! k <emphasis role="bold">Next</emphasis> or number '2' of the w! izard st eps to go to step 2.</para><mediaobject><imageobject><imagedata fileref="images/PageWizard2.png" format="PNG"></imagedata></imageobject></mediaobject><para>6. Select <emphasis role="bold">Empty Layout</emphasis> or click the icon to see more templates to select.</para><para>7. Click the <emphasis role="bold">Next</emphasis> button or number '3' of the wizard step to go to step 3. You can drag portlets on the left pane and drop it on the right pane to constitute the content of this page.</para><mediaobject><imageobject><imagedata fileref="images/PageWizard3.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Indicator </emphasis></entry><entry><emphasis role="bold"> Meaning </emphasis></entry></row><row><entry>!images/preview.png! </entry><entry> *Preview Page*: allows viewing a page in preview! mode </entry></row><row><entry>!images/ShowContainer.png! </entry><entry> *Show Container*: allows listing all existing containers </entry></row><row><entry>!images/ShowPortlet.png! </entry><entry> *Show Portlets*: allows listing all existing portlets </entry></row></tbody></tgroup></informaltable><para>8. Click the <emphasis role="bold">Show Container</emphasis> icon !images/ShowContainer.png! if you want to see the existing containers and re-select the layout of the page. There will be a category list which contains specific containers when clicking the icon.</para><variablelist><listitem>for GateIn Portal 2.6</listitem></variablelist><para>The step 2 of creating a page by wizard is the same as the above</para><para>In the step 3, you can drag portlets from the Edit Inline Composer popup and drag it to the constitute the content of this page</para><mediaobject><imageobject><imagedata fileref="images/Step32.6.png" format="PNG"></imagedata></imageobject></mediao! bject><para>You can click on!images/Switch.png! to view the co! ntent of this page.</para><para>Click <emphasis role="bold">Save</emphasis> to accept creating a new page, the <emphasis role="bold">Back</emphasis> button to return the previous step or the <emphasis role="bold">Abort</emphasis> button to quit without creating a new page.</para> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Switching_between_Portals"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,26 +21,21 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Switching between Portals</title> - <para>GateIn Portal allows users to switch between Portals simply and - easily. You can use another portals such as gateway, starting site if - you are given the appropriate permissions by the administrators.</para> + --><title>Switching between Portals</title> <para> - Go to - <emphasis role="bold">Site</emphasis> - on the Toolbarm it will list all portals in which you have at least - the access right + GateIn Portal allows users to switch between Portals simply and easily. You can use another portals such as gateway, starting site if you are given the appropriate permissions by the administrators. </para> + <para> + Go to <emphasis role="bold">Site</emphasis> on the Toolbarm it will list all portals in which you have at least the access right + </para> <mediaobject> <imageobject> - <imagedata fileref="images/ChangePortal2.6.png" format="PNG"></imagedata> + <imagedata fileref="images/ChangePortal2.6.png" format="PNG" /> </imageobject> </mediaobject> - <para>You easily switch between Portals by simply clicking on the - portal that you want to choose and wait for few seconds to take - effect.</para> -</section> \ No newline at end of file + <para> + You easily switch between Portals by simply clicking on the portal that you want to choose and wait for few seconds to take effect. + </para> +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/Toolbar.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Toolbar.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/Toolbar.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Toolbar"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,77 +21,91 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Toolbar</title> - <para>The convenient Toolbar helps users - and administrators to manipulate all actions quickly.</para> - <section> + --><title>Toolbar</title> + <para> + The convenient Toolbar helps users and administrators to manipulate all actions quickly. + </para> + <section id="sect-User_Guide-Toolbar-User_Actions_in_the_Toolbar"> <title>User Actions in the Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/exo2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + You can change language, change skin and sign out from GateIn Portal. + </para> </section> - - <section> - <title></title> - </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/exo2.6.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>You can change language, change skin and sign out from GateIn Portal.</para> - <section> + + <section id="sect-User_Guide-Toolbar-Dashboard"> <title>Dashboard</title> + <para> + Stuff Goes Here? + </para> </section> - - <section> + + <section id="sect-User_Guide-Toolbar-Site"> <title>Site</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Site2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + It shows all different sites available in GateIn Portal allows users to directly edit the navigation tree. + </para> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/Site2.6.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>It shows all different sites available in GateIn Portal allows - users to directly edit the navigation tree.</para> - <section> + + <section id="sect-User_Guide-Toolbar-Group"> <title>Group</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/GroupPortal2.6.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + Users can easily see and access pages in GateIn Portal. + </para> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/GroupPortal2.6.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>Users can easily see and access pages in GateIn Portal.</para> - <section> + + <section id="sect-User_Guide-Toolbar-Administration_Actions_in_the_Toolbar"> <title>Administration Actions in the Toolbar</title> + <para> + Stuff Goes Here? + </para> </section> - - <section> + + <section id="sect-User_Guide-Toolbar-Editor"> <title>Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Edit.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + You easily edit a page or add a new page + </para> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/Edit.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>You easily edit a page or add a new page</para> - <section> + + <section id="sect-User_Guide-Toolbar-Administrator"> <title>Administrator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Admin2.6.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <mediaobject> - <imageobject> - <imagedata fileref="images/Admin2.6.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Toolbar-Edit_Inline"> <title>Edit Inline</title> + <para> + With the Edit Inline Composer popup that consists of two tabs: Applications and Containers, it is convenient for a user to select the component that he wants and to drag and drop it to the page. + </para> + <para> + You also quickly edit, delete portlets in a page, change portal's properties or switch the view mode. + </para> </section> - <para>With the Edit Inline Composer popup that consists of two - tabs: Applications and Containers, it is convenient for a user to - select the component that he wants and to drag and drop it to the - page.</para> - <para>You also quickly edit, delete portlets in a page, change - portal's properties or switch the view mode.</para> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-User_Management"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,134 +21,419 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>User Management</title> - <para>It is so difficult to manage and set permissions for a great - number of registered users in a system. To solve this problem, GateIn - Portal helps Administrators manage users, groups and memberships - easily as well as effectively.</para> + --><title>User Management</title> <para> - Go to - <emphasis role="bold">Administration</emphasis> - / - <emphasis role="bold">Community Management</emphasis> - (or Organization/Management). The - <emphasis role="bold">Organization</emphasis> - form appears: + It is so difficult to manage and set permissions for a great number of registered users in a system. To solve this problem, GateIn Portal helps Administrators manage users, groups and memberships easily as well as effectively. </para> + <para> + Go to <emphasis role="bold">Administration</emphasis> / <emphasis role="bold">Community Management</emphasis> (or Organization/Management). The <emphasis role="bold">Organization</emphasis> form appears: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/UserManage.png" format="PNG"></imagedata> + <imagedata fileref="images/UserManage.png" format="PNG" /> </imageobject> </mediaobject> - <section> + <section id="sect-User_Guide-User_Management-Manage_Users"> <title>Manage Users</title> + <para> + Select the <emphasis role="bold">User Management</emphasis> tab in the <emphasis role="bold">Organization</emphasis> form. By default, it will show all existing registered users. With <emphasis role="bold">User Management</emphasis> , you can see all existing registered users, and also search, edit, delete them. For each user, you can see his groups and his memberships (roles) in these groups. You can not add users to a group but you can remove them from the group. + </para> </section> - <para> - Select the - <emphasis role="bold">User Management</emphasis> - tab in the - <emphasis role="bold">Organization</emphasis> - form. By default, it will show all existing registered users. With - <emphasis role="bold">User Management</emphasis> - , you can see all existing registered users, and also search, edit, - delete them. For each user, you can see his groups and his memberships - (roles) in these groups. You can not add users to a group but you can - remove them from the group. - </para> - <section> + + <section id="sect-User_Guide-User_Management-Search_a_user"> <title>Search a user</title> + <para> + The Administrator can search users by user name, first name, last name or email address. + </para> + <orderedlist> + <listitem> + <para> + 1. Type the search term related to the user that you want to search. You do not need to enter an exact term. + </para> + </listitem> + <listitem> + <para> + 2. Select the field in which you would like to search + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/SearchUser.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 3. Click the magnifying glass icon!images/SearchIcon.png! to perform searching. It will return a searching result in form. + </para> + </listitem> + </orderedlist> </section> - <para>The Administrator can search users by user name, first name, - last name or email address.</para> - <para>1. Type the search term related to the user that you want to - search. You do not need to enter an exact term.</para> - <para>2. Select the field in which you would like to search</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/SearchUser.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>3. Click the magnifying glass icon!images/SearchIcon.png! to - perform searching. It will return a searching result in form.</para> - <section> + + <section id="sect-User_Guide-User_Management-Edit_a_user"> <title>Edit a user</title> + <orderedlist> + <listitem> + <para> + 1. Click the edit icon!images/EditIcon.png! corresponding to the user that you want to edit. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Demo1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Select the <emphasis role="bold">Account Info</emphasis> tab to view and change the essential user information . + </para> + <itemizedlist> + <listitem> + <para> + The <emphasis role="bold">User Name</emphasis> field can not be changed, other fields <emphasis role="bold">First Name</emphasis> , <emphasis role="bold">Last Name</emphasis> , <emphasis role="bold">Email Address</emphasis> can be changed. + </para> + </listitem> + <listitem> + <para> + The <emphasis role="bold">Change Password</emphasis> option allows making a new password for this user when he/she forgets his/her password. When the <emphasis role="bold">Change Password</emphasis> option is unchecked, <emphasis role="bold">New Password</emphasis> and <emphasis role="bold">Confirm Password</emphasis> are hidden. Passwords must contain at least 6 characters (letters, numbers and punctuation marks). + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + 3. Select the <emphasis role="bold">User Profile</emphasis> tab to view and change profile information. The <emphasis role="bold">Language</emphasis> field is used to set the display language of that user. + </para> + </listitem> + <listitem> + <para> + 4. Select the <emphasis role="bold">User Membership</emphasis> tab to see user's information in groups. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Demo3.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + The <emphasis role="bold">User Membership</emphasis> tab indicates to which group the selected user belongs. In the above figure, the user "demo" is a member of two groups: "guests" and "users". The parent group of both is "platform". + </para> + </listitem> + <listitem> + <para> + To remove the user from a group, click the trash can icon!images/DeleteIcon.png! on the row you want. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + 5. Click the <emphasis role="bold">Save</emphasis> button to accept changes. + </para> + </listitem> + </orderedlist> </section> - <para>1. Click the edit icon!images/EditIcon.png! corresponding to - the user that you want to edit.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Demo1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para> - 2. Select the - <emphasis role="bold">Account Info</emphasis> - tab to view and change the essential user information . - </para> - <itemizedlist> - <listitem> - The - <emphasis role="bold">User Name</emphasis> - field can not be changed, other fields - <emphasis role="bold">First Name</emphasis> - , - <emphasis role="bold">Last Name</emphasis> - , - <emphasis role="bold">Email Address</emphasis> - can be changed. - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - The - <emphasis role="bold">Change Password</emphasis> - option allows making a new password for this user when he/she forgets - his/her password. When the - <emphasis role="bold">Change Password</emphasis> - option is unchecked, - <emphasis role="bold">New Password</emphasis> - and - <emphasis role="bold">Confirm Password</emphasis> - are hidden. Passwords must contain at least 6 characters (letters, - numbers and punctuation marks). - </listitem> - </itemizedlist> - <para> - 3. Select the - <emphasis role="bold">User Profile</emphasis> - tab to view and change profile information. The - <emphasis role="bold">Language</emphasis> - field is used to set the display language of that user. - </para> - <para> - 4. Select the - <emphasis role="bold">User Membership</emphasis> - tab to see user's information in groups. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Demo3.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <itemizedlist> - <listitem> - The - <emphasis role="bold">User Membership</emphasis> - tab indicates to which group the selected user belongs. In the above - figure, the user &quot;demo&quot; is a member of two groups: &quot;guests&quot; and &quot;users&quot;. The parent group of both is &quot;platform&quot;.</listitem><listitem>To remove the user from a group, click the trash can icon!images/DeleteIcon.png! on the row you want.</listitem></itemizedlist><para>5. Click the <emphasis role="bold">Save</emphasis> button to accept changes.</para><section><title>Delete a user</title></section> -<para>1. In the <emphasis role="bold">User Management</emphasis> form: Click the trash can icon !images/DeleteIcon.png! corresponding to the user that you want to delete.</para><para>2. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to confirm or the <emphasis role="bold">Cancel</emphasis> button to quit without deleting anything.</para><section><title>Manage Groups</title></section> -<para>Select the <emphasis role="bold">Group Management</emphasis> tab in the <emphasis role="bold">Organization</emphasis> form.</para><para>By default, all existing groups will be displayed on the left pane. This tab is used to add new, edit or delete a group. The right pane shows information about the selected group including information about the members in the specific group and a small form to add a new user to a group.</para><mediaobject><imageobject><imagedata fileref="images/GroupManage.png" format="PNG"></imagedata></imageobject></mediaobject><section><title>Add a new group</title></section> -<para>1. Choose the path to create a new group by selecting the groups from list on the left pane or clicking the arrow icon !images/ArrowIcon.png! if you want to create a group in a higher level. The selected path is displayed in the path bar.</para><mediaobject><imageobject><imagedata fileref="images/Admin1.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Click the <emphasis role="bold">Add New Group</emphasis> icon. The <emphasis role="bold">Add New Group</emphasis> form will be displayed on the right pane:</para><mediaobject><imageobject><imagedata fileref="images/AddGroup.png" format="PNG"></imagedata></imageobject></mediaobject><informaltable frame="none" rowsep="0" colsep="0"><tgroup cols="2"><colspec align="center"></colspec><colspec align="center"></colspec><tbody><row><entry><emphasis role="bold"> Name </emphasis></entry><entry><emphasis role="bold"> Description </emphasis></entry></row><row><entry> Group Name </entry><entry> The name of the new! group. This field is required and any length from 3 to 30 characters is allowed. </entry></row><row><entry> Label </entry><entry> The display name of the group. Any length from 3 to 30 characters is allowed. </entry></row><row><entry> Description </entry><entry> The description about the group. Any length from 3 to 30 characters is allowed. </entry></row></tbody></tgroup></informaltable><para>3. Fill in the required fields. Only alpha, digit and underscore characters are allowed for the <emphasis role="bold">Group Name</emphasis> field and it must be unique.</para><para>4. Click the <emphasis role="bold">Save</emphasis> button to accept entered values or the <emphasis role="bold">Cancel</emphasis> button to quit.</para><section><title>Edit a group</title></section> -<para>1. Select the path to the group you want to edit by selecting the groups from list on the left pane.</para><para>2. Click the edit icon!images/EditIcon1.png! to show the <emphasis role="bold">Edit Group</emphasis> form of the selected group. This form is identical with the <emphasis role="bold">New Group</emphasis> form.</para><para>3. You can not change the Group Name. Make changes for a <emphasis role="bold">Label</emphasis> or a <emphasis role="bold">Description</emphasis> field and then click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to cancel changes and return to the <emphasis role="bold">Group Info</emphasis> form.</para><section><title>Add a new user to the group</title></section> -<para>1. Select the path to the group you want to edit by selecting the groups from the list on the left pane. The Group's information is displayed including the user list and a form which allows to add a new user.</para><mediaobject><imageobject><imagedata fileref="images/AddMember1.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Enter the exact user name of the user that you want to add to the selected group or you can enter some characters if you are not sure about the exact spelling.</para><itemizedlist><listitem>Click the magnifying glass icon!images/MagnifyIcon.png! to select users.</listitem><listitem>After clicking the magnifying icon!images/MagnifyIcon.png! , there will be a list of all existing users :</listitem></itemizedlist><mediaobject><imageobject><imagedata fileref="images/SelectUser.png" format="PNG"></imagedata></imageobject></mediaobject><itemizedlist><listitem>Select the check box of the user (s) that you would like to add to the gr! oup.</listitem></itemizedlist><itemizedlist><listitem>After clicking the <emphasis role="bold">Add</emphasis> button you will see the complete user name(s) in the <emphasis role="bold">Add member</emphasis> form.</listitem></itemizedlist><para>3. Select the membership for the user in a group from memberships list. The refresh icon!images/RefreshIcon.png! can be used to update the memberships list in case there are any changes.</para><para>4. Click the <emphasis role="bold">Save</emphasis> button to accept adding the selected user to a specific group with the selected membership type.</para><section><title>Edit the User Membership in a Group</title></section> -<para>1. Click the edit icon!images/EditIcon.png! corresponding to a specific user with a membership in the <emphasis role="bold">Group Info</emphasis> table to open the <emphasis role="bold">Edit Membership</emphasis> form :</para><mediaobject><imageobject><imagedata fileref="images/EditMember1.png" format="PNG"></imagedata></imageobject></mediaobject><para>2. Change the membership of the selected user by selecting another value in the <emphasis role="bold">Membership</emphasis> field.</para><para>3. Complete editing the selected user by clicking the <emphasis role="bold">Save</emphasis> button.</para><section><title>Delete a group</title></section> -<para>1. Select the path to the group you want to delete by selecting the groups from list on the left pane.</para><para>2.Click the trash can !images/DeleteIcon.png! icon in order to delete.</para><para>3.Click the <emphasis role="bold">OK</emphasis> button on the confirmation message to accept or the <emphasis role="bold">Cancel</emphasis> button to quit without deleting.</para><section><title>Manage Memberships</title></section> -<para>The roles of an user in the specific group are managed in <emphasis role="bold">Membership Management</emphasis> form. Currently there are three membership types: Manager, Member and Validator. By default, Manager has the highest rights in a group. You can add new, edit or delete a membership type. Select the <emphasis role="bold">Membership Management</emphasis> tab in the <emphasis role="bold">Organization</emphasis> portlet. There will be a membership type list and a form to add new/edit:</para><mediaobject><imageobject><imagedata fileref="images/MembershipManage1.png" format="PNG"></imagedata></imageobject></mediaobject><section><title>Add a new Membership type</title></section> -<para>1. In the <emphasis role="bold">Add/Edit Membership</emphasis> form at the bottom, the input value for the membership name field (required) and the description field (optional). Only letters, digits, dots, dashes and underscores are allowed for the membership name.</para><para>2.Click the <emphasis role="bold">Save</emphasis> button to accept adding the new membership or click <emphasis role="bold">Reset</emphasis> button to clear the entered values.</para><section><title>Edit a Membership type</title></section> -<para>1. Click the edit icon!images/EditIcon.png! in the row of the membership type you want to edit. The selected Membership type information is displayed in the Add/Edit Membership form.</para><para>2. Make changes in this form.</para><para>3. Click <emphasis role="bold">Save</emphasis> to accept changes.</para><section><title>Delete a Membership type.</title></section> -<para>1. Click the trash can icon in the row of the membership type that you want to delete.</para><para>2. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to accept the deletion.</para> -</section> \ No newline at end of file + + <section id="sect-User_Guide-User_Management-Delete_a_user"> + <title>Delete a user</title> + <orderedlist> + <listitem> + <para> + 1. In the <emphasis role="bold">User Management</emphasis> form: Click the trash can icon !images/DeleteIcon.png! corresponding to the user that you want to delete. + </para> + </listitem> + <listitem> + <para> + 2. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to confirm or the <emphasis role="bold">Cancel</emphasis> button to quit without deleting anything. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Manage_Groups"> + <title>Manage Groups</title> + <para> + Select the <emphasis role="bold">Group Management</emphasis> tab in the <emphasis role="bold">Organization</emphasis> form. + </para> + <para> + By default, all existing groups will be displayed on the left pane. This tab is used to add new, edit or delete a group. The right pane shows information about the selected group including information about the members in the specific group and a small form to add a new user to a group. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/GroupManage.png" format="PNG" /> + </imageobject> + </mediaobject> + </section> + + <section id="sect-User_Guide-User_Management-Add_a_new_group"> + <title>Add a new group</title> + <orderedlist> + <listitem> + <para> + 1. Choose the path to create a new group by selecting the groups from list on the left pane or clicking the arrow icon !images/ArrowIcon.png! if you want to create a group in a higher level. The selected path is displayed in the path bar. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Admin1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Click the <emphasis role="bold">Add New Group</emphasis> icon. The <emphasis role="bold">Add New Group</emphasis> form will be displayed on the right pane: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/AddGroup.png" format="PNG" /> + </imageobject> + </mediaobject> + <informaltable colsep="0" frame="none" rowsep="0"> + <tgroup cols="2"> + <colspec align="center"></colspec> + <colspec align="center"></colspec> + <tbody> + <row> + <entry> + <emphasis role="bold"> Name </emphasis> + </entry> + <entry> + <emphasis role="bold"> Description </emphasis> + </entry> + </row> + <row> + <entry> + Group Name + </entry> + <entry> + The name of the new group. This field is required and any length from 3 to 30 characters is allowed. + </entry> + </row> + <row> + <entry> + Label + </entry> + <entry> + The display name of the group. Any length from 3 to 30 characters is allowed. + </entry> + </row> + <row> + <entry> + Description + </entry> + <entry> + The description about the group. Any length from 3 to 30 characters is allowed. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem> + <para> + 3. Fill in the required fields. Only alpha, digit and underscore characters are allowed for the <emphasis role="bold">Group Name</emphasis> field and it must be unique. + </para> + </listitem> + <listitem> + <para> + 4. Click the <emphasis role="bold">Save</emphasis> button to accept entered values or the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Edit_a_group"> + <title>Edit a group</title> + <orderedlist> + <listitem> + <para> + 1. Select the path to the group you want to edit by selecting the groups from list on the left pane. + </para> + </listitem> + <listitem> + <para> + 2. Click the edit icon!images/EditIcon1.png! to show the <emphasis role="bold">Edit Group</emphasis> form of the selected group. This form is identical with the <emphasis role="bold">New Group</emphasis> form. + </para> + </listitem> + <listitem> + <para> + 3. You can not change the Group Name. Make changes for a <emphasis role="bold">Label</emphasis> or a <emphasis role="bold">Description</emphasis> field and then click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to cancel changes and return to the <emphasis role="bold">Group Info</emphasis> form. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Add_a_new_user_to_the_group"> + <title>Add a new user to the group</title> + <orderedlist> + <listitem> + <para> + 1. Select the path to the group you want to edit by selecting the groups from the list on the left pane. The Group's information is displayed including the user list and a form which allows to add a new user. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/AddMember1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Enter the exact user name of the user that you want to add to the selected group or you can enter some characters if you are not sure about the exact spelling. + </para> + <itemizedlist> + <listitem> + <para> + Click the magnifying glass icon!images/MagnifyIcon.png! to select users. + </para> + </listitem> + <listitem> + <para> + After clicking the magnifying icon!images/MagnifyIcon.png! , there will be a list of all existing users : + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/SelectUser.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> + <listitem> + <para> + Select the check box of the user (s) that you would like to add to the group. + </para> + </listitem> + <listitem> + <para> + After clicking the <emphasis role="bold">Add</emphasis> button you will see the complete user name(s) in the <emphasis role="bold">Add member</emphasis> form. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + 3. Select the membership for the user in a group from memberships list. The refresh icon!images/RefreshIcon.png! can be used to update the memberships list in case there are any changes. + </para> + </listitem> + <listitem> + <para> + 4. Click the <emphasis role="bold">Save</emphasis> button to accept adding the selected user to a specific group with the selected membership type. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Edit_the_User_Membership_in_a_Group"> + <title>Edit the User Membership in a Group</title> + <orderedlist> + <listitem> + <para> + 1. Click the edit icon!images/EditIcon.png! corresponding to a specific user with a membership in the <emphasis role="bold">Group Info</emphasis> table to open the <emphasis role="bold">Edit Membership</emphasis> form : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditMember1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + 2. Change the membership of the selected user by selecting another value in the <emphasis role="bold">Membership</emphasis> field. + </para> + </listitem> + <listitem> + <para> + 3. Complete editing the selected user by clicking the <emphasis role="bold">Save</emphasis> button. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Delete_a_group"> + <title>Delete a group</title> + <orderedlist> + <listitem> + <para> + 1. Select the path to the group you want to delete by selecting the groups from list on the left pane. + </para> + </listitem> + <listitem> + <para> + 2.Click the trash can !images/DeleteIcon.png! icon in order to delete. + </para> + </listitem> + <listitem> + <para> + 3.Click the <emphasis role="bold">OK</emphasis> button on the confirmation message to accept or the <emphasis role="bold">Cancel</emphasis> button to quit without deleting. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Manage_Memberships"> + <title>Manage Memberships</title> + <para> + The roles of an user in the specific group are managed in <emphasis role="bold">Membership Management</emphasis> form. Currently there are three membership types: Manager, Member and Validator. By default, Manager has the highest rights in a group. You can add new, edit or delete a membership type. Select the <emphasis role="bold">Membership Management</emphasis> tab in the <emphasis role="bold">Organization</emphasis> portlet. There will be a membership type list and a form to add new/edit: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/MembershipManage1.png" format="PNG" /> + </imageobject> + </mediaobject> + </section> + + <section id="sect-User_Guide-User_Management-Add_a_new_Membership_type"> + <title>Add a new Membership type</title> + <orderedlist> + <listitem> + <para> + 1. In the <emphasis role="bold">Add/Edit Membership</emphasis> form at the bottom, the input value for the membership name field (required) and the description field (optional). Only letters, digits, dots, dashes and underscores are allowed for the membership name. + </para> + </listitem> + <listitem> + <para> + 2.Click the <emphasis role="bold">Save</emphasis> button to accept adding the new membership or click <emphasis role="bold">Reset</emphasis> button to clear the entered values. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Edit_a_Membership_type"> + <title>Edit a Membership type</title> + <orderedlist> + <listitem> + <para> + 1. Click the edit icon!images/EditIcon.png! in the row of the membership type you want to edit. The selected Membership type information is displayed in the Add/Edit Membership form. + </para> + </listitem> + <listitem> + <para> + 2. Make changes in this form. + </para> + </listitem> + <listitem> + <para> + 3. Click <emphasis role="bold">Save</emphasis> to accept changes. + </para> + </listitem> + </orderedlist> + </section> + + <section id="sect-User_Guide-User_Management-Delete_a_Membership_type."> + <title>Delete a Membership type.</title> + <orderedlist> + <listitem> + <para> + 1. Click the trash can icon in the row of the membership type that you want to delete. + </para> + </listitem> + <listitem> + <para> + 2. Click the <emphasis role="bold">OK</emphasis> button in the confirmation message to accept the deletion. + </para> + </listitem> + </orderedlist> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Dashboard_Portlet"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,159 +21,146 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Dashboard Portlet</title> - <section> + --><title>Dashboard Portlet</title> + <section id="sect-User_Guide-Dashboard_Portlet-Overview"> <title>Overview</title> + <para> + The Dashboard portlet is used for hosting mini applications known as gadgets. The Dashboard uses a variety of graphical effects for displaying, opening and using gadgets. Gadgets can be moved around, rearranged, deleted and created. More than one instance of the same gadget can be opened at the same time, each instance of the very same gadget can have different settings. The gadgets instances are as independent as different portlets instances. + </para> + <para> + This portlet includes two parts : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Dashboard1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>The Dashboard portlet is used for hosting mini applications - known as gadgets. The Dashboard uses a variety of graphical effects - for displaying, opening and using gadgets. Gadgets can be moved - around, rearranged, deleted and created. More than one instance of the - same gadget can be opened at the same time, each instance of the very - same gadget can have different settings. The gadgets instances are as - independent as different portlets instances.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Dashboard1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Dashboard_Portlet-Open_the_Dashboard_Workspace"> <title>Open the Dashboard Workspace</title> - </section> - <para> - Click on - <emphasis role="bold">Add Gadgets</emphasis> - to open the Dashboard Workspace. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Dash2.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>This portlet includes two parts :</para> - <figure> - <title>A popup window that lists all gadgets. By default, there are - four gadgets but - you can add more.</title> - </figure> - <itemizedlist> - <listitem> - <emphasis role="bold">Calculator</emphasis> - : This is a cool calculator for your page. This mini application lets - you perform most of the basic arithmetic operations. This gadget also - offers cool skins to make your page more alive. - </listitem> - <listitem> - <emphasis role="bold">Calendar</emphasis> - : A cool calendar to keep track of date. You also can switch easily - between daily, monthly and yearly view and change the skin as you - like. - </listitem> - <listitem> - <emphasis role="bold">Todo</emphasis> - : This mini application helps you to organize your everyday work. It - is designed to keep track of your tasks in a convenient and - transparent way. You can highlight tasks by using different colors. - </listitem> - <listitem> - <emphasis role="bold">RSS Reader</emphasis> - : This gadget lets you get a sneak preview of your favorite feeds - around the web. You can have the latest news, the latest posts from - your favorite blogs, latest email... all in one gadget. - </listitem> - </itemizedlist> - <para>A space used to contain and organize gadgets by - dragging from the - popup window and drop them into this space.</para> - <section> - <title>Display Gadgets</title> - </section> - <para>Moreover, you can change the number of columns - to create in this space.</para> - <para> - <orderedlist> + <para> + Click on <emphasis role="bold">Add Gadgets</emphasis> to open the Dashboard Workspace. + </para> + <para> + A popup window that lists all gadgets appears. By default, there are four gadgets but you can add more. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Dash2.png" format="PNG" /> + </imageobject> + </mediaobject> + <itemizedlist> <listitem> <para> - Click on - <emphasis role="bold">Group Editor</emphasis> - : - <emphasis role="bold">Edit Page</emphasis> + <emphasis role="bold">Calculator</emphasis> : This is a cool calculator for your page. This mini application lets you perform most of the basic arithmetic operations. This gadget also offers cool skins to make your page more alive. </para> </listitem> <listitem> <para> - Click on - <emphasis role="bold">Edit Portlet</emphasis> - . It will show a dialog to change the number of columns to display - gadgets. + <emphasis role="bold">Calendar</emphasis> : A cool calendar to keep track of date. You also can switch easily between daily, monthly and yearly view and change the skin as you like. </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Column.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> </listitem> <listitem> <para> - Change the number of columns and click the - <emphasis role="bold">Save</emphasis> - button to accept changing. + <emphasis role="bold">Todo</emphasis> : This mini application helps you to organize your everyday work. It is designed to keep track of your tasks in a convenient and transparent way. You can highlight tasks by using different colors. </para> </listitem> - </orderedlist> - </para> - <section> + <listitem> + <para> + <emphasis role="bold">RSS Reader</emphasis> : This gadget lets you get a sneak preview of your favorite feeds around the web. You can have the latest news, the latest posts from your favorite blogs, latest email... all in one gadget. + </para> + </listitem> + </itemizedlist> + <para> + A space used to contain and organize gadgets by dragging from the popup window and drop them into this space. + </para> + </section> + + <section id="sect-User_Guide-Dashboard_Portlet-Display_Gadgets"> + <title>Display Gadgets</title> + <para> + Moreover, you can change the number of columns to create in this space. + </para> + <para> + <orderedlist> + <listitem> + <para> + Click on <emphasis role="bold">Group Editor</emphasis> : <emphasis role="bold">Edit Page</emphasis> + </para> + </listitem> + <listitem> + <para> + Click on <emphasis role="bold">Edit Portlet</emphasis> . It will show a dialog to change the number of columns to display gadgets. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Column.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + <listitem> + <para> + Change the number of columns and click the <emphasis role="bold">Save</emphasis> button to accept changing. + </para> + </listitem> + </orderedlist> + </para> + </section> + + <section id="sect-User_Guide-Dashboard_Portlet-Add_Gadgets"> <title>Add Gadgets</title> - <para>You can also add more gadgets, do as follows:</para> - <para>Open the popup to add gadges</para> <para> + You can also add more gadgets, do as follows: + </para> + <para> + Open the popup to add gadges + </para> + <para> <orderedlist> <listitem> <para> - Click the - <emphasis role="bold">Add Gadgets</emphasis> - link + Click the <emphasis role="bold">Add Gadgets</emphasis> link <mediaobject> <imageobject> - <imagedata fileref="images/Dashboard1.png" format="PNG"></imagedata> + <imagedata fileref="images/Dashboard1.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> <para> - dialog to add a new gadget will appear : + dialog to add a new gadget will appear : <mediaobject> <imageobject> - <imagedata fileref="images/EnterLink.png" format="PNG"></imagedata> + <imagedata fileref="images/EnterLink.png" format="PNG" /> </imageobject> </mediaobject> </para> </listitem> <listitem> - <para>Enter a link (a .xml or .rss) in a text box on the left - pane.</para> - <note>If you enter a .rss file or a link that - generate rss format - (for example: - http://feeds.feedburner.com/gatein), a new rss gadget - reader will be - created in the dashboard.</note> <para> - Remote gadgets can be only created using the .xml file format - which - s the standard gadget format.</para> + Enter a link (a .xml or .rss) in a text box on the left pane. + </para> + <note> + <title>Note</title> + <para> + If you enter a .rss file or a link that generate rss format (for example: http://feeds.feedburner.com/gatein), a new rss gadget reader will be created in the dashboard. + </para> + </note> + <para> + Remote gadgets can be only created using the .xml file format which s the standard gadget format. + </para> </listitem> <listitem> - <para>Click on the + icon to add a new gadget - to the gadget - list beneath.</para> + <para> + Click on the + icon to add a new gadget to the gadget list beneath. + </para> </listitem> </orderedlist> </para> </section> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/FCK_Portlet.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portletsUser/FCK_Portlet.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/FCK_Portlet.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-FCK_Portlet"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,68 +21,70 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>FCK Portlet</title> - <section> + --><title>FCK Portlet</title> + <section id="sect-User_Guide-FCK_Portlet-Overview"> <title>Overview</title> + <para> + GateIn Portal provides users with FCK portlet used as a lightweight text editor in the web pages. All its common used functions (like Word editor) such as writing, formatting text, creating tables, inserting links or picture, etc. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/FCK1.png" format="PNG" /> + </imageobject> + </mediaobject> + <para> + FCK portlet also consists of some main elements: + </para> </section> - <para>GateIn Portal provides users with FCK portlet used as a - lightweight text editor in the web pages. All its common used - functions (like Word editor) such as writing, formatting text, - creating tables, inserting links or picture, etc.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/FCK1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <para>FCK portlet also consists of some main elements:</para> - <section> + + <section id="sect-User_Guide-FCK_Portlet-Toolbar"> <title>Toolbar</title> + <para> + The area at the top of the editor which contains many different buttons. You will use these buttons to activate the program functions. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ToolBar1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>The area at the top of the editor which contains many - different buttons. You will use these buttons to activate the program - functions.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/ToolBar1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-FCK_Portlet-Editing_Area"> <title>Editing Area</title> + <para> + This area is under the toolbar. This area allows typing your text and format document. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditingArea1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This area is under the toolbar. This area allows typing your - text and format document.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/EditingArea1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-FCK_Portlet-Context_menu"> <title>Context menu</title> + <para> + It is a menu with the functions that will appear when you right click anywhere in the space of editing area or an existing object. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ContextMenu1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>It is a menu with the functions that will appear when you right - click anywhere in the space of editing area or an existing object.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/ContextMenu1.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-FCK_Portlet-Dialogs"> <title>Dialogs</title> + <para> + Small windows appear when some of the functions are activated, it is used to provide the necessary information to accomplish that functions. For an example: To insert a link, you need to open <emphasis role="bold">Link</emphasis> dialog by clicking!images/LinkIcon.png! icon on the Tool bar : + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Link.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para> - Small windows appear when some of the functions are activated, it is - used to provide the necessary information to accomplish that - functions. For an example: To insert a link, you need to open - <emphasis role="bold">Link</emphasis> - dialog by clicking!images/LinkIcon.png! icon on the Tool bar : - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Link.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Functional_Portlets"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,84 +21,86 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Functional Portlets</title> - <section> + --><title>Functional Portlets</title> + <section id="sect-User_Guide-Functional_Portlets-Overview"> <title>Overview</title> + <para> + Portlets are pluggable user interface components that are managed and displayed in a portal. Functional Portlets support all functions of a Portal. GateIn Portal provides users with the following portlets: + </para> </section> - <para>Portlets are pluggable user interface components that are - managed and displayed in a portal. Functional Portlets support all - functions of a Portal. GateIn Portal provides users with the following - portlets:</para> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Account_Portlet"> <title>Account Portlet</title> + <para> + This Portlet allows users to register a new account. Moreover, it also used to support users to choose a preferred language for displaying the Portal interface. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Account.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This Portlet allows users to register a new account. - Moreover, it also used to support users to choose a preferred language - for displaying the Portal interface.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Account.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Organization_Portlet"> <title>Organization Portlet</title> + <para> + This Portlet is used to manage user information, groups of users and memberships. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/OrganizationPortlet1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This Portlet is used to manage user information, groups of - users and memberships.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/OrganizationPortlet1.png" - format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Application_Registry_Portlet"> <title>Application Registry Portlet</title> + <para> + This Portlet is used to manage different application categories. You can add, edit, set permissions, delete a category and its applications. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/ApplicationRegistry.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This Portlet is used to manage different application - categories. You can add, edit, set permissions, delete a category and - its applications.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/ApplicationRegistry.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Internationalization_Portlet"> <title>Internationalization Portlet</title> + <para> + This Portlet is used to define a word or a phrase of a current language to an expected language. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InternationalizationPortlet1.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This Portlet is used to define a word or a phrase of a - current language to an expected language.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/InternationalizationPortlet1.png" - format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Administration_Toolbar_Portlet"> <title>Administration Toolbar Portlet</title> + <para> + This Portlet supports administration actions in GateIn Portal. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Administration.png" format="PNG" /> + </imageobject> + </mediaobject> </section> - <para>This Portlet supports administration actions in GateIn Portal.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Administration.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> - <section> + + <section id="sect-User_Guide-Functional_Portlets-Star_Toolbar_Portlet"> <title>Star Toolbar Portlet</title> - </section> - <para>The Star Toolbar Portlet helps users to change language, - change skin or sign out GateIn Portal.</para> - <!-- + <para> + The Star Toolbar Portlet helps users to change language, change skin or sign out GateIn Portal. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/StarPortlet.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> - <!-- + --><!-- <section> <title>User Toolbar Portlet</title> </section> @@ -104,5 +110,9 @@ <imagedata fileref="images/UserToolbar.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> -</section> \ No newline at end of file + --> + </section> + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Interface_Portlets"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,166 +21,168 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Interface Portlets</title> - <para>These Portlets constitute the interface of the Portal. - GateIn - Portal consists of the following Interface Portlets:</para> - <section> + --><title>Interface Portlets</title> + <para> + These Portlets constitute the interface of the Portal. GateIn Portal consists of the following Interface Portlets: + </para> + <section id="sect-User_Guide-Interface_Portlets-Banner_Portlet"> <title>Banner Portlet</title> - <para>This Portlet is considered as the welcome gateway of a - Portal. It contains the organization's slogan, logo, icon, button, - etc.</para> - <!-- + <para> + This Portlet is considered as the welcome gateway of a Portal. It contains the organization's slogan, logo, icon, button, etc. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/BannerPortlet.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Breadcumbs_Portlet"> <title>Breadcumbs Portlet</title> - <para>This Portlet is used to display the path of the selected - page - from Navigation.</para> - <!-- + <para> + This Portlet is used to display the path of the selected page from Navigation. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/Breadcumbs.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <!-- + + <!-- <section> <title>Console Portlet</title> <para>This Portlet is used as console to run Java Script commands.</para> <mediaobject> <imageobject> <imagedata fileref="images/Console.png" format="PNG"></imagedata> </imageobject> </mediaobject> </section> - --> - <section> + --> + <section id="sect-User_Guide-Interface_Portlets-Footer_Portlet"> <title>Footer Portlet</title> - <para>This Portlet provides the footer for a site. Footer can be a - text, images that are displayed at the bottom of a web site. It - provides information about author/institutional sponsor, revision - date, copyright, comments form, and navigational links.</para> - <!-- + <para> + This Portlet provides the footer for a site. Footer can be a text, images that are displayed at the bottom of a web site. It provides information about author/institutional sponsor, revision date, copyright, comments form, and navigational links. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/Footer.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-HomePage_Portlet"> <title>HomePage Portlet</title> - <para>This Portlet is used to provide a home page for a portal. - The - home page is a main page displayed firstly when you visit the site.</para> - <!-- + <para> + This Portlet is used to provide a home page for a portal. The home page is a main page displayed firstly when you visit the site. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/PortletHome2.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Iframe_Portlet"> <title>Iframe Portlet</title> - <para>This Portlet is used to create IFrame elements for a site. - Iframe is a HTML element which can embed a document into a HTML - document. So embedded data is displayed inside a sub window of - browser - window.</para> - <!-- + <para> + This Portlet is used to create IFrame elements for a site. Iframe is a HTML element which can embed a document into a HTML document. So embedded data is displayed inside a sub window of browser window. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/IFrame.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Navigation_Portlet"> <title>Navigation Portlet</title> - <para>This Portlet provides a navigation bar. A navigation likes a - menu that helps users to visualize the structure of a site and - provide - links to quickly move from page to page.</para> - <!-- + <para> + This Portlet provides a navigation bar. A navigation likes a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/NavigationPortlet.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Sitemap_Portlet"> <title>Sitemap Portlet</title> - <para>This Portlet is used to provide a site map page of a web - site. It lists pages on a website, typically organized in - hierarchical - fashion.</para> - <!-- + <para> + This Portlet is used to provide a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion. + </para> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/SiteMap3.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> + --> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Web_Explorer_Portlet"> <title>Web Explorer Portlet</title> - <para>This Portlet provides web-browser for users. It allows users - to connect to other sites over Internet.</para> + <para> + This Portlet provides web-browser for users. It allows users to connect to other sites over Internet. + </para> <mediaobject> <imageobject> - <imagedata fileref="images/WebExplorer1.png" format="PNG"></imagedata> + <imagedata fileref="images/WebExplorer1.png" format="PNG" /> </imageobject> </mediaobject> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Dashboard_Portlet"> <title>Dashboard Portlet</title> - <para>This portlet is used for hosting mini - applications known - as - gadgets. The dashboard uses a variety of graphical effects for - displaying, opening, and using gadgets.</para> + <para> + This portlet is used for hosting mini - applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets. + </para> <mediaobject> <imageobject> - <imagedata fileref="images/Dashboard1.png" format="PNG"></imagedata> + <imagedata fileref="images/Dashboard1.png" format="PNG" /> </imageobject> </mediaobject> <para> - See more details in - <link linkend="Dashboard Portlet">Dashboard Portlet</link> + See more details in <xref linkend="sect-User_Guide-Dashboard_Portlet" /> </para> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-Gadget_Wrapper_Portlet"> <title>Gadget Wrapper Portlet</title> - <para>This Portlet allows users to view a gadget in canvas mode. - <mediaobject> - <imageobject> - <imagedata fileref="images/GadgetWrapper.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> + <para> + This Portlet allows users to view a gadget in canvas mode. + <mediaobject> + <imageobject> + <imagedata fileref="images/GadgetWrapper.png" format="PNG" /> + </imageobject> + </mediaobject> </para> </section> - <section> + + <section id="sect-User_Guide-Interface_Portlets-FCK_editor_Portlet"> <title>FCK editor Portlet</title> - <para>All its common used functions (like Word editor) such as - writing, formatting text, creating tables, inserting links or - picture, - etc.</para> + <para> + All its common used functions (like Word editor) such as writing, formatting text, creating tables, inserting links or picture, etc. + </para> <mediaobject> <imageobject> - <imagedata fileref="images/FCK1.png" format="PNG"></imagedata> + <imagedata fileref="images/FCK1.png" format="PNG" /> </imageobject> </mediaobject> <para> - See more details in - <link linkend="FCK Portlet">FCK Portlet</link> + See more details in <xref linkend="sect-User_Guide-FCK_Portlet" /> </para> </section> -</section> \ No newline at end of file + +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Gadget_concept"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,78 +21,56 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Gadget concept</title> + --><title>Gadget</title> <para> - A gadget is a mini web application running on a platform - and an user - can put it in a web page. GateIn Portal provides some useful - gadgets - such as: - <itemizedlist> - <listitem> + A gadget is a mini web application that a portal user can to their web page. EPP provides some useful gadgets such as: + </para> + <formalpara> + <title>Calculator</title> <para> - <emphasis role="bold">Calculator gadget</emphasis> - : This is the coolest calculator for your page. This - mini-application lets you perform most of the basic arithmetic - operations - and also offers cool skins to make your page more alive. - <mediaobject> - <imageobject> - <imagedata fileref="images/Calculator.png" format="PNG"></imagedata> - </imageobject> - </mediaobject> + This mini-application lets you perform most basic arithmetic operations and can be themed to match the rest of your portal. </para> - </listitem> - <listitem> + </formalpara> + <mediaobject> + <imageobject> + <imagedata fileref="images/Calculator.png" format="PNG" /> + </imageobject> + </mediaobject> + <formalpara> + <title>Calendar</title> <para> - <emphasis role="bold">Calendar gadget</emphasis> - : A cool calendar help users keep track of date. You also can - switch - easily between daily, monthly and yearly view and change skin - that - you like. + The calendar gadget allows users to switch easily between daily, monthly and yearly view and, again, is customizable to match your portal's theme. + </para> + </formalpara> <mediaobject> <imageobject> - <imagedata fileref="images/Calendar.png" format="PNG"></imagedata> + <imagedata fileref="images/Calendar.png" format="PNG" /> </imageobject> </mediaobject> - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">Todo gadget</emphasis> - : This mini-application helps you organize your day and work - group. - It is designed to keep track of your tasks in a convenient - and - transparent way. You can highlight tasks by coloring tasks with - different colors. + <formalpara> + <title>Todo</title> + <para> + This application helps you organize your day and work group. It is designed to keep track of your tasks in a convenient and transparent way. Tasks can be highlighted with different colors. + </para> + </formalpara> <mediaobject> <imageobject> - <imagedata fileref="images/Todo.png" format="PNG"></imagedata> + <imagedata fileref="images/Todo.png" format="PNG" /> </imageobject> </mediaobject> - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">RSS Reader</emphasis> - : This gadget lets you get a sneak preview of your favorite feeds - from the web. You can get the latest news, the latest posts from - your - favorite blogs, the latest email...all in one gadget. This - gadget is - a web based for receiving and viewing RSS feeds. - </para> - <!-- + <formalpara> + <title>RSS Reader</title> + <para> + An RSS reader, or aggregator, collates content from various, user-specified feed sources and displays them in one location. This content can include, but isn't limited to, news headlines, blog posts or email. The RSS Reader gadget displays this content in a single window on your Portal page. + </para> + </formalpara> + <!-- <mediaobject> <imageobject> <imagedata fileref="images/RSS.png" format="PNG"></imagedata> </imageobject> </mediaobject> - --> - </listitem> - </itemizedlist> + --> + <para> + Further gadgets can be obtained from the <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadget</ulink> site. EPP is compatible with any gadget available here. </para> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/terms/Navigation_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Navigation_concept.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Navigation_concept.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Navigation_concept"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,34 +21,28 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Navigation</title> + <para> + Portal navigations are menus that list hyperlinks to other parts of a Portal. They can help users to visualize the structure of a site. The navigation menus in EPP 5.0 are located in a bar across the top of the 'Home' page. There are three navigation types: + </para> + <formalpara> + <title>Site</title> + <para> + This navigation links to separate sites of the main Portal. Each site has only one navigation and it is automatically created when the site is created. This functionality allows different sites to administer some Portal aspects, such as portlets, individually while maintaining other content standaradized with the parent Portal. + </para> + </formalpara> + <formalpara> + <title>Group</title> + <para> + The content of this navigation differs depending on the type of account logged in. For user accounts the Groups navigation holds personal links set up by the user. For management accounts, it keeps the links to pages for registered Portal users as well as adminisrative tasks and personal links. In the administrator account, the navigation adds further management abilities such as Internationalization and community management. + </para> + </formalpara> + <formalpara> + <title>Dashboard</title> + <para> + Each user has own navigation 'Dashboard' that houses links and portlets (or gadgets) that the user has selected. A user's navigation is created automatically when user is registered. This navigation only can be deleted when the user is deleted. + </para> + </formalpara> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Navigation concept</title> - <para>A navigation is a menu that helps users to - visualize the structure of a site and provides hyper links to quickly - move from page to page. There is a bar which contains navigations - called Navigation bar. There are three navigation types:</para> - <itemizedlist> - <listitem> - <emphasis role="bold">Portal navigation</emphasis> - : This navigation type is used to keep the links to pages of Portal. - Each portal has only one navigation and it is automatically created - when a portal is created. - </listitem> - <listitem> - <emphasis role="bold">Group navigation</emphasis> - : All registered users are organized in groups. There is a navigation - keeping the links to all pages of each group, called group - navigation. - </listitem> - <listitem> - <emphasis role="bold">User navigation</emphasis> - : Each user has own navigation that keeps the links to pages. User's - navigation is created automatically like Navigation of Portal when - user is created (registered). This navigation only can be deleted - when the user is deleted. - </listitem> - </itemizedlist> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Permission_levels"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,45 +21,42 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Permission levels</title> - <para>There are two permission types:</para> + --><title>Permission levels</title> + <para> + There are two permission types: + </para> <itemizedlist> <listitem> - <emphasis role="bold">Access Permission</emphasis> - : allows users to use (see a page content, drag and drop portlets - into pages, sign in). The access permission can be set for a list of - groups. + <para> + <emphasis role="bold">Access Permission</emphasis> : allows users to use (see a page content, drag and drop portlets into pages, sign in). The access permission can be set for a list of groups. + </para> </listitem> <listitem> - <emphasis role="bold">Edit Permission</emphasis> - : allows users to change (change portal or page information, delete - portals or pages). The edit permission is set for only one group at - the same time. + <para> + <emphasis role="bold">Edit Permission</emphasis> : allows users to change (change portal or page information, delete portals or pages). The edit permission is set for only one group at the same time. + </para> </listitem> </itemizedlist> - <para>There are several permission levels:</para> + <para> + There are several permission levels: + </para> <itemizedlist> <listitem> - <emphasis role="bold">Portal</emphasis> - : The portal includes all pages, pages only can be accessed if the - user has also access to the Portal. + <para> + <emphasis role="bold">Portal</emphasis> : The portal includes all pages, pages only can be accessed if the user has also access to the Portal. + </para> </listitem> <listitem> - <emphasis role="bold">Page</emphasis> - : You can restrict the access permission to single pages. Users can - change page information (properties, layout) if they have the edit - permission. + <para> + <emphasis role="bold">Page</emphasis> : You can restrict the access permission to single pages. Users can change page information (properties, layout) if they have the edit permission. + </para> </listitem> <listitem> - <emphasis role="bold">Portlet</emphasis> - : When users create a page, they need to drag and drop portlets into - a page to create the page content. Some portlets are only used for - administrators, some are used for individual needs of a group thus - you have to set the appropriate access permission. + <para> + <emphasis role="bold">Portlet</emphasis> : When users create a page, they need to drag and drop portlets into a page to create the page content. Some portlets are only used for administrators, some are used for individual needs of a group thus you have to set the appropriate access permission. + </para> </listitem> </itemizedlist> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Portal_concept"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,25 +21,28 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Portal concept</title> - <para>Portal is the Web-based application software that provides - users - with personalized User Interface(UI). Through this UI, users can - easily access, search, communicate with other users, applications and - informations.</para> - <para> The - portal is responsible for UI management, personalization and - aggregation of enterprise contents and business applications.</para> - <para>Portal has two main components:</para> + --><title>Portal</title> + <para> + The Enterprise Portal Platform is a web-based application that provides users with personalized User Interface (UI). This UI allows users to easily perform actions such as searching applications or information and communicating with other users. + </para> + <para> + The Portal provides a graphical aggregation of enterprise content and business applications with flexible management and personalization options. + </para> + <para> + Portal has two main components: + </para> <itemizedlist> - <listitem>Portal Engine: takes care of pages, navigations and - preferences.</listitem> - <listitem>WebUI framework: a portlet Web framework tailored for - easy - screen composition and ajax support in Portal environment.</listitem> + <listitem> + <para> + Portal Engine: The engine renders and runs pages, navigations and preferences. + </para> + </listitem> + <listitem> + <para> + WebUI Framework: a Web framework tailored for easy screen composition and Ajax support in Portal environment. + </para> + </listitem> </itemizedlist> -</section> \ No newline at end of file +</section> + + Modified: portal/trunk/docs/user-guide/en/modules/terms/Portlet_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Portlet_concept.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Portlet_concept.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Portlet_concept"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,20 +21,13 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Portlet</title> + <para> + A portlet is a small, self-contained web application. Portlet interface components are managed and displayed within a Portal. Typically, a portal page is displayed as a collection of non-overlapping portlet windows, with each portlet window displaying a different portlet. Hence a portlet (or collection of portlets) resembles a web-based application hosted in a portal. Portlets can be configured to generated differing content. + </para> + <para> + EPP has a number of standard portlets that can be plugged into any portal. + </para> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Portlet concept</title> - <para>A portlet is a web application. Portlets are - pluggable user interface components that are managed and displayed in - a portal. Portlets produce fragments of markup code aggregated into a - portal page. Typically, a portal page is displayed as a collection of - non-overlapping portlet windows, where each portlet window displays a - portlet. Hence a portlet (or collection of portlets) resembles a - web-based application hosted in a portal. The content generated by a - portlet can vary from one user to another depending on the user who - configures that portlet.</para> - <para>GateIn has created standard portlets that can be plugged - into any portal.</para> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Public_mode_and_private_mode"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,26 +21,22 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> + --><title>Public mode and private mode</title> + <para> + Enterprise Portal Platform 5.0 has two modes: + </para> + <formalpara> + <title>Public</title> + <para> + This mode is for guest users who are not registered with the Portal. It does not require a log in and restricts the visitor to the public pages in the portal. Visitors can register an account to gain access to the restricted pages. After being registered, they can use the Private mode but must still contact the Portal administrator to get more rights or a group manager to become a member and gain access a group. + </para> + </formalpara> + <formalpara> + <title>Private</title> + <para> + This mode is for registered users. Users set a username and password during registration which they can use to sign in. This mode allows users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating hyperlinks and change the language for individual needs. + </para> + </formalpara> +</section> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Public mode and private mode</title> - <para>GateIn Portal has two modes:</para> - <itemizedlist> - <listitem> - <emphasis role="bold">Public mode</emphasis> - : this mode is for guest users (visitors) who have not registered yet - and it doesn't require to sign in so they can only visit the public - pages in a portal. Visitors can also register in order to get an - account. After being registered, they can use the private mode and - have to contact the administrator to get more rights or a group - manager in order to become a member of that group. - </listitem> - <listitem> - <emphasis role="bold">Private mode</emphasis> - : this mode is for registered users, users have to use username and - password to sign in. This mode supports users take many actions such - as :manage private resources (create private pages, edit or delete - them), &quot;borrow&quot; pages from others by creating hyperlinks to existing pages, change the language for individual needs, manage private information.</listitem></itemizedlist> -</section> \ No newline at end of file + Modified: portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml 2009-11-30 21:10:30 UTC (rev 876) +++ portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml 2009-11-30 21:17:17 UTC (rev 877) @@ -1,4 +1,8 @@ -<!-- +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<section id="sect-User_Guide-Toolbar_concept"> + <!-- Copyright (C) 2009 eXo Platform SAS. @@ -17,18 +21,15 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. ---> - -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<section> - <title>Toolbar concept</title> - <para>This is a specific bar that contains all user and - administration actions for the purpose of helping users and the - administrator access and perform actions easily, quickly and - effectively. You can see this Toolbar in GateIn Portal as below:</para> + --><title>Toolbar concept</title> + <para> + This is a specific bar that contains all user and administration actions for the purpose of helping users and the administrator access and perform actions easily, quickly and effectively. You can see this Toolbar in GateIn Portal as below: + </para> <mediaobject> <imageobject> - <imagedata fileref="images/Toolbar.png" format="PNG"></imagedata> + <imagedata fileref="images/Toolbar.png" format="PNG" /> </imageobject> </mediaobject> -</section> \ No newline at end of file +</section> + +