Naming conventions for snippet labels, mini panels, etc.

In order to stay consistent across uOttawa sites, it is recommended that you follow the naming conventions below.

Snippet labels

General Content Snippet

For the Label field of General Content Snippets, enter the English name of the page, followed by an interspaced hyphen, and finally the name of the item. For example, if I am creating a section called "Mandate" that is expected to appear on the About page, the label should be "About - Mandate".

Note: Do not lowercase the words in the label, and make sure to add spaces around the hyphen.

Title Snippet

For Title Snippets, the Label field should start with the English name of the page, followed by an interspaced hyphen, and then the word “Title”. For example, if I am creating a title snippet for the page "About", then the label should be "About - Title".

Hero Snippet

For the Label field of Hero Snippets, follow the same naming conventions as the General Content Snippet.

Mini panel titles

When creating a new mini panel, inasmuch as possible, follow the format "Page name - Element name - Mini panel". For example, if you were creating a mini panel for a news section on the home page of your site, then your administrative title should be something like "Home - News - Mini panel".

The reason for appending the words "Mini panel" at the end is to make mini panels more recognizable when they are added to Panel pages.

Taxonomy terms

For taxonomy terms, how you name them will depend on whether or not the terms are exposed on the site.

If the term is exposed on the site:

Taxonomy terms can be exposed if they appear in the categorizer section of Dynamic Content Lists (DCLs) or in other places like research interests. For the title of terms that are exposed, simply provide the title that you want to have appear to visitors of your site. Make sure to translate the term into French.

Tip: You may wish to hierarchize terms that are exposed under a parent term to group them together. This can help provide context and make it easier for users to understand where the terms are used.

If the term is not exposed on the site:

Most terms that you create will not be exposed on the site. Given this, you can follow the same naming convention as General Content Snippets. That is, enter the page name, followed by an interspaced hyphen, and then the name of the element.

For example, if you were creating a taxonomy term for a slideshow on the home page of your site, the term's title should resemble "Home - Slideshow".

URLs and paths

To learn more about the general guidelines for page paths, read the article Best practices regarding the path (URL) of a page.

» Submit feedback
Back to top