You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Jason Lingohr <ja...@lucid.net.au> on 2003/06/28 05:51:56 UTC
Beginnings of a standards document
I've begun taking on the task of documenting all the drafts/standards that
Apache adheres to, as per the STATUS file and PR 16938.
Before I march on too much more, I'd like some feedback on roughly how it's
looking and whatnot. Content isn't complete, nor is accuracy at this
point.
http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
Opinions welcome, and could someone explain to me the syntax of
<columnspec><column width=""/> (units used, etc) tag, as I'm not
seeing those widths get translated into HTML tags.
--
Jason Lingohr
jason@lucid.net.au
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by André Malo <nd...@perlig.de>.
* Jason Lingohr wrote:
> Ok, how about this:
>
> http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
In addition to what Joshua said,
(1) I would prefer to link to http resources rather than ftp
(2) the double-<dd> is not so cool, I'm not sure; what about
<dt>RFC foo (Draft standard)</dt>
<dd>...</dd>
?
(3) I'd put a space between RFC and #
(4) RFC 2616 is not a draft standard ;-))
btw: some recherches about the erratae (sp?) of the particular standards would
be cool. For example, RFC 2616 and 2617 errata are at
<http://purl.org/NET/http-errata>.
If I find some time next days, I think I can contribute some items to the
standards list.
nd
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Jason Lingohr <ja...@lucid.net.au>.
(Multi-people quotations)
On Mon, Jul 07, 2003 at 09:56:08AM -0400, Joshua Slive wrote:
> A couple small comments:
>
> 1. I'd keep the descriptions as short as possible, since there is no need
> to recreate what the abstract of the RFC will say.
Yeah -- I had intended to do this; what you're seeing was just a quick
mockup at the moment. Point taken.
> 2. Just as a style issue, I don't have a strong adherence to "adheres to".
> Brings up an image of a fly trapped on fly-paper ;-). I'd replace it with
> simply "follows" or something like that.
Agreed. Changed.
> Regarding which standards to document, there is no particular person who
> knows the answer to this (although Roy Fielding would surely come
> closest). You can start with the stuff here:
> http://httpd.apache.org/library/
> and perhaps post a message to dev@httpd asking for more suggestions.
I was going to use the library, and thanks for the other contacts.
André Malo said:
> (1) I would prefer to link to http resources rather than ftp
No problems.
> (2) the double-<dd> is not so cool, I'm not sure; what about
Taken onboard and changed.
> (3) I'd put a space between RFC and #
Done.
> (4) RFC 2616 is not a draft standard ;-))
Unless I'm missing something, rfc-editor.org says it is... at least on the
index page.
Erik Abele said:
> Andre already mentioned the HTTP RFC errata listing. Additionally, I'd
> like to see the following link go in too:
> http://www.rfc-editor.org/errata.html.
I'll add a links section.
--
Jason Lingohr
jason@lucid.net.au
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Joshua Slive <jo...@slive.ca>.
On Mon, 7 Jul 2003, Jason Lingohr wrote:
> Ok, how about this:
>
> http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
>
> I think Status should be near or at the top.
>
> If this is ok, I'll go ahead.
>
> I'm currently putting this in misc/, but won't commit until it has some
> actual body.
>
> Who should I talk to in dev about what RFC/STD's Apache actually adheres
> to?
This looks good to me, and misc/ seems like the right location (although
it has been used somewhat as a dumping ground in the past).
A couple small comments:
1. I'd keep the descriptions as short as possible, since there is no need
to recreate what the abstract of the RFC will say.
2. Just as a style issue, I don't have a strong adherence to "adheres to".
Brings up an image of a fly trapped on fly-paper ;-). I'd replace it with
simply "follows" or something like that.
Regarding which standards to document, there is no particular person who
knows the answer to this (although Roy Fielding would surely come
closest). You can start with the stuff here:
http://httpd.apache.org/library/
and perhaps post a message to dev@httpd asking for more suggestions.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Erik Abele <er...@codefaktor.de>.
On 07/07/2003, at 05:08, Jason Lingohr wrote:
> Ok, how about this:
>
> http://icarus.apache.org/~jsl/httpd-2.0/manual/
> relevant_standards.html.en
Looks good to me; just a minor typo in the first sentence: 'releveant'
should be 'relevant' :)
In addition to what Joshua and Andre said, I'd like to suggest to use
some sort of short title after the RFC#. For example 'RFC 2617 - HTTP
Authentication: Basic and Digest Access Authentication' or only 'RFC
2617 - HTTP Authentication' to keep it short. This will make it much
easier to scan a possibly very long list...
Andre already mentioned the HTTP RFC errata listing. Additionally, I'd
like to see the following link go in too:
http://www.rfc-editor.org/errata.html.
Another point to consider are some of the ISO specifications. I think
we should also mention such things as
Language Codes (ISO 639, http://www.loc.gov/standards/iso639-2/),
Country Codes (ISO 3166,
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-
lists/index.html) and also Language Tags (RFC 1766,
http://www.ietf.org/rfc/rfc1766.txt).
BTW, you'll find a nice, pre-compiled list of HTTP related RFCs at
http://ftp.ics.uci.edu/pub/ietf/http/#RFC and the RFC search-engine at
http://www.rfc-editor.org/cgi-bin/rfcsearch.pl is always your friend ;-)
Cheers,
Erik
Oh, and yes, please link to http instead of ftp resources.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Jason Lingohr <ja...@lucid.net.au>.
On Sat, Jun 28, 2003 at 12:54:45PM -0400, Joshua Slive wrote:
> > RFC2616 Hypertext Transfer Protocol (HTTP)
> > The Hypertext Transfer Protocol (HTTP) is an application-level protocol
> > for distributed, collaborative, hypermedia information systems.
> > Status: Draft standard
>
> Looks good to me.
Ok, how about this:
http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
I think Status should be near or at the top.
If this is ok, I'll go ahead.
I'm currently putting this in misc/, but won't commit until it has some
actual body.
Who should I talk to in dev about what RFC/STD's Apache actually adheres
to?
--
Jason Lingohr
jason@lucid.net.au
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Joshua Slive <jo...@slive.ca>.
On Sat, 28 Jun 2003, Astrid Keßler wrote:
> I'd also suggest a list rather then tables. Maybe something like:
>
> RFC2616 Hypertext Transfer Protocol (HTTP)
> The Hypertext Transfer Protocol (HTTP) is an application-level protocol
> for distributed, collaborative, hypermedia information systems.
> Status: Draft standard
Looks good to me.
> All books together present the httpd documentation.
> Banking on this idea, the standards list would fit into technical
> documentation. So I think, yes, it belongs to the docs like other stuff
> outside the manual.
>
> But since my idea is a long term prozess and may result into some
> restructuring of our pages, I'm not sure, where to put it now.
Why don't we go ahead and put it in the 2.0 docs. If we want to move it
later we can.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Astrid Keßler <ke...@kess-net.de>.
>> I've begun taking on the task of documenting all the drafts/standards that
>> Apache adheres to, as per the STATUS file and PR 16938.
>>
>> Before I march on too much more, I'd like some feedback on roughly how it's
>> looking and whatnot. Content isn't complete, nor is accuracy at this
>> point.
>>
>> http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
[...]
> For your doc, I'd tend to try to avoid tables. In general, we use tables
> as little as possible in the docs, and we use them only for truly tabular
> data. In this doc, I'd probably lean towards using a <dl> or something of
> the sort instead of a table.
I'd also suggest a list rather then tables. Maybe something like:
RFC2616 Hypertext Transfer Protocol (HTTP)
The Hypertext Transfer Protocol (HTTP) is an application-level protocol
for distributed, collaborative, hypermedia information systems.
Status: Draft standard
> The other question is does this belong in the manual, or should it be
> maintained on the website alone, as it has been in the past:
> http://httpd.apache.org/library/
> I don't have a strong opinion about that. In either case, an update is
> much needed.
I have been slighty thinking of an idea to collect all httpd
corresponding documentation together to some books like
- short introduction for beginners
- users manual
- technical documentation
- introduction for developers
- ...
All books together present the httpd documentation.
Banking on this idea, the standards list would fit into technical
documentation. So I think, yes, it belongs to the docs like other stuff
outside the manual.
But since my idea is a long term prozess and may result into some
restructuring of our pages, I'm not sure, where to put it now.
Hm, just a thought ...
Kess
> Joshua.
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
> For additional commands, e-mail: docs-help@httpd.apache.org
Viele Grüße
Kess
E-Mail: kess@kess-net.de
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Joshua Slive <jo...@slive.ca>.
On Sat, 28 Jun 2003, Jason Lingohr wrote:
> I've begun taking on the task of documenting all the drafts/standards that
> Apache adheres to, as per the STATUS file and PR 16938.
>
> Before I march on too much more, I'd like some feedback on roughly how it's
> looking and whatnot. Content isn't complete, nor is accuracy at this
> point.
>
> http://icarus.apache.org/~jsl/httpd-2.0/manual/relevant_standards.html.en
>
> Opinions welcome, and could someone explain to me the syntax of
> <columnspec><column width=""/> (units used, etc) tag, as I'm not
> seeing those widths get translated into HTML tags.
<columnspec> is presently only used in the LaTeX transform. The width
units are a fraction of the total line-width.
For your doc, I'd tend to try to avoid tables. In general, we use tables
as little as possible in the docs, and we use them only for truly tabular
data. In this doc, I'd probably lean towards using a <dl> or something of
the sort instead of a table.
The other question is does this belong in the manual, or should it be
maintained on the website alone, as it has been in the past:
http://httpd.apache.org/library/
I don't have a strong opinion about that. In either case, an update is
much needed.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: Beginnings of a standards document
Posted by Jason Lingohr <ja...@lucid.net.au>.
Ok, the appropriate files have been added/modified/committed.
A few notes:
1. I don't know the standard/style of getting the Trademark symbol into
XML, so I've left it as is (w3.org have a TM on the end of some things)
2. Obviously it isn't complete.
--
Jason Lingohr
jason@lucid.net.au
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org