Re: Using tbl(1) for structure definitions

2022-08-13 Thread G. Branden Robinson
At 2022-08-13T16:26:43-0400, James K. Lowden wrote: > Ingo Schwarze wrote: > > The reason is not that mandoc tbl(7) to HTML conversion is bad but > > that a structure display *is not tabular data*. > > Ingo's point is irrefutable. Oh yeah? Prove it! ;-) > The goal of better output for structu

Re: Using tbl(1) for structure definitions

2022-08-13 Thread James K. Lowden
On Fri, 12 Aug 2022 17:41:40 +0200 Ingo Schwarze wrote: > The reason is not that mandoc tbl(7) to HTML conversion is bad but > that a structure display *is not tabular data*. Ingo's point is irrefutable. Whenever a technology is used toward an unintended end, problems inevitably arise. (I excl

Re: Using tbl(1) for structure definitions

2022-08-12 Thread Ingo Schwarze
Hi Alejandro, Alejandro Colomar wrote on Fri, Aug 12, 2022 at 05:58:32PM +0200: > Since I'm not 100% convinced by any of the ways to format structure > definitions in SYNOPSIS, I'm going to go for the status quo. Since > there weren't any structure definitions (at least that I know of) in > S

Re: Using tbl(1) for structure definitions

2022-08-12 Thread Alejandro Colomar
Hi Ingo and Branden, Since I'm not 100% convinced by any of the ways to format structure definitions in SYNOPSIS, I'm going to go for the status quo. Since there weren't any structure definitions (at least that I know of) in SYNOPSIS before my introduction, I'll go for what was used in DESCR

Re: Using tbl(1) for structure definitions

