• If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

View
 

Language styleguide

This version was saved 15 years, 1 month ago View current version     Page history
Saved by Richard D. Worth
on February 12, 2009 at 7:26:38 pm
 

NOTE: These are all early recommendations and we welcome your input. Current pages (unfortunately) do not follow these guidelines and are inconsistent. We'll update all pages once this is nailed down.

 

 

Writing style

 

Short, declarative sentences with a crisp, active voice directed at the designer or developer who will be using our tools. View Apple's interface guidelines for a good example of the tone we'd like to follow in this wiki. Try to cross-link related plugins whenever possible.

 

 

Capitalization

 

Plugins should be named as briefly and unambiguously as possible and in the singular. Ideally, these should be a single word like "tree" or "tab" but for longer names, we should separate words with spaces which is different than the current jQuery system. For example, we use "Progressbar" in the current documentation but "progress bar" is probably a more common way to write this. In a quick Google search, you find 3.5M results for "progressbar" and  12.3M results for "progress bar". This trend is consistent across all widget searches so it seems to be a better way to name components.

NOTE: this is a potentially big decision that could have ripples beyond this wiki so we need to discuss.

 

Plugin, page and section titles all use sentence capitalization. Only the first word is capitalized in a title, not each word.

Ex. "Language styleguide", not "Language Styleguide".

 

You can use spaces in wiki page titles -- these will appear in the URL as a "+" separator.

Ex. This page's URL is "http://jqueryui.pbwiki.com/Language+styleguide".

 

In the running text, plugins should be written in lower case with spaces.

Ex. "a select box is used...", not "a Select Box is used...".

 

 

 

Common terms

 

plugin - any jQuery widget or component

widget - a plugin that is a complete UI element that a user would interact with like a tab strip or calendar and will be styled in ThemeRoller

effect - a plugin that provides a visual effect like animation and easing       

interaction - a plugin that adds user interaction behavior to an element like draggable or resizable

utility - a plugin that adds a low-level capability or tool to the library like positioning or collision detection

 

 

 

 

Comments (0)

You don't have permission to comment on this page.