Rodent of Unusual Size | 1 Dec 2005 05:51
Picon
Favicon

[STATUS] (httpd-docs-2.0) Wed Nov 30 23:51:48 2005

Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2004-11-21 09:35:21 -0500 (Sun, 21 Nov 2004) $

For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/

This document contains only documentation issues related to 2.0 alone.
For general documentation issues, or those that relate both to 2.0 and
to future versions, please see the same file in httpd-2.0 HEAD.
Noirin Plunkett | 1 Dec 2005 08:33

Re: 2.2 Announcement comma - Please no comma before 'and'

On Wed, Nov 30, 2005 at 11:07:27PM -0000, Chris and/or Diana Johns wrote:
> With regard to Noirin Plunkett's suggestion for consistency (unless it was
> 'tongue in cheek'), I'd suggest that consistency would be better achieved by
> getting Harvard to take out any 'Harvard commas' that precede the word 'and'
> in other instances similar to the example given, which was:

No, it was in earnest. Whether or not to use the commas is a decision
for the author. However, the document should be internally consistent.
This was the one example I noted without the Oxford comma, and I always
feel it's best to go with the majority, in questions of style.

> If 'Harvard' won't agree, then possibly a better way to avoid the
> inconsistency, if that's so important, would be to spread the sentiments
> expressed over two sentences, viz.
> "
> We consider this release to be the best version of Apache available.
> We therefore encourage users of all prior versions to upgrade.
> "

That would also be fine

> But I'd much prefer 'Harvard' to have written English in the first place.

You'll note that the Harvard comma is also regularly referred to as the
Oxford comma. It's not confined to the New World, by any means. It's a
style issue, and I don't think there's any right or wrong answer.

Noirin
Maxime Petazzoni | 1 Dec 2005 14:10
Gravatar

Re: 2.2 Announcement comma - Please no comma before 'and'

> You'll note that the Harvard comma is also regularly referred to as
> the Oxford comma. It's not confined to the New World, by any
> means. It's a style issue, and I don't think there's any right or
> wrong answer.

The word 'and' already act as a link between the two parts of the
sentence. Adding a comma before it is useless. If you real want to use
a comma-like séparator, you can use a semicolon and remove the 'and'.

In French for example, this rule apply and I believe it is the same in
English.

My 2 ¢,
- Sam

--

