From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-0.0 required=5.0 tests=T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 29733 invoked from network); 5 Jul 2022 15:16:57 -0000 Received: from bsd.lv (HELO mandoc.bsd.lv) (66.111.2.12) by inbox.vuxu.org with ESMTPUTF8; 5 Jul 2022 15:16:57 -0000 Received: from fantadrom.bsd.lv (localhost [127.0.0.1]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id 7ab9b022 for ; Tue, 5 Jul 2022 10:16:57 -0500 (EST) Received: from scc-mailout-kit-02.scc.kit.edu (scc-mailout-kit-02.scc.kit.edu [129.13.231.82]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id 76923117 for ; Tue, 5 Jul 2022 10:16:50 -0500 (EST) Received: from hekate.asta.kit.edu ([2a00:1398:5:f401::77]) by scc-mailout-kit-02.scc.kit.edu with esmtps (TLS1.3:ECDHE_SECP256R1__RSA_PSS_RSAE_SHA256__AES_256_GCM:256) (envelope-from ) id 1o8kID-00EDqw-7S; Tue, 05 Jul 2022 17:16:49 +0200 Received: from login-1.asta.kit.edu ([2a00:1398:5:f400::72]) by hekate.asta.kit.edu with esmtp (Exim 4.94.2) (envelope-from ) id 1o8kIB-006K2Q-HN; Tue, 05 Jul 2022 17:16:47 +0200 Received: from schwarze by login-1.asta.kit.edu with local (Exim 4.92) (envelope-from ) id 1o8kIB-0001Eb-Ti; Tue, 05 Jul 2022 17:16:47 +0200 Date: Tue, 5 Jul 2022 17:16:47 +0200 From: Ingo Schwarze To: Anna Cc: tech@mandoc.bsd.lv Subject: Re: [PATCH 1/3] Wrap manual header in the "
" tag Message-ID: References: <20220628181844.15484-1-cyber@sysrq.in> <20220628181844.15484-2-cyber@sysrq.in> X-Mailinglist: mandoc-tech Reply-To: tech@mandoc.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Hello Anna, Anna wrote on Mon, Jul 04, 2022 at 01:51:01AM +0500: > There are incomplete lists: > https://a11ysupport.io/ > https://www.powermapper.com/tests/screen-readers/aria/ Thanks, i linked those from https://mandoc.bsd.lv/links.html to not forget them. > On 2022-07-03 22:12, Ingo Schwarze wrote: [...] >> What difference does it make for a screen reader whether >> the aria-label is present or absent? > It will say the line before entering the element. >> Why would a user ever want the words "Manual header line" >> read out at them? > To know what to expect (and decide whether to skip or not). Fair enough, so we'll add such aria-label attributes where appropriate. [...] > Yes, there's no such requirement. I misinterpreted it. So wrapping the > form in
is fine. Done. In addition, i also committed another patch to move the

site header typically contained in header.html into the
. Next, i drafted a patch to use
for the manual header line, but it does not work, and i feel a bit at a loss now. The version of the patch appended below (also installed on man.bsd.lv for testing) is deliberately inconsistent to demonstrate two ways of writing the
. For manuals in man(7) format, the patch implements the original idea, so for example, https://man.bsd.lv/cvs.1 contains:
CVS(1) General Commands Manual CVS(1)
But that is invalid code, see https://validator.w3.org/nu/?doc=https%3A%2F%2Fman.bsd.lv%2Fcvs.1 Error: Bad value doc-pageheader for attribute role on element header. From line 171, column 1; to line 171, column 62 And indeed, https://www.w3.org/TR/html-aria/#docconformance says: HTML element:
ARIA roles which MAY be used: group, none or presentation. So we must not use doc-pageheader on
. My next attempt was to move the ARIA information from the
to the contained . For demonstration, i implemented that for manuals in mdoc(7) format. For example, https://man.bsd.lv/true.1 contains:
TRUE(1) General Commands Manual TRUE(1)
But the validator complains anyway: https://validator.w3.org/nu/?doc=https%3A%2F%2Fman.bsd.lv%2Ftrue.1 Error: Bad value doc-pageheader for attribute role on element table. From line 172, column 1; to line 172, column 61 I have no idea why; https://www.w3.org/TR/html-aria/#docconformance says: HTML element: ARIA roles which MAY be used: Any role The section https://www.w3.org/TR/html-aria/#allowed-descendants-of-aria-roles does not appear to restrict the content of an element of role="group"; it allows any flow content. I don't see anything in https://www.w3.org/TR/dpub-aria-1.1/#doc-pageheader either that might be violated. Do you have an idea what might be wrong here, or how we could fix it? If you have no idea either, i might just drop the
element around the manual header line, like this: [...]
TRUE(1) General Commands Manual TRUE(1)
[...] That looks syntactically and semantically correct to me, and the validator doesn't complain about it either. Yours, Ingo Index: html.c =================================================================== RCS file: /cvs/src/usr.bin/mandoc/html.c,v retrieving revision 1.148 diff -u -p -r1.148 html.c --- html.c 3 Jul 2022 14:28:26 -0000 1.148 +++ html.c 5 Jul 2022 14:06:10 -0000 @@ -1,7 +1,7 @@ /* $OpenBSD: html.c,v 1.148 2022/07/03 14:28:26 schwarze Exp $ */ /* + * Copyright (c) 2011-2015, 2017-2022 Ingo Schwarze * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons - * Copyright (c) 2011-2015, 2017-2021 Ingo Schwarze * Copyright (c) 2022 Anna Vyalkova * * Permission to use, copy, modify, and distribute this software for any @@ -66,10 +66,12 @@ static const struct htmldata htmltags[TA {"style", HTML_NLALL | HTML_INDENT}, {"title", HTML_NLAROUND}, {"body", HTML_NLALL}, + {"header", HTML_NLALL}, {"main", HTML_NLALL}, {"div", HTML_NLAROUND}, {"section", HTML_NLALL}, {"nav", HTML_NLALL}, + {"footer", HTML_NLALL}, {"table", HTML_NLALL | HTML_INDENT}, {"tr", HTML_NLALL | HTML_INDENT}, {"td", HTML_NLAROUND}, Index: html.h =================================================================== RCS file: /cvs/src/usr.bin/mandoc/html.h,v retrieving revision 1.73 diff -u -p -r1.73 html.h --- html.h 3 Jul 2022 14:28:27 -0000 1.73 +++ html.h 5 Jul 2022 14:06:10 -0000 @@ -2,6 +2,7 @@ /* * Copyright (c) 2017, 2018, 2019, 2020 Ingo Schwarze * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons + * Copyright (c) 2022 Anna Vyalkova * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -27,10 +28,12 @@ enum htmltag { TAG_STYLE, TAG_TITLE, TAG_BODY, + TAG_HEADER, TAG_MAIN, TAG_DIV, TAG_SECTION, TAG_NAV, + TAG_FOOTER, TAG_TABLE, TAG_TR, TAG_TD, Index: man_html.c =================================================================== RCS file: /cvs/src/usr.bin/mandoc/man_html.c,v retrieving revision 1.134 diff -u -p -r1.134 man_html.c --- man_html.c 4 Jul 2022 14:37:14 -0000 1.134 +++ man_html.c 5 Jul 2022 14:06:10 -0000 @@ -1,7 +1,8 @@ /* $OpenBSD: man_html.c,v 1.134 2022/07/04 14:37:14 schwarze Exp $ */ /* - * Copyright (c) 2013-2015, 2017-2020 Ingo Schwarze + * Copyright (c) 2013-2015,2017-2020,2022 Ingo Schwarze * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons + * Copyright (c) 2022 Anna Vyalkova * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -268,7 +269,9 @@ man_root_pre(const struct roff_meta *man assert(man->msec); mandoc_asprintf(&title, "%s(%s)", man->title, man->msec); - t = print_otag(h, TAG_TABLE, "c", "head"); + t = print_otag(h, TAG_HEADER, "r?", "doc-pageheader", + "aria-label", "manual header line"); + print_otag(h, TAG_TABLE, "c", "head"); tt = print_otag(h, TAG_TR, ""); print_otag(h, TAG_TD, "c", "head-ltitle"); @@ -291,7 +294,9 @@ man_root_post(const struct roff_meta *ma { struct tag *t, *tt; - t = print_otag(h, TAG_TABLE, "c", "foot"); + t = print_otag(h, TAG_FOOTER, "r?", "doc-pagefooter", + "aria-label", "manual footer line"); + print_otag(h, TAG_TABLE, "c", "foot"); tt = print_otag(h, TAG_TR, ""); print_otag(h, TAG_TD, "c", "foot-date"); Index: mandoc.css =================================================================== RCS file: /cvs/src/usr.bin/mandoc/mandoc.css,v retrieving revision 1.37 diff -u -p -r1.37 mandoc.css --- mandoc.css 3 Jul 2022 14:28:27 -0000 1.37 +++ mandoc.css 5 Jul 2022 14:06:10 -0000 @@ -53,7 +53,8 @@ table.results { margin-top: 1em; /* Header and footer lines. */ -table.head { width: 100%; +header > table { + width: 100%; border-bottom: 1px dotted #808080; margin-bottom: 1em; font-size: smaller; } @@ -61,7 +62,8 @@ td.head-vol { text-align: center; } td.head-rtitle { text-align: right; } -table.foot { width: 100%; +footer > table { + width: 100%; border-top: 1px dotted #808080; margin-top: 1em; font-size: smaller; } Index: mdoc_html.c =================================================================== RCS file: /cvs/src/usr.bin/mandoc/mdoc_html.c,v retrieving revision 1.221 diff -u -p -r1.221 mdoc_html.c --- mdoc_html.c 4 Jul 2022 14:37:14 -0000 1.221 +++ mdoc_html.c 5 Jul 2022 14:06:10 -0000 @@ -453,7 +453,9 @@ mdoc_root_post(const struct roff_meta *m { struct tag *t, *tt; - t = print_otag(h, TAG_TABLE, "c", "foot"); + t = print_otag(h, TAG_FOOTER, "r", "group"); + print_otag(h, TAG_TABLE, "r?", "doc-pagefooter", + "aria-label", "manual footer line"); tt = print_otag(h, TAG_TR, ""); print_otag(h, TAG_TD, "c", "foot-date"); @@ -483,7 +485,9 @@ mdoc_root_pre(const struct roff_meta *me mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec); - t = print_otag(h, TAG_TABLE, "c", "head"); + t = print_otag(h, TAG_HEADER, "r", "group"); + print_otag(h, TAG_TABLE, "r?", "doc-pageheader", + "aria-label", "manual header line"); tt = print_otag(h, TAG_TR, ""); print_otag(h, TAG_TD, "c", "head-ltitle"); -- To unsubscribe send an email to tech+unsubscribe@mandoc.bsd.lv