You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by Ted Leung <tw...@sauria.com> on 2002/11/26 01:26:46 UTC

Getting off of Stylebook

Belated congratulations to the Forrest team on converting the front page of xml.apache.org to use Forrest!

I would love to see some other projects move from Stylebook to Forrest.  One thing that would really help those of us in the other projects would be a set of stylesheets that we could use to convert our stylebook documentation into Forrest documentation.  Is there a plan to do something like that?

Thanks,

Ted

Stylebook goodness (Re: Getting off of Stylebook)

Posted by Jeff Turner <je...@apache.org>.
On Mon, Nov 25, 2002 at 04:26:46PM -0800, Ted Leung wrote:
...
> I would love to see some other projects move from Stylebook to Forrest.
> One thing that would really help those of us in the other projects
> would be a set of stylesheets that we could use to convert our
> stylebook documentation into Forrest documentation.  Is there a plan to
> do something like that?

It looks like Stylebook has some nice features that Forrest lacks:

1) The 'book.xml' can be specified, allowing various sites to be
generated from a single set of sources.  Eg, xalan-jlocal.xml and
xalan-jsite.xml generate slightly different sites, one for local use, one
for the website.

2) From Xalan's xdocs/sources/xalan-jlocal.xml:

<book title="Xalan XSL Transformer User's Guide" copyright="2002 The Apache Software Foundation">
  <resources source="sbk:/sources/xalan/resources.xml"/>
  ...
</book>

And then xalan/resources.xml contains links to 'resources':

<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE resources [
  <!ENTITY % externalEntity SYSTEM "../entities.ent">
  %externalEntity;
  ...
  ]>

<resources>
  <resource id="xslt4j-current" 
    title="&xslt4j-current;" 
    location="http://xml.apache.org/xalan-j"/>
  <resource id="ApacheLicense" 
            title="The Apache Software License, Version 1.1" 
            location="http://xml.apache.org/dist/LICENSE.txt"/>
  <resource id="bugzilla"
            title="Bugzilla (the Apache bug database)"
            location="http://nagoya.apache.org/bugzilla"/>
  ...

  <human-resource id="sboag"
    name="Scott Boag"
    mailto="scott_boag@us.ibm.com"/>
  ...
</resources>


Then XML files can have stuff like:

All known &xslt4j; bugs are listed in <resource-ref idref="bugzilla"/>.

That expands to:

All known Xalan-Java bugs are listed in <a
href="http://nagoya.apache.org/bugzilla">Bugzilla (the Apache bug
database)</a>.


Pretty neat :)  Seems like Forrest has some way to go before equalling
Stylesbook functionality.


--Jeff

> Thanks,
> 
> Ted

Re: Cocoon Update: better error reporting and chain metamodule

Posted by Nicola Ken Barozzi <ni...@apache.org>.

