Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 16 Mar 2002 22:12:13 +0000
From:      Ceri <setantae@submonkey.net>
To:        doc@FreeBSD.org
Subject:   Indexing the FAQ: does this suck ?
Message-ID:  <20020316221213.GA1647@submonkey.net>

next in thread | raw e-mail | index | archive | help

--PmA2V3Z32TCmWXqI
Content-Type: multipart/mixed; boundary="ZGiS0Q5IWpPtfppv"
Content-Disposition: inline


--ZGiS0Q5IWpPtfppv
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable


As some of you will know, I've been promising for a while now to start addi=
ng
indexterm elements to the FAQ.

Since this is major job, I'd like to ask you all if the attached patch sucks
or not (and whether it blows too).

What I'm thinking, rightly or wrongly is that this will produce an index li=
ke
books have, but I don't know if that's true or not.
If it is, then this patch will produce stuff like :

FreeBSD,
    name
    overview
    project goals

license,
    BSD

version,
    current
    latest
    release frequency
    stable


So what I'm asking is whether these are the kind of terms I should be using
within the indexterm elements, or whether I should be looser or stricter wi=
th
what I put in there.

Thanks,

Ceri

--=20
keep a mild groove on

--ZGiS0Q5IWpPtfppv
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="faq.diff"
Content-Transfer-Encoding: quoted-printable

--- book.sgml.old	Sat Mar 16 21:53:07 2002
+++ book.sgml	Sat Mar 16 22:05:47 2002
@@ -76,6 +76,10 @@
     <qandaset>
       <qandaentry>
         <question id=3D"what-is-FreeBSD">
+	  <indexterm>
+	    <primary>FreeBSD</primary>
+	    <secondary>overview</secondary>
+	  </indexterm>
           <para>What is FreeBSD?</para>
         </question>
=20
@@ -107,6 +111,10 @@
=20
       <qandaentry>
         <question id=3D"FreeBSD-goals">
+	  <indexterm>
+	    <primary>FreeBSD</primary>
+	    <secondary>project goals</secondary>
+	  </indexterm>
           <para>What is the goal of the FreeBSD Project?</para>
         </question>
=20
@@ -141,6 +149,10 @@
=20
       <qandaentry>
         <question id=3D"bsd-license-restrictions">
+	  <indexterm>
+	    <primary>license</primary>
+	    <secondary>BSD</secondary>
+	  </indexterm>
           <para>Does the FreeBSD license have any restrictions?</para>
         </question>
=20
@@ -167,6 +179,10 @@
=20
       <qandaentry>
         <question id=3D"replace-current-OS">
+	  <indexterm>
+	    <primary>operating system</primary>
+	    <secondary>replacing</secondary>
+	  </indexterm>
           <para>Can FreeBSD replace my current operating system?</para>
         </question>
=20
@@ -210,6 +226,10 @@
=20
       <qandaentry>
         <question id=3D"why-called-FreeBSD">
+	  <indexterm>
+	    <primary>FreeBSD</primary>
+	    <secondary>name</secondary?
+	  </indexterm>
           <para>Why is it called FreeBSD?</para>
         </question>
=20
@@ -246,6 +266,10 @@
=20
       <qandaentry>
         <question id=3D"latest-version">
+	  <indexterm>
+	    <primary>version</primary>
+	    <secondary>latest</secondary>
+	  </indexterm>
           <para>What is the latest version of FreeBSD?</para>
         </question>
=20
@@ -276,6 +300,10 @@
=20
       <qandaentry>
         <question id=3D"current">
+	  <indexterm>
+	    <primary>version</primary>
+	    <secondary>current</secondary>
+	  </indexterm>
           <para>What is FreeBSD-CURRENT?</para>
         </question>
=20
@@ -358,6 +386,10 @@
=20
       <qandaentry>
         <question id=3D"stable">
+	  <indexterm>
+	    <primary>version</primary>
+	    <secondary>stable</secondary>
+	  </indexterm>
           <para>What is the FreeBSD-STABLE concept?</para>
         </question>
=20
@@ -428,6 +460,10 @@
=20
       <qandaentry>
         <question id=3D"release-freq">
+	  <indexterm>
+	    <primary>version</primary>
+	    <secondary>release frequency</secondary>
+	  <indexterm>
           <para>When are FreeBSD releases made?</para>
         </question>
=20

--ZGiS0Q5IWpPtfppv--

--PmA2V3Z32TCmWXqI
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
Comment: For info see http://www.gnupg.org

iD8DBQE8k8M9ocfcwTS3JF8RAsYuAJ0a4mK9Gn8XjCJ1OE9wJEIDtz/CFgCgg7hB
MKQlTbZ5YwMrn7dP23hYr4E=
=/5JN
-----END PGP SIGNATURE-----

--PmA2V3Z32TCmWXqI--

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020316221213.GA1647>