[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Re^6: document registration policy needing to be written



Marco.Budde@hqsys.antar.com (Marco Budde) writes:
> Am 14.04.98 schrieb apharris # burrito.onshore.com ...

> APH> Document: doc-base
> 
> What for is this?

Did you read the doc-base documention yet, Marco?

It is the document ID.  Currently, in doc-base (and this affects your
new document standard registration format you proposed) every document
may have one and only one Debian-unique ID.  Each document id has a
control file (in /usr/share/doc-base).  Each document id may have many
formats.

> APH> Title: Debian doc-base Manual
> This is like my <linkname>?

Yes, but it is a field that actually makes sense to speakers of
English, unlike "linkname".

> APH> Author: Christian Schwarz
> 
> Do we need that?

Sure.  Arguably.  Then I could have an index on authors.  You could
sort by author.

> APH> Abstract: This manual describes what doc-base is and how it can
> APH> be used to manage online manuals on Debian systems.
> 
> Ok, is should HTML be allowed?

What?

> APH> Format: debiandoc-sgml
> APH> Files: /usr/doc/doc-base/doc-base.sgml.gz
> APH>
> APH> Format: text
> APH> Files: /usr/doc/doc-base/doc-base.text.gz
> 
> I don#t understand that. Can every File can have its own Abstract for  
> example? How can you recognize the beginning of the definition of a new  
> document (like my <item></item>)?

See above.

> APH> Format: HTML
> APH> Index: /usr/doc/doc-base/doc-base.html/index.html
> APH> Files: /usr/doc/doc-base/doc-base.html/*.html
> 
> What#s that? I don#t see any need for that. "File: " should be the root  
> document (index.html in this example). That#s difficult to parse in C.

I'm not quite sure what's up with these.  Christian, can you recount
the justification for these?

> APH> Blech.  Disagree.  Arguably, flat text files are our standard format;
> 
> No, see Policy.

I'm talking about reality, not policy.  Furthermore, Policy states
that our official format is HTML.  But most policy documents, in fact,
most people who care at all about writing documention in a
media-neutral format, use SGML.

We are beyond Policy.  We are setting policy here.  We should
acknowledge the pragmatics, but have the vision to see the future.
It's name is SGML.  (Mark my words, MSWord will support XML this
year.)
 
.....A. P. Harris...apharris@onShore.com...<URL:http://www.onShore.com/>


--
To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org


Reply to: