Uploaded image for project: 'translate5'
  1. translate5
  2. TRANSLATE-2634

Integrate PDF documentation in translate5 help window

    XMLWordPrintable

Details

    • Critical
    • Hide
      By default the new PDF documentation for translate5s editor is integrated in the help window of the editor. If you do not want to show this to your users, please deactivate it after the upgrade in the system configuration (GUI). For detailed info how this can be configured please check this link: https://confluence.translate5.net/display/CON/Database+based+configuration
      If you happen to have defined custom help content in the editor, and the help content is in written text/pdf/html , it make sense this content to be loaded with editordocumentation.phtml
      Show
      By default the new PDF documentation for translate5s editor is integrated in the help window of the editor. If you do not want to show this to your users, please deactivate it after the upgrade in the system configuration (GUI). For detailed info how this can be configured please check this link: https://confluence.translate5.net/display/CON/Database+based+configuration If you happen to have defined custom help content in the editor, and the help content is in written text/pdf/html , it make sense this content to be loaded with editordocumentation.phtml
    • Hide
      Pdf documentation in the editor help window is available now.
      To change PDF location or disable see config runtimeOptions.frontend.helpWindow.editor.documentationUrl
      Show
      Pdf documentation in the editor help window is available now. To change PDF location or disable see config runtimeOptions.frontend.helpWindow.editor.documentationUrl

    Description

      The written translate5 documentation about the most important end-user features should be included in the help window for the editor.

      A tab navigation should be introduced, showing "Video" on the first tab (shown by default) and "PDF documentation" / "PDF Dokumentation" on the second tab.

      The second tab should only appear, if an URL is defined for it in a new config value.

      It could also happen, that no video is defined in the config, but the PDF is. Also vice versa. In that cases no tab navigation should be shown.

      As text for the new config please use:

      Gui group: System setup: Help

      Gui name: Help window URL PDF documentation: Editor

      desscription: "The content of the defined URL will be loaded in this help page section. If empty and if the URL for the help video is also empty, nothing is loaded and the help button will not be available. If a video URL is also defined there will be a tab navigation in the help window."

      Please change the following:

      runtimeOptions.frontend.helpWindow.editor.loaderUrl

      => Gui Name change to: Help window URL video: Editor

      => description change to: "The content of the defined URL will be loaded in this help page section. If empty and if the URL for the PDF documentation is also empty, nothing is loaded and the help button will not be available. If a PDF documentation URL is also defined there will be a tab navigation in the help window."

      Attachments

        Activity

          People

            aleksandar Aleksandar Mitrev
            marcmittag Marc Mittag [Administrator]
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: