Mailing List Archive

On Sat, 9 Sep 2000, Rich Bowen wrote:

> In some of the docs, we have titles like "LogLevel directive", whereas
> in other places, we have things like "ThreadsPerChild." Although I
> realize that this is not a big deal, inconsistency like this is annoying
> to me. My preference is to omit the "directive" from each, but I
> wondered if there were any strong feelings one way or another on this
> issue. I don't necessarily intend to go through all the docs and remove
> it everywhere, but as I work on things, I could make the change as it
> comes up.
>
Which also brings up the question: Should there be a "style sheet" for
the modules files. The directives sections are mostly consistent (with
exceptions like you mention) but the top-matter varies a bit. Some have
the "Directives" title, while some don't. Some have an <HR> before the
directives, while some don't, etc.

Joshua

Rich Bowen wrote:
>
> My preference is to omit the "directive" from each

Consistency is good, but please remeber that a *lot* of things/places
link directly to directive description fragments, and someone might
follow a link and not have a lot of mental context about what
they'll see when they get there. Also remember that these sections
have a wide audience, from experts who have forgotten syntax details
to neophytes that have barely begun to use Apache. I don't see that
a couple of extra words are going to hurt anything, but whatever
the majority feels..
--
#ken P-)}

Ken Coar <http://Golux.Com/coar/>
Apache Software Foundation <http://www.apache.org/>
"Apache Server for Dummies" <http://Apache-Server.Com/>
"Apache Server Unleashed" <http://ApacheUnleashed.Com/>

Joshua Slive wrote:
>
> Which also brings up the question: Should there be a "style sheet" for
> the modules files.

I'd say yes.
--
#ken P-)}

Ken Coar <http://Golux.Com/coar/>
Apache Software Foundation <http://www.apache.org/>
"Apache Server for Dummies" <http://Apache-Server.Com/>
"Apache Server Unleashed" <http://ApacheUnleashed.Com/>

Rodent of Unusual Size wrote:
>
> Rich Bowen wrote:
> >
> > My preference is to omit the "directive" from each
>
> Consistency is good, but please remeber that a *lot* of things/places
> link directly to directive description fragments, and someone might
> follow a link and not have a lot of mental context about what
> they'll see when they get there. Also remember that these sections
> have a wide audience, from experts who have forgotten syntax details
> to neophytes that have barely begun to use Apache. I don't see that
> a couple of extra words are going to hurt anything, but whatever
> the majority feels..

Hmm. OK, good point. Well, since my main concern here is consistency,
then they should _all_ say 'directive'. It irks me that some do and some
don't. Once again, this is not a big deal, but just one of the things
that got hammered into me working with Tech. Pubs. at DataBeam corp. and
then at Lotus.

Rich