Category: Best Practices

Creating Headings

It is important to use properly structured HTML headings when organizing your web content. Think of webpage headings as a table of contents for a story.

Headings are not required on webpages. However, they help break up and organize lengthy informational webpages—improving readability. Proper heading use is not only important for accessibility, it also has search engine optimization benefits, which can help your webpages rank higher in Google’s search results.

According to the University’s editorial guide, headings are always title case, meaning you should capitalize all words that are not articles, prepositions, or to-be verbs.

Proper Content and Page Structure

The following tips are meant to help CMS users with day-to-day maintenance of basic content on their websites.

Paste as Text

If you paste content from a document or email into Omni CMS, you will likely get a bunch of bad code added behind the scenes that will effect how your webpage will look at function. To avoid issues, try clicking the “Paste as Text” button before pasting your content or use the Ctrl + Shift + V key combination.

Paste as Text icon in the toolbar.

The negative to pasting as text is that you will have to do some formatting manually (adding bold, adding links, etc). However, this will help to ensure that your website meets brand and accessibility standards and works correctly on all devices.

Headings

Headings play a key role in accessibility requirements and general page usability. It is important to use proper HTML headings instead of bold paragraphs or single lines of text and to not use the heading styling when the content is not a heading. To apply a heading style to a line of text, put your cursor inside of the line of text and then select a heading level from the paragraph dropdown menu in the Omni CMS editor. The same method working in other online applications, such as Google Docs. For text that you want to highlight that is not actually heading content, use the font styles in the Styles dropdown menu of the Omni CMS editor instead.

Writing Good ALT Tags

Alt tags (also known as Image Descriptions or alt text) are a very important for the accessibility of your webpage. Moz does a good job of explaining what alt tags are. Please take a moment to read up on what alt tags are and why they are important. Moz also provides some tips for how to write good ones.

There are many uses for alt tags. The most well-known ones are:

  1. Screen readers will speak the alt tag of an image for users who cannot see.
  2. If an image cannot be loaded due to some sort of network or IT error, the alt tag will display instead.
  3. Alt tags boost search engine rankings and can help your website’s images display in Google search results.

How to copy/paste clean code

Have you ever pasted content into the CMS, and it just doesn’t look right? You’re probably carrying old formatting code into the new CMS. Common culprits are copying from a Word document, copying text from one browser and pasting it into another, or copying text that was formatted in-line (using <span> and <style> tags directly in the code instead of letting the preformatted stylesheets do the work.)

Adding content with this type of formatting is bad for a couple of reasons:

  • It doesn’t let your page update with the rest of the CMS. We may decide to change the font size or style to make the site more accessible or to keep up with modern design trends. By using the standard heading (<h1>, <h2>, etc) and paragraph (<p>) tags, your content will be ready to shift in an instant. If you leave hard-coded styles in the page, your look won’t automatically change.
  • It can look strange on different devices. Everything on our new template is designed to expand and contract with the user’s screen size. Hard-coded styles may not change in the right way between desktop and mobile.
  • It’s annoying for you, the CMS user. Sometimes you’ll have lines and lines of needless code – annoying when you’re trying to find one or two words in pages of <span>s and <color>s. For example, look at the coding on the links below—the <u> and <span> tags make for messy code on the back and and ugly links on the front end.

Screen Shot 2017-06-30 at 2.38.47 PMScreen Shot 2017-06-30 at 2.40.52 PM

Website and Content Backups

There has been some confusion over what our CMS does and does not back up as a part of its revision process, so the purpose of this blog post is to clarify things. This information is accurate for both Percussion Rhythmyx and Omni CMS.

Content Backups

Enterprise Content Management Systems store pieces of content. You have a Generic Page which stores the meat of your webpage’s content. However, there is more. Think of a sidebars and sliders (Highlights). Images. And navigation—made up of Navons. There are also Files. Maybe some Script items or Personnel Information items. All told, any given webpage is made up of 50-100 total individual items.

Any CMS does a good job of keeping track of revisions for these items. Each revision is basically a backup of that individual piece of content. As long as an item is not deleted (purged), we will have a history for that item. If the item is deleted, then its revision history is also deleted.

Best Practices: Search Engine Optimization and Usability

Do you have pages with a lot of text and wonder if that is OK? Are your pages user-friendly? Do you want to increase your search engine rankings? Learn more about what search engine optimization is, along with some tips to make your website better for your users and increase your visibility in searches. Search engine optimization is driven by on-page content and technical SEO.

Content-Rich Page Examples

The What is Biomedical Engineering page shows good use of headings in a page that has a lot of content. The sections don’t drag on because the headings break up the content. They also make the content more scannable for both users and search engines. Using the images to break up the large amount of text rather than placing them at the top or side of the page is another way to make the page more user-friendly.

Please Attribute Sources to Migrated Content in Blogs

Attention web liaisons: if you copy existing content into your department’s blog from a web page or another source, please ensure that you have given credit to the author(s) by adding a byline. This policy applies to content that is authored by any member of the campus community (except for Tech Today), including individuals within your department, not only content that originates outside of the University. Plagiarism charges may be filed if credit is not given where it is due.

Thank you.

– UMC Web Team

Note: This was originally posted on October 4th, 2012.

Good File Naming Conventions

There are a number of good tips to keep in mind when you name your folders, files, and web pages. These tips will help to keep your URLs short and specific to what they involve. Good file naming will also help with search engine optimization.

  • Don’t include spaces or other punctuation in your folder or file name. If necessary, use dashes in this manner: “my-new-file.pdf”.
  • Try to keep your folder or file name short while still making sense.
  • Use key words.
  • Use lowercase.
  • Pick a filename and stick to it. Not renaming your file will keep the file indexed by any search engines.
  • Try to avoid using years, version numbers, or other naming patterns that date a file. Maintenance is reduced and user experience is sustained when you can just overwrite the old file with the new one each year and keep the filename the same. However, for archiving purposes, different filenames may be important (e.g., FY09). To ensure that your new filename updates properly, please request a redirect when you change a filename.