Thunderbird:Help Documentation:Style Guidelines: Difference between revisions

m
note about link syntax
(Info about wiki markup, and how to do links)
m (note about link syntax)
Line 15: Line 15:
'''Don't use wiki markup!'''  We won't be able to use wiki markup when the docs get added to the source code, and most HTML markup is still valid in this wiki.
'''Don't use wiki markup!'''  We won't be able to use wiki markup when the docs get added to the source code, and most HTML markup is still valid in this wiki.


'''Use wiki markup for links!'''  Link directly to the location of the page, like so: [http://wiki.mozilla.org/index.php/Thunderbird:Help_Documentation:Style_Guidelines Style Guidelines].  When the docs get moved over into the main tree, we'll do a search for "[http://" to find instances of wiki links.  It's pretty bad, but at least the links will be testable without edits.
'''Use wiki markup for links!'''  Link directly to the location of the page, like so (edit this page to see the code used): [http://wiki.mozilla.org/index.php/Thunderbird:Help_Documentation:Style_Guidelines Style Guidelines].  When the docs get moved over into the main tree, we'll do a search for "[http://" to find instances of wiki links.  It's pretty bad, but at least the links will be testable without edits.


'''Don't manually wrap lines!'''  Let them get wrapped by the wiki.  It looks bad in the wiki, and wrapping them for when they go on the mozilla.org site is relatively trivial.
'''Don't manually wrap lines!'''  Let them get wrapped by the wiki.  It looks bad in the wiki, and wrapping them for when they go on the mozilla.org site is relatively trivial.
Confirmed users
446

edits