Git Product home page Git Product logo

wet-boew's Introduction

Web Experience Toolkit (WET)

Build Status

Web Experience Toolkit (WET) includes reusable components for building and maintaining innovative Web sites that are accessible, usable, and interoperable. These reusable components are open source software and free for use by departments and external Web communities.

The toolkit complies with the new Standards on Web Accessibility and Web Usability; the toolkit will also ease compliance with the upcoming Standard Web Interoperability. WET is highly recommended for use on Government of Canada Websites.

Benefits

  • Provides reusable components for building and maintaining innovative Web sites.
  • Respects accessibility (WCAG 2.0 AA and WAI-ARIA), usability, and interoperability.
  • Reduces costs by consolidating Web tools and solutions.
  • Open source software that is free to use by departments and external Web communities.
  • Uses advanced technologies to push the envelope for Web site functionality:
    • HTML5, CSS3, jQuery (JavaScript framework);
    • Ever-growing list of open source plugins and widgets.
  • Supports a wide range of layouts and designs for internal and external Web sites (including applications).

Key resources

Contributor guidelines

  • Pull requests are welcome. Please make sure your changes are to the latest code and limit the commit range to just the files you intended to change (to avoid conflicts).
  • New components should be added in a feature-* branch (e.g., feature-lightbox).
    • Licensing for all new components and supporting code must be compatible with the MIT license used by WET.
    • New plugins should use pluginTemplate.js as the basis for the JavaScript code.
    • Include the WET terms and conditions comment block in all text-based source files that fall under Crown Copyright.
  • Validate your HTML markup. Markup should be well-formed HTML5.
    • To test for well-formed markup, validate with an XHTML5 preset and a checkmark next to "Be lax about HTTP Content-Type".
  • Validate your CSS with the following changes to the default settings:
    • Profile: CSS level 3
    • Vendor extensions: Warnings
  • Validate your JavaScript code with the following changes to the default settings:
    • Tolerate dangling _ in identifiers: true
    • Tolerate missing 'use strict' pragma: true
    • Assume browser: true
  • Formatting recommendations:
    • Indent with tabs using the K&R indenting style
    • Use single quotes for strings in JavaScript (so unescaped double quotes can be used for attributes in HTML output)
  • Supported browsers (should be tested against):

Boîte à outils de l’expérience Web (BOEW)

Vue d'ensemble

La Boîte à outils de l’expérience Web (BOEW) rassemble différents composants réutilisables et prêts-à-utiliser pour la conception et la mise à jour de sites Web innovateurs qui sont à la fois accessibles, conviviaux et interopérables. Tous ces composants réutilisables sont des logiciels libres mis à la disposition des ministères et des collectivités Web externes.

La Boîte à outils est conforme à la Norme sur l'accessibilité des sotes Web et la Norme sur la facilité des sites Web et sera conforme à la Norme sur l’interopérabilité du Web. Il est fortement recommandé d’utiliser la BOEW pour tous les sites Web du gouvernement du Canada.

Avantages

  • Fournit composants réutilisables pour la conception et la mise à jour de sites Web innovateurs.
  • Respecte l'accessibilité (WCAG 2.0 AA et WAI-ARIA), la facilité d’emploi et l'interoperabilité.
  • Réduit les coûts par consolider les outils et solutions axés sur le Web.
  • Sont des logiciels libres mis à la disposition des ministères et des collectivités Web externes.
  • Fait appel à des technologies nouvelles et novatrices pour rendre les sites plus novateurs et interactifs :
    • HTML5, CSS3 et jQuery (cadre JavaScript);
    • liste croissante de plugiciels et gadgets de source ouverte.
  • Permet d’avoir accès à une grande diversité de mises en page et de conceptions pour les sites Web internes et externes (y compris les applications).

Resources clés

Lignes directrices pour les contributeurs

  • Les demandes de retrait sont les bienvenues. Assurez-vous d'apporter les changements dans la dernière version du code et de limiter le champ de validation (commit range) seulement aux fichiers que vous aviez l’intention de modifier (pour éviter les conflits).
  • Les nouvelles composantes devraient être ajoutées dans un branchement de type feature-* (p. ex., feature-lightbox).
    • Les licences de toutes les nouvelles composantes et du code afférent doivent être compatibles avec la licence MIT utilisée par la Boîte à outils de l’expérience Web (BOEW).
    • Les nouveaux modules d’extension devraient se servir de pluginTemplate.js comme base pour le code JavaScript.
    • Inclure le bloc de texte sur les conditions d’utilisation de la BOEW dans tous les fichiers sources textuels soumis aux droits d’auteur de la Couronne.
  • Valider votre balisage HTML. Le balisage devrait être en HTML5 bien formé.
    • Pour vérifier si le balisage est bien formé, valider à l’aide d’un préréglage XHTML5 et cocher la case « Be lax about HTTP Content-Type ».
  • Valider votre CSS en apportant les changements suivants aux paramètres par défaut :
    • Profil : CSS niveau 3
    • Extensions Proprétaires : Avertissements
  • Valider votre code JavaScript en apportant les changements suivants aux paramètres par défaut :
    • Tolerate dangling _ in identifiers : true
    • Tolerate missing 'use strict' pragma : true
    • Assume browser : true
  • Recommandations quant au formatage :
    • Ajouter les tabulations en utilisant le style d'indentation K&R
    • Utiliser les guillemets simples pour les chaînes en JavaScript (de façon à ce que les guillemets doubles non échappés (unescaped) puissent être utilisés pour les attributs dans les données de sortie HTML)
  • Fureteurs supportés (cet élément devrait faire l’objet d’une vérification) :

wet-boew's People

Contributors

laurentgoderre avatar bottledg avatar sylus avatar charlesmorin avatar berubs avatar statcan-svc avatar mankev avatar thomasgohard avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.