Web Services

Web Services Internal Development Standards

• Introduction
• Basic Standards
• Web Page Design Standards
• Accessibility
• HTML Standards
• Include Files
• Navigation Elements
• Styles
• Coding Standards (HTML/ASP/JavaScript)
• Browser Support
• Site Development Procedures
• Maintaining Sites with Dreamweaver
• Collage Development Standards

Collage Development Standards

• Project
• Naming Conventions
• Masterpages
• Folder Types
• Document Types
• DDF
• Tasks
• Comments on Check In
• Description
• Deploy
• CSS, JavaScript, and Include files

Top

Naming Conventions

General (all names)

• All names must start with a lowercase letter
  • ex. content.html, index.html
• A capital letter must begin each word within the name, except for the first word
  • ex. thePage.html, deptDevResources.asp
• If the first word of a file name is an acronym, the entire acronym must be lowercase. Each following word in the file name must have the first letter capitalized
  • ex. atecDepartments.html, tlpResources.html
• Do not use spaces, dashes (-), or underscores (_) in any names
  • ex. don't do atec_Departments.html, the-page.html, dept dev Resources.asp

Asset Types

• All asset types need readable, understandable "English" names for readability and MetaData purposes

Master Pages

• All masterpage names must begin with lowercase "master"
  • ex. masterHome.html, masterDefault.html

Document Types

• All names of document types must end with "Page" in the name
  • ex. defaultPage, indexPage
• For pages that are specifically tied to a particular masterpage, the names should share a common element
  • ex. masterDefault and defaultPage, masterNews, newsPage

Folder Types

• All names of folder types (not the folders themselves) must end with "Folder" in the name
  • ex. imagesFolder, documentsFolder

DDF

All default tags (i.e. <strong>, <em>, <blockquote>) must be changed to all lowercase.

Top

Masterpages

• All masterpages must be stored in /System/masterpages/. The masterpages directory doesn't exist when a new project is initialized and will need to be created.
• The home page of each project should have its own masterpage entitled masterHome.html. No other pages should use this masterpage.
• Create as many masterpages as necessary, but if possible, try to limit the number of masterpages to one or two, including the masterHome.html page.

Folder Types

• All folder type names must end in "Folder", not "_fld"
  • ex. imageFolder, documentFolder NOT images_fld, documents_fld
• All folder type names should be singular, not plural
  • ex. imageFolder, not imagesFolder
• A folder type of "documentFolder" must be created in each project, and exist within each contribution folder in the project. This will be used to store Word docs, PDFs, Excel files, etc.
• A folder type of "imageFolder" must be created in each project, and exist within each contribution folder in the project. This will be used to store all image types.
• A folder type of "subFolder" must be created in each project. This is the default folder type for each contribution folder.
  • This folder type must have permittable folder types of "subFolder," "imageFolder," "documentFolder," and any other folder types as needed by the particular project.
  • This folder type must have permittable document types of "defaultPage," "indexPage", and any other document types as needed by the particular project.

Document Types

• All non-Web documents (i.e. Word docs, PDFs, etc.) must be contained within a "documentFolder" type folder.
• All images must be contained within an "imageFolder" type folder.
• All default template pages must use the "defaultPage" layout.

Top

DDF

• Use "Convert to XHTML"
• Use "Use Global Styles"
• Allow alignment privileges
• Delete all extra font styles. None are allowed. Fonts (etc.) should be set in the Global Styles.
• For images,
  • Make "alt" tag required
  • Allow users to navigate into all subfolders of project
  • Default location is /WebSite/
• For links,
  • Allow users to navigate into all subfolders of project
  • Default location is /WebSite/
  • Default external links location is /System/Links/
• Allow source edit
• Use Filter HTML when pages will be edited by non-experienced users pasting content from Word. Do not use Filter HTML when creating complex pages with anchors and other elements that confuse Collage.
• Allow accessibility features, but do not make required
• You should create default content for each contribution field in ddf file.
  • ex. "Enter page content here."

Tasks

• Create a basic task of Edit > Approve. This can be used for contributors to track their own tasks for themselves.
• If a task is referring to specific assets, add those assets to the task.
• Set up of workflow (tasks) will vary from project to project, and may not be required at all.

Comments on Check In

• Required only for significant or potentially confusing or ambiguous changes. Optional otherwise.

Top

Deploy

• Given the way in which projects are set up, you need to set the "Deploy termination error level" to "Only fatal errors" or else most deploys will fail.
• Upon deploying a project for the first live version, purge history (under Project) to set all versions to 1 (but make a copy of the project first, as a backup!).

CSS, JavaScript, and Include files

• CSS, JavaScript, and Include folders (/_styles, /_scripts, and /_include respectively) may not be contribution items.
• Each of these folders must exist at the root of the project folder (i.e. /WebSite /_include/, etc.)
• If CSS or JavaScript code is added to the CSS and JavaScript files for individual pages (meaning only one page uses this code, it is not project global), then comments must be placed around this section of code signifying what page is utilizing this code.
• All files that are pieces of a masterpage (i.e. header.html, footer.html, nav.html, etc.) must exist in the "_include" folder only.

Top