Making documentation - was RE: Docu updates question..

[Tony Lambregts]

Dustin Navea wrote:

>--- Tony Lambregts <tony_lambregts at telusplanet.net> wrote:
>  
>
>>Sylvain Petreolle wrote:
>>
>>    
>>
>>>Like Vincent said, the most convenient form of the doc (I think), fails
>>>when you do :
>>> 
>>>
>>>      
>>>
>>>>2b. make html
>>>>   
>>>>
>>>>        
>>>>
>>>See bug #688 http://bugs.winehq.com/show_bug.cgi?id=688
>>>
>>> 
>>>
>>>      
>>>
>>When I run "./make_winehq" (with the docbook packages installed) it 
>>produces the html files in  wine-doc with meaningfull names  but "make 
>>html" produces xNNNN files (just like bug report) so make_winehq is the 
>>prefered method,  yes? Is it realy a bug then?
>>
>>
>>I think that at the beginning of the document we had a getting started 
>>section.  This section would tell the developer that they needed to 
>>install have jade, tetex, docbook and perl installed in order to create 
>>html, pdf, and ps files from the sgml files. There should be links to 
>>the section on what is required for the various distrbutions and what 
>>command to run (./make_winhq).
>>
>>Right now there is only the section for RedHat . I would be really nice 
>>if we had sections for other distributions as well
>>  
>>The sections on setting up the docbook from section 3.2.1.4 on  needs 
>>work since it contains a lot of sections that are incomplete and to a 
>>large extent it is unclear (to me) what is required.
>>
>>As I pointed out before there is a bug about this 
>>http://bugs.winehq.com/show_bug.cgi?id=727
>>
>>    
>>
>Right, I have it in my TODO
>
>-Dustin
>
>P.S. I will probably end up rewriting a lot of the docs to get them to a
>usable state, but it will take some time.
>Dimi: If you could post on the Wine 0.9 v0.x that a backup docs guy is
>needed, it would be greatly appreciated.
>
>_
>
I am working on this based on what i have learned today. It won' t be 
complete I suppose but it should be better than what we have now. <g> 
Expect a patch soon (tm)

-- 

Tony Lambregts