Date: Tue, 31 Jan 2023 16:47:02 +0800 From: ykla <yklaxds@gmail.com> To: Mathieu Arnold <mat@freebsd.org> Cc: Sergio Carlavilla <carlavilla@freebsd.org>, doceng@freebsd.org, "freebsd-doc@FreeBSD.org" <freebsd-doc@freebsd.org> Subject: Re: To be deprecated [.filename]## tag in the document? Message-ID: <CA%2BPGaYC-_zudANd5ZUH=_rJj69w5JYRkSVs_t9ziDXQuUqc=4g@mail.gmail.com> In-Reply-To: <20230131080243.zsxwgvx6qxfjjdc3@aching.in.mat.cc> 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> <20230131080243.zsxwgvx6qxfjjdc3@aching.in.mat.cc>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] So why not just use markdown, which is simpler and easier for more people to learn? Just like vuepress https://handbook.bsdcn.org/ . Mathieu Arnold <mat@freebsd.org> 于2023年1月31日周二 16:02写道： > 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ó: > > > > > > > > > Hi, > > > > > > > > > > I see that in some sections the [.filename]# # tags have been > replaced > > > > > with ` `, which does not effectively distinguish between folders, > device > > > > > 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 > > > > Hi, > > > > > This feels like a regression, docbook allowed us to mark things up > > > semantically, > > > > Yes, but this is in Docbook, not in AsciiDoc. > > > > For AsciiDoc the syntax [.whatever]## is to declare a class for the CSS > parser. > > The result in the HTML, PDF and EPUB will be the same. > > Using [.whatever]## or ``. > > > > Personally, for me it is easier to read/write `` instead of the other > option. > > But not only in AsciiDoc, algo in Github MD, Gitlab MD, etc. > > > > 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. > > -- > Mathieu Arnold > [-- Attachment #2 --] <div dir="ltr">So why not just use markdown, which is simpler and easier for more people to learn? Just like vuepress <a href="https://handbook.bsdcn.org/">https://handbook.bsdcn.org/</a>; .<br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">Mathieu Arnold <<a href="mailto:mat@freebsd.org">mat@freebsd.org</a>> 于2023年1月31日周二 16:02写道：<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Mon, Jan 30, 2023 at 12:43:27PM +0100, Sergio Carlavilla wrote:<br> > On Mon, 30 Jan 2023 at 12:31, Mathieu Arnold <<a href="mailto:mat@freebsd.org" target="_blank">mat@freebsd.org</a>> wrote:<br> > ><br> > > On Mon, Jan 30, 2023 at 11:36:05AM +0100, Sergio Carlavilla wrote:<br> > > > El jue., 26 ene. 2023 8:21, ykla <<a href="mailto:yklaxds@gmail.com" target="_blank">yklaxds@gmail.com</a>> escribió:<br> > > ><br> > > > > Hi,<br> > > > ><br> > > > > I see that in some sections the [.filename]# # tags have been replaced<br> > > > > with ` `, which does not effectively distinguish between folders, device<br> > > > > symbols and specific commands, etc.<br> > > > ><br> > > > > Are there any plans for FreeBSD to do this across the board in the<br> > > > > future? I.e., do we need to do away with the [.filename]# # tag?<br> > > > ><br> > > > > ykla<br> > > > > .<br> > > > ><br> > > ><br> > > > Hi,<br> > > ><br> > > > Yes, the idea is to remove the [.filename]## tag and use ``<br> > > ><br> > > > This is from the migration of Docbook to AsciiDoc.<br> > ><br> > > But, why?<br> > ><br> > > This feels like a regression, docbook allowed us to mark things up<br> > > semantically, like, we would know what was a variable, a filename, a<br> > > code block... The idea was to be able to differentiate things, and let<br> > > the rendering do the right thing.<br> > > If I see [.filename]#PKG# I clearly see it refers to a filename, they<br> > > used to be rendered as fixed with, in some color, so that they could be<br> > > differentiated from other fixed width stuff.<br> > > If I see `PKG` I just see something that will be rendered with a fixed<br> > > with font, but I have no idea what it refers to.<br> > ><br> > > --<br> > > Mathieu Arnold<br> > <br> > Hi,<br> > <br> > > This feels like a regression, docbook allowed us to mark things up<br> > > semantically,<br> > <br> > Yes, but this is in Docbook, not in AsciiDoc.<br> > <br> > For AsciiDoc the syntax [.whatever]## is to declare a class for the CSS parser.<br> > The result in the HTML, PDF and EPUB will be the same.<br> > Using [.whatever]## or ``.<br> > <br> > Personally, for me it is easier to read/write `` instead of the other option.<br> > But not only in AsciiDoc, algo in Github MD, Gitlab MD, etc.<br> > <br> > But of course, this is my personal opinion, if you think is better to<br> > use the old syntax, please send an email to doceng@<br> > Of course, this kind of changes must be decided by the entire Doceng@<br> > not only a member of them.<br> <br> This is exactly my point, if you write `foo`, you cannot affect the<br> rendering so that variable `foo` is different than filename `foo` or<br> code block `foo`, which is why we should keep [.filename]#foo#, and if<br> it was ever a thing, [.variable]#foo#, so that rendering can be made<br> different, and people reading the documentation have a better<br> experience, like, if something is in fixed width font, and in green,<br> (which was the color when we used docbook, I think,) then I know it's a<br> filename, I don't have to figure it out by using context.<br> <br> -- <br> Mathieu Arnold<br> </blockquote></div>home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CA%2BPGaYC-_zudANd5ZUH=_rJj69w5JYRkSVs_t9ziDXQuUqc=4g>