Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0.0-b3
    • Fix Version/s: 2.5
    • Component/s: Documentation
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-6081Review Online Help for 2.0
      KULRICE-4856KR/KC Help Integration
      KULRICE-6674UI Framework - Online Help architecture
      KULRICE-8914Convert help functionality to Spring MVC
      KULRICE-3828Update Rice Help for KFS Patch
      KULRICE-12726Configure KEW and Help for Administration > Identity screens
      KULRICE-6739Document the UI Framework - Online Help architecture
      KULRICE-3324Add a "build time" to manifest file in Rice jars
      KULRICE-3653No context-sensitive help available for Rice documents
      KULRICE-2105Convert kim-authn-sesn to use rice database.
    • Sprint:
      Core 2.5.0-m3 Sprint 2
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required

      Description

      Integrate converted online help files into Rice. They're now in DocBook and the app needs to point to them.

        Issue Links

          Activity

          Hide
          Jessica Coltrin (Inactive) added a comment -

          [12/13/11 10:33:04 AM] Peter Giles: Help links for each doc type are configured in the database, see http://fisheye.kuali.org/viewrep/rice/branches/rice-release-1-0-1-br/scripts/upgrades/1.0.0%20to%201.0.1/db-updates/10-29-2009.sql?r=9861
          [12/13/11 10:33:58 AM] Peter Giles: I think section and field level help links are set up in the DD.
          [12/13/11 10:38:17 AM] Peter Giles: I think all the links are hard coded (as opposed to generated) as you see in that SQL, so there is almost no magic in the help system.

          Show
          Jessica Coltrin (Inactive) added a comment - [12/13/11 10:33:04 AM] Peter Giles: Help links for each doc type are configured in the database, see http://fisheye.kuali.org/viewrep/rice/branches/rice-release-1-0-1-br/scripts/upgrades/1.0.0%20to%201.0.1/db-updates/10-29-2009.sql?r=9861 [12/13/11 10:33:58 AM] Peter Giles: I think section and field level help links are set up in the DD. [12/13/11 10:38:17 AM] Peter Giles: I think all the links are hard coded (as opposed to generated) as you see in that SQL, so there is almost no magic in the help system.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          This can happen in 2.1. Not critical.

          Show
          Jessica Coltrin (Inactive) added a comment - This can happen in 2.1. Not critical.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          talk to Jerry to see how this relates to the 2.2 help framework requirement.

          Show
          Jessica Coltrin (Inactive) added a comment - talk to Jerry to see how this relates to the 2.2 help framework requirement.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          moving this to 2.2 as part of the help framework conversion

          Show
          Jessica Coltrin (Inactive) added a comment - moving this to 2.2 as part of the help framework conversion
          Hide
          Jessica Coltrin (Inactive) added a comment -

          Latest converted online help in DocBook is available at http://site.kuali.org/rice/latest/reference/html/Help.html.

          Show
          Jessica Coltrin (Inactive) added a comment - Latest converted online help in DocBook is available at http://site.kuali.org/rice/latest/reference/html/Help.html .
          Hide
          Kristina Taylor (Inactive) added a comment - - edited

          I wonder if we can use the ${rice.version} for this. So instead we would include

          http://site.kuali.org/rice/${rice.version}/reference/html/Help.html

          The code in the KNS indicates that this is possible, and I suspect this wouldn't be too hard to do for KRAD once we convert these views. None of those views have section or field help enabled, so we probably can just configure the document type help.

          We might also want to consider changing the DEFAULT_HELP_URL parameter in the same way in the database.

          Show
          Kristina Taylor (Inactive) added a comment - - edited I wonder if we can use the ${rice.version} for this. So instead we would include http://site.kuali.org/rice/${rice.version}/reference/html/Help.html The code in the KNS indicates that this is possible, and I suspect this wouldn't be too hard to do for KRAD once we convert these views. None of those views have section or field help enabled, so we probably can just configure the document type help. We might also want to consider changing the DEFAULT_HELP_URL parameter in the same way in the database.
          Hide
          Kristina Taylor (Inactive) added a comment - - edited

          [9:38:33 AM] Jessica Coltrin: Yeah, we discussed that a while ago. Since screens can change dramatically between versions, it seemed best to have the version someone is working with. For example, once Action List changes,help would be updated for that version. A user of KFS running on 2.1.9 would want to see help screens based on their version, not the new version with different functionality.
          [9:39:16 AM] Kristina B. Taylor: Ok, I think I saw that the KNS code handles substitution in this manner and then I'm guessing that KRAD would be able to as well.
          [9:40:20 AM] Kristina B. Taylor: So, ideally, if the ${rice.version} is set up correctly (and I'm not seeing why anyone at an instituion would mess with that) then it would pull the correct link from our help repo.

          Show
          Kristina Taylor (Inactive) added a comment - - edited [9:38:33 AM] Jessica Coltrin: Yeah, we discussed that a while ago. Since screens can change dramatically between versions, it seemed best to have the version someone is working with. For example, once Action List changes,help would be updated for that version. A user of KFS running on 2.1.9 would want to see help screens based on their version, not the new version with different functionality. [9:39:16 AM] Kristina B. Taylor: Ok, I think I saw that the KNS code handles substitution in this manner and then I'm guessing that KRAD would be able to as well. [9:40:20 AM] Kristina B. Taylor: So, ideally, if the ${rice.version} is set up correctly (and I'm not seeing why anyone at an instituion would mess with that) then it would pull the correct link from our help repo.

            People

            • Assignee:
              Kristina Taylor (Inactive)
              Reporter:
              Matt Sargent
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 1 day
                1d
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 day
                1d

                  Agile

                    Structure Helper Panel