Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 4 Jun 2001 22:52:50 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        "G. Adam Stanislav" <adam@whizkidtech.net>
Cc:        Nik Clayton <nik@freebsd.org>, doc@freebsd.org
Subject:   Re: Assembly language tutorial
Message-ID:  <20010604225250.C20450@catkin.nothing-going-on.org>
In-Reply-To: <20010604130919.B297@whizkidtech.net>; from adam@whizkidtech.net on Mon, Jun 04, 2001 at 01:09:19PM -0500
References:  <3.0.6.32.20010603215127.00a94100@mail85.pair.com> <20010604173555.B20450@catkin.nothing-going-on.org> <20010604130919.B297@whizkidtech.net>

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

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

On Mon, Jun 04, 2001 at 01:09:19PM -0500, G. Adam Stanislav wrote:
> On Mon, Jun 04, 2001 at 05:35:55PM +0100, Nik Clayton wrote:
> >> - Third, I need to know how to refer to other parts of the same
> >>   handbook. I mean parts written by someone else. I noticed
> >>   the handbook uses some very cryptic labels, such as AEN5339.
> >>   How do I know the proper label for some other sect[123]?
> >
> >See
> >
> >    http://www.freebsd.org/doc/en_US.ISO_8859-1/books/fdp-primer/x1266.h=
tml#AEN2071
>=20
> I read that. But that does not asnwer my question. I noticed most of
> the chapter.sgml's just have one id at the start of the chapter, but
> none inside. What I need to know is how to refer to a sect1 or even
> a sect2 buried deep within a chapter. They do not use <sect1 id=3D"blah">,
> they just say <sect1>.

That's only because we don't link to most sections.

The "id" on the chapter is there for two reasons.

  1.  It gives us something to link to.

  2.  It determines the name of the generated .html file.

You can link to subsections (<sect1> -> <sect6>) by adding in IDs as
necessary.  This example has two sections, and a link from the second
one to the first.

   <chapter id=3D"...">
     <sect1 id=3D"foo-sect">
       <title>Foo</title>

       <para>...</para>
     </sect1>

     <sect1>
       <title>Bar</title>

       <para>This includes a link back to the first section: <xref
         linkend=3D"foo-sect">.</para>
      </sect1>
    </chapter>

To see many, many more examples,=20

    % cd doc/en_US.ISO_8859-1/books/handbook
    % grep 'sect. id' */*.sgml

> But the final HTML book does have an id for each sect1. Where does it
> come from? Or should I just request that a specific <sect1> be
> given an id because I would like to link to it? I know I could just
> link to a chapter, but I would like to be more specific than that.

If something needs an ID, and it doesn't have one, the stylesheets
generate it automatically.  The do this by taking the string "AEN", and
adding a number to it.

That number corresponds exactly with that element's occurence in the
document.  For example, if you had a chapter without an ID, and the
"<chapter>" element was the 20th element in the original .sgml file, it
would be called AEN20.html.  AEN stands for "All element number" (or
something like that anyway).

N
--=20
FreeBSD: The Power to Serve             http://www.freebsd.org/
FreeBSD Documentation Project           http://www.freebsd.org/docproj/

          --- 15B8 3FFC DDB4 34B0 AA5F  94B7 93A8 0764 2C37 E375 ---

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

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

iEYEARECAAYFAjscAzEACgkQk6gHZCw343U4MACeINbHfsehPTDynkH5LxSugtVw
0o0AoIJeSAeUUGpri1K1OT5LtQYrZ0fS
=PpVs
-----END PGP SIGNATURE-----

--yVhtmJPUSI46BTXb--

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?20010604225250.C20450>