Open Bug 852318 Opened 12 years ago Updated 4 years ago

Settle on a style for capitalizing section headings in Help content and apply it consistently

Categories

(SeaMonkey :: Help Documentation, defect)

defect
Not set
trivial

Tracking

(Not tracked)

People

(Reporter: rsx11m.pub, Unassigned)

Details

+++ This bug was initially created as a clone of Bug #847182 +++ (Quoting Stefan [:stefanh] bug 847182 from comment #11) > Hmm, I'm quite convinced that "Are" in Why and How Are Websites Tracking > Me?" should be all lower-case (look at other headings). (Quoting rsx11m from bug 847182 comment #17) > To follow up on this question, "are" is here the present plural of "be" and > used as an auxiliary verb (says Merriam-Webster). In the style guides I've > looked up, verbs in headings are capitalized, thus I'd think that we are > doing it right here (though I've seen titles with lower-case "is" and "are"). Several different styles are used throughout the Help text, we should settle for one version and apply it consistently. The auxiliary verb "Are" is now used in upper case for all section headings: > customize_help.xhtml:740:<h3 id="what_are_bookmarks">What Are Bookmarks?</h3> > privacy_help.xhtml:117:<h2 id="what_are_cookies_and_how_do_they_work">What Are Cookies, and How Do > privacy_help.xhtml:145:<h3 id="what_are_third-party_cookies">What Are Third-Party Cookies?</h3> > privacy_help.xhtml:174:<h2 id="why_and_how_are_websites_tracking_me">Why and How Are Websites > privacy_help.xhtml:203:<h3>What Are the Mechanisms of User Tracking?</h3> In contrast, the related "is" comes in lower case only: > customize_help.xhtml:71:<h3 id="what_is_sidebar">What is Sidebar?</h3> > customize_help.xhtml:250:<h3 id="what_is_tabbed_browsing">What is Tabbed Browsing?</h3> In comparison, "with" comes in both upper and lower case versions: > composer_help.xhtml:1371:<h2 id="creating_links_within_the_same_page">Creating Links Within the Same > mailnews_newsgroups.xhtml:21:<h1 id="getting_started_with_newsgroups">Getting Started With Newsgroups</h1> > mailnews_organizing.xhtml:129:<h2 id="sharing_folders_with_other_users">Sharing Folders With Other Users > nav_help.xhtml:606:<h2 id="searching_within_a_page">Searching Within a Page</h2> > composer_help.xhtml:17:<h1 id="creating_web_pages_with_mozilla_composer">Creating Web Pages with > composer_help.xhtml:339:<h2 id="working_with_lists">Working with Lists</h2> > mailnews_getting_started.xhtml:88:<h1 id="getting_started_with_mozilla_mail_and_newsgroups">Getting Started with > nav_help.xhtml:1316:<h3 id="search_with_keywords">Search with Keywords</h3> There are other examples like "Do" vs. "do", etc. Depending on which guide one uses as a reference, different styles are advised. Most if not all would capitalize nouns, verbs, adjectives, and adverbs in the title. There are differences already when it comes to pronouns or auxiliary verbs (like forms of "to be" as in the given case). Conjunctions (and, or, nor, but), articles (a, an, the), and prepositions (as, at, by, for, in, of, on, per, to) are in general supposed to remain lowercase. A nice summary of the different levels of capitalization in section headings is given in this post, with the relevant excerpts cited below from http://answers.yahoo.com/question/index?qid=20080528090320AAZzCfs 1. The Vitamins Are In My Fresh Brussels Sprouts (capitalization of all words, regardless of the part of speech) 2. The Vitamins Are in My Fresh Brussels Sprouts (capitalization of all words, except for internal articles, prepositions and conjunctions) 3. The Vitamins are in My Fresh Brussels Sprouts (capitalization of all words, except for internal articles, prepositions, conjunctions and forms of to be) 4. The Vitamins are in my Fresh Brussels Sprouts (capitalization of all words, except for internal closed-class words) 5. The Vitamins are in my fresh Brussels Sprouts (capitalization of all nouns) 6. The vitamins are in my fresh Brussels sprouts (sentence-style capitalization, only the first word and proper nouns are capitalized) Currently SeaMonkey's Help seems to be using a mixture of levels 2.-4. Though this is trivial in severity (not in effort), it would make the Help sections look more professional.
You need to log in before you can comment on or make changes to this bug.