This is the mail archive of the
docbook-apps@lists.oasis-open.org
mailing list .
RE: Re: Help project structure
- From: Maggie Strevell <maggie at ssinc dot com>
- To: David Cramer <dcramer at broadjump dot com>, Norman Walsh <ndw at nwalsh dot com>
- Cc: denisb at rational dot com, docbook-apps at lists dot oasis-open dot org
- Date: Fri, 01 Feb 2002 10:35:27 -0600
- Subject: RE: DOCBOOK-APPS: Re: Help project structure
Related Topics... I hadn't gotten that far yet. But yes, add "releated
topics" to the wish list too. Might want to consider customizing the XSL to
modify the .hhk file and let the help compiler do the rest. I wonder if you
won't run into a problem validating if you use single index term thats
defined in multiple places.
In .hhk, related Topics popup when you click on "editing" in the index if
defined as follows (no javascript, no lists at the bottom of topics needed).
Getting the XSL to do this is the trick, but I'm not far from having to do
the same.
<UL>
<LI><OBJECT type="Text/sitemap">
<param name="Name" value="editing">
<param name="Name" value="editing this">
<param name="Local" value="editing_this.htm">
<param name="Name" value="editing that">
<param name="Local" value="editing_that.htm">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="editing this">
<param name="Local" value="editing_this.htm">
<param name="Url" value="editing_this.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="editing that">
<param name="Local" value="editing_thathtm">
<param name="Url" value="editing_that.htm">
</OBJECT>
</UL>
</UL>
Maggie
-----Original Message-----
From: David Cramer [mailto:dcramer@broadjump.com]
Sent: Friday, February 01, 2002 9:51 AM
To: Maggie Strevell; Norman Walsh
Cc: denisb@rational.com; docbook-apps@lists.oasis-open.org
Subject: RE: DOCBOOK-APPS: Re: Help project structure
> 2) Be allowed to specify which file is the default in the .hhp file
> 6) Ability to specify the title of the help project.
> Currently, for me, it
> defaults the title of my first <chapter>.
I need to chew on the other items, but for now: I've gotten those kind
of customizations to work (tho you do get an error message from hhc.exe,
it doesn't seem to impact the output):
http://lists.oasis-open.org/archives/docbook-apps/200112/msg00079.html
An easy hack would be to turn on use ids as filenames, make the id of
the default topic "defaulttopic" and then put defaulttopic.html in the
appropriate places in the window definition in the hhp:
[WINDOWS]
BroadJump="Database Reference
Guide","toc.hhc","Index.hhk","defaulttopic.html","defaulttopic.html","ht
tp://www.broadjump.com","BroadJump",,,0x63420,279,0x14387E,[100,100,1041
,763],0xB0000,,,,,,0
On my wish list for the xsls is a generated "related topics" list for
each section. I was talking with another writer here this morning and we
had this idea: the xsl looks at each indexterm in a topic (chunkable
thing) and then checks to see if any other topics contain that
indexterm, if so, it's added to the list of related topics. Since the
chm format is Windows/IE only, you'd be safe in using a Javascript drop
down in the header or footer, though the list could be as simple as
appending a list to the end of each topic.
David