WebAIM - Web Accessibility In Mind

E-mail List Archives

Thread: heading structure quandry

for

Number of posts in this thread: 7 (In chronological order)

From: Trafford, Logan
Date: Mon, Jan 19 2015 10:04AM
Subject: heading structure quandry
No previous message | Next message →

Looking for opinions. I will try to summarize the issue as succinctly as possible.

I’m building a Word template (for reports) that get converted to PDF and posted to external website. Once the Word document is completed, the author has no further control (i.e. the conversion to PDF is done in batch mode automatically and they can’t remediate the PDF after the fact).

The natural Heading 1 of the document is the text that appears at the top of the doc which is “Report to XYZ Committee”, followed by additional (normal text) that identifies date, who submitted it etc. and THEN the actual subject matter of the report.

Example:
Report to XYZ Committee
January 15, 2015
Submitted by: Jane Doe
Contact Person: Barney Fife
Ward:
File #
Subject:

My issue is that while it is natural to style the main title (Report to XYZ Committee) as a Heading 1 (and also enter it as the title in the Properties of the document), there may be hundreds of these reports converted to PDF and posted to the website on a yearly basis that would end up having the exact same title, thus potentially having an adverse effect on search capabilities.

Would it make more sense to have the unique “Subject:” of the document styled as the Heading 1 instead and the “Report to XXX Committee” as a Heading 2. I do realize that automated checkers will fail for having skipped heading levels, but that’s not the end of the world. Or am I simply over-thinking this and it wouldn’t make much of a difference either way (from and A11Y perspective), thus having the generic “Report to XYZ Committee” on multiple documents being totally acceptable.

Appreciate any input.
Thanks,

Logan Trafford

This e-mail originates from the City of Ottawa e-mail system. Any distribution, use or copying of this e-mail or the information it contains by other than the intended recipient(s) is unauthorized. Thank you.

Le présent courriel a été expédié par le système de courriels de la Ville d'Ottawa. Toute distribution, utilisation ou reproduction du courriel ou des renseignements qui s'y trouvent par une personne autre que son destinataire prévu est interdite. Je vous remercie de votre collaboration.

From: L Snider
Date: Mon, Jan 19 2015 10:36AM
Subject: Re: heading structure quandry
← Previous message | Next message →

Hello Logan,

An interesting problem...How about this? I think the H1 should be unique,
so how about this compromise?

For the title use Report to XYZ Committee-SUBJECT
It is repetitive, which is the drawback...but it gets the point across
right away-for all viewers.

Could you take Subject out all together?

Cheers

Lisa

Archivist | Archiviste

Canadian Museum for Human Rights | Musée canadien pour les droits de la
personne



On Mon, Jan 19, 2015 at 11:04 AM, Trafford, Logan < = EMAIL ADDRESS REMOVED = >
wrote:

