Thread: protocol-message-formats <- display format

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
Description:

Hi,

It would improve the readability if we add further tabulation to the
description of each message.
Also, make the message title bold to visually distinguish it from the
description.

I would gladly modify the css to make this happen.

On 1/8/19 2:33 PM, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
> Description:
>
> Hi,
>
> It would improve the readability if we add further tabulation to the
> description of each message.
> Also, make the message title bold to visually distinguish it from the
> description.
>
> I would gladly modify the css to make this happen.

Looking at a version[1] before the the redesign, it appears there was
further indentation, so yes, this should be added back in.

I believe the titles are used in other places with that style, so we'd
have to make sure any changes to that don't affect readability on other
pages.

Thanks,

Jonathan

[1]
https://web.archive.org/web/20180309050904/https://www.postgresql.org/docs/9.6/static/protocol-message-formats.html

On 1/9/19 10:13 AM, Jonathan S. Katz wrote:
> On 1/8/19 2:33 PM, PG Doc comments form wrote:
>> The following documentation comment has been logged on the website:
>>
>> Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
>> Description:
>>
>> Hi,
>>
>> It would improve the readability if we add further tabulation to the
>> description of each message.
>> Also, make the message title bold to visually distinguish it from the
>> description.
>>
>> I would gladly modify the css to make this happen.
>
> Looking at a version[1] before the the redesign, it appears there was
> further indentation, so yes, this should be added back in.

Attached is a patch to correct this. I tested several pages that are
affected by the "VARIABLELIST" style in multiple versions, and it
appears to be an overall improvement.

I will apply to pgweb shortly.

Thanks,

Jonathan