org.omegat.help

Class Help

java.lang.Object

org.omegat.help.Help

public final class Help
extends java.lang.Object

A utility class for accessing bundled local or online documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ONLINE_HELP_URL URL for the online manual.
static java.lang.String	ONLINE_JAVADOC_URL

Method Summary

Modifier and Type	Method and Description
static java.lang.String	errorHaiku()
static java.net.URI	getHelpFileURI(java.lang.String filename)
static java.net.URI	getHelpFileURI(java.lang.String lang, java.lang.String filename)
static void	showHelp() Shows help in the system browser.
static void	showJavadoc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ONLINE_HELP_URL

public static final java.lang.String ONLINE_HELP_URL

URL for the online manual.

ONLINE_JAVADOC_URL

public static final java.lang.String ONLINE_JAVADOC_URL

Method Detail

showJavadoc

public static void showJavadoc()
                        throws java.io.IOException

Throws:

java.io.IOException

showHelp

public static void showHelp()
                     throws java.io.IOException

Shows help in the system browser.

Throws:

java.io.IOException

getHelpFileURI

public static java.net.URI getHelpFileURI(java.lang.String filename)

getHelpFileURI

public static java.net.URI getHelpFileURI(java.lang.String lang,
                                          java.lang.String filename)

errorHaiku

public static java.lang.String errorHaiku()