JBoss.orgCommunity Documentation

GateIn Documentation

GateIn

This is a very rough documentation issued from the merge, content still has to be validated, we still hope that it can help the beta testers. Thanks !

1. Introduction
1.1. Links
2. Terms
2.1. Portal concept
2.2. Portlet concept
2.3. Navigation concept
2.4. Gadget concept
2.5. Public mode and private mode
2.6. Permission levels
2.7. Toolbar concept
3. Portlets
3.1. Functional Portlets
3.1.1. Overview
3.1.2. Account Portlet
3.1.3. Organization Portlet
3.1.4. Application Registry Portlet
3.1.5. Internationalization Portlet
3.1.6. Administration Toolbar Portlet
3.1.7. Star Toolbar Portlet
3.2. Interface Portlets
3.2.1. Banner Portlet
3.2.2. Breadcumbs Portlet
3.2.3. Footer Portlet
3.2.4. HomePage Portlet
3.2.5. Iframe Portlet
3.2.6. Navigation Portlet
3.2.7. Sitemap Portlet
3.2.8. Web Explorer Portlet
3.2.9. Dashboard Portlet
3.2.10. Gadget Wrapper Portlet
3.2.11. FCK editor Portlet
3.3. Dashboard Portlet
3.3.1. Overview
3.3.2. Open the Dashboard Workspace
3.3.3. Display Gadgets
3.3.4. Add Gadgets
3.4. FCK Portlet
3.4.1. Overview
3.4.2. Toolbar
3.4.3. Editing Area
3.4.4. Context menu
3.4.5. Dialogs
4. Account
4.1. Register New Accounts
4.2.
4.3. Change Account Settings
4.3.1.
4.4. Sign In and Sign Out
4.4.1. Sign In
4.4.2. Sign Out
4.5. Account and Password Retrieval
4.6. Remember User Account
5. Portal Administration
5.1. Toolbar
5.1.1. User Actions in the Toolbar
5.1.2.
5.1.3. Dashboard
5.1.4. Site
5.1.5. Group
5.1.6. Administration Actions in the Toolbar
5.1.7. Editor
5.1.8. Administrator
5.1.9. Edit Inline
5.2. User Management
5.2.1. Manage Users
5.2.2. Search a user
5.2.3. Edit a user
5.2.4. Delete a user
5.2.5. Manage Groups
5.2.6. Add a new group
5.2.7. Edit a group
5.2.8. Add a new user to the group
5.2.9. Edit the User Membership in a Group
5.2.10. Delete a group
5.2.11. Manage Memberships
5.2.12. Add a new Membership type
5.2.13. Edit a Membership type
5.2.14. Delete a Membership type.
5.3. Manage Permission
5.3.1. Set the Access Permission on a Portal
5.3.2. Set the Edit Permission on a Portal
5.3.3. Initialize a Permission on a Page
5.3.4. Set the Access Permission on a Page
5.3.5. Set the Edit Permission on a Page
5.3.6. Set the Access Permission on a Portlet
5.4. Change Portal Skins
5.4.1. Overview
5.4.2. Change the skin permanently
5.4.3. Change the skin temporarily
5.5. Manage Page Navigation
5.5.1. Overview
5.5.2. Portal's page navigation
5.5.3. Creating a portal's navigation
5.5.4. Editing a portal's navigation
5.5.5. Deleting a portal's navigation
5.5.6. Group's page navigation
5.5.7. Editing a group's navigation
5.5.8. User's page navigation
5.5.9. Creating a user's navigation
5.5.10. Editing a user's navigation
5.5.11. Deleting a user's navigation
5.6. Manage Navigation Nodes
5.6.1. Overview
5.6.2. Add a new node
5.6.3. Edit a node
5.6.4. Copy a node
5.6.5. Clone nodes
5.6.6. Cut a node
5.6.7. Delete a node
5.7. Change Node Order
5.8. Manage Pages
5.8.1. Add a new Page in the Page List
5.8.2. Edit a Page
5.8.3. View a Page
5.8.4. Delete a Page
5.9. Page Creation Wizard
5.10. Drag and Drop the Page Body
5.11. Create a New Portal
5.12. Manage Portals
5.12.1. Edit a Portal
5.12.2. Delete a Portal
5.13. Switching between Portals
6. Language administration
6.1. Change Interface Language
6.1.1. The 1^st^ way
6.1.2. The 2^nd^ way
6.1.3. The 3^rd^ way
6.1.4. Set language for a user
6.2. RTL Support (Right To Left)
6.2.1. The Account Portlet
6.2.2. The Application Registry Portlet
6.2.3. The Internationalization Portlet:
6.2.4. The Organization Portlet:
6.2.5. The User Workspace
6.3. Multi-Language Navigation Nodes
6.3.1. Overview
6.3.2. Key Format
6.3.3. Creating Keys
6.3.4. Creating Keys using the *Create Page Wizard*
6.3.5. Creating/Editing Keys by *Edit Page Wizard*
6.3.6. Creating/Editing Keys using the *Edit Page and Navigation*
6.3.7. Internationalize Resource Keys
6.3.8. Example
6.4. Internationalization Portlet
6.4.1. Add a new Resource
6.4.2. View and Edit a Resource
6.4.3. Delete a Resource
6.4.4. Search a Resource
7. Gadgets Administration
7.1. Manage Gadgets in User Workspace
7.1.1. Add a Gadget
7.1.2. Edit a Gadget
7.1.3. Remove a Gadget
7.2. Import Portlets and Gadgets
7.3. Manage Portlets and Gadgets
7.3.1. Introduction
7.3.2. Add a new Category
7.3.3. Edit a Category
7.3.4. Delete a Category
7.3.5. Add Portlets/Gadgets to the specific Category
7.3.6. Set Access Permission on Portlets
7.3.7. View detail information of the specific Portlets
7.3.8. Add a Gadget
7.3.9. Add a remote Gadget
7.3.10. Create a new Gadget
7.3.11. Add a new Gadget to the Dashboard Portlet
7.3.12. Manage Gadgets
8. Configuration
8.1. Default Portal Configuration
8.1.1. Overview
8.1.2. Configuration
8.2. Portal Navigation Configuration
8.2.1. Overview
8.2.2. Portal Navigation
8.2.3. Portal.xml
8.2.4. Navigation.xml
8.2.5. Pages.xml
8.2.6. Portlet-preferences.xml
8.2.7. Group Navigation
8.2.8. User Navigation
8.2.9. Tips
8.2.10. Direct External Links
8.3. Predefined User Configuration
8.3.1. Overview
8.3.2. Plugin for adding users, groups and membership types
8.3.3. Membership types
8.3.4. Groups
8.3.5. Users
8.3.6. Plugin for monitoring user creation
8.4. User Workspace Configuration
8.4.1. Overview
8.4.2. Default Configuration
8.4.3. Customize the Configuration
8.4.4. Related links
8.5. Portal Default Permission Configuration
8.5.1. Overview
8.6. Database Configuration
8.6.1. Overview
8.6.2. DB and datasource configuration
8.6.3. JCR database configuration
8.7. Data Injector Configuration
8.7.1. Data Injector
8.7.2. OrganizationInitializer
8.7.3. Service configuration file
8.7.4. Parameters for Group
8.7.5. Parameters for User
8.8. Skin Configuration
8.8.1. Overview
8.8.2. Skin Switching
8.8.3. Skins in Page Markups
8.8.4. Types of Styles
8.8.5. Portlet Styles
8.8.6. How to Configure a Portal Skin
8.8.7. SkinService
8.8.8. SkinConfigListener
8.8.9. Some CSS techniques
8.8.10. Decorator pattern
8.8.11. Left margin left pattern
8.8.12. How to create a new skin
8.8.13. How to create new themes
8.9. Javascript Configuration
8.10. Dashboard configuration
8.10.1. Parameters (in edit mode)
8.10.2. owner
8.10.3. isPrivate
8.11. Authentication Token Configuration
8.11.1. Overview
8.11.2. What is token service
8.11.3. Implement token service's API
8.11.4. Configure token services
8.12. Varnish Configuration
8.12.1. Introduction
8.12.2. Overview
8.12.3. Installation of Varnish
8.12.4. Prerequisite
8.12.5. Installation
8.12.6. Varnish configuration for GateIn Portal
8.12.7. How fast is Varnish?
8.12.8. Varnish testbed configuration
8.12.9. Varnish analyzes method
8.12.10. Varnish performance analyzes
9. Integration
10. Development
10.1. Portal Lifecycle
10.1.1. Overview
10.1.2. Application Server start and stop
10.1.3. The Listener
10.2. RTL (Right To Left) Framework
10.2.1. Overview
10.2.2. Direction
10.2.3. Groovy templates
10.2.4. Stylesheet
10.2.5. Images
10.3. Internationalization Configuration
10.3.1. Overview
10.3.2. Introduction
10.3.3. Example
10.3.4. Access
10.3.5. Debugging resource bundle usage
10.4. XML Resources Bundles
10.4.1. Motivation
10.4.2. Portal support
10.4.3. XML format
10.5. Dynamic Layouts
10.5.1. Overview
10.5.2. Advanced Drag and Drop mechanism
10.5.3. Summary
10.6. JavaScript Inter Application Communication
10.6.1. Overview
10.6.2. Common topics
10.6.3. /GateIn
10.6.4. /GateIn/portal/notification
10.6.5. /GateIn/portal/changeTitle (not implemented yet)
10.6.6. /GateIn/portal/pageLoaded (not implemented yet)
10.6.7. /GateIn/portal/pageUnloaded (not implemented yet)
10.6.8. /GateIn/application/applicationLoaded (not implemented yet)
10.6.9. /GateIn/application/applicationUnloaded (not implemented yet)
10.6.10. Library
10.6.11. Syntax
10.6.12. Example
10.7. Upload Component
10.7.1. Overview
10.7.2. Upload Service
10.7.3. How to use the upload component in your application
10.8. Deactivation of the Ajax Loading Mask Layer
10.8.1. Overview
10.8.2. Purpose of requirement
10.8.3. How to deactivate ajax-loading mask in your code
10.8.4. Synchronous issue
10.9. Accessing User Profile
11. Portlet development
11.1. Web User Interface - WebUI
11.1.1. Resources
11.2. AJAX in GateIn Framework
11.2.1. Overview
11.2.2. Portlet Preparation
11.2.3. AJAX in the Groovy template
11.2.4. How JavaScript works
11.2.5. PortletResponse
11.2.6. PortalResponse
11.2.7. AjaxRequest
11.2.8. HttpResponseHandler
11.2.9. Portal Ajax Response Data Structure
11.2.10. Manage Several Popups
11.3. Groovy Templates
11.3.1. Overview
11.3.2. Basic structure
11.3.3. Groovy language
11.3.4. Linking a portlet with a template
11.3.5. Portlet configuration
11.3.6. The template file
11.4. Create a WebUI Portlet
11.4.1. Overview
11.4.2. Configure the portlet
11.4.3. Folder tree
11.4.4. pom.xml
11.4.5. testRomain.xml
11.4.6. Portlet Groovy Template
11.4.7. Skin Folder
11.4.8. Locale Folder
11.4.9. configuration.xml
11.4.10. web.xml
11.5. Portlet Lifecycle
11.5.1. Overview
11.5.2. Portlet init
11.5.3. Portlet request handler
11.5.4. ProcessAction phase
11.5.5. Render phase
11.6. Sample Basic Portlet
12. Gadget development
12.1. Gadgets
12.1.1. Overview
12.1.2. Existing Gadgets
12.1.3. Create a new Gadget
12.1.4. Remote Gadget
12.1.5. Gadget Importing
12.1.6. Gadget Web Editing
12.1.7. Gadget IDE Editing
12.1.8. Dashboard Viewing
12.2. Setup a Gadget Server
12.2.1. Setup virtual servers for the gadget rendering
13. Orphans chapters: TODO: move and integrate those
13.1. Setup a Gadget Server
13.1.1. Setup virtual servers for the gadget rendering
13.1.2. Config
13.1.3. Security key
13.1.4. Gadget proxy and concat configuration
13.1.5. Proxy