| 1 | <?xml version="1.0" encoding="utf-8" ?> |
|---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|---|
| 3 | |
|---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 5 | <head> |
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|---|
| 7 | <meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" /> |
|---|
| 8 | <title>MochiKit Documentation Index</title> |
|---|
| 9 | |
|---|
| 10 | <link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" /> |
|---|
| 11 | <script type="text/javascript" src="../../../packed/MochiKit/MochiKit.js"></script> |
|---|
| 12 | <script type="text/javascript" src="../../js/toc.js"></script> |
|---|
| 13 | </head> |
|---|
| 14 | <body> |
|---|
| 15 | <div class="document"> |
|---|
| 16 | <div class="section"> |
|---|
| 17 | <h1><a id="distribution" name="distribution">Distribution</a></h1> |
|---|
| 18 | <p>MochiKit - makes JavaScript suck a bit less</p> |
|---|
| 19 | <ul class="simple"> |
|---|
| 20 | <li><a class="mochiref reference" href="Async.html">MochiKit.Async</a> - manage asynchronous tasks</li> |
|---|
| 21 | <li><a class="mochiref reference" href="Base.html">MochiKit.Base</a> - functional programming and useful comparisons</li> |
|---|
| 22 | <li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a> - painless DOM manipulation API</li> |
|---|
| 23 | <li><a class="mochiref reference" href="Color.html">MochiKit.Color</a> - color abstraction with CSS3 support</li> |
|---|
| 24 | <li><a class="mochiref reference" href="DateTime.html">MochiKit.DateTime</a> - "what time is it anyway?"</li> |
|---|
| 25 | <li><a class="mochiref reference" href="Format.html">MochiKit.Format</a> - string formatting goes here</li> |
|---|
| 26 | <li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a> - itertools for JavaScript; iteration made HARD, |
|---|
| 27 | and then easy</li> |
|---|
| 28 | <li><a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> - we're all tired of <tt class="docutils literal"><span class="pre">alert()</span></tt></li> |
|---|
| 29 | <li><a class="mochiref reference" href="LoggingPane.html">MochiKit.LoggingPane</a> - interactive <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> |
|---|
| 30 | pane</li> |
|---|
| 31 | <li><a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> - simple universal event handling</li> |
|---|
| 32 | <li><a class="mochiref reference" href="Visual.html">MochiKit.Visual</a> - visual effects</li> |
|---|
| 33 | </ul> |
|---|
| 34 | </div> |
|---|
| 35 | <div class="section"> |
|---|
| 36 | <h1><a id="screencasts" name="screencasts">Screencasts</a></h1> |
|---|
| 37 | <ul class="simple"> |
|---|
| 38 | <li><a class="reference" href="http://mochikit.com/screencasts/MochiKit_Intro-1">MochiKit 1.1 Intro</a></li> |
|---|
| 39 | </ul> |
|---|
| 40 | </div> |
|---|
| 41 | <div class="section"> |
|---|
| 42 | <h1><a id="see-also" name="see-also">See Also</a></h1> |
|---|
| 43 | <ul class="simple"> |
|---|
| 44 | <li><a class="reference" href="http://groups.google.com/group/mochikit">Google Groups: MochiKit</a>: The official mailing list for discussions |
|---|
| 45 | related to development of and with MochiKit</li> |
|---|
| 46 | <li><a class="reference" href="http://mochikit.com/">mochikit.com</a>: MochiKit's home on the web</li> |
|---|
| 47 | <li><a class="reference" href="http://bob.pythonmac.org/">from __future__ import *</a>: Bob Ippolito's blog</li> |
|---|
| 48 | <li><a class="reference" href="http://openjsan.org/doc/b/bo/bob/MochiKit/">MochiKit on JSAN</a>: the JSAN distribution page for MochiKit</li> |
|---|
| 49 | <li><a class="reference" href="http://del.icio.us/tag/mochikit">MochiKit tag on del.icio.us</a>: Recent bookmarks related to MochiKit</li> |
|---|
| 50 | <li><a class="reference" href="http://technorati.com/tag/mochikit">MochiKit tag on Technorati</a>: Recent blog entries related to MochiKit</li> |
|---|
| 51 | </ul> |
|---|
| 52 | </div> |
|---|
| 53 | <div class="section"> |
|---|
| 54 | <h1><a id="version-history" name="version-history">Version History</a></h1> |
|---|
| 55 | <p>2006-XX-XX v1.3</p> |
|---|
| 56 | <ul class="simple"> |
|---|
| 57 | <li>New MochiKit-based SimpleTest test runner as a replacement for Test.Simple</li> |
|---|
| 58 | <li>MochiKit.Base.isNull no longer matches undefined</li> |
|---|
| 59 | <li>example doctypes changed to HTML4</li> |
|---|
| 60 | <li>isDateLike no longer throws error on null</li> |
|---|
| 61 | <li>New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt</li> |
|---|
| 62 | <li>updated elementDimensions to calculate width from offsetWidth instead |
|---|
| 63 | of clientWidth</li> |
|---|
| 64 | <li>formContents now works with FORM tags that have a name attribute</li> |
|---|
| 65 | <li>Documentation now uses MochiKit to generate a function index</li> |
|---|
| 66 | </ul> |
|---|
| 67 | <p>2006-01-26 v1.2 "the ocho"</p> |
|---|
| 68 | <ul class="simple"> |
|---|
| 69 | <li>Fixed MochiKit.Color.Color.lighterColorWithLevel</li> |
|---|
| 70 | <li>Added new MochiKit.Base.findIdentical function to find the index of an |
|---|
| 71 | element in an Array-like object. Uses === for identity comparison.</li> |
|---|
| 72 | <li>Added new MochiKit.Base.find function to find the index of an element in |
|---|
| 73 | an Array-like object. Uses compare for rich comparison.</li> |
|---|
| 74 | <li>MochiKit.Base.bind will accept a string for func, which will be immediately |
|---|
| 75 | looked up as self[func].</li> |
|---|
| 76 | <li>MochiKit.DOM.formContents no longer skips empty form elements for Zope |
|---|
| 77 | compatibility</li> |
|---|
| 78 | <li>MochiKit.Iter.forEach will now catch StopIteration to break</li> |
|---|
| 79 | <li>New MochiKit.DOM.elementDimensions(element) for determining the width and |
|---|
| 80 | height of an element in the document</li> |
|---|
| 81 | <li>MochiKit.DOM's initialization is now compatible with |
|---|
| 82 | HTMLUnit + JWebUnit + Rhino</li> |
|---|
| 83 | <li>MochiKit.LoggingPane will now re-use a <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> DIV element |
|---|
| 84 | currently in the document instead of always creating one.</li> |
|---|
| 85 | <li>MochiKit.Base now has operator.mul</li> |
|---|
| 86 | <li>MochiKit.DOM.formContents correctly handles unchecked checkboxes that have |
|---|
| 87 | a custom value attribute</li> |
|---|
| 88 | <li>Added new MochiKit.Color constructors fromComputedStyle and fromText</li> |
|---|
| 89 | <li>MochiKit.DOM.setNodeAttribute should work now</li> |
|---|
| 90 | <li>MochiKit.DOM now has a workaround for an IE bug when setting the style |
|---|
| 91 | property to a string</li> |
|---|
| 92 | <li>MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the |
|---|
| 93 | name and for properties</li> |
|---|
| 94 | <li>MochiKit.DOM.scrapeText now walks the DOM tree in-order</li> |
|---|
| 95 | <li>MochiKit.LoggingPane now sanitizes the window name to work around IE bug</li> |
|---|
| 96 | <li>MochiKit.DOM now translates usemap to useMap to work around IE bug</li> |
|---|
| 97 | <li>MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks</li> |
|---|
| 98 | <li>Added new MochiKit.DOM documentation on element visibility</li> |
|---|
| 99 | <li>New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}]) |
|---|
| 100 | for determining the position of an element in the document</li> |
|---|
| 101 | <li>Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG</li> |
|---|
| 102 | </ul> |
|---|
| 103 | <p>2005-11-14 v1.1</p> |
|---|
| 104 | <ul class="simple"> |
|---|
| 105 | <li>Fixed a bug in numberFormatter with large numbers</li> |
|---|
| 106 | <li>Massively overhauled documentation</li> |
|---|
| 107 | <li>Fast-path for primitives in MochiKit.Base.compare</li> |
|---|
| 108 | <li>New groupby and groupby_as_array in MochiKit.Iter</li> |
|---|
| 109 | <li>Added iterator factory adapter for objects that implement iterateNext()</li> |
|---|
| 110 | <li>Fixed isoTimestamp to handle timestamps with time zone correctly</li> |
|---|
| 111 | <li>Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP, |
|---|
| 112 | LEGEND, FIELDSET</li> |
|---|
| 113 | <li>New MochiKit.DOM formContents and enhancement to queryString to support it</li> |
|---|
| 114 | <li>Updated view_source example to use dp.SyntaxHighlighter 1.3.0</li> |
|---|
| 115 | <li>MochiKit.LoggingPane now uses named windows based on the URL so that |
|---|
| 116 | a given URL will get the same LoggingPane window after a reload |
|---|
| 117 | (at the same position, etc.)</li> |
|---|
| 118 | <li>MochiKit.DOM now has currentWindow() and currentDocument() context |
|---|
| 119 | variables that are set with withWindow() and withDocument(). These |
|---|
| 120 | context variables affect all MochiKit.DOM functionality (getElement, |
|---|
| 121 | createDOM, etc.)</li> |
|---|
| 122 | <li>MochiKit.Base.items will now catch and ignore exceptions for properties |
|---|
| 123 | that are enumerable but not accessible (e.g. permission denied)</li> |
|---|
| 124 | <li>MochiKit.Async.Deferred's addCallback/addErrback/addBoth |
|---|
| 125 | now accept additional arguments that are used to create a partially |
|---|
| 126 | applied function. This differs from Twisted in that the callback/errback |
|---|
| 127 | result becomes the <em>last</em> argument, not the first when this feature |
|---|
| 128 | is used.</li> |
|---|
| 129 | <li>MochiKit.Async's doSimpleXMLHttpRequest will now accept additional |
|---|
| 130 | arguments which are used to create a GET query string</li> |
|---|
| 131 | <li>Did some refactoring to reduce the footprint of MochiKit by a few |
|---|
| 132 | kilobytes</li> |
|---|
| 133 | <li>escapeHTML to longer escapes ' (apos) and now uses |
|---|
| 134 | String.replace instead of iterating over every char.</li> |
|---|
| 135 | <li>Added DeferredLock to Async</li> |
|---|
| 136 | <li>Renamed getElementsComputedStyle to computedStyle and moved |
|---|
| 137 | it from MochiKit.Visual to MochiKit.DOM</li> |
|---|
| 138 | <li>Moved all color support out of MochiKit.Visual and into MochiKit.Color</li> |
|---|
| 139 | <li>Fixed range() to accept a negative step</li> |
|---|
| 140 | <li>New alias to MochiKit.swapDOM called removeElement</li> |
|---|
| 141 | <li>New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets |
|---|
| 142 | an attribute on a node without raising, roughly equivalent to: |
|---|
| 143 | updateNodeAttributes(node, {attr: value})</li> |
|---|
| 144 | <li>New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of |
|---|
| 145 | a node's attribute or returns null without raising</li> |
|---|
| 146 | <li>Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack |
|---|
| 147 | directly (addLoadEvent did not leak, since it clears the handler)</li> |
|---|
| 148 | </ul> |
|---|
| 149 | <p>2005-10-24 v1.0</p> |
|---|
| 150 | <ul class="simple"> |
|---|
| 151 | <li>New interpreter example that shows usage of MochiKit.DOM to make |
|---|
| 152 | an interactive JavaScript interpreter</li> |
|---|
| 153 | <li>New MochiKit.LoggingPane for use with the MochiKit.Logging |
|---|
| 154 | debuggingBookmarklet, with logging_pane example to show its usage</li> |
|---|
| 155 | <li>New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async |
|---|
| 156 | in order to provide a live regular expression matching tool</li> |
|---|
| 157 | <li>Added advanced number formatting capabilities to MochiKit.Format: |
|---|
| 158 | numberFormatter(pattern, placeholder="", locale="default") and |
|---|
| 159 | formatLocale(locale="default")</li> |
|---|
| 160 | <li>Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed |
|---|
| 161 | MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.</li> |
|---|
| 162 | <li>Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE</li> |
|---|
| 163 | <li>Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision) |
|---|
| 164 | to MochiKit.Format</li> |
|---|
| 165 | <li>MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically |
|---|
| 166 | isoTimestamp(isoString) will convert them to Date objects, and |
|---|
| 167 | toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC</li> |
|---|
| 168 | <li>Fixed missing errback for sendXMLHttpRequest when the server does not |
|---|
| 169 | respond</li> |
|---|
| 170 | <li>Fixed infinite recusion bug when using roundClass("DIV", ...)</li> |
|---|
| 171 | <li>Fixed a bug in MochiKit.Async wait (and callLater) that prevented them |
|---|
| 172 | from being cancelled properly</li> |
|---|
| 173 | <li>Workaround in MochiKit.Base bind (and partial) for functions that don't |
|---|
| 174 | have an apply method, such as alert</li> |
|---|
| 175 | <li>Reliably return null from the string parsing/manipulation functions if |
|---|
| 176 | the input can't be coerced to a string (s + "") or the input makes no sense; |
|---|
| 177 | e.g. isoTimestamp(null) and isoTimestamp("") return null</li> |
|---|
| 178 | </ul> |
|---|
| 179 | <p>2005-10-08 v0.90</p> |
|---|
| 180 | <ul class="simple"> |
|---|
| 181 | <li>Fixed ISO compliance with toISODate</li> |
|---|
| 182 | <li>Added missing operator.sub</li> |
|---|
| 183 | <li>Placated Mozilla's strict warnings a bit</li> |
|---|
| 184 | <li>Added JSON serialization and unserialization support to MochiKit.Base: |
|---|
| 185 | serializeJSON, evalJSON, registerJSON. This is very similar to the repr |
|---|
| 186 | API.</li> |
|---|
| 187 | <li>Fixed a bug in the script loader that failed in some scenarios when a script |
|---|
| 188 | tag did not have a "src" attribute (thanks Ian!)</li> |
|---|
| 189 | <li>Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA, |
|---|
| 190 | P, FORM</li> |
|---|
| 191 | <li>Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode |
|---|
| 192 | and parseQueryString, when available.</li> |
|---|
| 193 | </ul> |
|---|
| 194 | <p>2005-08-12 v0.80</p> |
|---|
| 195 | <ul class="simple"> |
|---|
| 196 | <li>Source highlighting in all examples, moved to a view-source example</li> |
|---|
| 197 | <li>Added some experimental syntax highlighting for the Rounded Corners example, |
|---|
| 198 | via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib</li> |
|---|
| 199 | <li>Use an indirect binding for the logger conveniences, so that the global |
|---|
| 200 | logger could be replaced by setting MochiKit.Logger.logger to something else |
|---|
| 201 | (though an observer is probably a better choice).</li> |
|---|
| 202 | <li>Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent, |
|---|
| 203 | which will be looked up with getElement</li> |
|---|
| 204 | <li>Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of |
|---|
| 205 | node.parentNode)</li> |
|---|
| 206 | <li>Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success</li> |
|---|
| 207 | <li>Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues</li> |
|---|
| 208 | <li>Possible workaround for Safari issue with swapDOM, where it would get |
|---|
| 209 | confused because two elements were in the DOM at the same time with the |
|---|
| 210 | same id</li> |
|---|
| 211 | <li>Added missing THEAD convenience function to MochiKit.DOM</li> |
|---|
| 212 | <li>Added lstrip, rstrip, strip to MochiKit.Format</li> |
|---|
| 213 | <li>Added updateNodeAttributes, appendChildNodes, replaceChildNodes to |
|---|
| 214 | MochiKit.DOM</li> |
|---|
| 215 | <li>MochiKit.Iter.iextend now has a fast-path for array-like objects</li> |
|---|
| 216 | <li>Added HSV color space support to MochiKit.Visual</li> |
|---|
| 217 | <li>Fixed a bug in the sortable_tables example, it now converts types |
|---|
| 218 | correctly</li> |
|---|
| 219 | <li>Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global |
|---|
| 220 | scope</li> |
|---|
| 221 | </ul> |
|---|
| 222 | <p>2005-08-04 v0.70</p> |
|---|
| 223 | <ul class="simple"> |
|---|
| 224 | <li>New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and |
|---|
| 225 | a little TAL-ish DOM templating attribute language.</li> |
|---|
| 226 | <li>sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer |
|---|
| 227 | ignore requests with status == 0, which seems to happen for cached or local |
|---|
| 228 | requests</li> |
|---|
| 229 | <li>Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.</li> |
|---|
| 230 | <li>Changed scrapeText API to return a string by default. This is API-breaking! |
|---|
| 231 | It was dumb to have the default return value be the form you almost never |
|---|
| 232 | want. Sorry.</li> |
|---|
| 233 | <li>Added special form to swapDOM(dest, src). If src is null, dest is removed |
|---|
| 234 | (where previously you'd likely get a DOM exception).</li> |
|---|
| 235 | <li>Added three new functions to MochiKit.Base for dealing with URL query |
|---|
| 236 | strings: urlEncode, queryString, parseQueryString</li> |
|---|
| 237 | <li>MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name |
|---|
| 238 | starts with "on" (e.g. "onclick"). If v is a string, it will set it to |
|---|
| 239 | new Function(v).</li> |
|---|
| 240 | <li>Another workaround for Internet "worst browser ever" Explorer's setAttribute |
|---|
| 241 | usage in MochiKit.DOM.createDOM (checked -> defaultChecked).</li> |
|---|
| 242 | <li>Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM</li> |
|---|
| 243 | <li>Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller |
|---|
| 244 | now!</li> |
|---|
| 245 | </ul> |
|---|
| 246 | <p>2005-07-29 v0.60</p> |
|---|
| 247 | <ul class="simple"> |
|---|
| 248 | <li>Beefed up the MochiKit.DOM test suite</li> |
|---|
| 249 | <li>Fixed return value for MochiKit.DOM.swapElementClass, could return |
|---|
| 250 | false unexpectedly before</li> |
|---|
| 251 | <li>Added an optional "parent" argument to |
|---|
| 252 | MochiKit.DOM.getElementsByTagAndClassName</li> |
|---|
| 253 | <li>Added a "packed" version in packed/MochiKit/MochiKit.js</li> |
|---|
| 254 | <li>Changed build script to rewrite the URLs in tests to account for the |
|---|
| 255 | JSAN-required reorganization</li> |
|---|
| 256 | <li>MochiKit.Compat to potentially work around IE 5.5 issues |
|---|
| 257 | (5.0 still not supported). Test.Simple doesn't seem to work there, |
|---|
| 258 | though.</li> |
|---|
| 259 | <li>Several minor documentation corrections</li> |
|---|
| 260 | </ul> |
|---|
| 261 | <p>2005-07-27 v0.50</p> |
|---|
| 262 | <ul class="simple"> |
|---|
| 263 | <li>Initial Release</li> |
|---|
| 264 | </ul> |
|---|
| 265 | </div> |
|---|
| 266 | <div class="section"> |
|---|
| 267 | <h1><a id="copyright" name="copyright">Copyright</a></h1> |
|---|
| 268 | <p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed |
|---|
| 269 | free software; you can redistribute it and/or modify it under the terms of the |
|---|
| 270 | <a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p> |
|---|
| 271 | </div> |
|---|
| 272 | </div> |
|---|
| 273 | |
|---|
| 274 | </body> |
|---|
| 275 | </html> |
|---|