org.olat.core.commons.contextHelp
Class ContextHelpModule

java.lang.Object
  org.olat.core.logging.LogDelegator
      org.olat.core.configuration.AbstractOLATModule
          org.olat.core.commons.contextHelp.ContextHelpModule

All Implemented Interfaces:

OLATModule, GenericEventListener

public class ContextHelpModule
extends AbstractOLATModule

Description:

The context help module offers configuration methods for the context help system

Initial Date: 31.10.2008

Author:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

Field Summary

static java.lang.String	CHELP_BLACKLIST_RELPATH
static java.lang.String	CHELP_DIR
static java.lang.String	CHELP_STATIC_DIR

Constructor Summary

ContextHelpModule()

Method Summary

void	destroy() Destroy the module resources.
static java.util.Set<java.lang.String>	getAllContextHelpPages()
static java.util.Map<java.lang.String,java.lang.String>	getContextHelpPagesLegacyLookupIndex()
static boolean	isContextHelpEnabled()
static boolean	isContextRatingEnabled()
static void	refreshContextHelpIndex()

Methods inherited from class org.olat.core.configuration.AbstractOLATModule

event, init

Methods inherited from class java.lang.Object

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

Field Detail

CHELP_DIR

public static final java.lang.String CHELP_DIR

See Also:

Constant Field Values

CHELP_STATIC_DIR

public static final java.lang.String CHELP_STATIC_DIR

See Also:

Constant Field Values

CHELP_BLACKLIST_RELPATH

public static final java.lang.String CHELP_BLACKLIST_RELPATH

See Also:

Constant Field Values

Constructor Detail

ContextHelpModule

public ContextHelpModule()

Method Detail

destroy

public void destroy()

Description copied from class: AbstractOLATModule

Destroy the module resources. Called by the framework at shutdown time

Specified by:

destroy in interface OLATModule

Overrides:

destroy in class AbstractOLATModule

See Also:

OLATModule.destroy()

refreshContextHelpIndex

public static void refreshContextHelpIndex()

isContextHelpEnabled

public static boolean isContextHelpEnabled()

Returns:

true: use context help; false: don't show context help

isContextRatingEnabled

public static boolean isContextRatingEnabled()

Returns:

true: allow users to rate help pages; false: don't allow users to rate help pages

getContextHelpPagesLegacyLookupIndex

public static java.util.Map<java.lang.String,java.lang.String> getContextHelpPagesLegacyLookupIndex()

Returns:

lookup map that can be used to find the package of a page when only the page name is known (legacy mode)

getAllContextHelpPages

public static java.util.Set<java.lang.String> getAllContextHelpPages()

Returns:

Set containing all help pages using the combined format: package.name:page_name.html