Re: [platform-doc-dev] Capitalization

["Debbie Wilson" <Debbie_Wilson@xxxxxxxxxx>]

I don't agree with the bold suggestion here.  Let's not have too much stuff screaming at readers.  Save the bold words for when we really need it.  Too much bold and it loses its effectiveness.

                     Deb

Mike Behm <mbehm@xxxxxxxxxx> Sent by: platform-doc-dev-admin@xxxxxxxxxxx 03/18/2003 02:50 PM Please respond to platform-doc-dev

To:        platform-doc-dev@xxxxxxxxxxx         cc:                 Subject:        Re: [platform-doc-dev] Capitalization

John Arthorne wrote:
 > ...

> A much trickier case is proper nouns.  I believe things like "Tasks 
> View", "File Menu", and "Export Wizard" are all proper nouns, and as 
> such both words should always be capitalized.  The documentation more 
> commonly uses "Tasks view", "File menu", and "Export wizard", but I 
> think this is not correct.  Correct me if I'm wrong here, but unless I 
> hear otherwise I'll correct these problems where I see them.





Here is a sentence from the Workbench User Guide:
  The Navigator view provides a hierarchical view of the resources
  in the Workbench.

"Navigator" is the name of a product feature and takes a capital. 
Because this name also appears on a title bar, it could be marked in 
bold. "Workbench" is also a product name and should be capitalized; 
however, the name doesn't appear in a title bar, so it should not be in 
bold. "View" should not be in bold, as it does not appear in a title 
bar, but should it be capitalized? Consider this usage:
  The Navigator, Tasks, and Outline views are open...

Because the text uses "view" almost optionally ("open the Navigator" as 
opposed to "open the Navigator view"), I think that it would be 
difficult to capitalize view throughout the help without it looking a 
little odd in places. If you also apply bolding to the view names, 
capitalizing "view" is even more of a problem.

I'd suggest that the markup should be:
  The <b>Navigator</b> view provides a hierarchical view of the resources
  in the Workbench.
And if there are any long-term plans to convert to SGML or XML:
  The <span class="guilabel">Navigator</span> view provides a
  hierarchical view of the resources in the Workbench.


Mike



_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-doc-dev