Editing Standards and Guidelines

Naming Conventions

  • When naming a new page use all lower-case with dashes between words (no camelCase).
  • No special characters should be used.
  • Images and documents must have the appropriate file extensions (.png or .jpg for images, .pdf for documents).
  • Dates should not be used in the page names. 
  • Use a uniform standard in page display names (Contact Us, Frequently Asked Questions, etc.).

Text Guidelines

  • No underlines or italics unless part of a citation.
  • Use of "ALL CAPS" to be avoided in titles and H-tags.
  • Page text should be wrapped in Paragraph (<p>) tags.
  • H-tags are to be used for separating out sections of content on a page. Think of them as an outline to organize the page's information and make it accessible for all users. For reference, examples of all tags have been provided in the left sidebar of this page below the navigation.
    • H-1 is used only once on a page for its title. Cascade adds this by default at the top of each page.
    • H-2 tags are used to break the page information down into primary subsections. H-2 tags may be applied to the titles of these sections via the "Formats" dropdown at the top of the WYSISWYG.
    • H-3 tags perform the same function of division and organization for information nested under an H-2 tag that the H-2 performs for information nested under the page's H-1 tag. H-3 tags may be applied via the same "Formats" dropdown as mentioned above for the H-2 tag.
    • H-4 and H-5 tags further break down and organize the page's information. These tags can also be accessed for the "Formats" dropdown.
  • Bold text should be used sparingly, always consider using H-tags if possible as a substitute.
  • No special characters should be used outside of links. Avoid using the Ampersand (&).
  • When using numbers in content, spell out one through nine and use numerals for 10 and above.
    • If you are listing out things with numbers and one of them is more than 10, use actual numerals.
      • E.g.: 22 hours, 19 minutes, 6 seconds.
  • When adding a date, include the year and avoid the use letters after numbers; e.g., Feb 1 as opposed to Feb 1st.
  • When listing times, use numerals and the appropriate meridiem notation; 3 p.m., 3:30 p.m.
    • Spell out noon and midnight but do not capitalize them.
    • Use short dashes with appropriate spacing, 11:30 a.m. - 2:30 p.m.
    • Remove “:00” when the time is at an exact hour and remove repeating meridiem notations; 2 - 3 p.m., 2:30 - 3 p.m.
  • Phone numbers should be in standard (999) 999-9999 format.
  • Emails should be linked via "mailto" tag, e.g.,   webteam@uiwtx.edu.
  • The word university should only be capitalized when included in the proper name of an institution, e.g., University of the Incarnate Word.
  • Semester designations should be capitalized only if they refer to a specific year unless they are separated by "of"; e.g.:
    • The seminar course was offered only in the Fall 2013 term.
    • The seminar course is offered each spring semester.
    • The seminar course was offered in the spring of 2012.
  • Text size is frozen and must not be adjusted through outside CSS or the WYSIWYG.
  • All embedded URL's must have unique link text. No visible naked URL's (naked-url-example.com) aside from email addresses will be allowed.

Links

  • By default, links are set to open in the same window. Any links to pages inside of our greater UIW environment (Main Site, Community Site, Professional and Individual School Sites) should retain this default. Links to documents (downloadable PDF's) or sites and resources outside of our UIW web environment should be set to open in a new window. This can be set by clicking the "Target" dropdown in the "Insert/Modify Link" menu of the WYSIWYG and selecting the "New Window" option.
  • The "Insert/Modify Link menu also contains the "Title" field. Filling out this field with the name of the page being linked to allows the user to see where the link is taking them when they hover over the link text.
  • Anchor Links may be used to jump from one area of a page to another. Highlight the text you wish to link to and select "Anchor" from the "Insert" dropdown. The link may then be added to existing text via the " Insert/Modify Link" menu of the WYSIWYG.
  • Link text should not be in Bold or ALL CAPS.
  • Learn more about UIW's Style Guide.
  • Learn more about Accessibility.
  • Download a PDF of this page.
  • Table Styling Guide

Tables

  • Tables should only be used to display data or lists. They should not be used to display biographies, images or other information.
  • All tables must include a caption that provides a concise summary of the data displayed.
  • Do not use bold or other style elements on content in tables.
  • All tables should be set to "Width:100%" through the table options in the WYSIWYG.
  • Borders and Striping can be applied in the table options in the page's WYSIWYG.
Sample table
Information that should be stored in tables Information that should not be stored in tables
Lists (Names, Classes, etc) Pictures
Organized Data Biographies