This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Versions Compared

Key

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

...

The text used in the tour is contained in the following properties:

guides.button.<key>

These properties define the text used in the buttons within the tour, such as the back and next buttons:

Code Block
guides.button.next=Next
guides.button.previous=Back
guides.button.ok=OK
guides.button.complete=Complete
guides.button.welcome=Let&#39;s Go!
guides.tableView.<key>

These properties define the text used for all tour panels shown in Table View:

Code Block
guides.tableView.expandSchemaPanel=
<h3>Customise the Table</
h3><p>Click
h3>
<p>Click here to expand the field tree.</p>
guides.tableView.fieldList=
<h3>Drag and Drop to Get Started</
h3><p>These
h3>
<p>These are all the fields available for analysis.</
p><p>Click
p>
<p>Click and drag items from the list to start building your table: </p><img src="<context-path>/images/guides/Guides01.png" draggable="false" width="340" height="145"/>
guides.tableView.addToTableButtons=
<h3>Build a Table</
h3><p>Alternatively
h3>
<p>Alternatively, select the checkboxes next to individual field items and then click one of the buttons at the top to add them to the table.</p><img src="<context-path>/images/guides/Guides02.png" draggable="false" width="340" height="150"/>
guides.tableView.retrieveData=
<h3>Retrieve the Results</
h3><p>Once
h3>
<p>Once you&#39;ve built your table, click this button to get the results.</p>
guides.tableView.tableOperation=
<h3>Drag and Drop to Change the Table</
h3><p>You
h3>
<p>You can rearrange your table by dragging the fields around.</
p><p>Or
p>
<p>Or drag a field to the trashcan to remove it.</p><img src="<context-path>/images/guides/Guides04.png" draggable="false" width="310" height="140"/>
guides.tableView.addDerivation=
<h3>Add Derivations</
h3><p>Derivations
h3>
<p>Derivations allow you to perform calculations without leaving SuperWEB2.</
p><p>These
p>
<p>These include things like adding items together, calculating percentages, creating forecasts and much more.</
p><div
p>
<div style="white-space:nowrap"><img src="<context-path>/images/guides/Guides-Deriv-01.png" draggable="false" width="260" height="160"/><img src="<context-path>/images/guides/Guides-Deriv-02.png" draggable="false" width="260" height="160" style="margin-left:10px"/></div>
guides.tableView.chartViewNav=
<h3>Visualise the Data</
h3><p>Once
h3>
<p>Once you have built your table you can visualise it as a graph:</p><img src="<context-path>/images/guides/Guides05.png" draggable="false" width="320" height="150"/>
guides.tableView.mapViewNav=
<h3>Generate a Map</
h3><p>If
h3>
<p>If your table contains a geographic field, you can visualise the results on a map:</p><img src="<context-path>/images/guides/Guides06.png" draggable="false" width="320" height="150"/>
guides.tableView.datasetsViewNav=
<h3>Choose a New Dataset</
h3><p>Click
h3>
<p>Click this button to go back and select another dataset.</p>
guides.tableView.tutorialMenu=
<h3>Take the Tour Again</
h3><p>To
h3>
<p>To see this help again at any time, select the <b>Tour</b> option from the menu.</p>
guides.datasets.<key>

These properties define the text used for all tour panels shown in the dataset catalogue screen:

Code Block
guides.datasets.welcome=
<p class="centerImg"><img src="<context-path>/images/guides/Tour.png" class="welcomeIcon" width="70" height="70"/></
p><h2>Take
p>
<h2>Take the SuperWEB2 Tour</
h2><p>Self
h2>
<p>Self-service analytics made easy.</
p><p>As
p>
<p>As a new user, we&#39;d like to take a few moments to guide you through the basics.</
p><p><i>This
p>
<p><i>This tour can be accessed at any time from the menu at the top right.</i></p>
guides.datasets.databases=
<h3>Datasets</
h3><p>These
h3>
<p>These are all the datasets available to you. Select one to see more information.</
p><p>Double
p>
<p>Double-clicking will open a dataset but we\'ve got a few more things to show you first.</p>
guides.datasets.tables=
<h3>Saved Tables</
h3><p>These
h3>
<p>These are saved queries/tables for the selected dataset.</p>
guides.datasets.info=
<h3>Learn More</
h3><p>This
h3>
<p>This area shows more information about the selected dataset.</p>
guides.datasets.open=
<h3>Start Exploring</
h3><p>Double
h3>
<p>Double-click a dataset or table to open it and continue the tour.</p>

Formatting Text

When providing content for the tour, you can use HTML tags and CSS styles to layout your content. For example, use heading tags to identify the title of each panel (the default text uses <h3> for all headings), and <p> tags for the body contents of each panel. If you wish to define additional CSS styles, you can do so by adding them to <tomcat_home>\webapps\webapi\tour\tour.css.

...

Code Block
languagetext
guides.tableView.fieldList=
<h3>Drag and Drop to Get Started</h3><p>Theseh3>
<p>These are all the fields available for analysis.</p><p>Clickp>
<p>Click and drag items from the list to start building your table: </p><img src="<context-path>/images/guides/Guides01.png" draggable="false" width="331" height="145"/>
Tip
iconfalse
If you are using your own images, make sure you adjust the width and height properties of the img tag to match the width and height of your images.

Escape the ' Character

If your text contains any instances of the single quote character, you must either replace this with the HTML entity code, &#39;, or escape it using a backslash: \'. For example:

Code Block
guides.datasets.welcome=
<p class="centerImg"><img src="<context-path>/images/guides/Tour.png" class="welcomeIcon" width="70" height="70"/></p><h2>Takep>
<h2>Take the SuperWEB2 Tour</h2><p>Selfh2>
<p>Self-service analytics made easy.</p><p>Asp>
<p>As a new user, we&#39;d like to take a few moments to guide you through the basics.</p><p><i>Thisp>
<p><i>This tour can be accessed at any time from the menu at the top right.</i></p>
guides.datasets.databases=
<h3>Datasets</h3><p>Theseh3>
<p>These are all the datasets available to you. Select one to see more information.</p><p>Doublep>
<p>Double-clicking will open a dataset but we\'ve got a few more things to show you first.</p>