Template

^{Template 1.0}

Category/ Domain :	Example
SCOL Voy@ger Compatibility :	V 2.0c or above
Update :	2001/02

Function

This module has no real utility except to serve as an exemple and base to developpe new modules. It makes use of a simple structure of module using two zones of editable text : one using the SCS editor under SCS (static edition), the other in the user interface (dynamic edition). In any case the modifications are saved when project is closed.

Attention : The modifications made dynamically while the project is in the course of edition in the SCS will be replaced during the saving of the project in the SCS.

Numerous dialogue boxes have been left as comments in the code to permit the comprehension at which moment callbacks are executed.

The graphic interface of the user is cut horizontally in two equal halves :
· The top one is occupied by a zone of text containing the editable text in SCS and which is use as label to the editable zone below.
· The bottom is occupied by a zone of editable text. The text is updated at the server level and other users when the action ‘validText‘ is activated.

Figure 1 : Template module interface

Configuration

None

Implementation

Open the SCS creation tree. Select the file Templates then double-click on Template 1.0.
Create required links for the project.

Action	Function
module.event à template.start	Starts the module.
module.event à template.destroy	Closes the module.
module.event à template.register	Registers the user. Then this one will be updated when another client updates the text on the server.
module.event à template.unregister	Unregisters the user.
module.event à template.show	Shows the interface (the two zones of text).
module.event à template.hide	Hides the interface (the two zones of text).
module.event à template.write	Writes a text in the editable zones of all the users (the text being edited at the different users will be overwrited).
module.event à template.validText	Allows to transmit on the edited text to the server which will update it on the other user interfaces.

Event	Function
template.entering à module Action	Launching the client part of the module generates an action.
template.in à module Action	The end of initialization of the client part generates an action.
template.out à module Action	Cancelling the client module generates an action.
template.shown à module Action	Displaying the graphic interface generates an action.
template.hidden à module Action	Hiding (but not cancelling) of the graphic interface generates an action.

Zone	Function	Interface	Assignment
template.Text	Contains the client zone for both zones of text.	Client	Yes