pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Jonathan S. Katz <jkatz@postgresql.org>
To: leobiwankenobi@gmail.com
To: pgsql-docs@lists.postgresql.org
Cc: Sarah Schnurr <xenophenes42@gmail.com>
Subject: Re: protocol-message-formats <- display format
Date: Wed, 9 Jan 2019 10:34:32 -0500
Message-ID: <e91764de-1fb6-cac8-4dda-97cb8c686b86@postgresql.org> (raw)
In-Reply-To: <1ec4a818-d66d-9bd9-1d44-003f707f06d6@postgresql.org>
References: <154697599467.22752.11471967510249028725@wrigleys.postgresql.org>
	<1ec4a818-d66d-9bd9-1d44-003f707f06d6@postgresql.org>

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

Attachments:

0001-Add-further-indentation-to-variable-lists-to-disting.patch (text/plain, 1.1K) download From 79253866e3ff99047c6bc6e4b79da6ecbb4823c8 Mon Sep 17 00:00:00 2001 From: "Jonathan S. Katz" <jonathan.katz@excoventures.com> Date: Wed, 9 Jan 2019 10:31:46 -0500 Subject: [PATCH] Add further indentation to variable lists to distinguish groups. This was an regression introduced by the new styles that affects readability of nested variables lists (e.g. on the message protocol page). This brings the look more in line with the previous documentation styles and should help with readability. --- media/css/main.css | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/media/css/main.css b/media/css/main.css index 7b11456..c0cf16d 100644 --- a/media/css/main.css +++ b/media/css/main.css @@ -941,6 +941,21 @@ code, font-weight: 300; } +#docContent .VARIABLELIST dt, +#docContent .variablelist dt { + font-family: monospace; + font-weight: 300; +} + +#docContent .variablelist dd { + margin-top: 1rem; +} + +#docContent .VARIABLELIST dd, +#docContent .variablelist dd { + margin-inline-start: 2rem; +} + #docContent ul.itemizedlist { margin-left: 2.5rem; } -- 2.14.3 (Apple Git-98)
signature.asc (application/pgp-signature, 832B) download

view thread (4+ messages)  latest in thread

Message-ID: <e91764de-1fb6-cac8-4dda-97cb8c686b86@postgresql.org>
Permalink:  ../e91764de-1fb6-cac8-4dda-97cb8c686b86@postgresql.org/
Also on:    postgresql.org/message-id/e91764de-1fb6-cac8-4dda-97cb8c686b86@postgresql.org

 ·  · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: jkatz@postgresql.org, leobiwankenobi@gmail.com, pgsql-docs@lists.postgresql.org, xenophenes42@gmail.com
  Subject: Re: protocol-message-formats <- display format
  In-Reply-To: <e91764de-1fb6-cac8-4dda-97cb8c686b86@postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox