pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Bruce Momjian <bruce@momjian.us>
To: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Why does SGML <indexterm> use zone=?
Date: Thu, 30 Aug 2007 16:15:31 -0400 (EDT)
Message-ID: <200708302015.l7UKFVO16372@momjian.us> (raw)

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



view thread (3+ messages)  latest in thread

Message-ID: <200708302015.l7UKFVO16372@momjian.us>
Permalink:  ../200708302015.l7UKFVO16372@momjian.us/
Also on:    postgresql.org/message-id/200708302015.l7UKFVO16372@momjian.us

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: bruce@momjian.us
  Subject: Re: Why does SGML <indexterm> use zone=?
  In-Reply-To: <200708302015.l7UKFVO16372@momjian.us>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

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