Date: Tue, 31 Jan 2023 09:02:43 +0100 From: Mathieu Arnold <mat@freebsd.org> To: Sergio Carlavilla <carlavilla@freebsd.org>, doceng@freebsd.org Cc: ykla <yklaxds@gmail.com>, "freebsd-doc@FreeBSD.org" <freebsd-doc@freebsd.org> Subject: Re: To be deprecated [.filename]## tag in the document? Message-ID: <20230131080243.zsxwgvx6qxfjjdc3@aching.in.mat.cc> In-Reply-To: <CAFwocyN=itM2OTjfstiLk6FMxqvktJSs7_MguaHbhSw=WGX9Jg@mail.gmail.com> References: <CA%2BPGaYChwV0uZi4y6fdLwFwX396tbUTzgGS7hCuxwT1LhRYr0g@mail.gmail.com> <CAFwocyO_2gzyG=qN4eiOyR12MrYBhq80mbUEB7qf6X110n5VSA@mail.gmail.com> <20230130113056.rxdp4ajyh5adayl4@aching.in.mat.cc> <CAFwocyN=itM2OTjfstiLk6FMxqvktJSs7_MguaHbhSw=WGX9Jg@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--2dftrqrd3isqa7yv Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Jan 30, 2023 at 12:43:27PM +0100, Sergio Carlavilla wrote: > On Mon, 30 Jan 2023 at 12:31, Mathieu Arnold <mat@freebsd.org> wrote: > > > > On Mon, Jan 30, 2023 at 11:36:05AM +0100, Sergio Carlavilla wrote: > > > El jue., 26 ene. 2023 8:21, ykla <yklaxds@gmail.com> escribi=F3: > > > > > > > Hi, > > > > > > > > I see that in some sections the [.filename]# # tags have been repla= ced > > > > with ` `, which does not effectively distinguish between folders, d= evice > > > > symbols and specific commands, etc. > > > > > > > > Are there any plans for FreeBSD to do this across the board in the > > > > future? I.e., do we need to do away with the [.filename]# # tag? > > > > > > > > ykla > > > > . > > > > > > > > > > Hi, > > > > > > Yes, the idea is to remove the [.filename]## tag and use `` > > > > > > This is from the migration of Docbook to AsciiDoc. > > > > But, why? > > > > This feels like a regression, docbook allowed us to mark things up > > semantically, like, we would know what was a variable, a filename, a > > code block... The idea was to be able to differentiate things, and let > > the rendering do the right thing. > > If I see [.filename]#PKG# I clearly see it refers to a filename, they > > used to be rendered as fixed with, in some color, so that they could be > > differentiated from other fixed width stuff. > > If I see `PKG` I just see something that will be rendered with a fixed > > with font, but I have no idea what it refers to. > > > > -- > > Mathieu Arnold >=20 > Hi, >=20 > > This feels like a regression, docbook allowed us to mark things up > > semantically, >=20 > Yes, but this is in Docbook, not in AsciiDoc. >=20 > For AsciiDoc the syntax [.whatever]## is to declare a class for the CSS p= arser. > The result in the HTML, PDF and EPUB will be the same. > Using [.whatever]## or ``. >=20 > Personally, for me it is easier to read/write `` instead of the other opt= ion. > But not only in AsciiDoc, algo in Github MD, Gitlab MD, etc. >=20 > But of course, this is my personal opinion, if you think is better to > use the old syntax, please send an email to doceng@ > Of course, this kind of changes must be decided by the entire Doceng@ > not only a member of them. This is exactly my point, if you write `foo`, you cannot affect the rendering so that variable `foo` is different than filename `foo` or code block `foo`, which is why we should keep [.filename]#foo#, and if it was ever a thing, [.variable]#foo#, so that rendering can be made different, and people reading the documentation have a better experience, like, if something is in fixed width font, and in green, (which was the color when we used docbook, I think,) then I know it's a filename, I don't have to figure it out by using context. --=20 Mathieu Arnold --2dftrqrd3isqa7yv Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQITBAABCgB9FiEE9XJBpJetWizkEBUef2IOCp6dQb4FAmPYyyNfFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldEY1 NzI0MUE0OTdBRDVBMkNFNDEwMTUxRTdGNjIwRTBBOUU5RDQxQkUACgkQf2IOCp6d Qb45rwv/Y76j8QWD4kgXkVMf9bMBPup3zQ8HTI0ahnGvI6iQP1NAJOimET4bVLjT CZpzy7Q2q5gvmxhYJzo9gFsCxRYJctFmjrVlpmzKm06k1tfMbI1Mbs7iPavcx7lt QDhJpa1TzbaqssTOPAik2iXy4gSpswuz3j5NWL0JKftYpo0mmrKx/6oA4noQ3woB MkOiJ1FUq/qsC2DC26kGnXayLipGcM31KzNBrMRi7Cj6kTJv/UWsWx/GnWeTDSQt oVuxcFRzkJuD4rqz1Qp7FRa8HN8hnLuQWPfvRLYb9VsbMDXwu7Bf3EXPUcZ6JoJk d2RD7QsffxNKHZxU4PCvXB0ZtRt+UtYBDWHRsg70Jt5LRpeia/lqDWFYV7JUwxZb V5yKYS7HnvTU7v1P2KTQcT0p/fcjxmaYxD9QqC1W2F/sOAIufirTV15iWlNMTMyI MkzfSNsJek9LE6N65rlegw/8LVPqWkYYllOiNT1ahm2xIY3HwuoLdMcDUQ8uLEAj 9guIFUox =bOIy -----END PGP SIGNATURE----- --2dftrqrd3isqa7yv--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20230131080243.zsxwgvx6qxfjjdc3>