Re: Collaborative effort on a User's Guide

From: Damir Buskulic (buskulic@lapp.in2p3.fr)
Date: Mon Feb 07 2000 - 23:16:04 MET


Hi Yannick,

Sure, HTML is not the best choice. I converted a word document just
because it was easier for people to view the result, and I was not forced
to do a very long message which nobody would read. It was just a
convenience.

For the format, I thought of using a cvs repository which could contain
latex or rtf sources. The format is to be discussed but it is in my
opinion an issue that will be discussed among people that will do the
work. The most important for the moment is to find those people.
Are you a candidate ? :-) 

Cheers

Damir

=====================================================================
| Damir Buskulic                  | Universite de Savoie/LAPP       |
|                                 | Chemin de Bellevue, B.P. 110    |
| Tel : +33 (0)450091600          | F-74941 Annecy-le-Vieux Cedex   |
| e-mail: buskulic@lapp.in2p3.fr  | FRANCE                          |
=====================================================================
mailto:buskulic@lapp.in2p3.fr

On Mon, 7 Feb 2000, Patois Yannick wrote:

> Hi, 
> 
> I just viewed the guidelines and the most important thing seems to
> be missing : Which format are you expecting to use ?
> 
> Maybe the first thing could be a look around for existing solution (unix
> man page format, latex, sgml, html, linux HOWTO and LDP (Linux
> Documentation Project).
> 
> I wouldnt be too warm for a pure HTML version. Not easy to print and
> uneasy to maintain.
> 
> If I could make a suggestion, I would vote for LaTex. A team could
> provide Template for redactors of the chapters, including the needed
> code and conventions for easy LateX2HTML translation and linking to the 
> ROOT class definitions, as well as a nice printout capability.
> 
> 	Yannick
> 
>  _/ Yannick Patois _________________ Address (home) __________________
> | irc(undernet): Garp on #france25+ | La Villa des Sciences            |
> | email : patois@ganil.fr           | 12, avenue de Cambridge          |
> | web :http://www.sura.org/~patois/ | 14200 Herouville-Saint-Clair     |
> | Tel/Fax-home:+33 (0)2 31 94 50 32 | FRANCE                           |
> |___________________________________|__________________________________|
> 
> 
> On Mon, 7 Feb 2000, Damir Buskulic wrote:
> 
> > Sorry if you received this twice
> > 
> > Hi Everybody,
> > 
> > As I was designed volunteer for coordinating a collaborative effort to
> > produce a User's Guide of ROOT at the last ROOT2000 workshop, I made two
> > small documents describing :
> > 
> > - a first shot of what could be a Table of Contents
> >      http://wwwlapp.in2p3.fr/virgo/vega/ROOT_Manual_outlook.html
> > - my view of the guidelines and principles for writing a chapter
> >      http://wwwlapp.in2p3.fr/virgo/vega/ROOT_Manual_whatFor.html
> > 
> > Clearly, this needs to be discussed. I propose that people intending to
> > collaborate and write a chapter (or two...) contact me. When enough
> > people will have volunteered, we will decide of the way to go on,
> > technically. But everybody is welcome to make comments !
> > Please, if you feel concerned, do make an effort. Each chapter at the
> > beginning could be no longer than 20-30 pages. If we do it 10 of us,
> > this will make a quite reasonnable User's Guide and will hopefully not
> > take too much time, while being extremely useful.
> > On the other hand, each person will be responsible for the maintenance
> > of his work, but again, this will not (I hope) mean a very big effort.
> > I hope that in two or three months, we will have something reasonable.
> > 
> > Cheers
> > 
> > Damir
> > -- 
> > =====================================================================
> > | Damir Buskulic                  | Universite de Savoie/LAPP       |
> > |                                 | Chemin de Bellevue, B.P. 110    |
> > | Tel : +33 (0)450091600          | F-74941 Annecy-le-Vieux Cedex   |
> > | e-mail: buskulic@lapp.in2p3.fr  | FRANCE                          |
> > =====================================================================
> > mailto:buskulic@lapp.in2p3.fr
> > 
> 
> 
> 



This archive was generated by hypermail 2b29 : Tue Jan 02 2001 - 11:50:18 MET