Re: resend update to sgml documentation

[Vincent Béron]

Le ven 08/11/2002 à 23:27, Tony Lambregts a écrit :
> -
> -
>      <listItem><para>
> -
>      run make_winehq

I think the proper way would be to call make doc or make allseparate
(with my patch applied).
make_winehq is more of a hack to generate html with another dsl file,
more suitable for HTML files to be put on www.winehq.org or another
webserver. For end-user documentation, make {doc, allseparate} is the
way to go.

Actually, the advantage of make_winehq is to be able to cvs co
wine/documentation only, and still be able to build the doc. So you
could reflect that in the doc.

Vincent

resend update to sgml documentation

[Tony Lambregts]

Vincent Béron wrote:
> Le ven 08/11/2002 à 23:27, Tony Lambregts a écrit :
> > -
> > -
> >      <listItem><para>
> > -
> >      run make_winehq
>
> I think the proper way would be to call make doc or make allseparate
> (with my patch applied).
> make_winehq is more of a hack to generate html with another dsl file,
> more suitable for HTML files to be put on www.winehq.org or another
> webserver. For end-user documentation, make {doc, allseparate} is the
> way to go.

What would be the syntax then if I wanted to only build  the user guide PS
"make (wine-user, ps)" or   have I missed you it completely?
> Actually, the advantage of make_winehq is to be able to cvs co
> wine/documentation only, and still be able to build the doc. So you
> could reflect that in the doc.

I must be thick... I have no idea what you are trying to say here.

resend update to sgml documentation

[Vincent Béron]

Le dim 10/11/2002 à 17:35, Tony Lambregts a écrit :
> Vincent Béron wrote:
> > Le ven 08/11/2002 à 23:27, Tony Lambregts a écrit :
> > > -
> > > -
> > >      <listItem><para>
> > > -
> > >      run make_winehq
> >
> > I think the proper way would be to call make doc or make allseparate
> > (with my patch applied).
> > make_winehq is more of a hack to generate html with another dsl file,
> > more suitable for HTML files to be put on www.winehq.org or another
> > webserver. For end-user documentation, make {doc, allseparate} is the
> > way to go.
>
> What would be the syntax then if I wanted to only build  the user guide PS
> "make (wine-user, ps)" or   have I missed you it completely?

make wine-user.ps

If you want the 4 separate pdf, it would be
make allseparatepdf

If you want all the separate ps, pdf and html, it would be
make allseparate

I must say that the actual target name (for multiple builds) are not
very good. Somebody has some ideas?
> > Actually, the advantage of make_winehq is to be able to cvs co
> > wine/documentation only, and still be able to build the doc. So you
> > could reflect that in the doc.
>
> I must be thick... I have no idea what you are trying to say here.

As stated in the comments at the beginning of make_winehq, you can do
cvs co wine/documentation (checkout only the documentation from CVS)
cd wine/documentation
make_winehq

and the docs will be built. You'll have the 4 separate guides plus
wine-doc in html, ps and pdf format (wine-doc only in html), plus
another set of HTML files which use some server-side includes. And
you'll get some tarballs of all that, including the sgml source.

Does it make sense now?

Vincent

resend update to sgml documentation

[Tony Lambregts]

Vincent Béron wrote:
> Le dim 10/11/2002 à 17:35, Tony Lambregts a écrit :
> > Vincent Béron wrote:
> > > Le ven 08/11/2002 à 23:27, Tony Lambregts a écrit :
> > > > -
> > > > -
> > > >      <listItem><para>
> > > > -
> > > >      run make_winehq
> > >
> > > I think the proper way would be to call make doc or make allseparate
> > > (with my patch applied).
> > > make_winehq is more of a hack to generate html with another dsl file,
> > > more suitable for HTML files to be put on www.winehq.org or another
> > > webserver. For end-user documentation, make {doc, allseparate} is the
> > > way to go.
> >
> > What would be the syntax then if I wanted to only build  the user guide PS
> > "make (wine-user, ps)" or   have I missed you it completely?
>
> make wine-user.ps
>
> If you want the 4 separate pdf, it would be
> make allseparatepdf
>
> If you want all the separate ps, pdf and html, it would be
> make allseparate

Ok there are four guides

wine-user
wine-devel
winelib-user
wine-pkg

and three formats (extentions)

.html
.pdf
.ps

So with your patch applied I can build any of the guides in any format I choose by picking the guide and the format extention. However none of these combinations build wine-doc.html

ie "make wine-user.html" builds just the wine users guide in html

you can also create the man page wint the command

make wine.man
> I must say that the actual target name (for multiple builds) are not
> very good. Somebody has some ideas?

