Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 12 Oct 2011 22:16:08 +0200
From:      Ulrich =?utf-8?B?U3DDtnJsZWlu?= <uqs@spoerlein.net>
To:        Benedict Reuschling <bcr@freebsd.org>
Cc:        Niclas Zeising <niclas.zeising@gmail.com>, cvs-doc@freebsd.org, doceng@freebsd.org, cvs-all@freebsd.org, Glen Barber <gjb@freebsd.org>, doc-committers@freebsd.org
Subject:   Re: cvs commit: doc/en_US.ISO8859-1/books/handbook/bsdinstall chapter.sgml
Message-ID:  <20111012201607.GJ26743@acme.spoerlein.net>
In-Reply-To: <4E95CA78.6040503@FreeBSD.org>
References:  <201110101729.p9AHTQg7030262@repoman.freebsd.org> <20111012132723.GH26743@acme.spoerlein.net> <4E9596B2.9000909@FreeBSD.org> <4E95981E.2070303@gmail.com> <4E9598FD.2010801@FreeBSD.org> <20111012164101.GI26743@acme.spoerlein.net> <4E95CA78.6040503@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, 2011-10-12 at 19:12:24 +0200, Benedict Reuschling wrote:
> Am 12.10.11 18:41, schrieb Ulrich Spörlein:
> > On Wed, 2011-10-12 at 09:41:17 -0400, Glen Barber wrote:
> >> On 10/12/11 9:37 AM, Niclas Zeising wrote:
> >>> On 10/12/11 15:31, Glen Barber wrote:
> >>>> On 10/12/11 9:27 AM, Ulrich Spörlein wrote:
> >>>>> On Mon, 2011-10-10 at 17:29:26 +0000, Glen Barber wrote:
> >>>>>> gjb         2011-10-10 17:29:26 UTC
> >>>>>>
> >>>>>>    FreeBSD doc repository
> >>>>>>
> >>>>>>    Modified files:
> >>>>>>      en_US.ISO8859-1/books/handbook/bsdinstall chapter.sgml
> >>>>>>    Log:
> >>>>>>    Use two spaces between end of sentence and beginning of sentence.
> >>>>>>
> >>>>>>    Revision  Changes    Path
> >>>>>>    1.9       +10 -10   
> >>>>>> doc/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml
> >>>>>
> >>>>> Why oh why? Please stop doing that, it's pointless, annoying and will
> >>>>> get lost with paragraph reformatting eventually and is not significant
> >>>>> in the generated output.
> >>>>>
> >>>>
> >>>> It follows the FDP standards as noted directly before Chapter 10.1 here:
> >>>>
> >>>> http://www.freebsd.org/doc/en/books/fdp-primer/writing-style.html
> >>>>
> >>>
> >>> From what I've come to understand it does not matter for the rendered
> >>> output. 
> >>
> >> The only "significant" spaces in SGML/HTML output is "&nbsp;".
> >>
> >>> It makes the source (i.e. sgml file) more readable though.
> >>
> >> In addition to being "proper" writing style.
> > 
> > Yes, the 20th century called and wants you to return your typewriter.
> > 
> > Please stop this double-spaced end of sentence madness.
> > http://www.slate.com/articles/technology/technology/2011/01/space_invaders.html
> 
> I've read the article, but my experience is the complete opposite. In
> school we learned that there is one space after the full stop. I do not
> find a single email in my work email nor in FreeBSD emails from users of
> all ages that use two spaces, either. My guess is that nowadays, this
> two spaces thing has been indeed been a thing of the past an no one uses
> it anymore (or they are simply too lazy to hit the spacebar a  second time).
> 
> When I learned the ways of being a doc committer, I was under the
> impression that it was project convention (similar to style(9)), but I
> did not ask and ran with it. Probably a good example for not taking
> anything for granted and question some of the this that have been done
> since "the dawn of time(tm)".
> 
> My suggestion is that we involve doceng@ (which I did in CC) and ask for
> a decision. A patch to the fdp-primer correcting this should be fairly
> easy, changing what nearly every doc committer has learned during
> his/her mentee phase in this regard is a different story.
> 
> I propose that once we decide to use just one single space in the
> future, that new documents which are added to the doc tree should use
> this new convention, but old documents should not be changed. This
> reduces the amount of work for translators immensely. PRs that are being
> filed with sweeping doc patches to correct this in old documents should
> also be closed with a reference to the policy.
> 
> Your thoughts on this?

For the SGML case, people should use whatever they want. They should
also accept that different authors do it differently and not commit
patches that simply change single to double spacing or vice versa.

I'd drop this suggestion from the fdp-primer, as it only fuels pointless
debates on cvs-doc :). How does it make life easier for emacs using
folk?

Cheers,
Uli



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20111012201607.GJ26743>