From: Niels Bom <niels@nielsbom.com>
To: Jonathan S. Katz <jkatz@postgresql.org>
To: pgsql-docs@lists.postgresql.org
Subject: Re: Usability ideas: text width and headers that are links
Date: Fri, 21 Oct 2022 18:49:44 +0200
Message-ID: <f3275687-5902-4637-b53b-1f2740e5a732@app.fastmail.com> (raw)
In-Reply-To: <283a08f1-ae00-8a96-db7c-dbd43bb53aae@postgresql.org>
References: <e6f470fa-030e-41cc-9326-010b8081f75e@app.fastmail.com>
<283a08f1-ae00-8a96-db7c-dbd43bb53aae@postgresql.org>
On Fri, Oct 21, 2022, at 17:42, Jonathan S. Katz wrote:
> Hi,
>
> Thanks for the suggestions. Comments inline:
>
> On 10/21/22 9:54 AM, Niels Bom wrote:
>> Hi!
>>
>> I have 2 small ideas to improve the usability of the PostgreSQL documentation. I'm looking at v15 (1) mostly.
>>
>> Idea 1:
>> Give the text width of the main content a max width.
>
> Why? Can you please provide examples? Screenshots are OK.
Setting a max-width on regular textual content is good for readability, which in turn increases accessibility. See this W3C a11y documentation (1) and an a11y page by the US government (2) for more detailed info.
Using the CSS max-width property makes narrower sizes possible (for smaller screens) but sets an upper limit. The newer `ch` unit in CSS is a good-enough approximation of the average width of a character. I've seen 66ch as the "ideal" width for regular text. For the docs code examples need to have enough width too of course. But we can have those be wider than their containing element if need be.
1: https://www.w3.org/WAI/tutorials/page-structure/styling/
2: https://accessibility.digital.gov/visual-design/typography/>
>> Idea 2:
>> Each h3 and h4 element should be a link pointing to the nearest parent section with an id. This makes deeplinking to specific parts of a page easier. This prevents people from having to scroll to the top, find out which table-of-content-link they have to click to get the deeplink of where they wanted to link. This is actually quite a common pattern. See the Python docs (2) and the Mozilla docs (3) as examples. The pattern on those sites is even a little nicer by showing an icon on hover.
>
> This has been on my backlog for awhile, i.e. to have the hovering
> "anchor holders". I'll try to move it up on the list.
Cool! I could help if you want to.
>
> Thanks,
>
> Jonathan
>
>
> Attachments:
> * OpenPGP_signature
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: niels@nielsbom.com, jkatz@postgresql.org, pgsql-docs@lists.postgresql.org
Subject: Re: Usability ideas: text width and headers that are links
In-Reply-To: <f3275687-5902-4637-b53b-1f2740e5a732@app.fastmail.com>
* 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