You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Andrew McIntyre (JIRA)" <de...@db.apache.org> on 2006/08/23 12:28:14 UTC

[jira] Commented: (DERBY-753) References from table of contents in the HTML book manuals are invalid

    [ http://issues.apache.org/jira/browse/DERBY-753?page=comments#action_12429956 ] 
            
Andrew McIntyre commented on DERBY-753:
---------------------------------------

Committed a fix to the trunk with revision 434003. Beware all ye who venture here: the sea of XSLT is deep and wide and unforgiving.

The story goes something like this: the generated id's for topic references were not being retained, and new unrelated generated ids were being created for the same topics as they were inserted into the final document at a later stage of processing. So, instead of being identified by their originally generated correct ids, the new incorrect generated id for the topic was being inserted into the final generated HTML Book. In addition, the internal page reference was being used instead of the XSLT engine generated id.

This was too late to make tonight's doc build, but I hope to verify the fix in the next doc build and close this issue. Any and all review/comments appreciated.

> References from table of contents in the HTML book manuals are invalid
> ----------------------------------------------------------------------
>
>                 Key: DERBY-753
>                 URL: http://issues.apache.org/jira/browse/DERBY-753
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.1.1.2, 10.1.2.1
>         Environment: Tested in several different browsers and on different computers.
>            Reporter: Kristian Waagan
>
> The references from the table of contents are invalid. They do not work because the wrong anchor/name is used, or that the tags defining the anchors are not included. 
> Is something going wrong in the documentation build process?
> To illustrate the point, try this:
> > http://db.apache.org/derby/docs/dev/ref/ref-single.html#crefsqlj95081
> The manual is shown, but you are not directed to the 'CREATE statements' chapter.
> Then try this:
> > http://db.apache.org/derby/docs/dev/ref/ref-single.html#N1223F
> This works and direct you to the 'CREATE statements' chapter.

-- 
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

        

Re: [jira] Commented: (DERBY-753) References from table of contents in the HTML book manuals are invalid

Posted by Kim Haase <Ca...@Sun.COM>.
I know a number of people, including me, who'll be very happy that you
fixed this, and also DERBY-935 (adding the logo). Thank you for your
wizardry!

Kim

Andrew McIntyre (JIRA) wrote On 08/23/06 06:28,:
>     [ http://issues.apache.org/jira/browse/DERBY-753?page=comments#action_12429956 ] 
>             
> Andrew McIntyre commented on DERBY-753:
> ---------------------------------------
> 
> Committed a fix to the trunk with revision 434003. Beware all ye who venture here: the sea of XSLT is deep and wide and unforgiving.
> 
> The story goes something like this: the generated id's for topic references were not being retained, and new unrelated generated ids were being created for the same topics as they were inserted into the final document at a later stage of processing. So, instead of being identified by their originally generated correct ids, the new incorrect generated id for the topic was being inserted into the final generated HTML Book. In addition, the internal page reference was being used instead of the XSLT engine generated id.
> 
> This was too late to make tonight's doc build, but I hope to verify the fix in the next doc build and close this issue. Any and all review/comments appreciated.
> 
> 
>>References from table of contents in the HTML book manuals are invalid
>>----------------------------------------------------------------------
>>
>>                Key: DERBY-753
>>                URL: http://issues.apache.org/jira/browse/DERBY-753
>>            Project: Derby
>>         Issue Type: Bug
>>         Components: Documentation
>>   Affects Versions: 10.1.1.2, 10.1.2.1
>>        Environment: Tested in several different browsers and on different computers.
>>           Reporter: Kristian Waagan
>>
>>The references from the table of contents are invalid. They do not work because the wrong anchor/name is used, or that the tags defining the anchors are not included. 
>>Is something going wrong in the documentation build process?
>>To illustrate the point, try this:
>>
>>>http://db.apache.org/derby/docs/dev/ref/ref-single.html#crefsqlj95081
>>
>>The manual is shown, but you are not directed to the 'CREATE statements' chapter.
>>Then try this:
>>
>>>http://db.apache.org/derby/docs/dev/ref/ref-single.html#N1223F
>>
>>This works and direct you to the 'CREATE statements' chapter.
> 
> 


Re: [jira] Commented: (DERBY-753) References from table of contents in the HTML book manuals are invalid

Posted by Kim Haase <Ca...@Sun.COM>.
Hi, Andrew,

This and the fix to DERBY-935 are working really well. I now see the
Derby logo in the HTML book file and the PDF, and in the HTML book file
the TOC links are now working. (They don't work in the PDF, but this
doesn't matter much because the bookmarks on the left side act as the TOC.)

After some perplexity (the changes didn't seem to be working at first),
I figured out that because of the following target in the build.xml file --

  <target name="unpack.dita" unless="dita.available">
    <unjar src="${dita.zip}" dest="${basedir}"/>
    <copy file="${dita.lib.dir}/dita2fo-shell.xsl" todir="${dita.dir}/xsl"/>
  </target>

you have to either delete your DITA-OT1.1.2.1 directory (so that this
target is run) or else just manually copy the file lib/dita2fo-shell.xsl
into the DITA-OT1.1.2.1/xsl directory. I did the latter since it seemed
less drastic.

Something odd seems to have happened at the same time to the way
trademark symbols are displayed in the HTML files version (not in the
monohtml or PDF versions. If I look at the file cadminapps810777.html,
for example (Accessing the Network Server by using the DB2 Driver for
JDBC), the R symbol and the TM symbol used to look fine, but now, in my
environment, they appear as double question marks and triple question
marks, respectively. In the nightly build on
http://db.apache.org/derby/docs/dev/adminguide/ everything seems to be
fine. On the other hand, these nightly versions include the logo fix
(DERBY-935) but not the TOC fix (DERBY-753), as it appears from looking
at http://db.apache.org/derby/docs/dev/adminguide/adminguide-single.html.

Since this change happened at the same time (things were okay Tuesday,
but bad on Wednesday after I did an update that brought in these
changes), I can only guess it is a side effect of the changes. But I
can't think why or how. It might just be something funny in my
environment. Has anyone else run into this?

Thanks,
Kim

Andrew McIntyre (JIRA) wrote On 08/23/06 06:28,:
>     [ http://issues.apache.org/jira/browse/DERBY-753?page=comments#action_12429956 ] 
>             
> Andrew McIntyre commented on DERBY-753:
> ---------------------------------------
> 
> Committed a fix to the trunk with revision 434003. Beware all ye who venture here: the sea of XSLT is deep and wide and unforgiving.
> 
> The story goes something like this: the generated id's for topic references were not being retained, and new unrelated generated ids were being created for the same topics as they were inserted into the final document at a later stage of processing. So, instead of being identified by their originally generated correct ids, the new incorrect generated id for the topic was being inserted into the final generated HTML Book. In addition, the internal page reference was being used instead of the XSLT engine generated id.
> 
> This was too late to make tonight's doc build, but I hope to verify the fix in the next doc build and close this issue. Any and all review/comments appreciated.
> 
> 
>>References from table of contents in the HTML book manuals are invalid
>>----------------------------------------------------------------------
>>
>>                Key: DERBY-753
>>                URL: http://issues.apache.org/jira/browse/DERBY-753
>>            Project: Derby
>>         Issue Type: Bug
>>         Components: Documentation
>>   Affects Versions: 10.1.1.2, 10.1.2.1
>>        Environment: Tested in several different browsers and on different computers.
>>           Reporter: Kristian Waagan
>>
>>The references from the table of contents are invalid. They do not work because the wrong anchor/name is used, or that the tags defining the anchors are not included. 
>>Is something going wrong in the documentation build process?
>>To illustrate the point, try this:
>>
>>>http://db.apache.org/derby/docs/dev/ref/ref-single.html#crefsqlj95081
>>
>>The manual is shown, but you are not directed to the 'CREATE statements' chapter.
>>Then try this:
>>
>>>http://db.apache.org/derby/docs/dev/ref/ref-single.html#N1223F
>>
>>This works and direct you to the 'CREATE statements' chapter.
> 
>