1,365
edits
Support:Style Guide: Difference between revisions
Jump to navigation
Jump to search
Plugins does not contain a hyphen
(add 'read me first') |
(Plugins does not contain a hyphen) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
==Terminology== | ==Terminology== | ||
In cases where you are not sure of proper terminology, or if an element has more than one name, use the term in the user-interface. For instance, in the customize toolbar screen, the term used for the location bar is "Location" bar, not "Address" bar, or "URL" bar. Other often used terms: | In cases where you are not sure of proper terminology, or if an element has more than one name, use the term in the user-interface. For instance, in the customize toolbar screen, the term used for the location bar is "Location" bar, not "Address" bar, or "URL" bar. Other often used terms: | ||
* | * Plugins does not contain a hyphen (it is not plug-ins). | ||
* Add-ons contains a hyphen (it is not addons). | * Add-ons contains a hyphen (it is not addons). | ||
* It's "web feeds", not "RSS feeds". | * It's "web feeds", not "RSS feeds". | ||
| Line 41: | Line 41: | ||
* Bad: CD-ROM's | * Bad: CD-ROM's | ||
==Capitalization | ==Capitalization== | ||
Capitalize the following items: | |||
* '''<span style="color: #006600">Good</span>''': How to make Firefox your default browser | * Proper nouns | ||
* Bad: How | * The letters of many abbreviations and acronyms | ||
* The first letter of the first word in numbered or bulleted lists | |||
* The first letter of each term that identifies the name of a key on the keyboard | |||
* The first letter of the first word of a complete sentence | |||
* The first letter of the first word of a complete sentence following a colon | |||
* The first letter of the first word in a title or heading | |||
** '''<span style="color: #006600">Good</span>''': How to make Firefox your default browser | |||
** Bad: How To Make Firefox Your Default Browser | |||
==Dates== | ==Dates== | ||
| Line 91: | Line 96: | ||
===Preference names / values=== | ===Preference names / values=== | ||
Enclose preference name and values in the designated preference tags. | |||
===User scripts (user.js, userChrome.css, userContent.css)=== | ===User scripts (user.js, userChrome.css, userContent.css)=== | ||
Enclose user scripts in the designated code tags.<br> | |||
<nowiki>{img src=images/code.png}%%% {CODE()} | |||
text | |||
{CODE}</nowiki> | |||
===File names / paths=== | ===File names / paths=== | ||
Enclose file names and file paths in the designated filename tags. | |||
===Keyboard shortcuts=== | ===Keyboard shortcuts=== | ||
Enclose keyboard shortcuts in the designated keyboard tags.<br> | |||
<nowiki>{TAG(tag=kbd)}text{TAG}</nowiki> | |||
===Menu paths=== | ===Menu paths=== | ||
Enclose menu paths in the designated menu tags.<br> | |||
<nowiki>{DIV(class=mnu,type=>span)}text{DIV}</nowiki> | |||
==References== | ==References== | ||
Links to any bug pages on Bugzilla should be treated as references. [We still need to figure out what we can do with this on tikiwiki.] | Links to any bug pages on Bugzilla should be treated as references. [We still need to figure out what we can do with this on tikiwiki.] | ||