-- 
Maxime Petazzoni (http://www.bulix.org)
 -- gone crazy, back soon. leave message.
Goddard Lee | 1 Dec 2005 15:01

RE: 2.2 Announcement comma - Please no comma before 'and'

As was pointed out before, this is a very old argument: it's the Oxford comma to me, and I personally like it,
but it is a matter of style. It can, has been, and often is argued both ways. 

I think the massive volume of debate available on this matter indicates that someone needs to impose an
executive decision, and not worry too much about their explanation...

- An Innocent By-stander
Joshua Slive | 2 Dec 2005 21:07
Picon

Re: /docs/ redirect and 2.2


In my usual spirit of pigheadedness, I've tried to end this debate by 
just taking some action.  I've redirected http://httpd.apache.org/docs/ 
to an index page but left all the other pages under docs/ redirecting to 
the 1.3 version.  I then added a note on every 1.3 page pointing back to 
the index.  It would also be possible to use a little SSI (or other 
magic) to point the 1.3 docs pages directly to a corresponding page in 
2.2.  If someone feels like doing that, go ahead.  But you'll also need 
to add an errordocument to help for pages that aren't equivalent.

(If people find the note at the top of all the 1.3 pages annoying, we 
could also make that conditional on the referer being non-apache.org.  I 
don't particularly care.)

Joshua.
Joshua Slive | 2 Dec 2005 22:21
Picon

pdf for 2.2

I've dropped a pdf version of the 2.2 docs at
http://www.apache.org/dist/httpd/docs/httpd-docs-2.2.0.en.pdf
(and soon to be on the mirrors).

It seems to still work pretty well, even though I haven't done too much 
work on the pdf generation process lately.  The <program> and <glossary> 
elements aren't doing anything useful, and some pages (like the new 
filters page) look really horrible.  But overall I think it is very 
usable.  (Make sure you have some serious toner in your printer if you 
want it on paper; it's now 726 pages.)

Instructions on generating this are on the bottom of this page:
http://httpd.apache.org/docs-project/docsformat.html

Let me know if you see any major problems.

Joshua.
Colm MacCarthaigh | 3 Dec 2005 09:02
Gravatar

Re: /docs/ redirect and 2.2

On Fri, Dec 02, 2005 at 03:07:56PM -0500, Joshua Slive wrote:
> In my usual spirit of pigheadedness, I've tried to end this debate by 
> just taking some action.  I've redirected http://httpd.apache.org/docs/ 
> to an index page but left all the other pages under docs/ redirecting to 
> the 1.3 version.

Thanks!
--

-- 
Colm MacCárthaigh                        Public Key: colm+pgp <at> stdlib.net
André Malo | 3 Dec 2005 09:21
Picon

Re: svn commit: r351702 - /httpd/httpd/branches/2.2.x/Makefile.win

* Joshua Slive wrote:

> I highly doubt that many people use the bundled docs.  They are not
> browsable on a default configuration and certainly require the server to
> be running before they are usable, which means they are of little help
> to upgraders.  We also build windows-help format docs, which would be
> much more appropriate for win32 users, but I don't think we have those
> for 2.2 yet.

Ah yes. This is, because my box crashed some time ago and I don't have a 
working windows installation yet. Anyone around here with about an hour to 
spare for booting (!) into each language (de, en, es, ja, ko) and building 
the chm docs? I'm happy to help through the process. (The necessary 
settings and requirements are also described the `build` help).

nd
--

-- 
Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook.
Ook! Ook? Ook. Ook? Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook.
Ook. Ook. Ook. Ook. Ook? Ook. Ook! Ook! Ook? Ook! Ook. Ook? Ook. Ook.
Ook. Ook. Ook. Ook. Ook! Ook. Ook! Ook! Ook! Ook!           Ook! Ook.
André Malo | 3 Dec 2005 23:12
Picon

Re: svn commit: r351821 - in /httpd/httpd/branches/2.0.x/docs/manual/style/xsl: common.xsl quickreference.xsl

* slive <at> apache.org wrote:

> Modified:
> httpd/httpd/branches/2.0.x/docs/manual/style/xsl/quickreference.xsl URL:
> http://svn.apache.org/viewcvs/httpd/httpd/branches/2.0.x/docs/manual/styl
>e/xsl/quickreference.xsl?rev=351821&r1=351820&r2=351821&view=diff
> =========================================================================
>===== ---
> httpd/httpd/branches/2.0.x/docs/manual/style/xsl/quickreference.xsl
> (original) +++
> httpd/httpd/branches/2.0.x/docs/manual/style/xsl/quickreference.xsl Fri
> Dec  2 11:47:55 2005  <at>  <at>  -179,7 +179,7  <at>  <at> 
>              <xsl:attribute name="class">odd</xsl:attribute>
>          </xsl:if>
>
> -        <td colspan="4" class="descr">
> +        <td class="descr">
>              <xsl:choose>
>              <xsl:when test="string-length(normalize-space(description))
> &gt; 0"> <xsl:apply-templates select="description"/>
>  <at>  <at>  -189,6 +189,19  <at>  <at> 
>              </xsl:otherwise>
>              </xsl:choose>
>          </td>
> +
> +        <td>
> +           <code class="module">
> +             <a href="{../name}.html">
> +                <xsl:value-of select="../name"/>
> +             </a>
(Continue reading)

Astrid 'Kess' Keßler | 4 Dec 2005 00:08
Picon

Re: svn commit: r351702 - /httpd/httpd/branches/2.2.x/Makefile.win

On Saturday 03 December 2005 09:21, André Malo wrote:
> * Joshua Slive wrote:
> > I highly doubt that many people use the bundled docs.  They are not
> > browsable on a default configuration and certainly require the server to
> > be running before they are usable, which means they are of little help
> > to upgraders.  We also build windows-help format docs, which would be
> > much more appropriate for win32 users, but I don't think we have those
> > for 2.2 yet.
>
> Ah yes. This is, because my box crashed some time ago and I don't have a
> working windows installation yet. Anyone around here with about an hour to
> spare for booting (!) into each language (de, en, es, ja, ko) and building
> the chm docs? I'm happy to help through the process. (The necessary
> settings and requirements are also described the `build` help).
>
> nd

been there, got nd's help, done that ;)

kess

Gmane