forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ross Gardler (JIRA)" <j...@apache.org>
Subject [jira] Updated: (FOR-162) Add ability to generate Eclipse Help Plug-in compliant sites
Date Mon, 09 Jan 2006 11:45:20 GMT
     [ http://issues.apache.org/jira/browse/FOR-162?page=all ]

Ross Gardler updated FOR-162:
-----------------------------

        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

  was:
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

       Priority: Minor  (was: Major)

[Updated with new Urgency field see http://forrest.apache.org/issues.html#urgency for more
details]

This is the kind of request that will only be completed when someone has enough of an itch
to actually build it. I do have a need for something like this, but other things have a greater
need right now.

Since no other dev have started work on it I doubt anyone else has that need.

Of course, if the original reporter, Geoff, would like to join us on the dev list I (and other
people) will be more than happy to give advice on how to build this. It's all fairly easy
in terms of the XSL and sitemap stuff that needs doing, the hard part is knowing what to do
on the Forrest internals, so asking on the dev list will probably help someone considerably.



> Add ability to generate Eclipse Help Plug-in compliant sites
> ------------------------------------------------------------
>
>          Key: FOR-162
>          URL: http://issues.apache.org/jira/browse/FOR-162
>      Project: Forrest
>         Type: New Feature
>   Components: Plugins (general issues)
>     Versions: 0.6
>  Environment: ALL
>     Reporter: Geoff Longman
>     Priority: Minor

>
> 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

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message