Please enable JavaScript.

Coggle requires JavaScript to display documents.

BOSweb Coding Standards (HTML (Current (Formatting (

BOSweb Coding Standards

HTML

Current

HTML4

Backward Compatibility (General)

Only use HTML elements compatible with HTML4

Prefer `id` over `name` attributes

No duplicate `id`s

No HTML4-only attributes (like `bgcolor`). Prefer CSS

Void elements

Don't use `/>` for self-closing tags

Don't explicitly define closing tags for self-closing tags

Empty value attributes

Always assign values to attributes `disabled=true` vs. `disabled`

Formatting

Space Width

Use the default spacing that the file has (tabs or spaces)

Prefer tab space of 2

Line Breaks on...

More than one attribute

If more than one attribute, line break before closing `>`

After opening tag, before closing

Each nested tag

Comments

HTML comments if code is not clear

Caveat about file length for weblink

Show example from `ACDDemographics.asp` in Pull Request

Line Length

No more than 80 characters

Quotes

Remain consistent with the file (if double, use double)

Casing

Prefer lowercase tags

CSS

Styling

No inline styling with `style` attribute

No styling with HTML4 attributes (e.g. `bgcolor`)

Put styling in same file as CSP/ASP #

List obsolete HTML4 attributes from W3C page

Future

HTML5

Changes between HTML4 and 5

Doctype to render in standards mode

Can use HTML5 only elements

New elements and attributes

Changed elements and attributes

Obsolete elements and attributes

JavaScript

Current

ECMAScript

Backward Compatibility

All code must be backward-compatible w/ ES2

No code newer than ES5

Check Mozilla documentation for each JS function

Can use polyfill and put it in `common.js` file

Documentation

JSDoc

Should include for each new function

Specify `param`s with types and `return`s and description

Future

ECMAScript

ES Standards

IE11 doesn't support ES6

Depending on browser, could use ES6+

Common Functions

Common.js file

For any code that's reused throughout multiple files, put into `common.js` file

jQuery

Current

The Menu

We currently use jQuery for the v2 version of the menu, compatible with IE11/Chrome

jQuery available for all pages with the menu

Not regularly updated

Shouldn't use it for pages b/c must be backward-compatible

Future

Using it in Pages

Should be able to use it for any page

Should prefer it since it's cross-browser compatible

Each browser has its own JS implementation

Caché

BOSweb Cache Files

List the cache files used by bosweb for the menu

`WSYSystem.mac`, `WSYBuildMenu.mac`, etc.