[Mono-docs-list] xslt update -- it's getting interesting

Martin Aliger martin_aliger@email.cz
Wed, 30 Oct 2002 08:14:51 +0100 (CET)


> > Overloads on method page looks good - maybe only anchors/links to overloaded method could be added.
> > 
> Well, I do this now.  Check the top of any overloaded function's page
> (constructors are overloaded methods too)
> Click on the method name to jump to that method.
> Did you mean something different?

I mean exactly this. Cool! Maybe that XSLT is not so bad. Maybe I should learn it... ;-)

> > > - There's very little indication of whether a member is static / public
> > > / const etc.  These should be made more visible.
> > 
> > Yes. I already point to it several times, but nobody aims attension to this...
> Point to it?  Where?

There on docs-list. But there was (still are?) other priorities as doc browser and editor...

> > Only one: In the class members page, could you add result type to method signature? Maybe parameters could be
> Yes, I think that would be a big improvement.  I'll add this to the TODO

> I thought it looked fairly confusing with arguments added, but maybe it
> would be OK if the font size was reduced.  It will take some fiddling.

Great. It will be much better to see

void Close()   Closes the current TextReader instance and releases any system resources associated with it.

instead of

Close  Method  Closes the current TextReader instance and releases any system resources associated with it.

> > I like much more that scheme with prop/methods/cons/events/fields split up. Maybe this could be splitted simillary in public/protected view? (two levels split) 
> Or do you mean, first sorted by type, then sorted by access, THEN sorted
> by name?  I can do that without much trouble too, and that does sound
> useful.  I'll add some deeper combinations to the next release.

Yes. I mean this (oh - I know - mine English is not so good as it could be and mine sentences are sometimes weird. I write without any spellchecker or grammarchecker. It was one reason to my interest in docs - I could learn some English style and improve expressing myself)

I do not find that public/protected view useful. You are usually looking for some specific method (either by name or by action) and not by whether it is public or protected. So I suggest, first sort them by type (prop/method/event/field) and than it could be sorted by other keys: static/nonstatic or public/protected or alphabetically. That second key could not be divided by any line or header to save some space...

> Finally, I guess my layout is a bit confusing.  It's not clear, for
> instance, that you go to the summary page by clicking on "TextReader" at
> the top (also by clicking on either the "Public Members" or "Protected
> Members" table titles).  Problem is, I don't want to clutter up the page
> with "To view the summary page, click _here_" messages.  If anyone has
> any ideas on how to make navigation easier, I'd love to hear them.

Understand you, but sometimes it is better. Maybe only add some "toolbar" to the top, where you could add link to the namespace, to the class and to members overview.

Moreover, I maybe could help you and make some style-sheet for generated pages. I have no experience with XSLT but some with CSS2. But I'm not graphic designer in any respect so do not expect much. Is XSLT+CSS common practise? And is it good idea in our case? I hate to do something fruitless


SB KOMPLET®  Informační ekonomický systém http://www.sb-komplet.cz  
…umíme svoji práci!