Skip to main content



      Home
Home » Language IDEs » C / C++ IDE (CDT) » org.eclipse.cdt.linux.help -- asking for comments
org.eclipse.cdt.linux.help -- asking for comments [message #25553] Tue, 23 April 2002 11:40 Go to next message
Eclipse UserFriend
org.eclipse.cdt.linux.help -- asking for comments

This is a very brief outline of how the org.eclipse.cdt.linux.help
component of the CDT is going to change and it is here so people can
share their ideas, comments and concerns.

THE CURRENT SITUATION: only "local" projects

Currently, the org.eclipse.cdt.linux.help plugin in the CDT works
only with "local" projects. It allows you to index/search html(via
lucene), search man(via whatis) and info pages(by looking at the top dir
node). It uses two browsers: konqueror(kde) or gnome-help-browser(gnome)
to display documentation (html, man and info pages). We used these
browsers because they implicitly convert man and info pages to html for
display-- and add links to other man, info pages.

THE PROBLEM: Need to make it work for "remote" projects

The help is becoming a miner so that it can work with remote
projects. But, we cannot use these browsers to do the man to html or
info to html conversion. And we also have to consider a nonlinux
client(e.g windows) connected to a linux server. So here is what we are
planning:

- We are planning on using tomcat in the server to serve html
documentation to the client (This would preserve the links in html).We
would have a simple servlet that would know how to find a man or info
page and convert it to html before serving it to the client.

- There are two ways to do the conversion from man/info to html:
either use available tools(e.g. man2html, info2html) or write our own.
Although we would prefer to reuse an existing utility they do not come
with all linux distributions. We cannot package them because these tools
are GPL (i.e. incompatible with the Common Public License). We may have
to write our own. For man pages, we may just ask groff to produce
html(-Thtml) and do a second pass adding links to the "SEE ALSO"
sections (i.e we avoid looking at all those man macros).
An info to html convertor seems necessary.

- We plan on using whatever browser eclipse provides in the client
and point it to our remote servlet.


If you have some comments/ideas or a better way of doing it, then feel
free to share your ideas with us.
Re:correction [message #25595 is a reply to message #25553] Tue, 23 April 2002 11:44 Go to previous messageGo to next message
Eclipse UserFriend
> The help is becoming a miner so that it can work with remote

This line should have been:

The help is becoming a Miner(The CDT Tool Extension Mechanism) so that
it can work with remote projects.
Re: org.eclipse.cdt.linux.help -- asking for comments [message #25836 is a reply to message #25553] Tue, 23 April 2002 18:15 Go to previous messageGo to next message
Eclipse UserFriend
Enrique Varillas wrote:

> For man pages, we may just ask groff to produce
> html(-Thtml) and do a second pass adding links to the "SEE ALSO"
> sections (i.e we avoid looking at all those man macros).

Looking at the definitions of those macros (man groff_man) I now don't
think you really have a choice. There is no SEE ALSO macro, so you will
have to pattern match for name(section) like man2html does.
The Berkeley mdoc macros are better, they have a .Xr macro for
a manual cross reference, but only a minority of man pages use these.

Unfortunately groff -Thtml produces pretty boring output, but when you
filter it you could also insert your own CSS stylesheet to spice
it up a bit, e.g. by making the section headers green.

Would you assume that groff -Thtml -mandoc is the right command to use,
rather than reading /etc/man.config? That's probably pretty safe.
How would you find the source files, with man -aW?




Brian
Re: org.eclipse.cdt.linux.help -- asking for comments [message #26202 is a reply to message #25836] Wed, 24 April 2002 11:41 Go to previous messageGo to next message
Eclipse UserFriend
> Unfortunately groff -Thtml produces pretty boring output, but when you
> filter it you could also insert your own CSS stylesheet to spice
> it up a bit, e.g. by making the section headers green.
Yes, a CSS should help.


> Would you assume that groff -Thtml -mandoc is the right command to use,
> rather than reading /etc/man.config? That's probably pretty safe.
Although grohtml(invoked by groff with -Thtml) is not perfect, the
current plan is to use
"groff -mandoc -Thtml" . The "-mandoc" flag should handle both the
regular
'man' and BSD 'mdoc' macro package.

> How would you find the source files, with man -aW?
Yes, the "-a --path","-aw" or "-aW" flags give the filepath.
Re: org.eclipse.cdt.linux.help -- asking for comments [message #27143 is a reply to message #25553] Fri, 26 April 2002 17:19 Go to previous messageGo to next message
Eclipse UserFriend
>>>>> "Enrique" == Enrique Varillas <enriquev@ca.ibm.com> writes:

Enrique> - There are two ways to do the conversion from man/info to
Enrique> html: either use available tools(e.g. man2html, info2html) or
Enrique> write our own. Although we would prefer to reuse an existing
Enrique> utility they do not come with all linux distributions. We
Enrique> cannot package them because these tools are GPL
Enrique> (i.e. incompatible with the Common Public License).

Could you elaborate on this point? Wouldn't packaging these and
distributing them with Eclipse fall into the "mere aggregation" clause
of the GPL and thus be ok?

Tom
Re: org.eclipse.cdt.linux.help -- asking for comments [message #27221 is a reply to message #27143] Mon, 29 April 2002 11:21 Go to previous message
Eclipse UserFriend
Hi Tom,

We (meaning myself and those on my team) are not lawyers and we would need to obtain legal approval before doing
something like this. However, we can discuss the technical issue that some of these tools are C code and not binary
portable, which may be enough to prevent us from going down this path anyway.

Jeff.

"Tom Tromey" <tromey@redhat.com> wrote in message news:87vgaekvjh.fsf@creche.redhat.com...
> >>>>> "Enrique" == Enrique Varillas <enriquev@ca.ibm.com> writes:
>
> Enrique> - There are two ways to do the conversion from man/info to
> Enrique> html: either use available tools(e.g. man2html, info2html) or
> Enrique> write our own. Although we would prefer to reuse an existing
> Enrique> utility they do not come with all linux distributions. We
> Enrique> cannot package them because these tools are GPL
> Enrique> (i.e. incompatible with the Common Public License).
>
> Could you elaborate on this point? Wouldn't packaging these and
> distributing them with Eclipse fall into the "mere aggregation" clause
> of the GPL and thus be ok?
>
> Tom
Previous Topic:Eclipse Runs out of Memory when Parsing Include files
Next Topic:GDBPicl docs
Goto Forum:
  


Current Time: Mon Jul 07 16:15:47 EDT 2025

Powered by FUDForum. Page generated in 0.09798 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top