You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@httpd.apache.org by Dean Gaudet <dg...@arctic.org> on 1998/02/05 21:25:11 UTC
Re: cvs commit: apache-1.3/htdocs/manual/vhosts details.html details_1_2.html examples.html fd-limits.html host.html ip-based.html name-based.html vhosts-in-depth.html virtual-host.html
Do we really have to do this? I don't recall us ever voting on html style
guides or anything like that. Not that I want to waste time voting on
something like that. I just really can't read some of the "corrections"
you're making to the html. Multi-line <a> tags are just terrible.
<AND ALL UPPERCASE HURTS MY EARS>
</dean>
On 5 Feb 1998 coar@hyperreal.org wrote:
> coar 98/02/05 12:05:20
>
> Modified: htdocs/manual bind.html cgi_path.html
> content-negotiation.html custom-error.html
> dns-caveats.html env.html handler.html index.html
> install.html invoking.html keepalive.html
> location.html multilogs.html new_features_1_0.html
> new_features_1_1.html new_features_1_2.html
> new_features_1_3.html sections.html
> sourcereorg.html stopping.html
> upgrading_to_1_3.html windows.html
> htdocs/manual/misc API.html client_block_api.html
> custom_errordocs.html howto.html
> known_client_problems.html perf-tuning.html
> perf.html
> htdocs/manual/mod core.html mod_access.html mod_actions.html
> mod_alias.html mod_asis.html mod_auth.html
> mod_auth_anon.html mod_auth_db.html
> mod_auth_dbm.html mod_autoindex.html
> mod_browser.html mod_cern_meta.html mod_cgi.html
> mod_cookies.html mod_digest.html mod_dir.html
> mod_dld.html mod_dll.html mod_env.html
> mod_headers.html mod_imap.html mod_include.html
> mod_info.html mod_isapi.html mod_log_agent.html
> mod_log_common.html mod_log_config.html
> mod_log_referer.html mod_mime.html
> mod_mime_magic.html mod_negotiation.html
> mod_proxy.html mod_rewrite.html mod_so.html
> mod_speling.html mod_status.html mod_unique_id.html
> mod_userdir.html mod_usertrack.html
> htdocs/manual/vhosts details.html details_1_2.html
> examples.html fd-limits.html host.html
> ip-based.html name-based.html vhosts-in-depth.html
> virtual-host.html
> Log:
> Another pass at the normalisation of the HTML tags. Some
> corrections coming up.
Re: cvs commit: apache-1.3/htdocs/manual/vhosts details.html
details_1_2.html examples.html fd-limits.html host.html ip-based.html
name-based.html vhosts-in-depth.html virtual-host.html
Posted by Rodent of Unusual Size <Ke...@Golux.Com>.
Dean Gaudet wrote:
>
> Well, you better have automated scripts, because I'm not going to expend
> the extra keystrokes just to <B>UPPERCASE</B> the tags in documentation I
> add. It's just not worth ruining my wrists. And that, imnsho, is far
> more important than finding the prose in the documentation.
Not a problem; as I've mentioned previously, I don't expect anyone to
change their upper/lowercase tag style. I'll just keep it consistent
periodically.
> While we're on this topic. The apache code indentation width is 4 spaces.
> Our documentation doesn't follow this convention. I've never understood
> why there's the bizarre indentation in the src/CHANGES file for example.
Don't ask me..
> And many of your doc changes are using 1 or 2 space indentations.
Indentation within a tag split across multiple lines (like a very long
A tag) is just to line the arguments up with the tag name; that's the
only rule I apply there. As for elsewhere.. well, I've generally tried
to disturb any existing intradocument convention (hah!) as little as
possible, but I've kept indentation to single spaces because of the load
they put on bandwidth when fetched from the host site. Using an indent
level of 4 doesn't bother me per se, but it's definitely going to impact
the traffic to Taz and our mirror hosts. I have personal preferences,
but I remember Roy turning "<HTML>\n<HEAD\n<TITLE>" into
"<HTML><HEAD><TITLE>" in a submitted patch because he doesn't like
newlines.
I wouldn't mind a rational style guide. What I'm going to post in the
apache-devsite in a few days will be your basic straw proposal.
#ken P-)}
Re: cvs commit: apache-1.3/htdocs/manual/vhosts details.html details_1_2.html examples.html fd-limits.html host.html ip-based.html name-based.html vhosts-in-depth.html virtual-host.html
Posted by Dean Gaudet <dg...@arctic.org>.
Well, you better have automated scripts, because I'm not going to expend
the extra keystrokes just to <B>UPPERCASE</B> the tags in documentation I
add. It's just not worth ruining my wrists. And that, imnsho, is far
more important than finding the prose in the documentation.
While we're on this topic. The apache code indentation width is 4 spaces.
Our documentation doesn't follow this convention. I've never understood
why there's the bizarre indentation in the src/CHANGES file for example.
And many of your doc changes are using 1 or 2 space indentations.
Dean
On Thu, 5 Feb 1998, Rodent of Unusual Size wrote:
> Dean Gaudet wrote:
> >
> > Do we really have to do this? I don't recall us ever voting on html style
> > guides or anything like that. Not that I want to waste time voting on
> > something like that. I just really can't read some of the "corrections"
> > you're making to the html.
>
> No, we didn't vote on a style guide. (I'm writing one to propose.) However,
> whatever we end up with in our documentation should be a) uniform and
> consistent, and b) easily readable. I've mentioned several times over
> the last eight months or so that I wanted to do this. The responses I
> got were a couple of whinges about how some individual didn't like it
> (but didn't make a counter-proposal or offer to maintain the docs),
> and one person saying that if I was going to go to the effort to clean
> up and normalise the HTML then it was my privilege to do it according
> to my own preferences. I have some time and inclination, and I'm not
> going to wait for another pointless interminable discussion to never
> resolve itself.
>
> > Multi-line <a> tags are just terrible.
>
> Lines longer than 80 characters - particularly so much so that they
> wrap several times - are worse, IMNSHO.
>
> > <AND ALL UPPERCASE HURTS MY EARS>
>
> What, is your monitor tied into your Speak&Spell? <g> Seriously, in
> normal prose, I definitely agree. In source code I agree. But in
> something like a markup document, I have found over the last decade+
> that it's a *lot* easier to figure out what's going on if the prose
> and the markup are easily distinguishable. Since the prose needs to
> be mixed- and mostly lower-case, that means the markup gets to be..
> uppercase.
>
> #ken P-)}
>
Re: cvs commit: apache-1.3/htdocs/manual/vhosts details.html
details_1_2.html examples.html fd-limits.html host.html ip-based.html
name-based.html vhosts-in-depth.html virtual-host.html
Posted by Rodent of Unusual Size <Ke...@Golux.Com>.
Dean Gaudet wrote:
>
> Do we really have to do this? I don't recall us ever voting on html style
> guides or anything like that. Not that I want to waste time voting on
> something like that. I just really can't read some of the "corrections"
> you're making to the html.
No, we didn't vote on a style guide. (I'm writing one to propose.) However,
whatever we end up with in our documentation should be a) uniform and
consistent, and b) easily readable. I've mentioned several times over
the last eight months or so that I wanted to do this. The responses I
got were a couple of whinges about how some individual didn't like it
(but didn't make a counter-proposal or offer to maintain the docs),
and one person saying that if I was going to go to the effort to clean
up and normalise the HTML then it was my privilege to do it according
to my own preferences. I have some time and inclination, and I'm not
going to wait for another pointless interminable discussion to never
resolve itself.
> Multi-line <a> tags are just terrible.
Lines longer than 80 characters - particularly so much so that they
wrap several times - are worse, IMNSHO.
> <AND ALL UPPERCASE HURTS MY EARS>
What, is your monitor tied into your Speak&Spell? <g> Seriously, in
normal prose, I definitely agree. In source code I agree. But in
something like a markup document, I have found over the last decade+
that it's a *lot* easier to figure out what's going on if the prose
and the markup are easily distinguishable. Since the prose needs to
be mixed- and mostly lower-case, that means the markup gets to be..
uppercase.
#ken P-)}