[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [TSVN] Spicing up the docs

From: Lübbe Onken <luebbe_at_tigris.org>
Date: 2005-06-27 21:37:22 CEST

SteveKing wrote:

> Simon Large wrote:
>
>> Lübbe Onken wrote:
>>
>>> Whaddayathink?
>>
>
> Looks good! One question though:
> are the words in the glossary automatically linked? (i.e. the word
> somewhere in the docs links to the glossary entry). If yes, how?

Did I mention the docbook docs? ;-)
IIRC <firstterm>s and <glossentry>s in the docs will be linked
automatically by either spelling them exactly the same as in the
glossary or by linking to the glossary via IDs (like in <xref>s)

>
>> Sounds good to me, but I think it should wait until after the 1.2.1
>> release, which should be in a few days. Don't want to release a
>> half-baked glossary.
>
>
> That won't be a problem. We didn't have a glossary before, so people
> won't complain if they get a rudimentary one the first time.

Yes, build the glossary up slowly. We got lots of <firstterms> scattered
throughout the docs without ever using them.

>
>> While we're about it, our indexing is not that good either.
>>
>> Something else I was thinking it would be nice to have is an image of
>> the main context menu with hotspots linked to the relevant helpfile
>> entries. Click on the menu entry to jump to the help for that item. But
>> I think that may be too difficult in docbook.
>
>
> Check out <AreaSpec>...

Haven't looked at that yet, but will it work in PDF, CHM and HTML?

Cheers
-Lübbe

--
       ___
  oo  // \\      "De Chelonian Mobile"
 (_,\/ \_/ \     TortoiseSVN
   \ \_/_\_/>    The coolest Interface to (Sub)Version Control
   /_/   \_\     http://tortoisesvn.tigris.org 
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org
Received on Mon Jun 27 21:39:03 2005

This is an archived mail posted to the TortoiseSVN Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.