Difference between revisions of "Adding a Quick tour guide to your portlet"

From Gcube Wiki
Jump to: navigation, search
(Adding a gCube Quick tour guide to your gCube Portlet Project)
(gCube Quick tour guide)
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==gCube Quick tour guide==
+
<!-- CATEGORIES -->
'''gCube Quick tour guide''' is a customizable dialogBox that can be loaded when your portlet starts up for new users.
+
[[Category:Developer's Guide]]
It is shipped with a built-in clickable option that allows a user to specify to not open it again.
+
<!-- END CATEGORIES -->
  
'''See it in [http://monitor.d4science.research-infrastructures.eu/guidedtour/ action]'''
+
== '''THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0''' ==
  
gCube Quick tour guide comes with '''12 different themes''' and is '''highly customizable'''. See some available themes in the picture below.
+
THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0
  
[[File:GCubeThemes.jpg]]
+
==gCube Quick tour guide==
 +
 
 +
'''THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0'''
 +
 
 +
'''gCube Quick tour guide''' is a customizable dialogBox that can be loaded when your portlet starts up for new users.
 +
It is shipped with a built-in click-able option that allows a user to specify to not open it again.
  
 
==Adding a gCube Quick tour guide to your gCube Portlet Project ==
 
==Adding a gCube Quick tour guide to your gCube Portlet Project ==
 +
* Get the latest gWL [https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Widgets_Library_-_General_guidelines_about_Portlet_StyleSheets see wiki]
 +
 +
Get the Quick Tour: Maven coordinates
 +
 +
<source lang="xml">
 +
<dependency>
 +
<groupId>org.gcube.portlets.widgets</groupId>
 +
<artifactId>guided-tour-widget</artifactId>
 +
<version>LATEST</version>
 +
</dependency>
 +
</source>
  
* Download the latest jar from here: [http://dl.dropbox.com/u/15737233/Portal-Bundle%20files/gcube-quicktour.jar gcube-quicktour.jar] and add it to your build path.
 
 
* Add the following to your project .gwt.xml file
 
* Add the following to your project .gwt.xml file
 
<source lang="xml">
 
<source lang="xml">
 
<!-- inherits GCUBE Quick tour -->
 
<!-- inherits GCUBE Quick tour -->
<inherits name='org.gcube.portlets.user.guidedtour.GuidedTour' />
+
<inherits name='org.gcube.portlets.widgets.guidedtour.GuidedTour' />
 
</source>
 
</source>
  
Line 23: Line 38:
 
<servlet>
 
<servlet>
 
<servlet-name>quicktourServlet</servlet-name>
 
<servlet-name>quicktourServlet</servlet-name>
<servlet-class>org.gcube.portlets.user.guidedtour.server.TourServiceImpl</servlet-class>
+
<servlet-class>org.gcube.portlets.widgets.guidedtour.server.TourServiceImpl</servlet-class>
 
</servlet>
 
</servlet>
  
Line 133: Line 148:
  
 
<source lang="java">  
 
<source lang="java">  
private void showGuidedTour() {
+
private void showGuidedTour() {
 
TourStep step1 = new GCUBETemplate1Text1Image(true) {
 
TourStep step1 = new GCUBETemplate1Text1Image(true) {
  
 
@Override
 
@Override
 
public String setStepTitle() {
 
public String setStepTitle() {
return "From Wikipedia";
+
return "gCube Reporting";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepImage() {
 
public String setStepImage() {
return "//upload.wikimedia.org/wikipedia/commons/thumb/a/a2/Moai_Rano_raraku.jpg/200px-Moai_Rano_raraku.jpg";
+
return "images/tour/tour_1.jpg";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepBody() {
 
public String setStepBody() {
return "Easter Island (Rapa Nui: Rapa Nui, Spanish: Isla de Pascua) is a Polynesian island " +
+
return "<div style=\"line-height: 19px; padding: 10px; font-size: 14px; \">" +
"in the southeastern Pacific Ocean, at the southeasternmost point of the Polynesian triangle. " +
+
"<div style=\"padding-bottom: 40px;\">" +
"<br /><br />A special territory of Chile that was annexed in 1888, Easter Island is famous for its 887 extant monumental statues, " +
+
"<b>gCube Reporting</b> allows users to create Reports and generate different " +
"called moai, created by the early Rapanui people. It is a World Heritage Site (as determined by UNESCO) with much " +
+
"export formats (OpenXML, HTML, PDF) ) based on results retrieved from the infrastructure." +
"of the island protected within Rapa Nui National Park. <br /><br />In recent times the island has served as a warning of the cultural" +
+
"</div>" +
" and environmental dangers of overexploitation. Ethnographers and archaeologists also blame diseases carried by European " +
+
"<div style=\"padding-bottom: 40px;\">" +
"colonizers and slave raiding of the 1860s for devastating the local peoples"+
+
"gCube Templates are dynamically and statically completed." +
"<p><b>Easter Island is claimed to be the most remote inhabited island in the world</b></p>";
+
"</div>" +
 +
"<div style=\"padding-bottom: 40px;\">" +
 +
"gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports." +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 10px;\">" +
 +
"<b>Discover</b> gCube Reporting features through this quick tour." +
 +
"</div>" +
 +
"</div>";
 
}
 
}
 
};
 
};
  
TourStep step2 = new GCUBETemplate1Text2Image(true) {
+
TourStep step2 = new GCUBETemplate1Text1Image(false) {
  
 
@Override
 
@Override
 
public String setStepTitle() {
 
public String setStepTitle() {
return "Name";
+
return "Toolbox";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepImage() {
 
public String setStepImage() {
return "//upload.wikimedia.org/wikipedia/commons/thumb/5/50/AhuTongariki.JPG/220px-AhuTongariki.JPG";
+
return "images/tour/tour2.jpg";
 
}
 
}
 
@Override
 
public String setStepOtherImage() {
 
return "//upload.wikimedia.org/wikipedia/commons/thumb/a/a8/Hodges_easter-island.jpg/220px-Hodges_easter-island.jpg";
 
}
 
 
 
@Override
 
@Override
 
public String setStepBody() {
 
public String setStepBody() {
return "The name \"Easter Island\" was given by the island's first recorded European visitor, " +
+
return "<div style=\"line-height: 19px; font-size: 16px; padding: 10px;\">" +
"the Dutch explorer Jacob Roggeveen, who encountered it on Easter Sunday 1722, while searching for Davis or David's island. " +
+
"<div style=\"padding-bottom: 90px;\">" +
"Roggeveen named it Paasch-Eyland (18th century Dutch for \"Easter Island\").[6] " +
+
"<b>Define</b> your template by selecting from the Toolbox components." +
"The island's official Spanish name, Isla de Pascua, also means \"Easter Island\"." +
+
"</div>" +
"<p>The current Polynesian name of the island, <b>Rapa Nui, \"Big Rapa\"</b>, was coined after the slave raids of the early 1860s, " +
+
"<div style=\"padding-bottom: 80px;\">" +
"and refers to the island's topographic resemblance to the island of Rapa in the Bass Islands of the Austral Islands group." +
+
"Choose from <b>several components:</b><br />" +
" However Thor Heyerdahl argued that Rapa was the original name of Easter Island, and that Rapa Iti was named by refugees from there.</p>";
+
"<span style=\"font-style: italic;\">title, headings, images, tables </span> and much more!</b>" +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 10px;\">" +
 +
"Choose from <b>two different layouts:</b>: one column or double columns for each section." +
 +
"</div>" +
 +
 
 +
"</div>";
 
}
 
}
 
};
 
};
 
 
TourStep step3 = new GCUBETemplate2Text2Image(false) {
 
TourStep step3 = new GCUBETemplate2Text2Image(false) {
  
 
@Override
 
@Override
 
public String setStepTitle() {
 
public String setStepTitle() {
return "History";
+
return "ToC & Reporting";
 +
}
 +
 
 +
@Override
 +
public String setStepImage() {
 +
return "images/tour/tourToc.jpg";
 +
}
 +
 
 +
@Override
 +
public String setStepBody() {
 +
return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
 +
"<div style=\"padding-bottom: 10px;\">" +
 +
"Add a dynamic component for automatic <b>Table Of Content</b> creation." +
 +
"</div>" +
 +
"</div>";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepOtherImage() {
 
public String setStepOtherImage() {
return "//imageseu.homeaway.com/vd2/files/HR/400x300/2/8495/7540_1321012895481.jpg";
+
return "images/tour/tourFormat.jpg";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepOtherBody() {
 
public String setStepOtherBody() {
return "Estimated dates of initial settlement of Easter Island have ranged from 300 to 1200 CE, approximately coinciding with the arrival of " +
+
return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
"the first settlers in Hawaii. Rectifications in radiocarbon dating have changed almost all of the previously-posited early settlement " +
+
"<div style=\"padding-bottom: 10px;\">" +
"dates in Polynesia. Rapa Nui has more recently been considered to have been settled in the narrower range of 700 to 1100 CE.";
+
"<b>Format text</b> as you would in a word processor using the Formatting Bar." +
 +
"</div>" +
 +
"</div>";
 +
}
 +
};
 +
TourStep step4 = new GCUBETemplate2Text2Image(false) {
 +
 
 +
@Override
 +
public String setStepTitle() {
 +
return "Tables";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepImage() {
 
public String setStepImage() {
return "//www.archidose.org/Blog/tikopia4.jpg";
+
return "images/tour/tour3_1.jpg";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepBody() {
 
public String setStepBody() {
return "The history of Easter Island is rich and controversial. Its inhabitants have endured famines, epidemics, " +
+
return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
"civil war, slave raids, colonialism, and near deforestation; its population declined precipitously more than once." +
+
"<div style=\"padding-bottom: 80px;\">" +
"However, this hypothesis contradicts radiocarbon dating, according to which other sites preceded Anakena by many years, " +
+
"Add static or dynamic <b>Tables</b>." +
"especially the Tahai, whose radiocarbon dates precede Anakena's by several centuries.";
+
"</div>" +
 +
"</div>";
 +
}
 +
 
 +
@Override
 +
public String setStepOtherImage() {
 +
return "images/tour/tour3_2.jpg";
 +
}
 +
 
 +
@Override
 +
public String setStepOtherBody() {
 +
return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
 +
"<div style=\"padding-bottom: 10px;\">" +
 +
"<b>Merge</b> table cells, add/remove rows and much more!" +
 +
"</div>" +
 +
"</div>";
 
}
 
}
 
};
 
};
  
TourStep step4 = new GCUBETemplate1Text1Image(true) {
+
TourStep step5 = new GCUBETemplate1Text1Image(false) {
  
 
@Override
 
@Override
 
public String setStepTitle() {
 
public String setStepTitle() {
return "Merchandise";
+
return "Sections";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepImage() {
 
public String setStepImage() {
return "//rlv.zcache.com/easter_island_tshirt-p235231819274168933ohvp_400.jpg";
+
return "images/tour/tour4.jpg";
 
}
 
}
  
 
@Override
 
@Override
 
public String setStepBody() {
 
public String setStepBody() {
return "<h3>Easter Island Pull Over Sweatshirt</h3><br /><h3>Only Euro 28.55 per shirt <input type=\"button\" value=\"Buy Now!\" onClick=\"Javascript:window.alert('Do you really wanna buy it? That was a joke man!')\"></h3>";
+
return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
}
+
"<div style=\"padding-bottom: 70px;\">" +
 +
"Divide your template into various <b>Sections.</b>" +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 50px;\">" +
 +
"Sections can be <b>imported</b> and/or <b>exported</b> from existing reports or templates." +
 +
"</div>" +
 +
"</div>";
 +
}
 
};
 
};
 +
//step1.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 
step2.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 
step2.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
GCUBEGuidedTour gt = new GCUBEGuidedTour("Easter Island", GuidedTour.class.getName(), 750, 450, false, ThemeColor.AQUAMARINE);
+
step3.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 +
step4.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 +
step5.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 +
 
 +
GCUBEGuidedTour gt = new GCUBEGuidedTour("gCube Template Creator", TemplateCreator.class.getName(), "$MyUserGuideURL", 780, 450, false, ThemeColor.BLUE);
 
gt.addStep(step1);
 
gt.addStep(step1);
 
gt.addStep(step2);
 
gt.addStep(step2);
 
gt.addStep(step3);
 
gt.addStep(step3);
 
gt.addStep(step4);
 
gt.addStep(step4);
 +
gt.addStep(step5);
 
gt.openTour();
 
gt.openTour();
 
}
 
}
 +
</source>
 +
 +
== Advanced (I wanna write HTML) ==
 +
 +
Luckily for you GWT has introduced '''Declarative Layouts with UiBinder'''. Since this Widget supports any Composite for its steps you are free to use it to create your UI Binder Binded Steps. For more information you can look at their developer's guide.
 +
 +
However if you just '''want to avoid things like''':
 +
 +
<source lang="java">
 +
...
 +
public String setStepBody() {
 +
return "<div style=\"line-height: 19px; padding: 10px; font-size: 14px; \">" +
 +
"<div style=\"padding-bottom: 40px;\">" +
 +
"<b>gCube Reporting</b> allows users to create Reports and generate different " +
 +
"export formats (OpenXML, HTML, PDF) ) based on results retrieved from the infrastructure." +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 40px;\">" +
 +
"gCube Templates are dynamically and statically completed." +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 40px;\">" +
 +
"gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports." +
 +
"</div>" +
 +
"<div style=\"padding-bottom: 10px;\">" +
 +
"<b>Discover</b> gCube Reporting features through this quick tour." +
 +
"</div>" +
 +
"</div>";
 +
}
 +
.....
 +
</source>
 +
 +
===There's an easy way to do it===
 +
 +
* Create a class with any name you like, make it extends HTML (com.google.gwt.user.client.ui.HTML). Say  this class is called '''IntroHTML''' you would have this code:
 +
<source lang="java">
 +
/**
 +
  * IntroHTML.java
 +
  */
 +
package org.gcube.portlets.user.guidedtour.client.sample;
 +
import com.google.gwt.core.client.GWT;
 +
import com.google.gwt.dom.client.Element;
 +
import com.google.gwt.uibinder.client.UiBinder;
 +
import com.google.gwt.user.client.ui.HTML;
 +
 +
 +
public class IntroHTML extends HTML {
 +
 +
interface IntroHTMLUiBinder extends UiBinder<Element, IntroHTML> {
 +
}
 +
 +
private static IntroHTMLUiBinder uiBinder = GWT.create(IntroHTMLUiBinder.class);
 +
 +
public IntroHTML() {
 +
setHTML(uiBinder.createAndBindUi(this).getInnerHTML());
 +
}
 +
} //end class
 +
</source>
 +
 +
* Create an XML file with same name of your .java class above. You must change the extension to .ui.xml. '''IntroHTML''' would have the following xml file associated (IntroHTML.ui.xml):
 +
<source lang="xml">
 +
<!--    IntroHTML.ui.xml  -->
 +
<!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
 +
<ui:UiBinder xmlns:ui="urn:ui:com.google.gwt.uibinder">
 +
<ui:style>
 +
/* Add CSS here. See the GWT docs on UI Binder for more details */
 +
.important {
 +
font-weight: bold;
 +
}
 +
</ui:style>
 +
<div>
 +
<!-- Add HTML content here -->
 +
<div style="line-height: 19px; padding: 10px; font-size: 14px; ">
 +
<div style="padding-bottom: 40px;">
 +
<b>gCube Reporting</b>
 +
allows users to create Reports and generate different
 +
export formats (OpenXML, HTML, PDF) based on results retrieved from the
 +
infrastructure.
 +
</div>
 +
<div style="padding-bottom: 40px;">gCube Templates are dynamically and statically completed.
 +
</div>
 +
<div style="padding-bottom: 40px;">
 +
gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports.
 +
</div>
 +
<div style="padding-bottom: 10px;">
 +
<b>Discover</b> gCube Reporting features through this quick tour.
 +
</div>
 +
</div>
 +
</div>
 +
</ui:UiBinder>
 +
</source>
 +
 +
* '''both your .java and .ui.xml must stay in the same package'''
 +
 +
[[File:SamePackage.png]]
 +
 +
* your ''' public String setStepBody() ''' previous method would just have the following body:
 +
 +
<source lang="java">
 +
...
 +
public String setStepBody() {
 +
return new IntroHTML().getHTML();  //no more HTML in Java Strings
 +
}
 +
...
 +
</source>
 +
 +
Enjoy!
 +
 +
== Advanced (I wanna write only a configuration file) ==
 +
 +
If you want to avoid to include text into your portlet's code you may want to use the guided tour XML configurations.
 +
 +
This feature allows you to move bodies and titles into an XML file (the main configuration), if you support more than one language you can put it into another XML file.
 +
 +
Here an example of main configuration file (GuidedTour.xml):
 +
 +
<source lang="xml">
 +
<guidedtour width="930" height="450" usemask="false">
 +
  <title>gCube Time Series</title>
 +
  <guide>https://gcube.wiki.gcube-system.org/gcube/index.php/Time_Series</guide>
 +
  <themecolor>BLUE</themecolor>
 +
  <steps>
 +
    <step>
 +
      <title>Introduction</title>
 +
      <bodies>
 +
        <body><![CDATA[
 +
<div>This is my first step!</div>
 +
]]></body>
 +
      </bodies>
 +
      <images>
 +
        <image url="images/step1.png" />
 +
      </images>
 +
    </step>
 +
    <step showTitle="false" v-alignment="ALIGN_MIDDLE">
 +
      <title>Second step</title>
 +
      <bodies>
 +
        <body><![CDATA[
 +
<div>This is my second step!</div>
 +
]]></body>
 +
      </bodies>
 +
      <images>
 +
        <image url="images/step2.1.png" />
 +
        <image url="images/step2.2.png" />
 +
      </images>
 +
    </step>
 +
  </steps>
 +
</guidedtour>
 +
</source>
 +
 +
 +
Here an example of translation file (GuidedTour_IT.xml):
 +
 +
<source lang="xml">
 +
<guidedtour>
 +
  <steps>
 +
    <step>
 +
      <title>Introduzione</title>
 +
      <bodies>
 +
        <body><![CDATA[
 +
<div>Ecco il mio primo passo!</div>
 +
]]></body>
 +
      </bodies>
 +
    </step>
 +
    <step>
 +
      <title>Secondo passo</title>
 +
      <bodies>
 +
        <body><![CDATA[
 +
<div>Ecco il mio secondo passo!</div>
 +
]]></body>
 +
      </bodies>
 +
    </step>
 +
  </steps>
 +
</guidedtour>
 +
</source>
 +
 +
As you can see the translation needs only the translated text, no images, no tour or step settings.
 +
 +
===How to create the tour in my application using the XML configuration file?===
 +
 +
The Guided Tour widget is provided with a ''GuidedTourResource'', a GWT resource like ImageResource, CSSResource or TxtResource (http://code.google.com/webtoolkit/doc/latest/DevGuideClientBundle.html). Like the other resources the GuidedTourResource can be declared in a ClientBundle interface:
 +
 +
For example:
 +
 +
<source lang="java">
 +
interface Resources extends ClientBundle {
 +
 
 +
  @Source("org/gcube/test/client/resources/GuidedTour.xml")
 +
  GuidedTourResource quickTour();
 +
}
 +
</source>
 +
 +
As you can see the Source tag is pointing to the configuration file that we've seen before. The Source tag value is checked by the GWT Eclipse Plugin so if it is wrong the editor will alert you.
 +
 +
What about the translation files? Don't worry, just put it in the same folder of the main configuration file, the system will recognize it.
 +
 +
Now we want to show the Tour in our application, here's a way to do it:
 +
 +
<source lang="java">
 +
GCUBEGuidedTour.showTour(MyApplication.class.getName(), new GuidedTourResourceProvider() {
 +
 +
@Override
 +
public GuidedTourResource getResource() {
 +
Resources resources = GWT.create(Resources.class);
 +
return resources.quickTour();
 +
}
 +
});
 +
</source>
 +
 +
That's all??? yes, that's all. Enjoy.
 +
 +
===How to move from declaration system to configuration files===
 +
 +
Ok, but I've already created my tour with the declaration system, there is an easy way to move to XML configuration?? Yes, there is.
 +
 +
The GuidedTour widget is distributed with an utility class '''GuidedTourConfigurationExctractor'''. In this class there is a method '''analyze''' which take as parameter a GCubeGuidedTour object, the one you create for the tour. The method analyzes your GuidedTour and outputs the necessary XML in the console. What you need to do is to call it instead of '''openTour()''', run you portlet once in Eclipse and the Extractor will generate the necessary XML files.
 +
 +
== Adding MultiLanguage Support ==
 +
 +
If you want to give the quick tour in another language other than English, you can add as many as you wish. All you need to do is the following:
 +
 +
* Add the Language you intend to support in the GCUBEGuidedTour Constructor, the following example to support Italian also.
 +
 +
<source lang="java">
 +
GCUBEGuidedTour gt = new GCUBEGuidedTour("gCube Template Creator", TemplateCreator.class.getName(),
 +
"http://www.myguide.com", 780, 450, false, ThemeColor.BLUE, TourLanguage.EN, TourLanguage.IT);  //add as many as TourLanguage you want here
 +
</source>
 +
 +
* Use the "ML" suffix for your GCUBETemplate instance:
 +
 +
NO
 +
 +
<source lang="java">
 +
        TourStep step1 = new GCUBETemplate1Text1Image(true)
 +
</source>
 +
 +
YES
 +
 +
<source lang="java">
 +
        TourStep step1 = new GCUBETemplate1Text1ImageML(true)
 +
</source>
 +
 +
* Provide the tour in the languages you support, you will have to return a HashMap<TourLanguage, String> instead of a String, use TourLanguage Type as key, and the translation for the value.
 +
 +
<source lang="java">
 +
@Override
 +
public HashMap<TourLanguage, String> setStepTitle() {
 +
HashMap<TourLanguage, String> languages = new HashMap<TourLanguage, String>();
 +
languages.put(TourLanguage.EN, "Tables");
 +
languages.put(TourLanguage.IT, "Tabelle");
 +
return languages;
 +
}
 
</source>
 
</source>

Latest revision as of 16:10, 23 June 2016


THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0

THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0

gCube Quick tour guide

THIS COMPONENT HAS BEEN DISMISSED AS OF gCube 4.0

gCube Quick tour guide is a customizable dialogBox that can be loaded when your portlet starts up for new users. It is shipped with a built-in click-able option that allows a user to specify to not open it again.

Adding a gCube Quick tour guide to your gCube Portlet Project

Get the Quick Tour: Maven coordinates

<dependency>
	<groupId>org.gcube.portlets.widgets</groupId>
	<artifactId>guided-tour-widget</artifactId>
	<version>LATEST</version>
</dependency>
  • Add the following to your project .gwt.xml file
<!-- inherits GCUBE Quick tour -->
<inherits name='org.gcube.portlets.widgets.guidedtour.GuidedTour' />
  • Add the following to your project web.xml file (Replace $YOUR_SERVLET_URL_PATTERN with your actual servlet url patter value)
	<!-- quicktourServlet -->
	<servlet>
		<servlet-name>quicktourServlet</servlet-name>
		<servlet-class>org.gcube.portlets.widgets.guidedtour.server.TourServiceImpl</servlet-class>
	</servlet>
 
	<servlet-mapping>
		<servlet-name>quicktourServlet</servlet-name>
		<url-pattern>/$YOUR_SERVLET_URL_PATTERN/quicktourServlet</url-pattern>
	</servlet-mapping>

You are ready to use it.

Show Quick tour guide at your portlet startup

In order to load the quick tour at portlet startup create a private (void) method in your GWT EntryPoint class, say you name it showGuidedTour() then you would put showGuidedTour() and the end of your public void onModuleLoad() method.


Customize Quick tour guide for your portlet

Within the showGuidedTour() method you must instanciate the GCUBEGuidedTour class (org.gcube.portlets.user.guidedtour.client.GCUBEGuidedTour)

There are several constructors you can use, allowing you to set its size, its theme, whether you want animation transitions or not and much more. Please refer to documentation to find the one that fits your needs.

As an example, see the code below:

GCUBEGuidedTour gt = new GCUBEGuidedTour(
"gCube Framework", /* caption */
 MyClass.class.getName(),  /* uniqueid (needed for implementing the don'tShowThisAgain feature) */
 750, /* width */
 350, /* height */
 false,  /* mask (When enabled, the background will be blocked with a semi-transparent panel) */
 ThemeColor.MAGENTA /* themeColor */
);

will eventually create the following:

StepsArea.jpg

Adding steps to the tour

GCUBEGuidedTour supports templates(GCUBETemplate) for its steps. Although any Composite (com.google.gwt.user.client.ui.Composite) will do, we reccomend to use predefined Templates as shown in the following.

Creating Step from template

There are 3 Templates you can choose from, in each of these three the window is divided in two areas vertically.

  • GCUBETemplate1Text1Image:

html | image

  • GCUBETemplate1Text2Image:
 
         image
 html |       
         image
  • GCUBETemplate2Text2Image:
html | image
         
html | image


According to the GCUBETemplate you choose for your step you will have to implement some methods, the following example shows how to instanciate a step with a GCUBETemplate1Text1Image as template:

 
TourStep myFirstStep = new GCUBETemplate1Text1Image(true) {
 
			@Override
			public String setStepTitle() {
				return "What's gCube";
			}
 
			@Override
			public String setStepImage() {
                                //get the image from the web, use relative path to get it from your project
				return "//www.gcube-system.org/templates/gcube/images/logo-top.gif";
			}
 
			@Override
			public String setStepBody() {
				return "gCube is a framework dedicated to scientists. It enables the declarative and interactive creation of transient Virtual Research Environments"
			}
		};

You then need to add the step to the GCUBEGuidedTour instance created previously:

 
gt.addStep(step1);
 
//the following would set the text vertical alignment (default is TOP)
myFirstStep.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);

and eventually show the tour on screen

 
gt.openTour();

Complete working example

The following shows how to create a Quick Guided tour in Java. See it in action

 
			private void showGuidedTour() {
		TourStep step1 = new GCUBETemplate1Text1Image(true) {
 
			@Override
			public String setStepTitle() {
				return "gCube Reporting";
			}
 
			@Override
			public String setStepImage() {
				return "images/tour/tour_1.jpg";
			}
 
			@Override
			public String setStepBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 14px; \">" +
						"<div style=\"padding-bottom: 40px;\">" +
						"<b>gCube Reporting</b> allows users to create Reports and generate different " +
						"export formats (OpenXML, HTML, PDF) ) based on results retrieved from the infrastructure." +
						"</div>" +
						"<div style=\"padding-bottom: 40px;\">" +
						"gCube Templates are dynamically and statically completed." +
						"</div>" +
						"<div style=\"padding-bottom: 40px;\">" +
						"gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports." +
						"</div>" +
						"<div style=\"padding-bottom: 10px;\">" +
						"<b>Discover</b> gCube Reporting features through this quick tour." +
						"</div>" +
						"</div>";
			}
		};
 
		TourStep step2 = new GCUBETemplate1Text1Image(false) {
 
			@Override
			public String setStepTitle() {
				return "Toolbox";
			}
 
			@Override
			public String setStepImage() {
				return "images/tour/tour2.jpg";
			}
			@Override
			public String setStepBody() {
				return "<div style=\"line-height: 19px; font-size: 16px; padding: 10px;\">" +
						"<div style=\"padding-bottom: 90px;\">" +
						"<b>Define</b> your template by selecting from the Toolbox components." +
						"</div>" +
						"<div style=\"padding-bottom: 80px;\">" +
						"Choose from <b>several components:</b><br />" +
						"<span style=\"font-style: italic;\">title, headings, images, tables </span> and much more!</b>" +
						"</div>" +
						"<div style=\"padding-bottom: 10px;\">" +
						"Choose from <b>two different layouts:</b>: one column or double columns for each section." +
						"</div>" +
 
						"</div>";
			}
		};
		TourStep step3 = new GCUBETemplate2Text2Image(false) {
 
			@Override
			public String setStepTitle() {
				return "ToC & Reporting";
			}
 
			@Override
			public String setStepImage() {
				return "images/tour/tourToc.jpg";
			}
 
			@Override
			public String setStepBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
						"<div style=\"padding-bottom: 10px;\">" +
						"Add a dynamic component for automatic <b>Table Of Content</b> creation." +
						"</div>" +
						"</div>";
			}
 
			@Override
			public String setStepOtherImage() {
				return "images/tour/tourFormat.jpg";
			}
 
			@Override
			public String setStepOtherBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
						"<div style=\"padding-bottom: 10px;\">" +
						"<b>Format text</b> as you would in a word processor using the Formatting Bar." +
						"</div>" +
						"</div>";
			}
		};
		TourStep step4 = new GCUBETemplate2Text2Image(false) {
 
			@Override
			public String setStepTitle() {
				return "Tables";
			}
 
			@Override
			public String setStepImage() {
				return "images/tour/tour3_1.jpg";
			}
 
			@Override
			public String setStepBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
						"<div style=\"padding-bottom: 80px;\">" +
						"Add static or dynamic <b>Tables</b>." +
						"</div>" +
						"</div>";
			}
 
			@Override
			public String setStepOtherImage() {
				return "images/tour/tour3_2.jpg";
			}
 
			@Override
			public String setStepOtherBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
						"<div style=\"padding-bottom: 10px;\">" +
						"<b>Merge</b> table cells, add/remove rows and much more!" +
						"</div>" +
						"</div>";
			}
		};
 
		TourStep step5 = new GCUBETemplate1Text1Image(false) {
 
			@Override
			public String setStepTitle() {
				return "Sections";
			}
 
			@Override
			public String setStepImage() {
				return "images/tour/tour4.jpg";
			}
 
			@Override
			public String setStepBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 16px; \">" +
						"<div style=\"padding-bottom: 70px;\">" +
						"Divide your template into various <b>Sections.</b>" +
						"</div>" +
						"<div style=\"padding-bottom: 50px;\">" +
						"Sections can be <b>imported</b> and/or <b>exported</b> from existing reports or templates." +
						"</div>" +
						"</div>";	
				}
		};
		//step1.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
		step2.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
		step3.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
		step4.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
		step5.setTextVerticalAlignment(VerticalAlignment.ALIGN_MIDDLE);
 
		GCUBEGuidedTour gt = new GCUBEGuidedTour("gCube Template Creator", TemplateCreator.class.getName(), "$MyUserGuideURL", 780, 450, false, ThemeColor.BLUE);
		gt.addStep(step1);
		gt.addStep(step2);
		gt.addStep(step3);
		gt.addStep(step4);
		gt.addStep(step5);
		gt.openTour();
	}

Advanced (I wanna write HTML)

Luckily for you GWT has introduced Declarative Layouts with UiBinder. Since this Widget supports any Composite for its steps you are free to use it to create your UI Binder Binded Steps. For more information you can look at their developer's guide.

However if you just want to avoid things like:

 
...
			public String setStepBody() {
				return "<div style=\"line-height: 19px; padding: 10px; font-size: 14px; \">" +
						"<div style=\"padding-bottom: 40px;\">" +
						"<b>gCube Reporting</b> allows users to create Reports and generate different " +
						"export formats (OpenXML, HTML, PDF) ) based on results retrieved from the infrastructure." +
						"</div>" +
						"<div style=\"padding-bottom: 40px;\">" +
						"gCube Templates are dynamically and statically completed." +
						"</div>" +
						"<div style=\"padding-bottom: 40px;\">" +
						"gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports." +
						"</div>" +
						"<div style=\"padding-bottom: 10px;\">" +
						"<b>Discover</b> gCube Reporting features through this quick tour." +
						"</div>" +
						"</div>";
			}
.....

There's an easy way to do it

  • Create a class with any name you like, make it extends HTML (com.google.gwt.user.client.ui.HTML). Say this class is called IntroHTML you would have this code:
/**
  * IntroHTML.java
  */ 
package org.gcube.portlets.user.guidedtour.client.sample;
import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Element;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.user.client.ui.HTML;
 
 
public class IntroHTML extends HTML {
 
	interface IntroHTMLUiBinder extends UiBinder<Element, IntroHTML> {
	}
 
	private static IntroHTMLUiBinder uiBinder = GWT.create(IntroHTMLUiBinder.class);
 
	public IntroHTML() {
		setHTML(uiBinder.createAndBindUi(this).getInnerHTML());
	}
} //end class
  • Create an XML file with same name of your .java class above. You must change the extension to .ui.xml. IntroHTML would have the following xml file associated (IntroHTML.ui.xml):
 
<!--    IntroHTML.ui.xml   -->
<!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
<ui:UiBinder xmlns:ui="urn:ui:com.google.gwt.uibinder">
	<ui:style>
		/* Add CSS here. See the GWT docs on UI Binder for more details */
		.important {
			font-weight: bold;
		}
	</ui:style>
	<div>
		<!-- Add HTML content here -->
		<div style="line-height: 19px; padding: 10px; font-size: 14px; ">
			<div style="padding-bottom: 40px;">
				<b>gCube Reporting</b>
				allows users to create Reports and generate different
				export formats (OpenXML, HTML, PDF) based on results retrieved from the
				infrastructure.
			</div>
			<div style="padding-bottom: 40px;">gCube Templates are dynamically and statically completed.
			</div>
			<div style="padding-bottom: 40px;">
				gCube Templates are loaded by the <b>gCube Report Generator</b> to produce actual reports.
			</div>
			<div style="padding-bottom: 10px;">
				<b>Discover</b> gCube Reporting features through this quick tour.
			</div>
		</div>
	</div>
</ui:UiBinder>
  • both your .java and .ui.xml must stay in the same package

SamePackage.png

  • your public String setStepBody() previous method would just have the following body:
 
...
public String setStepBody() {
				return new IntroHTML().getHTML();   //no more HTML in Java Strings
			}
...

Enjoy!

Advanced (I wanna write only a configuration file)

If you want to avoid to include text into your portlet's code you may want to use the guided tour XML configurations.

This feature allows you to move bodies and titles into an XML file (the main configuration), if you support more than one language you can put it into another XML file.

Here an example of main configuration file (GuidedTour.xml):

<guidedtour width="930" height="450" usemask="false">
  <title>gCube Time Series</title>
  <guide>https://gcube.wiki.gcube-system.org/gcube/index.php/Time_Series</guide>
  <themecolor>BLUE</themecolor>
  <steps>
    <step>
      <title>Introduction</title>
      <bodies>
         <body><![CDATA[
<div>This is my first step!</div>
]]></body>
      </bodies>
      <images>
        <image url="images/step1.png" />
      </images>
    </step>
    <step showTitle="false" v-alignment="ALIGN_MIDDLE">
      <title>Second step</title>
      <bodies>
        <body><![CDATA[
<div>This is my second step!</div>
]]></body>
      </bodies>
      <images>
        <image url="images/step2.1.png" />
        <image url="images/step2.2.png" />
      </images>
    </step>
  </steps>
</guidedtour>


Here an example of translation file (GuidedTour_IT.xml):

<guidedtour>
  <steps>
    <step>
      <title>Introduzione</title>
      <bodies>
         <body><![CDATA[
<div>Ecco il mio primo passo!</div>
]]></body>
      </bodies>
    </step>
    <step>
      <title>Secondo passo</title>
      <bodies>
        <body><![CDATA[
<div>Ecco il mio secondo passo!</div>
]]></body>
      </bodies>
    </step>
  </steps>
</guidedtour>

As you can see the translation needs only the translated text, no images, no tour or step settings.

How to create the tour in my application using the XML configuration file?

The Guided Tour widget is provided with a GuidedTourResource, a GWT resource like ImageResource, CSSResource or TxtResource (http://code.google.com/webtoolkit/doc/latest/DevGuideClientBundle.html). Like the other resources the GuidedTourResource can be declared in a ClientBundle interface:

For example:

 
	interface Resources extends ClientBundle {
 
		  @Source("org/gcube/test/client/resources/GuidedTour.xml")
		  GuidedTourResource quickTour();
	}

As you can see the Source tag is pointing to the configuration file that we've seen before. The Source tag value is checked by the GWT Eclipse Plugin so if it is wrong the editor will alert you.

What about the translation files? Don't worry, just put it in the same folder of the main configuration file, the system will recognize it.

Now we want to show the Tour in our application, here's a way to do it:

 
		GCUBEGuidedTour.showTour(MyApplication.class.getName(), new GuidedTourResourceProvider() {
 
			@Override
			public GuidedTourResource getResource() {
				Resources resources = GWT.create(Resources.class);
				return resources.quickTour();
			}
		});

That's all??? yes, that's all. Enjoy.

How to move from declaration system to configuration files

Ok, but I've already created my tour with the declaration system, there is an easy way to move to XML configuration?? Yes, there is.

The GuidedTour widget is distributed with an utility class GuidedTourConfigurationExctractor. In this class there is a method analyze which take as parameter a GCubeGuidedTour object, the one you create for the tour. The method analyzes your GuidedTour and outputs the necessary XML in the console. What you need to do is to call it instead of openTour(), run you portlet once in Eclipse and the Extractor will generate the necessary XML files.

Adding MultiLanguage Support

If you want to give the quick tour in another language other than English, you can add as many as you wish. All you need to do is the following:

  • Add the Language you intend to support in the GCUBEGuidedTour Constructor, the following example to support Italian also.
	GCUBEGuidedTour gt = new GCUBEGuidedTour("gCube Template Creator", TemplateCreator.class.getName(), 
"http://www.myguide.com", 780, 450, false, ThemeColor.BLUE, TourLanguage.EN, TourLanguage.IT);  //add as many as TourLanguage you want here
  • Use the "ML" suffix for your GCUBETemplate instance:

NO

         TourStep step1 = new GCUBETemplate1Text1Image(true)

YES

         TourStep step1 = new GCUBETemplate1Text1ImageML(true)
  • Provide the tour in the languages you support, you will have to return a HashMap<TourLanguage, String> instead of a String, use TourLanguage Type as key, and the translation for the value.
			@Override
			public HashMap<TourLanguage, String> setStepTitle() {
				HashMap<TourLanguage, String> languages = new HashMap<TourLanguage, String>();
				languages.put(TourLanguage.EN, "Tables");
				languages.put(TourLanguage.IT, "Tabelle");
				return languages;
			}