Re^2: Documents vs. Sections
Am 28.04.98 schrieb Marcus.Brinkmann # ruhr-uni-bochum.de ...
Moin Marcus!
MB> * Document Registrations --- a document needs to define one or more
MB> sections where to be placed. The sections have to exist before they can
MB> be used.
Ok.
MB> * Section Registrations --- the DDH shipped with doc-base and
MB> packages create sections, where documents can be stored. A section needs
MB> a shortname, a title and an abstract. Probably further tags that are
MB> useful in this context (language, ...)
Ok. But we could use the same tags as we use for doc registration. If
there#s no "File: " for an entry, the parser knows, that this entry
describes a section registration.
MB> * Link Registrations --- the DDH will contain *very* few *section
MB> crosslinks* between different sections of the hierarchy. Thsoe are only
MB> meant as a convenience for the user and to support the logical
MB> structure. Only the DDH may create such links. From DDH -guidelines:
Ok, but Links should only used for sections and not for documents. And we
could use the same syntax like for doc/section registration. For example
we could use "File: @devel/mini".
And remember we should support URLs:
"File: http://....";
MB> Document: foobar
MB> Author: Mr. Brown
MB> Abstract: The brown fox doesn't jump anymore.
MB> Section: devel/lang/perl
MB> Section: usr/games
Well, looks nice, but for a parser it would be easier, if we have one
entry for one Section:
Document: foobar
....
Section: devel/lang/perl
Document: foobar
....
Section: usr/games
MB> > To the contrary, I would suggest that we allow a single document to
MB> > appear in as many documentation sections as the maintainer sees fit
Ok, but he should use as few sections as possible.
MB> > Section: <section> [<additional_section> ...]
Ok, should we use that?
cu, Marco
--
Uni: Budde@tu-harburg.de Fido: 2:240/5202.15
Mailbox: mbudde@hqsys.antar.com http://www.tu-harburg.de/~semb2204/
--
To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Reply to: