Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

189 rindas
5.7KB

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  6. <meta name="description" content="Index to all HTML Purifier documentation." />
  7. <link rel="stylesheet" type="text/css" href="./style.css" />
  8. <title>Documentation - HTML Purifier</title>
  9. </head>
  10. <body>
  11. <h1>Documentation</h1>
  12. <p><strong><a href="http://htmlpurifier.org/">HTML Purifier</a></strong> has documentation for all types of people.
  13. Here is an index of all of them.</p>
  14. <h2>End-user</h2>
  15. <p>End-user documentation that contains articles, tutorials and useful
  16. information for casual developers using HTML Purifier.</p>
  17. <dl>
  18. <dt><a href="enduser-id.html">IDs</a></dt>
  19. <dd>Explains various methods for allowing IDs in documents safely.</dd>
  20. <dt><a href="enduser-youtube.html">Embedding YouTube videos</a></dt>
  21. <dd>Explains how to safely allow the embedding of flash from trusted sites.</dd>
  22. <dt><a href="enduser-slow.html">Speeding up HTML Purifier</a></dt>
  23. <dd>Explains how to speed up HTML Purifier through caching or inbound filtering.</dd>
  24. <dt><a href="enduser-utf8.html">UTF-8: The Secret of Character Encoding</a></dt>
  25. <dd>Describes the rationale for using UTF-8, the ramifications otherwise, and how to make the switch.</dd>
  26. <dt><a href="enduser-tidy.html">Tidy</a></dt>
  27. <dd>Tutorial for tweaking HTML Purifier's Tidy-like behavior.</dd>
  28. <dt><a href="enduser-customize.html">Customize</a></dt>
  29. <dd>Tutorial for customizing HTML Purifier's tag and attribute sets.</dd>
  30. <dt><a href="enduser-uri-filter.html">URI Filters</a></dt>
  31. <dd>Tutorial for creating custom URI filters.</dd>
  32. </dl>
  33. <h2>Development</h2>
  34. <p>Developer documentation detailing code issues, roadmaps and project
  35. conventions.</p>
  36. <dl>
  37. <dt><a href="dev-progress.html">Implementation Progress</a></dt>
  38. <dd>Tables detailing HTML element and CSS property implementation coverage.</dd>
  39. <dt><a href="dev-naming.html">Naming Conventions</a></dt>
  40. <dd>Defines class naming conventions.</dd>
  41. <dt><a href="dev-optimization.html">Optimization</a></dt>
  42. <dd>Discusses possible methods of optimizing HTML Purifier.</dd>
  43. <dt><a href="dev-flush.html">Flushing the Purifier</a></dt>
  44. <dd>Discusses when to flush HTML Purifier's various caches.</dd>
  45. <dt><a href="dev-advanced-api.html">Advanced API</a></dt>
  46. <dd>Specification for HTML Purifier's advanced API for defining
  47. custom filtering behavior.</dd>
  48. <dt><a href="dev-config-schema.html">Config Schema</a></dt>
  49. <dd>Describes config schema framework in HTML Purifier.</dd>
  50. </dl>
  51. <h2>Proposals</h2>
  52. <p>Proposed features, as well as the associated rambling to get a clear
  53. objective in place before attempted implementation.</p>
  54. <dl>
  55. <dt><a href="proposal-colors.html">Colors</a></dt>
  56. <dd>Proposal to allow for color constraints.</dd>
  57. </dl>
  58. <h2>Reference</h2>
  59. <p>Miscellaneous essays, research pieces and other reference type material
  60. that may not directly discuss HTML Purifier.</p>
  61. <dl>
  62. <dt><a href="ref-devnetwork.html">DevNetwork Credits</a></dt>
  63. <dd>Credits and links to DevNetwork forum topics.</dd>
  64. </dl>
  65. <h2>Internal memos</h2>
  66. <p>Plaintext documents that are more for use by active developers of
  67. the code. They may be upgraded to HTML files or stay as TXT scratchpads.</p>
  68. <table class="table">
  69. <thead><tr>
  70. <th style="width:10%">Type</th>
  71. <th style="width:20%">Name</th>
  72. <th>Description</th>
  73. </tr></thead>
  74. <tbody>
  75. <tr>
  76. <td>End-user</td>
  77. <td><a href="enduser-overview.txt">Overview</a></td>
  78. <td>High level overview of the general control flow (mostly obsolete).</td>
  79. </tr>
  80. <tr>
  81. <td>End-user</td>
  82. <td><a href="enduser-security.txt">Security</a></td>
  83. <td>Common security issues that may still arise (half-baked).</td>
  84. </tr>
  85. <tr>
  86. <td>Development</td>
  87. <td><a href="dev-config-bcbreaks.txt">Config BC Breaks</a></td>
  88. <td>Backwards-incompatible changes in HTML Purifier 4.0.0</td>
  89. </tr>
  90. <tr>
  91. <td>Development</td>
  92. <td><a href="dev-code-quality.txt">Code Quality Issues</a></td>
  93. <td>Enumerates code quality issues and places that need to be refactored.</td>
  94. </tr>
  95. <tr>
  96. <td>Proposal</td>
  97. <td><a href="proposal-filter-levels.txt">Filter levels</a></td>
  98. <td>Outlines details of projected configurable level of filtering.</td>
  99. </tr>
  100. <tr>
  101. <td>Proposal</td>
  102. <td><a href="proposal-language.txt">Language</a></td>
  103. <td>Specification of I18N for error messages derived from MediaWiki (half-baked).</td>
  104. </tr>
  105. <tr>
  106. <td>Proposal</td>
  107. <td><a href="proposal-new-directives.txt">New directives</a></td>
  108. <td>Assorted configuration options that could be implemented.</td>
  109. </tr>
  110. <tr>
  111. <td>Proposal</td>
  112. <td><a href="proposal-css-extraction.txt">CSS extraction</a></td>
  113. <td>Taking the inline CSS out of documents and into <code>style</code>.</td>
  114. </tr>
  115. <tr>
  116. <td>Reference</td>
  117. <td><a href="ref-content-models.txt">Handling Content Model Changes</a></td>
  118. <td>Discusses how to tidy up content model changes using custom ChildDef classes.</td>
  119. </tr>
  120. <tr>
  121. <td>Reference</td>
  122. <td><a href="ref-proprietary-tags.txt">Proprietary tags</a></td>
  123. <td>List of vendor-specific tags we may want to transform to W3C compliant markup.</td>
  124. </tr>
  125. <tr>
  126. <td>Reference</td>
  127. <td><a href="ref-html-modularization.txt">Modularization of HTMLDefinition</a></td>
  128. <td>Provides a high-level overview of the concepts behind HTMLModules.</td>
  129. </tr>
  130. <tr>
  131. <td>Reference</td>
  132. <td><a href="ref-whatwg.txt">WHATWG</a></td>
  133. <td>How WHATWG plays into what we need to do.</td>
  134. </tr>
  135. </tbody>
  136. </table>
  137. </body>
  138. </html>
  139. <!-- vim: et sw=4 sts=4
  140. -->