New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix pages with multiple h1 headings #1914

Closed
andrewdavidwong opened this Issue Apr 18, 2016 · 5 comments

Comments

Projects
None yet
2 participants
@andrewdavidwong
Member

andrewdavidwong commented Apr 18, 2016

Here's an example page:

https://www.qubes-os.org/doc/copy-from-dom0/

There are two h1 headings on that page. The second one doesn't show up in the automatically-generated table of contents on the right (or bottom, if on mobile).

@andrewdavidwong andrewdavidwong added this to the Documentation/website milestone Apr 18, 2016

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Apr 18, 2016

This relates to the same jQuery plugin as #1713 However, in this case, I believe the plugin explicitly ignores h1 headings as those are supposed to be the page heading and not repeated throughout the content.

Thus, I believe the right approach here is to Convert h1 in doc pages to h2, h3 tags rather than modify the plugin. Is that something you are up to doing @axon-qubes ?

bnvk commented Apr 18, 2016

This relates to the same jQuery plugin as #1713 However, in this case, I believe the plugin explicitly ignores h1 headings as those are supposed to be the page heading and not repeated throughout the content.

Thus, I believe the right approach here is to Convert h1 in doc pages to h2, h3 tags rather than modify the plugin. Is that something you are up to doing @axon-qubes ?

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Apr 19, 2016

Member

Sure, not a problem. However, I don't know of a good way to find all the pages with duplicate h1s, so I can only fix it for this one page for now.

Member

andrewdavidwong commented Apr 19, 2016

Sure, not a problem. However, I don't know of a good way to find all the pages with duplicate h1s, so I can only fix it for this one page for now.

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Apr 19, 2016

Member

(For all I know, this may be the only page that has duplicate h1s.)

Member

andrewdavidwong commented Apr 19, 2016

(For all I know, this may be the only page that has duplicate h1s.)

marmarek added a commit to QubesOS/qubesos.github.io that referenced this issue Apr 19, 2016

autoupdate: _doc
_doc:
    tag axon_dc4e1466
    tagger Axon <axon@openmailbox.org> 1461035323 +0000

    Tag for commit dc4e1466ce3967c30d6dbc766d170b6a80642354
    gpg: Signature made Tue 19 Apr 2016 05:08:38 AM CEST using RSA key ID 2A019A17
    gpg: Good signature from "Axon (Qubes Documentation Signing Key)"

    dc4e146 Fix headings (fixes QubesOS/qubes-issues#1914)
@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Apr 27, 2016

Member

I'm reopening this issue since we've come across at least one more page with multiple h1 headings (and since there are probably more out there), but I'm changing the title to reflect the decision made here.

Member

andrewdavidwong commented Apr 27, 2016

I'm reopening this issue since we've come across at least one more page with multiple h1 headings (and since there are probably more out there), but I'm changing the title to reflect the decision made here.

@andrewdavidwong andrewdavidwong changed the title from Auto-ToC doesn't detect multiple h1s to Fix pages with multiple h1 headings Apr 27, 2016

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Oct 15, 2016

Member

I'll just fix these as I come across them in the future.

Member

andrewdavidwong commented Oct 15, 2016

I'll just fix these as I come across them in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment