[PATCH] website: Modify use of H1 headings

The website was originally designed to use only one H1 element per

page, which is/was seen as a best practice for accessibility and

SEO. However, the value of the H1 element in all the pages of the

website was always the alternative text of the Guix logo ("Guix"). The

main content of a page started with a level 2 heading (H2).

This change maintains the best practice of using only one H1 element

per page, but gives a less important level to the Guix logo (it

becomes H2) and uses H1 as the heading for the main content of

pages. This means, for example, that the H1 of the download page is

"Download", the H1 of the help page is "Help", the H1 of a blog post

is its title, and so on.

The changes were tested in the following browsers (without assistive

technologies):

Website pages validate correctly using the https://validator.w3.org/,

and their heading-level and structural outlines are similar to those

of the https://webaim.org/pages.

For the following templates, change main content heading from H2 to

H1, and update subheadings accordingly.

(detailed-package-list-t)

For the following templates, add missing H1 heading to the main

content:

(screenshots-overview-t)

Style changes:

(.summary-box h2) New style.

".navbar > h2" (the logo is now an H2 heading).

---

website/apps/base/templates/about.scm | 6 +++---

website/apps/base/templates/components.scm | 4 ++--

website/apps/base/templates/contact.scm | 2 +-

website/apps/base/templates/contribute.scm | 20 +++++++++----------

website/apps/base/templates/donate.scm | 6 +++---

website/apps/base/templates/graphics.scm | 2 +-

website/apps/base/templates/help.scm | 14 ++++++-------

website/apps/base/templates/home.scm | 2 +-

website/apps/base/templates/irc.scm | 2 +-

website/apps/base/templates/security.scm | 8 ++++----

website/apps/blog/templates/components.scm | 2 +-

website/apps/blog/templates/post-list.scm | 2 +-

website/apps/blog/templates/post.scm | 2 +-

website/apps/blog/templates/tag.scm | 2 +-

.../apps/download/templates/components.scm | 2 +-

website/apps/download/templates/download.scm | 2 +-

website/apps/media/templates/screenshot.scm | 2 +-

.../media/templates/screenshots-overview.scm | 1 +

website/apps/media/templates/video-list.scm | 1 +

website/apps/media/templates/video.scm | 2 +-

.../packages/templates/detailed-index.scm | 2 +-

.../templates/detailed-package-list.scm | 2 +-

website/apps/packages/templates/index.scm | 2 +-

.../apps/packages/templates/package-list.scm | 2 +-

website/apps/packages/templates/package.scm | 4 ++--

website/static/base/css/download.css | 4 ++++

website/static/base/css/item-preview.css | 5 +++++

website/static/base/css/navbar.css | 2 +-

website/static/base/css/page.css | 7 ++++---

29 files changed, 63 insertions(+), 51 deletions(-)

Ping...

Regardless of whether this change is applied, I think it would be good to suggest blog posters to use heading levels to convey structure, not style. Currently, post headings are often used for the latter (for instance, to make a heading text smaller). I haven't tried myself, but it seems that using headings in this way can make it harder for people using assistive technologies.

So, when writing a blog post, the title has the highest level (currently H2, but H1 if this patch is applied), and the headings in the body should use lower levels accordingly, without skipping levels.

Hello sirgazil!

sirgazil <sirgazil@zoho.com> writes:

Thanks for the patch! It makes sense. Unfortunately it doesn't apply

with 'git am' :-/. Could you rebase it on the current master branch of

guix-artwork?

Thank you,

Maxim

Hi, Maxim.

??????? Original Message ???????

On Friday, October 9, 2020 2:49 AM, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:

[...]

Well, that's unfortunate because that patch is all I have. The copy of the git repository I was working on is long gone.

I'd redo the work, and send a new patch, but I haven't had much luck with my patches for the website, so I guess I pass for now.

Thanks,

Dear,

On Sat, 10 Oct 2020 at 21:58, Luis Felipe via Guix-patches via

<guix-patches@gnu.org> wrote:

Sad!

Since I have hit this issue several times when digging in the

Bug/Patch Report, now when sending patches, I personally try to use:

git format-patch --base <commit-where-it-applies>

Then the patch contains at the bottom these lines, for example:

And with a recent enough Magit version, it is "W c C-m b".

Well, it seems a good habit iMHO and I will try to send a patch

updating the section "Submitting Patches".

Thanks,

simon

Hi simon, thanks for the tip. I'll do that from now on.

Hello Luis,

Luis Felipe <luis.felipe.la@protonmail.com> writes:

That's unfortunate, indeed. Sorry we failed to be more responsive,

leading to this. Feel free to ping me on #guix when you get around to

send a refresh patch; I go by the 'apteryx' nickname.

Happy hacking,

Maxim

Hi Luis,

Sorry for not being super responsive. It is about an old patch#39635

submission [1].

1: http://issues.guix.gnu.org/issue/39635

On Sat, 10 Oct 2020 at 19:51, Luis Felipe <luis.felipe.la@protonmail.com> wrote:

[...]

What is the status? Do we close this submission? Are we waiting for an

update? Maybe it is included by another patch.

Cheers,

simon

Hi zimoun,

On Tuesday, October 18th, 2022 at 15:58, zimoun <zimon.toutoune@gmail.com> wrote:

Status: Neglected by myself. Unfortunately, I don't think I can update the patch anytime soon.

I'd like to leave the issue open, though, until I (or someone else) have the time to address it. I sill think it is an issue.

In any case, I have the same issue still open in my personal issue tracker. So, if it needs to be closed for any particular reason here, I won't get mad :)

Cheers,