Design/Living style guide

From MediaWiki.org
Jump to: navigation, search
shortcut: LSG

A living style guide offers improved documentation of the visual appearance and behavior of a site.
Unlike a static style guide (say, a wiki page or PDF), it is generated on-the-fly from the actual HTML, CSS, and JavaScript used in production.[1][2] This allows us to view styles as they are live on the site, and inline comments can be added to document the purpose of a particular style or set of styles.

MediaWiki currently has one style guide (the other 2 are outdated, see task T51117 and task T51117#2808532):

CURRENT
OUTDATED

Starting with release 1.25, when you use OOjs UI components within MediaWiki, they use its WikimediaUI theme which has its roots in mediawiki.UI.

Implementation[edit]

OOjs UI library live demos[edit]

This OOjs UI library features a live demo environment with all JS & PHP components and their JavaScript code snippets.

See also[edit]

Notes[edit]

Coding conventionsManual:Coding conventions
General All languagesManual:Coding conventions#Code structure · Development policyDevelopment policy · Security for developersSecurity for developers · Pre-commit checklistManual:Pre-commit checklist · Performance guidelinesPerformance guidelines(draft) · Style guideDesign/Living style guide · Accessibility guide for developersAccessibility guide for developers(draft)
PHP Code conventionsManual:Coding conventions/PHP · PHPUnit test conventionsManual:PHP unit testing/Writing unit tests#Test_conventions · Security checklist for developersSecurity checklist for developers
JavaScript Code conventionsManual:Coding conventions/JavaScript · Learning JavaScriptLearning JavaScript
CSS Code conventionsManual:Coding conventions/CSS
Database Code conventionsManual:Coding conventions/Database · Database policyDevelopment policy#Database policy
Python Code conventionsManual:Coding conventions/Python
Ruby Code conventionsManual:Coding conventions/Ruby
Selenium/Cucumber Code conventionsManual:Coding conventions/Selenium
Java Code conventionsManual:Coding conventions/Java
API client code Standards for API client librariesAPI:Client code/Gold standard