Re: Possible WM Documentation Project

Peter Dembinski wrote:

>On Tue, Mar 08, 2005 at 03:28:01PM -0500, cga wrote:
>  
>
>>Russ Button wrote:
>>
>>[...]
>>
>>    
>>
>>>One of the things I'd like to see are docs relating to all the weird 
>>>little control files
>>>and such.  
>>>      
>>>
>>Are there any plans to convert these to an xml-based format?
>>    
>>
>
>I didn't make any comparisons, but IMO XML parsers are bigger and slower
>than libproplist.  Moreover, proplists seem to be good enough for storing 
>configuration info.  Why to change the piece of software that does its work
>and does it well?  Because XML is trendy at the moment?
>  
>
So everybody would have to re-learn the format of all those weird little 
control files.. me included.. :-)

What I suggested is that by using a standard non-proprietory 
self-documenting format you might save yourself the trouble of 
documenting..

In other words in this instance instead of telling people to read the 
source you could direct them to the dtd..

The other thing is that some people might already have some familiarity 
with xml-based syntax and this might make it easier for them to learn 
wmaker (?)

As to speed I'm no xml expert by any reckoning.. might slow down 
wmaker's startup by a fraction.. but once the stuff is parsed and 
loaded..?? since fontconfig for instance uses an xml-based dialect in 
its config files I'd be rather surprised if it had such an effect.. I 
didn't notice any additional slowness in font rendering. But as I said I 
am no xml expert.

>>>What the GNUstep directory does and all the various control files
>>>underneath it.   This would really help those trying to integrate WM 
>>>into some
>>>new 'IX variant.  I've only installed it in Redhat 6.x, 7.x, 9.x and 
>>>Fedora Core 2.
>>>A lot of the problem I suppose is that it just isn't stuff with WM, 
>>>but also with
>>>the login manager like GDM or XDM.  
>>>      
>>>
>>Documenting the installation/configuration of XDM/GDM (WDM.. KDM..) is 
>>probably not relevant. Briefly explaining how to integrate wmaker to an 
>>existing graphical login setup definitely is.
>>    
>>
>
>yup, WM integration is the point  
>
>  
>
>>>Still I think that the job isn't done until
>>>the reader finds everything they need instead of having to reinvent 
>>>the wheel.
>>>
>>>I'd also like to see some docs that tell folks how to create themes
>>>and such.  
>>>      
>>>
>>Apparently wmakerconf & WPrefs let you create themes interactively.
>>    
>>
>
>There is plenty of WM themes.  Personally, I use The Default Theme :)
>
Yes.. it is also my favorite..

But are you suggesting that so long as you're not interested in a 
particular feature of wmaker it's not worth documenting?

What I mean is that if you want to document this particular feature you 
probably need to say a few words about creating you own themes with 
these config tools and many more to explain the syntax of the 
*.themed/style files.

And since most everything else in wmaker can be done either 
interactively or by editing config files..

>>>Maybe it's already there and I haven't found it, or what's there is 
>>>minimal
>>>and needs to be integrated into this larger effort.  It would 
>>>certainly help if everything
>>>could be found in one location.
>>>      
>>>
>>How about an interactive tutorial / guided tour?
>>    
>>
>
>It could be a presentation in OOo Impress -- with WM screenshots etc.
>
No. screenshots are mostly redundant.. since the novice is supposed to 
be sitting in front of his screen looking at a live copy of wmaker..? 
what I had in mind was some form of guided tour where the user is 
active.. A bit like vimtutor for vim. Texinfo has something similar.


_______________________________________________
INFO: https://windowmaker.org/lists/listinfo/wm-user
ARCHIVE: https://windowmaker.org/lists/archive/wm-user/
FAQ: http://windowmaker.org/faq.html