Skip to page content or Skip to Accesskey List.

Work

Main Page Content

Submission Style Guide Code 2001

Rated 4.33 (Ratings: 27)

Want more?

  • More articles in FAQ
 
Picture of aardvark

Adrian Roselli

Member info

User since: 14 Dec 1998

Articles written: 85

This document outlines the acceptable tags for use in posting articles. Please note that while you may use other tags, our editors (or our CMS) will most likely remove them before posting. This site is coded to xHTML 1.0 Transitional, so please only use elements and attributes from that specification. In particular, please remember:

  • All tags must be properly nested
  • and
    tags need to be self closing: bar and
  • All markup must be in lower case, and all attributes quoted

<h#> Tags and Their Use

The tags should be used for section headings. Using

is forbidden since that is the top-most title of every page. Please use them in order; don't skip to

without first using

. For your settings, the tags will render as:

This is the <h2> tag

This is the <h3> tag

This is the <h4> tag

This is the <h5> tag

This is the <h6> tag

Paragraphs

Please wrap each paragraph within a

pair.

Styling Text

Bold

Please use the pair to strongly emphasise. This is preferred to since it describes structure instead of style.

This is bold text

Italic

Please use the pair to emphasise text. This is preferred to since it describes structure instead of style.

This is italic text

Underline

Please do not use the pair to underline text. Not only is it deprecated, but it may confuse users about whether or not it is a link. If you think something should be underlined, it would probably be more correct to make it bold or italic.

Color

Do not apply any color to any text via CSS or the tag. The CSS for the site allows any user to customize the colors and fonts, and setting colors would override those settings, possibly hiding your text.

The <font> Tag

The tag is not allowed, if you use it we will remove it. All font properties for the site are defined via the CSS and customizable by each user. All markup must be structural; the tag does not denote structure. Also, the tag is deprecated.

Script and Code Samples

If you're using block-level code samples (see below), please don't forget to escape all your entities.

This means, in particular, changing all your > and < characters into &gt; and &lt; entities (respectively) as well as & to &amp; and " to &quote;. You can get a complete list of the accepted character entities from section 24.2 Character entity references for ISO 8859-1 characters of the HTML 4.01 specification at the W3C site. There is also a character entity chart right here on the evolt.org site: A Simple Character Entity Chart

Code Blocks

Blocks of code/script/markup should be placed between
tags. Since
 is a block level element, it will be rendered as its own paragraph.  

This is how a block of code will appear on the site.  Long lines of text will result in a scrollbar that doesn't mess up the layout.

Short lines will

be rendered thusly

You may also post block level PHP code between tags for pretty syntax colour coding:

Inline Code

Code/script/markup snippets within a paragraph should be wrapped within tags. This will escape all your entities for you.

This is a sample of inline code.

Linking

Whenever possible, please try to add a 'title' attribute to your tags. So a tag may appear like this:

.

Off-Site Links

Please add a 'target' attribute to your links to open a new window so readers of your article on evolt.org don't lose their place. Please use "_blank" so all new links open in one window, since the use of "_new" opens links in a new window for each link. To expand on the above example:

.

Miscellaneous Tags

Abbreviations

Whenever you use abbreviations in articles, please keep in mind that not everyone knows all abbreviations out there. To allow users to see what an abbreviation means, you can wrap it in the tag and add a title attribute with the full name of the abbreviated item. For example:

The W3C is an example of this in action. The abbreviation in the previous sentence uses the tag.

Acronyms

Whenever you use acronyms in articles, please keep in mind that not everyone knows all the acronyms out there, either. To allow users to see what an acronym means, you can wrap it in the tag and add a title attribute with the full name of the acronym. For example:

WYSIWYG is an example of this in action. The acronym in the previous sentence uses the tag.

Horizontal Rules

The
tag will render as:

Bullet Lists (Ordered, Unordered, Dictionary Lists)

The
    ,

A founder of evolt.org, Adrian Roselli (aardvark) is the Senior Usability Engineer at Algonquin Studios, located in Buffalo, New York.

Adrian has years of experience in graphic design, web design and multimedia design, as well as extensive experience in internet commerce and interface design and usability. He has been developing for the World Wide Web since its inception, and working the design field since 1993. Adrian is a founding member, board member, and writer to evolt.org. In addition, Adrian sits on the Digital Media Advisory Committee for a local SUNY college and a local private college, as well as the board for a local charter school.

You can see his brand-spanking-new blog at http://blog.adrianroselli.com/ as well as his new web site to promote his writing and speaking at AdrianRoselli.com

Adrian authored the usability case study for evolt.org in Usability: The Site Speaks for Itself, published by glasshaus. He has written three chapters for the book Professional Web Graphics for Non Designers, also published by glasshaus. Adrian also managed to get a couple chapters written (and published) for The Web Professional's Handbook before glasshaus went under. They were really quite good. You should have bought more of the books.

The access keys for this page are: ALT (Control on a Mac) plus:

  • 1 links to the evolt.org home page.
  • plus 2 skips to the main content of the page.
  • plus 3 skips to login and registration.
  • plus 4 skips to the search form.
  • plus 5 links to site FAQs.
  • plus 6 skips to list of content categories in this site.
  • plus 7 skips to the index of other sites in the evolt network.
  • plus 9 links to the feedback page.
  • plus 0 will repeat this list.
evolt.org Evolt.org is an all-volunteer resource for web developers made up of a discussion list, a browser archive, and member-submitted articles. This article is the property of its author, please do not redistribute or use elsewhere without checking with the author.