Usage

The PluginLib.PluginLibraryContents allows the insertion of a section of XHTML code consisting of javascript and html client-side code into a topic. The code can be set to run automatically by providing an initialization routine and it can be personalized by providing users with details to set up their own versions of variables. This plugin will support anything you may wish, with the exception of updating topic contents, much like a widget in MAC OS X or Yahoo, or an iGoogle gadget. The sample provided is for an implementation of a Traffic Camera insert.

 @@OdsWiki3.FleXhtml(namespace.GetTopicInfo("TrafficCamImplementation"), 
      namespace.GetTopicInfo(GetPersonalization.ToString), "TrafficCamDefault",
      "TrafficCamScript", "TrafficCamHTML", "TrafficCamPersonalization", 
      "specialFirstLoad()")@@
 :With: PersonalizationSupportLibrary

FleXhtml Insert Definition

The WikiTalk call to FleXhtml has 7 parts to it:

1. The TopicInfo for the topic containing the variables list in 3, 4, 5 below and the implementation of the initialization routine given in 7 below.
2. The TopicInfo for the topic containing personalization data for the variable listed in 6 below. The definition of the current user is determined by the PersonalizationSupportLibrary if there is an identifiable user.
3. The name of the property containing the default list of variables and their values in the TopicInfo specified in 1 above
4. The name of the property containing the javascript in the TopicInfo specified in 1 above
5. The name of the property containing the html in the TopicInfo specified in 1 above
6. The name of the property containing the personalization values for the required variables defined in 3 above, to be located in the TopicInfo specified in 2 above
7. The name of the property containing the name of the initialization javascript method defined in 4 above

The topic TrafficCamImplementation shows how items 3, 4, 5 and 7 are implemented. PluginLib.TestUser shows the implementation of item 6. It is important when creating the properties that the '[' (opening square bracket) is immediately after the ':' (full colon) of the property name with no spaces, e.g. ":[" the data should start on a new line and the closing square bracket for the property should be on a line by itself. It is possible to use indents in the properties, but it will display as sample code where indented (I do not recommend using spaces or tabs at the start of a line in these properties).

An actual working sample is found at PluginLib.TestTrafficCam

FlexWiki Integration

The binary plugin is integrated into FlexWiki by putting an entry into the flexwiki.config file as shown below. The administration section of the wiki has a verification section that provides a message if the plugin loads correctly.

 <Plugins>
     <Plugin>FleXhtml</Plugin>
 </Plugins>

Additional Considerations

The reference to OdsWiki3 is just the namespace used in the source code for the plugin.