Feature #6677: Remove "Description" label from issues#show view - Redmine

Actions

Copy link

Feature #6677

closed

Remove "Description" label from issues#show view

Added by Dmitry Babenko over 13 years ago. Updated over 12 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Category:

Target version:

Start date:

2010-10-15

Due date:

% Done:

Estimated time:

Resolution:

Wont fix

Description

Description section on the issue#show view is obvious. So, this label can be removed. It will save one line of vertical space.

Just remove line
<%=l(:field_description)%>
from the app/views/issues/show.rhtml

Actions

Copy link

Updated by Dmitry Babenko over 13 years ago

Or even more: we can omit the whole description block if there are no description and no attachements.

Actions

Copy link

Updated by Jean-Philippe Lang over 13 years ago

Tracker changed from Patch to Feature
Status changed from New to Closed
Target version set to 1.1.0
Resolution set to Fixed

Change done in r4264.

Actions

Copy link

Updated by Eric Davis over 13 years ago

Status changed from Closed to Reopened

Description section on the issue#show view is obvious. So, this label can be removed. It will save one line of vertical space.

Actually, I'm going to argue against that. To non-visible users it's impossible to tell where the description is (e.g. blind or screen readers). Since r4264 it appears as a 'wiki' div with no other hint as to it's content:


<div class="wiki"> 
<p>Description section on the issue#show view is obvious. So, this label can be removed. It will save one line of vertical space.</p> 
    <p>Just remove line<br /><code>&lt;p&gt;&lt;strong&gt;&lt;/strong&gt;&lt;/p&gt;</code><br />from the <code>app/views/issues/show.rhtml</code></p> 
</div>

I propose:

keeping the Description label and hiding it with css, or
adding a css class to the description div (class="description" or something)

Actions

Copy link

Updated by Jean-Philippe Lang over 13 years ago

I don't think that readers actually read the css classes so 2. would be useless for that purpose.

Actions

Copy link

Updated by Holger Just over 13 years ago

I would also favor having the label. Currently, everything in Redmine is labeled (which I consider a good thing). I don't think we should remove that trait.

Also, this view is often extended by plugins to add additional sections. I consider it good practice to label these sections to properly distinguish them and define their meaning. In my eyes, clarity beats saving a few vertical pixel every day.

Actions

Copy link

Updated by Jean-Philippe Lang over 13 years ago

Holger Just wrote:

I would also favor having the label. Currently, everything in Redmine is labeled (which I consider a good thing). I don't think we should remove that trait.

That's not correct. The other descriptions are not labelled (eg. project, versions...).

Actions

Copy link

Updated by Dmitry Babenko over 13 years ago

Eric Davis wrote:

Actually, I'm going to argue against that. To non-visible users it's impossible to tell where the description is (e.g. blind or screen readers). Since r4264 it appears as a 'wiki' div with no other hint as to it's content:

Look at any other web page: product info, articles, blog posts pages, etc. They do not have any label for the content part. Just heading (h1..h6 followed by content).

Also, if we are talking about the semantics then instead of <table class="attributes"> here should be definition list (<dl>, <dt>, <dd>).

Actions

Copy link

Updated by Holger Just over 13 years ago

Dmitry Babenko wrote:

Look at any other web page: product info, articles, blog posts pages, etc. They do not have any label for the content part. Just heading (h1..h6 followed by content).

And the headings are exactly what he are talking about here. The tag-type might have been wrong (should indeed be a h2 or h3), but the label serves the purpose of a header.

Jean-Philippe Lang wrote:

The other descriptions are not labelled (eg. project, versions...).

Projects have the Overview header directly above the description. In the roadmap, it is indeed missing. But there is not much that can distract from the description there.

Actions

Copy link

Updated by Eric Davis over 13 years ago

Assignee set to Eric Davis

I've talked to an associate of mine, Brian P. Hogan, who deals with a lot of web accessibility and screen readers. His recommendation was to use a header tag since that is what is actually presenting (like what Dmitry Babenko suggested too).

<h3>Description</h3>
<p>...</p>

Actions

Copy link

#10

Updated by Jean-Baptiste Barth over 13 years ago

Eric Davis wrote:

I've talked to an associate of mine, Brian P. Hogan, who deals with a lot of web accessibility and screen readers. His recommendation was to use a header tag since that is what is actually presenting (like what Dmitry Babenko suggested too).

And then we would hide it via css ? The first request was about that, not about accessibility or semantics... I don't understand arguments about accessibility where everyone focuses on blind users only, without thinking of lambda users (not specific to redmine though).

Actions

Copy link

#11

Updated by Eric Davis over 13 years ago

Jean-Baptiste Barth wrote:

And then we would hide it via css ? The first request was about that, not about accessibility or semantics... I don't understand arguments about accessibility where everyone focuses on blind users only, without thinking of lambda users (not specific to redmine though).

I think removing it was wrong in the first place and having a header or label here was right thing to do (and a Description was only half right).

Actions

Copy link

#12