Skip to main content

Office of Information Technology (OIT)

UT Arlington
OIT: Office of Information Technology

helpdesk@uta.edu ·  Work Order · 817-272-2208 · System Status

We are your IT partner!

Content Creation Standards

Folders and Pages

Naming Convention

Page/folder display names should use hyphens, not underscores, for example "computer-store". Underscores are difficult to read in underlined URLs. Since we use the "Display Name to System Name" plugin for Cascade, our page display name is automatically converted to the page system names, spaces are converted to hyphens.

This will also mean that wordsarenotruntogether but are-separated-by-hyphens.

Images and Files

The recommendation is creating a separate folder for each, named “images” and “files”.

Formatting

Phone Numbers

Phone numbers need to be 817-272-3260, the numbers separated by hyphens.

Headers

H2 is first header on page

Naming

Don't use _ in file or folder names, it is only used for the Cascade Server _internal folder.

Pages

Display name: Holidays Vaction (is used for short navigation, as in nav trails)

Title: Holiday Schedule and Vacation Regulations for 2009-2010 (shows in the tab of a browser)

System name: All pages (including structured data) should use the plugin "Display to System Name". It automatically converts the display name to the system name and replaces spaces with dashes. The plugin only generates the system name if it is empty. If the system name was entered manually, the plugin won't change it.

Navigation

3-click approach to navigation: the user should be displayed relevant content within 3 clicks from the home page (less than 3 is even better).

A link should almost never open a new window, including links to external content. 

Reasons:

  • breaks the "back" button
  • if the user wants a new window or browser tab, they should decide, not you
  • <target="_blank"> is not valid xhtml
  • some devices do not handle new windows well, e.g., iPhone

If you must do it, make sure you warn the user it will happen.

Some possible exceptions to this rule include:

  • window pops up information that user needs to copy/paste into web form on the current page
  • a help window, glossary, or definition pops up explaining content on current page
  • clicking a thumbnail image opens a larger image in a new window

 

Accessibility

Accessibility Standards - Responsibility of Content Contributors

Text equivalents for images ("alt tags") should be descriptive and make sense; if you absolutely must use an image that contains large amounts of textual information, a "longdesc" should be used.

Equivalent alternatives for any multimedia presentation shall be synchronized with the presentation (for example, video captions).

Headings, subheadings, and paragraphs should be in order and make sense semantically (for example, see Headings for OIT).

Tables should be used only for tabular data, not layout; row and column headers should be identified in the markup.

All information conveyed with color should also be available without color.

Link text should be meaningful enough to make sense when read out of context (for example, "click here" or "more" is not acceptable).

Accessibility Features to Be Built Into All Templates

All templates valid XHTML 1.0 Transitional.

All templates valid CSS.

All templates pass automatic accessibility checker, such as WAVE

All template headings in order and make sense semantically (for example, see Headings for OIT).

Pages readable without requiring an associated style sheet.

Link provided that permits users to skip repetitive navigation links.

Tables not used for template layouts.

Text-only and/or printer-friendly templates provided. (and print-friendly CSS?)

Templates constructed so that all "design" information is separate from "content."

Accessibility Checks Provided by Cascade Server

  • System will prompt the user to provide an alternative text description for all images ("alt tags").
  • User will be prompted to enter a table summary for all tables.
  • Tidy HTML/XML ensures W3C standards compliance.

Screenreaders

Firefox plugin: http://accessibar.mozdev.org/