Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

As of Weave 2.5.18 this bundle is already included and setup so all you need to do is the last step to add theĀ collapse theme to your client config.

Licence agreement and startup tips

It's possible to have the client display a licence that the user must agree to before continuing, or to display some general text, by adding one of the following configs to the client config

Code Block
languagexml
titleDisplaying a licence agreement
<client:config id="main">
	<licence>
		<title>Licence Agreement</title> <!-- "Licence Agreement" is the default so this is not strictly required -->
		<text>This is where you would insert the agreement text you wish the user to confirm.</text> <!-- this must be set -->
		<url>http://example.com</url> <!-- optional link if the user does not agree -->
	</licence>

	<!-- rest of client config goes here -->

</client:config>

Image Added

Code Block
languagexml
titleDisplaying a startup tip
<client:config id="main">
	<tip>
		<delay>1000</delay> <!-- how long before the tip should popup, default is 1000ms so this is not strictly required -->
		<title>Tip o' the day</title> <!-- title for the tip window -->
		<text>Don't run with scissors</text> <!-- required text for the tip -->
		<time>3000</time> <!-- optional duration for how long the tip should show, if not set then the user will have to click to hide it -->
	</tip>

	<!-- rest of client config goes here -->

</client:config>

Image Added

Further Reading