From 90dd7f13aef1d475c5067f7d97e0cff0754f8f12 Mon Sep 17 00:00:00 2001 From: "Edward Z. Yang" Date: Sun, 19 Nov 2006 03:10:14 +0000 Subject: [PATCH] [1.2.0] HTML-ization for code-quality and colors. Also added in missing $Id$ to progress, and allowed for subtitling in the style. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@533 48356398-32a2-884e-a903-53898d9a118a --- docs/{code-quality.txt => code-quality.html} | 23 ++++++++-- docs/colors.html | 44 ++++++++++++++++++++ docs/colors.txt | 23 ---------- docs/progress.html | 2 + docs/style.css | 7 +++- 5 files changed, 71 insertions(+), 28 deletions(-) rename docs/{code-quality.txt => code-quality.html} (63%) create mode 100644 docs/colors.html delete mode 100644 docs/colors.txt diff --git a/docs/code-quality.txt b/docs/code-quality.html similarity index 63% rename from docs/code-quality.txt rename to docs/code-quality.html index 28041993..7264bb40 100644 --- a/docs/code-quality.txt +++ b/docs/code-quality.html @@ -1,12 +1,24 @@ + + + + + + -Code Quality Issues +Code Quality Issues - HTML Purifier End-User Documentation -Okay, face it. Programmers can get lazy, cut corners, or make mistakes. They + + +

Code Quality Issues

+ +

Okay, face it. Programmers can get lazy, cut corners, or make mistakes. They also can do quick prototypes, and then forget to rewrite them later. Well, while I can't list mistakes in here, I can list prototype-like segments of code that should be aggressively refactored. This does not list -optimization issues, that needs to be done after intense profiling. +optimization issues, that needs to be done after intense profiling.

+
 AttrDef
     Class - doesn't support Unicode characters (fringe); uses regular
         expressions
@@ -26,5 +38,8 @@ URIScheme - needs to have callable generic checks
     mailto - doesn't validate emails, doesn't validate querystring
     news - doesn't validate opaque path
     nntp - doesn't constrain path
-EOL
+
+
$Id$
+ + \ No newline at end of file diff --git a/docs/colors.html b/docs/colors.html new file mode 100644 index 00000000..24236b32 --- /dev/null +++ b/docs/colors.html @@ -0,0 +1,44 @@ + + + + + + + +Proposal: Colors - HTML Purifier Proposal + + + +

Proposal: Colors

+
Hammering some sense into those color-blind newbies
+ +

Your website probably has a color-scheme. +Green on white, +purple on yellow, +whatever. When you give users the ability to style their content, you may +want them to keep in line with your styling. If you're website is all +about light colors, you don't want a user to come in and vandalize your +page with a deep maroon.

+ +

This is an extremely silly feature proposal, but I'm writing it down anyway.

+ +

What if the user could constrain the colors specified in inline styles? You +are only allowed to use these shades of dark green for text and these shades +of light yellow for the background. At the very least, you could ensure +that we did not have pale yellow on white text.

+ +

Implementation issues

+ +
    +
  1. Requires the color attribute definition to know, currently, what the text +and background colors are. This becomes difficult when classes are thrown +into the mix.
    2. +
  2. The user still has to define the permissible colors, how does one do +something like that?
    3. +
+ +
$Id$
+ + + diff --git a/docs/colors.txt b/docs/colors.txt deleted file mode 100644 index e0b74e45..00000000 --- a/docs/colors.txt +++ /dev/null @@ -1,23 +0,0 @@ - -Colors - Hammering some sense into those content-makers - -Your website probably has a color-scheme. Green on white, purple on yellow, -whatever. When you give users the ability to style their content, you may -want them to keep in line with your styling. If you're website is all -about light colors, you don't want a user to come in and vandalize your -page with a deep maroon. - -This is an extremely silly feature proposal, but I'm writing it down anyway. - -What if the user could constrain the colors specified in inline styles? You -are only allowed to use these shades of dark green for text and these shades -of light yellow for the background. At the very least, you could ensure -that we did not have pale yellow on white text. - -Implementation issues: -1. Requires the color attribute definition to know, currently, what the text -and background colors are. This becomes difficult when classes are thrown -into the mix. -2. The user still has to define the permissible colors, how does one do -something like that? diff --git a/docs/progress.html b/docs/progress.html index 456ee3de..deb9263b 100644 --- a/docs/progress.html +++ b/docs/progress.html @@ -292,4 +292,6 @@ Mozilla on inside and needs -moz-outline, no IE support. +
$Id$
+ \ No newline at end of file diff --git a/docs/style.css b/docs/style.css index a0c92c7d..a32c0c6d 100644 --- a/docs/style.css +++ b/docs/style.css @@ -12,6 +12,11 @@ h2 {border-bottom:1px solid #CCC; font-family:sans-serif; font-weight:normal; h3 {font-family:sans-serif; font-size:1.1em; font-weight:bold; } h4 {font-family:sans-serif; font-size:0.9em; font-weight:bold; } +/* For witty quips */ +.subtitled {margin-bottom:0em;} +.subtitle {font-size:.8em; margin-bottom:1em; text-align:center; + font-style:italic; margin-top:-.2em;} + /* Used for special "See also" links. */ .reference {font-style:italic;margin-left:2em;} @@ -25,4 +30,4 @@ h4 {font-family:sans-serif; font-size:0.9em; font-weight:bold; } .table tbody td {border-bottom:1px solid #CCC; padding-right:0.6em;padding-left:0.6em;} /* Contains, without exception, $Id$, for SVN version info. */ -#version {text-align:right; font-style:italic; } \ No newline at end of file +#version {text-align:right; font-style:italic; margin:2em 0;} \ No newline at end of file