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:26] – daryn | mantisbt:style_guide [2013/04/30 05:54] (current) – dregad | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | | + | ====== Style Guide (DRAFT) ====== |
- | * Inline CSS styling should not appear in any HTML output. | + | |
- | * The pages should | + | ===== HTML ===== |
- | * jQuery | + | |
- | * I strongly suggest looking at PHPTAL over any other templating engine I've come across. This will assist us with security | + | * Do not use tables for layout. |
- | * Avoid dumbing down the interface to cater for computer illiterate users (and making the interface look pretty) at the expense of making life hard for "power users". Power users are those who are attached to MantisBT for many hours of the day triaging issues, scheduling work, creating reports, etc and they desire the most efficient workflow possible. Having to find functionality that has been hidden away behind multiple mouse clicks is going to frustrate them. | + | * 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.// |
- | * Look at supporting | + | |
- | * Come to some sort of arrangement on how plugins will manipulate the HTML to insert their own buttons, widgets, etc as required. | + | ===== CSS ===== |
- | * Use multiple stylesheets for different screen resolutions so that the page will appear differently on a smartphone | + | * The only method allowed for including |
- | * Split layout and colour/text into different stylesheets. The layout stylesheet would control the layout of components on the screen | + | * Do use a fluid layout |
- | (positions, widths, heights, etc) whereas the colour/text stylesheet would control the branding of MantisBT. This could make it easier for | + | * Do use css styles to make adjustments for browser widths |
- | people | + | * Investigate media queries for determining width |
+ | * Do support a print stylesheet which emphasizes legibility, clarity and efficient printing | ||
+ | * Do support mobile devices screen sizes (iPhone/Android/Windows Phone 7) | ||
+ | * Must be optional | ||
+ | * Must support screen rotation | ||
+ | * Must not require a separate url | ||
+ | * Do design stylesheets with rebranding in mind so that users may change colours and text effects without breaking the layouts | ||
+ | * Do not use inline CSS styling in any HTML output. | ||
+ | * Do not use html style attributes | ||
+ | * Do not use inline <style>..</style> blocks in the body | ||
+ | |||
+ | ===== Javascript ===== | ||
+ | * The only method allowed for including | ||
+ | * 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) | ||
+ | * 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 | ||
+ | * 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 ===== | ||
+ | * Don't make life hard for power users. | ||
+ | * Workflow must be as efficient as possible | ||
+ | |||
+ | |||
+ | ===== Questions for discussion ===== | ||
+ | - App Mode -- several browsers are now supporting App Mode, do we have any requirements for that? Are there standards around this? | ||
+ | - 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? | ||
+ | - 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. | ||
+ | |||
mantisbt/style_guide.1287105993.txt.gz · Last modified: 2010/10/14 21:27 (external edit)