From 780c7fd3094ac6df606b3ef725e097cc88920a20 Mon Sep 17 00:00:00 2001 From: "Edward Z. Yang" Date: Sun, 19 Nov 2006 02:36:47 +0000 Subject: [PATCH] [1.2.0] Revamp docs - Style existing HTML files (taken from AuthTools) - Add svn:eol-style=native and svn:keywords=Id to all file - Add metadata to HTML files - Trim DevNetwork by using git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@532 48356398-32a2-884e-a903-53898d9a118a --- docs/devnetwork.html | 72 +++--- docs/progress.html | 585 ++++++++++++++++++++++--------------------- docs/style.css | 28 +++ 3 files changed, 363 insertions(+), 322 deletions(-) create mode 100644 docs/style.css diff --git a/docs/devnetwork.html b/docs/devnetwork.html index 1fcec1bf..5cd12472 100644 --- a/docs/devnetwork.html +++ b/docs/devnetwork.html @@ -1,32 +1,42 @@ - - - - -DevNetwork Forums - - - - -

Many thanks to the DevNetwork community for answering questions, -theorizing about design, and offering encouragement during -the development of this library in these forum threads:

- - - + + + + + + + + +DevNetwork Credits - HTML Purifier End-User Documentation + + + + +

DevNetwork Credits

+ +

Many thanks to the DevNetwork community for answering questions, +theorizing about design, and offering encouragement during +the development of this library in these forum threads:

+ + + +

...as well as any I may have forgotten.

+ +
$Id$
+ \ No newline at end of file diff --git a/docs/progress.html b/docs/progress.html index a15386e9..456ee3de 100644 --- a/docs/progress.html +++ b/docs/progress.html @@ -1,292 +1,295 @@ - - - - -HTMLPurifier Progress - - - - - -

HTMLPurifier Progress

- -

Key

- - - - - - - - -
Implemented
Partially implemented
Will not implement
Dangerous attribute/property
Present in CSS1
Feature, requires extra work
- -

CSS

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameNotes
Standard
background-colorCOMPOSITE(<color>, transparent)
backgroundSHORTHAND, only for color, see below for info on background-image and friends
borderSHORTHAND, MULTIPLE
border-colorMULTIPLE
border-styleMULTIPLE
border-widthMULTIPLE
border-*SHORTHAND
border-*-colorCOMPOSITE(<color>, transparent)
border-*-styleENUM(none, hidden, dotted, dashed, - solid, double, groove, ridge, inset, outset)
border-*-widthCOMPOSITE(<length>, thin, medium, thick)
clearENUM(none, left, right, both)
color<color>
floatENUM(left, right, none), May require layout - precautions with clear
fontSHORTHAND
font-familyCSS validator may complain if fallback font - family not specified
font-sizeCOMPOSITE(<absolute-size>, - <relative-size>, <length>, <percentage>)
font-styleENUM(normal, italic, oblique)
font-variantENUM(normal, small-caps)
font-weightENUM(normal, bold, bolder, lighter, - 100, 200, 300, 400, 500, 600, 700, 800, 900), maybe special code for - in-between integers
letter-spacingCOMPOSITE(<length>, normal)
line-heightCOMPOSITE(<number>, - <length>, <percentage>, normal)
list-style-positionENUM(inside, outside), - Strange behavior in browsers
list-style-typeENUM(...), - Well-supported values are: disc, circle, square, - decimal, lower-roman, upper-roman, lower-alpha and upper-alpha. See also - CSS 3. Mostly IE lack of support.
list-styleSHORTHAND
marginMULTIPLE
margin-*COMPOSITE(<length>, - <percentage>, auto)
paddingMULTIPLE
padding-*COMPOSITE(<length>(positive), - <percentage>(positive))
text-alignENUM(left, right, - center, justify)
text-decorationNo blink (argh my eyes), not - enum, can be combined (composite sorta): underline, overline, - line-through
text-indentCOMPOSITE(<length>, - <percentage>)
text-transformENUM(capitalize, uppercase, - lowercase, none)
widthCOMPOSITE(<length>, - <percentage>, auto), Interesting
word-spacingCOMPOSITE(<length>, auto), - IE 5 no support
Table
border-collapseENUM(collapse, seperate)
caption-sideENUM(top, bottom)
empty-cellsENUM(show, hide), No IE support makes this useless, - possible fix with &nbsp;? Unknown release milestone.
table-layoutENUM(auto, fixed)
vertical-alignCOMPOSITE(ENUM(baseline, sub, - super, top, text-top, middle, bottom, text-bottom), <percentage>, - <length>) Also applies to others with explicit height
Absolute positioning, unknown release milestone
bottomDangerous, must be non-negative
left
right
top
clip-
positionENUM(static, relative, absolute, fixed), permit - relative not absolute?
z-indexDangerous
Unknown
background-imageDangerous, target milestone 1.2
background-attachmentENUM(scroll, fixed), - Depends on background-image
background-positionDepends on background-image
cursorDangerous but fluffy
displayENUM(...), Dangerous but interesting; - will not implement list-item, run-in (Opera only) or table (no IE); - inline-block has incomplete IE6 support and requires -moz-inline-box - for Mozilla. Unknown target milestone.
heightInteresting, why use it? Unknown target milestone.
list-style-imageDangerous? Target milestone 1.2
max-heightNo IE 5/6
min-height
max-width
min-width
orphansNo IE support
widowsNo IE support
overflowENUM, IE 5/6 almost (remove visible if set). Unknown target milestone.
page-break-afterENUM(auto, always, avoid, left, right), - IE 5.5/6 and Opera. Unknown target milestone.
page-break-beforeENUM(auto, always, avoid, left, right), - Mostly supported. Unknown target milestone.
page-break-insideENUM(avoid, auto), Opera only. Unknown target milestone.
quotesMay be dropped from CSS2, fairly useless for inline context
visibilityENUM(visible, hidden, collapse), - Dangerous
white-spaceENUM(normal, pre, nowrap, pre-wrap, - pre-line), Spotty implementation: - pre (no IE 5/6), nowrap (no IE 5), - pre-wrap (only Opera), pre-line (no support). Fixable? Unknown target milestone.
Aural
azimuth-
cue-
cue-after-
cue-before-
elevation-
pause-after-
pause-before-
pause-
pitch-range-
pitch-
play-during-
richness-
speak-headerTable related
speak-numeral-
speak-punctuation-
speak-
speech-rate-
stress-
voice-family-
volume-
Will not implement
contentNot applicable for inline styles
counter-incrementNeeds content, Opera only
counter-resetNeeds content, Opera only
directionNo support
outline-colorIE Mac and Opera on outside, -Mozilla on inside and needs -moz-outline, no IE support.
outline-style
outline-width
outline
unicode-bidiNo support
- -

