Please, see

Demo

and especially the section for best practices:

Best Practices

[top]

Please look at tobago-example-blank or download the myfaces-tobago-example from the nightly builds directory.

[top]

Tobago runs with Sun RI and with MyFaces. Please take a look at the Compatibility List.

[top]

Tobago supports Facelets with the tobago-facelets.jar. Note: Please add following context param in your web.xml

<context-param>
  <param-name>facelets.SKIP_COMMENTS</param-name>
  <param-value>true</param-value>
</context-param>

[top]

JSF only supports one renderkit (renderkitId) per page (f:view). Because Tobago has it's own renderkitId you cannot use any non-Tobago components that need a renderer.

[top]

<tc:gridLayout rows="fixed;100px;1*;2*" />

The attribute 'fixed' means a theme dependent height of one row (i.e. in Speyside a row is typically 20px high.) In a 'fixed' row all one height unit high elements find their place (like buttons, input fields, one row of text...).

Using px heights is at your own risk, but it is sometimes needed for elements like box or sheet.

Alternatively you can give elements a proportion with the * notation.

For example rows="1*;2*" gives the first row 1/3 of the available vertical space and the second row 2/3. This works fine for columns, too.

You can group elements with a tc:panel element. Such a panel is interpreted as one element regarding layout. The panel itself can have its own layout for multiple elements inside the panel.

[top]

You have two options.

Add a TobagoMultipartFormdataFilter to your web.xml. JavaDoc Description

Add the tobago-fileupload.jar to your project. The tobago-fileupload.jar contains a FacesContextFactory that wraps the multipart-formdata request inside the FacesContext. JavaDoc Description

[top]

The page tag already acts like a form tag. You only need a explicit form tag for partial validation of your data. Please look at the forms example in the Tobago demo

[top]

Please take a look at the Compatibility List.

[top]

You have to define a new name for the theme in the META-INF/tobago-config.xml. Choose a fallback theme in the tobago-config.xml. Put the modified resources under the resource-path + theme-name. An example for this is the charlotteville theme. (TODO more details resource handling)

Example layout of a theme jar:

/META-INF/tobago-config.xml
(resource-path/html/theme-name)
/org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/style.css (standard styles)
/org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-menu.css (menu styles)
/org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-sheet.css (sheet styles)
/org/apache/myfaces/tobago/renderkit/html/xxxxx/msie/style/style.css (different styles for msie)

resource-path/content-type/theme/client/[tag(for renderer)|property|style|script|image]_locale
    .(class|property|property.xml|css|js|gif|png...]

Please look at tobago-example-theme

[top]

UIBox, UIInput and UIOutput support custom markup with the markup attribute. The supported markup is defined in the tobago-config.xml. The standard markup is defined in tobago-config.xml of the tobago-theme-standard. This can be extended in your own theme. The markup attribute is rendered as a CSS class tobago-[renderer-name.toLowerCase]-markup-[markup]. For an example please look at the markup number and the CSS class tobago-in-markup-number for UIInput in theme/scarborough/src/main/resources/org/apache/myfaces/tobago/renderkit/html/scarborough/standard/style/style.css

[top]

Please take a look at the Compatibility List. Feel free to post your own experiences.

[top]

Tobago cannot replace it. But sometimes you may not need it, when you are using Tobago. If you want to position and size your components automatically, you can do this with a Tobago LayoutManager. If you want your header and sidebar rendered without writing duplicate code, you may use JSP 2.0 tag files, Facelets or Tiles/Sitemesh.

[top]

If you want to set up a different mirror for some reason, you can use your ~/.m2/settings.xml and add the following lines:

<mirrors>
  <mirror>
    <id>mirror ID</id>
    <name>Give it a name</name>
    <url>The URL of the mirror</url>
    <mirrorOf>The server ID of the repository being mirrored.
        This must not match the mirror ID</mirrorOf>
  </mirror>
</mirrors>

See: Guide to mirror settings

Mirrors: List of mirrors

[top]

If you run into problems with fetching jars from the online repository, you can configure Maven not to fetch them but use the ones already in your local repository by adding the following to your ~/.m2/settings.xml:

<settings>
  <offline/>
</settings>

or use the mvn -o switch.

[top]

mvn compile checkstyle:check

[top]

SUBST X: "C:\Dokumente und Einstellungen\MyUser\Apache Projects\"

[top]

In the tobago-example-test application, the pages can be checked with selenium since Tobago 1.5. To run the full test automatically call

mvn -P integration-test

If you want to run the tests from your IDE, please start the jetty with

mvn jetty:run

mvn jetty:run-exploded

mvn selenium:start-server

Sometimes there is a problem with Firefox. You may try to use a different version, or an installation without plugins.

[top]

Please use at least Tobago 2.0 for this guidance (in this version the pom.xml files are prepared).

You will need to do the following steps for preparation:

• Download the server like:

  wlp-developers-runtime-8.5.next.beta.jar

  from IBM (Todo: check if this is the correct version)
• Unpack the server anywhere in you file system, e.g. like this

  mkdir /opt/wlp-developers-runtime-8.5.next.beta
  cd /opt/wlp-developers-runtime-8.5.next.beta
  java -jar ~/Downloads/wlp-developers-runtime-8.5.next.beta.jar
             

• Adding your server home to a property in the settings.xml of Maven

  <wlp.directory>/opt/wlp-developers-runtime-8.5.next.beta</wlp.directory>

After these steps you can start/stop the server and deploy an built artifact. For these steps, you need to be in a Tobago example directory.

cd tobago-examples/tobago-example-demo

• Start the server

  mvn -Pliberty liberty:start-server

• Build an artifact (you need the "provided" property, because JSF and OWB comes from the server)

  mvn package -Djsf=provided

• Deploy an artifact

  mvn -Pliberty liberty:deploy

• You will find the web application under this URL

  http://localhost:9080/tobago-example-demo/

• Redeploy an artifact: The same as deploy.
• Stop the server

  mvn -Pliberty liberty:stop-server

The server starts very fast and is simple to use (very different from the full WebSphere installation). The log files you will find here:

cd /opt/wlp-developers-8.5.next.beta/wlp/usr/servers/tobago/logs/

• Stop the server
• Remove the whole concrete server installation

  rm -r /opt/wlp-developers-8.5.next.beta/wlp/usr/servers/tobago

• Start the server
• Deploy again

[top]