This document covers some basic conventions that are used in XWiki codebase. Please read over this document and make sure your code conforms to the rules here.

HTML

The following rules must be followed:

  • The HTML output produced by XWiki pages must be valid HTML 5.
  • The XWiki project is also following the W3C WCAG Guidelines. In addition we're also following the Dutch Web Guidelines which are even stricter than the WCAG ones.

CSS

The following rules must be followed:

The following recommendations could be followed:

  • Properties:
    • alphabetical order
    • 2 spaces indentation
    • put a space between selector and declaration start, ex. "a {}"
    • use of CSS shorthands
    • use relative sizes (em, %) instead of fixed ones (px)
    • use appropriate CSS files for writing IE rules
      • limit as much as possible the number of IE hacks used
  • Organization:
    • comment headers for separation and grouping of different parts of the code
  • Overwriting:
    • document the localization of the overwrite using "Overwrites" and "Should be in" comments

Issues

  • We currently don't have a naming convention

Tools

Testing

See the Testing page.

Tags:
Created by Vincent Massol on 2018/01/12 13:40
   

Get Connected