Thread: A minor bug in doc. Hovering over heading shows # besides it.
Hi,
On page
https://www.postgresql.org/docs/devel/ddl-basics.html
5.1. Table Basics #
when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed
Regards,
Muhammad Ikram
Bitnine Global
Hi
I have checked other pages too and the issue is only with this page.
Regards
Kashif Zeeshan
On Thu, Jul 18, 2024 at 9:55 AM Muhammad Ikram <mmikram@gmail.com> wrote:
Hi,On page--https://www.postgresql.org/docs/devel/ddl-basics.html5.1. Table Basics #when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removedRegards,Muhammad IkramBitnine Global
On Wednesday, July 17, 2024, Muhammad Ikram <mmikram@gmail.com> wrote:
Hi,On pagehttps://www.postgresql.org/docs/devel/ddl-basics.html 5.1. Table Basics #when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed
That is telling you that this location on the page contains an anchor. If you click it your URL changes to include an anchor reference taking you directly to that spot.
David J.
On Wednesday, July 17, 2024, Kashif Zeeshan <kashi.zeeshan@gmail.com> wrote:
I have checked other pages too and the issue is only with this page.
There are like thousands of them…
David J.
On Thu, 18 Jul 2024 at 16:55, Muhammad Ikram <mmikram@gmail.com> wrote: > 5.1. Table Basics # > > when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed Those are meant to be there. They allow you to copy a URL directly to that doc section. In [1], there was some talk about using another more suitable character. If the purpose of the '#' isn't obvious, then maybe we should use something else. David https://www.postgresql.org/message-id/CAAKRu_Z1Xsjmv3b-JaGg2e1JLE2GCZe3+zX7C7WGbraJBfvvzg@mail.gmail.com
Hi David
Thanks for the clarification.
Regards
Kashif Zeeshan
On Thu, Jul 18, 2024 at 10:07 AM David Rowley <dgrowleyml@gmail.com> wrote:
On Thu, 18 Jul 2024 at 16:55, Muhammad Ikram <mmikram@gmail.com> wrote:
> 5.1. Table Basics #
>
> when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed
Those are meant to be there. They allow you to copy a URL directly to
that doc section.
In [1], there was some talk about using another more suitable
character. If the purpose of the '#' isn't obvious, then maybe we
should use something else.
David
https://www.postgresql.org/message-id/CAAKRu_Z1Xsjmv3b-JaGg2e1JLE2GCZe3+zX7C7WGbraJBfvvzg@mail.gmail.com
David Rowley <dgrowleyml@gmail.com> writes:
> On Thu, 18 Jul 2024 at 16:55, Muhammad Ikram <mmikram@gmail.com> wrote:
>> when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed
> In [1], there was some talk about using another more suitable
> character. If the purpose of the '#' isn't obvious, then maybe we
> should use something else.
Yeah. I've found this new feature useful multiple times already,
but the '#' icon is as non-mnemonic and unobvious as could possibly
be. OTOH, I don't know of a standard icon for this feature.
I wonder if we could make a tooltip worded like "link to this header"
pop up when you hover over the '#'? That'd improve things a lot
even if we had a better icon.
A different idea is to dispense with the icon and make the section
title itself be a link to itself.
regards, tom lane
On Wednesday, July 17, 2024, Tom Lane <tgl@sss.pgh.pa.us> wrote:
David Rowley <dgrowleyml@gmail.com> writes:
> On Thu, 18 Jul 2024 at 16:55, Muhammad Ikram <mmikram@gmail.com> wrote:
>> when we hover over Table Basics, it shows # sign postfixed. I think it needs to be removed
> In [1], there was some talk about using another more suitable
> character. If the purpose of the '#' isn't obvious, then maybe we
> should use something else.
Yeah. I've found this new feature useful multiple times already,
but the '#' icon is as non-mnemonic and unobvious as could possibly
be. OTOH, I don't know of a standard icon for this feature.
The fact that clicking this gave me a link with “#ANCHOR” appended to it made the use of # make perfect sense, at least in hindsight.
Can we use a boat anchor symbol?
I get that my ideas do have the problem that I’m familiar with web nomenclature and details at a lower level than most of the readers we are trying to help with this change…
I feel the bug here, though possibly rarely to be read, is to note this behavior on the “Conventions” page.
A different idea is to dispense with the icon and make the section
title itself be a link to itself.
If that includes styling it would solve what I’d say is the bigger issue that where these anchors exist is not always visible. I suppose understanding all major headings should have links makes sense, but we’ve probably got 30% (w.a.g.) of our tables with them as well. It also would have helped here possibly by not looking like a random buggy thing on mouse-over but instead quite evidently part of our navigation.
David J.
On Thu, 18 Jul 2024 at 17:18, Tom Lane <tgl@sss.pgh.pa.us> wrote: > Yeah. I've found this new feature useful multiple times already, > but the '#' icon is as non-mnemonic and unobvious as could possibly > be. OTOH, I don't know of a standard icon for this feature. I also find it useful and certainly don't want it to disappear. There's a unicode character for it. https://www.unicodepedia.com/unicode/miscellaneous-symbols-and-pictographs/1f517/link-symbol/ David
On Thu, 18 Jul 2024 at 07:40, David Rowley <dgrowleyml@gmail.com> wrote: > > On Thu, 18 Jul 2024 at 17:18, Tom Lane <tgl@sss.pgh.pa.us> wrote: > > Yeah. I've found this new feature useful multiple times already, > > but the '#' icon is as non-mnemonic and unobvious as could possibly > > be. OTOH, I don't know of a standard icon for this feature. > > I also find it useful and certainly don't want it to disappear. > +1. I have also already found it useful. > There's a unicode character for it. > https://www.unicodepedia.com/unicode/miscellaneous-symbols-and-pictographs/1f517/link-symbol/ > +1 for that and a "Link to this heading" tooltip. Regards, Dean
> On 18 Jul 2024, at 07:18, Tom Lane <tgl@sss.pgh.pa.us> wrote: > Yeah. I've found this new feature useful multiple times already, > but the '#' icon is as non-mnemonic and unobvious as could possibly > be. OTOH, I don't know of a standard icon for this feature. While not a standard the pilcrow [0] is, AFAICT from a bit of looking at other docs, commonly used for this. There is a lot of variability though so whichever we choose it will be wrong one for someone. -- Daniel Gustafsson [0] https://en.wikipedia.org/wiki/Pilcrow
On Thu, 18 Jul 2024 at 19:46, Daniel Gustafsson <daniel@yesql.se> wrote: > There is a lot of variability though so > whichever we choose it will be wrong one for someone. I think the tooltip would help reduce the chances of someone being confused. For an example, see [1]. David [1] https://devblogs.microsoft.com/cppblog/accelerating-compute-intensive-workloads-with-intel-avx-512/#test-system-configuration
Daniel Gustafsson <daniel@yesql.se> writes:
> While not a standard the pilcrow [0] is, AFAICT from a bit of looking at other
> docs, commonly used for this. There is a lot of variability though so
> whichever we choose it will be wrong one for someone.
I like this suggestion better because that's U+00B6, ie part of
LATIN-1, so it's *far* more likely to render correctly everywhere
than U+01F517 is. We could also consider the section sign §
(U+00A7).
In any case, a tooltip would help reduce confusion.
regards, tom lane
> On 18 Jul 2024, at 15:49, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>
> Daniel Gustafsson <daniel@yesql.se> writes:
>> While not a standard the pilcrow [0] is, AFAICT from a bit of looking at other
>> docs, commonly used for this. There is a lot of variability though so
>> whichever we choose it will be wrong one for someone.
>
> I like this suggestion better because that's U+00B6, ie part of
> LATIN-1, so it's *far* more likely to render correctly everywhere
> than U+01F517 is. We could also consider the section sign §
> (U+00A7).
>
> In any case, a tooltip would help reduce confusion.
Looking a bit closer, the Python documentation does just this, a pilcrow with a
tool-tip ("Link to this heading") when hovering over it
--
Daniel Gustafsson
Daniel Gustafsson <daniel@yesql.se> writes:
> Looking a bit closer, the Python documentation does just this, a pilcrow with a
> tool-tip ("Link to this heading") when hovering over it
Oh nice --- a precedent! And one that a fair number of people
will have seen before. +1 for copying Python.
regards, tom lane
On 7/18/24 1:59 PM, Daniel Gustafsson wrote:
>> On 18 Jul 2024, at 15:49, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>>
>> Daniel Gustafsson <daniel@yesql.se> writes:
>>> While not a standard the pilcrow [0] is, AFAICT from a bit of looking at other
>>> docs, commonly used for this. There is a lot of variability though so
>>> whichever we choose it will be wrong one for someone.
>>
>> I like this suggestion better because that's U+00B6, ie part of
>> LATIN-1, so it's *far* more likely to render correctly everywhere
>> than U+01F517 is. We could also consider the section sign §
>> (U+00A7).
>>
>> In any case, a tooltip would help reduce confusion.
>
> Looking a bit closer, the Python documentation does just this, a pilcrow with a
> tool-tip ("Link to this heading") when hovering over it
I forgot why we went with the "#" and not the (TIL the name) pilcrow
symbol, but I'm generally used to seeing the pilcrow when I browse docs
and may have voiced that at the time (though the record may show
otherwise). So +1 to that.
Thanks,
Jonathan
Attachment
On Fri, 19 Jul 2024 at 06:03, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>
> On 7/18/24 1:59 PM, Daniel Gustafsson wrote:
> > Looking a bit closer, the Python documentation does just this, a pilcrow with a
> > tool-tip ("Link to this heading") when hovering over it
>
> I forgot why we went with the "#" and not the (TIL the name) pilcrow
> symbol, but I'm generally used to seeing the pilcrow when I browse docs
> and may have voiced that at the time (though the record may show
> otherwise). So +1 to that.
I'm not really a web developer, but I did have a go at adjusting the
.css file so we show some relevant tooltip text. I was reminded about
this when looking at [1] this morning. That page is using '#' but the
purpose of it seems quite obvious when combined with the tooltip.
I've attached a small patch to adjust the CSS with hopes that it might
inspire someone who actually knows what they're doing with CSS to make
it better.
David
[1]
https://stackoverflow.blog/2024/07/24/developers-want-more-more-more-the-2024-results-from-stack-overflow-s-annual-developer-survey/
Attachment
Where are we on this? I still see "#".
---------------------------------------------------------------------------
On Mon, Aug 12, 2024 at 02:19:06PM +1200, David Rowley wrote:
> On Fri, 19 Jul 2024 at 06:03, Jonathan S. Katz <jkatz@postgresql.org> wrote:
> >
> > On 7/18/24 1:59 PM, Daniel Gustafsson wrote:
> > > Looking a bit closer, the Python documentation does just this, a pilcrow with a
> > > tool-tip ("Link to this heading") when hovering over it
> >
> > I forgot why we went with the "#" and not the (TIL the name) pilcrow
> > symbol, but I'm generally used to seeing the pilcrow when I browse docs
> > and may have voiced that at the time (though the record may show
> > otherwise). So +1 to that.
>
> I'm not really a web developer, but I did have a go at adjusting the
> .css file so we show some relevant tooltip text. I was reminded about
> this when looking at [1] this morning. That page is using '#' but the
> purpose of it seems quite obvious when combined with the tooltip.
>
> I've attached a small patch to adjust the CSS with hopes that it might
> inspire someone who actually knows what they're doing with CSS to make
> it better.
>
> David
>
> [1]
https://stackoverflow.blog/2024/07/24/developers-want-more-more-more-the-2024-results-from-stack-overflow-s-annual-developer-survey/
> diff --git a/doc/src/sgml/stylesheet.css b/doc/src/sgml/stylesheet.css
> index 86a8edb926..866636eccf 100644
> --- a/doc/src/sgml/stylesheet.css
> +++ b/doc/src/sgml/stylesheet.css
> @@ -175,6 +175,20 @@ acronym { font-style: inherit; }
> a.id_link {
> color: inherit;
> visibility: hidden;
> + text-decoration: none;
> +}
> +
> +a.id_link:hover:after {
> + content: "Pemalink to this heading";
> + font-size: 10px;
> + font-weight: normal;
> + text-decoration: none;
> + border: 1px solid #444444;
> + text-align: center;
> + border-radius: 5px 5px 5px 5px;
> + padding: 5px 5px 5px 5px;
> + position: relative;
> + top: 20px;
> }
>
> *:hover > a.id_link {
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
When a patient asks the doctor, "Am I going to die?", he means
"Am I going to die soon?"
On Wednesday, October 16, 2024, Bruce Momjian <bruce@momjian.us> wrote:
Where are we on this? I still see "#".
We should document what we are doing in Conventions.
The hover stuff is a nice usability add, if a bit limited on mobile.
My +1 as well to matching Python with the pilcrow symbol.
David J.
On Thu, 17 Oct 2024 at 11:19, Bruce Momjian <bruce@momjian.us> wrote: > Where are we on this? I still see "#". I was hoping for some voting for or against my patch or the general idea of it. Also, my web skills in this area amount to trial and error, so it would also be good to have someone who knows what they're doing have a look at it. David
> On 29 Oct 2024, at 12:31, David Rowley <dgrowleyml@gmail.com> wrote: > > On Thu, 17 Oct 2024 at 20:20, Daniel Gustafsson <daniel@yesql.se> wrote: >> My main concern is that the relative positioning will push it off screen with a >> break on smaller viewports (like phones). > > I can recreate what you sent in the screenshot, but I have to make my > browser window as small as it will go and adjust the browser scaling > to at least 150%. I don't know how to hover over a link on my phone to > get tooltips to appear. Is it even possible? Touching the screen without tapping brings up a hover event on iOS, and Android and Firefox mobile support that as well (even better IIRC). When trying that on my iPhone I get the "#" after the link. > I tried hovering over it > with my left finger, but it didn't work ;) You should start live-streaming your web hacking sessions, this sounds entertaining =) > One other difference in [1] vs what we have is that they put the # on > the left of the heading. There's less chance of having horizontal > wrapping issues when the mouse cursor is over on the left side. > However, we don't seem to have much of a margin for doing that. The # tooltip on that page renders outside of the screen for me with just a sliver of it visible to the left of the text. On the whole I wonder if we shouldn't just go with the proposal since it improves the status quo, optimizing for users who hover to get link anchors on mobile probably isn't worth the investment in time. -- Daniel Gustafsson
On Wed, 30 Oct 2024 at 03:46, Daniel Gustafsson <daniel@yesql.se> wrote: > On the whole I wonder if we shouldn't just go with the proposal since it > improves the status quo, optimizing for users who hover to get link anchors on > mobile probably isn't worth the investment in time. My primary motivation for hacking on this was to try to reduce the confusion and reports about the mysterious #. I imagine the patch will improve that situation, but it does risk us getting new reports if there's something off with these changes. My thoughts are that it doesn't seem excessively critical that this is perfect on the first attempt. I'd be happy to see us try to improve this. Maybe if there's some better way, someone will appear and tell us how to do it properly. I am hopeful that we're not just swapping one problem for another. Do you have access to make this change? I think it needs to go into https://www.postgresql.org/media/css/main.css David
> On 29 Oct 2024, at 23:36, David Rowley <dgrowleyml@gmail.com> wrote: > My thoughts are that it doesn't seem excessively critical that this is > perfect on the first attempt. I'd be happy to see us try to improve > this. Maybe if there's some better way, someone will appear and tell > us how to do it properly. I am hopeful that we're not just swapping > one problem for another. Agreed, even if not perfect I think this is an improvement. > Do you have access to make this change? I think it needs to go into > https://www.postgresql.org/media/css/main.css I have a pgweb commitbit so if you roll a patch for it I can take care of the rest. -- Daniel Gustafsson
> On 6 Nov 2024, at 07:10, David Rowley <dgrowleyml@gmail.com> wrote: > > On Wed, 30 Oct 2024 at 11:39, Daniel Gustafsson <daniel@yesql.se> wrote: >> >>> On 29 Oct 2024, at 23:36, David Rowley <dgrowleyml@gmail.com> wrote: >>> Do you have access to make this change? I think it needs to go into >>> https://www.postgresql.org/media/css/main.css >> >> I have a pgweb commitbit so if you roll a patch for it I can take care of the >> rest. > > Thanks. Patch attached. Committed, and with some help from Magnus, the docs site has been reloaded with the new CSS. Everything seems to behave as expected when testing in Firefox, Safari, Chrome and Edge. -- Daniel Gustafsson
On 2024-Nov-06, Daniel Gustafsson wrote: > Committed, and with some help from Magnus, the docs site has been reloaded with > the new CSS. Everything seems to behave as expected when testing in Firefox, > Safari, Chrome and Edge. Ah, but we kept the #? I thought it was going to be changed to ¶ ... was there any voice against that? -- Álvaro Herrera 48°01'N 7°57'E — https://www.EnterpriseDB.com/
> On 6 Nov 2024, at 15:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote: > > On 2024-Nov-06, Daniel Gustafsson wrote: > >> Committed, and with some help from Magnus, the docs site has been reloaded with >> the new CSS. Everything seems to behave as expected when testing in Firefox, >> Safari, Chrome and Edge. > > Ah, but we kept the #? I thought it was going to be changed to ¶ ... > was there any voice against that? You're right, I mistakenly remembered there being no concensus and didn't re-read the thread when it was revived with the patch in question. Re-reading it now I see multiple +1's for using a ¶ instead so will fix that. Thanks for the heads-up. -- Daniel Gustafsson
On Thu, 7 Nov 2024 at 02:33, Daniel Gustafsson <daniel@yesql.se> wrote: > Committed, and with some help from Magnus, the docs site has been reloaded with > the new CSS. Everything seems to behave as expected when testing in Firefox, > Safari, Chrome and Edge. Great. Thank you to you both. David
On Thu, 7 Nov 2024 at 03:58, Daniel Gustafsson <daniel@yesql.se> wrote: > > > On 6 Nov 2024, at 15:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote: > > Ah, but we kept the #? I thought it was going to be changed to ¶ ... > > was there any voice against that? > > You're right, I mistakenly remembered there being no concensus and didn't > re-read the thread when it was revived with the patch in question. Re-reading > it now I see multiple +1's for using a ¶ instead so will fix that. Thanks for > the heads-up. I see in the release notes we're using §. I'm not advocating for any particular one, but would it make sense to be consistent on which character we use for this? David
> On 6 Nov 2024, at 20:34, David Rowley <dgrowleyml@gmail.com> wrote: > > On Thu, 7 Nov 2024 at 03:58, Daniel Gustafsson <daniel@yesql.se> wrote: >> >>> On 6 Nov 2024, at 15:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote: >>> Ah, but we kept the #? I thought it was going to be changed to ¶ ... >>> was there any voice against that? >> >> You're right, I mistakenly remembered there being no concensus and didn't >> re-read the thread when it was revived with the patch in question. Re-reading >> it now I see multiple +1's for using a ¶ instead so will fix that. Thanks for >> the heads-up. > > I see in the release notes we're using §. I'm not advocating for any > particular one, but would it make sense to be consistent on which > character we use for this? The § in the release notes is for links leading from the page in question, whereas the # on the title element is a permalink to the page in question, so I think it's better to use different symbols given that they perform different tasks. -- Daniel Gustafsson
On Wed, Nov 6, 2024 at 03:58:18PM +0100, Daniel Gustafsson wrote:
> > On 6 Nov 2024, at 15:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
> >
> > On 2024-Nov-06, Daniel Gustafsson wrote:
> >
> >> Committed, and with some help from Magnus, the docs site has been reloaded with
> >> the new CSS. Everything seems to behave as expected when testing in Firefox,
> >> Safari, Chrome and Edge.
> >
> > Ah, but we kept the #? I thought it was going to be changed to ¶ ...
> > was there any voice against that?
>
> You're right, I mistakenly remembered there being no concensus and didn't
> re-read the thread when it was revived with the patch in question. Re-reading
> it now I see multiple +1's for using a ¶ instead so will fix that. Thanks for
> the heads-up.
Uh, has this change been made? I still see "#":
https://www.postgresql.org/docs/devel/tutorial-arch.html
I am actually fine with "#" since that is the symbol that will be added
to the URL.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
When a patient asks the doctor, "Am I going to die?", he means
"Am I going to die soon?"
> On 18 Nov 2024, at 20:51, Bruce Momjian <bruce@momjian.us> wrote: > > On Wed, Nov 6, 2024 at 03:58:18PM +0100, Daniel Gustafsson wrote: >>> On 6 Nov 2024, at 15:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote: >>> >>> On 2024-Nov-06, Daniel Gustafsson wrote: >>> >>>> Committed, and with some help from Magnus, the docs site has been reloaded with >>>> the new CSS. Everything seems to behave as expected when testing in Firefox, >>>> Safari, Chrome and Edge. >>> >>> Ah, but we kept the #? I thought it was going to be changed to ¶ ... >>> was there any voice against that? >> >> You're right, I mistakenly remembered there being no concensus and didn't >> re-read the thread when it was revived with the patch in question. Re-reading >> it now I see multiple +1's for using a ¶ instead so will fix that. Thanks for >> the heads-up. > > Uh, has this change been made? I still see "#": It hasn't been changed, I was hoping to hear more opinions but since there has been none I will go ahead with the result of the previous discussion which landed in ¶. Hearing no complaints against the fix for the issue Álvaro identified I'll push that as well. -- Daniel Gustafsson