2022-08-12 Thread Ingo Schwarze
G. Branden Robinson wrote on Thu, Aug 11, 2022 at 04:46:12PM -0500: > At 2022-08-11T15:47:38+0200, Ingo Schwarze wrote: >> Alejandro Colomar wrote on Tue, Jul 26, 2022 at 10:09:44PM +0200: >>> I must say that the source code is really ugly (ugly as in, >>> someone reading it will probably have a h

Re: Using tbl(1) for structure definitions

2022-08-11 Thread G. Branden Robinson
At 2022-08-11T15:47:38+0200, Ingo Schwarze wrote: > Alejandro Colomar wrote on Tue, Jul 26, 2022 at 10:09:44PM +0200: > > I must say that the source code is really ugly (ugly as in, > > someone reading it will probably have a hard time modifying it, > > without reading tbl(1)). > > Completely true

Re: Using tbl(1) for structure definitions

2022-08-11 Thread Ingo Schwarze
Hi Alejandro, Alejandro Colomar wrote on Tue, Jul 26, 2022 at 10:09:44PM +0200: > I must say that the source code is really ugly (ugly as in, > someone reading it will probably have a hard time modifying it, > without reading tbl(1)). Completely true, but that's not the worst aspect of it. In a

Re: Using tbl(1) for structure definitions

2022-07-29 Thread G. Branden Robinson
Hi Alex, At 2022-07-30T02:04:39+0200, Alejandro Colomar wrote: > On 7/30/22 01:56, G. Branden Robinson wrote: > > It'll be good to have a look. > > Oh, it's already in your mailbox, isn't it? I think I just responded to it. :) > But reallistically, how many people will fix their TS in man.loca

Re: Using tbl(1) for structure definitions

2022-07-29 Thread Alejandro Colomar
Hi Branden, On 7/30/22 01:56, G. Branden Robinson wrote: Hi Alex, At 2022-07-30T00:38:13+0200, Alejandro Colomar wrote: On 7/29/22 23:08, G. Branden Robinson wrote: At 2022-07-29T17:26:10+0200, Alejandro Colomar wrote: Hmm, considering that the amount of multiline comments with 80-char ter

Re: Using tbl(1) for structure definitions

2022-07-29 Thread G. Branden Robinson
Hi Alex, At 2022-07-30T00:38:13+0200, Alejandro Colomar wrote: > On 7/29/22 23:08, G. Branden Robinson wrote: > > At 2022-07-29T17:26:10+0200, Alejandro Colomar wrote: > Hmm, considering that the amount of multiline comments with 80-char > terminals is still non-negligible (not in this page, but

Re: Using tbl(1) for structure definitions

2022-07-29 Thread Alejandro Colomar
Hi Branden, On 7/29/22 23:08, G. Branden Robinson wrote: Hi Alex! At 2022-07-29T17:26:10+0200, Alejandro Colomar wrote: On 7/29/22 15:52, G. Branden Robinson wrote: I don't think you're abusing it but you are employing some heavy machinery that brings some limitations with it. The worst from

Re: Using tbl(1) for structure definitions

2022-07-29 Thread G. Branden Robinson
Hi Alex! At 2022-07-29T17:26:10+0200, Alejandro Colomar wrote: > On 7/29/22 15:52, G. Branden Robinson wrote: > > I don't think you're abusing it but you are employing some heavy > > machinery that brings some limitations with it. The worst from my > > perspective is that using tbl(1) in man page

Re: Using tbl(1) for structure definitions

2022-07-29 Thread Alejandro Colomar
Hi Branden, On 7/29/22 15:52, G. Branden Robinson wrote: Oh, I used text blocks and .BR, in v2. In part, I like it; in part I hate it. So, text blocks are definitely better. I'm not convinced about changing the escapes by macros; it makes it quite hard for inexperienced contributors to imagin

Re: Using tbl(1) for structure definitions

2022-07-29 Thread G. Branden Robinson
Hi Alex, At 2022-07-27T14:23:44+0200, Alejandro Colomar (man-pages) wrote: > Yeah, it seems that everything that I used was well documented (I > could find the way to use it). I didn't notice any other issues. > > Of course, there are things that I didn't pay much attention and > didn't fully un

Re: Using tbl(1) for structure definitions

2022-07-29 Thread G. Branden Robinson
At 2022-07-27T07:41:05+0100, Ralph Corderoy wrote: > > +.TS > > +l lB lB l1 lX. Alex, I think your contributors will be happier if you limit the number of table columns to the number of syntactical items that they can perceive in the structure body: the data type, element identifier, and (an optio

Re: Using tbl(1) for structure definitions

2022-07-29 Thread Alejandro Colomar
On 7/29/22 10:13, Heinz-Jürgen Oertel wrote:> Hi Alex, did you look at the dformat preprocessor for pic? Hi Heinz, I think tbl(1) is more suited for this. https://noxz.tech/guides/groff/papers/dformat_--_a_program_for_typesetting_data_formats__142.pdf But thanks for that. I didn't know a

Re: Using tbl(1) for structure definitions

2022-07-29 Thread Heinz-Jürgen Oertel
Am Dienstag, 26. Juli 2022, 21:33:07 CEST schrieb Alejandro Colomar: > Hi Branden, > > I've already read all that was relevant to me from tbl(1) regarding what > I had in mind: documenting structures. > > I haven't seen any mention to tables having a leading blank line, yet I > couldn't get rid

Re: Using tbl(1) for structure definitions

2022-07-27 Thread Ralph Corderoy
Hi Alex, > > .\" Start table. > > .de1 TS > > . \" If continuous rendering, tell tbl not to use keeps. > > . ie \\n[cR] .nr 3usekeeps 0 > > . el .nr 3usekeeps 1 > > . sp \\n[PD]u > > . if \\n[an-is-output-html] \{\ > > .nr an-TS-ll \\n[.l] > > .ll 1000n > > . \} > > . HTML-I

Re: Using tbl(1) for structure definitions

2022-07-27 Thread Alejandro Colomar (man-pages)
HI Branden, On 7/27/22 02:12, G. Branden Robinson wrote: Hi Alex, At 2022-07-26T21:33:07+0200, Alejandro Colomar wrote: I've already read all that was relevant to me from tbl(1) regarding what I had in mind: documenting structures. Okay. Apart from those two nits I didn't get any other feed

Re: Using tbl(1) for structure definitions

2022-07-27 Thread Alejandro Colomar (man-pages)
Hi Ralph, On 7/27/22 08:41, Ralph Corderoy wrote: Hi Alex, +.TS +l lB lB l1 lX. +\& u64 flags; /* T{ +.BR O_ * +flags */ +T} +\& u64 mode; /* T{ +Mode for +.BR O_ { CREAT , TMPFILE } +*/ +T} The inline font escapes, \fB...\fP, were much more readable because I co

Re: Using tbl(1) for structure definitions

2022-07-26 Thread Ralph Corderoy
Hi Alex, > +.TS > +l lB lB l1 lX. > +\& u64 flags; /* T{ > +.BR O_ * > +flags */ > +T} > +\& u64 mode; /* T{ > +Mode for > +.BR O_ { CREAT , TMPFILE } > +*/ > +T} The inline font escapes, \fB...\fP, were much more readable because I could still see, and check, the str

Re: Using tbl(1) for structure definitions

2022-07-26 Thread G. Branden Robinson
Hi Alex, At 2022-07-26T21:33:07+0200, Alejandro Colomar wrote: > I've already read all that was relevant to me from tbl(1) regarding > what I had in mind: documenting structures. Okay. Apart from those two nits I didn't get any other feedback from you, did you find the document clear and satisfa

Re: Using tbl(1) for structure definitions

2022-07-26 Thread Alejandro Colomar
I must say that the source code is really ugly (ugly as in, someone reading it will probably have a hard time modifying it, without reading tbl(1)). But at the same time, the result is beautiful, and the syntax is really great. You can express exactly what you want. Cheers, Alex On 7/26/2

Re: Using tbl(1) for structure definitions

2022-07-26 Thread Alejandro Colomar
Improved an v2 using T{...T} in combination with column modifiers and removing .nf/.fi for the table, fixing a misplaced .PD, and .BR instead of \fB...\fP: open_how.2type: ffix Format structures with tbl(1) to improve alignment in proportional-width font text. Reported-by: "G.

Using tbl(1) for structure definitions

2022-07-26 Thread Alejandro Colomar
Hi Branden, I've already read all that was relevant to me from tbl(1) regarding what I had in mind: documenting structures. I haven't seen any mention to tables having a leading blank line, yet I couldn't get rid of it without resorting to .PD. Let me know if I'm doing something wrong, or i