mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-06 08:52:46 +02:00
Code Issues Projects Releases Wiki Activity

MDL-65034 forum: add aria attributes to forum post

Browse Source
This commit is contained in:
Ryan Wyllie 2019-03-18 15:14:09 +08:00 committed by Mihail Geshoski
parent bef0fe2000
commit 53d743741e
4 changed files with 128 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
mod/forum/classes/local/exporters/author.php
View File

@ -82,9 +82,22 @@ class author extends exporter {
'null' => NULL_ALLOWED
],
'groups' => [
'type' => group_exporter::read_properties_definition(),
'multiple' => true,
'optional' => true,
'type' => [
'id' => ['type' => PARAM_INT],
'name' => ['type' => PARAM_TEXT],
'urls' => [
'type' => [
'image' => [
'type' => PARAM_URL,
'optional' => true,
'default' => null,
'null' => NULL_ALLOWED
]
]
]
]
],
'urls' => [
'type' => [
@ -122,6 +135,7 @@ class author extends exporter {
$imageurl = get_group_picture_url($group, $group->courseid);
return [
'id' => $group->id,
'name' => $group->name,
'urls' => [
'image' => $imageurl ? $imageurl->out(false) : null
]

13
mod/forum/classes/local/factories/renderer.php
View File

@ -187,6 +187,7 @@ class renderer {
function($exportedposts, $forums) use ($displaymode, $readonly, $exportedpostssorter) {
$forum = array_shift($forums);
$seenfirstunread = false;
$postcount = count($exportedposts);
$exportedposts = array_map(
function($exportedpost) use ($forum, $readonly, $seenfirstunread) {
if ($forum->get_type() == 'single' && !$exportedpost->hasparent) {
@ -196,6 +197,7 @@ class renderer {
$exportedpost->firstpost = false;
$exportedpost->readonly = $readonly;
$exportedpost->hasreplycount = false;
$exportedpost->hasreplies = false;
$exportedpost->replies = [];
@ -215,7 +217,14 @@ class renderer {
$sortintoreplies = function($nestedposts) use (&$sortintoreplies) {
return array_map(function($postdata) use (&$sortintoreplies) {
[$post, $replies] = $postdata;
$post->replies = $sortintoreplies($replies);
$sortedreplies = $sortintoreplies($replies);
// Set the parent author name on the replies. This is used for screen
// readers to help them identify the structure of the discussion.
$sortedreplies = array_map(function($reply) use ($post) {
$reply->parentauthorname = $post->author->fullname;
return $reply;
}, $sortedreplies);
$post->replies = $sortedreplies;
$post->hasreplies = !empty($post->replies);
return $post;
}, $nestedposts);
@ -232,6 +241,8 @@ class renderer {
if (!empty($exportedposts)) {
// Need to identify the first post so that we can use it in behat tests.
$exportedposts[0]->firstpost = true;
$exportedposts[0]->hasreplycount = true;
$exportedposts[0]->replycount = $postcount - 1;
}
return $exportedposts;

6
mod/forum/lang/en/forum.php
View File

@ -39,6 +39,7 @@ $string['anyfile'] = 'Any file';
$string['areaattachment'] = 'Attachments';
$string['areapost'] = 'Messages';
$string['attachment'] = 'Attachment';
$string['attachmentname'] = 'Attachment {$a}';
$string['attachment_help'] = 'You can optionally attach one or more files to a forum post. If you attach an image, it will be displayed after the message.';
$string['attachmentnopost'] = 'You cannot export attachments without a post id';
$string['attachments'] = 'Attachments';
@ -227,6 +228,7 @@ $string['everyoneisnowsubscribed'] = 'Everyone is now subscribed to this forum';
$string['everyoneissubscribed'] = 'Everyone is subscribed to this forum';
$string['existingsubscribers'] = 'Existing subscribers';
$string['exportdiscussion'] = 'Export whole discussion to portfolio';
$string['exportattachmentname'] = 'Export attachment {$a} to portfolio';
$string['forcedreadtracking'] = 'Allow forced read tracking';
$string['forcedreadtracking_desc'] = 'Allows forums to be set to forced read tracking. Will result in decreased performance for some users, particularly on courses with many forums and posts. When off, any forums previously set to Forced are treated as optional.';
$string['forcesubscribed_help'] = 'This forum has been configured so that you cannot unsubscribe from discussions.';
@ -290,6 +292,7 @@ $string['indicator:cognitivedepth_help'] = 'This indicator is based on the cogni
$string['indicator:socialbreadth'] = 'Forum social';
$string['indicator:socialbreadth_help'] = 'This indicator is based on the social breadth reached by the student in a Forum activity.';
$string['inforum'] = 'in {$a}';
$string['inreplyto'] = 'In reply to {$a}';
$string['introblog'] = 'The posts in this forum were copied here automatically from blogs of users in this course because those blog entries are no longer available';
$string['intronews'] = 'General news and announcements';
$string['introsocial'] = 'An open forum for chatting about anything you want to';
@ -408,6 +411,7 @@ $string['nownottracking'] = '{$a->name} is no longer tracking \'{$a->forum}\'.';
$string['nowsubscribed'] = '{$a->name} will be notified of new posts in \'{$a->forum}\'';
$string['nowtracking'] = '{$a->name} is now tracking \'{$a->forum}\'.';
$string['numposts'] = '{$a} posts';
$string['numberofreplies'] = 'Number of replies: {$a}';
$string['olderdiscussions'] = 'Older discussions';
$string['oldertopics'] = 'Older topics';
$string['oldpostdays'] = 'Read after days';
@ -419,6 +423,8 @@ $string['page-mod-forum-discuss'] = 'Forum module discussion thread page';
$string['parent'] = 'Show parent';
$string['parentofthispost'] = 'Parent of this post';
$string['permalink'] = 'Permalink';
$string['permanentlinktopost'] = 'Permanent link to this post';
$string['permanentlinktoparentpost'] = 'Permanent link to the parent of this post';
$string['postisprivatereply'] = 'This post was made privately and is not visible to all users.';
$string['posttomygroups'] = 'Post a copy to all groups';
$string['posttomygroups_help'] = 'Posts a copy of this message to all groups you have access to. Participants in groups you do not have access to will not see this post';

115
mod/forum/templates/forum_discussion_post.mustache
View File

@ -29,32 +29,51 @@
{
}
}}
<article id="p{{id}}" class="relativelink mb-2" tabindex="-1" data-post-id="{{id}}">
<article
id="p{{id}}"
class="relativelink mb-2"
data-post-id="{{id}}"
tabindex="-1"
aria-labelledby="post-header-{{id}}"
aria-describedby="post-content-{{id}}"
>
<!-- The firstpost and starter classes below aren't used for anything other than to identify the first post in behat -->
<div
class="d-flex border p-2 mb-2 forumpost {{#unread}}unread{{/unread}} {{#firstpost}}firstpost starter{{/firstpost}}"
aria-label='{{#str}} postbyuser, mod_forum, {"post": "{{subject}}", "user": "{{author.fullname}}"} {{/str}}'
>
{{#isfirstunread}}<a id="unread"></a>{{/isfirstunread}}
{{#isfirstunread}}<a id="unread" aria-hidden="true"></a>{{/isfirstunread}}
<div style="width: 45px;">
{{^isdeleted}}
{{#author}}
{{#urls.profileimage}}
<img class="rounded-circle w-100" src="{{{.}}}">
<img
class="rounded-circle w-100"
src="{{{.}}}"
alt="{{#str}} pictureof, core, {{author.fullname}} {{/str}}"
aria-hidden="true"
>
{{/urls.profileimage}}
{{#groups}}
<img class="rounded-circle w-100" src="{{{urls.image}}}">
<img
class="rounded-circle w-100"
src="{{{urls.image}}}"
alt="{{#str}} pictureof, core, {{name}} {{/str}}"
>
{{/groups}}
{{/author}}
{{/isdeleted}}
</div>
<div class="d-flex flex-column ml-2 w-100">
<header class="mb-2 header row">
<header id="post-header-{{id}}" class="mb-2 header row">
{{#parentauthorname}}
<span class="sr-only">{{#str}} inreplyto, mod_forum, {{.}} {{/str}}</span>
{{/parentauthorname}}
<h3 class="h6 font-weight-bold mb-0">{{$subject}}{{{subject}}}{{/subject}}</h3>
{{^isdeleted}}
<address>
<address tabindex="-1">
{{{html.authorsubheading}}}
</address>
{{/isdeleted}}
@ -63,8 +82,11 @@
{{#str}}postisprivatereply, forum{{/str}}
</div>
{{/isprivatereply}}
{{#hasreplycount}}
<span class="sr-only">{{#str}} numberofreplies, mod_forum, {{replycount}} {{/str}}</span>
{{/hasreplycount}}
</header>
<div>
<div id="post-content-{{id}}">
{{{message}}}
</div>
@ -76,7 +98,11 @@
{{#attachments}}
{{#isimage}}
<div>
<img src="{{{url}}}" alt="{{filename}}" style="max-width: 100%">
<img
src="{{{url}}}"
alt="{{#str}} attachmentname, mod_forum, {{filename}} {{/str}}"
style="max-width: 100%"
>
{{#urls.export}}
<a href="{{{.}}}" title="{{#str}} addtoportfolio, core_portfolio {{/str}}">
{{#pix}} t/portfolioadd, core {{/pix}}
@ -94,9 +120,14 @@
{{#attachments}}
{{^isimage}}
<div>
<a href="{{{url}}}">{{#pix}} {{icon}}, core {{/pix}} {{filename}}</a>
<a
href="{{{url}}}"
aria-label="{{#str}} attachmentname, mod_forum, {{filename}} {{/str}}"
>
{{#pix}} {{icon}}, core {{/pix}} {{filename}}
</a>
{{#urls.export}}
<a href="{{{.}}}" title="{{#str}} addtoportfolio, core_portfolio {{/str}}">
<a href="{{{.}}}" title="{{#str}} exportattachmentname, mod_forum, {{filename}} {{/str}}">
{{#pix}} t/portfolioadd, core {{/pix}}
</a>
{{/urls.export}}
@ -113,54 +144,98 @@
{{$actions}}
{{^readonly}}
<div class="d-flex justify-content-end">
<div
class="d-flex justify-content-end"
data-region="post-actions-container"
role="menubar"
aria-label='{{#str}} postbyuser, mod_forum, {"post": "{{subject}}", "user": "{{author.fullname}}"} {{/str}}'
aria-controls="p{{id}}"
>
{{#capabilities}}
{{#view}}
<a href="{{{urls.view}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.view}}}"
class="btn btn-link"
title="{{#str}} permanentlinktopost, mod_forum {{/str}}"
>
{{#str}} permalink, mod_forum {{/str}}
</a>
{{/view}}
{{#controlreadstatus}}
{{#unread}}
<a href="{{{urls.markasread}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.markasread}}}"
class="btn btn-link"
>
{{#str}} markread, mod_forum {{/str}}
</a>
{{/unread}}
{{^unread}}
<a href="{{{urls.markasunread}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.markasunread}}}"
class="btn btn-link"
>
{{#str}} markunread, mod_forum {{/str}}
</a>
{{/unread}}
{{/controlreadstatus}}
{{#urls.viewparent}}
<a href="{{{.}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{.}}}"
class="btn btn-link"
title="{{#str}} permanentlinktoparentpost, mod_forum {{/str}}"
>
{{#str}} parent, mod_forum {{/str}}
</a>
{{/urls.viewparent}}
{{#edit}}
<a href="{{{urls.edit}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.edit}}}"
class="btn btn-link"
>
{{#str}} edit, mod_forum {{/str}}
</a>
{{/edit}}
{{#split}}
<a href="{{{urls.split}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.split}}}"
class="btn btn-link"
>
{{#str}} prune, mod_forum {{/str}}
</a>
{{/split}}
{{#delete}}
<a href="{{{urls.delete}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.delete}}}"
class="btn btn-link"
>
{{#str}} delete, mod_forum {{/str}}
</a>
{{/delete}}
{{#reply}}
{{$replyoutput}}
<a href="{{{urls.reply}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.reply}}}"
class="btn btn-link"
>
{{#str}} reply, mod_forum {{/str}}
</a>
{{/replyoutput}}
{{/reply}}
{{#export}}
<a href="{{{urls.export}}}" class="btn btn-link">
<a
data-region="post-action"
href="{{{urls.export}}}"
class="btn btn-link"
>
{{#str}} addtoportfolio, core_portfolio {{/str}}
</a>
{{/export}}