Adding metadata

Best Practices

Tip: The first file within a folder must be named "index".

Tip: Use a hyphen between words in a system name.

Metadata is data within the Web CMS that describes an Asset. Common fields such as Title, Summary, or Keywords provide quick information about the content contained inside a particular asset. Because the system manages all assets as XML, the metadata that a user enters for assets can be used for display and/or navigation purposes on site pages. Learn more about navigation and the use of Display Names within your page templates.

As soon as you create a new asset, the New Asset page will appear. This page may look slightly different, depending on the asset type (file, folder, or page). You may save yourself a step and immediately click on the Metadata tab.

Metadata description field that displays in the main view's Inline Metadata section.

Full metadata options available from a page's Edit | Metadata link.

The following information should be provided for all new assets:

System name

All components in the Web CMS must have a system name. The system name is the file name that becomes part of the page URL (link). System names:

  1. Must be all lowercase (eg: myfilename)
  2. May not contain blank spaces; use dashes or underscore between words instead of spaces (eg: my-file-name or my_file_name)
  3. Should be as short as possible as this is used as part of your web page's URL name (eg: http://ucdavis.edu/example/my-file-name.html) 

When you create a new page or folder, the system name will be the first field in the template. It will default to the name of the template. Type in the page's new system name of the page.

If it is the primary page in the site or folder, name it "index." Folders used by navigation must contain a page named "index." If it is any other page or folder, name it something meaningful and short.

Changing a system name

To change a system name later on, select the Move/Rename tab and type in a new system name. Note: If the page has already been published, you must unpublish the page before changing the system name. Otherwise, the page will live on the server under its old name forever.

Display Name, Title, Summary, and Author

  • The Display Name is what will be displayed in any navigation (i.e., the left sidebar and the breadcrumbs). Keep this as short as possible to avoid wrapping. If left blank, the page will not display in the navigation.
  • The Title is displayed in the HTML metadata title tag. The Title also displays as the page title above the content and populates the page name users see in the window of their Web browser.
  • Keywords are part of the metadata content for pages, files, folders, blocks and external links, and are used by search engines to determine the relevancy of individual pages or sites.  Typically, keywords are a comma-delimited (comma-separated) list of words used on pages generated for the purpose of optimizing the page's score in a search engine query.
  • Description - the description of the Asset

 Review Date, Start Date, End Date and Expiration folder are not presently supported by the Web CMS.

To add or edit the Display Name, Title, Keyword, or Description:

  1. Select the Edit > Metadata tab
  2. Insert your Inline Metadata 
  3. Save your changes by clicking Submit.

Custom Metadata

Custom Metadata gives you the ability to fine tune how the page information is used in navigation.

  • Primary navigation placement* - Choose Top bar or Bottom bar. By default the top bar is used. If you want to add content to the Bottom bar, the second bar has to activated from the Site Configuration page.
  • Include in primary navigation - If the page is located at the root site, you can hide it from the primary navigation by unchecking the box.
  • Include in secondary navigation - If the page is in a subfolder, you can hide it from the secondary navigation by unchecking the box.
  • Exclude from all navigation - Hide the page from all navigation while still allowing to be published to the web site. Note, if the URL is known, the page can still be found and it can be indexed by search engines.

Advanced Options

As always, you may check spelling, accessibility or links before submitting and closing the asset.

Click Submit. While it is not required, it is wise to save (submit your changes) before proceeding. Once saved, continue working on this page as though it is an existing page (click on the Edit tab and proceed to edit the content through the WYSIWYG editor).