docbook-apps

I'm looking at the CHM/HtmlHelp output from my project. (Using Saxon-6, Microsoft Html Help Compiler, and Ant to call them both)

I want to customize how the Revision History is displayed. I would like to be able to show it linked from the title-page, using generate.revhistory.link.



If I copy the d:revhistory and d:revhistory/d:revision templates from html/block.xsl I can customize them with no problem. However, that is relevant to "in-line" revision histories, ie within a

. I would like to have the Revision History available linked from the title page, but in another page, which should be achievable using generate.revhistory.link.



However, if I copy the d:revhistory and d:revhistory/d:revision templates for mode="titlepage.mode" from html/titlepage.xsl I start getting problems. (Note that at this stage I've made no changes to those templates so that can't be what's causing the problem)



The first problem I noticed was that merely copying the relevant templates out of the default stylesheet file and into my customization stylesheet file would break the result. The Revision History link is available on the title page, but clicking it gives me a page "This program cannot display the webpage". By looking at the html produced by the DocBook-Xsl transformation I know that a page with the Revision History has been generated, named rh-something.html. However, it is not referenced by the .hhp file, which should list all the html files, shouldn't it ? (It does list all the other html files)

That was where I'd got to last week. Today I sat down to look at it again and I am now even more puzzled.

The .hhp file never contains a reference to the rh file !

Whether or not the resulting chm works there is no rh-something.html file listed in the .hhp file that has been produced by the DocBook stylesheets.

If I manually add the rh file, as generated by the transform, to the list in the hhp file, it then works.

Unfortunately I can't find any reference documentation for the Html Help Compiler (which is very old, and twice superseded.....) so I can't see whether it should contain some built-in rules for finding pages which aren't listed.



So, does anyone know :



1. Why it works when not customized, despite the rh file not being listed in the hhp ?

2. How the DocBook-XSL system is supposed to work for HtmlHelp; specifically the generation of the .hhp file and the writing of the reference for the rh-something file into the hhp.





Puzzledly,

Richard.







Richard Kerry
BNCS Engineer
T: +44 (0)20 82259063
M: +44 (0)7812 325518
Room EBX 301, BBC Television Centre, Wood Lane, London, W12 7RJ
richard.kerry@atos.net<mailto:richard.kerry@atos.net>
uk.atos.net<http://uk.atos.net/en-uk/>
This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable

So I may be the only person using HtmlHelp and the generate.revhistory.link and seeking to customize the resulting revhistory html page .....



And leaving aside the issue of exactly what the (very old and badly documented) MS Help Compiler is doing, and why it sort of works even if its input appears not to be correct .....



There would appear to be a fault in the default stylesheets for html-help generation. If generate.revhistory.link is set, although the rh-prefixed html file is generated, no reference to the generated revhistory html file is generated in the [FILES] section in the hhp file.



Looking in htmlhelp-common.xsl I can see the code that generates the [FILES] section. Though I can't follow how it works in full.

I would appreciate it if someone familiar with this process could explain how it works, and preferably provide a fix.



Once the process is fixed I can resume customizing the html.





Regards,

Richard.








[Blue line]
Richard Kerry
BNCS Engineer
T: +44 (0)20 82259063[X]<thismessage:/Body.htm#>
M: +44 (0)7812 325518[X]<thismessage:/Body.htm#>
Room EBX 301, BBC Television Centre, Wood Lane, London, W12 7RJ
richard.kerry@atos.net<https://webmail.siemens-it-solutions.com/owa/redir.aspx?C=9fb20d019e3e4cb99344d708709a3177&URL=mailto%3arichard.kerry%40atos.net>
uk.atos.net<https://webmail.siemens-it-solutions.com/owa/redir.aspx?C=9fb20d019e3e4cb99344d708709a3177&URL=http%3a%2f%2fuk.atos.net%2fen-uk%2f>
[Atos logo]
This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable
________________________________
From: Kerry, Richard [richard.kerry@atos.net]
Sent: 20 May 2013 14:22
To: DocBook Apps Mailing List ?[docbook-apps@lists.oasis-open.org]?
Subject: [docbook-apps] HtmlHelp/CHM - Revision History+generate.revhistory.link - not visible in output




I'm looking at the CHM/HtmlHelp output from my project. (Using Saxon-6, Microsoft Html Help Compiler, and Ant to call them both)

I want to customize how the Revision History is displayed. I would like to be able to show it linked from the title-page, using generate.revhistory.link.



If I copy the d:revhistory and d:revhistory/d:revision templates from html/block.xsl I can customize them with no problem. However, that is relevant to "in-line" revision histories, ie within a

. I would like to have the Revision History available linked from the title page, but in another page, which should be achievable using generate.revhistory.link.



However, if I copy the d:revhistory and d:revhistory/d:revision templates for mode="titlepage.mode" from html/titlepage.xsl I start getting problems. (Note that at this stage I've made no changes to those templates so that can't be what's causing the problem)



The first problem I noticed was that merely copying the relevant templates out of the default stylesheet file and into my customization stylesheet file would break the result. The Revision History link is available on the title page, but clicking it gives me a page "This program cannot display the webpage". By looking at the html produced by the DocBook-Xsl transformation I know that a page with the Revision History has been generated, named rh-something.html. However, it is not referenced by the .hhp file, which should list all the html files, shouldn't it ? (It does list all the other html files)

That was where I'd got to last week. Today I sat down to look at it again and I am now even more puzzled.

The .hhp file never contains a reference to the rh file !

Whether or not the resulting chm works there is no rh-something.html file listed in the .hhp file that has been produced by the DocBook stylesheets.

If I manually add the rh file, as generated by the transform, to the list in the hhp file, it then works.

Unfortunately I can't find any reference documentation for the Html Help Compiler (which is very old, and twice superseded.....) so I can't see whether it should contain some built-in rules for finding pages which aren't listed.



So, does anyone know :



1. Why it works when not customized, despite the rh file not being listed in the hhp ?

2. How the DocBook-XSL system is supposed to work for HtmlHelp; specifically the generation of the .hhp file and the writing of the reference for the rh-something file into the hhp.





Puzzledly,

Richard.







Richard Kerry
BNCS Engineer
T: +44 (0)20 82259063[X]<thismessage:/Body.htm#>
M: +44 (0)7812 325518[X]<thismessage:/Body.htm#>
Room EBX 301, BBC Television Centre, Wood Lane, London, W12 7RJ
richard.kerry@atos.net<mailto:richard.kerry@atos.net>
uk.atos.net<http://uk.atos.net/en-uk/>
This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable

On 24.5.2013 11:33, Kerry, Richard wrote:

> Looking in htmlhelp-common.xsl I can see the code that generates the [FILES] section. Though I can't follow how it works in full.
>
> I would appreciate it if someone familiar with this process could explain how it works, and preferably provide a fix.

I have fixed issue in sources, in a while change should be propagated
into an automatic build and you can give it a try:

http://snapshots.docbook.org/

--
------------------------------------------------------------------
Jirka Kosek e-mail: jirka@kosek.cz http://xmlguru.cz
------------------------------------------------------------------
Professional XML consulting and training services
DocBook customization, custom XSLT/XSL-FO document processing
------------------------------------------------------------------
OASIS DocBook TC member, W3C Invited Expert, ISO JTC1/SC34 rep.
------------------------------------------------------------------
Bringing you XML Prague conference http://xmlprague.cz
------------------------------------------------------------------

Jirka,

Thank you very much for looking at this.
I shall try it out when I am next working in the area.

How long does it take for the automatic build to happen and work to appear in the snapshots (roughly) ?


Regards,
Richard.



> -----Original Message-----
> From: Jirka Kosek [mailto:jirka@kosek.cz]
> Sent: 24 May 2013 14:44
> To: Kerry, Richard
> Cc: "DocBook Apps Mailing List ?[docbook-apps@lists.oasis-open.org]?"
> Subject: Re: [docbook-apps] RE: HtmlHelp/CHM - Revision
> History+generate.revhistory.link - not visible in output
>
> On 24.5.2013 11:33, Kerry, Richard wrote:
>
> > Looking in htmlhelp-common.xsl I can see the code that
> generates the [FILES] section. Though I can't follow how it
> works in full.
> >
> > I would appreciate it if someone familiar with this process
> could explain how it works, and preferably provide a fix.
>
> I have fixed issue in sources, in a while change should be propagated
> into an automatic build and you can give it a try:
>
> http://snapshots.docbook.org/
>
> --
> ------------------------------------------------------------------
> Jirka Kosek e-mail: jirka@kosek.cz http://xmlguru.cz
> ------------------------------------------------------------------
> Professional XML consulting and training services
> DocBook customization, custom XSLT/XSL-FO document processing
> ------------------------------------------------------------------
> OASIS DocBook TC member, W3C Invited Expert, ISO JTC1/SC34 rep.
> ------------------------------------------------------------------
> Bringing you XML Prague conference http://xmlprague.cz
> ------------------------------------------------------------------
>
>

I've now tried this and it is working as I would expect.

(I've copied the snapshot version of html/chunk-code.xsl to my 1.78 folder.)

A suitable entry is now being put into the hhp file and the resulting chm is showing the extra page as required.





Appreciatively,

Richard.





Richard Kerry
BNCS Engineer
T: +44 (0)20 82259063
M: +44 (0)7812 325518
Room EBX 301, BBC Television Centre, Wood Lane, London, W12 7RJ
richard.kerry@atos.net<https://webmail.siemens-it-solutions.com/owa/redir.aspx?C=9fb20d019e3e4cb99344d708709a3177&URL=mailto%3arichard.kerry%40atos.net>
uk.atos.net<https://webmail.siemens-it-solutions.com/owa/redir.aspx?C=9fb20d019e3e4cb99344d708709a3177&URL=http%3a%2f%2fuk.atos.net%2fen-uk%2f>
This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable
________________________________
From: Kerry, Richard [richard.kerry@atos.net]
Sent: 29 May 2013 12:21
To: Jirka Kosek; "DocBook Apps Mailing List ?[docbook-apps@lists.oasis-open.org]?"
Subject: RE: [docbook-apps] RE: HtmlHelp/CHM - Revision History+generate.revhistory.link - not visible in output



Jirka,

Thank you very much for looking at this.
I shall try it out when I am next working in the area.

How long does it take for the automatic build to happen and work to appear in the snapshots (roughly) ?


Regards,
Richard.



> -----Original Message-----
> From: Jirka Kosek [mailto:jirka@kosek.cz]
> Sent: 24 May 2013 14:44
> To: Kerry, Richard
> Cc: "DocBook Apps Mailing List ?[docbook-apps@lists.oasis-open.org]?"
> Subject: Re: [docbook-apps] RE: HtmlHelp/CHM - Revision
> History+generate.revhistory.link - not visible in output
>
> On 24.5.2013 11:33, Kerry, Richard wrote:
>
> > Looking in htmlhelp-common.xsl I can see the code that
> generates the [FILES] section. Though I can't follow how it
> works in full.
> >
> > I would appreciate it if someone familiar with this process
> could explain how it works, and preferably provide a fix.
>
> I have fixed issue in sources, in a while change should be propagated
> into an automatic build and you can give it a try:
>
> http://snapshots.docbook.org/
>
> --
> ------------------------------------------------------------------
> Jirka Kosek e-mail: jirka@kosek.cz http://xmlguru.cz<http://xmlguru.cz/>
> ------------------------------------------------------------------
> Professional XML consulting and training services
> DocBook customization, custom XSLT/XSL-FO document processing
> ------------------------------------------------------------------
> OASIS DocBook TC member, W3C Invited Expert, ISO JTC1/SC34 rep.
> ------------------------------------------------------------------
> Bringing you XML Prague conference http://xmlprague.cz<http://xmlprague.cz/>
> ------------------------------------------------------------------
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org