Page tree
Skip to end of metadata
Go to start of metadata

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Load EditLive! Help

showHelp

Help...

N/A

N/A

Display information about current EditLive! version.

eljAboutELJ

About EditLive!...

N/A

N/A

Popup menu of help and debugging commands, consisting of:

    • Help
    • About EditLive!
    • Enable Debug Logging
helpMenuHelpN/A

N/A

EditLive! help files are, by default, launched from the Tiny website.

Hosting Help Locally

To customize EditLive! to load Help files from a specific location, perform the following steps:

  1. Contact Tiny support to get a copy of the EditLive! Help source files.
  2. Unzip the source files to a desired location in your environment.
  3. Add a value parameter to your <menuItem> or <toolbarButton> elements which specify a name attribute of showHelp.
    • The value parameter specifies the location of your local Help deployment. Help is internationalized based on the current locale being used by the editor. As such, there are two different types of URLs you can pass to value:
      1. An absolute URL which will be automatically completed based on the editor's locale. Locale for the editor is either specified explicitly via the Locale load-time property or automatically detected. Using this method, the location of Help will be constructed by combining the URL in value, the locale and index.html in the following format: VALUE / LOCALE / index.html
        Example
        The value attribute contains http://server/docs/help
        The locale is en (which is English)
        The editor will load Help from the following location: http://serverdocs/help/en/index.html
      2. A relative URL, relative to the setDownloadDirectory Method.
        Example
        If you are currently running the editor with an English locale (i.e. en), the following configuration will load Help from http://www.myserver.com/editlive/enduserhelp/en/index.html_.

        ...
        <menuItem name="showHelp" value="http://www.myserver.com/editlive/enduserhelp/" />
        ...

Example
The following configuration will load Help from the location specified, relative to the setDownloadDirectory Method.

If you are currently running the editor with an English locale (i.e. en), with a DownloadDirectory of http://www.myserver.com/editlive, then Help will load from http://www.myserver.com/editlive/enduserhelp/en/index.html.

...
<toolbarButton name="showHelp" value="enduserhelp/" />
...
  • No labels