mantisbt:style_guide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
mantisbt:style_guide [2010/10/14 21:53] – daryn | mantisbt:style_guide [2013/04/30 05:54] (current) – dregad | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | * NO Inline Javascript. None. At all. Ever. In any HTML body output. | + | |
- | * NO onclick/ | + | |
- | * NO inline < | + | |
- | * NO use of javascript: | + | |
- | * No Inline CSS styling should appear in any HTML output. | + | |
- | * No style attributes | + | |
- | * No inline < | + | |
- | * I strongly suggest looking at PHPTAL over any other templating engine I've come across. This will assist us with security (automatically escaping strings to prevent XSS attacks), internationalisation and ease of template maintenance. The templates are valid XML documents and can be rendered directly in a web browser without needing to be parsed through the templating engine. | + | |
- | * Come to some sort of arrangement on how plugins will manipulate the HTML to insert their own buttons, widgets, etc as required. | + | |
- | * Any statement about use of tables vs. CSS for layout? | + | |
- | ====== | + | ===== HTML ===== |
- | * The only method allowed for including CSS styling is via including an external CSS stylesheetin | + | * Do use HTML5 |
- | * Use multiple stylesheets for different screen resolutions so that the page will appear differently on a smartphone (small horizontal width) and widescreen monitor (large horizontal width). | + | * Do not use tables for layout. |
- | * Support | + | * Do not put business logic in the templates - //Using PHPTAL templating engine will assist with security (automatically escaping strings to prevent XSS attacks), internationalisation and ease of template maintenance. The templates are valid XML documents and can be rendered directly in a web browser without needing to be parsed through the templating engine.// |
- | * Support for mobile devices screen sizes (iPhone/ | + | |
+ | ===== CSS ===== | ||
+ | * The only method allowed for including CSS styling is via including an external CSS stylesheet in the < | ||
+ | * Do use a fluid layout | ||
+ | * Do use css styles to make adjustments | ||
+ | * Investigate media queries for determining width | ||
+ | * Do support | ||
+ | * Do support | ||
* Must be optional | * Must be optional | ||
* Must support screen rotation | * Must support screen rotation | ||
* Must not require a separate url | * Must not require a separate url | ||
- | * Split layout and colour/text into different | + | * Do design |
- | * Investigate media queries to determine width | + | * Do not use inline CSS styling in any HTML output. |
- | * Use a fluid layout | + | * Do not use html style attributes |
+ | * Do not use inline < | ||
- | ====== Javascript | + | ===== Javascript ===== |
- | * The only method allowed for including Javascript is via including an external script file in the < | + | * The only method allowed for including Javascript is via including an external script file in the < |
- | * The pages should | + | * The pages must be able to fully function without Javascript enabled. If Javascript is available then it can be used to replace parts of the DOM with more advanced functionality (in the same way jQuery UI operates) |
- | * jQuery | + | * Use jQuery exclusively for any javascript |
+ | * Use only jQuery plugins | ||
+ | * Do not use inline Javascript in any HTML output | ||
+ | * No onclick, onmouseover, | ||
+ | * No inline < | ||
+ | * Do not use javascript: | ||
- | ====== Accessibility | + | ===== Accessibility |
- | * Look at supporting | + | * Maintain support for right-to-left (RLT) languages |
* Investigate accessibility concerns in depth to determine how the pages will work in screen readers, on browsers with extra large font sizes, for colour blind users, etc. | * Investigate accessibility concerns in depth to determine how the pages will work in screen readers, on browsers with extra large font sizes, for colour blind users, etc. | ||
- | ====== User Interface | + | ===== User Interface ===== |
- | * Avoid dumbing down the interface to cater for computer illiterate users (and making the interface look pretty) at the expense of making | + | * Don't make life hard for power users. |
+ | * Workflow must be as efficient as possible | ||
+ | |||
+ | |||
+ | ===== Questions for discussion ===== | ||
+ | - App Mode -- several browsers | ||
+ | - Any requirements | ||
+ | - Supported browsers / versions? | ||
+ | - Firefox 3.0+ | ||
+ | - Recent versions of Opera, Chromium, Konqueror, Safari (should almost come for free from I) | ||
+ | - IE7+ | ||
+ | - IE6 support, if needed, can come through community contributions | ||
+ | - Come to some sort of arrangement on how plugins will manipulate the HTML to insert their own buttons, widgets, etc as required. | ||
- | ====== Questions for discussion ====== | ||
- | 1. App Mode -- several browsers are now supporting App Mode, do we have any requirements for that? Are there standards around this? | ||
- | 2. Any requirements to have MantisBT grease monkey friendly to allow users to easily customize the page? Not sure what that means, does it mean naming fields? divs, etc? | ||
- | 3. Supported browsers / versions? | ||
- |
mantisbt/style_guide.1287107606.txt.gz · Last modified: 2010/10/14 21:57 (external edit)