What would be wrong with the following targets

everything    All the guides in all the formats + wine-doc.html and the 
man page
allguides     All the guides in all formats + wine-doc.html
allhtml       All the guides in html + wine-doc.html
allpdf        All the guides in pdf
allps         All the guides in ps
> > > Actually, the advantage of make_winehq is to be able to cvs co
> > > wine/documentation only, and still be able to build the doc. So you
> > > could reflect that in the doc.
> >
> > I must be thick... I have no idea what you are trying to say here.
>
> As stated in the comments at the beginning of make_winehq, you can do
> cvs co wine/documentation (checkout only the documentation from CVS)
> cd wine/documentation
> make_winehq
>
> and the docs will be built. You'll have the 4 separate guides plus
> wine-doc in html, ps and pdf format (wine-doc only in html), plus
> another set of HTML files which use some server-side includes. And
> you'll get some tarballs of all that, including the sgml source.
>
> Does it make sense now?

Doh!...   I am Thick!

Is it OK with you to put that in the documentation? or is that (TM.)

resend update to sgml documentation

[Vincent Béron]

Le dim 10/11/2002 à 19:49, Tony Lambregts a écrit :
> Ok there are four guides
>
> wine-user
> wine-devel
> winelib-user
> wine-pkg
>
> and three formats (extentions)
>
> .html
> .pdf
> .ps
>
> So with your patch applied I can build any of the guides in any format I choose by picking the guide and the format extention. However none of these combinations build wine-doc.html

Correct.
> ie "make wine-user.html" builds just the wine users guide in html

Correct. It's actually "make wine-user/index.html", but the point is
correct.
> you can also create the man page wint the command
>
> make wine.man

"make" alone will suffice. wine.man is a dependancy of all, so it'll be
built.
> > I must say that the actual target name (for multiple builds) are not
> > very good. Somebody has some ideas?
>
> What would be wrong with the following targets
>
> everything    All the guides in all the formats + wine-doc.html and the 
> man page

Why only wine-doc.html? Why not wine-doc.pdf and wine-doc.ps?
> allguides     All the guides in all formats + wine-doc.html

Again, why only wine-doc.html?
> allhtml       All the guides in html + wine-doc.html
> allpdf        All the guides in pdf
> allps         All the guides in ps

I ask the question again, why not wine-doc.pdf and wine-doc.ps? I don't
see a reason for not building those, but I may have missed something.

Seems good to me (with the inclusion of wine-doc.pdf and .ps), with the
exception that I'd keep the "separate" targets, so that you can build
either the 4 separate guides (in whatever format you prefer), or the
whole thing in one document. Else, with everything or allguides, you get
twice each information, once in wine-doc and the other in the specific
guide. It's valid for winehq.org, but not for packaging.

I'll rename the "separate" targets: wine-user, wine-devel, winelib-user,
wine-pkg. Each will build the 3 formats of the specified guide.

Recap of make targets:

doc: wine-doc.{html,pdf,ps}
guides: 4 guides in HTML, PDF, PS
(I keep those three because they're more important than the other
individual targets)
html: wine-doc.html
pdf: wine-doc.pdf
ps: wine-dos.ps

wine-user: wine-user.{html,pdf,ps}
wine-devel: wine-devel.{html,pdf,ps}
winelib-user: wine-devel.{html,pdf,ps}
wine-pkg: wine-pkg.{html,pdf,ps}
allhtml: 4 guides in HTML + wine-doc.html
allpdf: 4 guides in PDF + wine-doc.pdf
allps: 4 guides in PS + wine-doc.ps
alldoc: allhtml + allpdf + allps
everything: alldoc + man

How's that?
There's a lot of targets, I know. Too much, or is it still bearable?
> > As stated in the comments at the beginning of make_winehq, you can do
> > cvs co wine/documentation (checkout only the documentation from CVS)
> > cd wine/documentation
> > make_winehq
> >
> > and the docs will be built. You'll have the 4 separate guides plus
> > wine-doc in html, ps and pdf format (wine-doc only in html), plus
> > another set of HTML files which use some server-side includes. And
> > you'll get some tarballs of all that, including the sgml source.
> >
> > Does it make sense now?
>
> Doh!...   I am Thick!

No problem, it's clearer for everybody now.
> Is it OK with you to put that in the documentation? or is that (TM.)

Of course you can put it in the documentation.

As a sidenote, I've almost finished doing a faq.dsl, so you'll be able
to start the conversion of what Dimitrie, Keith and Thomas did pretty
soon.

Vincent

resend update to sgml documentation

