forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "David Crossley (JIRA)" <j...@apache.org>
Subject [jira] Updated: (FOR-559) FAQ+TOC problem: force-toc option
Date Sat, 24 Dec 2005 02:22:31 GMT
     [ http://issues.apache.org/jira/browse/FOR-559?page=all ]

David Crossley updated FOR-559:
-------------------------------

     Other Info: [Patch available]
    Description: 
This is a hybrid patch/RFE/bugfix. Today, I've taken another stab at the problem Clay Leeds
reported to you in May:
http://www.mail-archive.com/user@forrest.apache.org/msg00528.html

We have the problem in FOP that the TOC for the FAQ page isn't generated.


  was:
This is a hybrid patch/RFE/bugfix. Today, I've taken another stab at the problem Clay Leeds
reported to you in May:
http://www.mail-archive.com/user@forrest.apache.org/msg00528.html

We have the problem in FOP that the TOC for the FAQ page isn't generated. I've found out what
the problem is and have a suggestion for improvement. Essentially, the problem goes away when
I change the skinconf.xml from:

  <toc max-depth="2" min-sections="3" location="page"/>

to:

  <toc max-depth="2" min-sections="1" location="page"/>

The reason for the whole problem is actually totally simple. The faq2document.xsl stylesheet
creates exactly one top-level section. Due to the various checks in the stylesheet the TOC
is suppressed when min-sections is set to anything higher than 1. That's the work-around I'm
currently working with in FOP, but I think this can be improved. Setting min-sections to 3
or 4 is a very nice feature, but sometimes (like in the FAQ example), this is not ideal, so
I implemented a forcing mechanism, I will attach as a patch. Using the meta tag in the document
header is probably not the best idea but this let me add this feature without the need for
a change in the DTD. I'll leave it up to you guys, what to do with this. It's just a suggestion
and I've only patched the pelt skin so far. If this is nuts, just close the bug. :-) Thanks!


(Moved detail from Description to Comment.)

I've found out what the problem is and have a suggestion for improvement. Essentially, the
problem goes away when I change the skinconf.xml from:

  <toc max-depth="2" min-sections="3" location="page"/>

to:

  <toc max-depth="2" min-sections="1" location="page"/>

The reason for the whole problem is actually totally simple. The faq2document.xsl stylesheet
creates exactly one top-level section. Due to the various checks in the stylesheet the TOC
is suppressed when min-sections is set to anything higher than 1. That's the work-around I'm
currently working with in FOP, but I think this can be improved. Setting min-sections to 3
or 4 is a very nice feature, but sometimes (like in the FAQ example), this is not ideal, so
I implemented a forcing mechanism, I will attach as a patch. Using the meta tag in the document
header is probably not the best idea but this let me add this feature without the need for
a change in the DTD. I'll leave it up to you guys, what to do with this. It's just a suggestion
and I've only patched the pelt skin so far. If this is nuts, just close the bug. :-) Thanks!


> FAQ+TOC problem: force-toc option
> ---------------------------------
>
>          Key: FOR-559
>          URL: http://issues.apache.org/jira/browse/FOR-559
>      Project: Forrest
>         Type: New Feature
>   Components: Skins (general issues)
>     Versions: 0.6, 0.7, 0.8-dev
>     Reporter: Jeremias Maerki
>     Priority: Minor
>  Attachments: forrest-force-toc.diff
>
> This is a hybrid patch/RFE/bugfix. Today, I've taken another stab at the problem Clay
Leeds reported to you in May:
> http://www.mail-archive.com/user@forrest.apache.org/msg00528.html
> We have the problem in FOP that the TOC for the FAQ page isn't generated.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message