aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc_html.c
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2022-06-24 11:15:53 +0000
committerIngo Schwarze <schwarze@openbsd.org>2022-06-24 11:15:53 +0000
commit775d26d8d971fc94e1220bd3c8f87e4a1409a2ca (patch)
tree32a9a794f2256527eabce00439cb226c70a6e996 /mdoc_html.c
parent57d5a8a3f3e52ca15b81371ea3b38c3124a45ec4 (diff)
downloadmandoc-775d26d8d971fc94e1220bd3c8f87e4a1409a2ca.tar.gz
mandoc-775d26d8d971fc94e1220bd3c8f87e4a1409a2ca.tar.zst
mandoc-775d26d8d971fc94e1220bd3c8f87e4a1409a2ca.zip
Improve accessibility of -T html -O toc output by using the <nav> element
in the DPUB-ARIA doc-toc role. Patch from Anna Vyalkova <cyber at sysrq dot in> slightly tweaked by me. This is hopefully the start of a collaboration to improve accessibility of Unix manual pages using the WAI-ARIA, HTML-ARIA, and DPUB-ARIA standards. Progress appears to be possible without changing *anything* with respect to the way manual pages are written. Instead, it seems sufficient to properly translate semantic cues already implied by existing mdoc(7) markup into the appropriate HTML elements and ARIA attributes. Overall, the total length of HTML output is likely to increase slightly, but not much.
Diffstat (limited to 'mdoc_html.c')
-rw-r--r--mdoc_html.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/mdoc_html.c b/mdoc_html.c
index c0a0a6a5..85969a19 100644
--- a/mdoc_html.c
+++ b/mdoc_html.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc_html.c,v 1.342 2021/03/30 19:26:20 schwarze Exp $ */
+/* $Id: mdoc_html.c,v 1.343 2022/06/24 11:15:53 schwarze Exp $ */
/*
* Copyright (c) 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
* Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
@@ -515,7 +515,7 @@ static int
mdoc_sh_pre(MDOC_ARGS)
{
struct roff_node *sn, *subn;
- struct tag *t, *tsec, *tsub;
+ struct tag *t, *tnav, *tsec, *tsub;
char *id;
int sc;
@@ -536,6 +536,7 @@ mdoc_sh_pre(MDOC_ARGS)
break;
if (sc < 2)
break;
+ tnav = print_otag(h, TAG_NAV, "r", "doc-toc");
t = print_otag(h, TAG_H1, "c", "Sh");
print_text(h, "TABLE OF CONTENTS");
print_tagq(h, t);
@@ -567,7 +568,7 @@ mdoc_sh_pre(MDOC_ARGS)
}
print_tagq(h, tsec);
}
- print_tagq(h, t);
+ print_tagq(h, tnav);
print_otag(h, TAG_SECTION, "c", "Sh");
break;
case ROFFT_HEAD: