pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Why does SGML <indexterm> use zone=?
3+ messages / 2 participants
[nested] [flat]

* Why does SGML <indexterm> use zone=?
@ 2007-08-30 20:15 Bruce Momjian <bruce@momjian.us>
  2007-08-30 20:33 ` Re: Why does SGML <indexterm> use zone=? Peter Eisentraut <peter_e@gmx.net>
  0 siblings, 1 reply; 3+ messages in thread

From: Bruce Momjian @ 2007-08-30 20:15 UTC (permalink / raw)
  To: pgsql-docs

I see many places in the SGML docs that we do:

   <indexterm zone="functions-info">
    <primary>user</primary>
    <secondary>current</secondary>
   </indexterm>

In almost every case the "zone" tag has the same name as the section it
is in.  However, there are other cases that have no "zone" tag and they
default to the section they are in.  What I am wondering is why we
specify "zone" at all?  Why not just let it default to the section name?
Seems that would make writing and editing easier.

The SGML docs at:

	http://www.oasis-open.org/docbook/documentation/reference/html/indexterm.html

Say:

	Zone
	
	    The use of Zone implies a spanning index entry. Zone holds the IDs
	of the elements to which it applies. The IndexTerm applies to the
	contents of the entire element(s) to which it points. If Zone is used,
	the phyiscal placement of the IndexTerm in the flow of the document is
	irrelavant.


It seems "zone" is for cases where you want to specify index terms
outside of the main document flow, but we don't do that.

-- 
  Bruce Momjian  <bruce@momjian.us>          http://momjian.us
  EnterpriseDB                               http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +



^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Why does SGML <indexterm> use zone=?
  2007-08-30 20:15 Why does SGML <indexterm> use zone=? Bruce Momjian <bruce@momjian.us>
@ 2007-08-30 20:33 ` Peter Eisentraut <peter_e@gmx.net>
  2007-08-30 20:38   ` Re: Why does SGML <indexterm> use zone=? Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 3+ messages in thread

From: Peter Eisentraut @ 2007-08-30 20:33 UTC (permalink / raw)
  To: pgsql-docs; +Cc: Bruce Momjian <bruce@momjian.us>

Bruce Momjian wrote:
> What I am wondering is why we specify "zone" at all?

It means that the entire section is relevant to the index term.  
Otherwise it would mean that only the narrow area around the index term 
is relevant.  In printed renditions, that would be the difference 
between saying

foo, 87

and

foo, 86-90

in the index.
-- 
Peter Eisentraut
http://developer.postgresql.org/~petere/



^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Why does SGML <indexterm> use zone=?
  2007-08-30 20:15 Why does SGML <indexterm> use zone=? Bruce Momjian <bruce@momjian.us>
  2007-08-30 20:33 ` Re: Why does SGML <indexterm> use zone=? Peter Eisentraut <peter_e@gmx.net>
@ 2007-08-30 20:38   ` Bruce Momjian <bruce@momjian.us>
  0 siblings, 0 replies; 3+ messages in thread

From: Bruce Momjian @ 2007-08-30 20:38 UTC (permalink / raw)
  To: Peter Eisentraut <peter_e@gmx.net>; +Cc: pgsql-docs

Peter Eisentraut wrote:
> Bruce Momjian wrote:
> > What I am wondering is why we specify "zone" at all?
> 
> It means that the entire section is relevant to the index term.  
> Otherwise it would mean that only the narrow area around the index term 
> is relevant.  In printed renditions, that would be the difference 
> between saying
> 
> foo, 87
> 
> and
> 
> foo, 86-90
> 
> in the index.

Ah, interesting.  Thanks.

-- 
  Bruce Momjian  <bruce@momjian.us>          http://momjian.us
  EnterpriseDB                               http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +



^ permalink  raw  reply  [nested|flat] 3+ messages in thread


end of thread, other threads:[~2007-08-30 20:38 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2007-08-30 20:15 Why does SGML <indexterm> use zone=? Bruce Momjian <bruce@momjian.us>
2007-08-30 20:33 ` Peter Eisentraut <peter_e@gmx.net>
2007-08-30 20:38   ` Bruce Momjian <bruce@momjian.us>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox