Package org.omegat.help

Class Help

java.lang.Object

org.omegat.help.Help

public final class Help
extends Object

A utility class for accessing bundled local or online documentation.

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

ONLINE_HELP_URL

public static final String ONLINE_HELP_URL

URL for the online manual.

ONLINE_JAVADOC_URL

public static final String ONLINE_JAVADOC_URL

Method Details

showJavadoc

public static void showJavadoc()
                        throws IOException

Throws:

IOException

showHelp

public static void showHelp()
                     throws IOException

Shows help in the system browser.

Throws:

IOException - when URI creation failed.

getHelpFileURI

@Nullable
public static @Nullable URI getHelpFileURI(String filename)

getHelpFileURI

@Nullable
public static @Nullable URI getHelpFileURI(@Nullable
 @Nullable String lang,
 String filename)

getHelpFileURI

@Nullable
public static @Nullable URI getHelpFileURI(@Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable String lang,
 String filename)

errorHaiku

public static String errorHaiku()