Uploaded image for project: 'OpenOLAT'
  1. OpenOLAT
  2. OO-4562

Extend help module, include academy and more

    XMLWordPrintable

    Details

      Description

      Currently the help module has very limited configuration options and it can be configured only via olat.properties. We want to add more options, e.g. to include the Academy and contact forms. 

      The help can be a list of things: 

      • ✅ Link to the versioned manual (as today)
      • ✅ The Help course (old legacy)
        • Not visible on the login page, because starting a course without any role is not possible
      • ✅ Link to Academy (new)
      • ✅ Link to any page (new)
        • 3 different links can be configured
      • ✅ Contact form (new)

       

      ✅ The order of the help plugins should be editable. 

      Preset in olat.properties for the default values (new): 

      help.enabled=true
      
      # Define the plugin which generate the help URL
      help.plugin=ooConfluenceLinkHelp, ooAcademyLinkHelp
      help.plugin.values=ooConfluenceLinkHelp,ooAcademyLinkHelp,supportMailHelp,courseHelp,customLinkHelp
      
      # Settings for the ooConfluenceLinkHelp plugin 
      help.confluence.enabled=usertool,authorsite,dmz 
      
      # Settings for the ooAcademyLinkHelp plugin 
      help.academy.link=https://www.openolat.org/academy 
      help.academy.enabled=usertool,authorsite,dmz
      
      # Settings for the supportMailHelp plugin 
      help.support.email=${supportemail} 
      help.support.enabled=usertool,authorsite
       
      # Settings for the courseHelp plugin
      help.course.softkey=OLAT::help-course_de.zip
      help.course.enabled=
      
      # Settings for the customLinkHelp plugin 
      help.custom1.link= 
      help.custom1.enabled=
      help.custom2.link= 
      help.custom2.enabled=
      help.custom3.link= 
      help.custom3.enabled=
      
      

      The existing properties should work after transition. 

       

       

        Attachments

        1. config.png
          config.png
          352 kB
        2. run.png
          run.png
          398 kB

          Activity

            People

            Assignee:
            aboeckle Alexander Böckle
            Reporter:
            gnaegi Florian Gnägi
            Tester:
            Mandy Menzel
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 4 days, 6 hours, 30 minutes
                4d 6h 30m