Writing style
Short, decrative 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 plug-ins whenever possible.
Capitalization
Plug-ins 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 so we need to discuss.
Plug-in, 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, plug-ins should be written in lower case with spaces.
Ex. "a select box is used...", not "a Select Box is used...".
Common terms
plug-in - any jQuery widget or component
widget - a plug-in 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 plug-in that is provdes a visual effect like animation and easing
interaction - a plug-in that adds user interaction behavior to an element like draggable or resizable
utility - a plug-in that adds a low-level capability or tool to the library like positioning or collistion detection
Comments (0)
You don't have permission to comment on this page.