Uploaded image for project: 'Jalview'
  1. Jalview
  2. JAL-1562

refactor help documentation system

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 3.0
    • Component/s: documentation
    • Labels:
      None
    • Urgency:
      Nice to have

      Description

      The Jalview help system is based around java help - simple HTML documents with an XML document to define the contents page. There are, however, lots of duplicated pieces of information in the simple HTML pages that we could refactor to new sections that are then included within the HTML document that we ship.

      Since freemarker is now a build dependency for publishing the Jalview applet, we could migrate the help page to a freemarker publishing model, which would allow boiler-plate inserts, etc.

        Attachments

          Activity

            People

            Assignee:
            jprocter Jim Procter
            Reporter:
            tcnofoegbu Tochukwu Charles N Ofoegbu
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: