Uploaded image for project: 'Forrest'
  1. Forrest
  2. FOR-162

Add ability to generate Eclipse Help Plug-in compliant sites

Attach filesAttach ScreenshotAdd voteVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Plugins: Potential new
    • Labels:
      None
    • Environment:
      ALL
    • Urgency:
      Normal

      Description

      It would be nice to be able to generate a site that can be embedded into an Eclipse help plugin.

      The criteria would be as such:

      1. Generate more compact html. i.e. with less header info. The Eclipse help center is typically sized small on a user's screen and the less cruft the better. The workaround decribed in #2 below can get around this with the current way things are generated, but its kludgey.

      2. Generate html that does not contain the menus as Eclipse uses an xml files called a toc file to generate its own menus. A current workaround is to generate the site using a modified the forrest-css skin. The css is modified to hide the menus and compress the header portion of the page. Although you have to specify a 1px image in skinconf.xml for the mandatory project logo in order for this to work.

      3. Generate an Eclipse toc file that is basically a transformation of the site.xml.

      Note - I have been using forrest fo exactly 1 day so buyer beware.

      Reference material:

      A link to a page decribing the format of the Eclipse toc file:

      http://help.eclipse.org/help21/topic/org.eclipse.platform.doc.isv/guide/help_plugin_toc.htm

      P.S. I left the priority for this issue at it default setting for no particular reason.

      Geoff

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              glongman Geoff Longman

              Dates

              • Created:
                Updated:

                Issue deployment