[Tony Lambregts]

Vincent Béron wrote:
> Le dim 10/11/2002 à 19:49, Tony Lambregts a écrit :
> > Ok there are four guides
> >
> > wine-user
> > wine-devel
> > winelib-user
> > wine-pkg
> >
> > and three formats (extentions)
> >
> > .html
> > .pdf
> > .ps
> >
> > So with your patch applied I can build any of the guides in any format I choose by picking the guide and the format extention. However none of these combinations build wine-doc.html
>
> Correct.
> > ie "make wine-user.html" builds just the wine users guide in html
>
> Correct. It's actually "make wine-user/index.html", but the point is
> correct.

[snip]

So if I understand you correctly there is no way to build just the User Guide html

I can build all the html

make allhtml  --> All the guides in html + wine-doc.html

or user guide in all formats

make wine-user --> User guide in html, pdf and ps

I am sad about that. Could you explain why "make wine-user.html" has to make only the index and not the rest. or am I just being thick?

resend update to sgml documentation

[Vincent Béron]

Le dim 10/11/2002 à 21:00, Tony Lambregts a écrit :
> So if I understand you correctly there is no way to build just the User Guide html

Yes it's possible. make wine-user/index.html. It's not a "named" target,
it's just the name of the file.
> I can build all the html
>
> make allhtml  --> All the guides in html + wine-doc.html
>
> or user guide in all formats
>
> make wine-user --> User guide in html, pdf and ps
>
> I am sad about that. Could you explain why "make wine-user.html" has to make only the index and not the rest. or am I just being thick?

Of course it creates all the needed files in the directory. But the one
which "make" will check to see if it needs to be rebuilt is index.html
(along with all the source files needed for that target).

So you can build any of the 15 files (let's say the html are only one
file for the sake of the argument) independantly by specifying their
name. Or, there are a couple shorthands if you want to build more than
one.

Vincent

resend update to sgml documentation

[Dustin Navea]

--- Vincent B�ron  wrote:
> Le dim 10/11/2002 � 19:49, Tony Lambregts a �crit :

[-snip-]
> > > I must say that the actual target name (for multiple builds) are not
> > > very good. Somebody has some ideas?
> >
> > What would be wrong with the following targets
> >
> > everything    All the guides in all the formats + wine-doc.html and the 
> > man page
>
> Why only wine-doc.html? Why not wine-doc.pdf and wine-doc.ps?
> > allguides     All the guides in all formats + wine-doc.html
>
> Again, why only wine-doc.html?
> > allhtml       All the guides in html + wine-doc.html
> > allpdf        All the guides in pdf
> > allps         All the guides in ps
>
> I ask the question again, why not wine-doc.pdf and wine-doc.ps? I don't
> see a reason for not building those, but I may have missed something.
>
> Seems good to me (with the inclusion of wine-doc.pdf and .ps), with the
> exception that I'd keep the "separate" targets, so that you can build
> either the 4 separate guides (in whatever format you prefer), or the
> whole thing in one document. Else, with everything or allguides, you get
> twice each information, once in wine-doc and the other in the specific
> guide. It's valid for winehq.org, but not for packaging.
>
> I'll rename the "separate" targets: wine-user, wine-devel, winelib-user,
> wine-pkg. Each will build the 3 formats of the specified guide.
>
> Recap of make targets:
>
> doc: wine-doc.{html,pdf,ps}
> guides: 4 guides in HTML, PDF, PS
> (I keep those three because they're more important than the other
> individual targets)
> html: wine-doc.html
> pdf: wine-doc.pdf
> ps: wine-dos.ps
>
> wine-user: wine-user.{html,pdf,ps}
> wine-devel: wine-devel.{html,pdf,ps}
> winelib-user: wine-devel.{html,pdf,ps}
> wine-pkg: wine-pkg.{html,pdf,ps}
> allhtml: 4 guides in HTML + wine-doc.html
> allpdf: 4 guides in PDF + wine-doc.pdf
> allps: 4 guides in PS + wine-doc.ps
> alldoc: allhtml + allpdf + allps
> everything: alldoc + man
>
> How's that?
> There's a lot of targets, I know. Too much, or is it still bearable?

[-snip-]

It's missing one thing, the ability to make the 4 guides in 1 format (i.e.
"make guides.html" to make ONLY html format of the guides w/out the
wine-doc.html).  Should be 3 additional targets, 1 for each of html, ps, and
pdf, tacked onto the end of guides target.

-Dustin

__________________________________________________
Do you Yahoo!?
U2 on LAUNCH - Exclusive greatest hits videos
http://launch.yahoo.com/u2