Peter Donald wrote:
> On Tue, 26 Nov 2002 19:34, Nicola Ken Barozzi wrote:
> 
>>On http://www.krysalis.org/centipede/beta3/  you can see a modified
>>version of the forrest skin, with smaller fonts and lateral page
>>navigation embedded in the navbar. It also uses CSS to show images
>>(except the spacer gif, haven't got to that yet), and png with alpha
>>blending to round the corners (subtracting corners so the colors can be
>>more easily changed). It also uses some CSS where before there were font
>>tags.
> 
> 
> looks heaps better except for the footer that looks like attached image.
> 
> ------------------------------------------------------------------------
> 

Try setting the width of the central td to 90%, and see if it gets better.
I don't have Konqueror and cannot try it; In Netscape 4.7, Mozilla 1.1 
and IE 6 it doesn't show that issue.

Thanks.

-- 
Nicola Ken Barozzi                   nicolaken@apache.org
             - verba volant, scripta manent -
    (discussions get forgotten, just code remains)
---------------------------------------------------------------------


Re: Cocoon Update: better error reporting and chain metamodule

Posted by Peter Donald <pe...@apache.org>.
On Tue, 26 Nov 2002 19:34, Nicola Ken Barozzi wrote:
> On http://www.krysalis.org/centipede/beta3/  you can see a modified
> version of the forrest skin, with smaller fonts and lateral page
> navigation embedded in the navbar. It also uses CSS to show images
> (except the spacer gif, haven't got to that yet), and png with alpha
> blending to round the corners (subtracting corners so the colors can be
> more easily changed). It also uses some CSS where before there were font
> tags.

looks heaps better except for the footer that looks like attached image.

-- 
Cheers,

Peter Donald
"Artists can color the sky red because they know it's blue.  Those of us who
 aren't artists must color things the way they really are or people might 
 think we're stupid." -- Jules Feiffer 


Re: Getting off of Stylebook

Posted by Nicola Ken Barozzi <ni...@apache.org>.
Jeff Turner wrote:
> On Mon, Dec 02, 2002 at 02:43:15PM -0800, Ted Leung wrote:
> [snip <link idref="..."> errors]
> 
>>>>It looks to me like the forrest dtd's don't support some referencing
>>>>features that Stylebook has.
>>>
>>>Yes :/  Forrest is quite far behind Stylebook.  Link idrefs would have to
>>>be converted to page refs with #anchors.
>>
>>Is this something that will be added?
> 
> Eventually, but I don't know how.  This "link to another node" problem is
> related to our Problem #1, linking to externally generated stuff like
> Javadocs.  Ideally, the solution should be general enough to solve both
> probs.

I agree, it will be addressed. Suggestions on how to do it are highly 
welcome; Jeff, would you mind relinking us to the past proposals on this 
subject?

>>>>Also, does Forrest have doctypes corresponding to Xerces' releases.dtd,
>>>>settings.dtd and book.dtd?
>>>
>>>Forrest has a book DTD, slightly less fancy than the Stylebook one.
>>
>>Again the issue seems to be links
>>
>>
>>>status.xml is quite similar to releases.xml, but we don't have a DTD for
>>>it.  status.xml gets rendered to
>>>http://xml.apache.org/forrest/changes.html
>>
>>It looks like there's a DTD for changes -- could we add an optional
>>description element as a child of a release element?  That way you can
>>have release specific notes before the list of all the actions, so
>>people don't have to go looking at all the little changes.
> 
> Sounds good. How would this relate to real release notes?
> 
> Forrest currently does not have a DTD for status.xml, and is privately
> (not pushed on users) experimenting with using status.xml to record
> 'issues', to better emulate a traditional Apache STATUS file.

And eventually make a text-version of it, since many users find the xml 
not so cool to hand-edit (I agree).

>>>settings.dtd looks quite Xerces-specific, but adding project-specific DTDs
>>
>>+
>>
>>>stylesheets is fairly easy in Forrest.
>>
>>Can you point me to the right documentation to read for how to do this?
> 
> 
> The "Adding new content type" section of "Using Forrest":
> 
> http://xml.apache.org/forrest/your-project.html#N10189
> 
> I also posted a ready-to-run example of a project using a custom doc type
> and stylesheet:
> 
> http://marc.theaimsgroup.com/?l=forrest-dev&m=103786870103314&w=2

-- 
Nicola Ken Barozzi                   nicolaken@apache.org
             - verba volant, scripta manent -
    (discussions get forgotten, just code remains)
---------------------------------------------------------------------


Re: Getting off of Stylebook

Posted by Jeff Turner <je...@apache.org>.
On Mon, Dec 02, 2002 at 02:43:15PM -0800, Ted Leung wrote:
[snip <link idref="..."> errors]
> > > It looks to me like the forrest dtd's don't support some referencing
> > > features that Stylebook has.
> >
> > Yes :/  Forrest is quite far behind Stylebook.  Link idrefs would have to
> > be converted to page refs with #anchors.
> 
> Is this something that will be added?

Eventually, but I don't know how.  This "link to another node" problem is
related to our Problem #1, linking to externally generated stuff like
Javadocs.  Ideally, the solution should be general enough to solve both
probs.

> > > Also, does Forrest have doctypes corresponding to Xerces' releases.dtd,
> > > settings.dtd and book.dtd?
> >
> > Forrest has a book DTD, slightly less fancy than the Stylebook one.
> 
> Again the issue seems to be links
> 
> > status.xml is quite similar to releases.xml, but we don't have a DTD for
> > it.  status.xml gets rendered to
> > http://xml.apache.org/forrest/changes.html
> 
> It looks like there's a DTD for changes -- could we add an optional
> description element as a child of a release element?  That way you can
> have release specific notes before the list of all the actions, so
> people don't have to go looking at all the little changes.

Sounds good. How would this relate to real release notes?

Forrest currently does not have a DTD for status.xml, and is privately
(not pushed on users) experimenting with using status.xml to record
'issues', to better emulate a traditional Apache STATUS file.

> > settings.dtd looks quite Xerces-specific, but adding project-specific DTDs
> +
> > stylesheets is fairly easy in Forrest.
> 
> Can you point me to the right documentation to read for how to do this?

The "Adding new content type" section of "Using Forrest":

http://xml.apache.org/forrest/your-project.html#N10189

I also posted a ready-to-run example of a project using a custom doc type
and stylesheet:

http://marc.theaimsgroup.com/?l=forrest-dev&m=103786870103314&w=2


--Jeff

Re: Getting off of Stylebook

Posted by Ted Leung <tw...@sauria.com>.
----- Original Message -----
From: "Jeff Turner" <je...@apache.org>
To: <fo...@xml.apache.org>
Sent: Tuesday, November 26, 2002 5:13 PM
Subject: Re: Getting off of Stylebook


> On Tue, Nov 26, 2002 at 04:30:29PM -0800, Ted Leung wrote:
> > If I try converting:
> >
> > xml-xerces/java/docs/readme.xml
> >
> > I get XSL errors that look like this:
> >
> > file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has
no
> > idref attribute defined in the document-v11.dtd, please fix your
document.
> > file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has
no
> > idref attribute defined in the document-v11.dtd, please fix your
document.
> > file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has
no
> > idref attribute defined in the document-v11.dtd, please fix your
document.
> > file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has
no
> > idref attribute defined in the document-v11.dtd, please fix your
document.
> > file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has
no
> > idref attribute defined in the document-v11.dtd, please fix your
document.
> >
> > It looks to me like the forrest dtd's don't support some referencing
> > features that Stylebook has.
>
> Yes :/  Forrest is quite far behind Stylebook.  Link idrefs would have to
> be converted to page refs with #anchors.

Is this something that will be added?

> > Also, does Forrest have doctypes corresponding to Xerces' releases.dtd,
> > settings.dtd and book.dtd?
>
> Forrest has a book DTD, slightly less fancy than the Stylebook one.

Again the issue seems to be links

> status.xml is quite similar to releases.xml, but we don't have a DTD for
> it.  status.xml gets rendered to
> http://xml.apache.org/forrest/changes.html

It looks like there's a DTD for changes -- could we add an optional
description element as
a child of a release element?  That way you can have release specific notes
before the list of
all the actions, so people don't have to go looking at all the little
changes.

>
> settings.dtd looks quite Xerces-specific, but adding project-specific DTDs
+
> stylesheets is fairly easy in Forrest.

Can you point me to the right documentation to read for how to do this?

>
> --Jeff
>
> >
> > Ted
> > ----- Original Message -----
> > From: "Nicola Ken Barozzi" <ni...@apache.org>
> > To: <fo...@xml.apache.org>
> > Sent: Monday, November 25, 2002 11:25 PM
> > Subject: Re: Getting off of Stylebook
>



Re: Getting off of Stylebook

Posted by Jeff Turner <je...@apache.org>.
On Tue, Nov 26, 2002 at 04:30:29PM -0800, Ted Leung wrote:
> If I try converting:
> 
> xml-xerces/java/docs/readme.xml
> 
> I get XSL errors that look like this:
> 
> file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
> idref attribute defined in the document-v11.dtd, please fix your document.
> file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
> idref attribute defined in the document-v11.dtd, please fix your document.
> file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
> idref attribute defined in the document-v11.dtd, please fix your document.
> file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
> idref attribute defined in the document-v11.dtd, please fix your document.
> file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
> idref attribute defined in the document-v11.dtd, please fix your document.
> 
> It looks to me like the forrest dtd's don't support some referencing
> features that Stylebook has.

Yes :/  Forrest is quite far behind Stylebook.  Link idrefs would have to
be converted to page refs with #anchors. 

> Also, does Forrest have doctypes corresponding to Xerces' releases.dtd,
> settings.dtd and book.dtd?

Forrest has a book DTD, slightly less fancy than the Stylebook one.

status.xml is quite similar to releases.xml, but we don't have a DTD for
it.  status.xml gets rendered to
http://xml.apache.org/forrest/changes.html

settings.dtd looks quite Xerces-specific, but adding project-specific DTDs +
stylesheets is fairly easy in Forrest.


--Jeff

> 
> Ted
> ----- Original Message -----
> From: "Nicola Ken Barozzi" <ni...@apache.org>
> To: <fo...@xml.apache.org>
> Sent: Monday, November 25, 2002 11:25 PM
> Subject: Re: Getting off of Stylebook

Re: Getting off of Stylebook

Posted by Ted Leung <tw...@sauria.com>.
If I try converting:

xml-xerces/java/docs/readme.xml

I get XSL errors that look like this:

file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
idref attribute defined in the document-v11.dtd, please fix your document.
file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
idref attribute defined in the document-v11.dtd, please fix your document.
file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
idref attribute defined in the document-v11.dtd, please fix your document.
file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
idref attribute defined in the document-v11.dtd, please fix your document.
file:///tmp/docv10todocv11.xsl; Line 81; Column 33; The link element has no
idref attribute defined in the document-v11.dtd, please fix your document.

It looks to me like the forrest dtd's don't support some referencing
features that Stylebook has.

Also, does Forrest have doctypes corresponding to Xerces' releases.dtd,
settings.dtd and book.dtd?

Ted
----- Original Message -----
From: "Nicola Ken Barozzi" <ni...@apache.org>
To: <fo...@xml.apache.org>
Sent: Monday, November 25, 2002 11:25 PM
Subject: Re: Getting off of Stylebook


>
>
> Peter Donald wrote:
> > On Tue, 26 Nov 2002 11:26, Ted Leung wrote:
> >
> >>Belated congratulations to the Forrest team on converting the front page
of
> >>xml.apache.org to use Forrest!
> >>
> >>I would love to see some other projects move from Stylebook to Forrest.
> >>One thing that would really help those of us in the other projects would
be
> >>a set of stylesheets that we could use to convert our stylebook
> >>documentation into Forrest documentation.  Is there a plan to do
something
> >>like that?
> >
> >
> > Have a look at;
> >
> > ./src/resources/library/xslt/docv10todocv11.xsl
> > ./src/resources/library/xslt/changesv10tochangesv11.xsl
> > ./src/resources/library/xslt/faqv10tofaqv11.xsl
> >
> > I had a few problems with them and you may need to tweak the output
slightly
> > (sorry - I can't remember the changes I made) but they are a great
start.
> >
>
> Yes, Peter is right.
> Send us the changes you have made and/or post here pages that didn't
> convert quite right, and we'll enhance the stylesheets.
>
> --
> Nicola Ken Barozzi                   nicolaken@apache.org
>              - verba volant, scripta manent -
>     (discussions get forgotten, just code remains)
> ---------------------------------------------------------------------
>



Re: Cocoon Update: better error reporting and chain metamodule

Posted by Nick Chalko <ni...@chalko.com>.
Nicola Ken Barozzi wrote:

>
>
> {Another feature that has been asked: automatic skin download. 
> Indicate a url in the skin settings, and have it downloaded and 
> installed}
>
Yes.

Ruper is a good canidate for this.
Ruper already handles download and un jar.

R,
Nick


RE: Cocoon Update: better error reporting and chain metamodule

Posted by Robert Koberg <ro...@koberg.com>.
Hi Ken,

> -----Original Message-----
> From: Nicola Ken Barozzi [mailto:nicolaken@apache.org]
> Sent: Tuesday, November 26, 2002 4:38 PM

> {Another feature that has been asked: automatic skin download. Indicate
> a url in the skin settings, and have it downloaded and installed}
>

I would recommend creating several 'primary' XSLTs that have different
structures (L&Fs). These xsl:include/import 'common' XSL(T)s. The primaries are
relatively small, just setting up the structure of the page for things like a
table-based layout versus a pure CSS layout, or 1, 2, 3 or 4 column layouts.
Everything else should be able to be 'common' or 'util.'

Just ship all of the primaries with forrest and the user can choose (perhaps by
renaming the primary to the forrest default?)

make sense?

best,
-Rob



Re: Cocoon Update: better error reporting and chain metamodule

Posted by Nicola Ken Barozzi <ni...@apache.org>.

Jeff Turner wrote:
> On Tue, Nov 26, 2002 at 09:34:26AM +0100, Nicola Ken Barozzi wrote:
> 
>>I've updated the Cocoon stuff because I've patched it yesterday due to 
>>the complaints about the CLI not reporting errors: now it should.
> 
> Great!  This also fixes the sitemap reload bug and the PDF bug.
> 
>>With it we seem to get the chain metamodule free, so I've made the 
>>sitemap use it and named it "forrest".
>>
>>Please test and report any problem.
>>
>>PS:
>>
>>On http://www.krysalis.org/centipede/beta3/  you can see a modified 
>>version of the forrest skin, with smaller fonts and lateral page 
>>navigation embedded in the navbar. It also uses CSS to show images 
>>(except the spacer gif, haven't got to that yet), and png with alpha 
>>blending to round the corners (subtracting corners so the colors can be 
>>more easily changed). It also uses some CSS where before there were font 
>>tags.
>>
>>IMHO it wouldn't be bad to backport most of the changes to the forrest 
>>skin , but maybe it's better to put these in the new CSS-only skin.
> 
> 
> The rounded corners are lost in ns4.7 with the new CSS..

Yup, but the site still looks better than with the CSS version.

> I don't know if the benefits of further CSS'ifying forrest-site outweigh
> the risks.  *shrug* up to you..

I'm just trying to make the krysalis-site skin not use <img>s for 
rounded corners and spacers to make it play well in linksWimages, that's 
all. First part is done, now the spacers...

> I hope to skinify Miles' CSS mockup in the next few days.  I had it half
> done in build/webapp, and then forgot I had it there, and... usual story
> :P

hehehe, it happened to me today with the changes I was making to the 
sitemap to create pngs and jpegs out of svgs if they are present as 
such... it means I'm not alone ;-)

Anyway, seeing that you are already working on the CSS version, probably 
it's best not to touch the Forrest skin and simply replace it with the 
new one. I'll keep it with current changes as the krysalis-site skin if 
anyone wants it (not in Forrest CVS I think).

{Another feature that has been asked: automatic skin download. Indicate 
a url in the skin settings, and have it downloaded and installed}

-- 
Nicola Ken Barozzi                   nicolaken@apache.org
             - verba volant, scripta manent -
    (discussions get forgotten, just code remains)
---------------------------------------------------------------------


Re: Cocoon Update: better error reporting and chain metamodule

Posted by Jeff Turner <je...@apache.org>.
On Tue, Nov 26, 2002 at 09:34:26AM +0100, Nicola Ken Barozzi wrote:
> 
> I've updated the Cocoon stuff because I've patched it yesterday due to 
> the complaints about the CLI not reporting errors: now it should.

Great!  This also fixes the sitemap reload bug and the PDF bug.

> With it we seem to get the chain metamodule free, so I've made the 
> sitemap use it and named it "forrest".
> 
> Please test and report any problem.
> 
> PS:
> 
> On http://www.krysalis.org/centipede/beta3/  you can see a modified 
> version of the forrest skin, with smaller fonts and lateral page 
> navigation embedded in the navbar. It also uses CSS to show images 
> (except the spacer gif, haven't got to that yet), and png with alpha 
> blending to round the corners (subtracting corners so the colors can be 
> more easily changed). It also uses some CSS where before there were font 
> tags.
> 
> IMHO it wouldn't be bad to backport most of the changes to the forrest 
> skin , but maybe it's better to put these in the new CSS-only skin.

The rounded corners are lost in ns4.7 with the new CSS..

I don't know if the benefits of further CSS'ifying forrest-site outweigh
the risks.  *shrug* up to you..

I hope to skinify Miles' CSS mockup in the next few days.  I had it half
done in build/webapp, and then forgot I had it there, and... usual story
:P


--Jeff

Cocoon Update: better error reporting and chain metamodule

Posted by Nicola Ken Barozzi <ni...@apache.org>.
I've updated the Cocoon stuff because I've patched it yesterday due to 
the complaints about the CLI not reporting errors: now it should.

With it we seem to get the chain metamodule free, so I've made the 
sitemap use it and named it "forrest".

Please test and report any problem.

PS:

On http://www.krysalis.org/centipede/beta3/  you can see a modified 
version of the forrest skin, with smaller fonts and lateral page 
navigation embedded in the navbar. It also uses CSS to show images 
(except the spacer gif, haven't got to that yet), and png with alpha 
blending to round the corners (subtracting corners so the colors can be 
more easily changed). It also uses some CSS where before there were font 
tags.

IMHO it wouldn't be bad to backport most of the changes to the forrest 
skin , but maybe it's better to put these in the new CSS-only skin.

Comments?

-- 
Nicola Ken Barozzi                   nicolaken@apache.org
             - verba volant, scripta manent -
    (discussions get forgotten, just code remains)
---------------------------------------------------------------------


Re: Getting off of Stylebook

Posted by Nicola Ken Barozzi <ni...@apache.org>.

Peter Donald wrote:
> On Tue, 26 Nov 2002 11:26, Ted Leung wrote:
> 
>>Belated congratulations to the Forrest team on converting the front page of
>>xml.apache.org to use Forrest!
>>
>>I would love to see some other projects move from Stylebook to Forrest. 
>>One thing that would really help those of us in the other projects would be
>>a set of stylesheets that we could use to convert our stylebook
>>documentation into Forrest documentation.  Is there a plan to do something
>>like that?
> 
> 
> Have a look at;
> 
> ./src/resources/library/xslt/docv10todocv11.xsl 
> ./src/resources/library/xslt/changesv10tochangesv11.xsl
> ./src/resources/library/xslt/faqv10tofaqv11.xsl
> 
> I had a few problems with them and you may need to tweak the output slightly 
> (sorry - I can't remember the changes I made) but they are a great start.
> 

Yes, Peter is right.
Send us the changes you have made and/or post here pages that didn't 
convert quite right, and we'll enhance the stylesheets.

-- 
Nicola Ken Barozzi                   nicolaken@apache.org
             - verba volant, scripta manent -
    (discussions get forgotten, just code remains)
---------------------------------------------------------------------


Re: Getting off of Stylebook

Posted by Peter Donald <pe...@apache.org>.
On Tue, 26 Nov 2002 11:26, Ted Leung wrote:
> Belated congratulations to the Forrest team on converting the front page of
> xml.apache.org to use Forrest!
>
> I would love to see some other projects move from Stylebook to Forrest. 
> One thing that would really help those of us in the other projects would be
> a set of stylesheets that we could use to convert our stylebook
> documentation into Forrest documentation.  Is there a plan to do something
> like that?

Have a look at;

./src/resources/library/xslt/docv10todocv11.xsl 
./src/resources/library/xslt/changesv10tochangesv11.xsl
./src/resources/library/xslt/faqv10tofaqv11.xsl

I had a few problems with them and you may need to tweak the output slightly 
(sorry - I can't remember the changes I made) but they are a great start.

-- 
Cheers,

Peter Donald
*---------------------------------------------------------*
| Contrary to popular belief, UNIX is user-friendly. It   |
| just happens to be selective on who it makes friendship |
| with.                                                   |
|                       - Richard Cook                    |
*---------------------------------------------------------*