Author

Michael JasonSmith

Contact

Michael JasonSmith <mpj17@onlinegroups.net>

Date

2014-10-24

Organization

GroupServer.org

Copyright

This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by OnlineGroups.net.

The Welcome Box shows the introductory text on the homepage of a GroupServer site. It is made up of two parts.

Greeting:

A short greeting that is the first part of the welcome. It is shown as a header.

Message:

A longer HTML message that forms the bulk of the welcome.

The welcome is modified by the Change page. Both the Welcome Box and the Change page use the WelcomeMessage class.

The Welcome Box is a viewlet for displaying the introductory text in the main part of the site homepage. It is made up of a header, and a viewlet manager (gs.site.welcome.interfaces.IWelcomeBox). Two viewlets are provided by this product for the Welcome Box: one to provide the message, and another to provide a link to the Change page

The Change page /admin_changewelcome.html is used by the site-administrator to change the welcome message. The form uses the WelcomeMessage class to change both the greeting and the message.

The Change page is linked from a viewlet that is added to the Welcome Box

The gs.site.welcome.WelcomeMessage class is used to get or set the welcome message. It has two properties for the greeting and message. The properties themselves are stored in the welcome page template in the site-folder.

If the page template does not exist then the WelcomeMessage class will create it (with the identifier WelcomeMessage.welcomeId), and populate it with default values (WelcomeMessage.defaultGreeting and WelcomeMessage.defaultMsg for the greeting and message respectively.

• Code repository: https://github.com/groupserver/gs.site.welcome/
• Questions and comments to http://groupserver.org/groups/development/
• Report bugs at https://redmine.iopen.net/projects/groupserver/