From: "Anna “CyberTailor”" <cyber@sysrq.in>
To: tech@mandoc.bsd.lv
Subject: [PATCH 5/8] man.cgi: add ARIA roles and semantics
Date: Tue, 21 Jun 2022 17:27:46 +0500 [thread overview]
Message-ID: <20220621122749.11417-6-cyber@sysrq.in> (raw)
In-Reply-To: <20220621122749.11417-1-cyber@sysrq.in>
---
cgi.c | 61 ++++++++++++++++++++++++++++++++++++++++++-----------------
1 file changed, 44 insertions(+), 17 deletions(-)
diff --git a/cgi.c b/cgi.c
index da9e408d..71f9a8ac 100644
--- a/cgi.c
+++ b/cgi.c
@@ -431,7 +431,8 @@ resp_searchform(const struct req *req, enum focus focus)
{
int i;
- printf("<form action=\"/%s\" method=\"get\" "
+ printf("<header>\n"
+ "<form role=\"search\" action=\"/%s\" method=\"get\" "
"autocomplete=\"off\" autocapitalize=\"none\">\n"
" <fieldset>\n"
" <legend>Manual Page Search Parameters</legend>\n",
@@ -457,7 +458,7 @@ resp_searchform(const struct req *req, enum focus focus)
/* Write section selector. */
- puts(" <select name=\"sec\">");
+ puts(" <select name=\"sec\" aria-label=\"Manual section\">");
for (i = 0; i < sec_MAX; i++) {
printf(" <option value=\"%s\"", sec_numbers[i]);
if (NULL != req->q.sec &&
@@ -469,7 +470,7 @@ resp_searchform(const struct req *req, enum focus focus)
/* Write architecture selector. */
- printf( " <select name=\"arch\">\n"
+ printf( " <select name=\"arch\" aria-label=\"CPU architecture\">\n"
" <option value=\"default\"");
if (NULL == req->q.arch)
printf(" selected=\"selected\"");
@@ -499,7 +500,8 @@ resp_searchform(const struct req *req, enum focus focus)
}
puts(" </fieldset>\n"
- "</form>");
+ "</form>\n"
+ "</header>");
}
static int
@@ -557,13 +559,17 @@ pg_index(const struct req *req)
resp_begin_html(200, NULL, NULL);
resp_searchform(req, FOCUS_QUERY);
- printf("<p>\n"
+ printf("<main>\n"
+ "<p role=\"doc-notice\" aria-label=\"Usage\">\n"
"This web interface is documented in the\n"
- "<a class=\"Xr\" href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"
+ "<a class=\"Xr\" href=\"/%s%sman.cgi.8\""
+ " aria-label=\"man dot CGI, section 8\">man.cgi(8)</a>\n"
"manual, and the\n"
- "<a class=\"Xr\" href=\"/%s%sapropos.1\">apropos(1)</a>\n"
+ "<a class=\"Xr\" href=\"/%s%sapropos.1\""
+ " aria-label=\"apropos, section 1\">apropos(1)</a>\n"
"manual explains the query syntax.\n"
- "</p>\n",
+ "</p>\n"
+ "</main>\n",
scriptname, *scriptname == '\0' ? "" : "/",
scriptname, *scriptname == '\0' ? "" : "/");
resp_end_html();
@@ -575,9 +581,11 @@ pg_noresult(const struct req *req, int code, const char *http_msg,
{
resp_begin_html(code, http_msg, NULL);
resp_searchform(req, FOCUS_QUERY);
- puts("<p>");
+ puts("<main>");
+ puts("<p role=\"doc-notice\" aria-label=\"No result\">");
puts(user_msg);
puts("</p>");
+ puts("</main>");
resp_end_html();
}
@@ -586,12 +594,14 @@ pg_error_badrequest(const char *msg)
{
resp_begin_html(400, "Bad Request", NULL);
- puts("<h1>Bad Request</h1>\n"
- "<p>\n");
+ puts("<main>"
+ "<h1>Bad Request</h1>\n"
+ "<p role=\"doc-notice\" aria-label=\"Bad Request\">\n");
puts(msg);
printf("Try again from the\n"
"<a href=\"/%s\">main page</a>.\n"
- "</p>", scriptname);
+ "</p>\n"
+ "</main>", scriptname);
resp_end_html();
}
@@ -599,7 +609,7 @@ static void
pg_error_internal(void)
{
resp_begin_html(500, "Internal Server Error", NULL);
- puts("<p>Internal Server Error</p>");
+ puts("<main><p role=\"doc-notice\">Internal Server Error</p></main>");
resp_end_html();
}
@@ -625,7 +635,7 @@ pg_redirect(const struct req *req, const char *name)
static void
pg_searchres(const struct req *req, struct manpage *r, size_t sz)
{
- char *arch, *archend;
+ char *arch, *archend, *name = NULL, *label = NULL;
const char *sec;
size_t i, iuse;
int archprio, archpriouse;
@@ -704,11 +714,20 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
if (sz > 1) {
+ puts("<nav>");
puts("<table class=\"results\">");
for (i = 0; i < sz; i++) {
+ // FIXME: there has to be a way to do this without
+ // truncating
+ name = mandoc_strdup(r[i].names);
+ name[strlen(name)-3] = '\0';
+ mandoc_asprintf(&label, "%s, section %d",
+ name, r[i].sec);
+
printf(" <tr>\n"
" <td>"
- "<a class=\"Xr\" href=\"/");
+ "<a class=\"Xr\" aria-label=\"%s\" href=\"/",
+ label);
if (*scriptname != '\0')
printf("%s/", scriptname);
if (strcmp(req->q.manpath, req->p[0]))
@@ -720,8 +739,10 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
html_print(r[i].output);
puts("</span></td>\n"
" </tr>");
+ free(label);
}
puts("</table>");
+ puts("</nav>");
}
if (req->q.equal || sz == 1) {
@@ -743,7 +764,9 @@ resp_catman(const struct req *req, const char *file)
int italic, bold;
if ((f = fopen(file, "r")) == NULL) {
- puts("<p>You specified an invalid manual file.</p>");
+ puts("<p role=\"doc-notice\">\n"
+ " You specified an invalid manual file.\n"
+ "</p>");
return;
}
@@ -880,7 +903,9 @@ resp_format(const struct req *req, const char *file)
int usepath;
if (-1 == (fd = open(file, O_RDONLY))) {
- puts("<p>You specified an invalid manual file.</p>");
+ puts("<p role=\"doc-notice\">\n"
+ " You specified an invalid manual file.\n"
+ "</p>");
return;
}
@@ -900,10 +925,12 @@ resp_format(const struct req *req, const char *file)
usepath ? req->q.manpath : "", usepath ? "/" : "");
vp = html_alloc(&conf);
+ puts("<main>");
if (meta->macroset == MACROSET_MDOC)
html_mdoc(vp, meta);
else
html_man(vp, meta);
+ puts("</main>");
html_free(vp);
mparse_free(mp);
--
2.35.1
--
To unsubscribe send an email to tech+unsubscribe@mandoc.bsd.lv
next prev parent reply other threads:[~2022-06-21 12:28 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-21 12:27 [PATCH 0/8] Make generated HTML more accessible Anna “CyberTailor”
2022-06-21 12:27 ` [PATCH 1/8] mdoc_html: Accessibility markup for ToC Anna “CyberTailor”
2022-06-21 12:27 ` [PATCH 2/8] mdoc_html: Add DPUB-ARIA roles to sections Anna “CyberTailor”
2022-06-24 13:58 ` Ingo Schwarze
2022-06-21 12:27 ` [PATCH 3/8] mdoc_html: Add DPUB-ARIA roles to subsections Anna “CyberTailor”
2022-06-21 12:27 ` [PATCH 4/8] man_html: Add DPUB-ARIA roles to (sub)sections Anna “CyberTailor”
2022-06-21 12:27 ` Anna “CyberTailor” [this message]
2022-07-04 16:37 ` [PATCH 5/8] man.cgi: add ARIA roles and semantics Ingo Schwarze
2022-06-21 12:27 ` [PATCH 6/8] mdoc_html: Add accessible description to crosslinks Anna “CyberTailor”
2022-06-25 12:58 ` Ingo Schwarze
2022-06-21 12:27 ` [PATCH 7/8] mdoc_html: Tell screen readers to skip the header Anna “CyberTailor”
2022-06-26 15:51 ` Ingo Schwarze
2022-06-28 16:33 ` Anna “CyberTailor”
2022-06-21 12:27 ` [PATCH 8/8] man_html: " Anna “CyberTailor”
2022-06-22 19:15 ` [PATCH 0/8] Make generated HTML more accessible Ingo Schwarze
2022-06-22 19:40 ` Anna “CyberTailor”
2022-06-23 13:34 ` Ingo Schwarze
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220621122749.11417-6-cyber@sysrq.in \
--to=cyber@sysrq.in \
--cc=tech@mandoc.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).