MashZone NextGen 10.2 | Appendix | Legacy Presto components | Mashables and Mashups | Mashups in MashZone NextGen Wires | Customizing Wires | Add Tooltips and Help in Custom Blocks | Add a Help Button and Help Topic
 
Add a Help Button and Help Topic
For custom Wires blocks that require more than simple tooltips for user assistance, you can also create an HTML page as a help topic and add this to the block properties form using the macro metadata element <help> within <block>. This adds a ? button to the properties form.
The button opens your help topic (HTML page) in a new window that is 550px wide, by default, but can be resized.
How you handle CSS and images for help topics depends on how this HTML page will be accessed:
*Absolute URLs: the help topic HTML page, along with any CSS stylesheets and images must be hosted in a web server or application server that is accessible to the MashZone NextGen Server. There are no special requirements for links to CSS or images.
*Relative URLs: the help topic HTML page and any images should be uploaded to MashZone NextGen by a MashZone NextGen administrator. You may also upload CSS stylesheets or simply define all classes in an internal <style> tag in the <head> element of the help topic HTML page.
With relative URLs, you refer to CSS or images using a URL in the form /mashzone/files/path/filename-assigned using the path and filename assigned in MashZone NextGen.
Create the HTML page for the help topic and either:
*Deploy it, with any required resources in an appropriate web server or application server that accessible to the MashZone NextGen Server.
*Upload it, with any required resources, to MashZone NextGen.
Then add a URL to <help> in <block>:
<macros xmlns="http://www.open-mashup.org/schemas/v1.0/EMML"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.openmashup.org/schemas/v1.0/EMML/..
/schemas/EMMLPrestoSpec.xsd"
domain="myBlocks">

<macro name="helloWorld"
xmlns:presto="http://www.jackbe.com/v1.0/EMMLPrestoExtensions"
xmlns:macro="http://www.openmashup.org/schemas/v1.0/EMMLMacro">
<presto:macro-meta>
<block usage="Wires">
<label>Hello world!</label>
<help url="http://myOrg.com/help/helloworld.html">
Hello world block tooltip</help>
...
</block>
...
</presto:macro-meta>
....
</macro>
...
</macros>
This example shows an absolute URL. If you have uploaded the help topic to MashZone NextGen, use a URL in the form /mashzone/files/path/help-topic-name.

Copyright © 2013-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release