Interesting Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AttributeTagsNotes
CSS
styleAllNot all properties may be implemented, parser is good though.
Questionable
accesskeyAMay interfere with main interface
tabindexAMay interfere with main interface
targetAConfig enabled, only useful for frame layouts
Miscellaneous
datetimeDEL, INSNo visible effect, ISO format
relALargely user-defined: nofollow, tag (see microformats)
revALargely user-defined: vote-*
axisTD, THW3C only: No browser implementation
charCOL, COLGROUP, TBODY, TD, TFOOT, TH, THEAD, TRW3C only: No browser implementation
headersTD, THW3C only: No browser implementation
scopeTD, THW3C only: No browser implementation
URI
citeBLOCKQUOTE, QFor attribution
DEL, INSLink to explanation why it changed
hrefA-
longdescIMG-
srcIMGRequired
Transform, target milestone 1.4
alignCAPTIONNear-equiv style 'caption-side', drop left and right
IMGMargin-left and margin-right = auto or parent div
TABLE
HREquivalent style 'text-align' (IE tested)
H1, H2, H3, H4, H5, H6, PEquivalent style 'text-align'
altIMGRequired, insert image filename if src is present or default invalid image text
bgcolorTABLEEquivalent style 'background-color' (IE tested)
TREquivalent style 'background-color' (IE tested)
TD, THEquivalent style 'background-color'
borderIMGEquivalent style 'border-width', only applies when link present
clearBRNear-equiv style 'clear', transform 'all' into 'both'
compactDL, OL, ULBoolean, needs custom CSS class; rarely used anyway
dirBDORequired, insert ltr (or configuration value) if none
heightTD, THNear-equiv style 'height', needs px suffix if original was in pixels
hspaceIMGNear-equiv styles 'margin-top' and 'margin-bottom', needs px suffix
lang*Copy value to xml:lang
nameIMGTurn into ID
ATurn into ID? (not deprecated, though in which specs?)
noshadeHRBoolean, style 'border-style:solid;'
nowrapTD, THBoolean, style 'white-space:nowrap;' (not compat with IE5)
sizeHRNear-equiv 'width', needs px suffix if original was pixels
srcIMGRequired, insert blank or default img if not set
startOLPoorly supported 'counter-reset', transform may not be desirable
typeLIEquivalent style 'list-style-type', different allowed values though. (needs testing)
OL
UL
valueLIPoorly supported 'counter-reset', transform may not be desirable, see ol.start. Configurable.
vspaceIMGNear-equiv styles 'margin-left' and 'margin-right', needs px suffix, see hspace
widthHRNear-equiv style 'width', needs px suffix if original was pixels
TD, TH
- + + + + + + + +Implementation Progress - HTML Purifier End-User Documentation + + + + + +

