Naming Conventions - Guidelines for Directory and Naming

Document Sample
Naming Conventions - Guidelines for Directory and Naming Powered By Docstoc
					Guidelines for Directory and Naming
Conventions
Ryerson.ca


                                 Document Information and Revision History

Version        Date                     Author(s)                      Revision Notes
1.0            February 9,              K. Hewak                       Draft: Waiting for Approval
               2006
2.0                                                                    Removed footnotes




                                              Table of Contents

1     Introduction.................................................................................................................1
2     New URL Requests .......................................................................................................1
3     URL Naming Convention ..............................................................................................1
4     URL Conflicts ...............................................................................................................1
5     Policies on Custom Aliases .......................................................................................... 2
6     Subdirectories............................................................................................................. 2
7     General Standards....................................................................................................... 2
8     Avoid Unsafe and Reserved Characters ....................................................................... 3
9     Glossary ...................................................................................................................... 4
Ryerson_guidelines_naming_conventions_version2.0.doc




1   Introduction

       This document describes the requirements for the creation of acceptable web addresses
       or URLs for Ryerson University’s web site, Ryerson.ca. Ryerson.ca is the domain name
       for Ryerson University.

       In order to provide consistency of presentation and to protect the Ryerson brand, there
       are specific requirements relating to the creation of Ryerson University web addresses.


2 New URL Requests

       Web Services, University Advancement must approve the new URL requests.


3 URL Naming Convention

       Website addresses must meet the following standards:

       1. A directory name must be unambiguous when written or spoken.
          Example: ryerson.ca/registrar as opposed to ryerson.ca/registr.
       2. A top level directory name should be short, memorable and easy to type.
          Example: ryerson.ca/contact, not ryerson.ca/contactryerson.
       3. A top level directory name must not begin with or repeat “ryerson” – such repetition
          is redundant and cumbersome when printed, displayed on screen or spoken.
          Example: ryerson.ca/library, not ryerson.ca/ryersonlibrary.
       4. Abbreviations should not be used unless they are established brands.
       5. Multiple directory names must not be used for the same service unless there is an
          operational justification to do so. For example, it is not acceptable to have a directory
          as an alias for a possible misspelling.
       6. Web addresses must only contain letters, numbers, and the underscore and dash
          characters. [See Avoid Unsafe and Reserved Characters]



4     URL Conflicts

       When two different groups or individuals want the same name, the issue will be resolved
       by the Executive Director, Public Affairs, Marketing and Communications, University
       Advancement, whose decision will be based on necessity and best practices.




Ryerson_guidelines_naming_conventions_version2.0.doc
Ryerson_guidelines_naming_conventions_version2.0.doc


       In general, priority will be given in the following order:

           1. Administration or Governing Bodies (i.e. Board of Governors, Office of the
              President, Office of the Registrar, etc.)
           2. Faculties
           3. Schools, Institutes or Faculty Departments (i.e. School of Business, Department
              of Geography and School of Geographic Analysis, etc.)
           4. Individual Programs
           5. Organizational Departments or Academic Services (i.e. Human Resources,
              Library, etc.)
           6. Support Services (Purchasing, Campus Security)


5 Policies on Custom Aliases

       A custom alias is an address that points to a page on your real site and takes the format of
       "www.ryerson.ca/". Custom aliases help users reach content more directly and can be
       used to help market your web site.

       All custom aliases will be redirect aliases -- in other words, they will automatically
       redirect the user to your real site.

       Custom aliases must be used sparingly because they have a performance and
       administrative overhead. Therefore, a custom alias will only be set up when it is needed
       to facilitate or promote access to the site. Web Services will coordinate approval of
       custom aliases with Computing and Communications Services (CCS).


6 Subdirectories

       URLs should reflect logical web site organization, not Ryerson’s hierarchal structure.

       If users perceive a particular entity as a separate entity, or if users regularly contact the
       entity directly, the entity should have its own virtual directory; its site should not be a
       subdirectory of its parent entity.


7 General Standards

       1. The Ryerson.ca site is set up using the index.html file name as a base for all other files.
       Name the first page in any directory (folder) index.html. This is literally the "index" page
       for the other pages in the directory.

       Example URL: http://www.ryerson.ca/index.html




Ryerson_guidelines_naming_conventions_version2.0.doc
Ryerson_guidelines_naming_conventions_version2.0.doc


       2. There should be no spaces in filenames. If you do want to make a filename with two
       words before the extension, please use a hyphen as a placeholder to denote the space.

       Example: file-name.html

       NOTE: A hyphenated URL is more search engine friendly.

       3. Use descriptive names when possible. The filename should suitably describe the
       content of your page.


8 Avoid Unsafe and Reserved Characters

       8.1Unsafe Characters

       Characters can be unsafe for a number of reasons. The space character is unsafe because
       significant spaces may disappear and insignificant spaces may be introduced when URLs
       are transcribed or typeset or subjected to the treatment of word-processing programs.

       "<" and ">" are unsafe because they are used as the delimiters around URLs in free text.

        The quote mark "" is used to delimit URLs in some systems.

       "#" is unsafe and should always be encoded. It is used in other systems to delimit a URL
       from a fragment/anchor identifier that might follow it.

       "%" is unsafe because it is used for encodings of other characters.

       Other characters are unsafe because gateways and other transport agents are known to
       sometimes modify such characters. These characters are:

        "{", "}", "|", "\", "^", "~", "[", "]", "`", and “.”

       Avoid the use of the above unsafe characters in your filenames.

       8.2      Reserved Characters

       URLs use some characters for special use in defining their syntax. When these characters
       are not used in their special role inside a URL, they need to be encoded.

       Here is a list of reserved characters that should be avoided:

       "$", "&", "+", ",", "/", ":", ";", "=","?" and "@".


9 Glossary

       1. URL (Uniform Resource Locator) also sometimes referred to as URI (Uniform
          Resource Identifier).




Ryerson_guidelines_naming_conventions_version2.0.doc
Ryerson_guidelines_naming_conventions_version2.0.doc


          1. The address of a web site or file on the web.
          2. An address identifying the location of a file on the Internet, consisting of the
          protocol, the computer on which the file is located, and the file’s location on that
          computer.

       2. Directory: A folder for a group of files.

       3. Top Level Directory: A directory that exists at the top level of the site structure and
       so immediately follows the host name, separated by a slash.

       4. Sub-directory: A directory that exists within another directory.

       5. Redirect: To send a URL request received to a different location (URL), because the
       intended file or directory has moved, for example.




Ryerson_guidelines_naming_conventions_version2.0.doc

				
DOCUMENT INFO