From 0d92391d1c96ae134759271d036a8fe68f09f9b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Nettingsmeier?= Date: Mon, 3 Feb 2014 18:09:00 +0100 Subject: [PATCH] update style guide. --- STYLE_GUIDE | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/STYLE_GUIDE b/STYLE_GUIDE index f744496..53170b1 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -42,6 +42,10 @@ be valid XML, with all tags closed properly. The reason for this extra complication is that XML can be more easily checked and automatically refactored than plain HTML, which eases maintenance. +Watch out for the ampersand "&" and angle brackets "<" and ">". They will +render your XHTML invalid, and must be replaced by their named entities +"&", "<", and ">". + 3. Custom classes ================= @@ -57,8 +61,19 @@ If you need to apply a class to several block-level elements such as paragraphs or lists, enclose them in a
..
. Wherever possible, create semantic classes rather than visual ones. -.left: make an element float left in the surrounding paragraph. -.right: make an element float right in the surrounding paragraph. +.left: +make an element float left in the surrounding paragraph. + +.right: +make an element float right in the surrounding paragraph. + +.note: +use for important notes that should be visually distinct from the +normal text flow, or asides. Currently rendered in a gray box. + +.warning: +use for potentially dangerous situations involving data loss, malfunction, +or sound quality issues. Currently rendered in a red box. 4. Element use