Implementation Progress

+ +

Key

+ + + + + + + + +
Implemented
Partially implemented
Will not implement
Dangerous attribute/property
Present in CSS1
Feature, requires extra work
+ +

CSS

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNotes
Standard
background-colorCOMPOSITE(<color>, transparent)
backgroundSHORTHAND, only for color, see below for info on background-image and friends
borderSHORTHAND, MULTIPLE
border-colorMULTIPLE
border-styleMULTIPLE
border-widthMULTIPLE
border-*SHORTHAND
border-*-colorCOMPOSITE(<color>, transparent)
border-*-styleENUM(none, hidden, dotted, dashed, + solid, double, groove, ridge, inset, outset)
border-*-widthCOMPOSITE(<length>, thin, medium, thick)
clearENUM(none, left, right, both)
color<color>
floatENUM(left, right, none), May require layout + precautions with clear
fontSHORTHAND
font-familyCSS validator may complain if fallback font + family not specified
font-sizeCOMPOSITE(<absolute-size>, + <relative-size>, <length>, <percentage>)
font-styleENUM(normal, italic, oblique)
font-variantENUM(normal, small-caps)
font-weightENUM(normal, bold, bolder, lighter, + 100, 200, 300, 400, 500, 600, 700, 800, 900), maybe special code for + in-between integers
letter-spacingCOMPOSITE(<length>, normal)
line-heightCOMPOSITE(<number>, + <length>, <percentage>, normal)
list-style-positionENUM(inside, outside), + Strange behavior in browsers
list-style-typeENUM(...), + Well-supported values are: disc, circle, square, + decimal, lower-roman, upper-roman, lower-alpha and upper-alpha. See also + CSS 3. Mostly IE lack of support.
list-styleSHORTHAND
marginMULTIPLE
margin-*COMPOSITE(<length>, + <percentage>, auto)
paddingMULTIPLE
padding-*COMPOSITE(<length>(positive), + <percentage>(positive))
text-alignENUM(left, right, + center, justify)
text-decorationNo blink (argh my eyes), not + enum, can be combined (composite sorta): underline, overline, + line-through
text-indentCOMPOSITE(<length>, + <percentage>)
text-transformENUM(capitalize, uppercase, + lowercase, none)
widthCOMPOSITE(<length>, + <percentage>, auto), Interesting
word-spacingCOMPOSITE(<length>, auto), + IE 5 no support
Table
border-collapseENUM(collapse, seperate)
caption-sideENUM(top, bottom)
empty-cellsENUM(show, hide), No IE support makes this useless, + possible fix with &nbsp;? Unknown release milestone.
table-layoutENUM(auto, fixed)
vertical-alignCOMPOSITE(ENUM(baseline, sub, + super, top, text-top, middle, bottom, text-bottom), <percentage>, + <length>) Also applies to others with explicit height
Absolute positioning, unknown release milestone
bottomDangerous, must be non-negative
left
right
top
clip-
positionENUM(static, relative, absolute, fixed), permit + relative not absolute?
z-indexDangerous
Unknown
background-imageDangerous, target milestone 1.2
background-attachmentENUM(scroll, fixed), + Depends on background-image
background-positionDepends on background-image
cursorDangerous but fluffy
displayENUM(...), Dangerous but interesting; + will not implement list-item, run-in (Opera only) or table (no IE); + inline-block has incomplete IE6 support and requires -moz-inline-box + for Mozilla. Unknown target milestone.
heightInteresting, why use it? Unknown target milestone.
list-style-imageDangerous? Target milestone 1.2
max-heightNo IE 5/6
min-height
max-width
min-width
orphansNo IE support
widowsNo IE support
overflowENUM, IE 5/6 almost (remove visible if set). Unknown target milestone.
page-break-afterENUM(auto, always, avoid, left, right), + IE 5.5/6 and Opera. Unknown target milestone.
page-break-beforeENUM(auto, always, avoid, left, right), + Mostly supported. Unknown target milestone.
page-break-insideENUM(avoid, auto), Opera only. Unknown target milestone.
quotesMay be dropped from CSS2, fairly useless for inline context
visibilityENUM(visible, hidden, collapse), + Dangerous
white-spaceENUM(normal, pre, nowrap, pre-wrap, + pre-line), Spotty implementation: + pre (no IE 5/6), nowrap (no IE 5), + pre-wrap (only Opera), pre-line (no support). Fixable? Unknown target milestone.
Aural
azimuth-
cue-
cue-after-
cue-before-
elevation-
pause-after-
pause-before-
pause-
pitch-range-
pitch-
play-during-
richness-
speak-headerTable related
speak-numeral-
speak-punctuation-
speak-
speech-rate-
stress-
voice-family-
volume-
Will not implement
contentNot applicable for inline styles
counter-incrementNeeds content, Opera only
counter-resetNeeds content, Opera only
directionNo support
outline-colorIE Mac and Opera on outside, +Mozilla on inside and needs -moz-outline, no IE support.
outline-style
outline-width
outline
unicode-bidiNo support
+ +

