Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Instead use the feature to Implement a custom translate5 skin / look & feel and put your custom phtml help page in the client-specific folder, where it will not be overwritten.


documentationUrl Help window configuration definition in editorThe same way as the loaderUrl, in the editor overview if you define an url in this config

You can configure the help window and show content/documentation in 2 different tabs from 2 different sources.

  • Videos
    • defined with runtimeOptions.frontend.helpWindow.editor.

...

    • loaderUrl 
    • default /help/{0} . The default will show the translate5 editor video from the translate5 youtube channel
    • the content is loaded from editor.phtml located in /application/modules/default/views/scripts/help/ overwritable with client specific functionality
    • is meant for displaying video content documentation
    • can be configured to to load the content from remote url. The remote content will be loaded into an iframe


  • PDF documentation
    • defined with runtimeOptions.frontend.helpWindow.editor.documentationUrl
    • default/help/editordocumentation/{0} . The default will show the written pdf docu for the transalte5 editor.
    • the content is loaded from editordocumentation.phtml located in /application/modules/default/views/scripts/help/ overwritable with client specific functionality
    • is meant for showing written documentation.
    • If you provide placeholder ( {0} ) in the url ex: http://translate5.local/editor?lang={0} , the language locale of the current user will be set when the url is called.
    • can be configured to to load the content from remote url. The remote content will be loaded into an iframe

Help page localization

The current locale of the authenticated user can also be passed to the loaderUrl via the optional placeholder "{1}". This fragment is replaced with the current users locale.

...