Re: Time to Reorg the Doc? [Was: HTextArea form element ]

eric@oclc.org (Eric W. Sink)
Date: Thu, 30 Jun 94 11:41:33 EDT
Message-id: <9406301539.AA26191@hook.spyglass.com>
Reply-To: html-ig@oclc.org
Originator: html-ig@oclc.org
Sender: html-ig@oclc.org
Precedence: bulk
From: eric@oclc.org (Eric W. Sink)
To: Multiple recipients of list <html-ig@oclc.org>
Subject: Re: Time to Reorg the Doc? [Was: HTextArea form element ]
X-Listprocessor-Version: 6.0c -- ListProcessor by Anastasios Kotsikonas
X-Comment: HTML Implementation Group (Private)

>I've also been playing around with the FrameMaker/DocBook tools that
>we have here at HaL.  Is anybody out there planning to include this
>with their docset? If I produced a DocBook version of this thing,
>would that be valuable to folks? Or would you rather just take the
>PostScript version and print that?

I'd definitely like something a little more editable than just PostScript.
We have no intention of editing for content after the reviewers have
signed off on it.  However, the doc is just more useful if it comes in
a format we can manipulate.

>Then somebody else can write user documentation, tutorials, "how to
>write a browser" documents, etc. -- stick all the stuff about how to
>compose search URLs from ISMAP documents in there.

>So let's inventory exactly what we require for an HTML 2.0 spec:

I'll inventory exactly what I require for an HTML 2.0 spec *and* its
associated documents.  For us, the kind of documents we need, while not
really into the realm of user tutorials, may go beyond the scope of what
is appropriate for a simple HTML spec.

>I invite folks to rate each of the following as:
>        5 - must have this for my purposes
>        4 - may have this, and I think it should
>        3 - may have this, but I don't care
>        2 - may have this, but I'd rather it did not
>        1 - must not have this
>
>                                                        Eric's Rating
>Normative content:
>        * An SGML Declaration and one or more DTD subsets               5
>        * Minimal conformance definition                                5
>        * Definition of element semantics                               5
>                (e.g. what rendering distinctions MUST be made)
>        * Element reference                                             5
>        * Examples of recommended usage                                 4
>        * Explanation of operation of anchors, forms, ISINDEX, ISMAP    4
>        * Explanation of WWW linking and addressing                     2
>        * Security Issues                                               2
>
>(if only there were time...)
>        * Test Suite                                                    4
>
>Informative content:
>        * Publication History                                           4
>        * Summary of Changes since draft-iiir-html-01                   4
>        * "Typical Rendering" instructions                              5
>        * Historical notes about browser implementations that           2
>                conflict with the SGML standard
>        * Examples of common authoring errors                           2
>        * Rationale behind contentious issues                           4
>                (e.g. "why P is a container")
>        * Proposed language changes                                     2
>
>Navigation Features and Media:
>        * A Postscript format file                                      3
>        * A collection of HTML nodes                                    5
>        * A plain text format file                                      3
>        * A DocBook document                                            5
                or FrameMaker, TeX, Word, whatever
>
>        * List of Reviewers                                             5
>        * Revision History                                              4
>        * Numbered Sections                                             4
>        * Title page                                                    3
>        * Abstract                                                      3
>        * Index                                                         4
>
>Publication Forums/Audiences:
>        * Publication through the IETF as an RFC or FYI                 4
>        * Publication through the Davenport group                       3
>        * Publication through SGML Open                                 3


Eric W. Sink, Software Engineer --  eric@spyglass.com 217-355-6000 ext 237
All opinions expressed are mine, and may not be those of my employer.
        "Only academic people put cheese in their pocket."
            -SW, 24 May 1994