> Looking for opinions. I will try to summarize the issue as succinctly as
> possible.
>
> I'm building a Word template (for reports) that get converted to PDF and
> posted to external website. Once the Word document is completed, the author
> has no further control (i.e. the conversion to PDF is done in batch mode
> automatically and they can't remediate the PDF after the fact).
>
> The natural Heading 1 of the document is the text that appears at the top
> of the doc which is "Report to XYZ Committee", followed by additional
> (normal text) that identifies date, who submitted it etc. and THEN the
> actual subject matter of the report.
>
> Example:
> Report to XYZ Committee
> January 15, 2015
> Submitted by: Jane Doe
> Contact Person: Barney Fife
> Ward:
> File #
> Subject:
>
> My issue is that while it is natural to style the main title (Report to
> XYZ Committee) as a Heading 1 (and also enter it as the title in the
> Properties of the document), there may be hundreds of these reports
> converted to PDF and posted to the website on a yearly basis that would end
> up having the exact same title, thus potentially having an adverse effect
> on search capabilities.
>
> Would it make more sense to have the unique "Subject:" of the document
> styled as the Heading 1 instead and the "Report to XXX Committee" as a
> Heading 2. I do realize that automated checkers will fail for having
> skipped heading levels, but that's not the end of the world. Or am I
> simply over-thinking this and it wouldn't make much of a difference either
> way (from and A11Y perspective), thus having the generic "Report to XYZ
> Committee" on multiple documents being totally acceptable.
>
> Appreciate any input.
> Thanks,
>
> Logan Trafford
>
> This e-mail originates from the City of Ottawa e-mail system. Any
> distribution, use or copying of this e-mail or the information it contains
> by other than the intended recipient(s) is unauthorized. Thank you.
>
> Le présent courriel a été expédié par le système de courriels de la Ville
> d'Ottawa. Toute distribution, utilisation ou reproduction du courriel ou
> des renseignements qui s'y trouvent par une personne autre que son
> destinataire prévu est interdite. Je vous remercie de votre collaboration.
> > > >

From: Trafford, Logan
Date: Mon, Jan 19 2015 10:40AM
Subject: Re: heading structure quandry
← Previous message | Next message →

I wish it were that simple. Unfortunately due to reasons that are far too complex to attempt to explain (political more than anything), the order of appearance (of existing text) cannot change.


From: Pratik Patel
Date: Mon, Jan 19 2015 10:42AM
Subject: Re: heading structure quandry
← Previous message | Next message →

Is there a particular business case for "Refer to XYZ Committee" line to be
the first? In addition, there is nothing to suggest that the first line has
to be enclosed in a heading. If you're unable to reverse the two lines,
consider skipping the heading on the first line.

Regards,

Pratik



Pratik Patel
Founder and CEO, EZFire
T: 888-320-2921
M: 718-249-7019
E: = EMAIL ADDRESS REMOVED = (or = EMAIL ADDRESS REMOVED = )
Follow me on Twitter: @ppatel
Follow me on LinkedIn: http://www.linkedin.com/pub/pratik-patel/9/985/882
Skype: Patel.pratik


From: L Snider
Date: Mon, Jan 19 2015 10:49AM
Subject: Re: heading structure quandry
← Previous message | Next message →

Hi Logan,

Makes it tougher, but then I would suggest doubling the info, if you can
(putting subject in the subject line and title). If not, then geez that is
a tough one. I would do title as H1 and subject as H2.

Cheers

Lisa

On Mon, Jan 19, 2015 at 11:40 AM, Trafford, Logan < = EMAIL ADDRESS REMOVED = >
wrote:

> I wish it were that simple. Unfortunately due to reasons that are far too
> complex to attempt to explain (political more than anything), the order of
> appearance (of existing text) cannot change.
>
>
>

From: Lynn Holdsworth
Date: Mon, Jan 19 2015 11:02AM
Subject: Re: heading structure quandry
← Previous message | Next message →

I'd go with Pratik's suggestion: pretty the top title up using styles,
and still have the specific subject as the H1. One concern would be
whether the more specific heading still makes it clear, in search
results and such, that this is a Report to XYZ Committee.

On 19/01/2015, L Snider < = EMAIL ADDRESS REMOVED = > wrote:
> Hi Logan,
>
> Makes it tougher, but then I would suggest doubling the info, if you can
> (putting subject in the subject line and title). If not, then geez that is
> a tough one. I would do title as H1 and subject as H2.
>
> Cheers
>
> Lisa
>
> On Mon, Jan 19, 2015 at 11:40 AM, Trafford, Logan < = EMAIL ADDRESS REMOVED = >
> wrote:
>
>> I wish it were that simple. Unfortunately due to reasons that are far too
>> complex to attempt to explain (political more than anything), the order of
>> appearance (of existing text) cannot change.
>>
>>
>>

From: Cliff Tyllick
Date: Fri, Jan 23 2015 8:40AM
Subject: Re: heading structure quandry
← Previous message | No next message

Logan, in my opinion, Pratik's approach is on target: Make "Report to XYZ Committee" a distinct style.

Subtitle might work. Whether it does depends on what the various titles are like—do they ever have subtitles of their own?

But I'll add this wrinkle: "Report to XYZ Committee" belongs in the metadata. If you can use one of the fields that Word lets you embed into the body of the document (so that editing it in either location also updates the other), all the better.

I'd have to open Word to see which field would work best, and I'm away from the computer just now. But I'm sure you can find a good candidate.

Best to you,
Cliff

Cliff Tyllick

Sent from my iPhone
Although its spellcheck often saves me, all goofs in sent messages are its fault.

> On Jan 19, 2015, at 12:02 PM, Lynn Holdsworth < = EMAIL ADDRESS REMOVED = > wrote:
>
> I'd go with Pratik's suggestion: pretty the top title up using styles,
> and still have the specific subject as the H1. One concern would be
> whether the more specific heading still makes it clear, in search
> results and such, that this is a Report to XYZ Committee.
>
>> On 19/01/2015, L Snider < = EMAIL ADDRESS REMOVED = > wrote:
>> Hi Logan,
>>
>> Makes it tougher, but then I would suggest doubling the info, if you can
>> (putting subject in the subject line and title). If not, then geez that is
>> a tough one. I would do title as H1 and subject as H2.
>>
>> Cheers
>>
>> Lisa
>>
>> On Mon, Jan 19, 2015 at 11:40 AM, Trafford, Logan < = EMAIL ADDRESS REMOVED = >
>> wrote:
>>
>>> I wish it were that simple. Unfortunately due to reasons that are far too
>>> complex to attempt to explain (political more than anything), the order of
>>> appearance (of existing text) cannot change.
>>>
>>>
>>>