RE: [ROOT] THtml and Contet menu

From: Faine, Valeri (fine@bnl.gov)
Date: Fri Nov 12 2004 - 20:17:31 MET


 
> Valeri,
 
> Please play with your imagination, but do not send wrong
> information to this list if you do not know what you are
> talking about concerning the new HELP system currently
> under development.

It seems to me I did not send ANY information to this list on the issue.
I sent questions to get the information ... didn't I?

Are you saying one should ask question on the list when he/she had already
known the answer :-)

> We want to improve the situation (fast help and better help).
> Note that this new facility will not be part of the 4.01 release
> in December, but we expect to have it in the next iteration
> next year.

  Thank you, Valeri

> Rene Brun
> 
> On Fri, 12
> Nov
> 2004, Faine, Valeri wrote:
> 
> > Hello Axel,
> >
> > I am sorry, I think this just because of lack of information explaining
the
> > idea.
> > One said there will be new class and it was the only information about
that.
> > Thatr left plenty of the space for imagination to work . . .
> >
> >   Thank you
> >
> > ----
> > Best regards
> >                    Valeri
> >
> >
> > > -----Original Message-----
> > > From: Axel Naumann [mailto:axel-naumann@gmx.de]
> > > Sent: Friday, November 12, 2004 12:34 PM
> > > To: Faine, Valeri
> > > Cc: 'roottalk@pcroot.cern.ch'
> > > Subject: Re: [ROOT] THtml and Contet menu
> > >
> > > Jesus, Valeri, please: the html will still exist, and nobody will
notice
> > > any difference. When you tell THtml to generate documentation you will
> > > get your html as you used to. I thought I had explained all that in
> > > detail in my answer. You are right that some info is not available in
> > > the html files, but that's because it's not needed for html files, and
> > > it never was (like "what classes will I have to regenerate when file X
> > > has changed"). The original html doc will be improved, not replaced.
> > >
> > > Please, read Rene's and my answer before indirectly claiming silly
> > > things like "we do need some special ROOT-based Web browser plug-in to
> > > be able to get access to ALL ROOT Help". This is just plain wrong, and
> > > all the emails you could have read in this thread tell you the exact
> > > opposite. I'm very willing to discuss each bit of the (not even fixed)
> > > implementation - if the discussion is getting us somewhere.
> > >
> > > Axel.
> > >
> > > Faine, Valeri wrote:
> > > >>Hi Valeri,
> > > >>
> > > >> > Thank you very much for your precise clarification.
> > > >>
> > > >>You're welcome.
> > > >>
> > > >> > Is it possible to create the ROOT HELP file from its HTML
> > counterpart?
> > > >>
> > > >> >> Both output formats - html files
> > > >> >> and the online html help (and any other, non-html formats that
> > people
> > > >> >> implement) - are generated from the objects stored in the root
file.
> > > >>
> > > >>Or: no. the .root file is the core, not the .html files.
> > > >
> > > >
> > > > This means we have to forget about HTML and about any user code and
we
> > do
> > > > need some special ROOT-based Web browser plug-in to be able to get
> > access to
> > > > ALL ROOT Help information. Your ".root file is the core" sounds for
me
> > like
> > > > some information will be not available through HTML will be it?
> > > >
> > > > What about ROOT file in "XML format" using ROOT XML I/O feature?
> > > >
> > > >   Thank you, Valeri
> > > >
> > > >
> > > >>Axel.
> > > >>
> > > >>
> > > >>>>-----Original Message-----
> > > >>>>From: Axel Naumann [mailto:axel-naumann@gmx.de]
> > > >>>>Sent: Friday, November 12, 2004 12:50 AM
> > > >>>>To: Valeri Fine
> > > >>>>Cc: 'Thomas Bretz'; roottalk@pcroot.cern.ch
> > > >>>>Subject: RE: [ROOT] THtml and Contet menu
> > > >>>>
> > > >>>>Hi Valeri,
> > > >>>>as Rene pointed out, there will be both .html and .root. The root
file
> > > >>>>contains objects - storing those in html introduces an overhead
that's
> > > >
> > > > not
> > > >
> > > >>>>worth it. So instead of creating the application around a data
format,
> > > >>>>there will be a data format that suits the application. Browsers
read
> > > >>>>html, root reads root files. The root file will not replace the
html
> > > >
> > > > doc;
> > > >
> > > >>>>there will be an additional online help. Both output formats -
html
> > > >
> > > > files
> > > >
> > > >>>>and the online html help (and any other, non-html formats that
people
> > > >>>>implement) - are generated from the objects stored in the root
file.
> > > >>>>
> > > >>>>Cheers, Axel.
> > > >>>>
> > > >>>>
> > > >>>>
> > > >>>>>Hello Rene,
> > > >>>>>
> > > >>>>>Some question inspired by this discussion.
> > > >>>>>
> > > >>>>>
> > > >>>>>
> > > >>>>>>We intend to use this class to browse any html document and in
> > > >>>>>>particular
> > > >>>>>>the ROOT documentation itself that will be available in super
> > > >
> > > > compressed
> > > >
> > > >>>>>>form in $ROOTSYS/etc/help.root.
> > > >>>>>
> > > >>>>>
> > > >>>>>Why do you want to save it in the very "root" format?
> > > >>>>>With the plain HTML one could have used it with and with no ROOT.
> > > >>>>>
> > > >>>>>Are you going to repeat the Microsoft approach?
> > > >>>>>They indeed had the own binary format for HELP files but then  .
. .
> > > >>>>>
> > > >>>>>The HTML text file can be zipped just one care about the file
size.
> > For
> > > >>>>>example,
> > > >>>>>Window XP can read transparently the files within ZIP archive
without
> > > >>>>>bothering
> > > >>>>>the user to uncompress it first.  ROOT can do that also. I mean,
> > > >
> > > > instead
> > > >
> > > >>>>>of
> > > >>>>>reading the ROOT file with the help information; ROOT can unzip
the
> > > >
> > > > text
> > > >
> > > >>>>>file with
> > > >>>>>the HTML inside.
> > > >>>>>
> > > >>>>>By the way, it would have made it fully compatible with the
> > > >
> > > > corresponding
> > > >
> > > >>>>>Qt text
> > > >>>>>widgets.
> > > >>>>>
> > > >>>>>As result, our Qt users will enjoy this format with no extra
effort
> > > >
> > > > also.
> > > >
> > > >>>>>Just my 2 cents.
> > > >>>>>
> > > >>>>>
> > > >>>>>Hope this helps, Valeri
> > > >>>>>
> > > >>>>>
> > > >>>>>
> > > >>>>>
> > > >>>>>>Hi Thomas,
> > > >>>>>>
> > > >>>>>>Good that you ask this question!
> > > >>>>>>
> > > >>>>>>We are just about to introduce a new class TGHtml.
> > > >>>>>>We intend to use this class to browse any html document and in
> > > >>>>>>particular
> > > >>>>>>the ROOT documentation itself that will be available in super
> > > >
> > > > compressed
> > > >
> > > >>>>>>form in $ROOTSYS/etc/help.root.
> > > >>>>>>Axel Naumann is working on a modification of THtml that will
> > generate
> > > >>>>>>help.root
> > > >>>>>>file automatically (or any user classes).
> > > >>>>>>The idea that you should be able to get quickly the help from
the
> > > >>>>>>browser,
> > > >>>>>>the command line, the pad, etc.
> > > >>>>>>
> > > >>>>>>The TGHtml class could be used to browse any kind of document.
One
> > > >
> > > > could
> > > >
> > > >>>>>>even
> > > >>>>>>imagine that stdout from ROOT could be automatically hyperlinked
> > with
> > > >>>>>>this
> > > >>>>>>class.
> > > >>>>>>
> > > >>>>>>TGHtml will be introduced in CVS before the production release
in
> > > >>>>>>December.
> > > >>>>>>The adaptation to the ROOT help system is scheduled for the
first
> > > >>>>>>quarter of
> > > >>>>>>next year.
> > > >>>>>>
> > > >>>>>>Rene Brun
> > > >>>>>>
> > > >>>>>>Thomas Bretz wrote:
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>Dear all,
> > > >>>>>>>
> > > >>>>>>>I have a suggestion:
> > > >>>>>>>It would be nice if there would be an option in the context
menu of
> > a
> > > >>>>>>>class drawn to a pad (eg TH1F in a canvas) to show the class
> > > >>>>>>
> > > >>>>>>description
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>as plain text on the console. I don't know how a implementation
> > could
> > > >>>>>>>look like without storing the whole class description in the
> > > >>>>>>
> > > >>>>>>executable
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>and without starting a browser. Maybe it is possible to compile
the
> > > >>>>>>>class description text into a root file which can be opened by
the
> > > >>>>>>
> > > >>>>>>user.
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>If such a 'docu' file is open the corresponding help-entry
appears
> > in
> > > >>>>>>>the context menus. Through the TBrowser now all class
descriptions
> > > >>>>>>
> > > >>>>>>would
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>be acessible. This gives an easy interface to an online-help in
> > > >>>>>>
> > > >>>>>>programs.
> > > >>>>>>
> > > >>>>>>
> > > >>>>>>>What do you think?
> > > >>>>>>>
> > > >>>>>>>Best regards,
> > > >>>>>>>Thomas.
> > > >>>>>
> > > >>>>>
> > > >>>>>
> > > >
> >



This archive was generated by hypermail 2b29 : Sun Jan 02 2005 - 05:50:10 MET