<IMO>
It would be nice to have docs where the left navigation is static and 
the right part is dynamic. We can do it with frames or with a table as 
today if we mix in some simple javascript.

 +------+-------------------------+
 | *    | The template mechanism  |
 | +*   |                         |
 | +*   | Bla blablablabl         |
 |  +*  |                         |
 +------+-------------------------+

The frames approach should be well known. Clicking in the tree in the 
left frame changes page in right frame.

The table approach is similar: Clicking in the tree in the left column 
changes content in the right column (using javascript and document.write
() in the right column).

I am not a HTML guru, so I don't know which one is best. It probably 
doesn't make a difference to 95% of the browsers. Therefore, choose 
whichever approach that gives us the most flexibility.

Anyhow, we need two Velocity stylesheets for Anakia: One for the left 
frame/column and one for the right frame/column. This should be a 
matter of splitting up the current site.vsl and invoke Anakia twice.

I also think we should try to keep the "DTD" format of the XML docs 
compatible with jakarta-site2 (You know why I think so ;-)
</IMO>

----- Original Message -----
From: "Mathias Bogaert" <[EMAIL PROTECTED]>
Date: Friday, May 31, 2002 8:09 am
Subject: [Xdoclet-devel] docs and xdocs

> Aslak,
> 
> Could you explain how you think the documentation should be 
> structured? I
> mean, IMO all documentation should reside under one directory 
> (docs) and

A more common convention for XML transformation-based doc systems like 
the one we have now is to put the doc source under xdocs (as today) and 
store the result under some docs folder. The generated docs shouldn't 
be CVS'ed, and should therefore be generated to the xdoclet/dist/docs 
folder in stead of xdoclet/docs. As today. I'm not sure if this is what 
you meant...

> should be context relative (so we can use it as web-app and 
> standalone). The

Agree. But isn't it context relative already? (There is only one link: 
The top one which links to index.html. That's defined in project.xdt). 
think a flat structure for the *.xml files is OK. It makes it easier to 
keep the overview.

> frame for navigation was also nice, no? And what about the layout. 
> I see
> that your xdocs already have a kinda jakarta layout style.

We should get our own layout yes. It looks like jakarta only because I 
stole the site.vsl from jakarta-site2 and left it mostly unchanged, 
except from adding the FxTree stuff. The site.vsl should be edited to 
write HTML that uses CSS, and we should have a separate site.css.

> 
> Regards,
> 
> Mathias
> 
> 
> _______________________________________________________________
> 
> Don't miss the 2002 Sprint PCS Application Developer's Conference
> August 25-28 in Las Vegas -- http://devcon.sprintpcs.co
> 
> _______________________________________________
> Xdoclet-devel mailing list
> [EMAIL PROTECTED]
> https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
> 


_______________________________________________________________

Don't miss the 2002 Sprint PCS Application Developer's Conference
August 25-28 in Las Vegas -- http://devcon.sprintpcs.com/adp/index.cfm

_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel

Reply via email to