Re: [PATCH] Add CSS to support discoverable ids in the public documentation website

From: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
To: Brar Piening <brar(at)gmx(dot)de>, Melanie Plageman <melanieplageman(at)gmail(dot)com>
Cc: pgsql-www(at)lists(dot)postgresql(dot)org, Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>
Subject: Re: [PATCH] Add CSS to support discoverable ids in the public documentation website
Date: 2023-04-22 18:48:46
Message-ID: e2115459-8484-8690-54cb-f8abe33050eb@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

On 4/19/23 5:08 PM, Brar Piening wrote:
> On 19.04.2023 at 22:21, Melanie Plageman wrote:
>> On Wed, Apr 19, 2023 at 4:08 PM Jonathan S. Katz
>> <jkatz(at)postgresql(dot)org> wrote:
>>> On 4/13/23 9:41 AM, Brar Piening wrote:
>>>> Attached is the (unmodified) patch I initially sent to pgsql-hackers in
>>>> [2]. Please see the thread in pgsql-hackers for the discussion so far.
>>> I personally like the paperclip given how it's synonymous with "link",
>>> but that may also give the illusion that we also automatically copy the
>>> link to the clipboard. Perhaps "#" is good enough?
>> I find the "#" pretty meaningless and the paper clip a bit silly.
>> Personally, I think the link icon is the nicest. David pointed out [3]
>> does this, and it is quite visually appealing.

I think to do the link icon successfully, we should also attempt to
automatically copy the text to the clipboard as well. We already have a
basis for this thanks to some of the work we did on the downloads page,
so adapting it for this purpose would be fairly trivial.

> I have no qualifications or whatsoever to comment on the visual design,
> so I will not be involved in any bike shedding but please note that the
> patch here does not and cannot chose the symbol we are displaying. Being
> pure CSS it only changes the default color and visibility of the symbol.
> The symbol was part of the xslt modifications in the patch that I sent
> to hackers and was commited in commit e2922702a3. If you really think
> that changing the symbol is important or useful, you'll probably have to
> carry the discussion back to hackers (maybe to the original thread).

Yeah, I noticed that while testing the patch further and looking at the
current display in the devel docs.

For now, I committed Brar's patch as is, with an updated comment[1]. I
think there is more to be done here on usability, but, at least for Beta
1, we should be hiding the anchors by default.

Jonathan

[1] https://git.postgresql.org/gitweb/?p=pgweb.git;a=commit;h=c7a5951d2

In response to

Responses

Browse pgsql-www by date

  From Date Subject
Next Message Jonathan S. Katz 2023-04-22 18:59:39 Re: Patch to clean up and add missing GSoC pages
Previous Message Stefanie Janine Stölting 2023-04-21 09:27:53 Patch to clean up and add missing GSoC pages