Skip to content
This repository was archived by the owner on Jan 15, 2022. It is now read-only.

Fix/1.1.x/doc 1683 #45

Open
hoavt wants to merge 2 commits into
base: stable/1.1.x
Choose a base branch
from
Open

Fix/1.1.x/doc 1683 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b870f31
DOC-1683 Check the patch of DOC-1644 and edit if any
May 24, 2012
597fb6c
DOC-1683 Change eXo Social into Social
May 24, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/refguide/src/main/resources/wikbook/en/en-US/Application/List_of_Gadgets.wiki
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
All Social Gadgets are in _opensocial.war_.
All the Social gadgets are in _opensocial.war_.

h1. Activity Stream {anchor:id=SOCref.List_Of_Gadget_in_Social.ActivityStream}
* *Description*: Manages activities of users. Some kinds of activities such as: update status, like/unlike activities, comment activities, delete activities and delete comments.
* *Used REST services*: ActivitiesRestServices
* *Description*: Manage activities of users: update status, like/unlike activities, comment activities, delete activities and delete comments.
* *Used REST services*: ActivitiesRestServices.

h1. Social RSS Reader {anchor:id=SOCref.List_Of_Gadget_in_Social.SocialRSSReader}
* *Description*: Fetches and parses RSS information from a specific url.
* *Description of user preferences*: The number of RSS per page is 10 by default. Get RSS from input URL (Default URL is http://blog.exoplatform.org/feed/).
* *Used REST services*: N/A

* *Description*: Fetch, parse and display RSS from a specific URL.
* *Description of user preferences*: There are 2 preference fields: URL input box (default value is [http://blog.exoplatform.org/feed/]) and Number of RSS per page selector (default value is 10).
* *Used REST services*: N/A.

h1. My Connections {anchor:id=SOCref.List_Of_Gadget_in_Social.MyConnections}
* *Description*: Displays a viewer's information and his connections' information.
* *Description of user preferences*: Connections displayed per page. The number of connections displayed is 5 by default.
* *Used REST services*: N/A

* *Description*: Get and display information of the current viewer and his connections.
* *Description of user preferences*: The number of connections displayed per page. It is set to '5' by default.
* *Used REST services*: N/A.

h1. My Spaces {anchor:id=SOCref.List_Of_Gadget_in_Social.MySpaces}
* *Description*: Displays all the spaces that a user has the "member" role.
* *Used REST services*: SpacesRestService
* *Description*: Display all spaces that a user has the "member" role.
* *Used REST services*: SpacesRestService.
45 changes: 12 additions & 33 deletions .../refguide/src/main/resources/wikbook/en/en-US/Application/List_of_Portlets.wiki
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,18 @@
All the portlets are in _social-portlet.war_

|| Portlets name || Description ||
| *SpaceMenuPortlet* | Display the menu on the right of a Space: Home, Dashboard, Members, SpaceSettings |
| *MembersPortlet* | Display MemberSpace where you can search for space members or list space members in alphabet |
| *SpaceSettingPortlet* | Shows the settings of Space: Settings, Visibility, Members, Application. You can change the setting information of a space if you are the creator of that space or have the manager right on it. |
| *MySpacesPortlet* | Displays your Space page where you can add new spaces, search for spaces or list spaces in alphabet |
| *InvitationSpacesPortlet* | Displays the *Space invitation* page where you can search for spaces, list spaces in alphabet and view all the Space invitations |
| *PendingSpacesPortlet* | Displays the *Space requests to join* page where you can search for spaces, list spaces in alphabet and view all the pending request to join Spaces |
| *PublicSpaces Portlet* | Displays the *Public Spaces* page where you can search for spaces, list spaces by alphabet and view all available public spaces to join |
| *SpaceActivityStreamPortlet* | Display spaces activities |
| *UserActivityStreamPortlet* | Update user's activities/status |
| *PeoplePortlet* | The People page where you can find people, display people name by alphabet |
| *ProfileNavigationPortlet* | |
| *ConnectionsPortlet* | The Conections page where you can access to your network, invitations to connect or connection requests |
| *InvitationsPortlet* | |
| *RequestsPortlet* | |
| *UserProfilePortlet* | Display user profile page where you can view/ edit user's basic information, contacts, experience or change avatar |
| *MyConnectionsNavigationPortlet* | |


All the portlets are in the file _social-portlet.war_

|| Portlet name || Description ||
| *MembersPortlet* | To enable users to search for Space members or list Space members in the alphabet order. |
| *MySpacesPortlet* | To display the Space page where you can add new Spaces, search for Spaces or list Spaces in the alphabet order. |
| *SpaceActivityStreamPortlet* | To share Spaces activity information. |
| *InvitationsPortlet* | To list all people that invite users. |
| *RequestsPortlet* | To list all invitations that the user requests. |
| *InvitationSpaces Portlet* | To enable users to search for Spaces, and list spaces in the alphabet order and view all the Space invitations. |
| *PendingSpacePortlet* | To display the *Space requests to join* page where you can search for Spaces, list spaces in the alphabet order and view all the pending requests to join Spaces. |
| *PublicSpacesPortlet* | To display the *Public Spaces* page where you can search for Spaces, list Spaces in the alphabet order and view all available public Spaces to join. |
| *UserActivityStreamPortlet* | To update and share user's activities and/or status. |
| *People Portlet* | To display the People page where you can find people, display people names in the alphabet order. |
| *ConnectionsPortlet* | To display the Connections page where you can access your network, invitations to connect or connection requests. |
| *UserProfilePortlet* | To display the user profile page where users can view and/or edit basic information, contacts, experience or change their avatar. |
| *MembersPortlet* | Enable users to search for Space members or list Space members in the alphabet order. |
| *MySpacesPortlet* | Display the Space page where you can add new Spaces, search for Spaces or list Spaces in the alphabet order. |
| *SpaceActivityStreamPortlet* | Share Spaces activity information. |
| *InvitationsPortlet* | List all people that invite users. |
| *RequestsPortlet* | List all invitations that the user requests. |
| *InvitationSpaces Portlet* | Enable users to search for Spaces, and list spaces in the alphabet order and view all the Space invitations. |
| *PendingSpacePortlet* | Display the *Space requests to join* page where you can search for Spaces, list spaces in the alphabet order and view all the pending requests to join Spaces. |
| *PublicSpacesPortlet* | Display the *Public Spaces* page where you can search for Spaces, list Spaces in the alphabet order and view all available public Spaces to join. |
| *UserActivityStreamPortlet* | Update and share user's activities and/or status. |
| *People Portlet* | Display the People page where you can find people, display people names in the alphabet order. |
| *ConnectionsPortlet* | Display the *Connections* page where you can access your network, invitations to connect or connection requests. |
| *UserProfilePortlet* | Display the *UserProfile* page where users can view and/or edit basic information, contacts, experience or change their avatar. |



64 changes: 31 additions & 33 deletions docs/refguide/src/main/resources/wikbook/en/en-US/Configuration/Configuration.wiki
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,49 @@ h2. ActivityManager {anchor:id=SOCref.Configuration.Component.ActivityManager}

h2. SpaceService {anchor:id=SOCref.Configuration.Component.SpaceService}
|| Configuration name || Data type || Default Value || Description ||
| space.homeNodeApp | {{String}} | {{SpaceActivityStreamPortlet}} | The home application for a space |
| space.apps | {{String list}} | {{DashboardPortlet:true}}, {{SpaceSettingPortlet:false}}, {{MembersPortlet:true}} | The space applications |
| space.homeNodeApp | {{String}} | {{SpaceActivityStream Portlet}} | The home application for a space. |
| space.apps | {{String list}} | {{DashboardPortlet:true}}, {{SpaceSettingPortlet: false}}, {{MembersPortlet:true}} | The space applications. |

{note}
Deprecated: Use external-component-plugins instead: org.exoplatform.social.core.space.SpaceApplicationConfigPlugin
{note}

h2. IdentityManager {anchor:id=SOCref.Configuration.Component.IdentityManager}
|| Configuration name || Data type || Default Value || Description ||
| providers | {{String}} | {{org.exoplatform.social.core.identity.provider.SpaceIdentityProvider}} | |
| providers | {{String}} | {{org.exoplatform.social.core.identity.provider.SpaceIdentityProvider}} | The identity providers. |

h2. ProfileConfig {anchor:id=SOCref.Configuration.Component.ProfileConfig}
|| Configuration name || Data type || Default Value || Description ||
| nodetype.emails | {{String}} | {{exo:profileKeyValue}} | |
| nodetype.phones | {{String}} | {{exo:profileKeyValue}} | |
| nodetype.ims | {{String}} | {{exo:profileKeyValue}} | |
| nodetype.urls | {{String}} | {{exo:profileKeyValue}} | |
| nodetype.address | {{String}} | {{exo:profileAddress}} | |
| nodetype.experiences | {{String}} | {{exo:profileExperience}} | |
| nodetype.education | {{String}} | {{exo:profileEducation}} | |
| forceMultiValue | {{String}} | xxxxxxxxxxxx | |

| nodetype.emails | {{String}} | {{exo:profileKeyValue}} |Define the node type which contains user email information of a profile. |
| nodetype.phones | {{String}} | {{exo:profileKeyValue}} | Define the node type which contains user phone information of a profile. |
| nodetype.ims | {{String}} | {{exo:profileKeyValue}} |Define the node type contains user IMS information of a profile. |
| nodetype.urls | {{String}} | {{exo:profileKeyValue}} | Define the node type which contains user URL of a profile. |
| nodetype.address | {{String}} | {{exo:profileAddress}} | Define the node type which contains user address information of a profile. |
| nodetype.experiences | {{String}} | {{exo:profileExperience}} |Define the node type which contains user working-experience information of a profile. |
| nodetype.education | {{String}} | {{exo:profileEducation}} |Define the node type which contains user education information of a profile. |

h2. ServiceProviderStore {anchor:id=SOCref.Configuration.Component.ServiceProviderStore}
|| Configuration name || Data type || Default Value || Description ||
| sample-provider | properties-params | | sample service provider |
| sample-provider | properties-params | N/A | Sample service provider. |

h1. External component plugins {anchor:id=SOCref.Configuration.External_component_plugins}
h2. MentionsProcessor {anchor:id=SOCref.Configuration.External_component_plugins.MentionsProcessor}
|| Configuration name || Data type || Default Value || Description ||
| priority | {{String}} | 2 | priority of this processor (lower are executed first) |
| priority | {{String}} | 2 | Priority of this processor (lower are executed first). |

h2. PortletPreferenceRequiredPlugin {anchor:id=SOCref.Configuration.External_component_plugins.PortletPrederenceRequiredPlugin}
|| Configuration name || Data type || Default Value || Description ||
| portletsPrefsRequired | {{String list}} | {{SpaceActivityStreamPortlet, SpaceSettingPortlet, MembersPortlet}} | The portlet name which requires space URL preference|
| portletsPrefsRequired | {{String list}} | {{SpaceActivityStream Portlet, SpaceSettingPortlet, MembersPortlet}} | The portlet name which requires space URL preference.|

h2. SpaceApplicationConfigPlugin {anchor:id=SOCref.Configuration.External_component_plugins.SpaceApplicationConfigPlugin}

|| Configuration name || Data type || Description ||
| spaceHomeApplication | {{SpaceApplicationConfigPlugin$SpaceApplication}} | The space application for the space home node|
|spaceApplicationList| {{SpaceApplicationConfigPlugin}} |space application list configuration|
| spaceHomeApplication | {{SpaceApplicationConfigPlugin$S paceApplication}} | The space application for the space home node.|
|spaceApplicationList| {{SpaceApplicationConfigPlugin}} |Space application list configuration.|

h2. AddNodeTypePlugin {anchor:id=SOCref.Configuration.External_component_plugins.AddNodeTypePlugin}
|| Configuration name || Data type || Default Value || Description ||
| autoCreatedInNewRepository | {{String}} | {{jar:/conf/portal/core-nodetypes.xml}} | Node types configuration file |
| autoCreatedInNewRepository | {{String}} | {{jar:/conf/portal/ core-nodetypes.xml}} | Node types configuration file. |
h1. RelationshipManager {anchor:id=SOCref.Configuration.RelationshipManager}
The Service is used to manipulate user relationships.

Expand Down Expand Up @@ -94,7 +92,7 @@ h2. Components configuration {anchor:id=SOCref.Configuration.SpaceService.Compon
{code}

|| Configuration name || Data Type || Possible value || Default Value || Description ||
| *SpaceActivityStreamPortlet* | {{String}} | N/A | {{SpaceActivityStreamPortlet}} | The name of portlet displaying activities of spaces |
| *SpaceActivityStreamPortlet* | {{String}} | N/A | {{SpaceActivityStream Portlet}} | The name of portlet displaying activities of spaces |
| *space.apps* | {{String list}} | {{Porlets' name: true/false }} | {{DashboardPortlet:true}}; {{SpaceSettingPortlet:false}}; {{MembersPortlet:true}} |The list of configurations for portlets used as portlet applications. |

h2. External plug-in configuration {anchor:id=SOCref.Configuration.SpaceService.ExternalPluginConfiguration}
Expand All @@ -121,7 +119,7 @@ h3. PortletPreferenceRequiredPlugin {anchor:id=SOCref.Configuration.SpaceService
In which:

|| Name || Set-method || Type || Description ||
| *PortletPreferenceRequiredPlugin* | setPortletsPrefsRequired | org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin | Configure the list of portlet names which will have portlet preference of space context. |
| *PortletPreference RequiredPlugin* | setPortletsPrefsRequired | org.exoplatform.social.core.application. PortletPreferenceRequiredPlugin | Configure the list of portlet names which will have portlet preference of space context. |

* Init-params:

Expand All @@ -130,7 +128,7 @@ In which:

h3. SpaceApplicationConfigPlugin {anchor:id=SOCref.Configuration.SpaceService.ExternalPluginConfiguration.SpaceApplicationConfigPlugin}
{note}
Since 1.1.3
This plugin has been used since 1.1.3
{note}
{code:xml}
<external-component-plugins>
Expand Down Expand Up @@ -205,7 +203,7 @@ Since 1.1.3
In which:

|| Name || Set-method || Type || Description ||
| *Space Application Configuration* | setSpaceApplicationConfigPlugin | org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin | Configure the list of space applications to be installed when creating a new space. |
| *Space Application Configuration* | setSpaceApplicationConfigPlugin | org.exoplatform.social.core. application.PortletPreferenceRequiredPlugin | Configure the list of space applications to be installed when creating a new space. |

h1. Activity Manager {anchor:id=SOCref.Configuration.ActivityManager}

Expand Down Expand Up @@ -244,12 +242,12 @@ h2. Component plug-in configuration {anchor:id=SOCref.Configuration.ActivityMana
In which,

|| Name || Set-method || Type || Description ||
| *OSHtmlSanitizerProcessor* | addProcessorPlugin | org.exoplatform.social.core.processor.OSHtmlSanitizerProcessor | The plugin that renders valid html tags appearing in the Activity body (content). |
| *OSHtmlSanitizer Processor* | addProcessorPlugin | org.exoplatform.social.core. processor.OSHtmlSanitizerProcessor | The plugin that renders valid html tags appearing in the Activity body (content). |

* Init-params:

|| Name || Possible value || Default Value || Description ||
| *allowedTags* | {{html tags}} | b, i, a, span, em, strong, p, ol, ul,li, br, img | To process and render html tags in the activity content (body). |
| *allowedTags* | {{html tags}} | b, i, a, span, em, strong, p, ol, ul,li, br, img | Process and render html tags in the activity content (body). |

h2. External plug-in configuration {anchor:id=SOCref.Configuration.ActivityManager.ExternalPluginConfiguration}

Expand All @@ -274,18 +272,18 @@ h2. External plug-in configuration {anchor:id=SOCref.Configuration.ActivityManag
In which:

|| Name || Set-method || Type || Description ||
| *MentionsProcessor* | addProcessorPlugin | org.exoplatform.social.core.processor.MentionsProcessor | A processor that substitutes @username expressions by a link on the user profile. |
| *MentionsProcessor* | addProcessorPlugin | org.exoplatform.social.core. processor.MentionsProcessor | A processor that substitutes @username expressions by a link on the user profile. |

* Init-params:

|| Name || Possible value || Default Value || Description ||
| *priority* | {{priority number}} | 2 | Priority of this processor (The lower level will be executed first). |
| *priority* | {{priority number}} | 2 | The priority of this processor. The lower priority level is executed first. |

h1. Identity Manager {anchor:id=SOCref.Configuration.IdentityManager}

h2. Description {anchor:id=SOCref.Configuration.IdentityManager.Description}

The service is to manipulate the identity operations like creating, getting, deleting or finding a profile.
The service is used to manipulate the identity operations like creating, getting, deleting, or finding a profile.

h2. Component plug-in configuration {anchor:id=SOCref.Configuration.IdentityManager.ComponentPluginConfiguration}

Expand Down Expand Up @@ -313,23 +311,23 @@ h2. Component plug-in configuration {anchor:id=SOCref.Configuration.IdentityMana
In which:

|| Name || Set-method || Type || Description ||
| *SpaceIdentityProvider plugin* | registerIdentityProviders | org.exoplatform.social.core.identity.IdentityProviderPlugin | The plugin that provides identity for a space |
| *SpaceIdentityProvider plugin* | registerIdentityProviders | org.exoplatform.social.core. identity.IdentityProviderPlugin | The plugin that provides identity for a space. |

* Init-params:

|| Name || Possible value || Default Value || Description ||
| *providers* | {{Every other identity providers}} | {{org.exoplatform.social.core.identity.provider.SpaceIdentityProvider}} | Identity Provider instances for managing identities. |
| *providers* | {{Every other identity providers}} | {{org.exoplatform.social.core.identity.provider.SpaceIdentityProvider}} |The Identity Provider instances for managing identities. |

h1. OpenSocial Rest Context Configuration {anchor:id=SOCref.Configuration.OpenSocialRestContextConfiguration}

h2. Description {anchor:id=SOCref.Configuration.OpenSocialRestContextConfiguration.Description}

The service is used to configure the portal container name when there is a OpenSocial REST API request. By configuring this service, we can make sure to to reach the right portal container.
The service is used to configure the portal container name when there is a OpenSocial REST API request. By configuring this service, you must reach the right portal container.
The default portal container is {{portal}}.

h2. Component plug-in configuration {anchor:id=SOCref.Configuration.OpenSocialRestContextConfiguration.ComponentPluginConfiguration}

This should be used when there is a portal container different than the default {{portal}} one.
This should be used when there is a portal container different with the default {{portal}} one.

{code:xml}
<external-component-plugins>
Expand All @@ -351,9 +349,9 @@ This should be used when there is a portal container different than the default
In which:

|| Name || Set-method || Type || Description ||
| *set portal container name used for REST service* | setRestContainerName | org.exoplatform.social.opensocial.auth.RestPortalContainerNameConfig | The plugin provided to set rest portal container name for OpenSocial REST API request |
| *set portal container name used for REST service* | setRestContainerName | org.exoplatform.social.opensocial. auth.RestPortalContainerNameConfig | The plugin provided to set the rest portal container name for OpenSocial REST API request.|

* Init-params:

|| Name || Possible value || Default Value || Description ||
| *rest-container-name* | {{any valid portal container name}} | {{N/A}} | Portal container name |
| *rest-container-name* | {{any valid portal container name}} | {{N/A}} | The portal container name. |
Loading