Interesting Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeTagsNotes
CSS
styleAllNot all properties may be implemented, parser is good though.
Questionable
accesskeyAMay interfere with main interface
tabindexAMay interfere with main interface
targetAConfig enabled, only useful for frame layouts
Miscellaneous
datetimeDEL, INSNo visible effect, ISO format
relALargely user-defined: nofollow, tag (see microformats)
revALargely user-defined: vote-*
axisTD, THW3C only: No browser implementation
charCOL, COLGROUP, TBODY, TD, TFOOT, TH, THEAD, TRW3C only: No browser implementation
headersTD, THW3C only: No browser implementation
scopeTD, THW3C only: No browser implementation
URI
citeBLOCKQUOTE, QFor attribution
DEL, INSLink to explanation why it changed
hrefA-
longdescIMG-
srcIMGRequired
Transform, target milestone 1.4
alignCAPTIONNear-equiv style 'caption-side', drop left and right
IMGMargin-left and margin-right = auto or parent div
TABLE
HREquivalent style 'text-align' (IE tested)
H1, H2, H3, H4, H5, H6, PEquivalent style 'text-align'
altIMGRequired, insert image filename if src is present or default invalid image text
bgcolorTABLEEquivalent style 'background-color' (IE tested)
TREquivalent style 'background-color' (IE tested)
TD, THEquivalent style 'background-color'
borderIMGEquivalent style 'border-width', only applies when link present
clearBRNear-equiv style 'clear', transform 'all' into 'both'
compactDL, OL, ULBoolean, needs custom CSS class; rarely used anyway
dirBDORequired, insert ltr (or configuration value) if none
heightTD, THNear-equiv style 'height', needs px suffix if original was in pixels
hspaceIMGNear-equiv styles 'margin-top' and 'margin-bottom', needs px suffix
lang*Copy value to xml:lang
nameIMGTurn into ID
ATurn into ID? (not deprecated, though in which specs?)
noshadeHRBoolean, style 'border-style:solid;'
nowrapTD, THBoolean, style 'white-space:nowrap;' (not compat with IE5)
sizeHRNear-equiv 'width', needs px suffix if original was pixels
srcIMGRequired, insert blank or default img if not set
startOLPoorly supported 'counter-reset', transform may not be desirable
typeLIEquivalent style 'list-style-type', different allowed values though. (needs testing)
OL
UL
valueLIPoorly supported 'counter-reset', transform may not be desirable, see ol.start. Configurable.
vspaceIMGNear-equiv styles 'margin-left' and 'margin-right', needs px suffix, see hspace
widthHRNear-equiv style 'width', needs px suffix if original was pixels
TD, TH
+ \ No newline at end of file diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 00000000..a0c92c7d --- /dev/null +++ b/docs/style.css @@ -0,0 +1,28 @@ +html {font-size:1em; font-family:serif; } +body {margin-left:4em; margin-right:4em; } + +dt {font-weight:bold; } +pre {margin-left:2em; } +pre, code, tt {font-family:monospace; font-size:1em; } + +h1 {text-align:center; font-family:Garamond, serif; + font-variant:small-caps;} +h2 {border-bottom:1px solid #CCC; font-family:sans-serif; font-weight:normal; + font-size:1.3em;} +h3 {font-family:sans-serif; font-size:1.1em; font-weight:bold; } +h4 {font-family:sans-serif; font-size:0.9em; font-weight:bold; } + +/* Used for special "See also" links. */ +.reference {font-style:italic;margin-left:2em;} + +/* Marks off asides, discussions on why something is the way it is */ +.aside {margin-left:2em; font-family:sans-serif; font-size:0.9em; } + +/* A regular table */ +.table {border-collapse:collapse; border-bottom:2px solid #888; margin-left:2em; } +.table thead th {margin:0; background:#888; color:#FFF; } +.table thead th:first-child {-moz-border-radius-topleft:1em;} +.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