avalon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Berin Loritsch" <blorit...@apache.org>
Subject RE: Xdocs Standards
Date Thu, 18 Jul 2002 20:25:53 GMT
This is a ref to Forrest's solution:

http://xml.apache.org/forrest/libre-intro.html


> -----Original Message-----
> From: Berin Loritsch [mailto:bloritsch@apache.org] 
> Sent: Thursday, July 18, 2002 4:04 PM
> To: Avalon Developer's List
> Subject: Xdocs Standards
> 
> 
> I think since now we have some issues with Xdocs in Avalon 
> land, we set up the system so that it works for just about everyone.
> 
> To that end, I want to address the issues, and make it so 
> that we are not tied to any one doc generation scheme.  
> Whether we use Cocoon or Anakia shouldn't be the main 
> concern.  We should use a consistent DTD, and make the doc 
> gen system work with our DTD instead of the other way around. 
> The DTD we have now is based on the one we had when we had 
> Stylebook. Cocoon was added when we had the PDF docs--however 
> that can technically be solved in another way.
> 
> The first thing we have to do is decide between Book.xml and 
> Project.xml markup.  Cocoon can work with either--and the 
> book.xml is another holdover from the Stylebook days.  It is 
> rediculous to maintain two files that do the same thing.  
> However, I think that the fact that it is in a directory 
> named "stylesheets" is a misnomer.
> 
> Book.xml looks like this:
> 
> <book software="Excalibur AltRMI"
>       title="Avalon Excalibur Documentation - AltRMI"
>       copyright="@year@ The Apache Software Foundation">
> 
>   <project label="Back to Avalon" href="@AVALON_BASE@" />
>   <project label="Back to Excalibur" href="../index.html" />
> 
>   <menu label="About">
>     <menu-item label="Overview" href="index.html"/>
>   </menu>
> 
>   <menu label="Using">
>     <menu-item label="Facade Design" href="facades.html"/>
>   </menu>
> </book>
> 
> --------------------------------------------------------------
> ----------
> -
> keep in mind I snipped out a bunch of stuff to make it 
> readable in email. Below is the project.xml
> --------------------------------------------------------------
> ----------
> -
> 
> <project 
>   name="Excalibur Bzip2"
>   href="http://jakarta.apache.org/avalon/excalibur/bzip2">
>   
>   <title>Excalibur Bzip2</title>
>   <body>
>     <item href="@AVALON_BASE@" name="Back to Avalon"/>
>     <item href="/../index.html" name="Back to Excalibur"/>
> 
>     <menu name="About">
>       <item name="Overview" href="/index.html"/>
>       <item name="Excalibur Home" 
>  
> href="http://jakarta.apache.org/avalon/excalibur/index.html"/>
>       <item name="Download"
>  
> href="http://jakarta.apache.org/builds/jakarta-avalon-excalibu
> r/release/
> bzip2"/>
>       <item name="API Docs" href="/api/index.html"/>
>     </menu>
>   </body>
> </project>
> 
> --------------------------------------------------------------
> ----------
> -
> 
> Both are functionally equivalent, so it is easy to provide a 
> stylesheet to make the transition.  If Anakia absolutely 
> requires the Project.xml file, then we make the more flexible 
> tool use it.
> 
> Let's get that part settled before we move on.  I am +0 on 
> both of them, I will use whatever everyone else is comfortable with.
> 
> 
> --
> To unsubscribe, e-mail:   
> <mailto:avalon-dev-> unsubscribe@jakarta.apache.org>
> For 
> additional commands, 
> e-mail: <mailto:avalon-dev-help@jakarta.apache.org>
> 


--
To unsubscribe, e-mail:   <mailto:avalon-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-dev-help@jakarta.apache.org>


Mime
View raw message