[wp-docs] Quoting UI items in Help Tabs

[Tom Auger (personal)]

Doug writes:

" One stylistic quibble: most of the help tabs do not use quote marks for  
words/phrases/actions that are in the interface. Just capitalize the first  
letter: Customize, not "Customize" -- cleaner, less visual noise. We do not 
yet  have a Style Guide for the tabs... "

I hear you, and I agree that we should normalize our approach to writing
style within the Help tabs.

As I explained on the ticket, however, I do feel strongly that the use of
quotes when describing a specific UI element actually helps to disambiguate
the interface element from the context in which it appears within the
sentence. 

Doug's example of "Customize" vs. Customize works, but consider some of the
other UI elements that I need to refer to in the tabs: "Choose from image
library" and "Set as header". Those links are in sentence case and I feel
it's stylistically and grammatically incorrect to omit the quote marks,
which both serve to visually group those items together and keep them
distinct from the sentence, as well as to make it obvious that that clause
is the object of the sentence.

Anyway, sorry for being so pedantic about this.  It's a best practice I've
been using for 15 years. I'm eager to hear others' opinions of the matter,
especially in the context of sentence case hyperlinks.

Tom



------------------------------

Message: 2
Date: Sun, 22 Apr 2012 14:07:58 -0400 (EDT)
From: HeyMrPro at aol.com
Subject: Re: [wp-docs] 3.4 Help Tabs - Themes section
To: wp-docs at lists.automattic.com
Message-ID: <9397.2a8d3d2f.3cc5a2fe at aol.com>
Content-Type: text/plain; charset="us-ascii"

Hi Tom,
 
In the past, we've done one omnibus ticket for all the help tabs. I don't  
know if that's preferred or not this time. Maybe a separate ticket for each

section (Appearance, etc.)
 
One stylistic quibble: most of the help tabs do not use quote marks for  
words/phrases/actions that are in the interface. Just capitalize the first  
letter: Customize, not "Customize" -- cleaner, less visual noise. We do not 
yet  have a Style Guide for the tabs...
 
I'll comment on the ticket too, but thought people on this list might  want 
to weigh in as well.
 
Doug Provencio
 
 
In a message dated 4/22/2012 10:43:28 A.M. Pacific Daylight Time,  
tomaugerdotcom at yahoo.ca writes:

New help  tabs for the Themes section have been submitted in a patch to Trac
#20515  (http://core.trac.wordpress.org/ticket/20515). I didn't know where  
to
attach them, so I just created a new ticket and copied Jane and Koop on  it.
Minor revisions to existing tabs, some cosmetic code cleanup and then  two
new tabs - one for the Manage Themes and one for the Install Themes  page.

Logged a number of bug reports as well, while I was putting it  through its
paces.

I hope I'm doing this right. If there's a better  process, someone please
reach out and let me  know!

Tom

----------------------------------------------------------------------

Message:  1
Date: Fri, 20 Apr 2012 06:56:29 -0400
From: Jane Wells  <jane at automattic.com>
Subject: [wp-docs] 3.4 help tabs
To:  wp-docs at lists.automattic.com
Message-ID:  <4F9140DD.3030909 at automattic.com>
Content-Type: text/plain;  charset=ISO-8859-1; format=flowed

Hi all. 3.4 beta 3 comes out this  morning, which means RC (and string 
freeze) is right around the corner.  I'll be putting together the updated 
text for the About WordPress admin  screen and was hoping I might find a 
volunteer or two to whip up some help  tab patches this weekend to get 
the help tabs caught up with some of the  new features. Off the top of my 
head, flex headers, the  previewer/customizer, and html in captions need 
to be added (also to  Codex). I have someone taking screenshots of these 
for the About screen,  so those will be available for the Codex  soon.
j


------------------------------

_______________________________________________
wp-docs  mailing  list
wp-docs at lists.automattic.com
http://lists.automattic.com/mailman/listinfo/wp-docs


End  of wp-docs Digest, Vol 79, Issue  24
***************************************

_______________________________________________
wp-docs  mailing  list
wp-docs at lists.automattic.com
http://lists.automattic.com/mailman/listinfo/wp-docs

-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.automattic.com/pipermail/wp-docs/attachments/20120422/239a5260
/attachment-0001.htm>

------------------------------

_______________________________________________
wp-docs mailing list
wp-docs at lists.automattic.com
http://lists.automattic.com/mailman/listinfo/wp-docs


End of wp-docs Digest, Vol 79, Issue 27
***************************************