Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 10 Feb 2021 15:07:16 +0100
From:      Daniel Ebdrup Jensen <debdrup@FreeBSD.org>
To:        freebsd-doc@freebsd.org
Subject:   Re: Regarding AsciiDoctor and long lines
Message-ID:  <20210210140716.pr6up7uxjdf2gydu@nerd-thinkpad.local>
In-Reply-To: <CAL2%2B-iWpZQi-x4cMLqCMuMH22REirEChP6__m%2B5gd_ZRBwqvGg@mail.gmail.com>
References:  <20210210135028.u2mm3bhwgep557vu@nerd-thinkpad.local> <CAL2%2B-iWpZQi-x4cMLqCMuMH22REirEChP6__m%2B5gd_ZRBwqvGg@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help

--ck6fjlkzsm4eqmjg
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Disposition: inline

On Wed, Feb 10, 2021 at 02:57:34PM +0100, Andreas B wrote:
>Have you considered one sentence per line?
>
>Ref. https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line.
>
>Andreas
>
>On Wed, Feb 10, 2021 at 2:50 PM Daniel Ebdrup Jensen
><debdrup@freebsd.org> wrote:
>>
>> Hi folks,
>>
>> Pursuant to a conversation that was had on #bsddocs on EFnet, this is
>> mostly me wondering if we can adopt a new standard practice.
>>
>> Since the AsciiDoctor conversion, it's become evident that reading diffs
>> which exceed the usual 72 columns that FreeBSD has standardized on for
>> style(9) is less than great, especially as some of the sentences in the
>> documentation can be rather long.
>>
>> So I would love if it we can agree to wrap/justify lines to 72 columns,
>> going forward whenever we touch files.
>>
>> I've already started doing this on the handbook/x11 chapter update that
>> I'm working on, and it's in line with what we're used to from DocBook,
>> so I don't think it's too much of a big ask? :)
>>
>> We also need to decide about it relatively soon, since the Weblate
>> project needs to know about about it, as it involves their use of .so
>> files (although the details somewhat escaped me when I read it after
>> staying up all night, so perhaps a domain expert can fill in the blanks
>> here?).
>>
>> For reference, my testing had led me to believe that AsciiDoctor doesn't
>> care one bit how it's styled, as long as the actual markup is kept the
>> same.
>>
>> I'm open to feedback about it, of course, but it seems like a very
>> sensible change to me.
>>
>> Yours hopefully,
>> Daniel Ebdrup Jensen
>_______________________________________________
>freebsd-doc@freebsd.org mailing list
>https://lists.freebsd.org/mailman/listinfo/freebsd-doc
>To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org"

Sure, that seems like a nice compromise.

I mostly want some kind of consensus so we can move forward without
having to deal with these extremely long lines. ;)

Yours,
Daniel Ebdrup Jensen

--ck6fjlkzsm4eqmjg
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQGSBAABCgB9FiEEDonNJPbg/JLIMoS6Ps5hSHzN87oFAmAj6JRfFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDBF
ODlDRDI0RjZFMEZDOTJDODMyODRCQTNFQ0U2MTQ4N0NDREYzQkEACgkQPs5hSHzN
87pIxgf4yS9Sgck7ysrufZKHFBFUVAW4yxvJm/COs12w8rFsMgm3OWhK8X0D43IV
CS6vzGGt5fzkUeA9cCUbzMEPe3jshbEPy0LhyuosAWmE5UCn53xk+BlxfQjSD1DU
VJrAXV+ZTvJwhsQU2H5dMwX9Ltsnk8KYF1ZwDojwCh5q3h3Dua4XlRNmiOntGa4V
1OFmS/TmyOtk5LSj91hE25vjie1Lv64qrOYz2HrrfIKJFaL0x+80RofHUqt4yU/v
VhPGfbx0S11X9ISSTKJLquQbm4kIce+bOx958Q4fdeZW1St56jduTGSmVliMHzAA
/RQiaxFdNaoH9W9HIm8DNgsC1O/r
=Zplf
-----END PGP SIGNATURE-----

--ck6fjlkzsm4eqmjg--



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