Compare commits
2 Commits
XMLTO_Docu
...
v1
| Author | SHA1 | Date | |
|---|---|---|---|
|
5ddee5efc0 | ||
|
|
f46176d6f2 |
@@ -1,135 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
|
||||
]>
|
||||
|
||||
|
||||
<!-- Coding standards for this document
|
||||
|
||||
* Other than the GFDL, please use the "section" tag instead of "sect1",
|
||||
"sect2", etc.
|
||||
* Use Entities to include files for new chapters in Bugzilla-Guide.xml.
|
||||
* Try to use Entities for frequently-used passages of text as well.
|
||||
* Ensure all documents compile cleanly to HTML after modification.
|
||||
The warning, "DTDDECL catalog types not supported" is normal.
|
||||
* Try to index important terms wherever possible.
|
||||
* Use "glossterm" whenever you introduce a new term.
|
||||
* Follow coding standards at http://www.tldp.org, and
|
||||
check out the KDE guidelines (they are nice, too)
|
||||
http://i18n.kde.org/doc/markup.html
|
||||
* All tags should be lowercase.
|
||||
* Please use sensible spacing. The comments at the very end of each
|
||||
file define reasonable defaults for PSGML mode in EMACS.
|
||||
* Double-indent tags, use double spacing whenever possible, and
|
||||
try to avoid clutter and feel free to waste space in the code to make it
|
||||
more readable.
|
||||
|
||||
-->
|
||||
|
||||
<book id="index">
|
||||
|
||||
<!-- Header -->
|
||||
|
||||
<bookinfo>
|
||||
<title>The Bugzilla Guide - &bz-ver;
|
||||
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
|
||||
Release</title>
|
||||
|
||||
<authorgroup>
|
||||
<corpauthor>The Bugzilla Team</corpauthor>
|
||||
</authorgroup>
|
||||
|
||||
<pubdate>&bz-date;</pubdate>
|
||||
|
||||
<abstract>
|
||||
<para>
|
||||
This is the documentation for Bugzilla, a
|
||||
bug-tracking system from mozilla.org.
|
||||
Bugzilla is an enterprise-class piece of software
|
||||
that tracks millions of bugs and issues for hundreds of
|
||||
organizations around the world.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The most current version of this document can always be found on the
|
||||
<ulink url="http://www.bugzilla.org/docs/">Bugzilla
|
||||
Documentation Page</ulink>.
|
||||
</para>
|
||||
|
||||
</abstract>
|
||||
|
||||
<keywordset>
|
||||
<keyword>Bugzilla</keyword>
|
||||
<keyword>Guide</keyword>
|
||||
<keyword>installation</keyword>
|
||||
<keyword>FAQ</keyword>
|
||||
<keyword>administration</keyword>
|
||||
<keyword>integration</keyword>
|
||||
<keyword>MySQL</keyword>
|
||||
<keyword>Mozilla</keyword>
|
||||
<keyword>webtools</keyword>
|
||||
</keywordset>
|
||||
</bookinfo>
|
||||
|
||||
<!-- About This Guide -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="about.xml" />
|
||||
|
||||
<!-- Installing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="installation.xml" />
|
||||
|
||||
<!-- Administering Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="administration.xml" />
|
||||
|
||||
<!-- Securing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml" />
|
||||
|
||||
<!-- Customizing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="customization.xml" />
|
||||
|
||||
<!-- Using Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using.xml" />
|
||||
|
||||
<!-- Appendix: Troubleshooting -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
|
||||
|
||||
<!-- Appendix: Custom Patches -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="patches.xml" />
|
||||
|
||||
<!-- Appendix: Manually Installing Perl Modules -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules.xml" />
|
||||
|
||||
<!-- Appendix: GNU Free Documentation License -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gfdl.xml" />
|
||||
|
||||
<!-- Glossary -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml" />
|
||||
|
||||
<!-- Index -->
|
||||
<!--xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="index.xml" /-->
|
||||
|
||||
</book>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,246 +0,0 @@
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: about.xml,v 1.26.4.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<chapter id="about">
|
||||
<title>About This Guide</title>
|
||||
|
||||
<section id="copyright">
|
||||
<title>Copyright Information</title>
|
||||
|
||||
<para>This document is copyright (c) 2000-¤t-year; by the various
|
||||
Bugzilla contributors who wrote it.</para>
|
||||
|
||||
<blockquote>
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation
|
||||
License, Version 1.1 or any later version published by the
|
||||
Free Software Foundation; with no Invariant Sections, no
|
||||
Front-Cover Texts, and with no Back-Cover Texts. A copy of
|
||||
the license is included in <xref linkend="gfdl"/>.
|
||||
</para>
|
||||
</blockquote>
|
||||
<para>
|
||||
If you have any questions regarding this document, its
|
||||
copyright, or publishing this document in non-electronic form,
|
||||
please contact the Bugzilla Team.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="disclaimer">
|
||||
<title>Disclaimer</title>
|
||||
<para>
|
||||
No liability for the contents of this document can be accepted.
|
||||
Follow the instructions herein at your own risk.
|
||||
This document may contain errors
|
||||
and inaccuracies that may damage your system, cause your partner
|
||||
to leave you, your boss to fire you, your cats to
|
||||
pee on your furniture and clothing, and global thermonuclear
|
||||
war. Proceed with caution.
|
||||
</para>
|
||||
<para>
|
||||
Naming of particular products or brands should not be seen as
|
||||
endorsements, with the exception of the term "GNU/Linux". We
|
||||
wholeheartedly endorse the use of GNU/Linux; it is an extremely
|
||||
versatile, stable,
|
||||
and robust operating system that offers an ideal operating
|
||||
environment for Bugzilla.
|
||||
</para>
|
||||
<para>
|
||||
Although the Bugzilla development team has taken great care to
|
||||
ensure that all exploitable bugs have been fixed, security holes surely
|
||||
exist in any piece of code. Great care should be taken both in
|
||||
the installation and usage of this software. The Bugzilla development
|
||||
team members assume no liability for your use of Bugzilla. You have
|
||||
the source code, and are responsible for auditing it yourself to ensure
|
||||
your security needs are met.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- Section 2: New Versions -->
|
||||
|
||||
<section id="newversions">
|
||||
<title>New Versions</title>
|
||||
<para>
|
||||
This is the &bz-ver; version of The Bugzilla Guide. It is so named
|
||||
to match the current version of Bugzilla.
|
||||
<!-- BZ-DEVEL --> This version of the guide, like its associated Bugzilla version, is a
|
||||
development version.<!-- /BZ-DEVEL -->
|
||||
</para>
|
||||
<para>
|
||||
The latest version of this guide can always be found at <ulink
|
||||
url="http://www.bugzilla.org"/>, or checked out via CVS by
|
||||
following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
|
||||
CVS</ulink> instructions and check out the
|
||||
<filename>mozilla/webtools/bugzilla/docs/</filename>
|
||||
subtree. However, you should read the version
|
||||
which came with the Bugzilla release you are using.
|
||||
</para>
|
||||
<para>
|
||||
The Bugzilla Guide, or a section of it, is also available in
|
||||
the following languages:
|
||||
<ulink url="http://www.traduc.org/docs/guides/lecture/bugzilla/">French</ulink>,
|
||||
<ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>,
|
||||
<ulink url="http://www.bugzilla.jp/docs/2.18/">Japanese</ulink>.
|
||||
Note that these may be outdated or not up to date.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In addition, there are Bugzilla template localization projects in
|
||||
the following languages. They may have translated documentation
|
||||
available:
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-ar/">Arabic</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
|
||||
<ulink url="http://openfmi.net/projects/mozilla-bg/">Bulgarian</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
|
||||
<ulink url="http://germzilla.ganderbay.net/">German</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-it/">Italian</ulink>,
|
||||
<ulink url="http://www.bugzilla.jp/about/jp.html">Japanese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you would like to volunteer to translate the Guide into additional
|
||||
languages, please contact
|
||||
<ulink url="mailto:justdave@bugzilla.org">Dave Miller</ulink>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="credits">
|
||||
<title>Credits</title>
|
||||
<para>
|
||||
The people listed below have made enormous contributions to the
|
||||
creation of this Guide, through their writing, dedicated hacking efforts,
|
||||
numerous e-mail and IRC support sessions, and overall excellent
|
||||
contribution to the Bugzilla community:
|
||||
</para>
|
||||
|
||||
<!-- TODO: This is evil... there has to be a valid way to get this look -->
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
|
||||
<listitem>
|
||||
<para>for the Herculean task of pulling together the Bugzilla Guide
|
||||
and shepherding it to 2.14.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Terry Weissman <email>terry@mozilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for initially writing Bugzilla and creating the README upon
|
||||
which the UNIX installation documentation is largely based.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
|
||||
<listitem>
|
||||
<para>for keeping Bugzilla development going strong after Terry left
|
||||
mozilla.org and for running landfill.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
|
||||
<listitem>
|
||||
<para>for providing insight into the key differences between Red
|
||||
Hat's customized Bugzilla.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dawn Endico <email>endico@mozilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for being a hacker extraordinaire and putting up with Matthew's
|
||||
incessant questions and arguments on irc.mozilla.org in #mozwebtools
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for taking over documentation during the 2.17 development
|
||||
period.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dave Miller <email>justdave@bugzilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for taking over as project lead when Tara stepped down and
|
||||
continually pushing for the documentation to be the best it can be.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
|
||||
<para>
|
||||
Thanks also go to the following people for significant contributions
|
||||
to this documentation:
|
||||
<simplelist type="inline">
|
||||
<member>Kevin Brannen</member>
|
||||
<member>Vlad Dascalu</member>
|
||||
<member>Ben FrantzDale</member>
|
||||
<member>Eric Hanson</member>
|
||||
<member>Zach Lipton</member>
|
||||
<member>Gervase Markham</member>
|
||||
<member>Andrew Pearson</member>
|
||||
<member>Joe Robins</member>
|
||||
<member>Spencer Smith</member>
|
||||
<member>Ron Teitelbaum</member>
|
||||
<member>Shane Travis</member>
|
||||
<member>Martin Wulffeld</member>
|
||||
</simplelist>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Also, thanks are due to the members of the
|
||||
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">
|
||||
mozilla.support.bugzilla</ulink>
|
||||
newsgroup (and its predecessor, netscape.public.mozilla.webtools).
|
||||
Without your discussions, insight, suggestions, and patches,
|
||||
this could never have happened.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- conventions used here (didn't want to give it a chapter of its own) -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conventions.xml" />
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,168 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<section id="conventions">
|
||||
<title>Document Conventions</title>
|
||||
|
||||
<indexterm zone="conventions">
|
||||
<primary>conventions</primary>
|
||||
</indexterm>
|
||||
|
||||
<para>This document uses the following conventions:</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Descriptions</entry>
|
||||
|
||||
<entry>Appearance</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Caution</entry>
|
||||
|
||||
<entry>
|
||||
<caution>
|
||||
<para>Don't run with scissors!</para>
|
||||
</caution>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Hint or Tip</entry>
|
||||
|
||||
<entry>
|
||||
<tip>
|
||||
<para>For best results... </para>
|
||||
</tip>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Note</entry>
|
||||
|
||||
<entry>
|
||||
<note>
|
||||
<para>Dear John...</para>
|
||||
</note>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Warning</entry>
|
||||
|
||||
<entry>
|
||||
<warning>
|
||||
<para>Read this or the cat gets it.</para>
|
||||
</warning>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>File or directory name</entry>
|
||||
|
||||
<entry>
|
||||
<filename>filename</filename>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Command to be typed</entry>
|
||||
|
||||
<entry>
|
||||
<command>command</command>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Application name</entry>
|
||||
|
||||
<entry>
|
||||
<application>application</application>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Normal user's prompt under bash shell</entry>
|
||||
|
||||
<entry>bash$</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Root user's prompt under bash shell</entry>
|
||||
|
||||
<entry>bash#</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Normal user's prompt under tcsh shell</entry>
|
||||
|
||||
<entry>tcsh$</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Environment variables</entry>
|
||||
|
||||
<entry>
|
||||
<envar>VARIABLE</envar>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Term found in the glossary</entry>
|
||||
|
||||
<entry>
|
||||
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Code example</entry>
|
||||
|
||||
<entry>
|
||||
<programlisting><sgmltag class="starttag">para</sgmltag>
|
||||
Beginning and end of paragraph
|
||||
<sgmltag class="endtag">para</sgmltag></programlisting>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para>
|
||||
This documentation is maintained in DocBook 4.1.2 XML format.
|
||||
Changes are best submitted as plain text or XML diffs, attached
|
||||
to a bug filed in the &bzg-bugs; component.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,821 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<chapter id="customization">
|
||||
<title>Customizing Bugzilla</title>
|
||||
|
||||
<section id="cust-skins">
|
||||
<title>Custom Skins</title>
|
||||
|
||||
<para>
|
||||
Bugzilla allows you to have multiple skins. These are custom CSS and possibly
|
||||
also custom images for Bugzilla. To create a new custom skin, you have two
|
||||
choices:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Make a single CSS file, and put it in the
|
||||
<filename>skins/contrib</filename> directory.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Make a directory that contains all the same CSS file
|
||||
names as <filename>skins/standard/</filename>, and put
|
||||
your directory in <filename>skins/contrib/</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
After you put the file or the directory there, make sure to run checksetup.pl
|
||||
so that it can reset the file permissions correctly.
|
||||
</para>
|
||||
<para>
|
||||
After you have installed the new skin, it will show up as an option in the
|
||||
user's General Preferences. If you would like to force a particular skin on all
|
||||
users, just select it in the Default Preferences and then uncheck "Enabled" on
|
||||
the preference.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="cust-templates">
|
||||
<title>Template Customization</title>
|
||||
|
||||
<para>
|
||||
Administrators can configure the look and feel of Bugzilla without
|
||||
having to edit Perl files or face the nightmare of massive merge
|
||||
conflicts when they upgrade to a newer version in the future.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Templatization also makes localized versions of Bugzilla possible,
|
||||
for the first time. It's possible to have Bugzilla's UI language
|
||||
determined by the user's browser. More information is available in
|
||||
<xref linkend="template-http-accept"/>.
|
||||
</para>
|
||||
|
||||
<section id="template-directory">
|
||||
<title>Template Directory Structure</title>
|
||||
<para>
|
||||
The template directory structure starts with top level directory
|
||||
named <filename>template</filename>, which contains a directory
|
||||
for each installed localization. The next level defines the
|
||||
language used in the templates. Bugzilla comes with English
|
||||
templates, so the directory name is <filename>en</filename>,
|
||||
and we will discuss <filename>template/en</filename> throughout
|
||||
the documentation. Below <filename>template/en</filename> is the
|
||||
<filename>default</filename> directory, which contains all the
|
||||
standard templates shipped with Bugzilla.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
A directory <filename>data/templates</filename> also exists;
|
||||
this is where Template Toolkit puts the compiled versions of
|
||||
the templates from either the default or custom directories.
|
||||
<emphasis>Do not</emphasis> directly edit the files in this
|
||||
directory, or all your changes will be lost the next time
|
||||
Template Toolkit recompiles the templates.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
|
||||
<section id="template-method">
|
||||
<title>Choosing a Customization Method</title>
|
||||
<para>
|
||||
If you want to edit Bugzilla's templates, the first decision
|
||||
you must make is how you want to go about doing so. There are two
|
||||
choices, and which you use depends mainly on the scope of your
|
||||
modifications, and the method you plan to use to upgrade Bugzilla.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The first method of making customizations is to directly edit the
|
||||
templates found in <filename>template/en/default</filename>.
|
||||
This is probably the best way to go about it if you are going to
|
||||
be upgrading Bugzilla through CVS, because if you then execute
|
||||
a <command>cvs update</command>, any changes you have made will
|
||||
be merged automagically with the updated versions.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
If you use this method, and CVS conflicts occur during an
|
||||
update, the conflicted templates (and possibly other parts
|
||||
of your installation) will not work until they are resolved.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The second method is to copy the templates to be modified
|
||||
into a mirrored directory structure under
|
||||
<filename>template/en/custom</filename>. Templates in this
|
||||
directory structure automatically override any identically-named
|
||||
and identically-located templates in the
|
||||
<filename>default</filename> directory.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
The <filename>custom</filename> directory does not exist
|
||||
at first and must be created if you want to use it.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The second method of customization should be used if you
|
||||
use the overwriting method of upgrade, because otherwise
|
||||
your changes will be lost. This method may also be better if
|
||||
you are using the CVS method of upgrading and are going to make major
|
||||
changes, because it is guaranteed that the contents of this directory
|
||||
will not be touched during an upgrade, and you can then decide whether
|
||||
to continue using your own templates, or make the effort to merge your
|
||||
changes into the new versions by hand.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Using this method, your installation may break if incompatible
|
||||
changes are made to the template interface. Such changes should
|
||||
be documented in the release notes, provided you are using a
|
||||
stable release of Bugzilla. If you use using unstable code, you will
|
||||
need to deal with this one yourself, although if possible the changes
|
||||
will be mentioned before they occur in the deprecations section of the
|
||||
previous stable release's release notes.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
Regardless of which method you choose, it is recommended that
|
||||
you run <command>./checksetup.pl</command> after creating or
|
||||
editing any templates in the <filename>template/en/default</filename>
|
||||
directory, and after editing any templates in the
|
||||
<filename>custom</filename> directory.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
It is <emphasis>required</emphasis> that you run
|
||||
<command>./checksetup.pl</command> after creating a new
|
||||
template in the <filename>custom</filename> directory. Failure
|
||||
to do so will raise an incomprehensible error message.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
|
||||
<section id="template-edit">
|
||||
<title>How To Edit Templates</title>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
If you are making template changes that you intend on submitting back
|
||||
for inclusion in standard Bugzilla, you should read the relevant
|
||||
sections of the
|
||||
<ulink url="http://www.bugzilla.org/docs/developer.html">Developers'
|
||||
Guide</ulink>.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The syntax of the Template Toolkit language is beyond the scope of
|
||||
this guide. It's reasonably easy to pick up by looking at the current
|
||||
templates; or, you can read the manual, available on the
|
||||
<ulink url="http://www.template-toolkit.org">Template Toolkit home
|
||||
page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
One thing you should take particular care about is the need
|
||||
to properly HTML filter data that has been passed into the template.
|
||||
This means that if the data can possibly contain special HTML characters
|
||||
such as <, and the data was not intended to be HTML, they need to be
|
||||
converted to entity form, i.e. &lt;. You use the 'html' filter in the
|
||||
Template Toolkit to do this. If you forget, you may open up
|
||||
your installation to cross-site scripting attacks.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Also note that Bugzilla adds a few filters of its own, that are not
|
||||
in standard Template Toolkit. In particular, the 'url_quote' filter
|
||||
can convert characters that are illegal or have special meaning in URLs,
|
||||
such as &, to the encoded form, i.e. %26. This actually encodes most
|
||||
characters (but not the common ones such as letters and numbers and so
|
||||
on), including the HTML-special characters, so there's never a need to
|
||||
HTML filter afterwards.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Editing templates is a good way of doing a <quote>poor man's custom
|
||||
fields</quote>.
|
||||
For example, if you don't use the Status Whiteboard, but want to have
|
||||
a free-form text entry box for <quote>Build Identifier</quote>,
|
||||
then you can just
|
||||
edit the templates to change the field labels. It's still be called
|
||||
status_whiteboard internally, but your users don't need to know that.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-formats">
|
||||
<title>Template Formats and Types</title>
|
||||
|
||||
<para>
|
||||
Some CGI's have the ability to use more than one template. For example,
|
||||
<filename>buglist.cgi</filename> can output itself as RDF, or as two
|
||||
formats of HTML (complex and simple). The mechanism that provides this
|
||||
feature is extensible.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Bugzilla can support different types of output, which again can have
|
||||
multiple formats. In order to request a certain type, you can append
|
||||
the &ctype=<contenttype> (such as rdf or html) to the
|
||||
<filename><cginame>.cgi</filename> URL. If you would like to
|
||||
retrieve a certain format, you can use the &format=<format>
|
||||
(such as simple or complex) in the URL.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To see if a CGI supports multiple output formats and types, grep the
|
||||
CGI for <quote>get_format</quote>. If it's not present, adding
|
||||
multiple format/type support isn't too hard - see how it's done in
|
||||
other CGIs, e.g. config.cgi.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To make a new format template for a CGI which supports this,
|
||||
open a current template for
|
||||
that CGI and take note of the INTERFACE comment (if present.) This
|
||||
comment defines what variables are passed into this template. If
|
||||
there isn't one, I'm afraid you'll have to read the template and
|
||||
the code to find out what information you get.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Write your template in whatever markup or text style is appropriate.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You now need to decide what content type you want your template
|
||||
served as. The content types are defined in the
|
||||
<filename>Bugzilla/Constants.pm</filename> file in the
|
||||
<filename>contenttypes</filename>
|
||||
constant. If your content type is not there, add it. Remember
|
||||
the three- or four-letter tag assigned to your content type.
|
||||
This tag will be part of the template filename.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
After adding or changing a content type, it's suitable to edit
|
||||
<filename>Bugzilla/Constants.pm</filename> in order to reflect
|
||||
the changes. Also, the file should be kept up to date after an
|
||||
upgrade if content types have been customized in the past.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
Save the template as <filename><stubname>-<formatname>.<contenttypetag>.tmpl</filename>.
|
||||
Try out the template by calling the CGI as
|
||||
<filename><cginame>.cgi?format=<formatname>&ctype=<type></filename> .
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-specific">
|
||||
<title>Particular Templates</title>
|
||||
|
||||
<para>
|
||||
There are a few templates you may be particularly interested in
|
||||
customizing for your installation.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>index.html.tmpl</command>:
|
||||
This is the Bugzilla front page.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/header.html.tmpl</command>:
|
||||
This defines the header that goes on all Bugzilla pages.
|
||||
The header includes the banner, which is what appears to users
|
||||
and is probably what you want to edit instead. However the
|
||||
header also includes the HTML HEAD section, so you could for
|
||||
example add a stylesheet or META tag by editing the header.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/banner.html.tmpl</command>:
|
||||
This contains the <quote>banner</quote>, the part of the header
|
||||
that appears
|
||||
at the top of all Bugzilla pages. The default banner is reasonably
|
||||
barren, so you'll probably want to customize this to give your
|
||||
installation a distinctive look and feel. It is recommended you
|
||||
preserve the Bugzilla version number in some form so the version
|
||||
you are running can be determined, and users know what docs to read.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/footer.html.tmpl</command>:
|
||||
This defines the footer that goes on all Bugzilla pages. Editing
|
||||
this is another way to quickly get a distinctive look and feel for
|
||||
your Bugzilla installation.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/variables.none.tmpl</command>:
|
||||
This defines a list of terms that may be changed in order to
|
||||
<quote>brand</quote> the Bugzilla instance In this way, terms
|
||||
like <quote>bugs</quote> can be replaced with <quote>issues</quote>
|
||||
across the whole Bugzilla installation. The name
|
||||
<quote>Bugzilla</quote> and other words can be customized as well.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>list/table.html.tmpl</command>:
|
||||
This template controls the appearance of the bug lists created
|
||||
by Bugzilla. Editing this template allows per-column control of
|
||||
the width and title of a column, the maximum display length of
|
||||
each entry, and the wrap behaviour of long entries.
|
||||
For long bug lists, Bugzilla inserts a 'break' every 100 bugs by
|
||||
default; this behaviour is also controlled by this template, and
|
||||
that value can be modified here.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/create/user-message.html.tmpl</command>:
|
||||
This is a message that appears near the top of the bug reporting page.
|
||||
By modifying this, you can tell your users how they should report
|
||||
bugs.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/process/midair.html.tmpl</command>:
|
||||
This is the page used if two people submit simultaneous changes to the
|
||||
same bug. The second person to submit their changes will get this page
|
||||
to tell them what the first person did, and ask if they wish to
|
||||
overwrite those changes or go back and revisit the bug. The default
|
||||
title and header on this page read "Mid-air collision detected!" If
|
||||
you work in the aviation industry, or other environment where this
|
||||
might be found offensive (yes, we have true stories of this happening)
|
||||
you'll want to change this to something more appropriate for your
|
||||
environment.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/create/create.html.tmpl</command> and
|
||||
<command>bug/create/comment.txt.tmpl</command>:
|
||||
You may not wish to go to the effort of creating custom fields in
|
||||
Bugzilla, yet you want to make sure that each bug report contains
|
||||
a number of pieces of important information for which there is not
|
||||
a special field. The bug entry system has been designed in an
|
||||
extensible fashion to enable you to add arbitrary HTML widgets,
|
||||
such as drop-down lists or textboxes, to the bug entry page
|
||||
and have their values appear formatted in the initial comment.
|
||||
A hidden field that indicates the format should be added inside
|
||||
the form in order to make the template functional. Its value should
|
||||
be the suffix of the template filename. For example, if the file
|
||||
is called <filename>create-cust.html.tmpl</filename>, then
|
||||
<programlisting><input type="hidden" name="format" value="cust"></programlisting>
|
||||
should be used inside the form.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
An example of this is the mozilla.org
|
||||
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl&format=guided">guided
|
||||
bug submission form</ulink>. The code for this comes with the Bugzilla
|
||||
distribution as an example for you to copy. It can be found in the
|
||||
files
|
||||
<filename>create-guided.html.tmpl</filename> and
|
||||
<filename>comment-guided.html.tmpl</filename>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
So to use this feature, create a custom template for
|
||||
<filename>enter_bug.cgi</filename>. The default template, on which you
|
||||
could base it, is
|
||||
<filename>custom/bug/create/create.html.tmpl</filename>.
|
||||
Call it <filename>create-<formatname>.html.tmpl</filename>, and
|
||||
in it, add widgets for each piece of information you'd like
|
||||
collected - such as a build number, or set of steps to reproduce.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Then, create a template like
|
||||
<filename>custom/bug/create/comment.txt.tmpl</filename>, and call it
|
||||
<filename>comment-<formatname>.txt.tmpl</filename>. This
|
||||
template should reference the form fields you have created using
|
||||
the syntax <filename>[% form.<fieldname> %]</filename>. When a
|
||||
bug report is
|
||||
submitted, the initial comment attached to the bug report will be
|
||||
formatted according to the layout of this template.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For example, if your custom enter_bug template had a field
|
||||
<programlisting><input type="text" name="buildid" size="30"></programlisting>
|
||||
and then your comment.txt.tmpl had
|
||||
<programlisting>BuildID: [% form.buildid %]</programlisting>
|
||||
then something like
|
||||
<programlisting>BuildID: 20020303</programlisting>
|
||||
would appear in the initial comment.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-http-accept">
|
||||
<title>Configuring Bugzilla to Detect the User's Language</title>
|
||||
|
||||
<para>Bugzilla honours the user's Accept: HTTP header. You can install
|
||||
templates in other languages, and Bugzilla will pick the most appropriate
|
||||
according to a priority order defined by you. Many
|
||||
language templates can be obtained from <ulink
|
||||
url="http://www.bugzilla.org/download.html#localizations"/>. Instructions
|
||||
for submitting new languages are also available from that location.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="cust-hooks">
|
||||
<title>The Bugzilla Extension Mechanism</title>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
Note that the below paths are inconsistent and confusing. They will
|
||||
likely be changed in Bugzilla 4.0.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
Extensions are a way for extensions to Bugzilla to insert code
|
||||
into the standard Bugzilla templates and source files
|
||||
without modifying these files themselves. The extension mechanism
|
||||
defines a consistent API for extending the standard templates and source files
|
||||
in a way that cleanly separates standard code from extension code.
|
||||
Hooks reduce merge conflicts and make it easier to write extensions that work
|
||||
across multiple versions of Bugzilla, making upgrading a Bugzilla installation
|
||||
with installed extensions easier. Furthermore, they make it easy to install
|
||||
and remove extensions as each extension is nothing more than a
|
||||
simple directory structure.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There are two main types of hooks: code hooks and template hooks. Code
|
||||
hooks allow extensions to invoke code at specific points in various
|
||||
source files, while template hooks allow extensions to add elements to
|
||||
the Bugzilla user interface.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A hook is just a named place in a standard source or template file
|
||||
where extension source code or template files for that hook get processed.
|
||||
Each extension has a corresponding directory in the Bugzilla directory
|
||||
tree (<filename>BUGZILLA_ROOT/extensions/extension_name</filename>). Hooking
|
||||
an extension source file or template to a hook is as simple as putting
|
||||
the extension file into extension's template or code directory.
|
||||
When Bugzilla processes the source file or template and reaches the hook,
|
||||
it will process all extension files in the hook's directory.
|
||||
The hooks themselves can be added into any source file or standard template
|
||||
upon request by extension authors.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To use hooks to extend Bugzilla, first make sure there is
|
||||
a hook at the appropriate place within the source file or template you
|
||||
want to extend. The exact appearance of a hook depends on if the hook
|
||||
is a code hook or a template hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Code hooks appear in Bugzilla source files as a single method call
|
||||
in the format <literal role="code">Bugzilla::Hook->process("<varname>name</varname>");</literal>.
|
||||
For instance, <filename>enter_bug.cgi</filename> may invoke the hook
|
||||
"<varname>enter_bug-entrydefaultvars</varname>". Thus, a source file at
|
||||
<filename>BUGZILLA_ROOT/extensions/EXTENSION_NAME/code/enter_bug-entrydefaultvars.pl</filename>
|
||||
will be automatically invoked when the code hook is reached.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template hooks appear in the standard Bugzilla templates as a
|
||||
single directive in the format
|
||||
<literal role="code">[% Hook.process("<varname>name</varname>") %]</literal>,
|
||||
where <varname>name</varname> is the unique name of the hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you aren't sure what you want to extend or just want to browse the
|
||||
available hooks, either use your favorite multi-file search
|
||||
tool (e.g. <command>grep</command>) to search the standard templates
|
||||
for occurrences of <methodname>Hook.process</methodname> or the source
|
||||
files for occurrences of <methodname>Bugzilla::Hook::process</methodname>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If there is no hook at the appropriate place within the Bugzilla
|
||||
source file or template you want to extend,
|
||||
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=User%20Interface">file
|
||||
a bug requesting one</ulink>, specifying:
|
||||
</para>
|
||||
|
||||
<simplelist>
|
||||
<member>the source or template file for which you are
|
||||
requesting a hook;</member>
|
||||
<member>
|
||||
where in the file you would like the hook to be placed
|
||||
(line number/position for latest version of the file in CVS
|
||||
or description of location);
|
||||
</member>
|
||||
<member>the purpose of the hook;</member>
|
||||
<member>a link to information about your extension, if any.</member>
|
||||
</simplelist>
|
||||
|
||||
<para>
|
||||
The Bugzilla reviewers will promptly review each hook request,
|
||||
name the hook, add it to the template or source file, and check
|
||||
the new version of the template into CVS.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may optionally attach a patch to the bug which implements the hook
|
||||
and check it in yourself after receiving approval from a Bugzilla
|
||||
reviewer. The developers may suggest changes to the location of the
|
||||
hook based on their analysis of your needs or so the hook can satisfy
|
||||
the needs of multiple extensions, but the process of getting hooks
|
||||
approved and checked in is not as stringent as the process for general
|
||||
changes to Bugzilla, and any extension, whether released or still in
|
||||
development, can have hooks added to meet their needs.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
After making sure the hook you need exists (or getting it added if not),
|
||||
add your extension to the directory within the Bugzilla
|
||||
extensions tree corresponding to the hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
That's it! Now, when the source file or template containing the hook
|
||||
is processed, your extension file will be processed at the point
|
||||
where the hook appears.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For example, let's say you have an extension named Projman that adds
|
||||
project management capabilities to Bugzilla. Projman has an
|
||||
administration interface <filename>edit-projects.cgi</filename>,
|
||||
and you want to add a link to it into the navigation bar at the bottom
|
||||
of every Bugzilla page for those users who are authorized
|
||||
to administer projects.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The navigation bar is generated by the template file
|
||||
<filename>useful-links.html.tmpl</filename>, which is located in
|
||||
the <filename>global/</filename> subdirectory on the standard Bugzilla
|
||||
template path
|
||||
<filename>BUGZILLA_ROOT/template/en/default/</filename>.
|
||||
Looking in <filename>useful-links.html.tmpl</filename>, you find
|
||||
the following hook at the end of the list of standard Bugzilla
|
||||
administration links:
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[...
|
||||
[% ', <a href="editkeywords.cgi">keywords</a>'
|
||||
IF user.groups.editkeywords %]
|
||||
[% Hook.process("edit") %]
|
||||
...]]></programlisting>
|
||||
|
||||
<para>
|
||||
The corresponding extension file for this hook is
|
||||
<filename>BUGZILLA_ROOT/extensions/projman/template/en/global/useful-links-edit.html.tmpl</filename>.
|
||||
You then create that template file and add the following constant:
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %]]]></programlisting>
|
||||
|
||||
<para>
|
||||
Voila! The link now appears after the other administration links in the
|
||||
navigation bar for users in the <literal>projman_admins</literal> group.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Now, let us say your extension adds a custom "project_manager" field
|
||||
to enter_bug.cgi. You want to modify the CGI script to set the default
|
||||
project manager to be productname@company.com. Looking at
|
||||
<filename>enter_bug.cgi</filename>, you see the enter_bug-entrydefaultvars
|
||||
hook near the bottom of the file before the default form values are set.
|
||||
The corresponding extension source file for this hook is located at
|
||||
<filename>BUGZILLA_ROOT/extensions/projman/code/enter_bug-entrydefaultvars.pl</filename>.
|
||||
You then create that file and add the following:
|
||||
</para>
|
||||
|
||||
<programlisting>$default{'project_manager'} = $product.'@company.com';</programlisting>
|
||||
|
||||
<para>
|
||||
This code will be invoked whenever enter_bug.cgi is executed.
|
||||
Assuming that the rest of the customization was completed (e.g. the
|
||||
custom field was added to the enter_bug template and the required hooks
|
||||
were used in process_bug.cgi), the new field will now have this
|
||||
default value.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Notes:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If your extension includes entirely new templates in addition to
|
||||
extensions of standard templates, it should store those new
|
||||
templates in its
|
||||
<filename>BUGZILLA_ROOT/extensions/template/en/</filename>
|
||||
directory. Extension template directories, like the
|
||||
<filename>default/</filename> and <filename>custom/</filename>
|
||||
directories, are part of the template search path, so putting templates
|
||||
there enables them to be found by the template processor.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The template processor looks for templates first in the
|
||||
<filename>custom/</filename> directory (i.e. templates added by the
|
||||
specific installation), then in the <filename>extensions/</filename>
|
||||
directory (i.e. templates added by extensions), and finally in the
|
||||
<filename>default/</filename> directory (i.e. the standard Bugzilla
|
||||
templates). Thus, installation-specific templates override both
|
||||
default and extension templates.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
If you are looking to customize Bugzilla, you can also take advantage
|
||||
of template hooks. To do so, create a directory in
|
||||
<filename>BUGZILLA_ROOT/template/en/custom/hook/</filename>
|
||||
that corresponds to the hook you wish to use, then place your
|
||||
customization templates into those directories. For example,
|
||||
if you wanted to use the hook "end" in
|
||||
<filename>global/useful-links.html.tmpl</filename>, you would
|
||||
create the directory <filename>BUGZILLA_ROOT/template/en/custom/hook/
|
||||
global/useful-links.html.tmpl/end/</filename> and add your customization
|
||||
template to this directory.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Obviously this method of customizing Bugzilla only lets you add code
|
||||
to the standard source files and templates; you cannot change the
|
||||
existing code. Nevertheless, for those customizations that only add
|
||||
code, this method can reduce conflicts when merging changes,
|
||||
making upgrading your customized Bugzilla installation easier.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
|
||||
<section id="cust-change-permissions">
|
||||
<title>Customizing Who Can Change What</title>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
This feature should be considered experimental; the Bugzilla code you
|
||||
will be changing is not stable, and could change or move between
|
||||
versions. Be aware that if you make modifications as outlined here,
|
||||
you may have
|
||||
to re-make them or port them if Bugzilla changes internally between
|
||||
versions, and you upgrade.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
Companies often have rules about which employees, or classes of employees,
|
||||
are allowed to change certain things in the bug system. For example,
|
||||
only the bug's designated QA Contact may be allowed to VERIFY the bug.
|
||||
Bugzilla has been
|
||||
designed to make it easy for you to write your own custom rules to define
|
||||
who is allowed to make what sorts of value transition.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
By default, assignees, QA owners and users
|
||||
with <emphasis>editbugs</emphasis> privileges can edit all fields of bugs,
|
||||
except group restrictions (unless they are members of the groups they
|
||||
are trying to change). Bug reporters also have the ability to edit some
|
||||
fields, but in a more restrictive manner. Other users, without
|
||||
<emphasis>editbugs</emphasis> privileges, can not edit
|
||||
bugs, except to comment and add themselves to the CC list.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For maximum flexibility, customizing this means editing Bugzilla's Perl
|
||||
code. This gives the administrator complete control over exactly who is
|
||||
allowed to do what. The relevant method is called
|
||||
<filename>check_can_change_field()</filename>,
|
||||
and is found in <filename>Bug.pm</filename> in your
|
||||
Bugzilla/ directory. If you open that file and search for
|
||||
<quote>sub check_can_change_field</quote>, you'll find it.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This function has been carefully commented to allow you to see exactly
|
||||
how it works, and give you an idea of how to make changes to it.
|
||||
Certain marked sections should not be changed - these are
|
||||
the <quote>plumbing</quote> which makes the rest of the function work.
|
||||
In between those sections, you'll find snippets of code like:
|
||||
<programlisting> # Allow the assignee to change anything.
|
||||
if ($ownerid eq $whoid) {
|
||||
return 1;
|
||||
}</programlisting>
|
||||
It's fairly obvious what this piece of code does.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
So, how does one go about changing this function? Well, simple changes
|
||||
can be made just by removing pieces - for example, if you wanted to
|
||||
prevent any user adding a comment to a bug, just remove the lines marked
|
||||
<quote>Allow anyone to change comments.</quote> If you don't want the
|
||||
Reporter to have any special rights on bugs they have filed, just
|
||||
remove the entire section that deals with the Reporter.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
More complex customizations are not much harder. Basically, you add
|
||||
a check in the right place in the function, i.e. after all the variables
|
||||
you are using have been set up. So, don't look at $ownerid before
|
||||
$ownerid has been obtained from the database. You can either add a
|
||||
positive check, which returns 1 (allow) if certain conditions are true,
|
||||
or a negative check, which returns 0 (deny.) E.g.:
|
||||
<programlisting> if ($field eq "qacontact") {
|
||||
if (Bugzilla->user->groups("quality_assurance")) {
|
||||
return 1;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}</programlisting>
|
||||
This says that only users in the group "quality_assurance" can change
|
||||
the QA Contact field of a bug.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Getting more weird:
|
||||
<programlisting><![CDATA[ if (($field eq "priority") &&
|
||||
(Bugzilla->user->email =~ /.*\@example\.com$/))
|
||||
{
|
||||
if ($oldvalue eq "P1") {
|
||||
return 1;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}]]></programlisting>
|
||||
This says that if the user is trying to change the priority field,
|
||||
and their email address is @example.com, they can only do so if the
|
||||
old value of the field was "P1". Not very useful, but illustrative.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
If you are modifying <filename>process_bug.cgi</filename> in any
|
||||
way, do not change the code that is bounded by DO_NOT_CHANGE blocks.
|
||||
Doing so could compromise security, or cause your installation to
|
||||
stop working entirely.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
For a list of possible field names, look at the bugs table in the
|
||||
database. If you need help writing custom rules for your organization,
|
||||
ask in the newsgroup.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- Integrating Bugzilla with Third-Party Tools -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="integration.xml" />
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,449 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="gfdl">
|
||||
<title>GNU Free Documentation License</title>
|
||||
|
||||
<!-- - GNU Project - Free Software Foundation (FSF) -->
|
||||
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
|
||||
<!-- section>
|
||||
<title>GNU Free Documentation License</title -->
|
||||
<para>Version 1.1, March 2000</para>
|
||||
|
||||
<blockquote>
|
||||
<para>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
|
||||
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and
|
||||
distribute verbatim copies of this license document, but changing it is
|
||||
not allowed.</para>
|
||||
</blockquote>
|
||||
|
||||
<section label="0" id="gfdl-0">
|
||||
<title>Preamble</title>
|
||||
|
||||
<para>The purpose of this License is to make a manual, textbook, or other
|
||||
written document "free" in the sense of freedom: to assure everyone the
|
||||
effective freedom to copy and redistribute it, with or without modifying
|
||||
it, either commercially or noncommercially. Secondarily, this License
|
||||
preserves for the author and publisher a way to get credit for their
|
||||
work, while not being considered responsible for modifications made by
|
||||
others.</para>
|
||||
|
||||
<para>This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft license
|
||||
designed for free software.</para>
|
||||
|
||||
<para>We have designed this License in order to use it for manuals for
|
||||
free software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals; it
|
||||
can be used for any textual work, regardless of subject matter or whether
|
||||
it is published as a printed book. We recommend this License principally
|
||||
for works whose purpose is instruction or reference.</para>
|
||||
</section>
|
||||
|
||||
<section label="1" id="gfdl-1">
|
||||
<title>Applicability and Definition</title>
|
||||
|
||||
<para>This License applies to any manual or other work that contains a
|
||||
notice placed by the copyright holder saying it can be distributed under
|
||||
the terms of this License. The "Document", below, refers to any such
|
||||
manual or work. Any member of the public is a licensee, and is addressed
|
||||
as "you".</para>
|
||||
|
||||
<para>A "Modified Version" of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.</para>
|
||||
|
||||
<para>A "Secondary Section" is a named appendix or a front-matter section
|
||||
of the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall subject
|
||||
(or to related matters) and contains nothing that could fall directly
|
||||
within that overall subject. (For example, if the Document is in part a
|
||||
textbook of mathematics, a Secondary Section may not explain any
|
||||
mathematics.) The relationship could be a matter of historical connection
|
||||
with the subject or with related matters, or of legal, commercial,
|
||||
philosophical, ethical or political position regarding them.</para>
|
||||
|
||||
<para>The "Invariant Sections" are certain Secondary Sections whose
|
||||
titles are designated, as being those of Invariant Sections, in the
|
||||
notice that says that the Document is released under this License.</para>
|
||||
|
||||
<para>The "Cover Texts" are certain short passages of text that are
|
||||
listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says
|
||||
that the Document is released under this License.</para>
|
||||
|
||||
<para>A "Transparent" copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the general
|
||||
public, whose contents can be viewed and edited directly and
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or for
|
||||
automatic translation to a variety of formats suitable for input to text
|
||||
formatters. A copy made in an otherwise Transparent file format whose
|
||||
markup has been designed to thwart or discourage subsequent modification
|
||||
by readers is not Transparent. A copy that is not "Transparent" is called
|
||||
"Opaque".</para>
|
||||
|
||||
<para>Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML or
|
||||
XML using a publicly available DTD, and standard-conforming simple HTML
|
||||
designed for human modification. Opaque formats include PostScript, PDF,
|
||||
proprietary formats that can be read and edited only by proprietary word
|
||||
processors, SGML or XML for which the DTD and/or processing tools are not
|
||||
generally available, and the machine-generated HTML produced by some word
|
||||
processors for output purposes only.</para>
|
||||
|
||||
<para>The "Title Page" means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in formats
|
||||
which do not have any title page as such, "Title Page" means the text
|
||||
near the most prominent appearance of the work's title, preceding the
|
||||
beginning of the body of the text.</para>
|
||||
</section>
|
||||
|
||||
<section label="2" id="gfdl-2">
|
||||
<title>Verbatim Copying</title>
|
||||
|
||||
<para>You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies to
|
||||
the Document are reproduced in all copies, and that you add no other
|
||||
conditions whatsoever to those of this License. You may not use technical
|
||||
measures to obstruct or control the reading or further copying of the
|
||||
copies you make or distribute. However, you may accept compensation in
|
||||
exchange for copies. If you distribute a large enough number of copies
|
||||
you must also follow the conditions in section 3.</para>
|
||||
|
||||
<para>You may also lend copies, under the same conditions stated above,
|
||||
and you may publicly display copies.</para>
|
||||
</section>
|
||||
|
||||
<section label="3" id="gfdl-3">
|
||||
<title>Copying in Quantity</title>
|
||||
|
||||
<para>If you publish printed copies of the Document numbering more than
|
||||
100, and the Document's license notice requires Cover Texts, you must
|
||||
enclose the copies in covers that carry, clearly and legibly, all these
|
||||
Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts
|
||||
on the back cover. Both covers must also clearly and legibly identify you
|
||||
as the publisher of these copies. The front cover must present the full
|
||||
title with all words of the title equally prominent and visible. You may
|
||||
add other material on the covers in addition. Copying with changes
|
||||
limited to the covers, as long as they preserve the title of the Document
|
||||
and satisfy these conditions, can be treated as verbatim copying in other
|
||||
respects.</para>
|
||||
|
||||
<para>If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit reasonably)
|
||||
on the actual cover, and continue the rest onto adjacent pages.</para>
|
||||
|
||||
<para>If you publish or distribute Opaque copies of the Document
|
||||
numbering more than 100, you must either include a machine-readable
|
||||
Transparent copy along with each Opaque copy, or state in or with each
|
||||
Opaque copy a publicly-accessible computer-network location containing a
|
||||
complete Transparent copy of the Document, free of added material, which
|
||||
the general network-using public has access to download anonymously at no
|
||||
charge using public-standard network protocols. If you use the latter
|
||||
option, you must take reasonably prudent steps, when you begin
|
||||
distribution of Opaque copies in quantity, to ensure that this
|
||||
Transparent copy will remain thus accessible at the stated location until
|
||||
at least one year after the last time you distribute an Opaque copy
|
||||
(directly or through your agents or retailers) of that edition to the
|
||||
public.</para>
|
||||
|
||||
<para>It is requested, but not required, that you contact the authors of
|
||||
the Document well before redistributing any large number of copies, to
|
||||
give them a chance to provide you with an updated version of the
|
||||
Document.</para>
|
||||
</section>
|
||||
|
||||
<section label="4" id="gfdl-4">
|
||||
<title>Modifications</title>
|
||||
|
||||
<para>You may copy and distribute a Modified Version of the Document
|
||||
under the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution and
|
||||
modification of the Modified Version to whoever possesses a copy of it.
|
||||
In addition, you must do these things in the Modified Version:</para>
|
||||
|
||||
<orderedlist numeration="upperalpha">
|
||||
<listitem>
|
||||
<para>Use in the Title Page (and on the covers, if any) a title
|
||||
distinct from that of the Document, and from those of previous
|
||||
versions (which should, if there were any, be listed in the History
|
||||
section of the Document). You may use the same title as a previous
|
||||
version if the original publisher of that version gives
|
||||
permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>List on the Title Page, as authors, one or more persons or
|
||||
entities responsible for authorship of the modifications in the
|
||||
Modified Version, together with at least five of the principal
|
||||
authors of the Document (all of its principal authors, if it has less
|
||||
than five).</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve all the copyright notices of the Document.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Include, immediately after the copyright notices, a license
|
||||
notice giving the public permission to use the Modified Version under
|
||||
the terms of this License, in the form shown in the Addendum
|
||||
below.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve in that license notice the full lists of Invariant
|
||||
Sections and required Cover Texts given in the Document's license
|
||||
notice.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Include an unaltered copy of this License.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve the section entitled "History", and its title, and add
|
||||
to it an item stating at least the title, year, new authors, and
|
||||
publisher of the Modified Version as given on the Title Page. If
|
||||
there is no section entitled "History" in the Document, create one
|
||||
stating the title, year, authors, and publisher of the Document as
|
||||
given on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve the network location, if any, given in the Document
|
||||
for public access to a Transparent copy of the Document, and likewise
|
||||
the network locations given in the Document for previous versions it
|
||||
was based on. These may be placed in the "History" section. You may
|
||||
omit a network location for a work that was published at least four
|
||||
years before the Document itself, or if the original publisher of the
|
||||
version it refers to gives permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In any section entitled "Acknowledgements" or "Dedications",
|
||||
preserve the section's title, and preserve in the section all the
|
||||
substance and tone of each of the contributor acknowledgements and/or
|
||||
dedications given therein.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve all the Invariant Sections of the Document, unaltered
|
||||
in their text and in their titles. Section numbers or the equivalent
|
||||
are not considered part of the section titles.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Delete any section entitled "Endorsements". Such a section may
|
||||
not be included in the Modified Version.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Do not retitle any existing section as "Endorsements" or to
|
||||
conflict in title with any Invariant Section.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
|
||||
<para>If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all of
|
||||
these sections as invariant. To do this, add their titles to the list of
|
||||
Invariant Sections in the Modified Version's license notice. These titles
|
||||
must be distinct from any other section titles.</para>
|
||||
|
||||
<para>You may add a section entitled "Endorsements", provided it contains
|
||||
nothing but endorsements of your Modified Version by various parties--for
|
||||
example, statements of peer review or that the text has been approved by
|
||||
an organization as the authoritative definition of a standard.</para>
|
||||
|
||||
<para>You may add a passage of up to five words as a Front-Cover Text,
|
||||
and a passage of up to 25 words as a Back-Cover Text, to the end of the
|
||||
list of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or through
|
||||
arrangements made by) any one entity. If the Document already includes a
|
||||
cover text for the same cover, previously added by you or by arrangement
|
||||
made by the same entity you are acting on behalf of, you may not add
|
||||
another; but you may replace the old one, on explicit permission from the
|
||||
previous publisher that added the old one.</para>
|
||||
|
||||
<para>The author(s) and publisher(s) of the Document do not by this
|
||||
License give permission to use their names for publicity for or to assert
|
||||
or imply endorsement of any Modified Version.</para>
|
||||
</section>
|
||||
|
||||
<section label="5" id="gfdl-5">
|
||||
<title>Combining Documents</title>
|
||||
|
||||
<para>You may combine the Document with other documents released under
|
||||
this License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and list
|
||||
them all as Invariant Sections of your combined work in its license
|
||||
notice.</para>
|
||||
|
||||
<para>The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single copy.
|
||||
If there are multiple Invariant Sections with the same name but different
|
||||
contents, make the title of each such section unique by adding at the end
|
||||
of it, in parentheses, the name of the original author or publisher of
|
||||
that section if known, or else a unique number. Make the same adjustment
|
||||
to the section titles in the list of Invariant Sections in the license
|
||||
notice of the combined work.</para>
|
||||
|
||||
<para>In the combination, you must combine any sections entitled
|
||||
"History" in the various original documents, forming one section entitled
|
||||
"History"; likewise combine any sections entitled "Acknowledgements", and
|
||||
any sections entitled "Dedications". You must delete all sections
|
||||
entitled "Endorsements."</para>
|
||||
</section>
|
||||
|
||||
<section label="6" id="gfdl-6">
|
||||
<title>Collections of Documents</title>
|
||||
|
||||
<para>You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual copies
|
||||
of this License in the various documents with a single copy that is
|
||||
included in the collection, provided that you follow the rules of this
|
||||
License for verbatim copying of each of the documents in all other
|
||||
respects.</para>
|
||||
|
||||
<para>You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert a copy
|
||||
of this License into the extracted document, and follow this License in
|
||||
all other respects regarding verbatim copying of that document.</para>
|
||||
</section>
|
||||
|
||||
<section label="7" id="gfdl-7">
|
||||
<title>Aggregation with Independent Works</title>
|
||||
|
||||
<para>A compilation of the Document or its derivatives with other
|
||||
separate and independent documents or works, in or on a volume of a
|
||||
storage or distribution medium, does not as a whole count as a Modified
|
||||
Version of the Document, provided no compilation copyright is claimed for
|
||||
the compilation. Such a compilation is called an "aggregate", and this
|
||||
License does not apply to the other self-contained works thus compiled
|
||||
with the Document, on account of their being thus compiled, if they are
|
||||
not themselves derivative works of the Document.</para>
|
||||
|
||||
<para>If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one quarter of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on covers
|
||||
that surround only the Document within the aggregate. Otherwise they must
|
||||
appear on covers around the whole aggregate.</para>
|
||||
</section>
|
||||
|
||||
<section label="8" id="gfdl-8">
|
||||
<title>Translation</title>
|
||||
|
||||
<para>Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include translations
|
||||
of some or all Invariant Sections in addition to the original versions of
|
||||
these Invariant Sections. You may include a translation of this License
|
||||
provided that you also include the original English version of this
|
||||
License. In case of a disagreement between the translation and the
|
||||
original English version of this License, the original English version
|
||||
will prevail.</para>
|
||||
</section>
|
||||
|
||||
<section label="9" id="gfdl-9">
|
||||
<title>Termination</title>
|
||||
|
||||
<para>You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided for under this License. Any other attempt to
|
||||
copy, modify, sublicense or distribute the Document is void, and will
|
||||
automatically terminate your rights under this License. However, parties
|
||||
who have received copies, or rights, from you under this License will not
|
||||
have their licenses terminated so long as such parties remain in full
|
||||
compliance.</para>
|
||||
</section>
|
||||
|
||||
<section label="10" id="gfdl-10">
|
||||
<title>Future Revisions of this License</title>
|
||||
|
||||
<para>The Free Software Foundation may publish new, revised versions of
|
||||
the GNU Free Documentation License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns. See
|
||||
<ulink url="http://www.gnu.org/copyleft/"/>.</para>
|
||||
|
||||
<para>Each version of the License is given a distinguishing version
|
||||
number. If the Document specifies that a particular numbered version of
|
||||
this License "or any later version" applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or of
|
||||
any later version that has been published (not as a draft) by the Free
|
||||
Software Foundation. If the Document does not specify a version number of
|
||||
this License, you may choose any version ever published (not as a draft)
|
||||
by the Free Software Foundation.</para>
|
||||
</section>
|
||||
|
||||
<section label="" id="gfdl-howto">
|
||||
<title>How to use this License for your documents</title>
|
||||
|
||||
<para>To use this License in a document you have written, include a copy
|
||||
of the License in the document and put the following copyright and
|
||||
license notices just after the title page:</para>
|
||||
|
||||
<blockquote>
|
||||
<para>Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the GNU Free
|
||||
Documentation License, Version 1.1 or any later version published by
|
||||
the Free Software Foundation; with the Invariant Sections being LIST
|
||||
THEIR TITLES, with the Front-Cover Texts being LIST, and with the
|
||||
Back-Cover Texts being LIST. A copy of the license is included in the
|
||||
section entitled "GNU Free Documentation License".</para>
|
||||
</blockquote>
|
||||
|
||||
<para>If you have no Invariant Sections, write "with no Invariant
|
||||
Sections" instead of saying which ones are invariant. If you have no
|
||||
Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover
|
||||
Texts being LIST"; likewise for Back-Cover Texts.</para>
|
||||
|
||||
<para>If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of free
|
||||
software license, such as the GNU General Public License, to permit their
|
||||
use in free software.</para>
|
||||
</section>
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,555 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<glossary id="glossary">
|
||||
<glossdiv>
|
||||
<title>0-9, high ascii</title>
|
||||
|
||||
<glossentry id="gloss-htaccess">
|
||||
<glossterm>.htaccess</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Apache web server, and other NCSA-compliant web servers,
|
||||
observe the convention of using files in directories called
|
||||
<filename>.htaccess</filename>
|
||||
|
||||
to restrict access to certain files. In Bugzilla, they are used
|
||||
to keep secret files which would otherwise
|
||||
compromise your installation - e.g. the
|
||||
<filename>localconfig</filename>
|
||||
file contains the password to your database.
|
||||
curious.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-a">
|
||||
<title>A</title>
|
||||
|
||||
<glossentry id="gloss-apache">
|
||||
<glossterm>Apache</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>In this context, Apache is the web server most commonly used
|
||||
for serving up Bugzilla
|
||||
pages. Contrary to popular belief, the apache web server has nothing
|
||||
to do with the ancient and noble Native American tribe, but instead
|
||||
derived its name from the fact that it was
|
||||
<quote>a patchy</quote>
|
||||
version of the original
|
||||
<acronym>NCSA</acronym>
|
||||
world-wide-web server.</para>
|
||||
|
||||
<variablelist>
|
||||
<title>Useful Directives when configuring Bugzilla</title>
|
||||
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Tell Apache that it's OK to run CGI scripts.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>These directives are used to tell Apache many things about
|
||||
the directory they apply to. For Bugzilla's purposes, we need
|
||||
them to allow script execution and <filename>.htaccess</filename>
|
||||
overrides.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Used to tell Apache what files are indexes. If you can
|
||||
not add <filename>index.cgi</filename> to the list of valid files,
|
||||
you'll need to set <computeroutput>$index_html</computeroutput> to
|
||||
1 in <filename>localconfig</filename> so
|
||||
<command>./checksetup.pl</command> will create an
|
||||
<filename>index.html</filename> that redirects to
|
||||
<filename>index.cgi</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Used when running Apache on windows so the shebang line
|
||||
doesn't have to be changed in every Bugzilla script.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>For more information about how to configure Apache for Bugzilla,
|
||||
see <xref linkend="http-apache"/>.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-b">
|
||||
<title>B</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Bug</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A
|
||||
<quote>bug</quote>
|
||||
|
||||
in Bugzilla refers to an issue entered into the database which has an
|
||||
associated number, assignments, comments, etc. Some also refer to a
|
||||
<quote>tickets</quote>
|
||||
or
|
||||
<quote>issues</quote>;
|
||||
in the context of Bugzilla, they are synonymous.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Bug Number</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Each Bugzilla bug is assigned a number that uniquely identifies
|
||||
that bug. The bug associated with a bug number can be pulled up via a
|
||||
query, or easily from the very front page by typing the number in the
|
||||
"Find" box.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-bugzilla">
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Bugzilla is the world-leading free software bug tracking system.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-c">
|
||||
<title>C</title>
|
||||
|
||||
<glossentry id="gloss-cgi">
|
||||
<glossterm>Common Gateway Interface</glossterm>
|
||||
<acronym>CGI</acronym>
|
||||
<glossdef>
|
||||
<para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is
|
||||
a standard for interfacing an external application with a web server. Bugzilla
|
||||
is an example of a <acronym>CGI</acronym> application.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-component">
|
||||
<glossterm>Component</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A Component is a subsection of a Product. It should be a narrow
|
||||
category, tailored to your organization. All Products must contain at
|
||||
least one Component (and, as a matter of fact, creating a Product
|
||||
with no Components will create an error in Bugzilla).</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-cpan">
|
||||
<glossterm>Comprehensive Perl Archive Network</glossterm>
|
||||
<acronym>CPAN</acronym>
|
||||
|
||||
<!-- TODO: Rewrite def for CPAN -->
|
||||
<glossdef>
|
||||
<para>
|
||||
<acronym>CPAN</acronym>
|
||||
|
||||
stands for the
|
||||
<quote>Comprehensive Perl Archive Network</quote>.
|
||||
CPAN maintains a large number of extremely useful
|
||||
<glossterm>Perl</glossterm>
|
||||
modules - encapsulated chunks of code for performing a
|
||||
particular task.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-contrib">
|
||||
<glossterm><filename class="directory">contrib</filename></glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>The <filename class="directory">contrib</filename> directory is
|
||||
a location to put scripts that have been contributed to Bugzilla but
|
||||
are not a part of the official distribution. These scripts are written
|
||||
by third parties and may be in languages other than perl. For those
|
||||
that are in perl, there may be additional modules or other requirements
|
||||
than those of the official distribution.
|
||||
<note>
|
||||
<para>Scripts in the <filename class="directory">contrib</filename>
|
||||
directory are not officially supported by the Bugzilla team and may
|
||||
break in between versions.
|
||||
</para>
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-d">
|
||||
<title>D</title>
|
||||
|
||||
<glossentry id="gloss-daemon">
|
||||
<glossterm>daemon</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A daemon is a computer program which runs in the background. In
|
||||
general, most daemons are started at boot time via System V init
|
||||
scripts, or through RC scripts on BSD-based systems.
|
||||
<glossterm>mysqld</glossterm>,
|
||||
the MySQL server, and
|
||||
<glossterm>apache</glossterm>,
|
||||
a web server, are generally run as daemons.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-dos">
|
||||
<glossterm>DOS Attack</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A DOS, or Denial of Service attack, is when a user attempts to
|
||||
deny access to a web server by repeatedly accessing a page or sending
|
||||
malformed requests to a webserver. A D-DOS, or
|
||||
Distributed Denial of Service attack, is when these requests come
|
||||
from multiple sources at the same time. Unfortunately, these are much
|
||||
more difficult to defend against.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-g">
|
||||
<title>G</title>
|
||||
|
||||
<glossentry id="gloss-groups">
|
||||
<glossterm>Groups</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>The word
|
||||
<quote>Groups</quote>
|
||||
|
||||
has a very special meaning to Bugzilla. Bugzilla's main security
|
||||
mechanism comes by placing users in groups, and assigning those
|
||||
groups certain privileges to view bugs in particular
|
||||
<glossterm>Products</glossterm>
|
||||
in the
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
database.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-j">
|
||||
<title>J</title>
|
||||
|
||||
<glossentry id="gloss-javascript">
|
||||
<glossterm>JavaScript</glossterm>
|
||||
<glossdef>
|
||||
<para>JavaScript is cool, we should talk about it.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-m">
|
||||
<title>M</title>
|
||||
|
||||
<glossentry id="gloss-mta">
|
||||
<glossterm>Message Transport Agent</glossterm>
|
||||
<acronym>MTA</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A Message Transport Agent is used to control the flow of email on a system.
|
||||
The <ulink url="http://search.cpan.org/dist/Email-Send/lib/Email/Send.pm">Email::Send</ulink>
|
||||
Perl module, which Bugzilla uses to send email, can be configured to
|
||||
use many different underlying implementations for actually sending the
|
||||
mail using the <option>mail_delivery_method</option> parameter.
|
||||
Implementations other than <literal>sendmail</literal> require that the
|
||||
<option>sendmailnow</option> param be set to <literal>on</literal>.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-mysql">
|
||||
<glossterm>MySQL</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>MySQL is currently the required
|
||||
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL
|
||||
can be downloaded from <ulink url="http://www.mysql.com"/>. While you
|
||||
should familiarize yourself with all of the documentation, some high
|
||||
points are:
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
|
||||
<listitem>
|
||||
<para>Methods for backing up your Bugzilla database.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
|
||||
<listitem>
|
||||
<para>Information about how to configure MySQL using
|
||||
<filename>my.cnf</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
|
||||
<listitem>
|
||||
<para>Much more detailed information about the suggestions in
|
||||
<xref linkend="security-mysql"/>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-p">
|
||||
<title>P</title>
|
||||
|
||||
<glossentry id="gloss-ppm">
|
||||
<glossterm>Perl Package Manager</glossterm>
|
||||
<acronym>PPM</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm id="gloss-product">Product</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A Product is a broad category of types of bugs, normally
|
||||
representing a single piece of software or entity. In general,
|
||||
there are several Components to a Product. A Product may define a
|
||||
group (used for security) for all bugs entered into
|
||||
its Components.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Perl</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>First written by Larry Wall, Perl is a remarkable program
|
||||
language. It has the benefits of the flexibility of an interpreted
|
||||
scripting language (such as shell script), combined with the speed
|
||||
and power of a compiled language, such as C.
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
|
||||
is maintained in Perl.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-q">
|
||||
<title>Q</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>QA</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>
|
||||
<quote>QA</quote>,
|
||||
<quote>Q/A</quote>, and
|
||||
<quote>Q.A.</quote>
|
||||
are short for
|
||||
<quote>Quality Assurance</quote>.
|
||||
In most large software development organizations, there is a team
|
||||
devoted to ensuring the product meets minimum standards before
|
||||
shipping. This team will also generally want to track the progress of
|
||||
bugs over their life cycle, thus the need for the
|
||||
<quote>QA Contact</quote>
|
||||
|
||||
field in a bug.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-r">
|
||||
<title>R</title>
|
||||
|
||||
<glossentry id="gloss-rdbms">
|
||||
<glossterm>Relational DataBase Management System</glossterm>
|
||||
<acronym>RDBMS</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A relational database management system is a database system
|
||||
that stores information in tables that are related to each other.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-regexp">
|
||||
<glossterm>Regular Expression</glossterm>
|
||||
<acronym>regexp</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A regular expression is an expression used for pattern matching.
|
||||
<ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-s">
|
||||
<title>S</title>
|
||||
|
||||
<glossentry id="gloss-service">
|
||||
<glossterm>Service</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>In Windows NT environment, a boot-time background application
|
||||
is referred to as a service. These are generally managed through the
|
||||
control panel while logged in as an account with
|
||||
<quote>Administrator</quote> level capabilities. For more
|
||||
information, consult your Windows manual or the MSKB.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>
|
||||
<acronym>SGML</acronym>
|
||||
</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
stands for
|
||||
<quote>Standard Generalized Markup Language</quote>.
|
||||
Created in the 1980's to provide an extensible means to maintain
|
||||
documentation based upon content instead of presentation,
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
has withstood the test of time as a robust, powerful language.
|
||||
<glossterm>
|
||||
<acronym>XML</acronym>
|
||||
</glossterm>
|
||||
|
||||
is the
|
||||
<quote>baby brother</quote>
|
||||
|
||||
of SGML; any valid
|
||||
<acronym>XML</acronym>
|
||||
|
||||
document it, by definition, a valid
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
document. The document you are reading is written and maintained in
|
||||
<acronym>SGML</acronym>,
|
||||
and is also valid
|
||||
<acronym>XML</acronym>
|
||||
|
||||
if you modify the Document Type Definition.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-t">
|
||||
<title>T</title>
|
||||
|
||||
<glossentry id="gloss-target-milestone" xreflabel="Target Milestone">
|
||||
<glossterm>Target Milestone</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Target Milestones are Product goals. They are configurable on a
|
||||
per-Product basis. Most software development houses have a concept of
|
||||
|
||||
<quote>milestones</quote>
|
||||
|
||||
where the people funding a project expect certain functionality on
|
||||
certain dates. Bugzilla facilitates meeting these milestones by
|
||||
giving you the ability to declare by which milestone a bug will be
|
||||
fixed, or an enhancement will be implemented.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-tcl">
|
||||
<glossterm>Tool Command Language</glossterm>
|
||||
<acronym>TCL</acronym>
|
||||
<glossdef>
|
||||
<para>TCL is an open source scripting language available for Windows,
|
||||
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
|
||||
never released. The first release of Bugzilla was 2.0, which was when
|
||||
it was ported to perl.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-z">
|
||||
<title>Z</title>
|
||||
|
||||
<glossentry id="gloss-zarro">
|
||||
<glossterm>Zarro Boogs Found</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>This is just a goofy way of saying that there were no bugs
|
||||
found matching your query. When asked to explain this message,
|
||||
Terry had the following to say:
|
||||
</para>
|
||||
|
||||
<blockquote>
|
||||
<attribution>Terry Weissman</attribution>
|
||||
<para>I've been asked to explain this ... way back when, when
|
||||
Netscape released version 4.0 of its browser, we had a release
|
||||
party. Naturally, there had been a big push to try and fix every
|
||||
known bug before the release. Naturally, that hadn't actually
|
||||
happened. (This is not unique to Netscape or to 4.0; the same thing
|
||||
has happened with every software project I've ever seen.) Anyway,
|
||||
at the release party, T-shirts were handed out that said something
|
||||
like "Netscape 4.0: Zarro Boogs". Just like the software, the
|
||||
T-shirt had no known bugs. Uh-huh.
|
||||
</para>
|
||||
|
||||
<para>So, when you query for a list of bugs, and it gets no results,
|
||||
you can think of this as a friendly reminder. Of *course* there are
|
||||
bugs matching your query, they just aren't in the bugsystem yet...
|
||||
</para>
|
||||
</blockquote>
|
||||
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
</glossary>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
@@ -1,21 +0,0 @@
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,124 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- Keep these tools listings in alphabetical order please. -MPB -->
|
||||
<section id="integration">
|
||||
<title>Integrating Bugzilla with Third-Party Tools</title>
|
||||
|
||||
<section id="bonsai"
|
||||
xreflabel="Bonsai, the Mozilla automated CVS management system">
|
||||
<title>Bonsai</title>
|
||||
|
||||
<para>Bonsai is a web-based tool for managing
|
||||
<xref linkend="cvs" />
|
||||
|
||||
. Using Bonsai, administrators can control open/closed status of trees,
|
||||
query a fast relational database back-end for change, branch, and comment
|
||||
information, and view changes made since the last time the tree was
|
||||
closed. Bonsai
|
||||
also integrates with
|
||||
<xref linkend="tinderbox" />.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
|
||||
<title>CVS</title>
|
||||
|
||||
<para>CVS integration is best accomplished, at this point, using the
|
||||
Bugzilla Email Gateway.</para>
|
||||
|
||||
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
|
||||
integration. Ensure that your check-in script sends an email to your
|
||||
Bugzilla e-mail gateway with the subject of
|
||||
<quote>[Bug XXXX]</quote>,
|
||||
and you can have CVS check-in comments append to your Bugzilla bug. If
|
||||
you want to have the bug be closed automatically, you'll have to modify
|
||||
the <filename>contrib/bugzilla_email_append.pl</filename> script.
|
||||
</para>
|
||||
|
||||
<para>There is also a CVSZilla project, based upon somewhat dated
|
||||
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
|
||||
email. Check it out at: <ulink url="http://www.cvszilla.org/"/>.
|
||||
</para>
|
||||
|
||||
<para>Another system capable of CVS integration with Bugzilla is
|
||||
Scmbug. This system provides generic integration of Source code
|
||||
Configuration Management with Bugtracking. Check it out at: <ulink
|
||||
url="http://freshmeat.net/projects/scmbug/"/>.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="scm"
|
||||
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
|
||||
|
||||
<title>Perforce SCM</title>
|
||||
|
||||
<para>You can find the project page for Bugzilla and Teamtrack Perforce
|
||||
integration (p4dti) at:
|
||||
<ulink url="http://www.ravenbrook.com/project/p4dti/"/>
|
||||
|
||||
.
|
||||
<quote>p4dti</quote>
|
||||
|
||||
is now an officially supported product from Perforce, and you can find
|
||||
the "Perforce Public Depot" p4dti page at
|
||||
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/>
|
||||
|
||||
.</para>
|
||||
|
||||
<para>Integration of Perforce with Bugzilla, once patches are applied, is
|
||||
seamless. Perforce replication information will appear below the comments
|
||||
of each bug. Be certain you have a matching set of patches for the
|
||||
Bugzilla version you are installing. p4dti is designed to support
|
||||
multiple defect trackers, and maintains its own documentation for it.
|
||||
Please consult the pages linked above for further information.</para>
|
||||
</section>
|
||||
|
||||
<section id="svn"
|
||||
xreflabel="Subversion, a compelling replacement for CVS">
|
||||
<title>Subversion</title>
|
||||
<para>Subversion is a free/open-source version control system,
|
||||
designed to overcome various limitations of CVS. Integration of
|
||||
Subversion with Bugzilla is possible using Scmbug, a system
|
||||
providing generic integration of Source Code Configuration
|
||||
Management with Bugtracking. Scmbug is available at <ulink
|
||||
url="http://freshmeat.net/projects/scmbug/"/>.</para>
|
||||
</section>
|
||||
|
||||
<section id="tinderbox"
|
||||
xreflabel="Tinderbox, the Mozilla automated build management system">
|
||||
<title>Tinderbox/Tinderbox2</title>
|
||||
|
||||
<para>Tinderbox is a continuous-build system which can integrate with
|
||||
Bugzilla - see
|
||||
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
|
||||
of Tinderbox, and
|
||||
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
|
||||
in action.</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,121 +0,0 @@
|
||||
<chapter id="introduction">
|
||||
<title>Introduction</title>
|
||||
|
||||
<section id="what-is-bugzilla">
|
||||
<title>What is Bugzilla?</title>
|
||||
|
||||
<para>
|
||||
Bugzilla is a bug- or issue-tracking system. Bug-tracking
|
||||
systems allow individual or groups of developers effectively to keep track
|
||||
of outstanding problems with their products.
|
||||
</para>
|
||||
|
||||
<para><emphasis>Do we need more here?</emphasis></para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="why-tracking">
|
||||
<title>Why use a bug-tracking system?</title>
|
||||
|
||||
<para>Those who do not use a bug-tracking system tend to rely on
|
||||
shared lists, email, spreadsheets and/or Post-It notes to monitor the
|
||||
status of defects. This procedure
|
||||
is usually error-prone and tends to cause those bugs judged least
|
||||
significant by developers to be dropped or ignored.</para>
|
||||
|
||||
<para>Integrated defect-tracking systems make sure that nothing gets
|
||||
swept under the carpet; they provide a method of creating, storing,
|
||||
arranging and processing defect reports and enhancement requests.</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="why-bugzilla">
|
||||
<title>Why use Bugzilla?</title>
|
||||
|
||||
<para>Bugzilla is the leading open-source/free software bug tracking
|
||||
system. It boasts many advanced features, including:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Powerful searching</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>User-configurable email notifications of bug changes</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Full change history</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Inter-bug dependency tracking and graphing</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Excellent attachment management</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Integrated, product-based, granular security schema</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Fully security-audited, and runs under Perl's taint mode</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>A robust, stable RDBMS back-end</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Completely customizable and/or localizable web user
|
||||
interface</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Additional XML, email and console interfaces</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Extensive configurability</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Smooth upgrade pathway between versions</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>Bugzilla is very adaptable to various situations. Known uses
|
||||
currently include IT support queues, Systems Administration deployment
|
||||
management, chip design and development problem tracking (both
|
||||
pre-and-post fabrication), and software and hardware bug tracking for
|
||||
luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
|
||||
Combined with systems such as
|
||||
<ulink url="http://www.cvshome.org">CVS</ulink>,
|
||||
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
|
||||
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
|
||||
provides a powerful, easy-to-use configuration management solution.</para>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
@@ -1,197 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="install-perlmodules-manual">
|
||||
<title>Manual Installation of Perl Modules</title>
|
||||
|
||||
<section id="modules-manual-instructions">
|
||||
<title>Instructions</title>
|
||||
<para>
|
||||
If you need to install Perl modules manually, here's how it's done.
|
||||
Download the module using the link given in the next section, and then
|
||||
apply this magic incantation, as root:
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<screen><prompt>bash#</prompt> tar -xzvf <module>.tar.gz
|
||||
<prompt>bash#</prompt> cd <module>
|
||||
<prompt>bash#</prompt> perl Makefile.PL
|
||||
<prompt>bash#</prompt> make
|
||||
<prompt>bash#</prompt> make test
|
||||
<prompt>bash#</prompt> make install</screen>
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
In order to compile source code under Windows you will need to obtain
|
||||
a 'make' utility. The <command>nmake</command> utility provided with
|
||||
Microsoft Visual C++ may be used. As an alternative, there is a
|
||||
utility called <command>dmake</command> available from CPAN which is
|
||||
written entirely in Perl.
|
||||
</para>
|
||||
<para>
|
||||
As described in <xref linkend="modules-manual-download" />, however, most
|
||||
packages already exist and are available from ActiveState or theory58S.
|
||||
We highly recommend that you install them using the ppm GUI available with
|
||||
ActiveState and to add the theory58S repository to your list of repositories.
|
||||
</para>
|
||||
</note>
|
||||
</section>
|
||||
|
||||
<section id="modules-manual-download">
|
||||
<title>Download Locations</title>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
Running Bugzilla on Windows requires the use of ActiveState
|
||||
Perl 5.8.1 or higher. Many modules already exist in the core
|
||||
distribution of ActiveState Perl. Additional modules can be downloaded
|
||||
from <ulink url="http://theoryx5.uwinnipeg.ca/ppms/" /> if you use
|
||||
Perl 5.8.x or from <ulink url="http://cpan.uwinnipeg.ca/PPMPackages/10xx/" />
|
||||
if you use Perl 5.10.x.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
CGI:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/CGI.pm/"/>
|
||||
Documentation: <ulink url="http://perldoc.perl.org/CGI.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Data-Dumper:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Data-Dumper/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/Data-Dumper/Dumper.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Date::Format (part of TimeDate):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/TimeDate/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBI:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBI/"/>
|
||||
Documentation: <ulink url="http://dbi.perl.org/docs/"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBD::mysql:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-mysql/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBD::Pg:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-Pg/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/DBD-Pg/Pg.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
File::Spec:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/File-Spec/"/>
|
||||
Documentation: <ulink url="http://perldoc.perl.org/File/Spec.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template-Toolkit:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-Toolkit/"/>
|
||||
Documentation: <ulink url="http://www.template-toolkit.org/docs.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GD/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GD/GD.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template::Plugin::GD:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-GD/" />
|
||||
Documentation: <ulink url="http://www.template-toolkit.org/docs/aqua/Modules/index.html" />
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
MIME::Parser (part of MIME-tools):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/MIME-tools/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="modules-manual-optional">
|
||||
<title>Optional Modules</title>
|
||||
|
||||
<para>
|
||||
Chart::Base:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Chart/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/Chart/Chart.pod"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD::Graph:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDGraph/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GDGraph/Graph.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD::Text::Align (part of GD::Text::Util):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDTextUtil/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GDTextUtil/Text/Align.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
XML::Twig:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/XML-Twig/"/>
|
||||
Documentation: <ulink url="http://standards.ieee.org/resources/spasystem/twig/twig_stable.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
PatchReader:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/author/JKEISER/PatchReader/"/>
|
||||
Documentation: <ulink url="http://www.johnkeiser.com/mozilla/Patch_Viewer.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Image::Magick:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/PerlMagick/"/>
|
||||
Documentation: <ulink url="http://www.imagemagick.org/script/resources.php"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
</section>
|
||||
</appendix>
|
||||
@@ -1,135 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
|
||||
<title>Contrib</title>
|
||||
|
||||
<para>
|
||||
There are a number of unofficial Bugzilla add-ons in the
|
||||
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename>
|
||||
directory. This section documents them.
|
||||
</para>
|
||||
|
||||
<section id="cmdline">
|
||||
<title>Command-line Search Interface</title>
|
||||
|
||||
<para>
|
||||
There are a suite of Unix utilities for searching Bugzilla from the
|
||||
command line. They live in the
|
||||
<filename class="directory">contrib/cmdline</filename> directory.
|
||||
There are three files - <filename>query.conf</filename>,
|
||||
<filename>buglist</filename> and <filename>bugs</filename>.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
These files pre-date the templatization work done as part of the
|
||||
2.16 release, and have not been updated.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
<filename>query.conf</filename> contains the mapping from
|
||||
options to field names and comparison types. Quoted option names
|
||||
are <quote>grepped</quote> for, so it should be easy to edit this
|
||||
file. Comments (#) have no effect; you must make sure these lines
|
||||
do not contain any quoted <quote>option</quote>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<filename>buglist</filename> is a shell script that submits a
|
||||
Bugzilla query and writes the resulting HTML page to stdout.
|
||||
It supports both short options, (such as <quote>-Afoo</quote>
|
||||
or <quote>-Rbar</quote>) and long options (such
|
||||
as <quote>--assignedto=foo</quote> or <quote>--reporter=bar</quote>).
|
||||
If the first character of an option is not <quote>-</quote>, it is
|
||||
treated as if it were prefixed with <quote>--default=</quote>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The column list is taken from the COLUMNLIST environment variable.
|
||||
This is equivalent to the <quote>Change Columns</quote> option
|
||||
that is available when you list bugs in buglist.cgi. If you have
|
||||
already used Bugzilla, grep for COLUMNLIST in your cookies file
|
||||
to see your current COLUMNLIST setting.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<filename>bugs</filename> is a simple shell script which calls
|
||||
<filename>buglist</filename> and extracts the
|
||||
bug numbers from the output. Adding the prefix
|
||||
<quote>http://bugzilla.mozilla.org/buglist.cgi?bug_id=</quote>
|
||||
turns the bug list into a working link if any bugs are found.
|
||||
Counting bugs is easy. Pipe the results through
|
||||
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Akkana Peck says she has good results piping
|
||||
<filename>buglist</filename> output through
|
||||
<command>w3m -T text/html -dump</command>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="cmdline-bugmail">
|
||||
<title>Command-line 'Send Unsent Bug-mail' tool</title>
|
||||
|
||||
<para>
|
||||
Within the <filename class="directory">contrib</filename> directory
|
||||
exists a utility with the descriptive (if compact) name
|
||||
of <filename>sendunsentbugmail.pl</filename>. The purpose of this
|
||||
script is, simply, to send out any bug-related mail that should
|
||||
have been sent by now, but for one reason or another has not.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To accomplish this task, <filename>sendunsentbugmail.pl</filename> uses
|
||||
the same mechanism as the <filename>sanitycheck.cgi</filename> script;
|
||||
it scans through the entire database looking for bugs with changes that
|
||||
were made more than 30 minutes ago, but where there is no record of
|
||||
anyone related to that bug having been sent mail. Having compiled a list,
|
||||
it then uses the standard rules to determine who gets mail, and sends it
|
||||
out.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
As the script runs, it indicates the bug for which it is currently
|
||||
sending mail; when it has finished, it gives a numerical count of how
|
||||
many mails were sent and how many people were excluded. (Individual
|
||||
user names are not recorded or displayed.) If the script produces
|
||||
no output, that means no unsent mail was detected.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<emphasis>Usage</emphasis>: move the sendunsentbugmail.pl script
|
||||
up into the main directory, ensure it has execute permission, and run it
|
||||
from the command line (or from a cron job) with no parameters.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,77 +0,0 @@
|
||||
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
||||
<appendix id="downloadlinks">
|
||||
<title>Software Download Links</title>
|
||||
|
||||
<para>All of these sites are current as of April, 2001. Hopefully they'll
|
||||
stay current for a while.</para>
|
||||
|
||||
<para>Apache Web Server:
|
||||
<ulink url="http://www.apache.org/"/>
|
||||
|
||||
Optional web server for Bugzilla, but recommended because of broad user
|
||||
base and support.</para>
|
||||
|
||||
<para>Bugzilla:
|
||||
<ulink url="http://www.bugzilla.org/"/>
|
||||
</para>
|
||||
|
||||
<para>MySQL:
|
||||
<ulink url="http://www.mysql.com/"/>
|
||||
</para>
|
||||
|
||||
<para>Perl:
|
||||
<ulink url="http://www.perl.org/"/>
|
||||
</para>
|
||||
|
||||
<para>CPAN:
|
||||
<ulink url="http://www.cpan.org/"/>
|
||||
</para>
|
||||
|
||||
<para>DBI Perl module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/DBI/"/>
|
||||
</para>
|
||||
|
||||
<para>MySQL related Perl modules:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Mysql/"/>
|
||||
</para>
|
||||
|
||||
<para>TimeDate Perl module collection:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Date/"/>
|
||||
</para>
|
||||
|
||||
<para>GD Perl module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/GD/"/>
|
||||
|
||||
Alternately, you should be able to find the latest version of GD at
|
||||
<ulink url="http://www.boutell.com/gd/"/>
|
||||
</para>
|
||||
|
||||
<para>Chart::Base module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Chart/"/>
|
||||
</para>
|
||||
|
||||
<para>(But remember, Bundle::Bugzilla will install all the modules for you.)
|
||||
</para>
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,364 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: security.xml,v 1.19.2.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<chapter id="security">
|
||||
<title>Bugzilla Security</title>
|
||||
|
||||
<para>While some of the items in this chapter are related to the operating
|
||||
system Bugzilla is running on or some of the support software required to
|
||||
run Bugzilla, it is all related to protecting your data. This is not
|
||||
intended to be a comprehensive guide to securing Linux, Apache, MySQL, or
|
||||
any other piece of software mentioned. There is no substitute for active
|
||||
administration and monitoring of a machine. The key to good security is
|
||||
actually right in the middle of the word: <emphasis>U R It</emphasis>.
|
||||
</para>
|
||||
|
||||
<para>While programmers in general always strive to write secure code,
|
||||
accidents can and do happen. The best approach to security is to always
|
||||
assume that the program you are working with isn't 100% secure and restrict
|
||||
its access to other parts of your machine as much as possible.
|
||||
</para>
|
||||
|
||||
<section id="security-os">
|
||||
<title>Operating System</title>
|
||||
|
||||
<section id="security-os-ports">
|
||||
<title>TCP/IP Ports</title>
|
||||
|
||||
<!-- TODO: Get exact number of ports -->
|
||||
<para>The TCP/IP standard defines more than 65,000 ports for sending
|
||||
and receiving traffic. Of those, Bugzilla needs exactly one to operate
|
||||
(different configurations and options may require up to 3). You should
|
||||
audit your server and make sure that you aren't listening on any ports
|
||||
you don't need to be. It's also highly recommended that the server
|
||||
Bugzilla resides on, along with any other machines you administer, be
|
||||
placed behind some kind of firewall.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-os-accounts">
|
||||
<title>System User Accounts</title>
|
||||
|
||||
<para>Many <glossterm linkend="gloss-daemon">daemons</glossterm>, such
|
||||
as Apache's <filename>httpd</filename> or MySQL's
|
||||
<filename>mysqld</filename>, run as either <quote>root</quote> or
|
||||
<quote>nobody</quote>. This is even worse on Windows machines where the
|
||||
majority of <glossterm linkend="gloss-service">services</glossterm>
|
||||
run as <quote>SYSTEM</quote>. While running as <quote>root</quote> or
|
||||
<quote>SYSTEM</quote> introduces obvious security concerns, the
|
||||
problems introduced by running everything as <quote>nobody</quote> may
|
||||
not be so obvious. Basically, if you run every daemon as
|
||||
<quote>nobody</quote> and one of them gets compromised it can
|
||||
compromise every other daemon running as <quote>nobody</quote> on your
|
||||
machine. For this reason, it is recommended that you create a user
|
||||
account for each daemon.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>You will need to set the <option>webservergroup</option> option
|
||||
in <filename>localconfig</filename> to the group your web server runs
|
||||
as. This will allow <filename>./checksetup.pl</filename> to set file
|
||||
permissions on Unix systems so that nothing is world-writable.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-os-chroot">
|
||||
<title>The <filename>chroot</filename> Jail</title>
|
||||
|
||||
<para>
|
||||
If your system supports it, you may wish to consider running
|
||||
Bugzilla inside of a <filename>chroot</filename> jail. This option
|
||||
provides unprecedented security by restricting anything running
|
||||
inside the jail from accessing any information outside of it. If you
|
||||
wish to use this option, please consult the documentation that came
|
||||
with your system.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="security-mysql">
|
||||
<title>MySQL</title>
|
||||
|
||||
<section id="security-mysql-account">
|
||||
<title>The MySQL System Account</title>
|
||||
|
||||
<para>As mentioned in <xref linkend="security-os-accounts"/>, the MySQL
|
||||
daemon should run as a non-privileged, unique user. Be sure to consult
|
||||
the MySQL documentation or the documentation that came with your system
|
||||
for instructions.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="security-mysql-root">
|
||||
<title>The MySQL <quote>root</quote> and <quote>anonymous</quote> Users</title>
|
||||
|
||||
<para>By default, MySQL comes with a <quote>root</quote> user with a
|
||||
blank password and an <quote>anonymous</quote> user, also with a blank
|
||||
password. In order to protect your data, the <quote>root</quote> user
|
||||
should be given a password and the anonymous user should be disabled.
|
||||
</para>
|
||||
|
||||
<example id="security-mysql-account-root">
|
||||
<title>Assigning the MySQL <quote>root</quote> User a Password</title>
|
||||
|
||||
<screen>
|
||||
<prompt>bash$</prompt> mysql mysql
|
||||
<prompt>mysql></prompt> UPDATE user SET password = password('<replaceable>new_password</replaceable>') WHERE user = 'root';
|
||||
<prompt>mysql></prompt> FLUSH PRIVILEGES;
|
||||
</screen>
|
||||
</example>
|
||||
|
||||
<example id="security-mysql-account-anonymous">
|
||||
<title>Disabling the MySQL <quote>anonymous</quote> User</title>
|
||||
<screen>
|
||||
<prompt>bash$</prompt> mysql -u root -p mysql <co id="security-mysql-account-anonymous-mysql"/>
|
||||
<prompt>Enter Password:</prompt> <replaceable>new_password</replaceable>
|
||||
<prompt>mysql></prompt> DELETE FROM user WHERE user = '';
|
||||
<prompt>mysql></prompt> FLUSH PRIVILEGES;
|
||||
</screen>
|
||||
<calloutlist>
|
||||
<callout arearefs="security-mysql-account-anonymous-mysql">
|
||||
<para>This command assumes that you have already completed
|
||||
<xref linkend="security-mysql-account-root"/>.
|
||||
</para>
|
||||
</callout>
|
||||
</calloutlist>
|
||||
</example>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-mysql-network">
|
||||
<title>Network Access</title>
|
||||
|
||||
<para>If MySQL and your web server both run on the same machine and you
|
||||
have no other reason to access MySQL remotely, then you should disable
|
||||
the network access. This, along with the suggestion in
|
||||
<xref linkend="security-os-ports"/>, will help protect your system from
|
||||
any remote vulnerabilities in MySQL.
|
||||
</para>
|
||||
|
||||
<example id="security-mysql-network-ex">
|
||||
<title>Disabling Networking in MySQL</title>
|
||||
|
||||
<para>Simply enter the following in <filename>/etc/my.cnf</filename>:
|
||||
<screen>
|
||||
[mysqld]
|
||||
# Prevent network access to MySQL.
|
||||
skip-networking
|
||||
</screen>
|
||||
</para>
|
||||
</example>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<!-- For possible addition in the future: How to better control the bugs user
|
||||
<section id="security-mysql-bugs">
|
||||
<title>The bugs User</title>
|
||||
|
||||
</section>
|
||||
-->
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="security-webserver">
|
||||
<title>Web server</title>
|
||||
|
||||
<section id="security-webserver-access">
|
||||
<title>Disabling Remote Access to Bugzilla Configuration Files</title>
|
||||
|
||||
<para>
|
||||
There are many files that are placed in the Bugzilla directory
|
||||
area that should not be accessible from the web server. Because of the way
|
||||
Bugzilla is currently layed out, the list of what should and should not
|
||||
be accessible is rather complicated. A quick way is to run
|
||||
<filename>testserver.pl</filename> to check if your web server serves
|
||||
Bugzilla files as expected. If not, you may want to follow the few
|
||||
steps below.
|
||||
</para>
|
||||
|
||||
<tip>
|
||||
<para>Bugzilla ships with the ability to create
|
||||
<glossterm linkend="gloss-htaccess"><filename>.htaccess</filename></glossterm>
|
||||
files that enforce these rules. Instructions for enabling these
|
||||
directives in Apache can be found in <xref linkend="http-apache"/>
|
||||
</para>
|
||||
</tip>
|
||||
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>In the main Bugzilla directory, you should:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block:
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.pl</filename></member>
|
||||
<member><filename>*localconfig*</filename></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">data</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">data/webdot</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>If you use a remote webdot server:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>But allow
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.dot</filename></member>
|
||||
</simplelist>
|
||||
only for the remote webdot server</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Otherwise, if you use a local GraphViz:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>But allow:
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.png</filename></member>
|
||||
<member><filename>*.gif</filename></member>
|
||||
<member><filename>*.jpg</filename></member>
|
||||
<member><filename>*.map</filename></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>And if you don't use any dot:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">Bugzilla</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">template</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Be sure to test that data that should not be accessed remotely is
|
||||
properly blocked. Of particular interest is the localconfig file which
|
||||
contains your database password. Also, be aware that many editors
|
||||
create temporary and backup files in the working directory and that
|
||||
those should also not be accessible. For more information, see
|
||||
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=186383">bug 186383</ulink>
|
||||
or
|
||||
<ulink url="http://online.securityfocus.com/bid/6501">Bugtraq ID 6501</ulink>.
|
||||
To test, simply run <filename>testserver.pl</filename>, as said above.
|
||||
</para>
|
||||
|
||||
<tip>
|
||||
<para>Be sure to check <xref linkend="http"/> for instructions
|
||||
specific to the web server you use.
|
||||
</para>
|
||||
</tip>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="security-bugzilla">
|
||||
<title>Bugzilla</title>
|
||||
|
||||
<section id="security-bugzilla-charset">
|
||||
<title>Prevent users injecting malicious Javascript</title>
|
||||
|
||||
<para>If you installed Bugzilla version 2.22 or later from scratch,
|
||||
then the <emphasis>utf8</emphasis> parameter is switched on by default.
|
||||
This makes Bugzilla explicitly set the character encoding, following
|
||||
<ulink
|
||||
url="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3">a
|
||||
CERT advisory</ulink> recommending exactly this.
|
||||
The following therefore does not apply to you; just keep
|
||||
<emphasis>utf8</emphasis> turned on.
|
||||
</para>
|
||||
|
||||
<para>If you've upgraded from an older version, then it may be possible
|
||||
for a Bugzilla user to take advantage of character set encoding
|
||||
ambiguities to inject HTML into Bugzilla comments.
|
||||
This could include malicious scripts.
|
||||
This is because due to internationalization concerns, we are unable to
|
||||
turn the <emphasis>utf8</emphasis> parameter on by default for upgraded
|
||||
installations.
|
||||
Turning it on manually will prevent this problem.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
@@ -1,311 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: troubleshooting.xml,v 1.13.4.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<appendix id="troubleshooting">
|
||||
<title>Troubleshooting</title>
|
||||
|
||||
<para>This section gives solutions to common Bugzilla installation
|
||||
problems. If none of the section headings seems to match your
|
||||
problem, read the general advice.
|
||||
</para>
|
||||
|
||||
<section id="general-advice">
|
||||
<title>General Advice</title>
|
||||
<para>If you can't get <filename>checksetup.pl</filename> to run to
|
||||
completion, it normally explains what's wrong and how to fix it.
|
||||
If you can't work it out, or if it's being uncommunicative, post
|
||||
the errors in the
|
||||
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">mozilla.support.bugzilla</ulink>
|
||||
newsgroup.
|
||||
</para>
|
||||
|
||||
<para>If you have made it all the way through
|
||||
<xref linkend="installation"/> (Installation) and
|
||||
<xref linkend="configuration"/> (Configuration) but accessing the Bugzilla
|
||||
URL doesn't work, the first thing to do is to check your web server error
|
||||
log. For Apache, this is often located at
|
||||
<filename>/etc/logs/httpd/error_log</filename>. The error messages
|
||||
you see may be self-explanatory enough to enable you to diagnose and
|
||||
fix the problem. If not, see below for some commonly-encountered
|
||||
errors. If that doesn't help, post the errors to the newsgroup.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Bugzilla can also log all user-based errors (and many code-based errors)
|
||||
that occur, without polluting the web server's error log. To enable
|
||||
Bugzilla error logging, create a file that Bugzilla can write to, named
|
||||
<filename>errorlog</filename>, in the Bugzilla <filename>data</filename>
|
||||
directory. Errors will be logged as they occur, and will include the type
|
||||
of the error, the IP address and username (if available) of the user who
|
||||
triggered the error, and the values of all environment variables; if a
|
||||
form was being submitted, the data in the form will also be included.
|
||||
To disable error logging, delete or rename the
|
||||
<filename>errorlog</filename> file.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-testserver">
|
||||
<title>The Apache web server is not serving Bugzilla pages</title>
|
||||
<para>After you have run <command>checksetup.pl</command> twice,
|
||||
run <command>testserver.pl http://yoursite.yourdomain/yoururl</command>
|
||||
to confirm that your web server is configured properly for
|
||||
Bugzilla.
|
||||
</para>
|
||||
<programlisting>
|
||||
<prompt>bash$</prompt> ./testserver.pl http://landfill.bugzilla.org/bugzilla-tip
|
||||
TEST-OK Webserver is running under group id in $webservergroup.
|
||||
TEST-OK Got ant picture.
|
||||
TEST-OK Webserver is executing CGIs.
|
||||
TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-tip/localconfig.
|
||||
</programlisting>
|
||||
</section>
|
||||
|
||||
<section id="trbl-perlmodule">
|
||||
<title>I installed a Perl module, but
|
||||
<filename>checksetup.pl</filename> claims it's not installed!</title>
|
||||
|
||||
<para>This could be caused by one of two things:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>You have two versions of Perl on your machine. You are installing
|
||||
modules into one, and Bugzilla is using the other. Rerun the CPAN
|
||||
commands (or manual compile) using the full path to Perl from the
|
||||
top of <filename>checksetup.pl</filename>. This will make sure you
|
||||
are installing the modules in the right place.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The permissions on your library directories are set incorrectly.
|
||||
They must, at the very least, be readable by the web server user or
|
||||
group. It is recommended that they be world readable.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
||||
<section id="trbl-dbdSponge">
|
||||
<title>DBD::Sponge::db prepare failed</title>
|
||||
|
||||
<para>The following error message may appear due to a bug in DBD::mysql
|
||||
(over which the Bugzilla team have no control):
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248.
|
||||
SV = NULL(0x0) at 0x20fc444
|
||||
REFCNT = 1
|
||||
FLAGS = (PADBUSY,PADMY)
|
||||
]]></programlisting>
|
||||
|
||||
<para>To fix this, go to
|
||||
<filename><path-to-perl>/lib/DBD/sponge.pm</filename>
|
||||
in your Perl installation and replace
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[ my $numFields;
|
||||
if ($attribs->{'NUM_OF_FIELDS'}) {
|
||||
$numFields = $attribs->{'NUM_OF_FIELDS'};
|
||||
} elsif ($attribs->{'NAME'}) {
|
||||
$numFields = @{$attribs->{NAME}};
|
||||
]]></programlisting>
|
||||
|
||||
<para>with</para>
|
||||
|
||||
<programlisting><![CDATA[ my $numFields;
|
||||
if ($attribs->{'NUM_OF_FIELDS'}) {
|
||||
$numFields = $attribs->{'NUM_OF_FIELDS'};
|
||||
} elsif ($attribs->{'NAMES'}) {
|
||||
$numFields = @{$attribs->{NAMES}};
|
||||
]]></programlisting>
|
||||
|
||||
<para>(note the S added to NAME.)</para>
|
||||
</section>
|
||||
|
||||
<section id="paranoid-security">
|
||||
<title>cannot chdir(/var/spool/mqueue)</title>
|
||||
|
||||
<para>If you are installing Bugzilla on SuSE Linux, or some other
|
||||
distributions with <quote>paranoid</quote> security options, it is
|
||||
possible that the checksetup.pl script may fail with the error:
|
||||
<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied
|
||||
]]></programlisting>
|
||||
</para>
|
||||
|
||||
<para>This is because your <filename>/var/spool/mqueue</filename>
|
||||
directory has a mode of <computeroutput>drwx------</computeroutput>.
|
||||
Type <command>chmod 755 <filename>/var/spool/mqueue</filename></command>
|
||||
as root to fix this problem. This will allow any process running on your
|
||||
machine the ability to <emphasis>read</emphasis> the
|
||||
<filename>/var/spool/mqueue</filename> directory.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-relogin-everyone">
|
||||
<title>Everybody is constantly being forced to relogin</title>
|
||||
|
||||
<para>The most-likely cause is that the <quote>cookiepath</quote> parameter
|
||||
is not set correctly in the Bugzilla configuration. You can change this (if
|
||||
you're a Bugzilla administrator) from the editparams.cgi page via the web interface.
|
||||
</para>
|
||||
|
||||
<para>The value of the cookiepath parameter should be the actual directory
|
||||
containing your Bugzilla installation, <emphasis>as seen by the end-user's
|
||||
web browser</emphasis>. Leading and trailing slashes are mandatory. You can
|
||||
also set the cookiepath to any directory which is a parent of the Bugzilla
|
||||
directory (such as '/', the root directory). But you can't put something
|
||||
that isn't at least a partial match or it won't work. What you're actually
|
||||
doing is restricting the end-user's browser to sending the cookies back only
|
||||
to that directory.
|
||||
</para>
|
||||
|
||||
<para>How do you know if you want your specific Bugzilla directory or the
|
||||
whole site?
|
||||
</para>
|
||||
|
||||
<para>If you have only one Bugzilla running on the server, and you don't
|
||||
mind having other applications on the same server with it being able to see
|
||||
the cookies (you might be doing this on purpose if you have other things on
|
||||
your site that share authentication with Bugzilla), then you'll want to have
|
||||
the cookiepath set to "/", or to a sufficiently-high enough directory that
|
||||
all of the involved apps can see the cookies.
|
||||
</para>
|
||||
|
||||
<example id="trbl-relogin-everyone-share">
|
||||
<title>Examples of urlbase/cookiepath pairs for sharing login cookies</title>
|
||||
|
||||
<blockquote>
|
||||
<literallayout>
|
||||
urlbase is <ulink url="http://bugzilla.mozilla.org/"/>
|
||||
cookiepath is /
|
||||
|
||||
urlbase is <ulink url="http://tools.mysite.tld/bugzilla/"/>
|
||||
but you have http://tools.mysite.tld/someotherapp/ which shares
|
||||
authentication with your Bugzilla
|
||||
cookiepath is /
|
||||
</literallayout>
|
||||
</blockquote>
|
||||
</example>
|
||||
|
||||
<para>On the other hand, if you have more than one Bugzilla running on the
|
||||
server (some people do - we do on landfill) then you need to have the
|
||||
cookiepath restricted enough so that the different Bugzillas don't
|
||||
confuse their cookies with one another.
|
||||
</para>
|
||||
|
||||
|
||||
<example id="trbl-relogin-everyone-restrict">
|
||||
<title>Examples of urlbase/cookiepath pairs to restrict the login cookie</title>
|
||||
<blockquote>
|
||||
<literallayout>
|
||||
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"/>
|
||||
cookiepath is /bugzilla-tip/
|
||||
|
||||
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-2.16-branch/"/>
|
||||
cookiepath is /bugzilla-2.16-branch/
|
||||
</literallayout>
|
||||
</blockquote>
|
||||
</example>
|
||||
|
||||
<para>If you had cookiepath set to <quote>/</quote> at any point in the
|
||||
past and need to set it to something more restrictive
|
||||
(i.e. <quote>/bugzilla/</quote>), you can safely do this without
|
||||
requiring users to delete their Bugzilla-related cookies in their
|
||||
browser (this is true starting with Bugzilla 2.18 and Bugzilla 2.16.5).
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-relogin-some">
|
||||
<title>Some users are constantly being forced to relogin</title>
|
||||
|
||||
<para>First, make sure cookies are enabled in the user's browser.
|
||||
</para>
|
||||
|
||||
<para>If that doesn't fix the problem, it may be that the user's ISP
|
||||
implements a rotating proxy server. This causes the user's effective IP
|
||||
address (the address which the Bugzilla server perceives him coming from)
|
||||
to change periodically. Since Bugzilla cookies are tied to a specific IP
|
||||
address, each time the effective address changes, the user will have to
|
||||
log in again.
|
||||
</para>
|
||||
|
||||
<para>If you are using 2.18 (or later), there is a
|
||||
parameter called <quote>loginnetmask</quote>, which you can use to set
|
||||
the number of bits of the user's IP address to require to be matched when
|
||||
authenticating the cookies. If you set this to something less than 32,
|
||||
then the user will be given a checkbox for <quote>Restrict this login to
|
||||
my IP address</quote> on the login screen, which defaults to checked. If
|
||||
they leave the box checked, Bugzilla will behave the same as it did
|
||||
before, requiring an exact match on their IP address to remain logged in.
|
||||
If they uncheck the box, then only the left side of their IP address (up
|
||||
to the number of bits you specified in the parameter) has to match to
|
||||
remain logged in.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="trbl-index">
|
||||
<title><filename>index.cgi</filename> doesn't show up unless specified in the URL</title>
|
||||
<para>
|
||||
You probably need to set up your web server in such a way that it
|
||||
will serve the index.cgi page as an index page.
|
||||
</para>
|
||||
<para>
|
||||
If you are using Apache, you can do this by adding
|
||||
<filename>index.cgi</filename> to the end of the
|
||||
<computeroutput>DirectoryIndex</computeroutput> line
|
||||
as mentioned in <xref linkend="http-apache"/>.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="trbl-passwd-encryption">
|
||||
<title>
|
||||
checksetup.pl reports "Client does not support authentication protocol
|
||||
requested by server..."
|
||||
</title>
|
||||
|
||||
<para>
|
||||
This error is occurring because you are using the new password
|
||||
encryption that comes with MySQL 4.1, while your
|
||||
<filename>DBD::mysql</filename> module was compiled against an
|
||||
older version of MySQL. If you recompile <filename>DBD::mysql</filename>
|
||||
against the current MySQL libraries (or just obtain a newer version
|
||||
of this module) then the error may go away.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If that does not fix the problem, or if you cannot recompile the
|
||||
existing module (e.g. you're running Windows) and/or don't want to
|
||||
replace it (e.g. you want to keep using a packaged version), then a
|
||||
workaround is available from the MySQL docs:
|
||||
<ulink url="http://dev.mysql.com/doc/mysql/en/Old_client.html"/>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,217 +0,0 @@
|
||||
#!/usr/bin/perl -w
|
||||
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
||||
#
|
||||
# The contents of this file are subject to the Mozilla Public
|
||||
# License Version 1.1 (the "License"); you may not use this file
|
||||
# except in compliance with the License. You may obtain a copy of
|
||||
# the License at http://www.mozilla.org/MPL/
|
||||
#
|
||||
# Software distributed under the License is distributed on an "AS
|
||||
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
# implied. See the License for the specific language governing
|
||||
# rights and limitations under the License.
|
||||
#
|
||||
# The Original Code is the Bugzilla Bug Tracking System.
|
||||
#
|
||||
# The Initial Developer of the Original Code is Netscape Communications
|
||||
# Corporation. Portions created by Netscape are
|
||||
# Copyright (C) 1998 Netscape Communications Corporation. All
|
||||
# Rights Reserved.
|
||||
#
|
||||
# Contributor(s): Matthew Tuck <matty@chariot.net.au>
|
||||
# Jacob Steenhagen <jake@bugzilla.org>
|
||||
# Colin Ogilvie <colin.ogilvie@gmail.com>
|
||||
# Max Kanat-Alexander <mkanat@bugzilla.org>
|
||||
|
||||
# This script compiles all the documentation.
|
||||
|
||||
use strict;
|
||||
use Cwd;
|
||||
|
||||
# We need to be in this directory to use our libraries.
|
||||
BEGIN {
|
||||
require File::Basename;
|
||||
import File::Basename qw(dirname);
|
||||
chdir dirname($0);
|
||||
}
|
||||
|
||||
use lib qw(.. ../lib lib);
|
||||
|
||||
# We only compile our POD if Pod::Simple is installed. We do the checks
|
||||
# this way so that if there's a compile error in Pod::Simple::HTML::Bugzilla,
|
||||
# makedocs doesn't just silently fail, but instead actually tells us there's
|
||||
# a compile error.
|
||||
my $pod_simple;
|
||||
if (eval { require Pod::Simple }) {
|
||||
require Pod::Simple::HTMLBatch::Bugzilla;
|
||||
require Pod::Simple::HTML::Bugzilla;
|
||||
$pod_simple = 1;
|
||||
};
|
||||
|
||||
use Bugzilla::Install::Requirements
|
||||
qw(REQUIRED_MODULES OPTIONAL_MODULES);
|
||||
use Bugzilla::Constants qw(DB_MODULE BUGZILLA_VERSION);
|
||||
|
||||
###############################################################################
|
||||
# Generate minimum version list
|
||||
###############################################################################
|
||||
|
||||
my $modules = REQUIRED_MODULES;
|
||||
my $opt_modules = OPTIONAL_MODULES;
|
||||
|
||||
open(ENTITIES, '>', 'bugzilla.ent') or die('Could not open bugzilla.ent: ' . $!);
|
||||
print ENTITIES <<END_ENTITIES;
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<!ENTITY bz-ver "3.3">
|
||||
<!ENTITY bz-nextver "4.0">
|
||||
<!ENTITY bz-date "2008-05-20">
|
||||
<!ENTITY current-year "2008">
|
||||
|
||||
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
|
||||
<!ENTITY bz "http://www.bugzilla.org/">
|
||||
<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation'>Bugzilla Documentation</ulink>">
|
||||
<!ENTITY mysql "http://www.mysql.com/">
|
||||
|
||||
<!ENTITY min-perl-ver "5.8.1">
|
||||
|
||||
|
||||
<!-- Module Versions -->
|
||||
END_ENTITIES
|
||||
foreach my $module (@$modules, @$opt_modules)
|
||||
{
|
||||
my $name = $module->{'module'};
|
||||
$name =~ s/::/-/g;
|
||||
$name = lc($name);
|
||||
#This needs to be a string comparison, due to the modules having
|
||||
#version numbers like 0.9.4
|
||||
my $version = $module->{'version'} eq 0 ? 'any' : $module->{'version'};
|
||||
print ENTITIES '<!ENTITY min-' . $name . '-ver "'.$version.'">' . "\n";
|
||||
}
|
||||
|
||||
# CGI is a special case, because for Perl versions below 5.10, it has an
|
||||
# optional version *and* a required version.
|
||||
# We check @opt_modules first, then @modules, and pick the first we get.
|
||||
# We'll get the optional one then, if it is given, otherwise the required one.
|
||||
my ($cgi_opt) = grep($_->{module} eq 'CGI', @$opt_modules, @$modules);
|
||||
print ENTITIES '<!ENTITY min-mp-cgi-ver "' . $cgi_opt->{version} . '">' . "\n";
|
||||
|
||||
print ENTITIES "\n <!-- Database Versions --> \n";
|
||||
|
||||
my $db_modules = DB_MODULE;
|
||||
foreach my $db (keys %$db_modules) {
|
||||
my $dbd = $db_modules->{$db}->{dbd};
|
||||
my $name = $dbd->{module};
|
||||
$name =~ s/::/-/g;
|
||||
$name = lc($name);
|
||||
my $version = $dbd->{version} || 'any';
|
||||
my $db_version = $db_modules->{$db}->{'db_version'};
|
||||
print ENTITIES '<!ENTITY min-' . $name . '-ver "'.$version.'">' . "\n";
|
||||
print ENTITIES '<!ENTITY min-' . lc($db) . '-ver "'.$db_version.'">' . "\n";
|
||||
}
|
||||
close(ENTITIES);
|
||||
|
||||
###############################################################################
|
||||
# Subs
|
||||
###############################################################################
|
||||
|
||||
sub MakeDocs {
|
||||
|
||||
my ($name, $cmdline) = @_;
|
||||
|
||||
print "Creating $name documentation ...\n" if defined $name;
|
||||
print "$cmdline\n\n";
|
||||
system $cmdline;
|
||||
print "\n";
|
||||
|
||||
}
|
||||
|
||||
sub make_pod {
|
||||
|
||||
print "Creating API documentation...\n";
|
||||
|
||||
my $converter = Pod::Simple::HTMLBatch::Bugzilla->new;
|
||||
# Don't output progress information.
|
||||
$converter->verbose(0);
|
||||
$converter->html_render_class('Pod::Simple::HTML::Bugzilla');
|
||||
|
||||
my $doctype = Pod::Simple::HTML::Bugzilla->DOCTYPE;
|
||||
my $content_type = Pod::Simple::HTML::Bugzilla->META_CT;
|
||||
my $bz_version = BUGZILLA_VERSION;
|
||||
|
||||
my $contents_start = <<END_HTML;
|
||||
$doctype
|
||||
<html>
|
||||
<head>
|
||||
$content_type
|
||||
<title>Bugzilla $bz_version API Documentation</title>
|
||||
</head>
|
||||
<body class="contentspage">
|
||||
<h1>Bugzilla $bz_version API Documentation</h1>
|
||||
END_HTML
|
||||
|
||||
$converter->contents_page_start($contents_start);
|
||||
$converter->contents_page_end("</body></html>");
|
||||
$converter->add_css('./../../../style.css');
|
||||
$converter->javascript_flurry(0);
|
||||
$converter->css_flurry(0);
|
||||
$converter->batch_convert(['../../'], 'html/api/');
|
||||
|
||||
print "\n";
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
# Make the docs ...
|
||||
###############################################################################
|
||||
|
||||
my @langs;
|
||||
# search for sub directories which have a 'xml' sub-directory
|
||||
opendir(LANGS, './');
|
||||
foreach my $dir (readdir(LANGS)) {
|
||||
next if (($dir eq '.') || ($dir eq '..') || (! -d $dir));
|
||||
if (-d "$dir/xml") {
|
||||
push(@langs, $dir);
|
||||
}
|
||||
}
|
||||
closedir(LANGS);
|
||||
|
||||
my $docparent = getcwd();
|
||||
foreach my $lang (@langs) {
|
||||
chdir "$docparent/$lang";
|
||||
MakeDocs(undef, 'cp ../bugzilla.ent ./xml/');
|
||||
|
||||
if (!-d 'txt') {
|
||||
unlink 'txt';
|
||||
mkdir 'txt', 0755;
|
||||
}
|
||||
if (!-d 'pdf') {
|
||||
unlink 'pdf';
|
||||
mkdir 'pdf', 0755;
|
||||
}
|
||||
if (!-d 'html') {
|
||||
unlink 'html';
|
||||
mkdir 'html', 0755;
|
||||
}
|
||||
if (!-d 'html/api') {
|
||||
unlink 'html/api';
|
||||
mkdir 'html/api', 0755;
|
||||
}
|
||||
|
||||
MakeDocs(undef, 'cp ../style.css html/api/');
|
||||
|
||||
make_pod() if $pod_simple;
|
||||
|
||||
MakeDocs('separate HTML', 'xmlto -m ../xsl/chunks.xsl -o html html ' .
|
||||
'xml/Bugzilla-Guide.xml');
|
||||
MakeDocs('big HTML', 'xmlto -m ../xsl/nochunks.xsl -o html html-nochunks ' .
|
||||
'xml/Bugzilla-Guide.xml');
|
||||
MakeDocs('big text', "lynx -dump -justify=off -nolist html/Bugzilla-Guide.html " .
|
||||
"> txt/Bugzilla-Guide.txt");
|
||||
|
||||
if (! grep($_ eq "--with-pdf", @ARGV)) {
|
||||
next;
|
||||
}
|
||||
|
||||
MakeDocs('PDF', 'xmlto -m ../xsl/pdf.xsl -o pdf pdf xml/Bugzilla-Guide.xml');
|
||||
}
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
/* The contents of this file are subject to the Mozilla Public
|
||||
* License Version 1.1 (the "License"); you may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of
|
||||
* the License at http://www.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License.
|
||||
*
|
||||
* The Original Code is the Bugzilla Bug Tracking System.
|
||||
*
|
||||
* The Initial Developer of the Original Code is Everything Solved.
|
||||
* Portions created by Everything Solved are Copyright (C) 2006
|
||||
* Everything Solved. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
|
||||
*/
|
||||
|
||||
body {
|
||||
background: white;
|
||||
color: #111;
|
||||
padding: 0 1em;
|
||||
margin: 0;
|
||||
font-family: Verdana, Arial, sans-serif;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
td, th {
|
||||
font-family: Verdana, Arial, sans-serif;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
a:link, a:active { color: #36415c; }
|
||||
a:visited { color: #666; }
|
||||
a:hover { color: #888; }
|
||||
|
||||
h1 {
|
||||
font-size: 150%;
|
||||
font-weight: bold;
|
||||
border-bottom: 2px solid #ccc;
|
||||
}
|
||||
h2 {
|
||||
font-size: 125%;
|
||||
font-weight: bold;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
h3 {
|
||||
font-size: 115%;
|
||||
font-weight: bold;
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
/* This makes Description/Params/Returns look nice. */
|
||||
dd { margin-top: .2em; }
|
||||
dd p { margin-top: 0; }
|
||||
dl { margin-bottom: 1em; }
|
||||
|
||||
/* This makes the names of functions slightly larger, in Gecko. */
|
||||
body > dl > dt code { font-size: 1.35em; }
|
||||
|
||||
#pod h1 a, #pod h2 a, #pod h3 a {
|
||||
color: #36415c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
pre, code, tt, kbd, samp {
|
||||
/* Unfortunately, the default monospace fonts on most browsers
|
||||
look odd with relative sizing. */
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
.code {
|
||||
background: #eed;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
pre.code {
|
||||
margin-left: 10px;
|
||||
width: 90%;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
/* Special styles for the Contents page */
|
||||
|
||||
.contentspage dt {
|
||||
font-size: large;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.pod_desc_table {
|
||||
border-collapse: collapse;
|
||||
table-layout: auto;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.pod_desc_table th {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.pod_desc_table td, .pod_desc_table th {
|
||||
padding: .25em;
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.pod_desc_table .odd th, .pod_desc_table .odd td {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
.pod_desc_table
|
||||
@@ -1,102 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<!-- Nicer Filenames -->
|
||||
<xsl:param name="use.id.as.filename" select="1"/>
|
||||
|
||||
<!-- Label sections if they aren't automatically labeled -->
|
||||
<xsl:param name="section.autolabel" select="1"/>
|
||||
|
||||
<!-- Table of Contents Depth -->
|
||||
<xsl:param name="toc.section.depth">1</xsl:param>
|
||||
|
||||
<!-- Set chunk parameters -->
|
||||
<xsl:param name="chunk.section.depth" select="1"/>
|
||||
<xsl:param name="chunk.first.sections" select="1"/>
|
||||
<xsl:param name="chunker.output.encoding" select="UTF-8"/>
|
||||
|
||||
<!-- Show titles of next/previous page -->
|
||||
<xsl:param name="navig.showtitles">1</xsl:param>
|
||||
|
||||
<!-- Tidy up the HTML a bit... -->
|
||||
<xsl:param name="html.cleanup" select="1"/>
|
||||
<xsl:param name="make.valid.html" select="1"/>
|
||||
<xsl:param name="html.stylesheet">api/style.css</xsl:param>
|
||||
<!-- make links nicer... -->
|
||||
<xsl:param name="refentry.generate.title" select="1"/>
|
||||
<xsl:param name="refentry.generate.name" select="0"/>
|
||||
|
||||
<!-- Use Graphics, specify their Path and Extension -->
|
||||
<xsl:param name="admon.graphics" select="1"/>
|
||||
<xsl:param name="admon.graphics.path">../images/</xsl:param>
|
||||
<xsl:param name="admon.graphics.extension">.gif</xsl:param>
|
||||
|
||||
<xsl:param name="qanda.inherit.numeration" select="0" />
|
||||
|
||||
<!--
|
||||
****
|
||||
CODE BELOW HERE IS EXTRACTED AND EDITED FROM THE DOCBOOK XSL SOURCES
|
||||
****
|
||||
-->
|
||||
|
||||
<xsl:template match="simplelist[@type='inline']/member">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
<!--
|
||||
To generate valid HTML, we need to redefine this section... Code extracted from
|
||||
http://cvs.sourceforge.net/viewcvs.py/docbook/xsl/html/qandaset.xsl?rev=1.19&view=log
|
||||
|
||||
and modified below. Basic change: Remove the colspan attribute of the tr tags - no
|
||||
other changes have been made to the document.
|
||||
-->
|
||||
|
||||
<xsl:template match="qandadiv">
|
||||
<xsl:variable name="preamble" select="*[name(.) != 'title'
|
||||
and name(.) != 'titleabbrev'
|
||||
and name(.) != 'qandadiv'
|
||||
and name(.) != 'qandaentry']"/>
|
||||
|
||||
<xsl:if test="blockinfo/title|title">
|
||||
<tr class="qandadiv">
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:call-template name="anchor">
|
||||
<xsl:with-param name="conditional" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="(blockinfo/title|title)[1]"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
|
||||
<xsl:variable name="toc">
|
||||
<xsl:call-template name="dbhtml-attribute">
|
||||
<xsl:with-param name="pis"
|
||||
select="processing-instruction('dbhtml')"/>
|
||||
<xsl:with-param name="attribute" select="'toc'"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:variable name="toc.params">
|
||||
<xsl:call-template name="find.path.params">
|
||||
<xsl:with-param name="table" select="normalize-space($generate.toc)"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:if test="(contains($toc.params, 'toc') and $toc != '0') or $toc = '1'">
|
||||
<tr class="toc">
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:call-template name="process.qanda.toc"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
<xsl:if test="$preamble">
|
||||
<tr class="toc" >
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:apply-templates select="$preamble"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
<xsl:apply-templates select="qandadiv|qandaentry"/>
|
||||
</xsl:template>
|
||||
</xsl:stylesheet>
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
<!-- Include default bugzilla XSL -->
|
||||
<xsl:include href="bugzilla-docs.xsl"/>
|
||||
<!-- Set Chunk Specific XSL Params -->
|
||||
<xsl:param name="chunker.output.doctype-public">-//W3C//DTD HTML 4.01 Transitional//EN</xsl:param>
|
||||
<xsl:param name="chunker.output.doctype-system">http://www.w3.org/TR/html4/loose.dtd</xsl:param>
|
||||
<xsl:param name="chunk.section.depth" select="1"/>
|
||||
<xsl:param name="chunk.first.sections" select="1"/>
|
||||
<!-- Don't output filename list - mimic old behaviour-->
|
||||
<xsl:param name="chunk.quietly" select="0" />
|
||||
</xsl:stylesheet>
|
||||
@@ -1,6 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
<!-- Include default bugzilla XSL -->
|
||||
<xsl:include href="bugzilla-docs.xsl"/>
|
||||
<!-- No other params necessary -->
|
||||
</xsl:stylesheet>
|
||||
@@ -1,19 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
|
||||
<!-- Enable passivetex extensions -->
|
||||
<xsl:param name="passivetex.extensions" select="1"/>
|
||||
<xsl:param name="tablecolumns.extensions" select="1"/>
|
||||
|
||||
<!-- Show <ulink>s as footnotes -->
|
||||
<xsl:param name="ulink.footnotes" select="1" />
|
||||
<xsl:param name="ulink.show" select="1" />
|
||||
|
||||
<!-- Don't use Graphics -->
|
||||
<xsl:param name="admon.graphics" select="0"/>
|
||||
<xsl:param name="callout.graphics" select="'0'"/>
|
||||
|
||||
<xsl:template match="simplelist[@type='inline']/member">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
5
mozilla/webtools/uninstall_survey/.htaccess
Normal file
5
mozilla/webtools/uninstall_survey/.htaccess
Normal file
@@ -0,0 +1,5 @@
|
||||
<IfModule mod_rewrite.c>
|
||||
RewriteEngine on
|
||||
RewriteRule ^$ webroot/ [L]
|
||||
RewriteRule (.*) webroot/$1 [L]
|
||||
</IfModule>
|
||||
69
mozilla/webtools/uninstall_survey/app_controller.php
Normal file
69
mozilla/webtools/uninstall_survey/app_controller.php
Normal file
@@ -0,0 +1,69 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: app_controller.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Short description for file.
|
||||
*
|
||||
* This file is application-wide controller file. You can put all
|
||||
* application-wide controller-related methods here.
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.cake
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* Short description for class.
|
||||
*
|
||||
* Add your application-wide methods in the class below, your controllers
|
||||
* will inherit them.
|
||||
*
|
||||
* @package cake
|
||||
* @subpackage cake.cake
|
||||
*/
|
||||
|
||||
uses('Sanitize');
|
||||
|
||||
class AppController extends Controller {
|
||||
|
||||
/**
|
||||
* This function is intended to be used with url parameters when passing them to
|
||||
* a view. (This is useful when echoing values out in <input> tags, etc.
|
||||
* Note that the keys to the arrays are escaped as well.
|
||||
*
|
||||
* @param array dirty parameters
|
||||
* @return array cleaned values
|
||||
*/
|
||||
function decodeAndSanitize($params)
|
||||
{
|
||||
$clean = array();
|
||||
|
||||
foreach ($params as $var => $val) {
|
||||
$var = $this->Sanitize->html(urldecode($var));
|
||||
$val = $this->Sanitize->html(urldecode($val));
|
||||
|
||||
$clean[$var] = $val;
|
||||
}
|
||||
|
||||
return $clean;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
72
mozilla/webtools/uninstall_survey/app_model.php
Normal file
72
mozilla/webtools/uninstall_survey/app_model.php
Normal file
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: app_model.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Application model for Cake.
|
||||
*
|
||||
* This file is application-wide model file. You can put all
|
||||
* application-wide model-related methods here.
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.cake
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* Application model for Cake.
|
||||
*
|
||||
* Add your application-wide methods in the class below, your models
|
||||
* will inherit them.
|
||||
*
|
||||
* @package cake
|
||||
* @subpackage cake.cake
|
||||
*/
|
||||
|
||||
uses('sanitize');
|
||||
|
||||
class AppModel extends Model {
|
||||
|
||||
/**
|
||||
* Will clean arrays for input into SQL.
|
||||
* Note that the array keys are getting cleaned here as well. If you're using strings
|
||||
* (with escapable characters in them) as keys to your array, be extra careful.
|
||||
*
|
||||
* @access public
|
||||
* @param array to be cleaned
|
||||
* @return array with sql escaped
|
||||
*/
|
||||
function cleanArrayForSql($array)
|
||||
{
|
||||
$sanitize = new Sanitize();
|
||||
$clean = array();
|
||||
|
||||
foreach ($array as $var => $val)
|
||||
{
|
||||
$var = $sanitize->sql($var);
|
||||
$val = $sanitize->sql($val);
|
||||
$clean[$var] = $val;
|
||||
}
|
||||
|
||||
return $clean;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
?>
|
||||
76
mozilla/webtools/uninstall_survey/config/acl.ini.php
Normal file
76
mozilla/webtools/uninstall_survey/config/acl.ini.php
Normal file
@@ -0,0 +1,76 @@
|
||||
;<?php die() ?>
|
||||
; SVN FILE: $Id: acl.ini.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $
|
||||
;/**
|
||||
; * Short description for file.
|
||||
; *
|
||||
; *
|
||||
; * PHP versions 4 and 5
|
||||
; *
|
||||
; * CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
; * Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
; * 1785 E. Sahara Avenue, Suite 490-204
|
||||
; * Las Vegas, Nevada 89104
|
||||
; *
|
||||
; * Licensed under The MIT License
|
||||
; * Redistributions of files must retain the above copyright notice.
|
||||
; *
|
||||
; * @filesource
|
||||
; * @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
; * @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
; * @package cake
|
||||
; * @subpackage cake.app.config
|
||||
; * @since CakePHP v 0.10.0.1076
|
||||
; * @version $Revision: 1.1.1.1 $
|
||||
; * @modifiedby $LastChangedBy: phpnut $
|
||||
; * @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
; * @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
; */
|
||||
|
||||
; acl.ini.php - Cake ACL Configuration
|
||||
; ---------------------------------------------------------------------
|
||||
; Use this file to specify user permissions.
|
||||
; aco = access control object (something in your application)
|
||||
; aro = access request object (something requesting access)
|
||||
;
|
||||
; User records are added as follows:
|
||||
;
|
||||
; [uid]
|
||||
; groups = group1, group2, group3
|
||||
; allow = aco1, aco2, aco3
|
||||
; deny = aco4, aco5, aco6
|
||||
;
|
||||
; Group records are added in a similar manner:
|
||||
;
|
||||
; [gid]
|
||||
; allow = aco1, aco2, aco3
|
||||
; deny = aco4, aco5, aco6
|
||||
;
|
||||
; The allow, deny, and groups sections are all optional.
|
||||
; NOTE: groups names *cannot* ever be the same as usernames!
|
||||
;
|
||||
; ACL permissions are checked in the following order:
|
||||
; 1. Check for user denies (and DENY if specified)
|
||||
; 2. Check for user allows (and ALLOW if specified)
|
||||
; 3. Gather user's groups
|
||||
; 4. Check group denies (and DENY if specified)
|
||||
; 5. Check group allows (and ALLOW if specified)
|
||||
; 6. If no aro, aco, or group information is found, DENY
|
||||
;
|
||||
; ---------------------------------------------------------------------
|
||||
|
||||
;-------------------------------------
|
||||
;Users
|
||||
;-------------------------------------
|
||||
|
||||
[username-goes-here]
|
||||
groups = group1, group2
|
||||
deny = aco1, aco2
|
||||
allow = aco3, aco4
|
||||
|
||||
;-------------------------------------
|
||||
;Groups
|
||||
;-------------------------------------
|
||||
|
||||
[groupname-goes-here]
|
||||
deny = aco5, aco6
|
||||
allow = aco7, aco8
|
||||
50
mozilla/webtools/uninstall_survey/config/bootstrap.php
Normal file
50
mozilla/webtools/uninstall_survey/config/bootstrap.php
Normal file
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: bootstrap.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Short description for file.
|
||||
*
|
||||
* Long description for file
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.config
|
||||
* @since CakePHP v 0.10.8.2117
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
*
|
||||
* This file is loaded automatically by the app/webroot/index.php file after the core bootstrap.php is loaded
|
||||
* This is an application wide file to load any function that is not used within a class define.
|
||||
* You can also use this to include or require any files in your application.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* The settings below can be used to set additional paths to models, views and controllers.
|
||||
* This is related to Ticket #470 (https://trac.cakephp.org/ticket/470)
|
||||
*
|
||||
* $modelPaths = array('full path to models', 'second full path to models', 'etc...');
|
||||
* $viewPaths = array('this path to views', 'second full path to views', 'etc...');
|
||||
* $controllerPaths = array('this path to controllers', 'second full path to controllers', 'etc...');
|
||||
*
|
||||
*/
|
||||
|
||||
//EOF
|
||||
?>
|
||||
153
mozilla/webtools/uninstall_survey/config/core.php
Normal file
153
mozilla/webtools/uninstall_survey/config/core.php
Normal file
@@ -0,0 +1,153 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: core.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* This is core configuration file.
|
||||
*
|
||||
* Use it to configure core behaviour ofCake.
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.config
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* If you do not have mod rewrite on your system
|
||||
* or if you prefer to use CakePHP pretty urls.
|
||||
* uncomment the line below.
|
||||
* Note: If you do have mod rewrite but prefer the
|
||||
* CakePHP pretty urls, you also have to remove the
|
||||
* .htaccess files
|
||||
* release/.htaccess
|
||||
* release/app/.htaccess
|
||||
* release/app/webroot/.htaccess
|
||||
*/
|
||||
//define ('BASE_URL', env('SCRIPT_NAME'));
|
||||
|
||||
/**
|
||||
* Set debug level here:
|
||||
* - 0: production
|
||||
* - 1: development
|
||||
* - 2: full debug with sql
|
||||
* - 3: full debug with sql and dump of the current object
|
||||
*
|
||||
* In production, the "flash messages" redirect after a time interval.
|
||||
* With the other debug levels you get to click the "flash message" to continue.
|
||||
*
|
||||
*/
|
||||
define('DEBUG', 0);
|
||||
/**
|
||||
* Turn of caching checking wide.
|
||||
* You must still use the controller var cacheAction inside you controller class.
|
||||
* You can either set it controller wide, or in each controller method.
|
||||
* use var $cacheAction = true; or in the controller method $this->cacheAction = true;
|
||||
*/
|
||||
define ('CACHE_CHECK', false);
|
||||
/**
|
||||
* Error constant. Used for differentiating error logging and debugging.
|
||||
* Currently PHP supports LOG_DEBUG
|
||||
*/
|
||||
define ('LOG_ERROR', 2);
|
||||
/**
|
||||
* CakePHP includes 3 types of session saves
|
||||
* database or file. Set this to your preferred method.
|
||||
* If you want to use your own save handler place it in
|
||||
* app/config/name.php DO NOT USE file or database as the name.
|
||||
* and use just the name portion below.
|
||||
*
|
||||
* Setting this to cake will save files to /cakedistro/tmp directory
|
||||
* Setting it to php will use the php default save path
|
||||
* Setting it to database will use the database
|
||||
*
|
||||
*
|
||||
*/
|
||||
define('CAKE_SESSION_SAVE', 'php');
|
||||
/**
|
||||
* Set a random string of used in session.
|
||||
*
|
||||
*/
|
||||
define('CAKE_SESSION_STRING', 'DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi');
|
||||
/**
|
||||
* Set the name of session cookie
|
||||
*
|
||||
*/
|
||||
define('CAKE_SESSION_COOKIE', 'CAKEPHP');
|
||||
|
||||
/**
|
||||
* Set level of Cake security.
|
||||
*
|
||||
*/
|
||||
define('CAKE_SECURITY', 'high');
|
||||
|
||||
/**
|
||||
* Set Cake Session time out.
|
||||
* If CAKE_SECURITY define is set
|
||||
* high: multiplied by 10
|
||||
* medium: is multiplied by 100
|
||||
* low is: multiplied by 300
|
||||
*
|
||||
* Number below is seconds.
|
||||
*/
|
||||
define('CAKE_SESSION_TIMEOUT', '120');
|
||||
|
||||
/**
|
||||
* Uncomment the define below to use cake built in admin routes.
|
||||
* You can set this value to anything you want.
|
||||
* All methods related to the admin route should be prefixed with the
|
||||
* name you set CAKE_ADMIN to.
|
||||
* For example: admin_index, admin_edit
|
||||
*/
|
||||
//define('CAKE_ADMIN', 'admin');
|
||||
|
||||
/**
|
||||
* The define below is used to turn cake built webservices
|
||||
* on or off. Default setting is off.
|
||||
*/
|
||||
define('WEBSERVICES', 'off');
|
||||
|
||||
/**
|
||||
* Compress output CSS (removing comments, whitespace, repeating tags etc.)
|
||||
* This requires a/var/cache directory to be writable by the web server (caching).
|
||||
* To use, prefix the CSS link URL with '/ccss/' instead of '/css/' or use Controller::cssTag().
|
||||
*/
|
||||
define('COMPRESS_CSS', false);
|
||||
|
||||
/**
|
||||
* If set to true, helpers would output data instead of returning it.
|
||||
*/
|
||||
define('AUTO_OUTPUT', false);
|
||||
|
||||
/**
|
||||
* If set to false, session would not automatically be started.
|
||||
*/
|
||||
define('AUTO_SESSION', true);
|
||||
|
||||
/**
|
||||
* Set the max size of file to use md5() .
|
||||
*/
|
||||
define('MAX_MD5SIZE', (5*1024)*1024 );
|
||||
|
||||
/**
|
||||
* To use Access Control Lists with Cake...
|
||||
*/
|
||||
define('ACL_CLASSNAME', 'DB_ACL');
|
||||
define('ACL_FILENAME', 'dbacl'.DS.'db_acl');
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,79 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: database.php.default,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* This is core configuration file.
|
||||
*
|
||||
* Use it to configure core behaviour ofCake.
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.config
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* In this file you set up your database connection details.
|
||||
*
|
||||
* @package cake
|
||||
* @subpackage cake.config
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Database configuration class.
|
||||
* You can specify multiple configurations for production, development and testing.
|
||||
*
|
||||
* driver =>
|
||||
* mysql, postgres, sqlite, adodb-drivername, pear-drivername
|
||||
*
|
||||
* connect =>
|
||||
* MySQL set the connect to either mysql_pconnect of mysql_connect
|
||||
* PostgreSQL set the connect to either pg_pconnect of pg_connect
|
||||
* SQLite set the connect to sqlite_popen sqlite_open
|
||||
* ADOdb set the connect to one of these
|
||||
* (http://phplens.com/adodb/supported.databases.html) and
|
||||
* append it '|p' for persistent connection. (mssql|p for example, or just mssql for not persistent)
|
||||
*
|
||||
* host =>
|
||||
* the host you connect to the database
|
||||
* MySQL 'localhost' to add a port number use 'localhost:port#'
|
||||
* PostgreSQL 'localhost' to add a port number use 'localhost port=5432'
|
||||
*
|
||||
*/
|
||||
class DATABASE_CONFIG
|
||||
{
|
||||
var $default = array('driver' => 'mysql',
|
||||
'connect' => 'mysql_connect',
|
||||
'host' => 'localhost',
|
||||
'login' => 'user',
|
||||
'password' => 'password',
|
||||
'database' => 'project_name',
|
||||
'prefix' => '');
|
||||
|
||||
var $test = array('driver' => 'mysql',
|
||||
'connect' => 'mysql_connect',
|
||||
'host' => 'localhost',
|
||||
'login' => 'user',
|
||||
'password' => 'password',
|
||||
'database' => 'project_name-test',
|
||||
'prefix' => '');
|
||||
}
|
||||
|
||||
?>
|
||||
74
mozilla/webtools/uninstall_survey/config/inflections.php
Normal file
74
mozilla/webtools/uninstall_survey/config/inflections.php
Normal file
@@ -0,0 +1,74 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: inflections.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Custom Inflected Words.
|
||||
*
|
||||
* This file is used to hold words that are not matched in the normail Inflector::pluralize() and
|
||||
* Inflector::singularize()
|
||||
*
|
||||
* PHP versions 4 and %
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.config
|
||||
* @since CakePHP v 1.0.0.2312
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* This is a key => value array of regex used to match words.
|
||||
* If key matches then the value is returned.
|
||||
*
|
||||
* $pluralRules = array('/(s)tatus$/i' => '\1\2tatuses', '/^(ox)$/i' => '\1\2en', '/([m|l])ouse$/i' => '\1ice');
|
||||
*/
|
||||
$pluralRules = array();
|
||||
/**
|
||||
* This is a key only array of plural words that should not be inflected.
|
||||
* Notice the last comma
|
||||
*
|
||||
* $uninflectedPlural = array('.*[nrlm]ese', '.*deer', '.*fish', '.*measles', '.*ois', '.*pox');
|
||||
*/
|
||||
$uninflectedPlural = array();
|
||||
/**
|
||||
* This is a key => value array of plural irregular words.
|
||||
* If key matches then the value is returned.
|
||||
*
|
||||
* $irregularPlural = array('atlas' => 'atlases', 'beef' => 'beefs', 'brother' => 'brothers')
|
||||
*/
|
||||
$irregularPlural = array();
|
||||
/**
|
||||
* This is a key => value array of regex used to match words.
|
||||
* If key matches then the value is returned.
|
||||
*
|
||||
* $singularRules = array('/(s)tatuses$/i' => '\1\2tatus', '/(matr)ices$/i' =>'\1ix','/(vert|ind)ices$/i')
|
||||
*/
|
||||
$singularRules = array();
|
||||
/**
|
||||
* This is a key only array of singular words that should not be inflected.
|
||||
* You should not have to change this value below if you do change it use same format
|
||||
* as the $uninflectedPlural above.
|
||||
*/
|
||||
$uninflectedSingular = $uninflectedPlural;
|
||||
/**
|
||||
* This is a key => value array of singular irregular words.
|
||||
* Most of the time this will be a reverse of the above $irregularPlural array
|
||||
* You should not have to change this value below if you do change it use same format
|
||||
*
|
||||
* $irregularSingular = array('atlases' => 'atlas', 'beefs' => 'beef', 'brothers' => 'brother')
|
||||
*/
|
||||
$irregularSingular = array_flip($irregularPlural);
|
||||
?>
|
||||
51
mozilla/webtools/uninstall_survey/config/routes.php
Normal file
51
mozilla/webtools/uninstall_survey/config/routes.php
Normal file
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: routes.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Short description for file.
|
||||
*
|
||||
* In this file, you set up routes to your controllers and their actions.
|
||||
* Routes are very important mechanism that allows you to freely connect
|
||||
* different urls to chosen controllers and their actions (functions).
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.config
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* Here, we are connecting '/' (base path) to controller called 'Pages',
|
||||
* its action called 'display', and we pass a param to select the view file
|
||||
* to use (in this case, /app/views/pages/home.thtml)...
|
||||
*/
|
||||
$Route->connect ('/', array('controller'=>'results', 'action'=>'', ''));
|
||||
|
||||
/**
|
||||
* ...and connect the rest of 'Pages' controller's urls.
|
||||
*/
|
||||
$Route->connect ('/pages/*', array('controller'=>'pages', 'action'=>'display'));
|
||||
|
||||
/**
|
||||
* Then we connect url '/test' to our test controller. This is helpfull in
|
||||
* developement.
|
||||
*/
|
||||
$Route->connect ('/tests', array('controller'=>'tests', 'action'=>'index'));
|
||||
|
||||
?>
|
||||
30
mozilla/webtools/uninstall_survey/config/sql/db_acl.sql
Normal file
30
mozilla/webtools/uninstall_survey/config/sql/db_acl.sql
Normal file
@@ -0,0 +1,30 @@
|
||||
CREATE TABLE `acos` (
|
||||
`id` int(11) NOT NULL auto_increment,
|
||||
`model` varchar(255) NOT NULL default '',
|
||||
`object_id` int(11) default NULL,
|
||||
`alias` varchar(255) NOT NULL default '',
|
||||
`lft` int(11) default NULL,
|
||||
`rght` int(11) default NULL,
|
||||
PRIMARY KEY (`id`)
|
||||
);
|
||||
|
||||
CREATE TABLE `aros` (
|
||||
`id` int(11) NOT NULL auto_increment,
|
||||
`model` varchar(255) NOT NULL default '',
|
||||
`user_id` int(11) default NULL,
|
||||
`alias` varchar(255) NOT NULL default '',
|
||||
`lft` int(11) default NULL,
|
||||
`rght` int(11) default NULL,
|
||||
PRIMARY KEY (`id`)
|
||||
);
|
||||
|
||||
CREATE TABLE `aros_acos` (
|
||||
`id` int(11) NOT NULL auto_increment,
|
||||
`aro_id` int(11) default NULL,
|
||||
`aco_id` int(11) default NULL,
|
||||
`_create` int(1) NOT NULL default '0',
|
||||
`_read` int(1) NOT NULL default '0',
|
||||
`_update` int(1) NOT NULL default '0',
|
||||
`_delete` int(11) NOT NULL default '0',
|
||||
PRIMARY KEY (`id`)
|
||||
);
|
||||
11
mozilla/webtools/uninstall_survey/config/sql/sessions.sql
Normal file
11
mozilla/webtools/uninstall_survey/config/sql/sessions.sql
Normal file
@@ -0,0 +1,11 @@
|
||||
-- @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
-- @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
-- @since CakePHP v 0.10.8.1997
|
||||
-- @version $Revision: 1.1.1.1 $
|
||||
|
||||
CREATE TABLE cake_sessions (
|
||||
id varchar(255) NOT NULL default '',
|
||||
data text,
|
||||
expires int(11) default NULL,
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
class ApplicationsController extends AppController {
|
||||
|
||||
var $name = 'Applications';
|
||||
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
class IntentionsController extends AppController {
|
||||
|
||||
var $name = 'Intentions';
|
||||
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
class IssuesController extends AppController {
|
||||
|
||||
var $name = 'Issues';
|
||||
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,122 @@
|
||||
<?php
|
||||
|
||||
/* Include the CSV library. It would be nice to make this OO sometime */
|
||||
vendor('csv/csv');
|
||||
|
||||
class ResultsController extends AppController {
|
||||
|
||||
var $name = 'Results';
|
||||
|
||||
/**
|
||||
* Model's this controller uses
|
||||
* @var array
|
||||
*/
|
||||
var $uses = array('Application','Result');
|
||||
|
||||
/**
|
||||
* Cake Helpers
|
||||
* @var array
|
||||
*/
|
||||
var $helpers = array('Html', 'Javascript', 'Export', 'Pagination','Time');
|
||||
|
||||
/**
|
||||
* Pagination helper variable array
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
var $pagination_parameters = array();
|
||||
|
||||
/**
|
||||
* Will hold a sanitize object
|
||||
* @var object
|
||||
*/
|
||||
var $Sanitize;
|
||||
|
||||
/**
|
||||
* Constructor - sets up the sanitizer and the pagination
|
||||
*/
|
||||
function ResultsController()
|
||||
{
|
||||
parent::AppController();
|
||||
|
||||
$this->Sanitize = new Sanitize();
|
||||
|
||||
// Pagination Stuff
|
||||
$this->pagination_parameters['show'] = empty($_GET['show'])? '10' : $this->Sanitize->paranoid($_GET['show']);
|
||||
$this->pagination_parameters['sortBy'] = empty($_GET['sort'])? 'created' : $this->Sanitize->paranoid($_GET['sort']);
|
||||
$this->pagination_parameters['direction'] = empty($_GET['direction'])? 'desc': $this->Sanitize->paranoid($_GET['direction']);
|
||||
$this->pagination_parameters['page'] = empty($_GET['page'])? '1': $this->Sanitize->paranoid($_GET['page']);
|
||||
$this->pagination_parameters['order'] = $this->modelClass.'.'.$this->pagination_parameters['sortBy'].' '.strtoupper($this->pagination_parameters['direction']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Front page will show the graph
|
||||
*/
|
||||
function index()
|
||||
{
|
||||
// Products dropdown
|
||||
$this->set('products', $this->Application->getApplications());
|
||||
|
||||
// Fill in all the data passed in $_GET
|
||||
$this->set('url_params',$this->decodeAndSanitize($this->params['url']));
|
||||
|
||||
// We'll need to include the graphing libraries
|
||||
$this->set('include_graph_libraries', true);
|
||||
|
||||
// Core data to show on page
|
||||
$this->set('descriptionAndTotalsData',$this->Result->getDescriptionAndTotalsData($this->params['url']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Display a table of user comments
|
||||
*/
|
||||
function comments()
|
||||
{
|
||||
// Products dropdown
|
||||
$this->set('products', $this->Application->getApplications());
|
||||
|
||||
// Fill in all the data passed in $_GET
|
||||
$this->set('url_params',$this->decodeAndSanitize($this->params['url']));
|
||||
|
||||
// Pagination settings
|
||||
$paging['style'] = 'html';
|
||||
$paging['link'] = "/results/comments/?product=".urlencode($this->params['url']['product'])."&start_date=".urlencode($this->params['url']['start_date'])."&end_date=".urlencode($this->params['url']['end_date'])."&show={$this->pagination_parameters['show']}&sort={$this->pagination_parameters['sortBy']}&direction={$this->pagination_parameters['direction']}&page=";
|
||||
$paging['count'] = $this->Result->getCommentCount($this->params['url']);
|
||||
$paging['page'] = $this->pagination_parameters['page'];
|
||||
$paging['limit'] = $this->pagination_parameters['show'];
|
||||
$paging['show'] = array('10','25','50');
|
||||
|
||||
// No point in showing them an error if they click on "show 50" but they are
|
||||
// already on the last page.
|
||||
if ($paging['count'] < ($this->pagination_parameters['page'] * ($this->pagination_parameters['show']/2))) {
|
||||
$this->pagination_parameters['page'] = $paging['page'] = 1;
|
||||
}
|
||||
|
||||
// Set pagination array
|
||||
$this->set('paging',$paging);
|
||||
|
||||
// Core data to show on page
|
||||
$this->set('commentsData',$this->Result->getComments($this->params['url'], $this->pagination_parameters));
|
||||
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Display a csv
|
||||
*/
|
||||
function csv()
|
||||
{
|
||||
// Get rid of the header/footer/etc.
|
||||
$this->layout = null;
|
||||
|
||||
// Our CSV library sends headers and everything. Keep the view empty!
|
||||
csv_send_csv($this->Result->getCsvExportData($this->params['url']));
|
||||
|
||||
// I'm not exiting here in case someone is going to use post callback stuff.
|
||||
// In development, that means extra lines get added to our CSVs, but in
|
||||
// production it should be clean.
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
?>
|
||||
27
mozilla/webtools/uninstall_survey/index.php
Normal file
27
mozilla/webtools/uninstall_survey/index.php
Normal file
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: index.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app
|
||||
* @since CakePHP v 0.10.0.1076
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
require 'webroot'.DIRECTORY_SEPARATOR.'index.php';
|
||||
?>
|
||||
24
mozilla/webtools/uninstall_survey/models/application.php
Normal file
24
mozilla/webtools/uninstall_survey/models/application.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
class Application extends AppModel {
|
||||
var $name = 'Application';
|
||||
|
||||
var $hasOne = array('Result');
|
||||
|
||||
var $hasAndBelongsToMany = array(
|
||||
'Intention' => array('className' => 'Intention'),
|
||||
'Issue' => array('className' => 'Issue')
|
||||
);
|
||||
|
||||
/**
|
||||
* This was added because running findAll() on this model does a left join on the
|
||||
* results table which takes around 10 seconds to grab all the data. All I want
|
||||
* is a list of the applications...
|
||||
*
|
||||
* @return array rows representing each application
|
||||
*/
|
||||
function getApplications()
|
||||
{
|
||||
return $this->query('SELECT * FROM `applications` ORDER BY `id`');
|
||||
}
|
||||
}
|
||||
?>
|
||||
12
mozilla/webtools/uninstall_survey/models/intention.php
Normal file
12
mozilla/webtools/uninstall_survey/models/intention.php
Normal file
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
class Intention extends AppModel {
|
||||
var $name = 'Intention';
|
||||
|
||||
var $hasOne = array('Result');
|
||||
|
||||
var $hasAndBelongsToMany = array('Application' =>
|
||||
array('className' => 'Application')
|
||||
);
|
||||
|
||||
}
|
||||
?>
|
||||
10
mozilla/webtools/uninstall_survey/models/issue.php
Normal file
10
mozilla/webtools/uninstall_survey/models/issue.php
Normal file
@@ -0,0 +1,10 @@
|
||||
<?php
|
||||
class Issue extends AppModel {
|
||||
var $name = 'Issue';
|
||||
|
||||
var $hasAndBelongsToMany = array(
|
||||
'Application' => array('className' => 'Application'),
|
||||
'Result' => array('className' => 'Result')
|
||||
);
|
||||
}
|
||||
?>
|
||||
339
mozilla/webtools/uninstall_survey/models/result.php
Normal file
339
mozilla/webtools/uninstall_survey/models/result.php
Normal file
@@ -0,0 +1,339 @@
|
||||
<?php
|
||||
class Result extends AppModel {
|
||||
var $name = 'Result';
|
||||
|
||||
var $belongsTo = array('Application', 'Intention');
|
||||
|
||||
var $hasAndBelongsToMany = array('Issue' =>
|
||||
array('className' => 'Issue')
|
||||
);
|
||||
|
||||
/**
|
||||
* Count's all the comments, according to the parameters.
|
||||
* @param array URL parameters
|
||||
* @return Cake's findCount() value
|
||||
*/
|
||||
function getCommentCount($params)
|
||||
{
|
||||
// Clean parameters
|
||||
$params = $this->cleanArrayForSql($params);
|
||||
|
||||
// We only want to see rows with comments
|
||||
$_conditions = array("comments NOT LIKE ''");
|
||||
|
||||
if (!empty($params['start_date'])) {
|
||||
$_timestamp = strtotime($params['start_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
array_push($_conditions, "`created` >= '{$_date}'");
|
||||
}
|
||||
}
|
||||
if (!empty($params['end_date'])) {
|
||||
$_timestamp = strtotime($params['end_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
array_push($_conditions, "`created` <= '{$_date}'");
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['product'])) {
|
||||
// product's come in looking like:
|
||||
// Mozilla Firefox 1.5.0.1
|
||||
$_exp = explode(' ',urldecode($params['product']));
|
||||
|
||||
if(count($_exp) == 3) {
|
||||
$_product = $_exp[0].' '.$_exp[1];
|
||||
|
||||
$_version = $_exp[2];
|
||||
|
||||
/* Note that 'Application' is not the actual name of the table! You can
|
||||
* thank cake for that.*/
|
||||
array_push($_conditions, "`Application`.`name` LIKE '%{$_product}%'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '%{$_version}%'");
|
||||
} else {
|
||||
// defaults I guess?
|
||||
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
|
||||
}
|
||||
|
||||
} else {
|
||||
// I'm providing a default here, because otherwise all results will be
|
||||
// returned (across all applications) and that is not desired
|
||||
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
|
||||
}
|
||||
|
||||
// Do the actual query
|
||||
$comments = $this->findCount($_conditions);
|
||||
|
||||
return $comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Will retrieve all the comments within param's and pagination's parameters
|
||||
* @param array URL parameters
|
||||
* @param array pagination values from the controller
|
||||
* @param boolean if privacy is true phone numbers and email addresses will be
|
||||
* masked
|
||||
* @return cake result set
|
||||
*/
|
||||
function getComments($params, $pagination, $privacy=true)
|
||||
{
|
||||
$params = $this->cleanArrayForSql($params);
|
||||
|
||||
// We only want to see rows with comments
|
||||
$_conditions = array("comments NOT LIKE ''");
|
||||
|
||||
if (!empty($params['start_date'])) {
|
||||
$_timestamp = strtotime($params['start_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
array_push($_conditions, "`created` >= '{$_date}'");
|
||||
}
|
||||
}
|
||||
if (!empty($params['end_date'])) {
|
||||
$_timestamp = strtotime($params['end_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
array_push($_conditions, "`created` <= '{$_date}'");
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['product'])) {
|
||||
// product's come in looking like:
|
||||
// Mozilla Firefox 1.5.0.1
|
||||
$_exp = explode(' ',urldecode($params['product']));
|
||||
|
||||
if(count($_exp) == 3) {
|
||||
$_product = $_exp[0].' '.$_exp[1];
|
||||
|
||||
$_version = $_exp[2];
|
||||
|
||||
/* Note that 'Application' is not the actual name of the table! You can
|
||||
* thank cake for that.*/
|
||||
array_push($_conditions, "`Application`.`name` LIKE '%{$_product}%'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '%{$_version}%'");
|
||||
} else {
|
||||
// defaults I guess?
|
||||
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
|
||||
}
|
||||
|
||||
} else {
|
||||
// I'm providing a default here, because otherwise all results will be
|
||||
// returned (across all applications) and that is not desired
|
||||
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
|
||||
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
|
||||
}
|
||||
|
||||
$comments = $this->findAll($_conditions, null, $pagination['order'], $pagination['show'], $pagination['page']);
|
||||
|
||||
if ($privacy) {
|
||||
// Pull out all the email addresses and phone numbers
|
||||
foreach ($comments as $var => $val) {
|
||||
|
||||
// Handle foo@bar.com
|
||||
$_email_regex = '/\ ?(.+)?@(.+)?\.(.+)?\ ?/';
|
||||
$comments[$var]['Result']['comments'] = preg_replace($_email_regex,'$1@****.$3',$comments[$var]['Result']['comments']);
|
||||
$comments[$var]['Result']['intention_text'] = preg_replace($_email_regex,'$1@****.$3',$comments[$var]['Result']['intention_text']);
|
||||
|
||||
// Handle xxx-xxx-xxxx
|
||||
$_phone_regex = '/([0-9]{3})[ .-]?[0-9]{4}/';
|
||||
$comments[$var]['Result']['comments'] = preg_replace($_phone_regex,'$1-****',$comments[$var]['Result']['comments']);
|
||||
$comments[$var]['Result']['intention_text'] = preg_replace($_phone_regex,'$1-****',$comments[$var]['Result']['intention_text']);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return $comments;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* This function runs the query to get the export data for the CSV file.
|
||||
*
|
||||
* @param array URL parameters
|
||||
* @param boolean if privacy is true phone numbers and email addresses will be
|
||||
* masked
|
||||
* @return array two dimensional array that should be pretty easy to transform
|
||||
* into a CSV.
|
||||
*/
|
||||
function getCsvExportData($params, $privacy=true)
|
||||
{
|
||||
$params = $this->cleanArrayForSql($params);
|
||||
|
||||
// We have to use a left join here because there isn't always an intention
|
||||
$_query = "
|
||||
SELECT
|
||||
`results`.`id`,
|
||||
`results`.`created`,
|
||||
`results`.`intention_text` as `intention_other`,
|
||||
`results`.`comments`,
|
||||
`intentions`.`description` as `intention`
|
||||
FROM `results`
|
||||
LEFT JOIN `intentions` ON `results`.`intention_id`=`intentions`.`id`
|
||||
INNER JOIN `applications` ON `applications`.`id` = `results`.`application_id`
|
||||
WHERE
|
||||
1=1
|
||||
";
|
||||
|
||||
if (!empty($params['start_date'])) {
|
||||
$_timestamp = strtotime($params['start_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
$_query .= " AND `results`.`created` >= '{$_date}'";
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['end_date'])) {
|
||||
$_timestamp = strtotime($params['end_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
$_query .= " AND `results`.`created` <= '{$_date}'";
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['product'])) {
|
||||
// product's come in looking like:
|
||||
// Mozilla Firefox 1.5.0.1
|
||||
$_exp = explode(' ',urldecode($params['product']));
|
||||
|
||||
if(count($_exp) == 3) {
|
||||
$_product = $_exp[0].' '.$_exp[1];
|
||||
|
||||
$_version = $_exp[2];
|
||||
|
||||
$_query .= " AND `applications`.`name` LIKE '{$_product}'";
|
||||
$_query .= " AND `applications`.`version` LIKE '{$_version}'";
|
||||
} else {
|
||||
// defaults I guess?
|
||||
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
|
||||
$_query .= " AND `applications`.`version` LIKE '1.5'";
|
||||
}
|
||||
} else {
|
||||
// I'm providing a default here, because otherwise all results will be
|
||||
// returned (across all applications) and that is not desired
|
||||
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
|
||||
$_query .= " AND `applications`.`version` LIKE '1.5'";
|
||||
}
|
||||
|
||||
$_query .= " ORDER BY `results`.`created` ASC";
|
||||
|
||||
$res = $this->query($_query);
|
||||
|
||||
// Since we're exporting to a CSV, we need to flatten the results into a 2
|
||||
// dimensional table array
|
||||
$newdata = array();
|
||||
|
||||
foreach ($res as $result) {
|
||||
|
||||
$newdata[] = array_merge($result['results'], $result['intentions']);
|
||||
}
|
||||
|
||||
if ($privacy) {
|
||||
// Pull out all the email addresses and phone numbers
|
||||
foreach ($newdata as $var => $val) {
|
||||
|
||||
// Handle foo@bar.com
|
||||
$_email_regex = '/\ ?(.+)?@(.+)?\.(.+)?\ ?/';
|
||||
$newdata[$var]['comments'] = preg_replace($_email_regex,'$1@****.$3',$newdata[$var]['comments']);
|
||||
$newdata[$var]['intention_other'] = preg_replace($_email_regex,'$1@****.$3',$newdata[$var]['intention_other']);
|
||||
|
||||
// Handle xxx-xxx-xxxx
|
||||
$_phone_regex = '/([0-9]{3})[ .-]?[0-9]{4}/';
|
||||
$newdata[$var]['comments'] = preg_replace($_phone_regex,'$1-****',$newdata[$var]['comments']);
|
||||
$newdata[$var]['intention_other'] = preg_replace($_phone_regex,'$1-****',$newdata[$var]['intention_other']);
|
||||
}
|
||||
}
|
||||
|
||||
// Our CSV library just prints out everything in order, so we have to put the
|
||||
// column labels on here ourselves
|
||||
$newdata = array_merge(array(array_keys($newdata[0])), $newdata);
|
||||
|
||||
return $newdata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Will retrieve the information used for graphing.
|
||||
* @param the url parameters (unescaped)
|
||||
* @return a result set
|
||||
*/
|
||||
function getDescriptionAndTotalsData($params)
|
||||
{
|
||||
// Clean parameters for inserting into SQL
|
||||
$params = $this->cleanArrayForSql($params);
|
||||
|
||||
/* It would be nice to drop something like this in the SELECT:
|
||||
*
|
||||
* CONCAT(COUNT(*)/(SELECT COUNT(*) FROM our_giant_query_all_over_again)*100,'%') AS `percentage`
|
||||
*/
|
||||
|
||||
$_query = "
|
||||
SELECT
|
||||
issues.description,
|
||||
COUNT( DISTINCT results.id ) AS total
|
||||
FROM
|
||||
issues
|
||||
LEFT JOIN
|
||||
issues_results ON issues_results.issue_id=issues.id
|
||||
LEFT JOIN results ON results.id=issues_results.result_id AND results.application_id=applications.id
|
||||
JOIN applications_issues ON applications_issues.issue_id=issues.id
|
||||
JOIN applications ON applications.id=applications_issues.application_id
|
||||
WHERE 1=1
|
||||
";
|
||||
|
||||
if (!empty($params['start_date'])) {
|
||||
$_timestamp = strtotime($params['start_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
$_query.= " AND `results`.`created` >= '{$_date}'";
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['end_date'])) {
|
||||
$_timestamp = strtotime($params['end_date']);
|
||||
|
||||
if (!($_timestamp == -1) || $_timestamp == false) {
|
||||
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
|
||||
$_query .= " AND `results`.`created` <= '{$_date}'";
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['product'])) {
|
||||
// product's come in looking like:
|
||||
// Mozilla Firefox 1.5.0.1
|
||||
$_exp = explode(' ',urldecode($params['product']));
|
||||
|
||||
if(count($_exp) == 3) {
|
||||
$_product = $_exp[0].' '.$_exp[1];
|
||||
|
||||
$_version = $_exp[2];
|
||||
|
||||
$_query .= " AND `applications`.`name` LIKE '{$_product}'";
|
||||
$_query .= " AND `applications`.`version` LIKE '{$_version}'";
|
||||
} else {
|
||||
// defaults I guess?
|
||||
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
|
||||
$_query .= " AND `applications`.`version` LIKE '1.5'";
|
||||
}
|
||||
} else {
|
||||
// I'm providing a default here, because otherwise all results will be
|
||||
// returned (across all applications) and that is not desired
|
||||
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
|
||||
$_query .= " AND `applications`.`version` LIKE '1.5'";
|
||||
}
|
||||
|
||||
$_query .= " GROUP BY `issues`.`description`
|
||||
ORDER BY `issues`.`description` DESC";
|
||||
|
||||
return $this->query($_query);
|
||||
}
|
||||
}
|
||||
?>
|
||||
188
mozilla/webtools/uninstall_survey/vendors/csv/csv.php
vendored
Normal file
188
mozilla/webtools/uninstall_survey/vendors/csv/csv.php
vendored
Normal file
@@ -0,0 +1,188 @@
|
||||
<?php
|
||||
/**
|
||||
* Functions that take a db result and export it to CSV.
|
||||
* Usage example:
|
||||
* <code>
|
||||
* if ($_GET['csv'])
|
||||
* {
|
||||
* $res=db_query("SELECT * FROM fic_courses");
|
||||
* csv_send_csv($res);
|
||||
* exit;
|
||||
* }
|
||||
* </code>
|
||||
* @package libs
|
||||
* @subpackage csv
|
||||
* @author Richard Faaberg <faabergr@onid.orst.edu>
|
||||
* @author Mike Morgan <mike.morgan@oregonstate.edu>
|
||||
*/
|
||||
|
||||
/**
|
||||
* Use a resource or two dimensional array, then send the CSV results to user.
|
||||
* @param mixed $res MySQL resource / result, or a two dimensional array
|
||||
* @param string $name name of the export file
|
||||
* @return bool true if file sent, false otherwise
|
||||
*/
|
||||
function csv_send_csv($res,$name=null)
|
||||
{
|
||||
// set name of the export file
|
||||
$filename=(is_null($name))?'export-'.date('Y-m-d').'.csv':$name.'.csv';
|
||||
// check for valid resource
|
||||
if ( is_resource($res) )
|
||||
{
|
||||
$csv=csv_export_to_csv($res);
|
||||
}
|
||||
elseif( is_array($res) && !empty($res) )
|
||||
{
|
||||
foreach ($res as $row)
|
||||
{
|
||||
if ( !is_array($row) )
|
||||
;
|
||||
else
|
||||
$csv[] = csv_array_to_csv($row)."\n";
|
||||
}
|
||||
}
|
||||
|
||||
if ( is_array($csv) )
|
||||
{
|
||||
// stream csv to user
|
||||
header("Content-type: application/x-csv");
|
||||
header('Content-disposition: inline; filename="'.$filename.'"');
|
||||
header('Cache-Control: private');
|
||||
header('Pragma: public');
|
||||
foreach ($csv as $row)
|
||||
{
|
||||
echo $row;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace quotes inside of a field with double quotes, which is something CSV requires.
|
||||
* @param string $string unquoted quotes
|
||||
* @return string $string quoted quotes
|
||||
*/
|
||||
function csv_fix_quotes($string)
|
||||
{
|
||||
return preg_replace('/"/','""',$string);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace line breaks with commas trailed by a space.
|
||||
* @param string $string string containing line breaks
|
||||
* @param string string without line breaks
|
||||
*/
|
||||
function csv_fix_line_breaks($string)
|
||||
{
|
||||
return preg_replace('/(\n\r|\r)/','\n',$string);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces instances of double quotes in a string with a single quote.
|
||||
* @param string $string the string to perform the replacement on
|
||||
* @return string the string with "" replaced by "
|
||||
*/
|
||||
function csv_unfix_quotes($string)
|
||||
{
|
||||
return preg_replace('/""/', '"', $string);
|
||||
}
|
||||
|
||||
/**
|
||||
* Place quotes outside of every field, which inherently solves space, line break issues.
|
||||
* @param string $string
|
||||
* @return string $string with quotes around it
|
||||
*/
|
||||
function csv_add_quotes($string)
|
||||
{
|
||||
return '"'.$string.'"';
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes quotes from the beginning and the end of a string.
|
||||
* @param string $string the string to remove the quotes from
|
||||
* @return string the string, sans quotes at the beginning and end
|
||||
*/
|
||||
function csv_remove_quotes($string)
|
||||
{
|
||||
$pattern = "/^\"(.*)\"$/";
|
||||
$replacement = "$1";
|
||||
return preg_replace($pattern, $replacement, $string);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an array into a CSV string with quotes around each value.
|
||||
* @param array $array
|
||||
* @return string the values in $array surrounded by quotes and separated by commas
|
||||
*/
|
||||
function csv_array_to_csv($array)
|
||||
{
|
||||
$csv_arr = array();
|
||||
foreach ($array as $value)
|
||||
{
|
||||
$csv_arr[]=csv_add_quotes(csv_fix_quotes(csv_fix_line_breaks($value)));
|
||||
}
|
||||
$csv_string=implode(',',$csv_arr);
|
||||
|
||||
return $csv_string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert a CSV string into an array.
|
||||
* Please use sparingly - this creates temp files
|
||||
* @param string $string the CSV string
|
||||
* @return array the elements from the CSV string in an array
|
||||
*/
|
||||
function csv_csv_to_array($string)
|
||||
{
|
||||
$return = array();
|
||||
$length = strlen($string);
|
||||
|
||||
// create a temp file and write the string to it
|
||||
$tmpfname = tempnam('/tmp', 'csvlib');
|
||||
$fh = fopen($tmpfname, 'w');
|
||||
fwrite($fh, $string);
|
||||
fclose($fh);
|
||||
|
||||
// open the file for csv parsing
|
||||
$csvh = fopen($tmpfname, 'r');
|
||||
while (($arraydata = fgetcsv($csvh, $length, ',')) !== false)
|
||||
{
|
||||
$return = array_merge($return, $arraydata);
|
||||
}
|
||||
|
||||
fclose($csvh);
|
||||
unlink($tmpfname);
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Read a CSV file into a two dimensional array
|
||||
* It returns all the rows in the file, so if the first row are headers, you'd need to take care of that in the returned array
|
||||
* @param string $filepath the path to the csv file
|
||||
* @param string $delimiter delimiter, default to ','
|
||||
* @param string $enclosure enclosure character, default to '"'
|
||||
* @return &array the two dimensional array with the csv file content, or an empty if an error occured
|
||||
*/
|
||||
function &csv_csv_file_to_array($filepath, $delimiter=',', $enclosure='"')
|
||||
{
|
||||
$return = array();
|
||||
|
||||
if (!file_exists($filepath) || !is_readable($filepath))
|
||||
return $return;
|
||||
|
||||
$fh =& fopen($filepath, 'r');
|
||||
$size = filesize($filepath)+1;
|
||||
|
||||
while ($data =& fgetcsv($fh, $size, $delimiter, $enclosure))
|
||||
{
|
||||
$return[] = $data;
|
||||
}
|
||||
|
||||
fclose($fh);
|
||||
|
||||
return $return;
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,11 @@
|
||||
<div id="t_footer">
|
||||
</div>
|
||||
|
||||
<!-- t_wrapper -->
|
||||
</div>
|
||||
|
||||
<!-- t_border -->
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<title>Mozilla Uninstall Survey Data</title>
|
||||
<meta name="author" content="Mozilla Corporation" />
|
||||
<meta name="copyright" content="Mozilla Corporation" />
|
||||
<?php echo $html->charset('UTF-8'); ?>
|
||||
<?php echo $html->css('screen'); ?>
|
||||
<?php if (isset($include_graph_libraries) && $include_graph_libraries):
|
||||
echo $javascript->link('mochikit/MochiKit.js');
|
||||
echo $javascript->link('plotkit/Base.js');
|
||||
echo $javascript->link('plotkit/Layout.js');
|
||||
echo $javascript->link('plotkit/Canvas.js');
|
||||
echo $javascript->link('plotkit/SweetCanvas.js');
|
||||
endif; ?>
|
||||
</head>
|
||||
<body>
|
||||
<div id="t_border">
|
||||
<div id="t_wrapper">
|
||||
<a class="skipnav" href="#t_content">Skip Navigation Links</a>
|
||||
<div id="t_header">
|
||||
<div id="t_title">
|
||||
<h1>Mozilla Firefox Uninstall Survey Data</h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
<div id="t_nav">
|
||||
<ul>
|
||||
<li><?php echo $html->link('Results', '/results'); ?></li>
|
||||
<li><?php echo $html->link('Comments', '/results/comments'); ?></li>
|
||||
</ul>
|
||||
</div>
|
||||
36
mozilla/webtools/uninstall_survey/views/helpers/export.php
Normal file
36
mozilla/webtools/uninstall_survey/views/helpers/export.php
Normal file
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* When we're exporting data, we end up having to pass all the parameters
|
||||
* via $_GET. Since we're doing this a few times per page (each graph, and the
|
||||
* export hrefs) this helper should make that easier.
|
||||
*/
|
||||
class ExportHelper
|
||||
{
|
||||
/**
|
||||
* Method to collect the current $_GET parameters and build another string from
|
||||
* them.
|
||||
*
|
||||
* @param string cake URL that you want prepended to the result. eg: reports/graph/
|
||||
* @param array the array of GET variables to add. These need to be
|
||||
* pre-sanitized to print in html! This is designed to
|
||||
* be used from the calling controller like:
|
||||
* $params = $this->sanitize->html($url_parameters);
|
||||
* @param string string to put between url and arguments (probably either '?' or
|
||||
* '&')
|
||||
* @param array array of strings which will be ignored
|
||||
* @return string string with the url variables appeneded to it
|
||||
*/
|
||||
function buildUrlString($url, $params, $seperator='?', $ignore=array('url'))
|
||||
{
|
||||
$arguments = '';
|
||||
|
||||
foreach ($params as $var => $val) {
|
||||
if (!in_array($var, $ignore)) {
|
||||
$arguments .= empty($arguments) ? "{$var}={$val}" : "&{$var}={$val}";
|
||||
}
|
||||
}
|
||||
|
||||
return "{$url}{$seperator}{$arguments}";
|
||||
}
|
||||
}
|
||||
?>
|
||||
196
mozilla/webtools/uninstall_survey/views/helpers/pagination.php
Normal file
196
mozilla/webtools/uninstall_survey/views/helpers/pagination.php
Normal file
@@ -0,0 +1,196 @@
|
||||
<?php
|
||||
class PaginationHelper {
|
||||
|
||||
var $helpers = array('Html','Ajax');
|
||||
var $_pageDetails = array();
|
||||
var $link = '';
|
||||
var $show = array();
|
||||
var $page;
|
||||
var $style;
|
||||
|
||||
/**
|
||||
* Sets the default pagination options.
|
||||
*
|
||||
* @param array $paging an array detailing the page options
|
||||
*/
|
||||
function setPaging($paging)
|
||||
{
|
||||
if(!empty($paging))
|
||||
{
|
||||
|
||||
$this->link = $paging['link'];
|
||||
$this->show = $paging['show'];
|
||||
$this->page = $paging['page'];
|
||||
$this->style = $paging['style'];
|
||||
|
||||
$pageCount = ceil($paging['count'] / $paging['limit'] );
|
||||
|
||||
$this->_pageDetails = array(
|
||||
'page'=>$paging['page'],
|
||||
'recordCount'=>$paging['count'],
|
||||
'pageCount' =>$pageCount,
|
||||
'nextPage'=> ($paging['page'] < $pageCount) ? $paging['page']+1 : '',
|
||||
'previousPage'=> ($paging['page']>1) ? $paging['page']-1 : '',
|
||||
'limit'=>$paging['limit']
|
||||
);
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
/**
|
||||
* Displays limits for the query
|
||||
*
|
||||
* @param string $text - text to display before limits
|
||||
* @param string $separator - display a separate between limits
|
||||
*
|
||||
**/
|
||||
function show($text=null, $separator=null)
|
||||
{
|
||||
if (empty($this->_pageDetails)) { return false; }
|
||||
if ( !empty($this->_pageDetails['recordCount']) )
|
||||
{
|
||||
$t = '';
|
||||
if(is_array($this->show))
|
||||
{
|
||||
$t = $text.$separator;
|
||||
foreach($this->show as $value)
|
||||
{
|
||||
$link = preg_replace('/show=(.*?)&/','show='.$value.'&',$this->link);
|
||||
if($this->_pageDetails['limit'] == $value)
|
||||
{
|
||||
$t .= '<em>'.$value.'</em>'.$separator;
|
||||
}
|
||||
else
|
||||
{
|
||||
if($this->style == 'ajax')
|
||||
{
|
||||
$t .= $this->Ajax->linkToRemote($value, array("fallback"=>$this->action."#","url" => $link.$this->_pageDetails['page'],"update" => "ajax_update","method"=>"get")).$separator;
|
||||
}
|
||||
else
|
||||
{
|
||||
$t .= $this->Html->link($value,$link.$this->_pageDetails['page']).$separator;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return $t;
|
||||
}
|
||||
return false;
|
||||
|
||||
}
|
||||
/**
|
||||
* Displays current result information
|
||||
*
|
||||
* @param string $text - text to preceeding the number of results
|
||||
*
|
||||
**/
|
||||
function result($text)
|
||||
{
|
||||
if (empty($this->_pageDetails)) { return false; }
|
||||
if ( !empty($this->_pageDetails['recordCount']) )
|
||||
{
|
||||
if($this->_pageDetails['recordCount'] > $this->_pageDetails['limit'])
|
||||
{
|
||||
$start_row = $this->_pageDetails['page'] > 1 ? (($this->_pageDetails['page']-1)*$this->_pageDetails['limit'])+1:'1';
|
||||
$end_row = ($this->_pageDetails['recordCount'] < ($start_row + $this->_pageDetails['limit']-1)) ? $this->_pageDetails['recordCount'] : ($start_row + $this->_pageDetails['limit']-1);
|
||||
$t = $text.$start_row.'-'.$end_row.' of '.$this->_pageDetails['recordCount'];
|
||||
}
|
||||
else
|
||||
{
|
||||
$t = $text.$this->_pageDetails['recordCount'];
|
||||
}
|
||||
return $t;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
/**
|
||||
* Returns a list of page numbers separated by $separator
|
||||
*
|
||||
* @param string $separator - defaults to null
|
||||
*
|
||||
**/
|
||||
function pageNumbers($separator=null)
|
||||
{
|
||||
if (empty($this->_pageDetails) || $this->_pageDetails['pageCount'] == 1) { return false; }
|
||||
$t = array();
|
||||
$text = '';
|
||||
$pc = 1;
|
||||
do
|
||||
{
|
||||
if($pc == $this->_pageDetails['page'])
|
||||
{
|
||||
$text = '<em>'.$pc.'</em>';
|
||||
}
|
||||
else
|
||||
{
|
||||
if($this->style == 'ajax')
|
||||
{
|
||||
$text = $this->Ajax->linkToRemote($pc, array("fallback"=>$this->action."#","url" =>$this->link.$pc,"update" => "ajax_update","method"=>"get"));
|
||||
}
|
||||
else
|
||||
{
|
||||
$text = $this->Html->link($pc,$this->link.$pc);
|
||||
}
|
||||
}
|
||||
|
||||
$t[] = $text;
|
||||
$pc++;
|
||||
}
|
||||
while ($pc<=$this->_pageDetails['pageCount']);
|
||||
|
||||
$t = implode($separator, $t);
|
||||
|
||||
return $t;
|
||||
}
|
||||
/**
|
||||
* Displays a link to the previous page, where the page doesn't exist then
|
||||
* display the $text
|
||||
*
|
||||
* @param string $text - text display: defaults to next
|
||||
*
|
||||
**/
|
||||
function prevPage($text='prev')
|
||||
{
|
||||
if (empty($this->_pageDetails)) { return false; }
|
||||
if ( !empty($this->_pageDetails['previousPage']) )
|
||||
{
|
||||
if($this->style == 'ajax')
|
||||
{
|
||||
$t = $this->Ajax->linkToRemote($text, array("fallback"=>$this->action."#","url" => $this->link.$this->_pageDetails['previousPage'],"update" => "ajax_update","method"=>"get"));
|
||||
}
|
||||
else
|
||||
{
|
||||
$t = $this->Html->link($text,$this->link.$this->_pageDetails['previousPage']);
|
||||
}
|
||||
return $t;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
/**
|
||||
* Displays a link to the next page, where the page doesn't exist then
|
||||
* display the $text
|
||||
*
|
||||
* @param string $text - text to display: defaults to next
|
||||
*
|
||||
**/
|
||||
function nextPage($text='next')
|
||||
{
|
||||
if (empty($this->_pageDetails)) { return false; }
|
||||
if (!empty($this->_pageDetails['nextPage']))
|
||||
{
|
||||
if($this->style == 'ajax')
|
||||
{
|
||||
$t = $this->Ajax->linkToRemote($text, array("fallback"=>$this->action."#","url" => $this->link.$this->_pageDetails['nextPage'],"update" => "ajax_update","method"=>"get"));
|
||||
}
|
||||
else
|
||||
{
|
||||
$t = $this->Html->link($text,$this->link.$this->_pageDetails['nextPage']);
|
||||
}
|
||||
return $t;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,8 @@
|
||||
<?php echo $this->renderElement( 'header' ); ?>
|
||||
<?php echo $this->renderElement( 'nav' ); ?>
|
||||
<div id="t_content_container">
|
||||
<div id="t_content">
|
||||
<?php echo $content_for_layout;?>
|
||||
</div>
|
||||
</div>
|
||||
<?php echo $this->renderElement( 'footer'); ?>
|
||||
@@ -0,0 +1,51 @@
|
||||
<h1><?php echo Inflector::humanize($this->name); ?></h1>
|
||||
|
||||
<div id="queryform">
|
||||
<?php echo $html->formTag('/results/comments/','get'); ?>
|
||||
<span>
|
||||
<label for="start_date">Start Date:</label>
|
||||
<input type="text" name="start_date" id="start_date" value="<? echo isset($url_params['start_date']) ? $url_params['start_date'] : ''; ?>" />
|
||||
<label for="end_date">End Date:</label>
|
||||
<input type="text" name="end_date" id="end_date" value="<? echo isset($url_params['end_date']) ? $url_params['end_date'] : ''; ?>" />
|
||||
</span>
|
||||
|
||||
<label for="product">Product:</label>
|
||||
<select name="product" id="product">
|
||||
<?php
|
||||
foreach ($products as $select) :
|
||||
$product = $select['applications']['name'].' '.$select['applications']['version'];
|
||||
$selected = ($product == trim($url_params['product'])) ? ' selected="selected" ' : '';
|
||||
?>
|
||||
<option<?=$selected?>><?=$product?></option>
|
||||
|
||||
<?php endforeach; ?>
|
||||
</select>
|
||||
|
||||
<input type="submit" name="submit" id="submit" value="Go" />
|
||||
</form>
|
||||
<br />
|
||||
<span><small>Date format is yyyy-mm-dd. A blank date will use the largest possible range.</small></span>
|
||||
</div>
|
||||
|
||||
<?php if (!empty($commentsData)) : ?>
|
||||
|
||||
<table class="comments" summary="User submitted comments.">
|
||||
<tr><th>Date Recorded</th><th>Comment</th></tr>
|
||||
<?php foreach ($commentsData as $var => $val) : ?>
|
||||
<tr><td><?php echo $time->niceShort($val['Result']['created']); ?></td><td><?php echo nl2br(htmlspecialchars($val['Result']['comments'])); ?></td></tr>
|
||||
<?php endforeach; ?>
|
||||
</table>
|
||||
|
||||
<?php if($pagination->setPaging($paging)):?>
|
||||
<ul id="page-numbers">
|
||||
<li><?php echo $pagination->show('Show ', ' '); ?></li>
|
||||
<li><?php echo $pagination->result('Results: '); ?></li>
|
||||
<li><?php echo $pagination->pageNumbers(' '); ?></li>
|
||||
</ul>
|
||||
<?php endif;?>
|
||||
|
||||
<?php else: ?>
|
||||
|
||||
<div id="notice">There is no data available for your parameters. Please review your search criteria.</div>
|
||||
|
||||
<?php endif; ?>
|
||||
91
mozilla/webtools/uninstall_survey/views/results/index.thtml
Normal file
91
mozilla/webtools/uninstall_survey/views/results/index.thtml
Normal file
@@ -0,0 +1,91 @@
|
||||
<h1><?php echo Inflector::humanize($this->name); ?></h1>
|
||||
|
||||
<div id="queryform">
|
||||
<?php echo $html->formTag('/results/','get'); ?>
|
||||
<span>
|
||||
<label for="start_date">Start Date:</label>
|
||||
<input type="text" name="start_date" id="start_date" value="<? echo isset($url_params['start_date']) ? $url_params['start_date'] : ''; ?>" />
|
||||
<label for="end_date">End Date:</label>
|
||||
<input type="text" name="end_date" id="end_date" value="<? echo isset($url_params['end_date']) ? $url_params['end_date'] : ''; ?>" />
|
||||
</span>
|
||||
|
||||
<label for="product">Product:</label>
|
||||
<select name="product" id="product">
|
||||
<?php
|
||||
foreach ($products as $select) :
|
||||
$product = $select['applications']['name'].' '.$select['applications']['version'];
|
||||
$selected = ($product == trim($url_params['product'])) ? ' selected="selected" ' : '';
|
||||
?>
|
||||
<option<?=$selected?>><?=$product?></option>
|
||||
|
||||
<?php endforeach; ?>
|
||||
</select>
|
||||
|
||||
<input type="submit" name="submit" id="submit" value="Go" />
|
||||
</form>
|
||||
<br />
|
||||
<span><small>Date format is yyyy-mm-dd. A blank date will use the largest possible range.</small></span>
|
||||
</div>
|
||||
|
||||
<?php if (!empty($descriptionAndTotalsData)) : ?>
|
||||
<?php
|
||||
/* Prepare data for graphing */
|
||||
$_dataset = '';
|
||||
$_count = 0;
|
||||
$_total = 0;
|
||||
/* We've got to do 2 loops here because I need the totals to calculate
|
||||
* percentages.
|
||||
*/
|
||||
foreach ($descriptionAndTotalsData as $var => $val) {
|
||||
$_total += $val[0]['total'];
|
||||
}
|
||||
foreach ($descriptionAndTotalsData as $var => $val) {
|
||||
// We're putting this in a js string, so escape the double quotes
|
||||
$_description = str_replace('"','\"',$val['issues']['description']);
|
||||
$_percentage = intval(($val[0]['total'] / $_total)*100);
|
||||
|
||||
$_dataset .= "[{$_count}, {$val[0]['total']}, \"{$_description} (n={$val[0]['total']}, {$_percentage}%)\"], ";
|
||||
$_count++;
|
||||
}
|
||||
$_dataset = "[{$_dataset}]";
|
||||
?>
|
||||
<div id="graphcontainer">
|
||||
<canvas id="graph" height="400" width="800">
|
||||
<table class="results" summary="Firefox Uninstallation results.">
|
||||
<tr><th>Reason for uninstalling</th><th>Total</th></tr>
|
||||
<?php foreach ($descriptionAndTotalsData as $var => $val) : ?>
|
||||
<tr><td><?=$val['issues']['description']?></td><td><?=$val[0]['total']?></td></tr>
|
||||
<?php endforeach; ?>
|
||||
</table>
|
||||
</canvas>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var layout = new PlotKit.Layout("bar", {"barOrientation":"horizontal"});
|
||||
layout.addDataset("results", <?=$_dataset?>);
|
||||
layout.evaluate();
|
||||
|
||||
var canvas = MochiKit.DOM.getElement("graph");
|
||||
var plotter = new PlotKit.SweetCanvasRenderer(canvas, layout,
|
||||
{
|
||||
"drawYAxis" : false,
|
||||
"drawXAxis" : false,
|
||||
"backgroundColor" : Color.fromHexString('#78c'),
|
||||
"strokeColor" : Color.fromHexString('#777'),
|
||||
"strokeWidth" : 1.0,
|
||||
"enableEvents" : false
|
||||
});
|
||||
|
||||
plotter.render();
|
||||
</script>
|
||||
|
||||
|
||||
<div id="exportbox">
|
||||
<a href="<?php echo $export->buildUrlString('results/comments/',$url_params); ?>">View Any Associated Comments»</a><br />
|
||||
<a href="<?php echo $export->buildUrlString('results/csv/',$url_params); ?>">Download this Data»</a>
|
||||
</div>
|
||||
|
||||
<?php else: ?>
|
||||
|
||||
<div id="notice">There is no data available for your parameters. Please review your search criteria.</div>
|
||||
|
||||
<?php endif; ?>
|
||||
6
mozilla/webtools/uninstall_survey/webroot/.htaccess
Normal file
6
mozilla/webtools/uninstall_survey/webroot/.htaccess
Normal file
@@ -0,0 +1,6 @@
|
||||
<IfModule mod_rewrite.c>
|
||||
RewriteEngine On
|
||||
RewriteCond %{REQUEST_FILENAME} !-d
|
||||
RewriteCond %{REQUEST_FILENAME} !-f
|
||||
RewriteRule ^(.*)$ index.php?url=$1 [QSA,L]
|
||||
</IfModule>
|
||||
116
mozilla/webtools/uninstall_survey/webroot/css.php
Normal file
116
mozilla/webtools/uninstall_survey/webroot/css.php
Normal file
@@ -0,0 +1,116 @@
|
||||
<?php
|
||||
/* SVN FILE: $Id: css.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
|
||||
|
||||
/**
|
||||
* Short description for file.
|
||||
*
|
||||
* Long description for file
|
||||
*
|
||||
* PHP versions 4 and 5
|
||||
*
|
||||
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
|
||||
* Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* 1785 E. Sahara Avenue, Suite 490-204
|
||||
* Las Vegas, Nevada 89104
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @filesource
|
||||
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
|
||||
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
|
||||
* @package cake
|
||||
* @subpackage cake.app.webroot
|
||||
* @since CakePHP v 0.2.9
|
||||
* @version $Revision: 1.1.1.1 $
|
||||
* @modifiedby $LastChangedBy: phpnut $
|
||||
* @lastmodified $Date: 2006-05-24 19:14:24 $
|
||||
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
||||
*/
|
||||
|
||||
/**
|
||||
* Enter description here...
|
||||
*/
|
||||
require(CONFIGS.'paths.php');
|
||||
require(CAKE.'basics.php');
|
||||
require(LIBS.'folder.php');
|
||||
require(LIBS.'file.php');
|
||||
require(LIBS.'legacy.php');
|
||||
|
||||
/**
|
||||
* Enter description here...
|
||||
*
|
||||
* @param unknown_type $path
|
||||
* @param unknown_type $name
|
||||
* @return unknown
|
||||
*/
|
||||
function make_clean_css ($path, $name)
|
||||
{
|
||||
require(VENDORS.'csspp'.DS.'csspp.php');
|
||||
|
||||
$data = file_get_contents($path);
|
||||
$csspp = new csspp();
|
||||
$output = $csspp->compress($data);
|
||||
|
||||
$ratio = 100-(round(strlen($output)/strlen($data), 3)*100);
|
||||
$output = " /* file: $name, ratio: $ratio% */ " . $output;
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enter description here...
|
||||
*
|
||||
* @param unknown_type $path
|
||||
* @param unknown_type $content
|
||||
* @return unknown
|
||||
*/
|
||||
function write_css_cache ($path, $content)
|
||||
{
|
||||
if (!is_dir(dirname($path)))
|
||||
mkdir(dirname($path));
|
||||
|
||||
$cache = new File($path);
|
||||
return $cache->write($content);
|
||||
}
|
||||
|
||||
if (preg_match('|\.\.|', $url) || !preg_match('|^ccss/(.+)$|i', $url, $regs))
|
||||
die('Wrong file name.');
|
||||
|
||||
$filename = 'css/'.$regs[1];
|
||||
$filepath = CSS.$regs[1];
|
||||
$cachepath = CACHE.'css'.DS.str_replace(array('/','\\'), '-', $regs[1]);
|
||||
|
||||
if (!file_exists($filepath))
|
||||
die('Wrong file name.');
|
||||
|
||||
|
||||
if (file_exists($cachepath))
|
||||
{
|
||||
$templateModified = filemtime($filepath);
|
||||
$cacheModified = filemtime($cachepath);
|
||||
|
||||
if ($templateModified > $cacheModified)
|
||||
{
|
||||
$output = make_clean_css ($filepath, $filename);
|
||||
write_css_cache ($cachepath, $output);
|
||||
}
|
||||
else
|
||||
{
|
||||
$output = file_get_contents($cachepath);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$output = make_clean_css ($filepath, $filename);
|
||||
write_css_cache ($cachepath, $output);
|
||||
}
|
||||
|
||||
header("Date: ".date("D, j M Y G:i:s ", $templateModified).'GMT');
|
||||
header("Content-Type: text/css");
|
||||
header("Expires: ".gmdate("D, j M Y H:i:s", time()+DAY)." GMT");
|
||||
header("Cache-Control: cache");// HTTP/1.1
|
||||
header("Pragma: cache");// HTTP/1.0
|
||||
print $output;
|
||||
|
||||
?>
|
||||
195
mozilla/webtools/uninstall_survey/webroot/css/cake.default.css
Normal file
195
mozilla/webtools/uninstall_survey/webroot/css/cake.default.css
Normal file
@@ -0,0 +1,195 @@
|
||||
/* CSS Document */
|
||||
@import url("cake.forms.css");
|
||||
|
||||
* {
|
||||
padding:0;
|
||||
margin:0;
|
||||
}
|
||||
body {
|
||||
font: 76% Verdana, Arial, Sans-serif;
|
||||
color: #333;
|
||||
}
|
||||
img {
|
||||
border:0;
|
||||
}
|
||||
#wrapper {
|
||||
text-align:left;
|
||||
}
|
||||
#header {
|
||||
height: 101px;
|
||||
background: #0D5087 url(../img/cake.header_bg.png) repeat-x left top;
|
||||
border-bottom: 1px solid #000;
|
||||
}
|
||||
#content {
|
||||
min-height:400px;
|
||||
background-color: #fff;
|
||||
padding:2em 4em;
|
||||
}
|
||||
#footer {
|
||||
text-align:center;
|
||||
padding:1em 0;
|
||||
font-size:smaller;
|
||||
border-top:1px solid #333;
|
||||
background-color: #063260;
|
||||
color:#fff;
|
||||
line-height:1.5;
|
||||
}
|
||||
#footer a {
|
||||
color:#fff;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4 {
|
||||
padding-bottom:0.5em;
|
||||
}
|
||||
h1 {
|
||||
font-family:"Trebuchet MS",Verdana,Arial,Sans-serif;
|
||||
}
|
||||
h1, a {
|
||||
color:#DB8101;
|
||||
}
|
||||
h1 em, a em {
|
||||
color:#008BCC;
|
||||
font-style: normal;
|
||||
}
|
||||
ul.colored a em
|
||||
h2 {
|
||||
font-style: italic;
|
||||
font-weight: bold;
|
||||
color:#666;
|
||||
}
|
||||
a:hover, a:hover em {
|
||||
color:#A22424;
|
||||
text-decoration:none;
|
||||
}
|
||||
#content p, #content ul, #content ol {
|
||||
line-height:1.5;
|
||||
padding-bottom:1em;
|
||||
}
|
||||
ul, ol {
|
||||
margin-left:3em;
|
||||
}
|
||||
|
||||
/* tables */
|
||||
|
||||
table {
|
||||
width: 100%;
|
||||
background-color: #fff;
|
||||
border: 1px solid #333;
|
||||
clear:both;
|
||||
margin: 0 0 2em 0;
|
||||
white-space: normal;
|
||||
}
|
||||
th {
|
||||
background-color: #ccc;
|
||||
border-top: 1px solid #fff;
|
||||
border-right: 1px solid #666;
|
||||
border-bottom: 1px solid #666;
|
||||
text-align: center;
|
||||
padding:3px;
|
||||
}
|
||||
table tr td {
|
||||
border-right: 1px solid #ccc;
|
||||
padding:4px 4px;
|
||||
vertical-align:top;
|
||||
text-align: center;
|
||||
}
|
||||
table tr.altRow td {
|
||||
background: #f4f4f4;
|
||||
}
|
||||
|
||||
/* scaffold show */
|
||||
|
||||
|
||||
div.related {
|
||||
clear:both;
|
||||
display:block;
|
||||
}
|
||||
dl {
|
||||
line-height:2em;
|
||||
margin:1em;
|
||||
}
|
||||
dt {
|
||||
font-weight: bold;
|
||||
vertical-align:top;
|
||||
}
|
||||
dd {
|
||||
margin-left:10em;
|
||||
margin-top:-2em;
|
||||
vertical-align:top;
|
||||
}
|
||||
|
||||
/* scaffold buttons */
|
||||
|
||||
|
||||
.notice {
|
||||
color: #DB8101;
|
||||
background-color: #ddd;
|
||||
display: block;
|
||||
padding: 1em;
|
||||
}
|
||||
.tip {
|
||||
color: #DB8101;
|
||||
background-color: #ddd;
|
||||
display: block;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
ul.actions {
|
||||
list-style: none;
|
||||
text-align:left;
|
||||
margin:2em 0;
|
||||
padding: 0;
|
||||
}
|
||||
ul.actions li {
|
||||
margin-left:1em;
|
||||
list-style: none;
|
||||
display: inline;
|
||||
}
|
||||
ul.actions li a, ul.actions li input {
|
||||
padding: 2px 12px;
|
||||
color: #DB8101;
|
||||
background-color:#ccc;
|
||||
text-decoration: none;
|
||||
border: 1px solid #666;
|
||||
line-height: 24px;
|
||||
font-weight: bold;
|
||||
text-align:center;
|
||||
text-decoration: none;
|
||||
}
|
||||
ul.actions li a:hover {
|
||||
color: #DB8101;
|
||||
background-color:#fff;
|
||||
text-decoration: none;
|
||||
}
|
||||
td.listactions {
|
||||
width: 14em;
|
||||
text-align: center;
|
||||
white-space: nowrap;
|
||||
}
|
||||
td.listactions a {
|
||||
padding: 0px 8px;
|
||||
text-align:center;
|
||||
font-weight: bold;
|
||||
color: #DB8101;
|
||||
background-color:#ccc;
|
||||
text-decoration: none;
|
||||
border: 1px solid #666;
|
||||
white-space: nowrap;
|
||||
}
|
||||
td.listactions a:hover {
|
||||
color: #fff;
|
||||
background-color:#DB8101;
|
||||
}
|
||||
|
||||
/* index links */
|
||||
|
||||
ul.colored a {
|
||||
|
||||
}
|
||||
ul.colored a em {
|
||||
|
||||
}
|
||||
|
||||
a {
|
||||
font-weight: bold;
|
||||
}
|
||||
279
mozilla/webtools/uninstall_survey/webroot/css/cake.forms.css
Normal file
279
mozilla/webtools/uninstall_survey/webroot/css/cake.forms.css
Normal file
@@ -0,0 +1,279 @@
|
||||
/* form.css */
|
||||
|
||||
form {
|
||||
margin: 0 4px;
|
||||
font-size: 120%;
|
||||
border-width: 0px 0px 0px 0px;
|
||||
border-style: solid;
|
||||
border-color: #DB8101;
|
||||
}
|
||||
|
||||
form fieldset {
|
||||
font-size: 100%;
|
||||
border-color: #000000;
|
||||
border-width: 1px 0px 0px 0px;
|
||||
border-style: solid none none none;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
form fieldset legend {
|
||||
font-size: 150%;
|
||||
font-weight: normal;
|
||||
color: #000;
|
||||
padding: 0px 5px;
|
||||
}
|
||||
|
||||
label {
|
||||
font-size: 150%;
|
||||
}
|
||||
|
||||
label u {
|
||||
font-style: normal;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
input, select, textarea {
|
||||
font-family: Tahoma, Arial, sans-serif;
|
||||
font-size: 100%;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
textarea {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
form div {
|
||||
clear: left;
|
||||
display: block;
|
||||
margin: 5px 0px 0px 0px;
|
||||
padding: 1px 3px;
|
||||
}
|
||||
|
||||
form fieldset div.notes {
|
||||
float: right;
|
||||
width: 158px;
|
||||
height: auto;
|
||||
margin: 0px 0px 10px 10px;
|
||||
padding: 5px;
|
||||
border: 1px solid #666;
|
||||
background-color: #ffffe1;
|
||||
color: #666;
|
||||
font-size: 88%;
|
||||
}
|
||||
|
||||
form fieldset div.notes h4 {
|
||||
background-image: url(/images/icon_info.gif);
|
||||
background-repeat: no-repeat;
|
||||
background-position: top left;
|
||||
padding: 3px 0px 3px 27px;
|
||||
border-width: 0px 0px 1px 0px;
|
||||
border-style: solid;
|
||||
border-color: #666;
|
||||
color: #666;
|
||||
font-size: 110%;
|
||||
}
|
||||
|
||||
form fieldset div.notes p {
|
||||
margin: 0em 0em 1.2em 0em;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
form fieldset div.notes p.last {
|
||||
margin: 0em;
|
||||
}
|
||||
|
||||
form div fieldset {
|
||||
clear: none;
|
||||
border-width: 0px 1px 0px 1px;
|
||||
border-style: solid;
|
||||
border-color: #666;
|
||||
margin: 0px 0px 0px 142px;
|
||||
padding: 0px 5px 5px 5px;
|
||||
}
|
||||
|
||||
form div fieldset legend {
|
||||
font-size: 100%;
|
||||
padding: 0px 3px 0px 9px;
|
||||
}
|
||||
|
||||
form div.required fieldset legend {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
form div label {
|
||||
display: block;
|
||||
float: left;
|
||||
width: 200px;
|
||||
background-color: #f4f4f4;
|
||||
font-size: 16px;
|
||||
padding: 3px 5px;
|
||||
margin: 0px 0px 5px 0px;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
form div.optional label, label.optional {
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
form div.required label, label.required {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
form div label.labelCheckbox, form div label.labelRadio {
|
||||
float: none;
|
||||
display: block;
|
||||
margin: 0px 0px 5px 142px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
form div fieldset label.labelCheckbox, form div fieldset label.labelRadio {
|
||||
margin: 0px 0px 5px 0px;
|
||||
}
|
||||
p.error {
|
||||
color: #DB8101;
|
||||
background-color: #DBA941;
|
||||
font-size: 14px;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
form div input, form div select, form div textarea {
|
||||
padding: 1px 3px;
|
||||
margin: 0px 0px 0px 0px;
|
||||
}
|
||||
|
||||
form div input.inputFile {
|
||||
width: 211px;
|
||||
}
|
||||
|
||||
form div select.selectOne, form div select.selectMultiple {
|
||||
width: 211px;
|
||||
padding: 1px 3px;
|
||||
}
|
||||
|
||||
form div input.inputCheckbox, form div input.inputRadio, input.inputCheckbox, input.inputRadio {
|
||||
display: inline;
|
||||
height: 14px;
|
||||
width: 14px;
|
||||
background-color: transparent;
|
||||
border-width: 0px;
|
||||
}
|
||||
|
||||
form div.submit {
|
||||
padding: 0px 0px 0px 140px;
|
||||
clear:both;
|
||||
display:block;
|
||||
}
|
||||
|
||||
div.submit input {
|
||||
padding: 2px 12px;
|
||||
color: #DB8101;
|
||||
background-color:#ccc;
|
||||
text-decoration: none;
|
||||
border: 1px solid #666;
|
||||
font-size: 14px;
|
||||
font-weight: bold;
|
||||
text-align:center;
|
||||
text-decoration: none;
|
||||
width: auto;
|
||||
}
|
||||
div.submit input:hover {
|
||||
padding: 2px 12px;
|
||||
color: #fff;
|
||||
background-color:#DB8101;
|
||||
text-decoration: none;
|
||||
border: 1px solid #666;
|
||||
font-size: 14px;
|
||||
font-weight: bold;
|
||||
text-align:center;
|
||||
text-decoration: none;
|
||||
width: auto;
|
||||
}
|
||||
|
||||
form div.submit div input.inputSubmit, form div.submit div input.inputButton {
|
||||
float: right;
|
||||
margin: 0px 0px 0px 5px;
|
||||
}
|
||||
|
||||
form div small {
|
||||
display: block;
|
||||
margin: 0px 0px 5px 142px;
|
||||
padding: 1px 3px;
|
||||
font-size: 88%;
|
||||
}
|
||||
|
||||
/* form.import.css */
|
||||
|
||||
form fieldset legend {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
form input, form select, form textarea {
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
div.optional label:before {
|
||||
content: '';
|
||||
}
|
||||
|
||||
div.required label:before {
|
||||
content: '';
|
||||
}
|
||||
|
||||
form div label.labelCheckbox, form div label.labelRadio, label.labelCheckbox, label.labelRadio {
|
||||
display: block;
|
||||
width: 190px;
|
||||
padding: 4px 0px 0px 18px;
|
||||
text-indent: -18px;
|
||||
line-height: 120%;
|
||||
}
|
||||
|
||||
form div label.labelCheckbox input.inputCheckbox, form div label.labelRadio input.inputRadio, label.labelCheckbox input.inputCheckbox, label.labelRadio input.inputRadio {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
form div fieldset input.inputText, form div fieldset input.inputPassword, form div fieldset input.inputFile, form div fieldset textarea.inputTextarea {
|
||||
width: 160px;
|
||||
margin: 0px 0px 0px 18px;
|
||||
}
|
||||
|
||||
form div label.compact {
|
||||
display: inline;
|
||||
width: auto;
|
||||
padding: 4px 10px 0px 0px;
|
||||
text-indent: 0px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
form div.wide label {
|
||||
float: none;
|
||||
display: block;
|
||||
}
|
||||
|
||||
form div label.wide {
|
||||
width: 348px;
|
||||
}
|
||||
|
||||
form div.wide input.inputText, form div.wide input.inputPassword, form div.wide input.inputFile, form div.wide select, form div.wide textarea {
|
||||
width: 344px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
form div.notes p, form div small {
|
||||
line-height: 125%;
|
||||
}
|
||||
|
||||
form div.wide small {
|
||||
margin: 0px 0px 5px 0px;
|
||||
}
|
||||
|
||||
div.date select {
|
||||
width:auto;
|
||||
}
|
||||
|
||||
select.autoWidth {
|
||||
width:auto;
|
||||
}
|
||||
|
||||
option {
|
||||
padding-left:1em;
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
form div,
|
||||
form div label.labelCheckbox, form div label.labelRadio,
|
||||
form div small,
|
||||
form div label.labelCheckbox, form div label.labelRadio, label.labelCheckbox, label.labelRadio {
|
||||
height: expression('1%');
|
||||
}
|
||||
form div fieldset input.inputText, form div fieldset input.inputPassword, form div fieldset input.inputFile, form div fieldset textarea.inputTextarea {
|
||||
margin: expression('0px 0px 0px -124px');
|
||||
}
|
||||
133
mozilla/webtools/uninstall_survey/webroot/css/screen.css
Normal file
133
mozilla/webtools/uninstall_survey/webroot/css/screen.css
Normal file
@@ -0,0 +1,133 @@
|
||||
/* Screen Stylesheet */
|
||||
|
||||
/* This is temporary while we use the scaffolding */
|
||||
@import url("cake.default.css");
|
||||
table { clear:none; }
|
||||
|
||||
/* CORE STYLES */
|
||||
|
||||
body{
|
||||
background-color:#788;
|
||||
}
|
||||
div#t_title{
|
||||
background-color:#ddd;
|
||||
height:50px;
|
||||
padding-left:8px;
|
||||
}
|
||||
div#t_title h1{
|
||||
font-size:1.7em;
|
||||
padding-top:10px;
|
||||
color:#677;
|
||||
}
|
||||
div#t_content_container{
|
||||
}
|
||||
div#t_content{
|
||||
padding: 20px 10px 100px 10px;
|
||||
margin-left:151px;
|
||||
background-image:url('../img/bg.jpg');
|
||||
background-position:bottom right;
|
||||
background-repeat:no-repeat;
|
||||
min-height:200px;
|
||||
}
|
||||
div#t_wrapper{
|
||||
margin:0px;
|
||||
padding:0px;
|
||||
background-color:#fff;
|
||||
}
|
||||
|
||||
div#t_border{
|
||||
border-left:1px solid #111;
|
||||
border-right:1px solid #111;
|
||||
border-bottom:1px solid #111;
|
||||
margin:0px 30px 0px 30px;
|
||||
}
|
||||
|
||||
div#t_nav {
|
||||
padding:20px 0px 50px 0px;
|
||||
float:left;
|
||||
width:151px;
|
||||
}
|
||||
div#t_nav ul {
|
||||
list-style-type:none;
|
||||
padding:2px 0px 0px 0px;
|
||||
margin:0px;
|
||||
}
|
||||
div#t_nav ul li{
|
||||
padding:2px 0px 2px 0px;
|
||||
}
|
||||
div#t_nav ul li a{
|
||||
text-decoration:none;
|
||||
font-size:.8em;
|
||||
padding:6px 0px 6px 8px;
|
||||
margin:0px 0px 0px 0px;
|
||||
color:#566;
|
||||
border:none;
|
||||
}
|
||||
div#t_nav ul li a:hover{
|
||||
color:#f80;
|
||||
}
|
||||
div#t_nav h3 {
|
||||
padding:5px 0px 0px 5px;
|
||||
font-size:.9em;
|
||||
}
|
||||
div#t_footer {
|
||||
clear:both;
|
||||
border-top:1px solid #111;
|
||||
}
|
||||
|
||||
div#t_content h1 {
|
||||
margin-bottom:100px;
|
||||
font-size:1.6em;
|
||||
}
|
||||
|
||||
a.skipnav {
|
||||
position:absolute;
|
||||
visibility:hidden;
|
||||
}
|
||||
|
||||
div#queryform {
|
||||
margin: 5px 20px 5px 20px;
|
||||
padding-bottom:20px;
|
||||
width:700px;
|
||||
}
|
||||
div#queryform label {
|
||||
font-size:.8em;
|
||||
font-weight:bold;
|
||||
}
|
||||
div#queryform input[type="text"]{
|
||||
width:7em;
|
||||
}
|
||||
|
||||
div#exportbox {
|
||||
}
|
||||
|
||||
/* Classes for graph/table data. (Generally just padding) */
|
||||
.results {
|
||||
padding: 5px 5px 5px 5px;
|
||||
margin: 5px 5px 5px 5px;
|
||||
}
|
||||
|
||||
div#notice {
|
||||
background-color:#ecc;
|
||||
border:1px dashed #daa;
|
||||
text-align:center;
|
||||
padding:6px 6px 6px 6px;
|
||||
margin:6px 20px 6px 20px;
|
||||
}
|
||||
|
||||
table.comments tr {
|
||||
}
|
||||
|
||||
table.comments tr td{
|
||||
text-align:left;
|
||||
border-bottom: 1px solid #222;
|
||||
}
|
||||
|
||||
div.bar_chart_label {
|
||||
position: absolute;
|
||||
text-align: left;
|
||||
font-size: small;
|
||||
color: #fff;
|
||||
overflow: hidden;
|
||||
z-index: 10;
|
||||
}
|
||||
BIN
mozilla/webtools/uninstall_survey/webroot/favicon.ico
Normal file
BIN
mozilla/webtools/uninstall_survey/webroot/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
mozilla/webtools/uninstall_survey/webroot/img/bg.jpg
Normal file
BIN
mozilla/webtools/uninstall_survey/webroot/img/bg.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
@@ -0,0 +1 @@
|
||||
deny from all
|
||||
@@ -0,0 +1,244 @@
|
||||
2006-04-29 v1.3.1 (bug fix release)
|
||||
|
||||
- Fix sendXMLHttpRequest sendContent regression
|
||||
- Internet Explorer fix in MochiKit.Logging (printfire exception)
|
||||
- Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async
|
||||
|
||||
2006-04-26 v1.3 "warp zone"
|
||||
|
||||
- IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)
|
||||
- IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)
|
||||
- New MochiKit.Base.method as a convenience form of bind that takes the
|
||||
object before the method
|
||||
- New MochiKit.Base.flattenArguments for flattening a list of arguments to
|
||||
a single Array
|
||||
- Refactored MochiRegExp example to use MochiKit.Signal
|
||||
- New key_events example demonstrating use of MochiKit.Signal's key handling
|
||||
capabilities.
|
||||
- MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
|
||||
null is used and the string will be considered the first node. This
|
||||
allows for the more natural P("foo") rather than P(null, "foo").
|
||||
- MochiKit Interpreter example refactored to use MochiKit.Signal and now
|
||||
provides multi-line input and a help() function to get MochiKit function
|
||||
signature from the documentation.
|
||||
- Native Console Logging for the default MochiKit.Logging logger
|
||||
- New MochiKit.Async.DeferredList, gatherResults, maybeDeferred
|
||||
- New MochiKit.Signal example: draggable
|
||||
- Added sanity checking to Deferred to ensure that errors happen when chaining
|
||||
is used incorrectly
|
||||
- Opera sendXMLHttpRequest fix (sends empty string instead of null by default)
|
||||
- Fix a bug in MochiKit.Color that incorrectly generated hex colors for
|
||||
component values smaller than 16/255.
|
||||
- Fix a bug in MochiKit.Logging that prevented logs from being capped at a
|
||||
maximum size
|
||||
- MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
|
||||
Error, so that the errback chain is used instead of the callback chain.
|
||||
- MochiKit.DOM.appendChildNodes and associated functions now append iterables
|
||||
in the correct order.
|
||||
- New MochiKit-based SimpleTest test runner as a replacement for Test.Simple
|
||||
- MochiKit.Base.isNull no longer matches undefined
|
||||
- example doctypes changed to HTML4
|
||||
- isDateLike no longer throws error on null
|
||||
- New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt
|
||||
- updated elementDimensions to calculate width from offsetWidth instead
|
||||
of clientWidth
|
||||
- formContents now works with FORM tags that have a name attribute
|
||||
- Documentation now uses MochiKit to generate a function index
|
||||
|
||||
2006-01-26 v1.2 "the ocho"
|
||||
|
||||
- Fixed MochiKit.Color.Color.lighterColorWithLevel
|
||||
- Added new MochiKit.Base.findIdentical function to find the index of an
|
||||
element in an Array-like object. Uses === for identity comparison.
|
||||
- Added new MochiKit.Base.find function to find the index of an element in
|
||||
an Array-like object. Uses compare for rich comparison.
|
||||
- MochiKit.Base.bind will accept a string for func, which will be immediately
|
||||
looked up as self[func].
|
||||
- MochiKit.DOM.formContents no longer skips empty form elements for Zope
|
||||
compatibility
|
||||
- MochiKit.Iter.forEach will now catch StopIteration to break
|
||||
- New MochiKit.DOM.elementDimensions(element) for determining the width and
|
||||
height of an element in the document
|
||||
- MochiKit.DOM's initialization is now compatible with
|
||||
HTMLUnit + JWebUnit + Rhino
|
||||
- MochiKit.LoggingPane will now re-use a ``_MochiKit_LoggingPane`` DIV element
|
||||
currently in the document instead of always creating one.
|
||||
- MochiKit.Base now has operator.mul
|
||||
- MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
|
||||
a custom value attribute
|
||||
- Added new MochiKit.Color constructors fromComputedStyle and fromText
|
||||
- MochiKit.DOM.setNodeAttribute should work now
|
||||
- MochiKit.DOM now has a workaround for an IE bug when setting the style
|
||||
property to a string
|
||||
- MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
|
||||
name and for properties
|
||||
- MochiKit.DOM.scrapeText now walks the DOM tree in-order
|
||||
- MochiKit.LoggingPane now sanitizes the window name to work around IE bug
|
||||
- MochiKit.DOM now translates usemap to useMap to work around IE bug
|
||||
- MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks
|
||||
- Added new MochiKit.DOM documentation on element visibility
|
||||
- New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
|
||||
for determining the position of an element in the document
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG
|
||||
|
||||
2005-11-14 v1.1
|
||||
|
||||
- Fixed a bug in numberFormatter with large numbers
|
||||
- Massively overhauled documentation
|
||||
- Fast-path for primitives in MochiKit.Base.compare
|
||||
- New groupby and groupby_as_array in MochiKit.Iter
|
||||
- Added iterator factory adapter for objects that implement iterateNext()
|
||||
- Fixed isoTimestamp to handle timestamps with time zone correctly
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
|
||||
LEGEND, FIELDSET
|
||||
- New MochiKit.DOM formContents and enhancement to queryString to support it
|
||||
- Updated view_source example to use dp.SyntaxHighlighter 1.3.0
|
||||
- MochiKit.LoggingPane now uses named windows based on the URL so that
|
||||
a given URL will get the same LoggingPane window after a reload
|
||||
(at the same position, etc.)
|
||||
- MochiKit.DOM now has currentWindow() and currentDocument() context
|
||||
variables that are set with withWindow() and withDocument(). These
|
||||
context variables affect all MochiKit.DOM functionality (getElement,
|
||||
createDOM, etc.)
|
||||
- MochiKit.Base.items will now catch and ignore exceptions for properties
|
||||
that are enumerable but not accessible (e.g. permission denied)
|
||||
- MochiKit.Async.Deferred's addCallback/addErrback/addBoth
|
||||
now accept additional arguments that are used to create a partially
|
||||
applied function. This differs from Twisted in that the callback/errback
|
||||
result becomes the *last* argument, not the first when this feature
|
||||
is used.
|
||||
- MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
|
||||
arguments which are used to create a GET query string
|
||||
- Did some refactoring to reduce the footprint of MochiKit by a few
|
||||
kilobytes
|
||||
- escapeHTML to longer escapes ' (apos) and now uses
|
||||
String.replace instead of iterating over every char.
|
||||
- Added DeferredLock to Async
|
||||
- Renamed getElementsComputedStyle to computedStyle and moved
|
||||
it from MochiKit.Visual to MochiKit.DOM
|
||||
- Moved all color support out of MochiKit.Visual and into MochiKit.Color
|
||||
- Fixed range() to accept a negative step
|
||||
- New alias to MochiKit.swapDOM called removeElement
|
||||
- New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
|
||||
an attribute on a node without raising, roughly equivalent to:
|
||||
updateNodeAttributes(node, {attr: value})
|
||||
- New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
|
||||
a node's attribute or returns null without raising
|
||||
- Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
|
||||
directly (addLoadEvent did not leak, since it clears the handler)
|
||||
|
||||
2005-10-24 v1.0
|
||||
|
||||
- New interpreter example that shows usage of MochiKit.DOM to make
|
||||
an interactive JavaScript interpreter
|
||||
- New MochiKit.LoggingPane for use with the MochiKit.Logging
|
||||
debuggingBookmarklet, with logging_pane example to show its usage
|
||||
- New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
|
||||
in order to provide a live regular expression matching tool
|
||||
- Added advanced number formatting capabilities to MochiKit.Format:
|
||||
numberFormatter(pattern, placeholder="", locale="default") and
|
||||
formatLocale(locale="default")
|
||||
- Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
|
||||
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE
|
||||
- Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
|
||||
to MochiKit.Format
|
||||
- MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
|
||||
isoTimestamp(isoString) will convert them to Date objects, and
|
||||
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC
|
||||
- Fixed missing errback for sendXMLHttpRequest when the server does not
|
||||
respond
|
||||
- Fixed infinite recusion bug when using roundClass("DIV", ...)
|
||||
- Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
|
||||
from being cancelled properly
|
||||
- Workaround in MochiKit.Base bind (and partial) for functions that don't
|
||||
have an apply method, such as alert
|
||||
- Reliably return null from the string parsing/manipulation functions if
|
||||
the input can't be coerced to a string (s + "") or the input makes no sense;
|
||||
e.g. isoTimestamp(null) and isoTimestamp("") return null
|
||||
|
||||
2005-10-08 v0.90
|
||||
|
||||
- Fixed ISO compliance with toISODate
|
||||
- Added missing operator.sub
|
||||
- Placated Mozilla's strict warnings a bit
|
||||
- Added JSON serialization and unserialization support to MochiKit.Base:
|
||||
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
|
||||
API.
|
||||
- Fixed a bug in the script loader that failed in some scenarios when a script
|
||||
tag did not have a "src" attribute (thanks Ian!)
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
|
||||
P, FORM
|
||||
- Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
|
||||
and parseQueryString, when available.
|
||||
|
||||
2005-08-12 v0.80
|
||||
|
||||
- Source highlighting in all examples, moved to a view-source example
|
||||
- Added some experimental syntax highlighting for the Rounded Corners example,
|
||||
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib
|
||||
- Use an indirect binding for the logger conveniences, so that the global
|
||||
logger could be replaced by setting MochiKit.Logger.logger to something else
|
||||
(though an observer is probably a better choice).
|
||||
- Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
|
||||
which will be looked up with getElement
|
||||
- Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
|
||||
node.parentNode)
|
||||
- Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success
|
||||
- Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues
|
||||
- Possible workaround for Safari issue with swapDOM, where it would get
|
||||
confused because two elements were in the DOM at the same time with the
|
||||
same id
|
||||
- Added missing THEAD convenience function to MochiKit.DOM
|
||||
- Added lstrip, rstrip, strip to MochiKit.Format
|
||||
- Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
|
||||
MochiKit.DOM
|
||||
- MochiKit.Iter.iextend now has a fast-path for array-like objects
|
||||
- Added HSV color space support to MochiKit.Visual
|
||||
- Fixed a bug in the sortable_tables example, it now converts types
|
||||
correctly
|
||||
- Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
|
||||
scope
|
||||
|
||||
2005-08-04 v0.70
|
||||
|
||||
- New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
|
||||
a little TAL-ish DOM templating attribute language.
|
||||
- sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
|
||||
ignore requests with status == 0, which seems to happen for cached or local
|
||||
requests
|
||||
- Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.
|
||||
- Changed scrapeText API to return a string by default. This is API-breaking!
|
||||
It was dumb to have the default return value be the form you almost never
|
||||
want. Sorry.
|
||||
- Added special form to swapDOM(dest, src). If src is null, dest is removed
|
||||
(where previously you'd likely get a DOM exception).
|
||||
- Added three new functions to MochiKit.Base for dealing with URL query
|
||||
strings: urlEncode, queryString, parseQueryString
|
||||
- MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
|
||||
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
|
||||
new Function(v).
|
||||
- Another workaround for Internet "worst browser ever" Explorer's setAttribute
|
||||
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).
|
||||
- Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM
|
||||
- Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
|
||||
now!
|
||||
|
||||
2005-07-29 v0.60
|
||||
|
||||
- Beefed up the MochiKit.DOM test suite
|
||||
- Fixed return value for MochiKit.DOM.swapElementClass, could return
|
||||
false unexpectedly before
|
||||
- Added an optional "parent" argument to
|
||||
MochiKit.DOM.getElementsByTagAndClassName
|
||||
- Added a "packed" version in packed/MochiKit/MochiKit.js
|
||||
- Changed build script to rewrite the URLs in tests to account for the
|
||||
JSAN-required reorganization
|
||||
- MochiKit.Compat to potentially work around IE 5.5 issues
|
||||
(5.0 still not supported). Test.Simple doesn't seem to work there,
|
||||
though.
|
||||
- Several minor documentation corrections
|
||||
|
||||
2005-07-27 v0.50
|
||||
|
||||
- Initial Release
|
||||
@@ -0,0 +1,69 @@
|
||||
MochiKit is dual-licensed software. It is available under the terms of the
|
||||
MIT License, or the Academic Free License version 2.1. The full text of
|
||||
each license is included below.
|
||||
|
||||
MIT License
|
||||
===========
|
||||
|
||||
Copyright (c) 2005 Bob Ippolito. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
Academic Free License v. 2.1
|
||||
============================
|
||||
|
||||
Copyright (c) 2005 Bob Ippolito. All rights reserved.
|
||||
|
||||
This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following notice immediately following the copyright notice for the Original Work:
|
||||
|
||||
Licensed under the Academic Free License version 2.1
|
||||
|
||||
1) Grant of Copyright License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license to do the following:
|
||||
|
||||
a) to reproduce the Original Work in copies;
|
||||
|
||||
b) to prepare derivative works ("Derivative Works") based upon the Original Work;
|
||||
|
||||
c) to distribute copies of the Original Work and Derivative Works to the public;
|
||||
|
||||
d) to perform the Original Work publicly; and
|
||||
|
||||
e) to display the Original Work publicly.
|
||||
|
||||
2) Grant of Patent License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, to make, use, sell and offer for sale the Original Work and Derivative Works.
|
||||
|
||||
3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor hereby agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work, and by publishing the address of that information repository in a notice immediately following the copyright notice that applies to the Original Work.
|
||||
|
||||
4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior written permission of the Licensor. Nothing in this License shall be deemed to grant any rights to trademarks, copyrights, patents, trade secrets or any other intellectual property of Licensor except as expressly stated herein. No patent license is granted to make, use, sell or offer to sell embodiments of any patent claims other than the licensed claims defined in Section 2. No right is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under different terms from this License any Original Work that Licensor otherwise would have a right to license.
|
||||
|
||||
5) This section intentionally omitted.
|
||||
|
||||
6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
|
||||
|
||||
7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately proceeding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of NON-INFRINGEMENT, MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to Original Work is granted hereunder except under this disclaimer.
|
||||
|
||||
8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to any person for any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to liability for death or personal injury resulting from Licensor's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
|
||||
|
||||
9) Acceptance and Termination. If You distribute copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. Nothing else but this License (or another written agreement between Licensor and You) grants You permission to create Derivative Works based upon the Original Work or to exercise any of the rights granted in Section 1 herein, and any attempt to do so except under the terms of this License (or another written agreement between Licensor and You) is expressly prohibited by U.S. copyright law, the equivalent laws of other countries, and by international treaty. Therefore, by exercising any of the rights granted to You in Section 1 herein, You indicate Your acceptance of this License and all of its terms and conditions.
|
||||
|
||||
10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
|
||||
|
||||
11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of the U.S. Copyright Act, 17 U.S.C. § 101 et seq., the equivalent laws of other countries, and international treaty. This section shall survive the termination of this License.
|
||||
|
||||
12) Attorneys Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
|
||||
|
||||
13) Miscellaneous. This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
|
||||
|
||||
14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
|
||||
|
||||
This license is Copyright (C) 2003-2004 Lawrence E. Rosen. All rights reserved. Permission is hereby granted to copy and distribute this license without modification. This license may not be modified without the express written permission of its copyright owner.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,115 @@
|
||||
Changes
|
||||
META.json
|
||||
MANIFEST This list of files
|
||||
LICENSE.txt
|
||||
doc/html/MochiKit/Async.html
|
||||
doc/html/MochiKit/Base.html
|
||||
doc/html/MochiKit/Color.html
|
||||
doc/html/MochiKit/DateTime.html
|
||||
doc/html/MochiKit/DOM.html
|
||||
doc/html/MochiKit/Format.html
|
||||
doc/html/MochiKit/index.html
|
||||
doc/html/MochiKit/Iter.html
|
||||
doc/html/MochiKit/Logging.html
|
||||
doc/html/MochiKit/LoggingPane.html
|
||||
doc/html/MochiKit/Signal.html
|
||||
doc/html/MochiKit/VersionHistory.html
|
||||
doc/html/MochiKit/Visual.html
|
||||
doc/js/toc.js
|
||||
doc/rst/MochiKit/Async.rst
|
||||
doc/rst/MochiKit/Base.rst
|
||||
doc/rst/MochiKit/Color.rst
|
||||
doc/rst/MochiKit/DateTime.rst
|
||||
doc/rst/MochiKit/DOM.rst
|
||||
doc/rst/MochiKit/Format.rst
|
||||
doc/rst/MochiKit/index.rst
|
||||
doc/rst/MochiKit/Iter.rst
|
||||
doc/rst/MochiKit/Logging.rst
|
||||
doc/rst/MochiKit/LoggingPane.rst
|
||||
doc/rst/MochiKit/Signal.rst
|
||||
doc/rst/MochiKit/VersionHistory.rst
|
||||
doc/rst/MochiKit/Visual.rst
|
||||
examples/ajax_tables/ajax_tables.css
|
||||
examples/ajax_tables/ajax_tables.js
|
||||
examples/ajax_tables/domains.json
|
||||
examples/ajax_tables/domains.xml
|
||||
examples/ajax_tables/index.html
|
||||
examples/color_wheel/color_wheel.css
|
||||
examples/color_wheel/color_wheel.js
|
||||
examples/color_wheel/index.html
|
||||
examples/draggable/draggable.css
|
||||
examples/draggable/draggable.js
|
||||
examples/draggable/index.html
|
||||
examples/interpreter/index.html
|
||||
examples/interpreter/interpreter.css
|
||||
examples/interpreter/interpreter.js
|
||||
examples/key_events/index.html
|
||||
examples/key_events/key_events.css
|
||||
examples/key_events/key_events.js
|
||||
examples/logging_pane/index.html
|
||||
examples/logging_pane/logging_pane.css
|
||||
examples/logging_pane/logging_pane.js
|
||||
examples/mochiregexp/index.html
|
||||
examples/mochiregexp/mochiregexp.css
|
||||
examples/mochiregexp/mochiregexp.js
|
||||
examples/rounded_corners/index.html
|
||||
examples/rounded_corners/rounded_corners.css
|
||||
examples/rounded_corners/rounded_corners.js
|
||||
examples/sortable_tables/index.html
|
||||
examples/sortable_tables/sortable_tables.css
|
||||
examples/sortable_tables/sortable_tables.js
|
||||
examples/view-source/view-source.css
|
||||
examples/view-source/view-source.html
|
||||
examples/view-source/view-source.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushCSharp.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushDelphi.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushJScript.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushPhp.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushPython.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushSql.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushVb.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shBrushXml.js
|
||||
examples/view-source/lib/SyntaxHighlighter/shCore.js
|
||||
examples/view-source/lib/SyntaxHighlighter/SyntaxHighlighter.css
|
||||
examples/view-source/lib/SyntaxHighlighter/Tests.html
|
||||
include/css/documentation.css
|
||||
include/css/general.css
|
||||
MochiKit/__package__.js
|
||||
MochiKit/Async.js
|
||||
MochiKit/Base.js
|
||||
MochiKit/Color.js
|
||||
MochiKit/DateTime.js
|
||||
MochiKit/DOM.js
|
||||
MochiKit/Format.js
|
||||
MochiKit/Iter.js
|
||||
MochiKit/Logging.js
|
||||
MochiKit/LoggingPane.js
|
||||
MochiKit/MochiKit.js
|
||||
MochiKit/MockDOM.js
|
||||
MochiKit/Signal.js
|
||||
MochiKit/Test.js
|
||||
MochiKit/Visual.js
|
||||
packed/MochiKit/__package__.js
|
||||
packed/MochiKit/MochiKit.js
|
||||
tests/index.html
|
||||
tests/test_Base.js
|
||||
tests/test_Color.js
|
||||
tests/test_DateTime.js
|
||||
tests/test_Format.js
|
||||
tests/test_Iter.js
|
||||
tests/test_Logging.js
|
||||
tests/test_MochiKit-Async.html
|
||||
tests/test_MochiKit-Base.html
|
||||
tests/test_MochiKit-Color.html
|
||||
tests/test_MochiKit-DateTime.html
|
||||
tests/test_MochiKit-DOM.html
|
||||
tests/test_MochiKit-Format.html
|
||||
tests/test_MochiKit-Iter.html
|
||||
tests/test_MochiKit-JSAN.html
|
||||
tests/test_MochiKit-Logging.html
|
||||
tests/test_MochiKit-MochiKit.html
|
||||
tests/test_MochiKit-Signal.html
|
||||
tests/test_Signal.js
|
||||
tests/SimpleTest/SimpleTest.js
|
||||
tests/SimpleTest/test.css
|
||||
tests/SimpleTest/TestRunner.js
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"recommends": {
|
||||
"JSAN": "0.10"
|
||||
},
|
||||
"name": "MochiKit",
|
||||
"license": "mit",
|
||||
"author": [
|
||||
"Bob Ippolito <bob@redivi.com>"
|
||||
],
|
||||
"abstract": "Python-inspired JavaScript kit",
|
||||
"generated_by": "MochiKit's build script",
|
||||
"build_requires": {
|
||||
"Test.Simple": "0.11"
|
||||
},
|
||||
"version": "1.3.1",
|
||||
"provides": {}
|
||||
}
|
||||
@@ -0,0 +1,606 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Async - manage asynchronous tasks</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Async - manage asynchronous tasks</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
var url = "/src/b/bo/bob/MochiKit.Async/META.json";
|
||||
/*
|
||||
|
||||
META.json looks something like this:
|
||||
|
||||
{"name": "MochiKit", "version": "0.5"}
|
||||
|
||||
*/
|
||||
var d = loadJSONDoc(url);
|
||||
var gotMetadata = function (meta) {
|
||||
if (MochiKit.Async.VERSION == meta.version) {
|
||||
alert("You have the newest MochiKit.Async!");
|
||||
} else {
|
||||
alert("MochiKit.Async "
|
||||
+ meta.version
|
||||
+ " is available, upgrade!");
|
||||
}
|
||||
};
|
||||
var metadataFetchFailed = function (err) {
|
||||
alert("The metadata for MochiKit.Async could not be fetched :(");
|
||||
};
|
||||
d.addCallbacks(gotMetadata, metadataFetchFailed);
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>MochiKit.Async provides facilities to manage asynchronous
|
||||
(as in AJAX <a class="footnote-reference" href="#id7" id="id1" name="id1">[1]</a>) tasks. The model for asynchronous computation
|
||||
used in this module is heavily inspired by Twisted <a class="footnote-reference" href="#id8" id="id2" name="id2">[2]</a>.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="deferred" name="deferred">Deferred</a></h2>
|
||||
<p>The Deferred constructor encapsulates a single value that
|
||||
is not available yet. The most important example of this
|
||||
in the context of a web browser would be an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
|
||||
to a server. The importance of the Deferred is that it
|
||||
allows a consistent API to be exposed for all asynchronous
|
||||
computations that occur exactly once.</p>
|
||||
<p>The producer of the Deferred is responsible for doing all
|
||||
of the complicated work behind the scenes. This often
|
||||
means waiting for a timer to fire, or waiting for an event
|
||||
(e.g. <tt class="docutils literal"><span class="pre">onreadystatechange</span></tt> of <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>).
|
||||
It could also be coordinating several events (e.g.
|
||||
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> with a timeout, or several Deferreds
|
||||
(e.g. fetching a set of XML documents that should be
|
||||
processed at the same time).</p>
|
||||
<p>Since these sorts of tasks do not respond immediately, the
|
||||
producer of the Deferred does the following steps before
|
||||
returning to the consumer:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Create a <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred();</a> object and keep a reference
|
||||
to it, because it will be needed later when the value is
|
||||
ready.</li>
|
||||
<li>Setup the conditions to create the value requested (e.g.
|
||||
create a new <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>, set its
|
||||
<tt class="docutils literal"><span class="pre">onreadystatechange</span></tt>).</li>
|
||||
<li>Return the <a class="mochiref reference" href="#fn-deferred">Deferred</a> object.</li>
|
||||
</ol>
|
||||
<p>Since the value is not yet ready, the consumer attaches
|
||||
a function to the Deferred that will be called when the
|
||||
value is ready. This is not unlike <tt class="docutils literal"><span class="pre">setTimeout</span></tt>, or
|
||||
other similar facilities you may already be familiar with.
|
||||
The consumer can also attach an "errback" to the
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a>, which is a callback for error handling.</p>
|
||||
<p>When the value is ready, the producer simply calls
|
||||
<tt class="docutils literal"><span class="pre">myDeferred.callback(theValue)</span></tt>. If an error occurred,
|
||||
it should call <tt class="docutils literal"><span class="pre">myDeferred.errback(theValue)</span></tt> instead.
|
||||
As soon as this happens, the callback that the consumer
|
||||
attached to the <a class="mochiref reference" href="#fn-deferred">Deferred</a> is called with <tt class="docutils literal"><span class="pre">theValue</span></tt>
|
||||
as the only argument.</p>
|
||||
<p>There are quite a few additional "advanced" features
|
||||
baked into <a class="mochiref reference" href="#fn-deferred">Deferred</a>, such as cancellation and
|
||||
callback chains, so take a look at the API
|
||||
reference if you would like to know more!</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="errors" name="errors">Errors</a></h2>
|
||||
<p>
|
||||
<a name="fn-alreadycallederror"></a>
|
||||
<a class="mochidef reference" href="#fn-alreadycallederror">AlreadyCalledError</a>:</p>
|
||||
<blockquote>
|
||||
Thrown by a <a class="mochiref reference" href="#fn-deferred">Deferred</a> if <tt class="docutils literal"><span class="pre">.callback</span></tt> or
|
||||
<tt class="docutils literal"><span class="pre">.errback</span></tt> are called more than once.</blockquote>
|
||||
<p>
|
||||
<a name="fn-browsercomplianceerror"></a>
|
||||
<a class="mochidef reference" href="#fn-browsercomplianceerror">BrowserComplianceError</a>:</p>
|
||||
<blockquote>
|
||||
Thrown when the JavaScript runtime is not capable of performing
|
||||
the given function. Currently, this happens if the browser
|
||||
does not support <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-cancellederror"></a>
|
||||
<a class="mochidef reference" href="#fn-cancellederror">CancelledError</a>:</p>
|
||||
<blockquote>
|
||||
Thrown by a <a class="mochiref reference" href="#fn-deferred">Deferred</a> when it is cancelled,
|
||||
unless a canceller is present and throws something else.</blockquote>
|
||||
<p>
|
||||
<a name="fn-genericerror"></a>
|
||||
<a class="mochidef reference" href="#fn-genericerror">GenericError</a>:</p>
|
||||
<blockquote>
|
||||
Results passed to <tt class="docutils literal"><span class="pre">.fail</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> of a <a class="mochiref reference" href="#fn-deferred">Deferred</a>
|
||||
are wrapped by this <tt class="docutils literal"><span class="pre">Error</span></tt> if <tt class="docutils literal"><span class="pre">!(result</span> <span class="pre">instanceof</span> <span class="pre">Error)</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-xmlhttprequesterror"></a>
|
||||
<a class="mochidef reference" href="#fn-xmlhttprequesterror">XMLHttpRequestError</a>:</p>
|
||||
<blockquote>
|
||||
Thrown when an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> does not complete successfully
|
||||
for any reason. The <tt class="docutils literal"><span class="pre">req</span></tt> property of the error is the failed
|
||||
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object, and for convenience the <tt class="docutils literal"><span class="pre">number</span></tt>
|
||||
property corresponds to <tt class="docutils literal"><span class="pre">req.status</span></tt>.</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="constructors" name="constructors">Constructors</a></h2>
|
||||
<p>
|
||||
<a name="fn-deferred"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred">Deferred()</a>:</p>
|
||||
<blockquote>
|
||||
Encapsulates a sequence of callbacks in response to a value that
|
||||
may not yet be available. This is modeled after the Deferred class
|
||||
from Twisted <a class="footnote-reference" href="#id9" id="id3" name="id3">[3]</a>.</blockquote>
|
||||
<blockquote>
|
||||
<p>Why do we want this? JavaScript has no threads, and even if it did,
|
||||
threads are hard. Deferreds are a way of abstracting non-blocking
|
||||
events, such as the final response to an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</p>
|
||||
<p>The sequence of callbacks is internally represented as a list
|
||||
of 2-tuples containing the callback/errback pair. For example,
|
||||
the following call sequence:</p>
|
||||
<pre class="literal-block">
|
||||
var d = new Deferred();
|
||||
d.addCallback(myCallback);
|
||||
d.addErrback(myErrback);
|
||||
d.addBoth(myBoth);
|
||||
d.addCallbacks(myCallback, myErrback);
|
||||
</pre>
|
||||
<p>is translated into a <a class="mochiref reference" href="#fn-deferred">Deferred</a> with the following internal
|
||||
representation:</p>
|
||||
<pre class="literal-block">
|
||||
[
|
||||
[myCallback, null],
|
||||
[null, myErrback],
|
||||
[myBoth, myBoth],
|
||||
[myCallback, myErrback]
|
||||
]
|
||||
</pre>
|
||||
<p>The <a class="mochiref reference" href="#fn-deferred">Deferred</a> also keeps track of its current status (fired).
|
||||
Its status may be one of the following three values:</p>
|
||||
<blockquote>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="14%" />
|
||||
<col width="86%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">Value</th>
|
||||
<th class="head">Condition</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td>-1</td>
|
||||
<td>no value yet (initial condition)</td>
|
||||
</tr>
|
||||
<tr><td>0</td>
|
||||
<td>success</td>
|
||||
</tr>
|
||||
<tr><td>1</td>
|
||||
<td>error</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</blockquote>
|
||||
<p>A <a class="mochiref reference" href="#fn-deferred">Deferred</a> will be in the error state if one of the following
|
||||
conditions are met:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>The result given to callback or errback is "<tt class="docutils literal"><span class="pre">instanceof</span> <span class="pre">Error</span></tt>"</li>
|
||||
<li>The callback or errback threw while executing. If the thrown object
|
||||
is not <tt class="docutils literal"><span class="pre">instanceof</span> <span class="pre">Error</span></tt>, it will be wrapped with
|
||||
<a class="mochiref reference" href="#fn-genericerror">GenericError</a>.</li>
|
||||
</ol>
|
||||
<p>Otherwise, the <a class="mochiref reference" href="#fn-deferred">Deferred</a> will be in the success state. The state
|
||||
of the <a class="mochiref reference" href="#fn-deferred">Deferred</a> determines the next element in the callback
|
||||
sequence to run.</p>
|
||||
<p>When a callback or errback occurs with the example deferred chain, something
|
||||
equivalent to the following will happen (imagine that exceptions are caught
|
||||
and returned as-is):</p>
|
||||
<pre class="literal-block">
|
||||
// d.callback(result) or d.errback(result)
|
||||
if (!(result instanceof Error)) {
|
||||
result = myCallback(result);
|
||||
}
|
||||
if (result instanceof Error) {
|
||||
result = myErrback(result);
|
||||
}
|
||||
result = myBoth(result);
|
||||
if (result instanceof Error) {
|
||||
result = myErrback(result);
|
||||
} else {
|
||||
result = myCallback(result);
|
||||
}
|
||||
</pre>
|
||||
<p>The result is then stored away in case another step is added to the
|
||||
callback sequence. Since the <a class="mochiref reference" href="#fn-deferred">Deferred</a> already has a value
|
||||
available, any new callbacks added will be called immediately.</p>
|
||||
<p>There are two other "advanced" details about this implementation that are
|
||||
useful:</p>
|
||||
<p>Callbacks are allowed to return <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances,
|
||||
so you can build complicated sequences of events with (relative) ease.</p>
|
||||
<p>The creator of the <a class="mochiref reference" href="#fn-deferred">Deferred</a> may specify a canceller. The
|
||||
canceller is a function that will be called if
|
||||
<a class="mochiref reference" href="#fn-deferred.prototype.cancel">Deferred.prototype.cancel</a> is called before the
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a> fires. You can use this to allow an
|
||||
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> to be cleanly cancelled, for example. Note that
|
||||
cancel will fire the <a class="mochiref reference" href="#fn-deferred">Deferred</a> with a
|
||||
<a class="mochiref reference" href="#fn-cancellederror">CancelledError</a> (unless your canceller throws or returns
|
||||
a different <tt class="docutils literal"><span class="pre">Error</span></tt>), so errbacks should be prepared to handle that
|
||||
<tt class="docutils literal"><span class="pre">Error</span></tt> gracefully for cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.addboth"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.addboth">Deferred.prototype.addBoth(func)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Add the same function as both a callback and an errback as the
|
||||
next element on the callback sequence. This is useful for code
|
||||
that you want to guarantee to run, e.g. a finalizer.</p>
|
||||
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
|
||||
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
|
||||
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the callback or
|
||||
errback will be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
|
||||
callbacks.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.addcallback"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.addcallback">Deferred.prototype.addCallback(func[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Add a single callback to the end of the callback sequence.</p>
|
||||
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
|
||||
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
|
||||
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the callback will
|
||||
be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
|
||||
callbacks.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.addcallbacks"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.addcallbacks">Deferred.prototype.addCallbacks(callback, errback)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Add separate callback and errback to the end of the callback
|
||||
sequence. Either callback or errback may be <tt class="docutils literal"><span class="pre">null</span></tt>,
|
||||
but not both.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">callback</span></tt> or <tt class="docutils literal"><span class="pre">errback</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>,
|
||||
then it will be chained (its value or error will be passed to the
|
||||
next callback). Note that once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained,
|
||||
it can no longer accept new callbacks.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.adderrback"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.adderrback">Deferred.prototype.addErrback(func)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Add a single errback to the end of the callback sequence.</p>
|
||||
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
|
||||
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
|
||||
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the errback will
|
||||
be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
|
||||
callbacks.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.callback"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.callback">Deferred.prototype.callback([result])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Begin the callback sequence with a non-<tt class="docutils literal"><span class="pre">Error</span></tt> result. Result
|
||||
may be any value except for a <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
|
||||
<p>Either <tt class="docutils literal"><span class="pre">.callback</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> should
|
||||
be called exactly once on a <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.cancel"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.cancel">Deferred.prototype.cancel()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Cancels a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has not yet received a value,
|
||||
or is waiting on another <a class="mochiref reference" href="#fn-deferred">Deferred</a> as its value.</p>
|
||||
<p>If a canceller is defined, the canceller is called.
|
||||
If the canceller did not return an <tt class="docutils literal"><span class="pre">Error</span></tt>, or there
|
||||
was no canceller, then the errback chain is started
|
||||
with <a class="mochiref reference" href="#fn-cancellederror">CancelledError</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferred.prototype.errback"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred.prototype.errback">Deferred.prototype.errback([result])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Begin the callback sequence with an error result.
|
||||
Result may be any value except for a <a class="mochiref reference" href="#fn-deferred">Deferred</a>,
|
||||
but if <tt class="docutils literal"><span class="pre">!(result</span> <span class="pre">instanceof</span> <span class="pre">Error)</span></tt>, it will be wrapped
|
||||
with <a class="mochiref reference" href="#fn-genericerror">GenericError</a>.</p>
|
||||
<p>Either <tt class="docutils literal"><span class="pre">.callback</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> should
|
||||
be called exactly once on a
|
||||
<a name="fn-deferred"></a>
|
||||
<a class="mochidef reference" href="#fn-deferred">Deferred</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferredlock"></a>
|
||||
<a class="mochidef reference" href="#fn-deferredlock">DeferredLock()</a>:</p>
|
||||
<blockquote>
|
||||
<p>A lock for asynchronous systems.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre">locked</span></tt> property of a <a class="mochiref reference" href="#fn-deferredlock">DeferredLock</a> will be <tt class="docutils literal"><span class="pre">true</span></tt> if
|
||||
it locked, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise. Do not change this property.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferredlock.prototype.acquire"></a>
|
||||
<a class="mochidef reference" href="#fn-deferredlock.prototype.acquire">DeferredLock.prototype.acquire()</a>:</p>
|
||||
<blockquote>
|
||||
Attempt to acquire the lock. Returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that fires on
|
||||
lock acquisition with the <a class="mochiref reference" href="#fn-deferredlock">DeferredLock</a> as the value.
|
||||
If the lock is locked, then the <a class="mochiref reference" href="#fn-deferred">Deferred</a> goes into a waiting
|
||||
list.</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferredlock.prototype.release"></a>
|
||||
<a class="mochidef reference" href="#fn-deferredlock.prototype.release">DeferredLock.prototype.release()</a>:</p>
|
||||
<blockquote>
|
||||
Release the lock. If there is a waiting list, then the first
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a> in that waiting list will be called back.</blockquote>
|
||||
<p>
|
||||
<a name="fn-deferredlist"></a>
|
||||
<a class="mochidef reference" href="#fn-deferredlist">DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Combine a list of <a class="mochiref reference" href="#fn-deferred">Deferred</a> into one. Track the callbacks and
|
||||
return a list of (success, result) tuples, 'success' being a boolean
|
||||
indicating whether result is a normal result or an error.</p>
|
||||
<p>Once created, you have access to all <a class="mochiref reference" href="#fn-deferred">Deferred</a> methods, like
|
||||
addCallback, addErrback, addBoth. The behaviour can be changed by the
|
||||
following options:</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">fireOnOneCallback</span></tt>:</dt>
|
||||
<dd>Flag for launching the callback once the first Deferred of the list
|
||||
has returned.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">fireOnOneErrback</span></tt>:</dt>
|
||||
<dd>Flag for calling the errback at the first error of a Deferred.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">consumeErrors</span></tt>:</dt>
|
||||
<dd>Flag indicating that any errors raised in the Deferreds should be
|
||||
consumed by the DeferredList.</dd>
|
||||
</dl>
|
||||
<p>Example:</p>
|
||||
<pre class="literal-block">
|
||||
// We need to fetch data from 2 different urls
|
||||
var d1 = loadJSONDoc(url1);
|
||||
var d2 = loadJSONDoc(url2);
|
||||
var l1 = new DeferredList([d1, d2], false, false, true);
|
||||
l1.addCallback(function (resultList) {
|
||||
MochiKit.Base.map(function (result) {
|
||||
if (result[0]) {
|
||||
alert("Data is here: " + result[1]);
|
||||
} else {
|
||||
alert("Got an error: " + result[1]);
|
||||
}
|
||||
}, resultList);
|
||||
});
|
||||
</pre>
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-calllater"></a>
|
||||
<a class="mochidef reference" href="#fn-calllater">callLater(seconds, func[, args...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Call <tt class="docutils literal"><span class="pre">func(args...)</span></tt> after at least <tt class="docutils literal"><span class="pre">seconds</span></tt> seconds have elapsed.
|
||||
This is a convenience method for:</p>
|
||||
<pre class="literal-block">
|
||||
func = partial.apply(extend(null, arguments, 1));
|
||||
return wait(seconds).addCallback(function (res) { return func() });
|
||||
</pre>
|
||||
<p>Returns a cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-dosimplexmlhttprequest"></a>
|
||||
<a class="mochidef reference" href="#fn-dosimplexmlhttprequest">doSimpleXMLHttpRequest(url[, queryArguments...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Perform a simple <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> and wrap it with a
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a> that may be cancelled.</p>
|
||||
<p>Note that currently, only <tt class="docutils literal"><span class="pre">200</span></tt> (OK) and <tt class="docutils literal"><span class="pre">304</span></tt>
|
||||
(NOT_MODIFIED) are considered success codes at this time, other
|
||||
status codes will result in an errback with an <tt class="docutils literal"><span class="pre">XMLHttpRequestError</span></tt>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">url</span></tt>:</dt>
|
||||
<dd>The URL to GET</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">queryArguments</span></tt>:</dt>
|
||||
<dd><p class="first">If this function is called with more than one argument, a <tt class="docutils literal"><span class="pre">"?"</span></tt>
|
||||
and the result of <a class="mochiref reference" href="Base.html#fn-querystring">MochiKit.Base.queryString</a> with
|
||||
the rest of the arguments are appended to the URL.</p>
|
||||
<p>For example, this will do a GET request to the URL
|
||||
<tt class="docutils literal"><span class="pre">http://example.com?bar=baz</span></tt>:</p>
|
||||
<pre class="last literal-block">
|
||||
doSimpleXMLHttpRequest("http://example.com", {bar: "baz"});
|
||||
</pre>
|
||||
</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
|
||||
instance on success</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-evaljsonrequest"></a>
|
||||
<a class="mochidef reference" href="#fn-evaljsonrequest">evalJSONRequest(req)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Evaluate a JSON <a class="footnote-reference" href="#id10" id="id4" name="id4">[4]</a> <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt></p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">req</span></tt>:</dt>
|
||||
<dd>The request whose <tt class="docutils literal"><span class="pre">.responseText</span></tt> property is to be evaluated</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>A JavaScript object</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-fail"></a>
|
||||
<a class="mochidef reference" href="#fn-fail">fail([result])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has already had <tt class="docutils literal"><span class="pre">.errback(result)</span></tt>
|
||||
called.</p>
|
||||
<p>See <tt class="docutils literal"><span class="pre">succeed</span></tt> documentation for rationale.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">result</span></tt>:</dt>
|
||||
<dd>The result to give to <a class="mochiref reference" href="#fn-deferred.prototype.errback">Deferred.prototype.errback(result)</a>.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>A <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred()</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-gatherresults"></a>
|
||||
<a class="mochidef reference" href="#fn-gatherresults">gatherResults(deferreds)</a>:</p>
|
||||
<blockquote>
|
||||
A convenience function that returns a <a class="mochiref reference" href="#fn-deferredlist">DeferredList</a>
|
||||
from the given <tt class="docutils literal"><span class="pre">Array</span></tt> of <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances
|
||||
that will callback with an <tt class="docutils literal"><span class="pre">Array</span></tt> of just results when
|
||||
they're available, or errback on the first array.</blockquote>
|
||||
<p>
|
||||
<a name="fn-getxmlhttprequest"></a>
|
||||
<a class="mochidef reference" href="#fn-getxmlhttprequest">getXMLHttpRequest()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> compliant object for the current
|
||||
platform.</p>
|
||||
<p>In order of preference:</p>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">XMLHttpRequest()</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Msxml2.XMLHTTP')</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Microsoft.XMLHTTP')</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Msxml2.XMLHTTP.4.0')</span></tt></li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-maybedeferred"></a>
|
||||
<a class="mochidef reference" href="#fn-maybedeferred">maybeDeferred(func[, argument...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Call a <tt class="docutils literal"><span class="pre">func</span></tt> with the given arguments and ensure the result is a
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">func</span></tt>:</dt>
|
||||
<dd>The function to call.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>A new <a class="mochiref reference" href="#fn-deferred">Deferred</a> based on the call to <tt class="docutils literal"><span class="pre">func</span></tt>. If <tt class="docutils literal"><span class="pre">func</span></tt>
|
||||
does not naturally return a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, its result or error
|
||||
value will be wrapped by one.</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-loadjsondoc"></a>
|
||||
<a class="mochidef reference" href="#fn-loadjsondoc">loadJSONDoc(url)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Do a simple <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> to a URL and get the response
|
||||
as a JSON <a class="footnote-reference" href="#id10" id="id5" name="id5">[4]</a> document.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">url</span></tt>:</dt>
|
||||
<dd>The URL to GET</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the evaluated JSON <a class="footnote-reference" href="#id10" id="id6" name="id6">[4]</a>
|
||||
response upon successful <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-sendxmlhttprequest"></a>
|
||||
<a class="mochidef reference" href="#fn-sendxmlhttprequest">sendXMLHttpRequest(req[, sendContent])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Set an <tt class="docutils literal"><span class="pre">onreadystatechange</span></tt> handler on an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object
|
||||
and send it off. Will return a cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> that will
|
||||
callback on success.</p>
|
||||
<p>Note that currently, only <tt class="docutils literal"><span class="pre">200</span></tt> (OK) and <tt class="docutils literal"><span class="pre">304</span></tt>
|
||||
(NOT_MODIFIED) are considered success codes at this time, other
|
||||
status codes will result in an errback with an <tt class="docutils literal"><span class="pre">XMLHttpRequestError</span></tt>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">req</span></tt>:</dt>
|
||||
<dd>An preconfigured <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object (open has been called).</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">sendContent</span></tt>:</dt>
|
||||
<dd>Optional string or DOM content to send over the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
|
||||
instance on success.</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-succeed"></a>
|
||||
<a class="mochidef reference" href="#fn-succeed">succeed([result])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has already had <tt class="docutils literal"><span class="pre">.callback(result)</span></tt>
|
||||
called.</p>
|
||||
<p>This is useful when you're writing synchronous code to an asynchronous
|
||||
interface: i.e., some code is calling you expecting a <a class="mochiref reference" href="#fn-deferred">Deferred</a>
|
||||
result, but you don't actually need to do anything asynchronous. Just
|
||||
return <tt class="docutils literal"><span class="pre">succeed(theResult)</span></tt>.</p>
|
||||
<p>See <tt class="docutils literal"><span class="pre">fail</span></tt> for a version of this function that uses a failing
|
||||
<a class="mochiref reference" href="#fn-deferred">Deferred</a> rather than a successful one.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">result</span></tt>:</dt>
|
||||
<dd>The result to give to <a class="mochiref reference" href="#fn-deferred.prototype.callback">Deferred.prototype.callback(result)</a></dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>a <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-wait"></a>
|
||||
<a class="mochidef reference" href="#fn-wait">wait(seconds[, res])</a>:</p>
|
||||
<blockquote>
|
||||
Return a new cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> that will <tt class="docutils literal"><span class="pre">.callback(res)</span></tt>
|
||||
after at least <tt class="docutils literal"><span class="pre">seconds</span></tt> seconds have elapsed.</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id7" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id1" name="id7">[1]</a></td><td>AJAX, Asynchronous JavaScript and XML: <a class="reference" href="http://en.wikipedia.org/wiki/AJAX">http://en.wikipedia.org/wiki/AJAX</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id8" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id2" name="id8">[2]</a></td><td>Twisted, an event-driven networking framework written in Python: <a class="reference" href="http://twistedmatrix.com/">http://twistedmatrix.com/</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id9" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id3" name="id9">[3]</a></td><td>Twisted Deferred Reference: <a class="reference" href="http://twistedmatrix.com/projects/core/documentation/howto/defer.html">http://twistedmatrix.com/projects/core/documentation/howto/defer.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id10" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id10">[4]</a></td><td><em>(<a class="fn-backref" href="#id4">1</a>, <a class="fn-backref" href="#id5">2</a>, <a class="fn-backref" href="#id6">3</a>)</em> JSON, JavaScript Object Notation: <a class="reference" href="http://json.org/">http://json.org/</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,509 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Color - color abstraction with CSS3 support</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Color - color abstraction with CSS3 support</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
// RGB color expressions are supported
|
||||
assert(
|
||||
objEqual(Color.whiteColor(), Color.fromString("rgb(255,100%, 255)"))
|
||||
);
|
||||
|
||||
// So is instantiating directly from HSL or RGB values.
|
||||
// Note that fromRGB and fromHSL take numbers between 0.0 and 1.0!
|
||||
assert( objEqual(Color.fromRGB(1.0, 1.0, 1.0), Color.fromHSL(0.0, 0.0, 1.0) );
|
||||
|
||||
// Or even SVG color keyword names, as per CSS3!
|
||||
assert( Color.fromString("aquamarine"), "#7fffd4" );
|
||||
|
||||
// NSColor-like colors built in
|
||||
assert( Color.whiteColor().toHexString() == "#ffffff" );
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>MochiKit.Color is an abstraction for handling colors and strings that
|
||||
represent colors.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<p>MochiKit.Color provides an abstraction of RGB, HSL and HSV colors with alpha.
|
||||
It supports parsing and generating of CSS3 colors, and has a full CSS3 (SVG)
|
||||
color table.</p>
|
||||
<p>All of the functionality in this module is exposed through a Color constructor
|
||||
and its prototype, but a few of its internals are available for direct use at
|
||||
module level.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="constructors" name="constructors">Constructors</a></h2>
|
||||
<p>
|
||||
<a name="fn-color"></a>
|
||||
<a class="mochidef reference" href="#fn-color">Color()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Represents a color. Component values should be integers between <tt class="docutils literal"><span class="pre">0.0</span></tt>
|
||||
and <tt class="docutils literal"><span class="pre">1.0</span></tt>. You should use one of the <a class="mochiref reference" href="#fn-color">Color</a> factory
|
||||
functions such as <a class="mochiref reference" href="#fn-color.fromrgb">Color.fromRGB</a>, <a class="mochiref reference" href="#fn-color.fromhsl">Color.fromHSL</a>,
|
||||
etc. instead of constructing <a class="mochiref reference" href="#fn-color">Color</a> objects directly.</p>
|
||||
<p><a class="mochiref reference" href="#fn-color">Color</a> instances can be compared with
|
||||
<a class="mochiref reference" href="Base.html#fn-compare">MochiKit.Base.compare</a> (though ordering is on RGB, so is not
|
||||
particularly meaningful except for equality), and the default <tt class="docutils literal"><span class="pre">toString</span></tt>
|
||||
implementation returns <a class="mochiref reference" href="#fn-color.prototype.tohexstring">Color.prototype.toHexString()</a>.</p>
|
||||
<p><a class="mochiref reference" href="#fn-color">Color</a> instances are immutable, and much of the architecture is
|
||||
inspired by AppKit's NSColor <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a></p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.frombackground"></a>
|
||||
<a class="mochidef reference" href="#fn-color.frombackground">Color.fromBackground(elem)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the background of the provided
|
||||
element. Equivalent to:</p>
|
||||
<pre class="literal-block">
|
||||
c = Color.fromComputedStyle(
|
||||
elem, "backgroundColor", "background-color") || Color.whiteColor();
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromcomputedstyle"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromcomputedstyle">Color.fromComputedStyle(elem, style, mozillaEquivalentCSS)</a>:</p>
|
||||
<blockquote>
|
||||
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the result of
|
||||
<a class="mochiref reference" href="DOM.html#fn-computedstyle">MochiKit.DOM.computedStyle(elem, style, mozillaEquivalentCSS)</a>
|
||||
or <tt class="docutils literal"><span class="pre">null</span></tt> if not found.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromhexstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromhexstring">Color.fromHexString(hexString)</a>:</p>
|
||||
<blockquote>
|
||||
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given hexadecimal color string.
|
||||
For example, <tt class="docutils literal"><span class="pre">"#FFFFFF"</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
|
||||
RGB values <tt class="docutils literal"><span class="pre">[255/255,</span> <span class="pre">255/255,</span> <span class="pre">255/255]</span></tt> (white).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromhsl"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromhsl">Color.fromHSL(hue, saturation, lightness, alpha=1.0)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">hue</span></tt>, <tt class="docutils literal"><span class="pre">saturation</span></tt>,
|
||||
<tt class="docutils literal"><span class="pre">lightness</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0.0</span></tt> and
|
||||
<tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-color.fromhsl">Color.fromHSL({h: hue, s: saturation, l: lightness, a: alpha})</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromhslstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromhslstring">Color.fromHSLString(hslString)</a>:</p>
|
||||
<blockquote>
|
||||
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given decimal hsl color string.
|
||||
For example, <tt class="docutils literal"><span class="pre">"hsl(0,0%,100%)"</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
|
||||
HSL values <tt class="docutils literal"><span class="pre">[0/360,</span> <span class="pre">0/360,</span> <span class="pre">360/360]</span></tt> (white).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromhsv"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromhsv">Color.fromHSV(hue, saturation, value, alpha=1.0)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">hue</span></tt>, <tt class="docutils literal"><span class="pre">saturation</span></tt>,
|
||||
<tt class="docutils literal"><span class="pre">value</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0.0</span></tt> and
|
||||
<tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-color.fromhsv">Color.fromHSV({h: hue, s: saturation, v: value, a: alpha})</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromname"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromname">Color.fromName(colorName)</a>:</p>
|
||||
<blockquote>
|
||||
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object corresponding to the given
|
||||
SVG 1.0 color keyword name <a class="footnote-reference" href="#id7" id="id2" name="id2">[2]</a> as per the W3C CSS3
|
||||
Color Module <a class="footnote-reference" href="#id8" id="id3" name="id3">[3]</a>. <tt class="docutils literal"><span class="pre">"transparent"</span></tt> is also accepted
|
||||
as a color name, and will return <a class="mochiref reference" href="#fn-color.transparentcolor">Color.transparentColor()</a>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromrgb"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromrgb">Color.fromRGB(red, green, blue, alpha=1.0)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">red</span></tt>, <tt class="docutils literal"><span class="pre">green</span></tt>,
|
||||
<tt class="docutils literal"><span class="pre">blue</span></tt>, and <tt class="docutils literal"><span class="pre">alpha</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0</span></tt>
|
||||
and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-color.fromrgb">Color.fromRGB({r: red, g: green, b: blue, a: alpha})</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromrgbstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromrgbstring">Color.fromRGBString(rgbString)</a>:</p>
|
||||
<blockquote>
|
||||
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given decimal rgb color string.
|
||||
For example, <tt class="docutils literal"><span class="pre">"rgb(255,255,255)"</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
|
||||
RGB values <tt class="docutils literal"><span class="pre">[255/255,</span> <span class="pre">255/255,</span> <span class="pre">255/255]</span></tt> (white).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromtext"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromtext">Color.fromText(elem)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the text color of the provided
|
||||
element. Equivalent to:</p>
|
||||
<pre class="literal-block">
|
||||
c = Color.fromComputedStyle(elem, "color") || Color.whiteColor();
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.fromstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.fromstring">Color.fromString(rgbOrHexString)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given RGB, HSL, hex, or name.
|
||||
Will return <tt class="docutils literal"><span class="pre">null</span></tt> if the string can not be parsed by any of these
|
||||
methods.</p>
|
||||
<p>See <a class="mochiref reference" href="#fn-color.fromhexstring">Color.fromHexString</a>, <a class="mochiref reference" href="#fn-color.fromrgbstring">Color.fromRGBString</a>,
|
||||
<a class="mochiref reference" href="#fn-color.fromhslstring">Color.fromHSLString</a> and <a class="mochiref reference" href="#fn-color.fromname">Color.fromName</a> more
|
||||
information.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.namedcolors"></a>
|
||||
<a class="mochidef reference" href="#fn-color.namedcolors">Color.namedColors()</a>:</p>
|
||||
<blockquote>
|
||||
Returns an object with properties for each SVG 1.0 color keyword
|
||||
name <a class="footnote-reference" href="#id7" id="id4" name="id4">[2]</a> supported by CSS3 <a class="footnote-reference" href="#id8" id="id5" name="id5">[3]</a>. Property names are the color keyword
|
||||
name in lowercase, and the value is a string suitable for
|
||||
<a class="mochiref reference" href="#fn-color.fromstring">Color.fromString()</a>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.colorwithalpha"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.colorwithalpha">Color.prototype.colorWithAlpha(alpha)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
|
||||
<tt class="docutils literal"><span class="pre">alpha</span></tt> value.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.colorwithhue"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.colorwithhue">Color.prototype.colorWithHue(hue)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
|
||||
<tt class="docutils literal"><span class="pre">hue</span></tt> value.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.colorwithsaturation"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.colorwithsaturation">Color.prototype.colorWithSaturation(saturation)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
|
||||
<tt class="docutils literal"><span class="pre">saturation</span></tt> value (using the HSL color model).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.colorwithlightness"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.colorwithlightness">Color.prototype.colorWithLightness(lightness)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
|
||||
<tt class="docutils literal"><span class="pre">lightness</span></tt> value.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.darkercolorwithlevel"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.darkercolorwithlevel">Color.prototype.darkerColorWithLevel(level)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but darker by the given
|
||||
<tt class="docutils literal"><span class="pre">level</span></tt> (between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.lightercolorwithlevel"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.lightercolorwithlevel">Color.prototype.lighterColorWithLevel(level)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but lighter by the given
|
||||
<tt class="docutils literal"><span class="pre">level</span></tt> (between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.blendedcolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.blendedcolor">Color.prototype.blendedColor(other, fraction=0.5)</a>:</p>
|
||||
<blockquote>
|
||||
Return a new <a class="mochiref reference" href="#fn-color">Color</a> whose RGBA component values are a weighted sum
|
||||
of this color and <tt class="docutils literal"><span class="pre">other</span></tt>. Each component of the returned color
|
||||
is the <tt class="docutils literal"><span class="pre">fraction</span></tt> of other's value plus <tt class="docutils literal"><span class="pre">1</span> <span class="pre">-</span> <span class="pre">fraction</span></tt> of this
|
||||
color's.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.islight"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.islight">Color.prototype.isLight()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if the lightness value of this color is greater than
|
||||
<tt class="docutils literal"><span class="pre">0.5</span></tt>.</p>
|
||||
<p>Note that <tt class="docutils literal"><span class="pre">alpha</span></tt> is ignored for this calculation (color components
|
||||
are not premultiplied).</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.isdark"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.isdark">Color.prototype.isDark()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if the lightness value of this color is less than or
|
||||
equal to <tt class="docutils literal"><span class="pre">0.5</span></tt>.</p>
|
||||
<p>Note that <tt class="docutils literal"><span class="pre">alpha</span></tt> is ignored for this calculation (color components
|
||||
are not premultiplied).</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.torgbstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.torgbstring">Color.prototype.toRGBString()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return the decimal <tt class="docutils literal"><span class="pre">"rgb(red,</span> <span class="pre">green,</span> <span class="pre">blue)"</span></tt> string representation of this
|
||||
color.</p>
|
||||
<p>If the alpha component is not <tt class="docutils literal"><span class="pre">1.0</span></tt> (fully opaque), the
|
||||
<tt class="docutils literal"><span class="pre">"rgba(red,</span> <span class="pre">green,</span> <span class="pre">blue,</span> <span class="pre">alpha)"</span></tt> string representation will be used.</p>
|
||||
<p>For example:</p>
|
||||
<pre class="literal-block">
|
||||
assert( Color.whiteColor().toRGBString() == "rgb(255,255,255)" );
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.tohslstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.tohslstring">Color.prototype.toHSLString()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return the decimal <tt class="docutils literal"><span class="pre">"hsl(hue,</span> <span class="pre">saturation,</span> <span class="pre">lightness)"</span></tt>
|
||||
string representation of this color.</p>
|
||||
<p>If the alpha component is not <tt class="docutils literal"><span class="pre">1.0</span></tt> (fully opaque), the
|
||||
<tt class="docutils literal"><span class="pre">"hsla(hue,</span> <span class="pre">saturation,</span> <span class="pre">lightness,</span> <span class="pre">alpha)"</span></tt> string representation
|
||||
will be used.</p>
|
||||
<p>For example:</p>
|
||||
<pre class="literal-block">
|
||||
assert( Color.whiteColor().toHSLString() == "hsl(0,0,360)" );
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.tohexstring"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.tohexstring">Color.prototype.toHexString()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return the hexadecimal <tt class="docutils literal"><span class="pre">"#RRGGBB"</span></tt> string representation of this color.</p>
|
||||
<p>Note that the alpha component is completely ignored for hexadecimal
|
||||
string representations!</p>
|
||||
<p>For example:</p>
|
||||
<pre class="literal-block">
|
||||
assert( Color.whiteColor().toHexString() == "#FFFFFF" );
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.asrgb"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.asrgb">Color.prototype.asRGB()</a>:</p>
|
||||
<blockquote>
|
||||
Return the RGB (red, green, blue, alpha) components of this color as an
|
||||
object with <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt>, <tt class="docutils literal"><span class="pre">b</span></tt>, and <tt class="docutils literal"><span class="pre">a</span></tt> properties that have
|
||||
values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.ashsl"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.ashsl">Color.prototype.asHSL()</a>:</p>
|
||||
<blockquote>
|
||||
Return the HSL (hue, saturation, lightness, alpha) components of this
|
||||
color as an object with <tt class="docutils literal"><span class="pre">h</span></tt>, <tt class="docutils literal"><span class="pre">s</span></tt>, <tt class="docutils literal"><span class="pre">l</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> properties
|
||||
that have values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.prototype.ashsv"></a>
|
||||
<a class="mochidef reference" href="#fn-color.prototype.ashsv">Color.prototype.asHSV()</a>:</p>
|
||||
<blockquote>
|
||||
Return the HSV (hue, saturation, value, alpha) components of this
|
||||
color as an object with <tt class="docutils literal"><span class="pre">h</span></tt>, <tt class="docutils literal"><span class="pre">s</span></tt>, <tt class="docutils literal"><span class="pre">v</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> properties
|
||||
that have values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.blackcolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.blackcolor">Color.blackColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 0, 0
|
||||
(#000000).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.bluecolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.bluecolor">Color.blueColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 0, 1
|
||||
(#0000ff).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.browncolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.browncolor">Color.brownColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.6, 0.4, 0.2
|
||||
(#996633).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.cyancolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.cyancolor">Color.cyanColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 1, 1
|
||||
(#00ffff).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.darkgraycolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.darkgraycolor">Color.darkGrayColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1/3, 1/3, 1/3
|
||||
(#555555).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.graycolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.graycolor">Color.grayColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.5, 0.5, 0.5
|
||||
(#808080).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.greencolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.greencolor">Color.greenColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 1, 0.
|
||||
(#00ff00).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.lightgraycolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.lightgraycolor">Color.lightGrayColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 2/3, 2/3, 2/3
|
||||
(#aaaaaa).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.magentacolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.magentacolor">Color.magentaColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0, 1
|
||||
(#ff00ff).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.orangecolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.orangecolor">Color.orangeColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0.5, 0
|
||||
(#ff8000).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.purplecolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.purplecolor">Color.purpleColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.5, 0, 0.5
|
||||
(#800080).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.redcolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.redcolor">Color.redColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0, 0
|
||||
(#ff0000).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.whitecolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.whitecolor">Color.whiteColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 1, 1
|
||||
(#ffffff).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.yellowcolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.yellowcolor">Color.yellowColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 1, 0
|
||||
(#ffff00).</blockquote>
|
||||
<p>
|
||||
<a name="fn-color.transparentcolor"></a>
|
||||
<a class="mochidef reference" href="#fn-color.transparentcolor">Color.transparentColor()</a>:</p>
|
||||
<blockquote>
|
||||
Return a <a class="mochiref reference" href="#fn-color">Color</a> object that is completely transparent
|
||||
(has alpha component of 0).</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-clampcolorcomponent"></a>
|
||||
<a class="mochidef reference" href="#fn-clampcolorcomponent">clampColorComponent(num, scale)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns <tt class="docutils literal"><span class="pre">num</span> <span class="pre">*</span> <span class="pre">scale</span></tt> clamped between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">scale</span></tt>.</p>
|
||||
<p><a class="mochiref reference" href="#fn-clampcolorcomponent">clampColorComponent</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-hsltorgb"></a>
|
||||
<a class="mochidef reference" href="#fn-hsltorgb">hslToRGB(hue, saturation, lightness, alpha)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Computes RGB values from the provided HSL values. The return value is a
|
||||
mapping with <tt class="docutils literal"><span class="pre">"r"</span></tt>, <tt class="docutils literal"><span class="pre">"g"</span></tt>, <tt class="docutils literal"><span class="pre">"b"</span></tt> and <tt class="docutils literal"><span class="pre">"a"</span></tt> keys.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-hsltorgb">hslToRGB({h: hue, s: saturation, l: lightness, a: alpha})</a>.</dd>
|
||||
</dl>
|
||||
<p><a class="mochiref reference" href="#fn-hsltorgb">hslToRGB</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-hsvtorgb"></a>
|
||||
<a class="mochidef reference" href="#fn-hsvtorgb">hsvToRGB(hue, saturation, value, alpha)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Computes RGB values from the provided HSV values. The return value is a
|
||||
mapping with <tt class="docutils literal"><span class="pre">"r"</span></tt>, <tt class="docutils literal"><span class="pre">"g"</span></tt>, <tt class="docutils literal"><span class="pre">"b"</span></tt> and <tt class="docutils literal"><span class="pre">"a"</span></tt> keys.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-hsvtorgb">hsvToRGB({h: hue, s: saturation, v: value, a: alpha})</a>.</dd>
|
||||
</dl>
|
||||
<p><a class="mochiref reference" href="#fn-hsvtorgb">hsvToRGB</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-tocolorpart"></a>
|
||||
<a class="mochidef reference" href="#fn-tocolorpart">toColorPart(num)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convert num to a zero padded hexadecimal digit for use in a hexadecimal
|
||||
color string. Num should be an integer between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">255</span></tt>.</p>
|
||||
<p><a class="mochiref reference" href="#fn-tocolorpart">toColorPart</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-rgbtohsl"></a>
|
||||
<a class="mochidef reference" href="#fn-rgbtohsl">rgbToHSL(red, green, blue, alpha)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Computes HSL values based on the provided RGB values. The return value is
|
||||
a mapping with <tt class="docutils literal"><span class="pre">"h"</span></tt>, <tt class="docutils literal"><span class="pre">"s"</span></tt>, <tt class="docutils literal"><span class="pre">"l"</span></tt> and <tt class="docutils literal"><span class="pre">"a"</span></tt> keys.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-rgbtohsl">rgbToHSL({r: red, g: green, b: blue, a: alpha})</a>.</dd>
|
||||
</dl>
|
||||
<p><a class="mochiref reference" href="#fn-rgbtohsl">rgbToHSL</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-rgbtohsv"></a>
|
||||
<a class="mochidef reference" href="#fn-rgbtohsv">rgbToHSV(red, green, blue, alpha)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Computes HSV values based on the provided RGB values. The return value is
|
||||
a mapping with <tt class="docutils literal"><span class="pre">"h"</span></tt>, <tt class="docutils literal"><span class="pre">"s"</span></tt>, <tt class="docutils literal"><span class="pre">"v"</span></tt> and <tt class="docutils literal"><span class="pre">"a"</span></tt> keys.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Alternate form:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-rgbtohsv">rgbToHSV({r: red, g: green, b: blue, a: alpha})</a>.</dd>
|
||||
</dl>
|
||||
<p><a class="mochiref reference" href="#fn-rgbtohsv">rgbToHSV</a> is not exported by default when using JSAN.</p>
|
||||
</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id6" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id1" name="id6">[1]</a></td><td>Application Kit Reference - NSColor: <a class="reference" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html">http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id7" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id7">[2]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> SVG 1.0 color keywords: <a class="reference" href="http://www.w3.org/TR/SVG/types.html#ColorKeywords">http://www.w3.org/TR/SVG/types.html#ColorKeywords</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id8" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id8">[3]</a></td><td><em>(<a class="fn-backref" href="#id3">1</a>, <a class="fn-backref" href="#id5">2</a>)</em> W3C CSS3 Color Module: <a class="reference" href="http://www.w3.org/TR/css3-color/#svg-color">http://www.w3.org/TR/css3-color/#svg-color</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,798 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.DOM - painless DOM manipulation API</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.DOM - painless DOM manipulation API</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
var rows = [
|
||||
["dataA1", "dataA2", "dataA3"],
|
||||
["dataB1", "dataB2", "dataB3"]
|
||||
];
|
||||
row_display = function (row) {
|
||||
return TR(null, map(partial(TD, null), row));
|
||||
}
|
||||
var newTable = TABLE({'class': 'prettytable'},
|
||||
THEAD(null,
|
||||
row_display(["head1", "head2", "head3"])),
|
||||
TFOOT(null,
|
||||
row_display(["foot1", "foot2", "foot3"])),
|
||||
TBODY(null,
|
||||
map(row_display, rows)));
|
||||
// put that in your document.createElement and smoke it!
|
||||
swapDOM(oldTable, newTable);
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>As you probably know, the DOM APIs are some of the most painful Java-inspired
|
||||
APIs you'll run across from a highly dynamic language. Don't worry about that
|
||||
though, because they provide a reasonable basis to build something that
|
||||
sucks a lot less.</p>
|
||||
<p>MochiKit.DOM takes much of its inspiration from Nevow's <a class="footnote-reference" href="#id5" id="id1" name="id1">[1]</a> stan <a class="footnote-reference" href="#id6" id="id2" name="id2">[2]</a>.
|
||||
This means you choose a tag, give it some attributes, then stuff it full
|
||||
of <em>whatever objects you want</em>. MochiKit.DOM isn't stupid, it knows that
|
||||
a string should be a text node, and that you want functions to be called,
|
||||
and that <tt class="docutils literal"><span class="pre">Array</span></tt>-like objects should be expanded, and stupid <tt class="docutils literal"><span class="pre">null</span></tt> values
|
||||
should be skipped.</p>
|
||||
<p>Hell, it will let you return strings from functions, and use iterators from
|
||||
<a class="mochiref reference" href="Iter.html">MochiKit.Iter</a>. If that's not enough, just teach it new tricks with
|
||||
<a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>. If you have never used an API like this for
|
||||
creating DOM elements, you've been wasting your damn time. Get with it!</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="dom-coercion-rules" name="dom-coercion-rules">DOM Coercion Rules</a></h2>
|
||||
<p>In order of precedence, <a class="mochiref reference" href="#fn-createdom">createDOM</a> coerces given arguments to DOM
|
||||
nodes using the following rules:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Functions are called with a <tt class="docutils literal"><span class="pre">this</span></tt> of the parent
|
||||
node and their return value is subject to the
|
||||
following rules (even this one).</li>
|
||||
<li><tt class="docutils literal"><span class="pre">undefined</span></tt> and <tt class="docutils literal"><span class="pre">null</span></tt> are ignored.</li>
|
||||
<li>Iterables (see <a class="mochiref reference" href="Iter.html">MochiKit.Iter</a>) are flattened
|
||||
(as if they were passed in-line as nodes) and each
|
||||
return value is subject to all of these rules.</li>
|
||||
<li>Values that look like DOM nodes (objects with a
|
||||
<tt class="docutils literal"><span class="pre">.nodeType</span> <span class="pre">></span> <span class="pre">0</span></tt>) are <tt class="docutils literal"><span class="pre">.appendChild</span></tt>'ed to the created
|
||||
DOM fragment.</li>
|
||||
<li>Strings are wrapped up with <tt class="docutils literal"><span class="pre">document.createTextNode</span></tt></li>
|
||||
<li>Objects that are not strings are run through the <tt class="docutils literal"><span class="pre">domConverters</span></tt>
|
||||
<a class="mochiref reference" href="Base.html#fn-adapterregistry">MochiKit.Base.AdapterRegistry</a>
|
||||
(see <a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>).
|
||||
The value returned by the adapter is subject to these same rules (e.g.
|
||||
adapters are allowed to return a string, which will be coerced into a
|
||||
text node).</li>
|
||||
<li>If no adapter is available, <tt class="docutils literal"><span class="pre">.toString()</span></tt> is used to create a text node.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="creating-dom-element-trees" name="creating-dom-element-trees">Creating DOM Element Trees</a></h2>
|
||||
<p><a class="mochiref reference" href="#fn-createdom">createDOM</a> provides you with an excellent facility for creating DOM trees
|
||||
that is easy on the wrists. One of the best ways to understand how to use
|
||||
it is to take a look at an example:</p>
|
||||
<pre class="literal-block">
|
||||
var rows = [
|
||||
["dataA1", "dataA2", "dataA3"],
|
||||
["dataB1", "dataB2", "dataB3"]
|
||||
];
|
||||
row_display = function (row) {
|
||||
return TR(null, map(partial(TD, null), row));
|
||||
}
|
||||
var newTable = TABLE({'class': 'prettytable'},
|
||||
THEAD(null,
|
||||
row_display(["head1", "head2", "head3"])),
|
||||
TFOOT(null,
|
||||
row_display(["foot1", "foot2", "foot3"])),
|
||||
TBODY(null,
|
||||
map(row_display, rows)));
|
||||
</pre>
|
||||
<p>This will create a table with the following visual layout (if it
|
||||
were inserted into the document DOM):</p>
|
||||
<blockquote>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="33%" />
|
||||
<col width="33%" />
|
||||
<col width="33%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">head1</th>
|
||||
<th class="head">head2</th>
|
||||
<th class="head">head3</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td>dataA1</td>
|
||||
<td>dataA2</td>
|
||||
<td>dataA3</td>
|
||||
</tr>
|
||||
<tr><td>dataB1</td>
|
||||
<td>dataB2</td>
|
||||
<td>dataB3</td>
|
||||
</tr>
|
||||
<tr><td>foot1</td>
|
||||
<td>foot2</td>
|
||||
<td>foot3</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</blockquote>
|
||||
<p>Corresponding to the following HTML:</p>
|
||||
<pre class="literal-block">
|
||||
<table class="prettytable">
|
||||
<thead>
|
||||
<tr>
|
||||
<td>head1</td>
|
||||
<td>head2</td>
|
||||
<td>head3</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<td>foot1</td>
|
||||
<td>foot2</td>
|
||||
<td>foot3</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>dataA1</td>
|
||||
<td>dataA2</td>
|
||||
<td>dataA3</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dataB1</td>
|
||||
<td>dataB2</td>
|
||||
<td>dataB3</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="dom-context" name="dom-context">DOM Context</a></h2>
|
||||
<p>In order to prevent having to pass a <tt class="docutils literal"><span class="pre">window</span></tt> and/or <tt class="docutils literal"><span class="pre">document</span></tt>
|
||||
variable to every MochiKit.DOM function (e.g. when working with a
|
||||
child window), MochiKit.DOM maintains a context variable for each
|
||||
of them. They are managed with the <a class="mochiref reference" href="#fn-withwindow">withWindow</a> and
|
||||
<a class="mochiref reference" href="#fn-withdocument">withDocument</a> functions, and can be acquired with
|
||||
<a class="mochiref reference" href="#fn-currentwindow">currentWindow()</a> and <a class="mochiref reference" href="#fn-currentdocument">currentDocument()</a></p>
|
||||
<p>For example, if you are creating DOM nodes in a child window, you
|
||||
could do something like this:</p>
|
||||
<pre class="literal-block">
|
||||
withWindow(child, function () {
|
||||
var doc = currentDocument();
|
||||
appendChildNodes(doc.body, H1(null, "This is in the child!"));
|
||||
});
|
||||
</pre>
|
||||
<p>Note that <a class="mochiref reference" href="#fn-withwindow">withWindow(win, ...)</a> also implies
|
||||
<a class="mochiref reference" href="#fn-withdocument">withDocument(win.document, ...)</a>.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="element-visibility" name="element-visibility">Element Visibility</a></h2>
|
||||
<p>The <a class="mochiref reference" href="#fn-hideelement">hideElement</a> and <a class="mochiref reference" href="#fn-showelement">showElement</a> functions are
|
||||
provided as a convenience, but only work for elements that are
|
||||
<tt class="docutils literal"><span class="pre">display:</span> <span class="pre">block</span></tt>. For a general solution to showing, hiding, and checking
|
||||
the explicit visibility of elements, we recommend using a solution that
|
||||
involves a little CSS. Here's an example:</p>
|
||||
<pre class="literal-block">
|
||||
<style type="text/css">
|
||||
.invisible { display: none; }
|
||||
</style>
|
||||
|
||||
<script type="text/javascript">
|
||||
function toggleVisible(elem) {
|
||||
toggleElementClass("invisible", elem);
|
||||
}
|
||||
|
||||
function makeVisible(elem) {
|
||||
removeElementClass(elem, "invisible");
|
||||
}
|
||||
|
||||
function makeInvisible(elem) {
|
||||
addElementClass(elem, "invisible");
|
||||
}
|
||||
|
||||
function isVisible(elem) {
|
||||
// you may also want to check for
|
||||
// getElement(elem).style.display == "none"
|
||||
return !hasElementClass(elem, "invisible");
|
||||
};
|
||||
</script>
|
||||
</pre>
|
||||
<p>MochiKit doesn't ship with such a solution, because there is no reliable and
|
||||
portable method for adding CSS rules on the fly with JavaScript.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-$"></a>
|
||||
<a class="mochidef reference" href="#fn-$">$(id[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
An alias for <a class="mochiref reference" href="#fn-getelement">getElement(id[, ...])</a></blockquote>
|
||||
<p>
|
||||
<a name="fn-addelementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-addelementclass">addElementClass(element, className)</a>:</p>
|
||||
<blockquote>
|
||||
Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">className</span></tt> set as part of its
|
||||
class attribute. This will not disturb other class names.
|
||||
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-addloadevent"></a>
|
||||
<a class="mochidef reference" href="#fn-addloadevent">addLoadEvent(func)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Note that <a class="mochiref reference" href="#fn-addloadevent">addLoadEvent</a> can not be used in combination with
|
||||
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> if the <tt class="docutils literal"><span class="pre">onload</span></tt> event is connected.
|
||||
Once an event is connected with <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs
|
||||
may be used for that same event.</p>
|
||||
<p>This will stack <tt class="docutils literal"><span class="pre">window.onload</span></tt> functions on top of each other.
|
||||
Each function added will be called after <tt class="docutils literal"><span class="pre">onload</span></tt> in the
|
||||
order that they were added.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-addtocallstack"></a>
|
||||
<a class="mochidef reference" href="#fn-addtocallstack">addToCallStack(target, path, func[, once])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Note that <a class="mochiref reference" href="#fn-addtocallstack">addToCallStack</a> is not compatible with
|
||||
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>. Once an event is connected with
|
||||
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs may be used for that same event.</p>
|
||||
<p>Set the property <tt class="docutils literal"><span class="pre">path</span></tt> of <tt class="docutils literal"><span class="pre">target</span></tt> to a function that calls the
|
||||
existing function at that property (if any), then calls <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">target[path]()</span></tt> returns exactly <tt class="docutils literal"><span class="pre">false</span></tt>, then <tt class="docutils literal"><span class="pre">func</span></tt> will
|
||||
not be called.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">once</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then <tt class="docutils literal"><span class="pre">target[path]</span></tt> is set to <tt class="docutils literal"><span class="pre">null</span></tt> after
|
||||
the function call stack has completed.</p>
|
||||
<p>If called several times for the same <tt class="docutils literal"><span class="pre">target[path]</span></tt>, it will create
|
||||
a stack of functions (instead of just a pair).</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-appendchildnodes"></a>
|
||||
<a class="mochidef reference" href="#fn-appendchildnodes">appendChildNodes(node[, childNode[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Append children to a DOM element using the <a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to add children to
|
||||
(if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
|
||||
will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
|
||||
<dd>All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>The given DOM element</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-computedstyle"></a>
|
||||
<a class="mochidef reference" href="#fn-computedstyle">computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS)</a>:</p>
|
||||
<blockquote>
|
||||
Looks up a CSS property for the given element. The element can be
|
||||
specified as either a string with the element's ID or the element
|
||||
object itself.</blockquote>
|
||||
<p>
|
||||
<a name="fn-createdom"></a>
|
||||
<a class="mochidef reference" href="#fn-createdom">createDOM(name[, attrs[, node[, ...]]])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Create a DOM fragment in a really convenient manner, much like
|
||||
Nevow`s <a class="footnote-reference" href="#id5" id="id3" name="id3">[1]</a> stan <a class="footnote-reference" href="#id6" id="id4" name="id4">[2]</a>.</p>
|
||||
<p>Partially applied versions of this function for common tags are
|
||||
available as aliases:</p>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">A</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">BUTTON</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">BR</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">CANVAS</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">DIV</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">FIELDSET</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">FORM</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">H1</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">H2</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">H3</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">HR</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">IMG</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">INPUT</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">LABEL</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">LEGEND</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">LI</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">OL</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">OPTGROUP</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">OPTION</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">P</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">PRE</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">SELECT</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">SPAN</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">STRONG</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TABLE</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TBODY</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TD</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TEXTAREA</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TFOOT</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TH</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">THEAD</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TR</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">TT</span></tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">UL</span></tt></li>
|
||||
</ul>
|
||||
<p>See <a class="reference" href="#creating-dom-element-trees">Creating DOM Element Trees</a> for a comprehensive example.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">name</span></tt>:</dt>
|
||||
<dd>The kind of fragment to create (e.g. 'span'), such as you would
|
||||
pass to <tt class="docutils literal"><span class="pre">document.createElement</span></tt>.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
|
||||
<dd><p class="first">An object whose properties will be used as the attributes
|
||||
(e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">'display:block'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
|
||||
attributes need to be set.</p>
|
||||
<p>See <a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a> for more information.</p>
|
||||
<p class="last">For convenience, if <tt class="docutils literal"><span class="pre">attrs</span></tt> is a string, <tt class="docutils literal"><span class="pre">null</span></tt> is used
|
||||
and the string will be considered the first <tt class="docutils literal"><span class="pre">node</span></tt>.</p>
|
||||
</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
|
||||
<dd>All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>A DOM element</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-createdomfunc"></a>
|
||||
<a class="mochidef reference" href="#fn-createdomfunc">createDOMFunc(tag[, attrs[, node[, ...]]])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convenience function to create a partially applied createDOM
|
||||
function. You'd want to use this if you add additional convenience
|
||||
functions for creating tags, or if you find yourself creating
|
||||
a lot of tags with a bunch of the same attributes or contents.</p>
|
||||
<p>See <a class="mochiref reference" href="#fn-createdom">createDOM</a> for more detailed descriptions of the arguments.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">tag</span></tt>:</dt>
|
||||
<dd>The name of the tag</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
|
||||
<dd>Optionally specify the attributes to apply</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
|
||||
<dd>Optionally specify any children nodes it should have</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>function that takes additional arguments and calls
|
||||
<a class="mochiref reference" href="#fn-createdom">createDOM</a></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-currentdocument"></a>
|
||||
<a class="mochidef reference" href="#fn-currentdocument">currentDocument()</a>:</p>
|
||||
<blockquote>
|
||||
Return the current <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always
|
||||
be the same as the global <tt class="docutils literal"><span class="pre">document</span></tt> unless <a class="mochiref reference" href="#fn-withdocument">withDocument</a> or
|
||||
<a class="mochiref reference" href="#fn-withwindow">withWindow</a> is currently executing.</blockquote>
|
||||
<p>
|
||||
<a name="fn-currentwindow"></a>
|
||||
<a class="mochidef reference" href="#fn-currentwindow">currentWindow()</a>:</p>
|
||||
<blockquote>
|
||||
Return the current <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always
|
||||
be the same as the global <tt class="docutils literal"><span class="pre">window</span></tt> unless <a class="mochiref reference" href="#fn-withwindow">withWindow</a> is
|
||||
currently executing.</blockquote>
|
||||
<p>
|
||||
<a name="fn-elementdimensions"></a>
|
||||
<a class="mochidef reference" href="#fn-elementdimensions">elementDimensions(element)</a>:</p>
|
||||
<blockquote>
|
||||
Return the absolute pixel width and height of <tt class="docutils literal"><span class="pre">element</span></tt> as an object with
|
||||
<tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">element</span></tt> is not in the
|
||||
document. <tt class="docutils literal"><span class="pre">element</span></tt> may be specified as a string to be looked up with
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object with
|
||||
<tt class="docutils literal"><span class="pre">w</span></tt> and/or <tt class="docutils literal"><span class="pre">h</span></tt> properties.</blockquote>
|
||||
<p>
|
||||
<a name="fn-elementposition"></a>
|
||||
<a class="mochidef reference" href="#fn-elementposition">elementPosition(element[, relativeTo={x: 0, y: 0}])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return the absolute pixel position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document as an
|
||||
object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">element</span></tt>
|
||||
is not in the document. <tt class="docutils literal"><span class="pre">element</span></tt> may be specified as a string to
|
||||
be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially
|
||||
as an object with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">relativeTo</span></tt> is given, then its coordinates are subtracted from
|
||||
the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt>, e.g.:</p>
|
||||
<pre class="literal-block">
|
||||
var elemPos = elementPosition(elem);
|
||||
var anotherElemPos = elementPosition(anotherElem);
|
||||
var relPos = elementPosition(elem, anotherElem);
|
||||
assert( relPos.x == (elemPos.x - anotherElemPos.x) );
|
||||
assert( relPos.y == (elemPos.y - anotherElemPos.y) );
|
||||
</pre>
|
||||
<p><tt class="docutils literal"><span class="pre">relativeTo</span></tt> may be specified as a string to be looked up with
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object
|
||||
with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-emithtml"></a>
|
||||
<a class="mochidef reference" href="#fn-emithtml">emitHTML(dom[, lst])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convert a DOM tree to an <tt class="docutils literal"><span class="pre">Array</span></tt> of HTML string fragments</p>
|
||||
<p>You probably want to use <a class="mochiref reference" href="#fn-tohtml">toHTML</a> instead.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-escapehtml"></a>
|
||||
<a class="mochidef reference" href="#fn-escapehtml">escapeHTML(s)</a>:</p>
|
||||
<blockquote>
|
||||
Make a string safe for HTML, converting the usual suspects (lt,
|
||||
gt, quot, apos, amp)</blockquote>
|
||||
<p>
|
||||
<a name="fn-focusonload"></a>
|
||||
<a class="mochidef reference" href="#fn-focusonload">focusOnLoad(element)</a>:</p>
|
||||
<blockquote>
|
||||
Add an onload event to focus the given element</blockquote>
|
||||
<p>
|
||||
<a name="fn-formcontents"></a>
|
||||
<a class="mochidef reference" href="#fn-formcontents">formContents(elem)</a>:</p>
|
||||
<blockquote>
|
||||
Search the DOM tree, starting at <tt class="docutils literal"><span class="pre">elem</span></tt>, for any elements with a
|
||||
<tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">value</span></tt> attribute. Return a 2-element <tt class="docutils literal"><span class="pre">Array</span></tt> of
|
||||
<tt class="docutils literal"><span class="pre">names</span></tt> and <tt class="docutils literal"><span class="pre">values</span></tt> suitable for use with
|
||||
<a class="mochiref reference" href="Base.html#fn-querystring">MochiKit.Base.queryString</a>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-getelement"></a>
|
||||
<a class="mochidef reference" href="#fn-getelement">getElement(id[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>A small quick little function to encapsulate the <tt class="docutils literal"><span class="pre">getElementById</span></tt>
|
||||
method. It includes a check to ensure we can use that method.</p>
|
||||
<p>If the id isn't a string, it will be returned as-is.</p>
|
||||
<p>Also available as <a class="mochiref reference" href="#fn-$">$(...)</a> for convenience and compatibility with
|
||||
other JavaScript frameworks.</p>
|
||||
<p>If multiple arguments are given, an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-getelementsbytagandclassname"></a>
|
||||
<a class="mochidef reference" href="#fn-getelementsbytagandclassname">getElementsByTagAndClassName(tagName, className, parent=document)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns an array of elements in <tt class="docutils literal"><span class="pre">parent</span></tt> that match the tag name
|
||||
and class name provided. If <tt class="docutils literal"><span class="pre">parent</span></tt> is a string, it will be looked
|
||||
up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">tagName</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt> or <tt class="docutils literal"><span class="pre">"*"</span></tt>, all elements will be searched
|
||||
for the matching class.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">className</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt>, all elements matching the provided tag are
|
||||
returned.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-getnodeattribute"></a>
|
||||
<a class="mochidef reference" href="#fn-getnodeattribute">getNodeAttribute(node, attr)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Get the value of the given attribute for a DOM element without
|
||||
ever raising an exception (will return <tt class="docutils literal"><span class="pre">null</span></tt> on exception).</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to update (if a string is given,
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
|
||||
<dd><p class="first">The name of the attribute</p>
|
||||
<p class="last">Note that it will do the right thing for IE, so don't do
|
||||
the <tt class="docutils literal"><span class="pre">class</span></tt> -> <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
|
||||
</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>The attribute's value, or <tt class="docutils literal"><span class="pre">null</span></tt></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-getviewportdimensions"></a>
|
||||
<a class="mochidef reference" href="#fn-getviewportdimensions">getViewportDimensions()</a>:</p>
|
||||
<blockquote>
|
||||
Return the pixel width and height of the viewport as an object with <tt class="docutils literal"><span class="pre">w</span></tt>
|
||||
and <tt class="docutils literal"><span class="pre">h</span></tt> properties. <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-haselementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-haselementclass">hasElementClass(element, className[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">className</span></tt> is found on the <tt class="docutils literal"><span class="pre">element</span></tt>.
|
||||
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-hideelement"></a>
|
||||
<a class="mochidef reference" href="#fn-hideelement">hideElement(element, ...)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
|
||||
<pre class="literal-block">
|
||||
partial(setDisplayForElement, "none")
|
||||
</pre>
|
||||
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-registerdomconverter"></a>
|
||||
<a class="mochidef reference" href="#fn-registerdomconverter">registerDOMConverter(name, check, wrap[, override])</a>:</p>
|
||||
<blockquote>
|
||||
Register an adapter to convert objects that match <tt class="docutils literal"><span class="pre">check(obj,</span> <span class="pre">ctx)</span></tt>
|
||||
to a DOM element, or something that can be converted to a DOM
|
||||
element (i.e. number, bool, string, function, iterable).</blockquote>
|
||||
<p>
|
||||
<a name="fn-removeelement"></a>
|
||||
<a class="mochidef reference" href="#fn-removeelement">removeElement(node)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Remove and return <tt class="docutils literal"><span class="pre">node</span></tt> from a DOM tree. This is technically
|
||||
just a convenience for <a class="mochiref reference" href="#fn-swapdom">swapDOM(node, null)</a>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>the DOM element (or string id of one) to be removed</dd>
|
||||
<dt><em>returns</em></dt>
|
||||
<dd>The removed element</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-removeelementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-removeelementclass">removeElementClass(element, className)</a>:</p>
|
||||
<blockquote>
|
||||
Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> does not have <tt class="docutils literal"><span class="pre">className</span></tt> set as part
|
||||
of its class attribute. This will not disturb other class names.
|
||||
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-replacechildnodes"></a>
|
||||
<a class="mochidef reference" href="#fn-replacechildnodes">replaceChildNodes(node[, childNode[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Remove all children from the given DOM element, then append any given
|
||||
childNodes to it (by calling <a class="mochiref reference" href="#fn-appendchildnodes">appendChildNodes</a>).</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to add children to
|
||||
(if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
|
||||
will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
|
||||
<dd>All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>The given DOM element</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-scrapetext"></a>
|
||||
<a class="mochidef reference" href="#fn-scrapetext">scrapeText(node[, asArray=false])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Walk a DOM tree in-order and scrape all of the text out of it as a
|
||||
<tt class="docutils literal"><span class="pre">string</span></tt>.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">asArray</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned with
|
||||
each individual text node. These two are equivalent:</p>
|
||||
<pre class="literal-block">
|
||||
assert( scrapeText(node) == scrapeText(node, true).join("") );
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-setdisplayforelement"></a>
|
||||
<a class="mochidef reference" href="#fn-setdisplayforelement">setDisplayForElement(display, element[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Change the <tt class="docutils literal"><span class="pre">style.display</span></tt> for the given element(s). Usually
|
||||
used as the partial forms:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="#fn-showelement">showElement(element, ...)</a></li>
|
||||
<li><a class="mochiref reference" href="#fn-hideelement">hideElement(element, ...)</a></li>
|
||||
</ul>
|
||||
<p>Elements are looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are acceptable.</p>
|
||||
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-setelementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-setelementclass">setElementClass(element, className)</a>:</p>
|
||||
<blockquote>
|
||||
Set the entire class attribute of <tt class="docutils literal"><span class="pre">element</span></tt> to <tt class="docutils literal"><span class="pre">className</span></tt>.
|
||||
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-setelementdimensions"></a>
|
||||
<a class="mochidef reference" href="#fn-setelementdimensions">setElementDimensions(element, dimensions[, units='px'])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Sets the dimensions of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an
|
||||
object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to update (if a string is given,
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">dimensions</span></tt>:</dt>
|
||||
<dd>An object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
|
||||
<dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-setelementposition"></a>
|
||||
<a class="mochidef reference" href="#fn-setelementposition">setElementPosition(element, position[, units='px'])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Sets the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an
|
||||
object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to update (if a string is given,
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">position</span></tt>:</dt>
|
||||
<dd>An object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
|
||||
<dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-setnodeattribute"></a>
|
||||
<a class="mochidef reference" href="#fn-setnodeattribute">setNodeAttribute(node, attr, value)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Set the value of the given attribute for a DOM element without
|
||||
ever raising an exception (will return null on exception). If
|
||||
setting more than one attribute, you should use
|
||||
<a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to update (if a string is given,
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
|
||||
<dd><p class="first">The name of the attribute</p>
|
||||
<p class="last">Note that it will do the right thing for IE, so don't do
|
||||
the <tt class="docutils literal"><span class="pre">class</span></tt> -> <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
|
||||
</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">value</span></tt>:</dt>
|
||||
<dd>The value of the attribute, may be an object to be merged
|
||||
(e.g. for setting style).</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>The given DOM element or <tt class="docutils literal"><span class="pre">null</span></tt> on failure</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-setopacity"></a>
|
||||
<a class="mochidef reference" href="#fn-setopacity">setOpacity(element, opacity)</a>:</p>
|
||||
<blockquote>
|
||||
Sets <tt class="docutils literal"><span class="pre">opacity</span></tt> for <tt class="docutils literal"><span class="pre">element</span></tt>. Valid <tt class="docutils literal"><span class="pre">opacity</span></tt> values range from 0
|
||||
(invisible) to 1 (opaque). <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-showelement"></a>
|
||||
<a class="mochidef reference" href="#fn-showelement">showElement(element, ...)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
|
||||
<pre class="literal-block">
|
||||
partial(setDisplayForElement, "block")
|
||||
</pre>
|
||||
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-swapdom"></a>
|
||||
<a class="mochidef reference" href="#fn-swapdom">swapDOM(dest, src)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Replace <tt class="docutils literal"><span class="pre">dest</span></tt> in a DOM tree with <tt class="docutils literal"><span class="pre">src</span></tt>, returning <tt class="docutils literal"><span class="pre">src</span></tt>.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">dest</span></tt>:</dt>
|
||||
<dd>a DOM element (or string id of one) to be replaced</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">src</span></tt>:</dt>
|
||||
<dd>the DOM element (or string id of one) to replace it with, or
|
||||
<tt class="docutils literal"><span class="pre">null</span></tt> if <tt class="docutils literal"><span class="pre">dest</span></tt> is to be removed (replaced with nothing).</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>a DOM element (<tt class="docutils literal"><span class="pre">src</span></tt>)</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-swapelementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-swapelementclass">swapElementClass(element, fromClass, toClass)</a>:</p>
|
||||
<blockquote>
|
||||
If <tt class="docutils literal"><span class="pre">fromClass</span></tt> is set on <tt class="docutils literal"><span class="pre">element</span></tt>, replace it with <tt class="docutils literal"><span class="pre">toClass</span></tt>.
|
||||
This will not disturb other classes on that element.
|
||||
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
|
||||
are also acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-toggleelementclass"></a>
|
||||
<a class="mochidef reference" href="#fn-toggleelementclass">toggleElementClass(className[, element[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Toggle the presence of a given <tt class="docutils literal"><span class="pre">className</span></tt> in the class attribute
|
||||
of all given elements. All elements will be looked up with
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are acceptable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-tohtml"></a>
|
||||
<a class="mochidef reference" href="#fn-tohtml">toHTML(dom)</a>:</p>
|
||||
<blockquote>
|
||||
Convert a DOM tree to a HTML string using <a class="mochiref reference" href="#fn-emithtml">emitHTML</a></blockquote>
|
||||
<p>
|
||||
<a name="fn-updatenodeattributes"></a>
|
||||
<a class="mochidef reference" href="#fn-updatenodeattributes">updateNodeAttributes(node, attrs)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Update the attributes of a DOM element from a given object.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
|
||||
<dd>A reference to the DOM element to update (if a string is given,
|
||||
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
|
||||
<dd><p class="first">An object whose properties will be used to set the attributes
|
||||
(e.g. <tt class="docutils literal"><span class="pre">{'class':</span> <span class="pre">'invisible'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
|
||||
attributes need to be set. If an object is given for the
|
||||
attribute value (e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">{'display':</span> <span class="pre">'block'}}</span></tt>)
|
||||
then <a class="mochiref reference" href="Base.html#fn-updatetree">MochiKit.Base.updatetree</a> will be used to set that
|
||||
attribute.</p>
|
||||
<p class="last">Note that it will do the right thing for IE, so don't do
|
||||
the <tt class="docutils literal"><span class="pre">class</span></tt> -> <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself, and it deals with
|
||||
setting "on..." event handlers correctly.</p>
|
||||
</dd>
|
||||
<dt><em>returns</em>:</dt>
|
||||
<dd>The given DOM element</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-withwindow"></a>
|
||||
<a class="mochidef reference" href="#fn-withwindow">withWindow(win, func)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win</span></tt> and
|
||||
the <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win.document</span></tt>. When
|
||||
<tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a> will be
|
||||
restored to its previous state.</p>
|
||||
<p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-withdocument"></a>
|
||||
<a class="mochidef reference" href="#fn-withdocument">withDocument(doc, func)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">doc</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">doc</span></tt>.
|
||||
When <tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a>
|
||||
will be restored to its previous state.</p>
|
||||
<p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
|
||||
</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id5" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id5">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Nevow, a web application construction kit for Python: <a class="reference" href="http://nevow.com/">http://nevow.com/</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id6" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id6">[2]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> nevow.stan is a domain specific language for Python
|
||||
(read as "crazy getitem/call overloading abuse") that Donovan and I
|
||||
schemed up at PyCon 2003 at this super ninja Python/C++ programmer's
|
||||
(David Abrahams) hotel room. Donovan later inflicted this upon the
|
||||
masses in Nevow. Check out the Divmod project page for some
|
||||
examples: <a class="reference" href="http://nevow.com/Nevow2004Tutorial.html">http://nevow.com/Nevow2004Tutorial.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,125 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.DateTime - "what time is it anyway?"</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.DateTime - "what time is it anyway?"</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
stringDate = toISOTimestamp(new Date());
|
||||
dateObject = isoTimestamp(stringDate);
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>Remote servers don't give you JavaScript Date objects, and they certainly
|
||||
don't want them from you, so you need to deal with string representations
|
||||
of dates and timestamps. MochiKit.Date does that.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<p>None.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-isodate"></a>
|
||||
<a class="mochidef reference" href="#fn-isodate">isoDate(str)</a>:</p>
|
||||
<blockquote>
|
||||
Convert an ISO 8601 date (YYYY-MM-DD) to a <tt class="docutils literal"><span class="pre">Date</span></tt> object.</blockquote>
|
||||
<p>
|
||||
<a name="fn-isotimestamp"></a>
|
||||
<a class="mochidef reference" href="#fn-isotimestamp">isoTimestamp(str)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convert any ISO 8601 <a class="footnote-reference" href="#id3" id="id1" name="id1">[1]</a> timestamp (or something reasonably close to it)
|
||||
to a <tt class="docutils literal"><span class="pre">Date</span></tt> object. Will accept the "de facto" form:</p>
|
||||
<blockquote>
|
||||
YYYY-MM-DD hh:mm:ss</blockquote>
|
||||
<p>or (the proper form):</p>
|
||||
<blockquote>
|
||||
YYYY-MM-DDThh:mm:ssZ</blockquote>
|
||||
<p>If a time zone designator ("Z" or "[+-]HH:MM") is not present, then the
|
||||
local timezone is used.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-toisotime"></a>
|
||||
<a class="mochidef reference" href="#fn-toisotime">toISOTime(date)</a>:</p>
|
||||
<blockquote>
|
||||
Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to a string in the form of hh:mm:ss</blockquote>
|
||||
<p>
|
||||
<a name="fn-toisotimestamp"></a>
|
||||
<a class="mochidef reference" href="#fn-toisotimestamp">toISOTimestamp(date, realISO=false)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to something that's ALMOST but not quite an
|
||||
ISO 8601 [1]_timestamp. If it was a proper ISO timestamp it would be:</p>
|
||||
<blockquote>
|
||||
YYYY-MM-DDThh:mm:ssZ</blockquote>
|
||||
<p>However, we see junk in SQL and other places that looks like this:</p>
|
||||
<blockquote>
|
||||
YYYY-MM-DD hh:mm:ss</blockquote>
|
||||
<p>So, this function returns the latter form, despite its name, unless
|
||||
you pass <tt class="docutils literal"><span class="pre">true</span></tt> for <tt class="docutils literal"><span class="pre">realISO</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-toisodate"></a>
|
||||
<a class="mochidef reference" href="#fn-toisodate">toISODate(date)</a>:</p>
|
||||
<blockquote>
|
||||
Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an ISO 8601 <a class="footnote-reference" href="#id3" id="id2" name="id2">[1]</a> date string (YYYY-MM-DD)</blockquote>
|
||||
<p>
|
||||
<a name="fn-americandate"></a>
|
||||
<a class="mochidef reference" href="#fn-americandate">americanDate(str)</a>:</p>
|
||||
<blockquote>
|
||||
Converts a MM/DD/YYYY date to a <tt class="docutils literal"><span class="pre">Date</span></tt> object</blockquote>
|
||||
<p>
|
||||
<a name="fn-topaddedamericandate"></a>
|
||||
<a class="mochidef reference" href="#fn-topaddedamericandate">toPaddedAmericanDate(date)</a>:</p>
|
||||
<blockquote>
|
||||
Converts a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an MM/DD/YYYY date, e.g. 01/01/2001</blockquote>
|
||||
<p>
|
||||
<a name="fn-toamericandate"></a>
|
||||
<a class="mochidef reference" href="#fn-toamericandate">toAmericanDate(date)</a>:</p>
|
||||
<blockquote>
|
||||
Converts a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an M/D/YYYY date, e.g. 1/1/2001</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id3" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id3">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> W3C profile of ISO 8601: <a class="reference" href="http://www.w3.org/TR/NOTE-datetime">http://www.w3.org/TR/NOTE-datetime</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,241 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Format - string formatting goes here</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Format - string formatting goes here</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
assert( truncToFixed(0.12345, 4) == "0.1234" );
|
||||
assert( roundToFixed(0.12345, 4) == "0.1235" );
|
||||
assert( twoDigitAverage(1, 0) == "0" );
|
||||
assert( twoDigitFloat(1.2345) == "1.23" );
|
||||
assert( twoDigitFloat(1) == "1" );
|
||||
assert( percentFormat(1.234567) == "123.46%" );
|
||||
assert( numberFormatter("###,###%")(125) == "12,500%" );
|
||||
assert( numberFormatter("##.000")(1.25) == "1.250" );
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>Formatting strings and stringifying numbers is boring, so a couple useful
|
||||
functions in that domain live here.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<p>None.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="formatting-numbers" name="formatting-numbers">Formatting Numbers</a></h2>
|
||||
<p>MochiKit provides an extensible number formatting facility, modeled loosely
|
||||
after the Number Format Pattern Syntax <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a> from Java.
|
||||
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter(pattern[, placeholder=""[, locale="default"])</a>
|
||||
returns a function that converts Number to string using the given information.
|
||||
<tt class="docutils literal"><span class="pre">pattern</span></tt> is a string consisting of the following symbols:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="15%" />
|
||||
<col width="85%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">Symbol</th>
|
||||
<th class="head">Meaning</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td><tt class="docutils literal"><span class="pre">-</span></tt></td>
|
||||
<td>If given, used as the position of the minus sign
|
||||
for negative numbers. If not given, the position
|
||||
to the left of the first number placeholder is used.</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal"><span class="pre">#</span></tt></td>
|
||||
<td>The placeholder for a number that does not imply zero
|
||||
padding.</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal"><span class="pre">0</span></tt></td>
|
||||
<td>The placeholder for a number that implies zero padding.
|
||||
If it is used to the right of a decimal separator, it
|
||||
implies trailing zeros, otherwise leading zeros.</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal"><span class="pre">,</span></tt></td>
|
||||
<td>The placeholder for a "thousands separator". May be used
|
||||
at most once, and it must be to the left of a decimal
|
||||
separator. Will be replaced by <tt class="docutils literal"><span class="pre">locale.separator</span></tt> in the
|
||||
result (the default is also <tt class="docutils literal"><span class="pre">,</span></tt>).</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal"><span class="pre">.</span></tt></td>
|
||||
<td>The decimal separator. The quantity of <tt class="docutils literal"><span class="pre">#</span></tt> or <tt class="docutils literal"><span class="pre">0</span></tt>
|
||||
after the decimal separator will determine the precision of
|
||||
the result. If no decimal separator is present, the
|
||||
fractional precision is <tt class="docutils literal"><span class="pre">0</span></tt> -- meaning that it will be
|
||||
rounded to the nearest integer.</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal"><span class="pre">%</span></tt></td>
|
||||
<td>If present, the number will be multiplied by <tt class="docutils literal"><span class="pre">100</span></tt> and
|
||||
the <tt class="docutils literal"><span class="pre">%</span></tt> will be replaced by <tt class="docutils literal"><span class="pre">locale.percent</span></tt>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-formatlocale"></a>
|
||||
<a class="mochidef reference" href="#fn-formatlocale">formatLocale(locale="default")</a>:</p>
|
||||
<blockquote>
|
||||
Return a locale object for the given locale. <tt class="docutils literal"><span class="pre">locale</span></tt> may be either a
|
||||
string, which is looked up in the <tt class="docutils literal"><span class="pre">MochiKit.Format.LOCALE</span></tt> object, or
|
||||
a locale object. If no locale is given, <tt class="docutils literal"><span class="pre">LOCALE.default</span></tt> is used
|
||||
(equivalent to <tt class="docutils literal"><span class="pre">LOCALE.en_US</span></tt>).</blockquote>
|
||||
<p>
|
||||
<a name="fn-lstrip"></a>
|
||||
<a class="mochidef reference" href="#fn-lstrip">lstrip(str, chars="\s")</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with leading whitespace stripped.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
|
||||
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-numberformatter"></a>
|
||||
<a class="mochidef reference" href="#fn-numberformatter">numberFormatter(pattern, placeholder="", locale="default")</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a function <tt class="docutils literal"><span class="pre">formatNumber(aNumber)</span></tt> that formats numbers
|
||||
as a string according to the given pattern, placeholder and locale.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">pattern</span></tt> is a string that describes how the numbers should be formatted,
|
||||
for more information see <a class="reference" href="#formatting-numbers">Formatting Numbers</a>.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">locale</span></tt> is a string of a known locale (en_US, de_DE, fr_FR, default) or
|
||||
an object with the following fields:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="16%" />
|
||||
<col width="84%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td>separator</td>
|
||||
<td>The "thousands" separator for this locale (en_US is ",")</td>
|
||||
</tr>
|
||||
<tr><td>decimal</td>
|
||||
<td>The decimal separator for this locale (en_US is ".")</td>
|
||||
</tr>
|
||||
<tr><td>percent</td>
|
||||
<td>The percent symbol for this locale (en_US is "%")</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-percentformat"></a>
|
||||
<a class="mochidef reference" href="#fn-percentformat">percentFormat(someFloat)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Roughly equivalent to: <tt class="docutils literal"><span class="pre">sprintf("%.2f%%",</span> <span class="pre">someFloat</span> <span class="pre">*</span> <span class="pre">100)</span></tt></p>
|
||||
<p>In new code, you probably want to use:
|
||||
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter("#.##%")(someFloat)</a> instead.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-roundtofixed"></a>
|
||||
<a class="mochidef reference" href="#fn-roundtofixed">roundToFixed(aNumber, precision)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a string representation of <tt class="docutils literal"><span class="pre">aNumber</span></tt>, rounded to <tt class="docutils literal"><span class="pre">precision</span></tt>
|
||||
digits with trailing zeros. This is similar to
|
||||
<tt class="docutils literal"><span class="pre">Number.toFixed(aNumber,</span> <span class="pre">precision)</span></tt>, but this has implementation
|
||||
consistent rounding behavior (some versions of Safari round 0.5 down!)
|
||||
and also includes preceding <tt class="docutils literal"><span class="pre">0</span></tt> for numbers less than <tt class="docutils literal"><span class="pre">1</span></tt> (Safari,
|
||||
again).</p>
|
||||
<p>For example, <a class="mochiref reference" href="#fn-roundtofixed">roundToFixed(0.1357, 2)</a> returns <tt class="docutils literal"><span class="pre">0.14</span></tt> on every
|
||||
supported platform, where some return <tt class="docutils literal"><span class="pre">.13</span></tt> for <tt class="docutils literal"><span class="pre">(0.1357).toFixed(2)</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-rstrip"></a>
|
||||
<a class="mochidef reference" href="#fn-rstrip">rstrip(str, chars="\s")</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with trailing whitespace stripped.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
|
||||
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-strip"></a>
|
||||
<a class="mochidef reference" href="#fn-strip">strip(str, chars="\s")</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with leading and trailing whitespace
|
||||
stripped (equivalent to <a class="mochiref reference" href="#fn-lstrip">lstrip(rstrip(str, chars), chars)</a>).</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
|
||||
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-trunctofixed"></a>
|
||||
<a class="mochidef reference" href="#fn-trunctofixed">truncToFixed(aNumber, precision)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return a string representation of <tt class="docutils literal"><span class="pre">aNumber</span></tt>, truncated to <tt class="docutils literal"><span class="pre">precision</span></tt>
|
||||
digits with trailing zeros. This is similar to
|
||||
<tt class="docutils literal"><span class="pre">aNumber.toFixed(precision)</span></tt>, but this truncates rather than rounds and
|
||||
has implementation consistent behavior for numbers less than 1.
|
||||
Specifically, <a class="mochiref reference" href="#fn-trunctofixed">truncToFixed(aNumber, precision)</a> will always have a
|
||||
preceding <tt class="docutils literal"><span class="pre">0</span></tt> for numbers less than <tt class="docutils literal"><span class="pre">1</span></tt>.</p>
|
||||
<p>For example, <a class="mochiref reference" href="#fn-tofixed">toFixed(0.1357, 2)</a> returns <tt class="docutils literal"><span class="pre">0.13</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-twodigitaverage"></a>
|
||||
<a class="mochidef reference" href="#fn-twodigitaverage">twoDigitAverage(numerator, denominator)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Calculate an average from a numerator and a denominator and return
|
||||
it as a string with two digits of precision (e.g. "1.23").</p>
|
||||
<p>If the denominator is 0, "0" will be returned instead of <tt class="docutils literal"><span class="pre">NaN</span></tt>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-twodigitfloat"></a>
|
||||
<a class="mochidef reference" href="#fn-twodigitfloat">twoDigitFloat(someFloat)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Roughly equivalent to: <tt class="docutils literal"><span class="pre">sprintf("%.2f",</span> <span class="pre">someFloat)</span></tt></p>
|
||||
<p>In new code, you probably want to use
|
||||
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter("#.##")(someFloat)</a> instead.</p>
|
||||
</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id2" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id1" name="id2">[1]</a></td><td>Java Number Format Pattern Syntax:
|
||||
<a class="reference" href="http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html">http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,372 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
theSum = sum(takewhile(
|
||||
partial(operator.gt, 10),
|
||||
imap(
|
||||
partial(operator.mul, 2),
|
||||
count()
|
||||
)
|
||||
)
|
||||
));
|
||||
|
||||
assert( theSum == (0 + 0 + 2 + 4 + 6 + 8) );
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>All of the functional programming missing from <a class="mochiref reference" href="Base.html">MochiKit.Base</a> lives
|
||||
here. The functionality in this module is largely inspired by Python's iteration
|
||||
protocol <a class="footnote-reference" href="#id4" id="id1" name="id1">[1]</a>, and the itertools module <a class="footnote-reference" href="#id5" id="id2" name="id2">[2]</a>.</p>
|
||||
<p>MochiKit.Iter defines a standard way to iterate over anything, that you can
|
||||
extend with <a class="mochiref reference" href="#fn-registeriterator">registerIterator</a>, or by implementing the <tt class="docutils literal"><span class="pre">.iter()</span></tt>
|
||||
protocol. Iterators are lazy, so it can potentially be cheaper to build a
|
||||
filter chain of iterators than to build lots of intermediate arrays.
|
||||
Especially when the data set is very large, but the result is not.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="iteration-for-javascript" name="iteration-for-javascript">Iteration for JavaScript</a></h2>
|
||||
<p>The best overview right now is in my Iteration for JavaScript <a class="footnote-reference" href="#id6" id="id3" name="id3">[3]</a> blog entry.
|
||||
This information will migrate here eventually.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="errors" name="errors">Errors</a></h2>
|
||||
<p>
|
||||
<a name="fn-stopiteration"></a>
|
||||
<a class="mochidef reference" href="#fn-stopiteration">StopIteration</a>:</p>
|
||||
<blockquote>
|
||||
The singleton <a class="mochiref reference" href="Base.html#fn-namederror">MochiKit.Base.NamedError</a> that signifies the end
|
||||
of an iterator</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-applymap"></a>
|
||||
<a class="mochidef reference" href="#fn-applymap">applymap(fun, seq[, self])</a>:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">applymap(fun,</span> <span class="pre">seq)</span></tt> --></dt>
|
||||
<dd>fun.apply(self, seq0), fun.apply(self, seq1), ...</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-chain"></a>
|
||||
<a class="mochidef reference" href="#fn-chain">chain(p, q[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">chain(p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --> p0, p1, ... plast, q0, q1, ...</blockquote>
|
||||
<p>
|
||||
<a name="fn-count"></a>
|
||||
<a class="mochidef reference" href="#fn-count">count(n=0)</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">count(n=0)</span></tt> --> n, n + 1, n + 2, ...</blockquote>
|
||||
<p>
|
||||
<a name="fn-cycle"></a>
|
||||
<a class="mochidef reference" href="#fn-cycle">cycle(p)</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">cycle(p)</span></tt> --> p0, p1, ... plast, p0, p1, ...</blockquote>
|
||||
<p>
|
||||
<a name="fn-dropwhile"></a>
|
||||
<a class="mochidef reference" href="#fn-dropwhile">dropwhile(pred, seq)</a>:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">dropwhile(pred,</span> <span class="pre">seq)</span></tt> --> seq[n], seq[n + 1], starting when</dt>
|
||||
<dd>pred(seq[n]) fails</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-every"></a>
|
||||
<a class="mochidef reference" href="#fn-every">every(iterable, func)</a>:</p>
|
||||
<blockquote>
|
||||
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">func(item)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt> for every item in
|
||||
<tt class="docutils literal"><span class="pre">iterable</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-exhaust"></a>
|
||||
<a class="mochidef reference" href="#fn-exhaust">exhaust(iterable)</a>:</p>
|
||||
<blockquote>
|
||||
Exhausts an iterable without saving the results anywhere,
|
||||
like <a class="mochiref reference" href="#fn-list">list(iterable)</a> when you don't care what the output is.</blockquote>
|
||||
<p>
|
||||
<a name="fn-foreach"></a>
|
||||
<a class="mochidef reference" href="#fn-foreach">forEach(iterable, func[, self])</a>:</p>
|
||||
<blockquote>
|
||||
Call <tt class="docutils literal"><span class="pre">func</span></tt> for each item in <tt class="docutils literal"><span class="pre">iterable</span></tt>, and don't save the results.</blockquote>
|
||||
<p>
|
||||
<a name="fn-groupby"></a>
|
||||
<a class="mochidef reference" href="#fn-groupby">groupby(iterable[, keyfunc])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Make an iterator that returns consecutive keys and groups from the
|
||||
iterable. The key is a function computing a key value for each element.
|
||||
If not specified or is None, key defaults to an identity function and
|
||||
returns the element unchanged. Generally, the iterable needs to already be
|
||||
sorted on the same key function.</p>
|
||||
<p>The returned group is itself an iterator that shares the underlying
|
||||
iterable with <a class="mochiref reference" href="#fn-groupby">groupby()</a>. Because the source is shared, when the
|
||||
groupby object is advanced, the previous group is no longer visible.
|
||||
So, if that data is needed later, it should be stored as an array:</p>
|
||||
<pre class="literal-block">
|
||||
var groups = [];
|
||||
var uniquekeys = [];
|
||||
forEach(groupby(data, keyfunc), function (key_group) {
|
||||
groups.push(list(key_group[1]));
|
||||
uniquekeys.push(key_group[0]);
|
||||
});
|
||||
</pre>
|
||||
<p>As a convenience, <a class="mochiref reference" href="#fn-groupby_as_array">groupby_as_array()</a> is provided to suit the above
|
||||
use case.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-groupby_as_array"></a>
|
||||
<a class="mochidef reference" href="#fn-groupby_as_array">groupby_as_array(iterable[, keyfunc])</a>:</p>
|
||||
<blockquote>
|
||||
Perform the same task as <a class="mochiref reference" href="#fn-groupby">groupby()</a>, except return an array of
|
||||
arrays instead of an iterator of iterators.</blockquote>
|
||||
<p>
|
||||
<a name="fn-iextend"></a>
|
||||
<a class="mochidef reference" href="#fn-iextend">iextend(lst, iterable)</a>:</p>
|
||||
<blockquote>
|
||||
Just like <a class="mochiref reference" href="#fn-list">list(iterable)</a>, except it pushes results on <tt class="docutils literal"><span class="pre">lst</span></tt>
|
||||
rather than creating a new one.</blockquote>
|
||||
<p>
|
||||
<a name="fn-ifilter"></a>
|
||||
<a class="mochidef reference" href="#fn-ifilter">ifilter(pred, seq)</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">ifilter(pred,</span> <span class="pre">seq)</span></tt> --> elements of seq where <tt class="docutils literal"><span class="pre">pred(elem)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt></blockquote>
|
||||
<p>
|
||||
<a name="fn-ifilterfalse"></a>
|
||||
<a class="mochidef reference" href="#fn-ifilterfalse">ifilterfalse(pred, seq)</a>:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">ifilterfalse(pred,</span> <span class="pre">seq)</span></tt> --> elements of seq where <tt class="docutils literal"><span class="pre">pred(elem)</span></tt> is</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">false</span></tt></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-imap"></a>
|
||||
<a class="mochidef reference" href="#fn-imap">imap(fun, p, q[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">imap(fun,</span> <span class="pre">p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --> fun(p0, q0, ...), fun(p1, q1, ...), ...</blockquote>
|
||||
<p>
|
||||
<a name="fn-islice"></a>
|
||||
<a class="mochidef reference" href="#fn-islice">islice(seq, [start,] stop[, step])</a>:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">islice(seq,</span> <span class="pre">[start,]</span> <span class="pre">stop[,</span> <span class="pre">step])</span></tt> --> elements from</dt>
|
||||
<dd>seq[start:stop:step] (in Python slice syntax)</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-iter"></a>
|
||||
<a class="mochidef reference" href="#fn-iter">iter(iterable[, sentinel])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Convert the given argument to an iterator (object implementing
|
||||
<tt class="docutils literal"><span class="pre">.next()</span></tt>).</p>
|
||||
<ol class="arabic simple">
|
||||
<li>If <tt class="docutils literal"><span class="pre">iterable</span></tt> is an iterator (implements <tt class="docutils literal"><span class="pre">.next()</span></tt>), then it will
|
||||
be returned as-is.</li>
|
||||
<li>If <tt class="docutils literal"><span class="pre">iterable</span></tt> is an iterator factory (implements <tt class="docutils literal"><span class="pre">.iter()</span></tt>), then
|
||||
the result of <tt class="docutils literal"><span class="pre">iterable.iter()</span></tt> will be returned.</li>
|
||||
<li>Otherwise, the iterator factory <a class="mochiref reference" href="Base.html#fn-adapterregistry">MochiKit.Base.AdapterRegistry</a>
|
||||
is used to find a match.</li>
|
||||
<li>If no factory is found, it will throw <tt class="docutils literal"><span class="pre">TypeError</span></tt></li>
|
||||
</ol>
|
||||
<p>Built-in iterator factories are present for Array-like objects, and
|
||||
objects that implement the <tt class="docutils literal"><span class="pre">iterateNext</span></tt> protocol (e.g. the result of
|
||||
Mozilla's <tt class="docutils literal"><span class="pre">document.evaluate</span></tt>).</p>
|
||||
<p>When used directly, using an iterator should look like this:</p>
|
||||
<pre class="literal-block">
|
||||
var it = iter(iterable);
|
||||
try {
|
||||
while (var o = it.next()) {
|
||||
// use o
|
||||
}
|
||||
} catch (e) {
|
||||
if (e != StopIteration) {
|
||||
throw e;
|
||||
}
|
||||
// pass
|
||||
}
|
||||
</pre>
|
||||
<p>This is ugly, so you should use the higher order functions to work
|
||||
with iterators whenever possible.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-izip"></a>
|
||||
<a class="mochidef reference" href="#fn-izip">izip(p, q[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">izip(p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --> [p0, q0, ...], [p1, q1, ...], ...</blockquote>
|
||||
<p>
|
||||
<a name="fn-list"></a>
|
||||
<a class="mochidef reference" href="#fn-list">list(iterable)</a>:</p>
|
||||
<blockquote>
|
||||
Convert <tt class="docutils literal"><span class="pre">iterable</span></tt> to a new <tt class="docutils literal"><span class="pre">Array</span></tt></blockquote>
|
||||
<p>
|
||||
<a name="fn-next"></a>
|
||||
<a class="mochidef reference" href="#fn-next">next(iterator)</a>:</p>
|
||||
<blockquote>
|
||||
Return <tt class="docutils literal"><span class="pre">iterator.next()</span></tt></blockquote>
|
||||
<p>
|
||||
<a name="fn-range"></a>
|
||||
<a class="mochidef reference" href="#fn-range">range([start,] stop[, step])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Return an iterator containing an arithmetic progression of integers.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">range(i,</span> <span class="pre">j)</span></tt> returns <a class="mochiref reference" href="#fn-iter">iter([i, i + 1, i + 2, ..., j - 1])</a></p>
|
||||
<p><tt class="docutils literal"><span class="pre">start</span></tt> (!) defaults to <tt class="docutils literal"><span class="pre">0</span></tt>. When <tt class="docutils literal"><span class="pre">step</span></tt> is given, it specifies the
|
||||
increment (or decrement). The end point is omitted!</p>
|
||||
<p>For example, <tt class="docutils literal"><span class="pre">range(4)</span></tt> returns <a class="mochiref reference" href="#fn-iter">iter([0, 1, 2, 3])</a>.
|
||||
This iterates over exactly the valid indexes for an array of 4 elements.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-reduce"></a>
|
||||
<a class="mochidef reference" href="#fn-reduce">reduce(fn, iterable[, initial])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Apply <tt class="docutils literal"><span class="pre">fn(a,</span> <span class="pre">b)</span></tt> cumulatively to the items of an
|
||||
iterable from left to right, so as to reduce the iterable
|
||||
to a single value.</p>
|
||||
<p>For example:</p>
|
||||
<pre class="literal-block">
|
||||
reduce(function (a, b) { return x + y; }, [1, 2, 3, 4, 5])
|
||||
</pre>
|
||||
<p>calculates:</p>
|
||||
<pre class="literal-block">
|
||||
((((1 + 2) + 3) + 4) + 5).
|
||||
</pre>
|
||||
<p>If initial is given, it is placed before the items of the sequence
|
||||
in the calculation, and serves as a default when the sequence is
|
||||
empty.</p>
|
||||
<p>Note that the above example could be written more clearly as:</p>
|
||||
<pre class="literal-block">
|
||||
reduce(operator.add, [1, 2, 3, 4, 5])
|
||||
</pre>
|
||||
<p>Or even simpler:</p>
|
||||
<pre class="literal-block">
|
||||
sum([1, 2, 3, 4, 5])
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-registeriteratorfactory"></a>
|
||||
<a class="mochidef reference" href="#fn-registeriteratorfactory">registerIteratorFactory(name, check, iterfactory[, override])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Register an iterator factory for use with the iter function.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">check</span></tt> is a <tt class="docutils literal"><span class="pre">function(a)</span></tt> that returns <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">a</span></tt> can be
|
||||
converted into an iterator with <tt class="docutils literal"><span class="pre">iterfactory</span></tt>.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">iterfactory</span></tt> is a <tt class="docutils literal"><span class="pre">function(a)</span></tt> that returns an object with a
|
||||
<tt class="docutils literal"><span class="pre">.next()</span></tt> method that returns the next value in the sequence.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">iterfactory</span></tt> is guaranteed to only be called if <tt class="docutils literal"><span class="pre">check(a)</span></tt>
|
||||
returns a true value.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">override</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then it will be made the
|
||||
highest precedence iterator factory. Otherwise, the lowest.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-repeat"></a>
|
||||
<a class="mochidef reference" href="#fn-repeat">repeat(elem[, n])</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">repeat(elem,</span> <span class="pre">[,n])</span></tt> --> elem, elem, elem, ... endlessly or up to n times</blockquote>
|
||||
<p>
|
||||
<a name="fn-reversed"></a>
|
||||
<a class="mochidef reference" href="#fn-reversed">reversed(iterable)</a>:</p>
|
||||
<blockquote>
|
||||
Return a reversed array from iterable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-some"></a>
|
||||
<a class="mochidef reference" href="#fn-some">some(iterable, func)</a>:</p>
|
||||
<blockquote>
|
||||
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">func(item)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt> for at least one item in
|
||||
<tt class="docutils literal"><span class="pre">iterable</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-sorted"></a>
|
||||
<a class="mochidef reference" href="#fn-sorted">sorted(iterable[, cmp])</a>:</p>
|
||||
<blockquote>
|
||||
Return a sorted array from iterable.</blockquote>
|
||||
<p>
|
||||
<a name="fn-sum"></a>
|
||||
<a class="mochidef reference" href="#fn-sum">sum(iterable, start=0)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns the sum of a sequence of numbers plus the value
|
||||
of parameter <tt class="docutils literal"><span class="pre">start</span></tt> (with a default of 0). When the sequence is
|
||||
empty, returns start.</p>
|
||||
<p>Equivalent to:</p>
|
||||
<pre class="literal-block">
|
||||
reduce(operator.add, iterable, start);
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-takewhile"></a>
|
||||
<a class="mochidef reference" href="#fn-takewhile">takewhile(pred, seq)</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">takewhile(pred,</span> <span class="pre">seq)</span></tt> --> seq[0], seq[1], ... until pred(seq[n]) fails</blockquote>
|
||||
<p>
|
||||
<a name="fn-tee"></a>
|
||||
<a class="mochidef reference" href="#fn-tee">tee(iterable, n=2)</a>:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">tee(it,</span> <span class="pre">n=2)</span></tt> --> [it1, it2, it3, ... itn] splits one iterator into n</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id4" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id1" name="id4">[1]</a></td><td>The iteration protocol is described in
|
||||
PEP 234 - Iterators: <a class="reference" href="http://www.python.org/peps/pep-0234.html">http://www.python.org/peps/pep-0234.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id5" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id2" name="id5">[2]</a></td><td>Python's itertools
|
||||
module: <a class="reference" href="http://docs.python.org/lib/module-itertools.html">http://docs.python.org/lib/module-itertools.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id6" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id3" name="id6">[3]</a></td><td>Iteration in JavaScript: <a class="reference" href="http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/">http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,310 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Logging - we're all tired of alert()</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Logging - we're all tired of alert()</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
log("INFO messages are so boring");
|
||||
logDebug("DEBUG messages are even worse");
|
||||
log("good thing I can pass", objects, "conveniently");
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>MochiKit.Logging steals some ideas from Python's logging module <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a>, but
|
||||
completely forgot about the Java <a class="footnote-reference" href="#id7" id="id2" name="id2">[2]</a> inspiration. This is a KISS module for
|
||||
logging that provides enough flexibility to do just about anything via
|
||||
listeners, but without all the cruft.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="native-console-logging" name="native-console-logging">Native Console Logging</a></h2>
|
||||
<p>As of MochiKit 1.3, the default logger will log all messages to your browser's
|
||||
native console. This is currently supported in Safari, Opera 9, and Firefox
|
||||
when the <a class="reference" href="http://www.joehewitt.com/software/firebug/">FireBug</a> extension is installed.</p>
|
||||
<p>To disable this behavior:</p>
|
||||
<pre class="literal-block">
|
||||
MochiKit.Logging.logger.useNativeLogging = false;
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="bookmarklet-based-debugging" name="bookmarklet-based-debugging">Bookmarklet Based Debugging</a></h2>
|
||||
<p>JavaScript is at a serious disadvantage without a standard console for
|
||||
"print" statements. Everything else has one. The closest thing that
|
||||
you get in a browser environment is the <tt class="docutils literal"><span class="pre">alert</span></tt> function, which is
|
||||
absolutely evil.</p>
|
||||
<p>This leaves you with one reasonable solution: do your logging in the page
|
||||
somehow. The problem here is that you don't want to clutter the page with
|
||||
debugging tools. The solution to that problem is what we call BBD, or
|
||||
Bookmarklet Based Debugging <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a>.</p>
|
||||
<p>Simply create a bookmarklet for <a class="reference" href="javascript:MochiKit.Logging.logger.debuggingBookmarklet()">javascript:MochiKit.Logging.logger.debuggingBookmarklet()</a>,
|
||||
and whack it whenever you want to see what's in the logger. Of course, this
|
||||
means you must drink the MochiKit.Logging kool-aid. It's tangy and sweet,
|
||||
don't worry.</p>
|
||||
<p>Currently this is an ugly <tt class="docutils literal"><span class="pre">alert</span></tt>, but we'll have something spiffy
|
||||
Real Soon Now, and when we do, you only have to upgrade MochiKit.Logging,
|
||||
not your bookmarklet!</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="constructors" name="constructors">Constructors</a></h2>
|
||||
<p>
|
||||
<a name="fn-logmessage"></a>
|
||||
<a class="mochidef reference" href="#fn-logmessage">LogMessage(num, level, info)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Properties:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">num</span></tt>:</dt>
|
||||
<dd>Identifier for the log message</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">level</span></tt>:</dt>
|
||||
<dd>Level of the log message (<tt class="docutils literal"><span class="pre">"INFO"</span></tt>, <tt class="docutils literal"><span class="pre">"WARN"</span></tt>, <tt class="docutils literal"><span class="pre">"DEBUG"</span></tt>,
|
||||
etc.)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">info</span></tt>:</dt>
|
||||
<dd>All other arguments passed to log function as an <tt class="docutils literal"><span class="pre">Array</span></tt></dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">timestamp</span></tt>:</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">Date</span></tt> object timestamping the log message</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger"></a>
|
||||
<a class="mochidef reference" href="#fn-logger">Logger([maxSize])</a>:</p>
|
||||
<blockquote>
|
||||
<p>A basic logger object that has a buffer of recent messages
|
||||
plus a listener dispatch mechanism for "real-time" logging
|
||||
of important messages.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">maxSize</span></tt> is the maximum number of entries in the log.
|
||||
If <tt class="docutils literal"><span class="pre">maxSize</span> <span class="pre">>=</span> <span class="pre">0</span></tt>, then the log will not buffer more than that
|
||||
many messages. So if you don't like logging at all, be sure to
|
||||
pass <tt class="docutils literal"><span class="pre">0</span></tt>.</p>
|
||||
<p>There is a default logger available named "logger", and several
|
||||
of its methods are also global functions:</p>
|
||||
<blockquote>
|
||||
<tt class="docutils literal"><span class="pre">logger.log</span></tt> -> <tt class="docutils literal"><span class="pre">log</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">logger.debug</span></tt> -> <tt class="docutils literal"><span class="pre">logDebug</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">logger.warning</span></tt> -> <tt class="docutils literal"><span class="pre">logWarning</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">logger.error</span></tt> -> <tt class="docutils literal"><span class="pre">logError</span></tt>
|
||||
<tt class="docutils literal"><span class="pre">logger.fatal</span></tt> -> <tt class="docutils literal"><span class="pre">logFatal</span></tt></blockquote>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.addlistener"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.addlistener">Logger.prototype.addListener(ident, filter, listener)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Add a listener for log messages.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">ident</span></tt> is a unique identifier that may be used to remove the listener
|
||||
later on.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">filter</span></tt> can be one of the following:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">null</span></tt>:</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">listener(msg)</span></tt> will be called for every log message
|
||||
received.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">string</span></tt>:</dt>
|
||||
<dd><a class="mochiref reference" href="#fn-loglevelatleast">logLevelAtLeast(filter)</a> will be used as the function
|
||||
(see below).</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">function</span></tt>:</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">filter(msg)</span></tt> will be called for every msg, if it returns
|
||||
true then <tt class="docutils literal"><span class="pre">listener(msg)</span></tt> will be called.</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<p><tt class="docutils literal"><span class="pre">listener</span></tt> is a function that takes one argument, a log message. A log
|
||||
message is an object (<a class="mochiref reference" href="#fn-logmessage">LogMessage</a> instance) that has at least these
|
||||
properties:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">num</span></tt>:</dt>
|
||||
<dd>A counter that uniquely identifies a log message (per-logger)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">level</span></tt>:</dt>
|
||||
<dd>A string or number representing the log level. If string, you
|
||||
may want to use <tt class="docutils literal"><span class="pre">LogLevel[level]</span></tt> for comparison.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">info</span></tt>:</dt>
|
||||
<dd>An Array of objects passed as additional arguments to the <tt class="docutils literal"><span class="pre">log</span></tt>
|
||||
function.</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.baselog"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.baselog">Logger.prototype.baseLog(level, message[, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<p>The base functionality behind all of the log functions.
|
||||
The first argument is the log level as a string or number,
|
||||
and all other arguments are used as the info list.</p>
|
||||
<p>This function is available partially applied as:</p>
|
||||
<blockquote>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="61%" />
|
||||
<col width="39%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td>Logger.debug</td>
|
||||
<td>'DEBUG'</td>
|
||||
</tr>
|
||||
<tr><td>Logger.log</td>
|
||||
<td>'INFO'</td>
|
||||
</tr>
|
||||
<tr><td>Logger.error</td>
|
||||
<td>'ERROR'</td>
|
||||
</tr>
|
||||
<tr><td>Logger.fatal</td>
|
||||
<td>'FATAL'</td>
|
||||
</tr>
|
||||
<tr><td>Logger.warning</td>
|
||||
<td>'WARNING'</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</blockquote>
|
||||
<p>For the default logger, these are also available as global functions,
|
||||
see the <a class="mochiref reference" href="#fn-logger">Logger</a> constructor documentation for more info.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.clear"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.clear">Logger.prototype.clear()</a>:</p>
|
||||
<blockquote>
|
||||
Clear all messages from the message buffer.</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.debuggingbookmarklet"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.debuggingbookmarklet">Logger.prototype.debuggingBookmarklet()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Display the contents of the logger in a useful way for browsers.</p>
|
||||
<p>Currently, if <a class="mochiref reference" href="LoggingPane.html">MochiKit.LoggingPane</a> is loaded, then a pop-up
|
||||
<a class="mochiref reference" href="LoggingPane.html#fn-loggingpane">MochiKit.LoggingPane.LoggingPane</a> will be used. Otherwise,
|
||||
it will be an alert with <a class="mochiref reference" href="#fn-logger.prototype.getmessagetext">Logger.prototype.getMessageText()</a>.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.dispatchlisteners"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.dispatchlisteners">Logger.prototype.dispatchListeners(msg)</a>:</p>
|
||||
<blockquote>
|
||||
Dispatch a log message to all listeners.</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.getmessages"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.getmessages">Logger.prototype.getMessages(howMany)</a>:</p>
|
||||
<blockquote>
|
||||
Return a list of up to <tt class="docutils literal"><span class="pre">howMany</span></tt> messages from the message buffer.</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.getmessagetext"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.getmessagetext">Logger.prototype.getMessageText(howMany)</a>:</p>
|
||||
<blockquote>
|
||||
<p>Get a string representing up to the last <tt class="docutils literal"><span class="pre">howMany</span></tt> messages in the
|
||||
message buffer. The default is <tt class="docutils literal"><span class="pre">30</span></tt>.</p>
|
||||
<p>The message looks like this:</p>
|
||||
<pre class="literal-block">
|
||||
LAST {messages.length} MESSAGES:
|
||||
[{msg.num}] {msg.level}: {m.info.join(' ')}
|
||||
[{msg.num}] {msg.level}: {m.info.join(' ')}
|
||||
...
|
||||
</pre>
|
||||
<p>If you want some other format, use
|
||||
<a class="mochiref reference" href="#fn-logger.prototype.getmessages">Logger.prototype.getMessages</a> and do it yourself.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-logger.prototype.removelistener"></a>
|
||||
<a class="mochidef reference" href="#fn-logger.prototype.removelistener">Logger.prototype.removeListener(ident)</a>:</p>
|
||||
<blockquote>
|
||||
Remove a listener using the ident given to <a class="mochiref reference" href="#fn-logger.prototype.addlistener">Logger.prototype.addListener</a></blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-alertlistener"></a>
|
||||
<a class="mochidef reference" href="#fn-alertlistener">alertListener(msg)</a>:</p>
|
||||
<blockquote>
|
||||
Ultra-obnoxious <tt class="docutils literal"><span class="pre">alert(...)</span></tt> listener</blockquote>
|
||||
<p>
|
||||
<a name="fn-logdebug"></a>
|
||||
<a class="mochidef reference" href="#fn-logdebug">logDebug(message[, info[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Log an INFO message to the default logger</blockquote>
|
||||
<p>
|
||||
<a name="fn-logdebug"></a>
|
||||
<a class="mochidef reference" href="#fn-logdebug">logDebug(message[, info[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Log a DEBUG message to the default logger</blockquote>
|
||||
<p>
|
||||
<a name="fn-logerror"></a>
|
||||
<a class="mochidef reference" href="#fn-logerror">logError(message[, info[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Log an ERROR message to the default logger</blockquote>
|
||||
<p>
|
||||
<a name="fn-logfatal"></a>
|
||||
<a class="mochidef reference" href="#fn-logfatal">logFatal(message[, info[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Log a FATAL message to the default logger</blockquote>
|
||||
<p>
|
||||
<a name="fn-loglevelatleast"></a>
|
||||
<a class="mochidef reference" href="#fn-loglevelatleast">logLevelAtLeast(minLevel)</a>:</p>
|
||||
<blockquote>
|
||||
Return a function that will match log messages whose level
|
||||
is at least minLevel</blockquote>
|
||||
<p>
|
||||
<a name="fn-logwarning"></a>
|
||||
<a class="mochidef reference" href="#fn-logwarning">logWarning(message[, info[, ...]])</a>:</p>
|
||||
<blockquote>
|
||||
Log a WARNING message to the default logger</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id6" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id1" name="id6">[1]</a></td><td>Python's logging module: <a class="reference" href="http://docs.python.org/lib/module-logging.html">http://docs.python.org/lib/module-logging.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id7" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id2" name="id7">[2]</a></td><td>PEP 282, where they admit all of the Java influence: <a class="reference" href="http://www.python.org/peps/pep-0282.html">http://www.python.org/peps/pep-0282.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id8" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Original Bookmarklet Based Debugging blather: <a class="reference" href="http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/">http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,121 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.LoggingPane - Interactive MochiKit.Logging pane</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.LoggingPane - Interactive MochiKit.Logging pane</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
// open a pop-up window
|
||||
createLoggingPane()
|
||||
// use a div at the bottom of the document
|
||||
createLoggingPane(true);
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>MochiKit.Logging does not have any browser dependencies and is completely
|
||||
unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane
|
||||
for your <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> output that can be used as a pop-up or
|
||||
inline.</p>
|
||||
<p>It also allows for regex and level filtering! MochiKit.LoggingPane is used
|
||||
as the default <a class="mochiref reference" href="Logging.html#fn-debuggingbookmarklet">MochiKit.Logging.debuggingBookmarklet()</a> if it is
|
||||
loaded.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
<li><a class="mochiref reference" href="Logging.html">MochiKit.Logging</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="constructors" name="constructors">Constructors</a></h2>
|
||||
<p>
|
||||
<a name="fn-loggingpane"></a>
|
||||
<a class="mochidef reference" href="#fn-loggingpane">LoggingPane(inline=false, logger=MochiKit.Logging.logger)</a>:</p>
|
||||
<blockquote>
|
||||
<p>A listener for a <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> logger with an interactive
|
||||
DOM representation.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">inline</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then the <tt class="docutils literal"><span class="pre">LoggingPane</span></tt> will be a <tt class="docutils literal"><span class="pre">DIV</span></tt>
|
||||
at the bottom of the document. Otherwise, it will be in a pop-up
|
||||
window with a name based on the calling page's URL. If there is an
|
||||
element in the document with an id of <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt>,
|
||||
it will be used instead of appending a new <tt class="docutils literal"><span class="pre">DIV</span></tt> to the body.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">logger</span></tt> is the reference to the <a class="mochiref reference" href="Logging.html#fn-logger">MochiKit.Logging.Logger</a> to
|
||||
listen to. If not specified, the global default logger is used.</p>
|
||||
<p>Properties:</p>
|
||||
<blockquote>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">win</span></tt>:</dt>
|
||||
<dd>Reference to the pop-up window (<tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">inline</span></tt>)</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">inline</span></tt>:</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">true</span></tt> if the <tt class="docutils literal"><span class="pre">LoggingPane</span></tt> is inline</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">colorTable</span></tt>:</dt>
|
||||
<dd><p class="first">An object with property->value mappings for each log level
|
||||
and its color. May also be mutated on <tt class="docutils literal"><span class="pre">LoggingPane.prototype</span></tt>
|
||||
to affect all instances. For example:</p>
|
||||
<pre class="last literal-block">
|
||||
MochiKit.LoggingPane.LoggingPane.prototype.colorTable = {
|
||||
DEBUG: "green",
|
||||
INFO: "black",
|
||||
WARNING: "blue",
|
||||
ERROR: "red",
|
||||
FATAL: "darkred"
|
||||
};
|
||||
</pre>
|
||||
</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-loggingpane.prototype.closepane"></a>
|
||||
<a class="mochidef reference" href="#fn-loggingpane.prototype.closepane">LoggingPane.prototype.closePane()</a>:</p>
|
||||
<blockquote>
|
||||
Close the <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> (close the child window, or
|
||||
remove the <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> <tt class="docutils literal"><span class="pre">DIV</span></tt> from the document).</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-createloggingpane"></a>
|
||||
<a class="mochidef reference" href="#fn-createloggingpane">createLoggingPane(inline=false)</a>:</p>
|
||||
<blockquote>
|
||||
Create or return an existing <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> for this document
|
||||
with the given inline setting. This is preferred over using
|
||||
<a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> directly, as only one <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a>
|
||||
should be present in a given document.</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,331 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Signal - Simple universal event handling</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Signal - Simple universal event handling</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<p>Signal for DOM events:</p>
|
||||
<pre class="literal-block">
|
||||
// DOM events are also signals. Connect freely! The functions will be
|
||||
// called with the custom event as a parameter.
|
||||
|
||||
// calls myClicked.apply(getElement('myID'), event)
|
||||
connect('myID', 'onclick', myClicked);
|
||||
|
||||
// calls wasClicked.apply(myObject, event)
|
||||
connect('myID', 'onclick', myObject, wasClicked);
|
||||
|
||||
// calls myObject.wasClicked(event)
|
||||
connect('myID', 'onclick', myObject, 'wasClicked');
|
||||
|
||||
// the event is normalized, no more e = e || window.event!
|
||||
myObject.wasClicked = function(e) {
|
||||
var crossBrowserCoordinates = e.mouse().page;
|
||||
// e.mouse().page is a MochiKit.DOM.Coordinates object
|
||||
}
|
||||
</pre>
|
||||
<p>Signal for non-DOM events:</p>
|
||||
<pre class="literal-block">
|
||||
// otherObject.gotFlash() will be called when 'flash' signalled.
|
||||
connect(myObject, 'flash', otherObject, 'gotFlash');
|
||||
|
||||
// gotBang.apply(otherObject) will be called when 'bang' signalled.
|
||||
// You can access otherObject from within gotBang as 'this'.
|
||||
connect(myObject, 'bang', otherObject, gotBang);
|
||||
|
||||
// myFunc.apply(myObject) will be called when 'flash' signalled.
|
||||
// You can access myObject from within myFunc as 'this'.
|
||||
var ident = connect(myObject, 'flash', myFunc);
|
||||
|
||||
// You may disconnect with the return value from connect
|
||||
disconnect(ident);
|
||||
|
||||
// Signal can take parameters. These will be passed along to the connected
|
||||
// functions.
|
||||
signal(myObject, 'flash');
|
||||
signal(myObject, 'bang', 'BANG!');
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>Event handling was never so easy!</p>
|
||||
<p>This module takes care of all the hard work—figuring out which event
|
||||
model to use, trying to retrieve the event object, and handling your own
|
||||
internal events, as well as cleanup when the page is unloaded to clean up IE's
|
||||
nasty memory leakage.</p>
|
||||
<p>This event system is largely based on Qt's signal/slot system. Read more on
|
||||
how that is handled and also how it is used in model/view programming at:
|
||||
<a class="reference" href="http://doc.trolltech.com/">http://doc.trolltech.com/</a></p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="using-signal-for-dom-events" name="using-signal-for-dom-events">Using Signal for DOM Events</a></h2>
|
||||
<p>When using MochiKit.Signal, do not use the browser's native event API. That
|
||||
means, no <tt class="docutils literal"><span class="pre">onclick="blah"</span></tt>, no <tt class="docutils literal"><span class="pre">elem.addEventListener(...)</span></tt>, and certainly
|
||||
no <tt class="docutils literal"><span class="pre">elem.attachEvent(...)</span></tt>. This also means that
|
||||
<a class="mochiref reference" href="DOM.html#fn-addtocallstack">MochiKit.DOM.addToCallStack</a> and
|
||||
<a class="mochiref reference" href="DOM.html#fn-addloadevent">MochiKit.DOM.addLoadEvent</a> should not be used in combination with
|
||||
this module.</p>
|
||||
<p>Signals for DOM objects are named with the <tt class="docutils literal"><span class="pre">'on'</span></tt> prefix, e.g.:
|
||||
<tt class="docutils literal"><span class="pre">'onclick'</span></tt>, <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt>, etc.</p>
|
||||
<p>When the signal fires, your slot will be called with one parameter, the custom
|
||||
event object.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="custom-event-objects-for-dom-events" name="custom-event-objects-for-dom-events">Custom Event Objects for DOM events</a></h2>
|
||||
<p>Signals triggered by DOM events are called with a custom event object as a
|
||||
parameter. The custom event object presents a consistent view of the event
|
||||
across all supported platforms and browsers, and provides many conveniences
|
||||
not available even in a correct W3C implementation.</p>
|
||||
<p>See the <a class="reference" href="#dom-custom-event-object-reference">DOM Custom Event Object Reference</a> for a detailed API description
|
||||
of this object.</p>
|
||||
<p>If you find that you're accessing the native event for any reason, create a
|
||||
<a class="reference" href="http://trac.mochikit.com/newticket">new ticket</a> and we'll look into normalizing the behavior you're looking for.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="memory-usage" name="memory-usage">Memory Usage</a></h2>
|
||||
<p>Any object that has connected slots (via <a class="mochiref reference" href="#fn-connect">connect()</a>) is referenced
|
||||
by the Signal mechanism until it is disconnected via <a class="mochiref reference" href="#fn-disconnect">disconnect()</a>
|
||||
or <a class="mochiref reference" href="#fn-disconnectall">disconnectAll()</a>.</p>
|
||||
<p>Signal does not leak. It registers an <tt class="docutils literal"><span class="pre">'onunload'</span></tt> event that disconnects all
|
||||
objects on the page when the browser leaves the page. However, memory usage
|
||||
will grow during the page view for every connection made until it is
|
||||
disconnected. Even if the DOM object is removed from the document, it
|
||||
will still be referenced by Signal until it is explicitly disconnected.</p>
|
||||
<p>In order to conserve memory during the page view, <a class="mochiref reference" href="#fn-disconnectall">disconnectAll()</a>
|
||||
any DOM elements that are about to be removed from the document.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="using-signal-for-non-dom-objects" name="using-signal-for-non-dom-objects">Using Signal for non-DOM objects</a></h2>
|
||||
<p>Signals are triggered with the <a class="mochiref reference" href="#fn-signal">signal(src, 'signal', ...)</a>
|
||||
function. Additional parameters passed to this are passed onto the
|
||||
connected slots. Explicit signals are not required for DOM events.</p>
|
||||
<p>Slots that are connected to a signal are called in the following manner
|
||||
when that signal is signalled:</p>
|
||||
<ul class="simple">
|
||||
<li>If the slot was a single function, then it is called with <tt class="docutils literal"><span class="pre">this</span></tt> set
|
||||
to the object originating the signal with whatever parameters it was
|
||||
signalled with.</li>
|
||||
<li>If the slot was an object and a function, then it is called with
|
||||
<tt class="docutils literal"><span class="pre">this</span></tt> set to the object, and with whatever parameters it was
|
||||
signalled with.</li>
|
||||
<li>If the slot was an object and a string, then <tt class="docutils literal"><span class="pre">object[string]</span></tt> is
|
||||
called with the parameters to the signal.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="signal-api-reference" name="signal-api-reference">Signal API Reference</a></h2>
|
||||
<p>
|
||||
<a name="fn-connect"></a>
|
||||
<a class="mochidef reference" href="#fn-connect">connect(src, signal, dest[, func])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Connects a signal to a slot, and return a unique identifier that can be
|
||||
used to disconnect that signal.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">src</span></tt> is the object that has the signal. You may pass in a string, in
|
||||
which case, it is interpreted as an id for an HTML element.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">signal</span></tt> is a string that represents a signal name. If 'src' is an HTML
|
||||
Element, <tt class="docutils literal"><span class="pre">window</span></tt>, or the <tt class="docutils literal"><span class="pre">document</span></tt>, then it can be one of the
|
||||
'on-XYZ' events. You must include the 'on' prefix, and it must be all
|
||||
lower-case.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">dest</span></tt> and <tt class="docutils literal"><span class="pre">func</span></tt> describe the slot, or the action to take when the
|
||||
signal is triggered.</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li>If <tt class="docutils literal"><span class="pre">dest</span></tt> is an object and <tt class="docutils literal"><span class="pre">func</span></tt> is a string, then
|
||||
<tt class="docutils literal"><span class="pre">dest[func].apply(dest,</span> <span class="pre">...)</span></tt> will be called when the signal
|
||||
is signalled.</li>
|
||||
<li>If <tt class="docutils literal"><span class="pre">dest</span></tt> is an object and <tt class="docutils literal"><span class="pre">func</span></tt> is a function, then
|
||||
<tt class="docutils literal"><span class="pre">func.apply(dest,</span> <span class="pre">...)</span></tt> will be called when the signal is
|
||||
signalled.</li>
|
||||
<li>If <tt class="docutils literal"><span class="pre">func</span></tt> is undefined and <tt class="docutils literal"><span class="pre">dest</span></tt> is a function, then
|
||||
<tt class="docutils literal"><span class="pre">func.apply(src,</span> <span class="pre">...)</span></tt> will be called when the signal is
|
||||
signalled.</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>No other combinations are allowed and will raise an exception.</p>
|
||||
<p>The return value can be passed to <a class="mochiref reference" href="#fn-disconnect">disconnect</a> to disconnect
|
||||
the signal.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-disconnect"></a>
|
||||
<a class="mochidef reference" href="#fn-disconnect">disconnect(ident)</a>:</p>
|
||||
<blockquote>
|
||||
To disconnect a signal, pass its ident returned by <a class="mochiref reference" href="#fn-connect">connect()</a>.
|
||||
This is similar to how the browser's <tt class="docutils literal"><span class="pre">setTimeout</span></tt> and <tt class="docutils literal"><span class="pre">clearTimeout</span></tt>
|
||||
works.</blockquote>
|
||||
<p>
|
||||
<a name="fn-disconnectall"></a>
|
||||
<a class="mochidef reference" href="#fn-disconnectall">disconnectAll(src[, signal, ...])</a>:</p>
|
||||
<blockquote>
|
||||
<p><tt class="docutils literal"><span class="pre">disconnectAll(src)</span></tt> removes all signals from src.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">disconnectAll(src,</span> <span class="pre">'onmousedown',</span> <span class="pre">'mySignal')</span></tt> will remove all
|
||||
<tt class="docutils literal"><span class="pre">'onmousedown'</span></tt> and <tt class="docutils literal"><span class="pre">'mySignal'</span></tt> signals from src.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-signal"></a>
|
||||
<a class="mochidef reference" href="#fn-signal">signal(src, signal, ...)</a>:</p>
|
||||
<blockquote>
|
||||
This will signal a signal, passing whatever additional parameters on to
|
||||
the connected slots. <tt class="docutils literal"><span class="pre">src</span></tt> and <tt class="docutils literal"><span class="pre">signal</span></tt> are the same as for
|
||||
<a class="mochiref reference" href="#fn-connect">connect()</a>.</blockquote>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h2><a id="dom-custom-event-object-reference" name="dom-custom-event-object-reference">DOM Custom Event Object Reference</a></h2>
|
||||
<p>
|
||||
<a name="fn-event"></a>
|
||||
<a class="mochidef reference" href="#fn-event">event()</a>:</p>
|
||||
<blockquote>
|
||||
The native event produced by the browser. You should not need to use this.</blockquote>
|
||||
<p>
|
||||
<a name="fn-src"></a>
|
||||
<a class="mochidef reference" href="#fn-src">src()</a>:</p>
|
||||
<blockquote>
|
||||
The element that this signal is connected to.</blockquote>
|
||||
<p>
|
||||
<a name="fn-type"></a>
|
||||
<a class="mochidef reference" href="#fn-type">type()</a>:</p>
|
||||
<blockquote>
|
||||
The event type (<tt class="docutils literal"><span class="pre">'click'</span></tt>, <tt class="docutils literal"><span class="pre">'mouseover'</span></tt>, <tt class="docutils literal"><span class="pre">'keypress'</span></tt>, etc.) as a
|
||||
string. Does not include the <tt class="docutils literal"><span class="pre">'on'</span></tt> prefix.</blockquote>
|
||||
<p>
|
||||
<a name="fn-target"></a>
|
||||
<a class="mochidef reference" href="#fn-target">target()</a>:</p>
|
||||
<blockquote>
|
||||
The element that triggered the event. This may be a child of
|
||||
<a class="mochiref reference" href="#fn-src">src()</a>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-modifier"></a>
|
||||
<a class="mochidef reference" href="#fn-modifier">modifier()</a>:</p>
|
||||
<blockquote>
|
||||
Returns <tt class="docutils literal"><span class="pre">{shift,</span> <span class="pre">ctrl,</span> <span class="pre">meta,</span> <span class="pre">alt,</span> <span class="pre">any}</span></tt>, where each property is <tt class="docutils literal"><span class="pre">true</span></tt>
|
||||
if its respective modifier key was pressed, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise. <tt class="docutils literal"><span class="pre">any</span></tt>
|
||||
is <tt class="docutils literal"><span class="pre">true</span></tt> if any modifier is pressed, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</blockquote>
|
||||
<p>
|
||||
<a name="fn-stoppropagation"></a>
|
||||
<a class="mochidef reference" href="#fn-stoppropagation">stopPropagation()</a>:</p>
|
||||
<blockquote>
|
||||
Works like W3C's <tt class="docutils literal"><span class="pre">stopPropagation()</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-preventdefault"></a>
|
||||
<a class="mochidef reference" href="#fn-preventdefault">preventDefault()</a>:</p>
|
||||
<blockquote>
|
||||
Works like W3C's <tt class="docutils literal"><span class="pre">preventDefault()</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-stop"></a>
|
||||
<a class="mochidef reference" href="#fn-stop">stop()</a>:</p>
|
||||
<blockquote>
|
||||
Shortcut that calls <tt class="docutils literal"><span class="pre">stopPropagation()</span></tt> and <tt class="docutils literal"><span class="pre">preventDefault()</span></tt>.</blockquote>
|
||||
<p>
|
||||
<a name="fn-key"></a>
|
||||
<a class="mochidef reference" href="#fn-key">key()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Returns <tt class="docutils literal"><span class="pre">{code,</span> <span class="pre">string}</span></tt>.</p>
|
||||
<p>Use <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt> handlers to detect control
|
||||
characters such as <tt class="docutils literal"><span class="pre">'KEY_F1'</span></tt>. Use the <tt class="docutils literal"><span class="pre">'onkeypressed'</span></tt> handler to
|
||||
detect "printable" characters, such as <tt class="docutils literal"><span class="pre">'é'</span></tt>.</p>
|
||||
<p>When a user presses F1, in <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt> this method
|
||||
returns <tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">122,</span> <span class="pre">string:</span> <span class="pre">'KEY_F1'}</span></tt>. In <tt class="docutils literal"><span class="pre">'onkeypress'</span></tt>, it returns
|
||||
<tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">0,</span> <span class="pre">string:</span> <span class="pre">''}</span></tt>.</p>
|
||||
<p>If a user presses Shift+2 on a US keyboard, this method returns
|
||||
<tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">50,</span> <span class="pre">string:</span> <span class="pre">'KEY_2'}</span></tt> in <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt>.
|
||||
In <tt class="docutils literal"><span class="pre">'onkeypress'</span></tt>, it returns <tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">64,</span> <span class="pre">string:</span> <span class="pre">'@'}</span></tt>.</p>
|
||||
<p>See <tt class="docutils literal"><span class="pre">_specialKeys</span></tt> in the source code for a comprehensive list of
|
||||
control characters.</p>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-mouse"></a>
|
||||
<a class="mochidef reference" href="#fn-mouse">mouse()</a>:</p>
|
||||
<blockquote>
|
||||
<p>Properties for <tt class="docutils literal"><span class="pre">'onmouse*'</span></tt>, <tt class="docutils literal"><span class="pre">'onclick'</span></tt>, <tt class="docutils literal"><span class="pre">'ondblclick'</span></tt>, and
|
||||
<tt class="docutils literal"><span class="pre">'oncontextmenu'</span></tt>:</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">page</span></tt> is a <a class="mochiref reference" href="DOM.html#fn-coordinates">MochiKit.DOM.Coordinates</a> object that
|
||||
represents the cursor position relative to the HTML document.
|
||||
Equivalent to <tt class="docutils literal"><span class="pre">pageX</span></tt> and <tt class="docutils literal"><span class="pre">pageY</span></tt> in Safari, Mozilla, and
|
||||
Opera.</li>
|
||||
<li><tt class="docutils literal"><span class="pre">client</span></tt> is a <a class="mochiref reference" href="DOM.html#fn-coordinates">MochiKit.DOM.Coordinates</a> object that
|
||||
represents the cursor position relative to the visible portion of
|
||||
the HTML document. Equivalent to <tt class="docutils literal"><span class="pre">clientX</span></tt> and <tt class="docutils literal"><span class="pre">clientY</span></tt> on
|
||||
all browsers.</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>Properties for <tt class="docutils literal"><span class="pre">'onmouseup'</span></tt>, <tt class="docutils literal"><span class="pre">'onmousedown'</span></tt>, <tt class="docutils literal"><span class="pre">'onclick'</span></tt>, and
|
||||
<tt class="docutils literal"><span class="pre">'ondblclick'</span></tt>:</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">mouse().button</span></tt> returns <tt class="docutils literal"><span class="pre">{left,</span> <span class="pre">right,</span> <span class="pre">middle}</span></tt> where each
|
||||
property is <tt class="docutils literal"><span class="pre">true</span></tt> if the mouse button was pressed, <tt class="docutils literal"><span class="pre">false</span></tt>
|
||||
otherwise.</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>Known browser bugs:</p>
|
||||
<blockquote>
|
||||
<ul>
|
||||
<li><p class="first">Current versions of Safari won't signal <tt class="docutils literal"><span class="pre">'ondblclick'</span></tt> when
|
||||
attached via <tt class="docutils literal"><span class="pre">connect()</span></tt> (<a class="reference" href="http://bugzilla.opendarwin.org/show_bug.cgi?id=7790">Safari Bug 7790</a>).</p>
|
||||
</li>
|
||||
<li><p class="first">Mac browsers don't report right-click consistently. Firefox
|
||||
signals the slot and sets <tt class="docutils literal"><span class="pre">modifier().ctrl</span></tt> to true, Opera
|
||||
signals the slot and sets <tt class="docutils literal"><span class="pre">modifier().meta</span></tt> to <tt class="docutils literal"><span class="pre">true</span></tt>, and
|
||||
Safari doesn't signal the slot at all (<a class="reference" href="http://bugzilla.opendarwin.org/show_bug.cgi?id=6595">Safari Bug 6595</a>).</p>
|
||||
<p>To find a right-click in Safari, Firefox, and IE, you can connect
|
||||
an element to <tt class="docutils literal"><span class="pre">'oncontextmenu'</span></tt>. This doesn't work in Opera.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p>
|
||||
<a name="fn-relatedtarget"></a>
|
||||
<a class="mochidef reference" href="#fn-relatedtarget">relatedTarget()</a>:</p>
|
||||
<blockquote>
|
||||
Returns the document element that the mouse has moved to. This is
|
||||
generated for <tt class="docutils literal"><span class="pre">'onmouseover'</span></tt> and <tt class="docutils literal"><span class="pre">'onmouseout'</span></tt> events.</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Jonathan Gardner <<a class="reference" href="mailto:jgardner@jonathangardner.net">jgardner@jonathangardner.net</a>></li>
|
||||
<li>Beau Hartshorne <<a class="reference" href="mailto:beau@hartshornesoftware.com">beau@hartshornesoftware.com</a>></li>
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2006 Jonathan Gardner <<a class="reference" href="mailto:jgardner@jonathangardner.net">jgardner@jonathangardner.net</a>>, Beau
|
||||
Hartshorne <<a class="reference" href="mailto:beau@hartshornesoftware.com">beau@hartshornesoftware.com</a>>, and Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>.
|
||||
This program is dual-licensed free software; you can redistribute it and/or
|
||||
modify it under the terms of the <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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,264 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title></title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<p>2006-04-29 v1.3.1 (bug fix release)</p>
|
||||
<ul class="simple">
|
||||
<li>Fix sendXMLHttpRequest sendContent regression</li>
|
||||
<li>Internet Explorer fix in MochiKit.Logging (printfire exception)</li>
|
||||
<li>Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async</li>
|
||||
</ul>
|
||||
<p>2006-04-26 v1.3 "warp zone"</p>
|
||||
<ul class="simple">
|
||||
<li>IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)</li>
|
||||
<li>IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)</li>
|
||||
<li>New MochiKit.Base.method as a convenience form of bind that takes the
|
||||
object before the method</li>
|
||||
<li>New MochiKit.Base.flattenArguments for flattening a list of arguments to
|
||||
a single Array</li>
|
||||
<li>Refactored MochiRegExp example to use MochiKit.Signal</li>
|
||||
<li>New key_events example demonstrating use of MochiKit.Signal's key handling
|
||||
capabilities.</li>
|
||||
<li>MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
|
||||
null is used and the string will be considered the first node. This
|
||||
allows for the more natural P("foo") rather than P(null, "foo").</li>
|
||||
<li>MochiKit Interpreter example refactored to use MochiKit.Signal and now
|
||||
provides multi-line input and a help() function to get MochiKit function
|
||||
signature from the documentation.</li>
|
||||
<li>Native Console Logging for the default MochiKit.Logging logger</li>
|
||||
<li>New MochiKit.Async.DeferredList, gatherResults, maybeDeferred</li>
|
||||
<li>New MochiKit.Signal example: draggable</li>
|
||||
<li>Added sanity checking to Deferred to ensure that errors happen when chaining
|
||||
is used incorrectly</li>
|
||||
<li>Opera sendXMLHttpRequest fix (sends empty string instead of null by default)</li>
|
||||
<li>Fix a bug in MochiKit.Color that incorrectly generated hex colors for
|
||||
component values smaller than 16/255.</li>
|
||||
<li>Fix a bug in MochiKit.Logging that prevented logs from being capped at a
|
||||
maximum size</li>
|
||||
<li>MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
|
||||
Error, so that the errback chain is used instead of the callback chain.</li>
|
||||
<li>MochiKit.DOM.appendChildNodes and associated functions now append iterables
|
||||
in the correct order.</li>
|
||||
<li>New MochiKit-based SimpleTest test runner as a replacement for Test.Simple</li>
|
||||
<li>MochiKit.Base.isNull no longer matches undefined</li>
|
||||
<li>example doctypes changed to HTML4</li>
|
||||
<li>isDateLike no longer throws error on null</li>
|
||||
<li>New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt</li>
|
||||
<li>updated elementDimensions to calculate width from offsetWidth instead
|
||||
of clientWidth</li>
|
||||
<li>formContents now works with FORM tags that have a name attribute</li>
|
||||
<li>Documentation now uses MochiKit to generate a function index</li>
|
||||
</ul>
|
||||
<p>2006-01-26 v1.2 "the ocho"</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed MochiKit.Color.Color.lighterColorWithLevel</li>
|
||||
<li>Added new MochiKit.Base.findIdentical function to find the index of an
|
||||
element in an Array-like object. Uses === for identity comparison.</li>
|
||||
<li>Added new MochiKit.Base.find function to find the index of an element in
|
||||
an Array-like object. Uses compare for rich comparison.</li>
|
||||
<li>MochiKit.Base.bind will accept a string for func, which will be immediately
|
||||
looked up as self[func].</li>
|
||||
<li>MochiKit.DOM.formContents no longer skips empty form elements for Zope
|
||||
compatibility</li>
|
||||
<li>MochiKit.Iter.forEach will now catch StopIteration to break</li>
|
||||
<li>New MochiKit.DOM.elementDimensions(element) for determining the width and
|
||||
height of an element in the document</li>
|
||||
<li>MochiKit.DOM's initialization is now compatible with
|
||||
HTMLUnit + JWebUnit + Rhino</li>
|
||||
<li>MochiKit.LoggingPane will now re-use a <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> DIV element
|
||||
currently in the document instead of always creating one.</li>
|
||||
<li>MochiKit.Base now has operator.mul</li>
|
||||
<li>MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
|
||||
a custom value attribute</li>
|
||||
<li>Added new MochiKit.Color constructors fromComputedStyle and fromText</li>
|
||||
<li>MochiKit.DOM.setNodeAttribute should work now</li>
|
||||
<li>MochiKit.DOM now has a workaround for an IE bug when setting the style
|
||||
property to a string</li>
|
||||
<li>MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
|
||||
name and for properties</li>
|
||||
<li>MochiKit.DOM.scrapeText now walks the DOM tree in-order</li>
|
||||
<li>MochiKit.LoggingPane now sanitizes the window name to work around IE bug</li>
|
||||
<li>MochiKit.DOM now translates usemap to useMap to work around IE bug</li>
|
||||
<li>MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks</li>
|
||||
<li>Added new MochiKit.DOM documentation on element visibility</li>
|
||||
<li>New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
|
||||
for determining the position of an element in the document</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG</li>
|
||||
</ul>
|
||||
<p>2005-11-14 v1.1</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed a bug in numberFormatter with large numbers</li>
|
||||
<li>Massively overhauled documentation</li>
|
||||
<li>Fast-path for primitives in MochiKit.Base.compare</li>
|
||||
<li>New groupby and groupby_as_array in MochiKit.Iter</li>
|
||||
<li>Added iterator factory adapter for objects that implement iterateNext()</li>
|
||||
<li>Fixed isoTimestamp to handle timestamps with time zone correctly</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
|
||||
LEGEND, FIELDSET</li>
|
||||
<li>New MochiKit.DOM formContents and enhancement to queryString to support it</li>
|
||||
<li>Updated view_source example to use dp.SyntaxHighlighter 1.3.0</li>
|
||||
<li>MochiKit.LoggingPane now uses named windows based on the URL so that
|
||||
a given URL will get the same LoggingPane window after a reload
|
||||
(at the same position, etc.)</li>
|
||||
<li>MochiKit.DOM now has currentWindow() and currentDocument() context
|
||||
variables that are set with withWindow() and withDocument(). These
|
||||
context variables affect all MochiKit.DOM functionality (getElement,
|
||||
createDOM, etc.)</li>
|
||||
<li>MochiKit.Base.items will now catch and ignore exceptions for properties
|
||||
that are enumerable but not accessible (e.g. permission denied)</li>
|
||||
<li>MochiKit.Async.Deferred's addCallback/addErrback/addBoth
|
||||
now accept additional arguments that are used to create a partially
|
||||
applied function. This differs from Twisted in that the callback/errback
|
||||
result becomes the <em>last</em> argument, not the first when this feature
|
||||
is used.</li>
|
||||
<li>MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
|
||||
arguments which are used to create a GET query string</li>
|
||||
<li>Did some refactoring to reduce the footprint of MochiKit by a few
|
||||
kilobytes</li>
|
||||
<li>escapeHTML to longer escapes ' (apos) and now uses
|
||||
String.replace instead of iterating over every char.</li>
|
||||
<li>Added DeferredLock to Async</li>
|
||||
<li>Renamed getElementsComputedStyle to computedStyle and moved
|
||||
it from MochiKit.Visual to MochiKit.DOM</li>
|
||||
<li>Moved all color support out of MochiKit.Visual and into MochiKit.Color</li>
|
||||
<li>Fixed range() to accept a negative step</li>
|
||||
<li>New alias to MochiKit.swapDOM called removeElement</li>
|
||||
<li>New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
|
||||
an attribute on a node without raising, roughly equivalent to:
|
||||
updateNodeAttributes(node, {attr: value})</li>
|
||||
<li>New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
|
||||
a node's attribute or returns null without raising</li>
|
||||
<li>Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
|
||||
directly (addLoadEvent did not leak, since it clears the handler)</li>
|
||||
</ul>
|
||||
<p>2005-10-24 v1.0</p>
|
||||
<ul class="simple">
|
||||
<li>New interpreter example that shows usage of MochiKit.DOM to make
|
||||
an interactive JavaScript interpreter</li>
|
||||
<li>New MochiKit.LoggingPane for use with the MochiKit.Logging
|
||||
debuggingBookmarklet, with logging_pane example to show its usage</li>
|
||||
<li>New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
|
||||
in order to provide a live regular expression matching tool</li>
|
||||
<li>Added advanced number formatting capabilities to MochiKit.Format:
|
||||
numberFormatter(pattern, placeholder="", locale="default") and
|
||||
formatLocale(locale="default")</li>
|
||||
<li>Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
|
||||
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE</li>
|
||||
<li>Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
|
||||
to MochiKit.Format</li>
|
||||
<li>MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
|
||||
isoTimestamp(isoString) will convert them to Date objects, and
|
||||
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC</li>
|
||||
<li>Fixed missing errback for sendXMLHttpRequest when the server does not
|
||||
respond</li>
|
||||
<li>Fixed infinite recusion bug when using roundClass("DIV", ...)</li>
|
||||
<li>Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
|
||||
from being cancelled properly</li>
|
||||
<li>Workaround in MochiKit.Base bind (and partial) for functions that don't
|
||||
have an apply method, such as alert</li>
|
||||
<li>Reliably return null from the string parsing/manipulation functions if
|
||||
the input can't be coerced to a string (s + "") or the input makes no sense;
|
||||
e.g. isoTimestamp(null) and isoTimestamp("") return null</li>
|
||||
</ul>
|
||||
<p>2005-10-08 v0.90</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed ISO compliance with toISODate</li>
|
||||
<li>Added missing operator.sub</li>
|
||||
<li>Placated Mozilla's strict warnings a bit</li>
|
||||
<li>Added JSON serialization and unserialization support to MochiKit.Base:
|
||||
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
|
||||
API.</li>
|
||||
<li>Fixed a bug in the script loader that failed in some scenarios when a script
|
||||
tag did not have a "src" attribute (thanks Ian!)</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
|
||||
P, FORM</li>
|
||||
<li>Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
|
||||
and parseQueryString, when available.</li>
|
||||
</ul>
|
||||
<p>2005-08-12 v0.80</p>
|
||||
<ul class="simple">
|
||||
<li>Source highlighting in all examples, moved to a view-source example</li>
|
||||
<li>Added some experimental syntax highlighting for the Rounded Corners example,
|
||||
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib</li>
|
||||
<li>Use an indirect binding for the logger conveniences, so that the global
|
||||
logger could be replaced by setting MochiKit.Logger.logger to something else
|
||||
(though an observer is probably a better choice).</li>
|
||||
<li>Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
|
||||
which will be looked up with getElement</li>
|
||||
<li>Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
|
||||
node.parentNode)</li>
|
||||
<li>Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success</li>
|
||||
<li>Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues</li>
|
||||
<li>Possible workaround for Safari issue with swapDOM, where it would get
|
||||
confused because two elements were in the DOM at the same time with the
|
||||
same id</li>
|
||||
<li>Added missing THEAD convenience function to MochiKit.DOM</li>
|
||||
<li>Added lstrip, rstrip, strip to MochiKit.Format</li>
|
||||
<li>Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
|
||||
MochiKit.DOM</li>
|
||||
<li>MochiKit.Iter.iextend now has a fast-path for array-like objects</li>
|
||||
<li>Added HSV color space support to MochiKit.Visual</li>
|
||||
<li>Fixed a bug in the sortable_tables example, it now converts types
|
||||
correctly</li>
|
||||
<li>Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
|
||||
scope</li>
|
||||
</ul>
|
||||
<p>2005-08-04 v0.70</p>
|
||||
<ul class="simple">
|
||||
<li>New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
|
||||
a little TAL-ish DOM templating attribute language.</li>
|
||||
<li>sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
|
||||
ignore requests with status == 0, which seems to happen for cached or local
|
||||
requests</li>
|
||||
<li>Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.</li>
|
||||
<li>Changed scrapeText API to return a string by default. This is API-breaking!
|
||||
It was dumb to have the default return value be the form you almost never
|
||||
want. Sorry.</li>
|
||||
<li>Added special form to swapDOM(dest, src). If src is null, dest is removed
|
||||
(where previously you'd likely get a DOM exception).</li>
|
||||
<li>Added three new functions to MochiKit.Base for dealing with URL query
|
||||
strings: urlEncode, queryString, parseQueryString</li>
|
||||
<li>MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
|
||||
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
|
||||
new Function(v).</li>
|
||||
<li>Another workaround for Internet "worst browser ever" Explorer's setAttribute
|
||||
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).</li>
|
||||
<li>Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM</li>
|
||||
<li>Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
|
||||
now!</li>
|
||||
</ul>
|
||||
<p>2005-07-29 v0.60</p>
|
||||
<ul class="simple">
|
||||
<li>Beefed up the MochiKit.DOM test suite</li>
|
||||
<li>Fixed return value for MochiKit.DOM.swapElementClass, could return
|
||||
false unexpectedly before</li>
|
||||
<li>Added an optional "parent" argument to
|
||||
MochiKit.DOM.getElementsByTagAndClassName</li>
|
||||
<li>Added a "packed" version in packed/lib/MochiKit/MochiKit.js</li>
|
||||
<li>Changed build script to rewrite the URLs in tests to account for the
|
||||
JSAN-required reorganization</li>
|
||||
<li>MochiKit.Compat to potentially work around IE 5.5 issues
|
||||
(5.0 still not supported). Test.Simple doesn't seem to work there,
|
||||
though.</li>
|
||||
<li>Several minor documentation corrections</li>
|
||||
</ul>
|
||||
<p>2005-07-27 v0.50</p>
|
||||
<ul class="simple">
|
||||
<li>Initial Release</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,162 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit.Visual - visual effects</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="name" name="name">Name</a></h1>
|
||||
<p>MochiKit.Visual - visual effects</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
|
||||
<pre class="literal-block">
|
||||
// round the corners of all h1 elements
|
||||
roundClass("h1", null);
|
||||
|
||||
// round the top left corner of the element with the id "title"
|
||||
roundElement("title", {corners: "tl"});
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="description" name="description">Description</a></h1>
|
||||
<p>MochiKit.Visual provides visual effects and support functions for visuals.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
|
||||
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a></li>
|
||||
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a></li>
|
||||
<li><a class="mochiref reference" href="Color.html">MochiKit.Color</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="overview" name="overview">Overview</a></h1>
|
||||
<p>At this time, MochiKit.Visual provides one visual effect: rounded corners
|
||||
for your HTML elements. These rounded corners are created completely
|
||||
through CSS manipulations and require no external images or style sheets.
|
||||
This implementation was adapted from <a class="reference" href="http://www.openrico.org">Rico</a>.</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
|
||||
<div class="section">
|
||||
<h2><a id="functions" name="functions">Functions</a></h2>
|
||||
<p>
|
||||
<a name="fn-roundclass"></a>
|
||||
<a class="mochidef reference" href="#fn-roundclass">roundClass(tagName[, className[, options]])</a>:</p>
|
||||
<blockquote>
|
||||
Rounds all of the elements that match the <tt class="docutils literal"><span class="pre">tagName</span></tt> and <tt class="docutils literal"><span class="pre">className</span></tt>
|
||||
specifiers, using the options provided. <tt class="docutils literal"><span class="pre">tagName</span></tt> or <tt class="docutils literal"><span class="pre">className</span></tt> can
|
||||
be <tt class="docutils literal"><span class="pre">null</span></tt> to match all tags or classes. For more information about
|
||||
the options, see the <a class="mochiref reference" href="#fn-roundelement">roundElement</a> function.</blockquote>
|
||||
<p>
|
||||
<a name="fn-roundelement"></a>
|
||||
<a class="mochidef reference" href="#fn-roundelement">roundElement(element[, options])</a>:</p>
|
||||
<blockquote>
|
||||
<p>Immediately round the corners of the specified element.
|
||||
The element can be given as either a string
|
||||
with the element ID, or as an element object.</p>
|
||||
<p>The options mapping has the following defaults:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="35%" />
|
||||
<col width="65%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td>corners</td>
|
||||
<td><tt class="docutils literal"><span class="pre">"all"</span></tt></td>
|
||||
</tr>
|
||||
<tr><td>color</td>
|
||||
<td><tt class="docutils literal"><span class="pre">"fromElement"</span></tt></td>
|
||||
</tr>
|
||||
<tr><td>bgColor</td>
|
||||
<td><tt class="docutils literal"><span class="pre">"fromParent"</span></tt></td>
|
||||
</tr>
|
||||
<tr><td>blend</td>
|
||||
<td><tt class="docutils literal"><span class="pre">true</span></tt></td>
|
||||
</tr>
|
||||
<tr><td>border</td>
|
||||
<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
|
||||
</tr>
|
||||
<tr><td>compact</td>
|
||||
<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>corners:</p>
|
||||
<blockquote>
|
||||
<p>specifies which corners of the element should be rounded.
|
||||
Choices are:</p>
|
||||
<ul class="simple">
|
||||
<li>all</li>
|
||||
<li>top</li>
|
||||
<li>bottom</li>
|
||||
<li>tl (top left)</li>
|
||||
<li>bl (bottom left)</li>
|
||||
<li>tr (top right)</li>
|
||||
<li>br (bottom right)</li>
|
||||
</ul>
|
||||
<dl class="docutils">
|
||||
<dt>Example:</dt>
|
||||
<dd><tt class="docutils literal"><span class="pre">"tl</span> <span class="pre">br"</span></tt>: top-left and bottom-right corners are rounded</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<dl class="docutils">
|
||||
<dt>blend:</dt>
|
||||
<dd>specifies whether the color and background color should be blended
|
||||
together to produce the border color.</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<table class="docutils footnote" frame="void" id="id1" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id1">[1]</a></td><td>Application Kit Reference - NSColor: <a class="reference" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html">http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id2" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id2">[2]</a></td><td>SVG 1.0 color keywords: <a class="reference" href="http://www.w3.org/TR/SVG/types.html#ColorKeywords">http://www.w3.org/TR/SVG/types.html#ColorKeywords</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="docutils footnote" frame="void" id="id3" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a name="id3">[3]</a></td><td>W3C CSS3 Color Module: <a class="reference" href="http://www.w3.org/TR/css3-color/#svg-color">http://www.w3.org/TR/css3-color/#svg-color</a></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="authors" name="authors">Authors</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Kevin Dangoor <<a class="reference" href="mailto:dangoor@gmail.com">dangoor@gmail.com</a>></li>
|
||||
<li>Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>></li>
|
||||
<li>Originally adapted from Rico <<a class="reference" href="http://openrico.org/">http://openrico.org/</a>> (though little remains)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
<p>Portions adapted from <a class="reference" href="http://www.openrico.org">Rico</a> are available under the terms of the
|
||||
<a class="reference" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2.0</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,319 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
|
||||
<title>MochiKit Documentation Index</title>
|
||||
|
||||
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
|
||||
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="../../js/toc.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document">
|
||||
<div class="section">
|
||||
<h1><a id="distribution" name="distribution">Distribution</a></h1>
|
||||
<p>MochiKit - makes JavaScript suck a bit less</p>
|
||||
<ul class="simple">
|
||||
<li><a class="mochiref reference" href="Async.html">MochiKit.Async</a> - manage asynchronous tasks</li>
|
||||
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a> - functional programming and useful comparisons</li>
|
||||
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a> - painless DOM manipulation API</li>
|
||||
<li><a class="mochiref reference" href="Color.html">MochiKit.Color</a> - color abstraction with CSS3 support</li>
|
||||
<li><a class="mochiref reference" href="DateTime.html">MochiKit.DateTime</a> - "what time is it anyway?"</li>
|
||||
<li><a class="mochiref reference" href="Format.html">MochiKit.Format</a> - string formatting goes here</li>
|
||||
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a> - itertools for JavaScript; iteration made HARD,
|
||||
and then easy</li>
|
||||
<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>
|
||||
<li><a class="mochiref reference" href="LoggingPane.html">MochiKit.LoggingPane</a> - interactive <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a>
|
||||
pane</li>
|
||||
<li><a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> - simple universal event handling</li>
|
||||
<li><a class="mochiref reference" href="Visual.html">MochiKit.Visual</a> - visual effects</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="notes" name="notes">Notes</a></h1>
|
||||
<p>To turn on MochiKit's compatibility mode, do this before loading MochiKit:</p>
|
||||
<pre class="literal-block">
|
||||
<script type="text/javascript">MochiKit = {__compat__: true};</script>
|
||||
</pre>
|
||||
<p>When compatibility mode is on, you must use fully qualified names for all
|
||||
MochiKit functions (e.g. <tt class="docutils literal"><span class="pre">MochiKit.Base.map(...)</span></tt>).</p>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="screencasts" name="screencasts">Screencasts</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference" href="http://mochikit.com/screencasts/MochiKit_Intro-1">MochiKit 1.1 Intro</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="see-also" name="see-also">See Also</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference" href="http://groups.google.com/group/mochikit">Google Groups: MochiKit</a>: The official mailing list for discussions
|
||||
related to development of and with MochiKit</li>
|
||||
<li><a class="reference" href="http://mochikit.com/">mochikit.com</a>: MochiKit's home on the web</li>
|
||||
<li><a class="reference" href="http://bob.pythonmac.org/">from __future__ import *</a>: Bob Ippolito's blog</li>
|
||||
<li><a class="reference" href="http://openjsan.org/doc/b/bo/bob/lib/MochiKit/">MochiKit on JSAN</a>: the JSAN distribution page for MochiKit</li>
|
||||
<li><a class="reference" href="http://del.icio.us/tag/mochikit">MochiKit tag on del.icio.us</a>: Recent bookmarks related to MochiKit</li>
|
||||
<li><a class="reference" href="http://technorati.com/tag/mochikit">MochiKit tag on Technorati</a>: Recent blog entries related to MochiKit</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="version-history" name="version-history">Version History</a></h1>
|
||||
<p>2006-04-29 v1.3.1 (bug fix release)</p>
|
||||
<ul class="simple">
|
||||
<li>Fix sendXMLHttpRequest sendContent regression</li>
|
||||
<li>Internet Explorer fix in MochiKit.Logging (printfire exception)</li>
|
||||
<li>Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async</li>
|
||||
</ul>
|
||||
<p>2006-04-26 v1.3 "warp zone"</p>
|
||||
<ul class="simple">
|
||||
<li>IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)</li>
|
||||
<li>IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)</li>
|
||||
<li>New MochiKit.Base.method as a convenience form of bind that takes the
|
||||
object before the method</li>
|
||||
<li>New MochiKit.Base.flattenArguments for flattening a list of arguments to
|
||||
a single Array</li>
|
||||
<li>Refactored MochiRegExp example to use MochiKit.Signal</li>
|
||||
<li>New key_events example demonstrating use of MochiKit.Signal's key handling
|
||||
capabilities.</li>
|
||||
<li>MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
|
||||
null is used and the string will be considered the first node. This
|
||||
allows for the more natural P("foo") rather than P(null, "foo").</li>
|
||||
<li>MochiKit Interpreter example refactored to use MochiKit.Signal and now
|
||||
provides multi-line input and a help() function to get MochiKit function
|
||||
signature from the documentation.</li>
|
||||
<li>Native Console Logging for the default MochiKit.Logging logger</li>
|
||||
<li>New MochiKit.Async.DeferredList, gatherResults, maybeDeferred</li>
|
||||
<li>New MochiKit.Signal example: draggable</li>
|
||||
<li>Added sanity checking to Deferred to ensure that errors happen when chaining
|
||||
is used incorrectly</li>
|
||||
<li>Opera sendXMLHttpRequest fix (sends empty string instead of null by default)</li>
|
||||
<li>Fix a bug in MochiKit.Color that incorrectly generated hex colors for
|
||||
component values smaller than 16/255.</li>
|
||||
<li>Fix a bug in MochiKit.Logging that prevented logs from being capped at a
|
||||
maximum size</li>
|
||||
<li>MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
|
||||
Error, so that the errback chain is used instead of the callback chain.</li>
|
||||
<li>MochiKit.DOM.appendChildNodes and associated functions now append iterables
|
||||
in the correct order.</li>
|
||||
<li>New MochiKit-based SimpleTest test runner as a replacement for Test.Simple</li>
|
||||
<li>MochiKit.Base.isNull no longer matches undefined</li>
|
||||
<li>example doctypes changed to HTML4</li>
|
||||
<li>isDateLike no longer throws error on null</li>
|
||||
<li>New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt</li>
|
||||
<li>updated elementDimensions to calculate width from offsetWidth instead
|
||||
of clientWidth</li>
|
||||
<li>formContents now works with FORM tags that have a name attribute</li>
|
||||
<li>Documentation now uses MochiKit to generate a function index</li>
|
||||
</ul>
|
||||
<p>2006-01-26 v1.2 "the ocho"</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed MochiKit.Color.Color.lighterColorWithLevel</li>
|
||||
<li>Added new MochiKit.Base.findIdentical function to find the index of an
|
||||
element in an Array-like object. Uses === for identity comparison.</li>
|
||||
<li>Added new MochiKit.Base.find function to find the index of an element in
|
||||
an Array-like object. Uses compare for rich comparison.</li>
|
||||
<li>MochiKit.Base.bind will accept a string for func, which will be immediately
|
||||
looked up as self[func].</li>
|
||||
<li>MochiKit.DOM.formContents no longer skips empty form elements for Zope
|
||||
compatibility</li>
|
||||
<li>MochiKit.Iter.forEach will now catch StopIteration to break</li>
|
||||
<li>New MochiKit.DOM.elementDimensions(element) for determining the width and
|
||||
height of an element in the document</li>
|
||||
<li>MochiKit.DOM's initialization is now compatible with
|
||||
HTMLUnit + JWebUnit + Rhino</li>
|
||||
<li>MochiKit.LoggingPane will now re-use a <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> DIV element
|
||||
currently in the document instead of always creating one.</li>
|
||||
<li>MochiKit.Base now has operator.mul</li>
|
||||
<li>MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
|
||||
a custom value attribute</li>
|
||||
<li>Added new MochiKit.Color constructors fromComputedStyle and fromText</li>
|
||||
<li>MochiKit.DOM.setNodeAttribute should work now</li>
|
||||
<li>MochiKit.DOM now has a workaround for an IE bug when setting the style
|
||||
property to a string</li>
|
||||
<li>MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
|
||||
name and for properties</li>
|
||||
<li>MochiKit.DOM.scrapeText now walks the DOM tree in-order</li>
|
||||
<li>MochiKit.LoggingPane now sanitizes the window name to work around IE bug</li>
|
||||
<li>MochiKit.DOM now translates usemap to useMap to work around IE bug</li>
|
||||
<li>MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks</li>
|
||||
<li>Added new MochiKit.DOM documentation on element visibility</li>
|
||||
<li>New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
|
||||
for determining the position of an element in the document</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG</li>
|
||||
</ul>
|
||||
<p>2005-11-14 v1.1</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed a bug in numberFormatter with large numbers</li>
|
||||
<li>Massively overhauled documentation</li>
|
||||
<li>Fast-path for primitives in MochiKit.Base.compare</li>
|
||||
<li>New groupby and groupby_as_array in MochiKit.Iter</li>
|
||||
<li>Added iterator factory adapter for objects that implement iterateNext()</li>
|
||||
<li>Fixed isoTimestamp to handle timestamps with time zone correctly</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
|
||||
LEGEND, FIELDSET</li>
|
||||
<li>New MochiKit.DOM formContents and enhancement to queryString to support it</li>
|
||||
<li>Updated view_source example to use dp.SyntaxHighlighter 1.3.0</li>
|
||||
<li>MochiKit.LoggingPane now uses named windows based on the URL so that
|
||||
a given URL will get the same LoggingPane window after a reload
|
||||
(at the same position, etc.)</li>
|
||||
<li>MochiKit.DOM now has currentWindow() and currentDocument() context
|
||||
variables that are set with withWindow() and withDocument(). These
|
||||
context variables affect all MochiKit.DOM functionality (getElement,
|
||||
createDOM, etc.)</li>
|
||||
<li>MochiKit.Base.items will now catch and ignore exceptions for properties
|
||||
that are enumerable but not accessible (e.g. permission denied)</li>
|
||||
<li>MochiKit.Async.Deferred's addCallback/addErrback/addBoth
|
||||
now accept additional arguments that are used to create a partially
|
||||
applied function. This differs from Twisted in that the callback/errback
|
||||
result becomes the <em>last</em> argument, not the first when this feature
|
||||
is used.</li>
|
||||
<li>MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
|
||||
arguments which are used to create a GET query string</li>
|
||||
<li>Did some refactoring to reduce the footprint of MochiKit by a few
|
||||
kilobytes</li>
|
||||
<li>escapeHTML to longer escapes ' (apos) and now uses
|
||||
String.replace instead of iterating over every char.</li>
|
||||
<li>Added DeferredLock to Async</li>
|
||||
<li>Renamed getElementsComputedStyle to computedStyle and moved
|
||||
it from MochiKit.Visual to MochiKit.DOM</li>
|
||||
<li>Moved all color support out of MochiKit.Visual and into MochiKit.Color</li>
|
||||
<li>Fixed range() to accept a negative step</li>
|
||||
<li>New alias to MochiKit.swapDOM called removeElement</li>
|
||||
<li>New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
|
||||
an attribute on a node without raising, roughly equivalent to:
|
||||
updateNodeAttributes(node, {attr: value})</li>
|
||||
<li>New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
|
||||
a node's attribute or returns null without raising</li>
|
||||
<li>Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
|
||||
directly (addLoadEvent did not leak, since it clears the handler)</li>
|
||||
</ul>
|
||||
<p>2005-10-24 v1.0</p>
|
||||
<ul class="simple">
|
||||
<li>New interpreter example that shows usage of MochiKit.DOM to make
|
||||
an interactive JavaScript interpreter</li>
|
||||
<li>New MochiKit.LoggingPane for use with the MochiKit.Logging
|
||||
debuggingBookmarklet, with logging_pane example to show its usage</li>
|
||||
<li>New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
|
||||
in order to provide a live regular expression matching tool</li>
|
||||
<li>Added advanced number formatting capabilities to MochiKit.Format:
|
||||
numberFormatter(pattern, placeholder="", locale="default") and
|
||||
formatLocale(locale="default")</li>
|
||||
<li>Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
|
||||
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE</li>
|
||||
<li>Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
|
||||
to MochiKit.Format</li>
|
||||
<li>MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
|
||||
isoTimestamp(isoString) will convert them to Date objects, and
|
||||
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC</li>
|
||||
<li>Fixed missing errback for sendXMLHttpRequest when the server does not
|
||||
respond</li>
|
||||
<li>Fixed infinite recusion bug when using roundClass("DIV", ...)</li>
|
||||
<li>Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
|
||||
from being cancelled properly</li>
|
||||
<li>Workaround in MochiKit.Base bind (and partial) for functions that don't
|
||||
have an apply method, such as alert</li>
|
||||
<li>Reliably return null from the string parsing/manipulation functions if
|
||||
the input can't be coerced to a string (s + "") or the input makes no sense;
|
||||
e.g. isoTimestamp(null) and isoTimestamp("") return null</li>
|
||||
</ul>
|
||||
<p>2005-10-08 v0.90</p>
|
||||
<ul class="simple">
|
||||
<li>Fixed ISO compliance with toISODate</li>
|
||||
<li>Added missing operator.sub</li>
|
||||
<li>Placated Mozilla's strict warnings a bit</li>
|
||||
<li>Added JSON serialization and unserialization support to MochiKit.Base:
|
||||
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
|
||||
API.</li>
|
||||
<li>Fixed a bug in the script loader that failed in some scenarios when a script
|
||||
tag did not have a "src" attribute (thanks Ian!)</li>
|
||||
<li>Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
|
||||
P, FORM</li>
|
||||
<li>Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
|
||||
and parseQueryString, when available.</li>
|
||||
</ul>
|
||||
<p>2005-08-12 v0.80</p>
|
||||
<ul class="simple">
|
||||
<li>Source highlighting in all examples, moved to a view-source example</li>
|
||||
<li>Added some experimental syntax highlighting for the Rounded Corners example,
|
||||
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib</li>
|
||||
<li>Use an indirect binding for the logger conveniences, so that the global
|
||||
logger could be replaced by setting MochiKit.Logger.logger to something else
|
||||
(though an observer is probably a better choice).</li>
|
||||
<li>Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
|
||||
which will be looked up with getElement</li>
|
||||
<li>Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
|
||||
node.parentNode)</li>
|
||||
<li>Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success</li>
|
||||
<li>Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues</li>
|
||||
<li>Possible workaround for Safari issue with swapDOM, where it would get
|
||||
confused because two elements were in the DOM at the same time with the
|
||||
same id</li>
|
||||
<li>Added missing THEAD convenience function to MochiKit.DOM</li>
|
||||
<li>Added lstrip, rstrip, strip to MochiKit.Format</li>
|
||||
<li>Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
|
||||
MochiKit.DOM</li>
|
||||
<li>MochiKit.Iter.iextend now has a fast-path for array-like objects</li>
|
||||
<li>Added HSV color space support to MochiKit.Visual</li>
|
||||
<li>Fixed a bug in the sortable_tables example, it now converts types
|
||||
correctly</li>
|
||||
<li>Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
|
||||
scope</li>
|
||||
</ul>
|
||||
<p>2005-08-04 v0.70</p>
|
||||
<ul class="simple">
|
||||
<li>New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
|
||||
a little TAL-ish DOM templating attribute language.</li>
|
||||
<li>sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
|
||||
ignore requests with status == 0, which seems to happen for cached or local
|
||||
requests</li>
|
||||
<li>Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.</li>
|
||||
<li>Changed scrapeText API to return a string by default. This is API-breaking!
|
||||
It was dumb to have the default return value be the form you almost never
|
||||
want. Sorry.</li>
|
||||
<li>Added special form to swapDOM(dest, src). If src is null, dest is removed
|
||||
(where previously you'd likely get a DOM exception).</li>
|
||||
<li>Added three new functions to MochiKit.Base for dealing with URL query
|
||||
strings: urlEncode, queryString, parseQueryString</li>
|
||||
<li>MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
|
||||
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
|
||||
new Function(v).</li>
|
||||
<li>Another workaround for Internet "worst browser ever" Explorer's setAttribute
|
||||
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).</li>
|
||||
<li>Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM</li>
|
||||
<li>Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
|
||||
now!</li>
|
||||
</ul>
|
||||
<p>2005-07-29 v0.60</p>
|
||||
<ul class="simple">
|
||||
<li>Beefed up the MochiKit.DOM test suite</li>
|
||||
<li>Fixed return value for MochiKit.DOM.swapElementClass, could return
|
||||
false unexpectedly before</li>
|
||||
<li>Added an optional "parent" argument to
|
||||
MochiKit.DOM.getElementsByTagAndClassName</li>
|
||||
<li>Added a "packed" version in packed/lib/MochiKit/MochiKit.js</li>
|
||||
<li>Changed build script to rewrite the URLs in tests to account for the
|
||||
JSAN-required reorganization</li>
|
||||
<li>MochiKit.Compat to potentially work around IE 5.5 issues
|
||||
(5.0 still not supported). Test.Simple doesn't seem to work there,
|
||||
though.</li>
|
||||
<li>Several minor documentation corrections</li>
|
||||
</ul>
|
||||
<p>2005-07-27 v0.50</p>
|
||||
<ul class="simple">
|
||||
<li>Initial Release</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section">
|
||||
<h1><a id="copyright" name="copyright">Copyright</a></h1>
|
||||
<p>Copyright 2005 Bob Ippolito <<a class="reference" href="mailto:bob@redivi.com">bob@redivi.com</a>>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,89 @@
|
||||
function function_ref(fn) {
|
||||
return A({"href": fn[1], "class": "mochiref reference"}, fn[0], BR());
|
||||
};
|
||||
|
||||
function toggle_docs() {
|
||||
toggleElementClass("invisible", "show_index", "function_index");
|
||||
return false;
|
||||
};
|
||||
|
||||
function create_toc() {
|
||||
if (getElement("distribution")) {
|
||||
return global_index();
|
||||
}
|
||||
if (getElement("api-reference")) {
|
||||
return module_index();
|
||||
}
|
||||
};
|
||||
|
||||
function doXHTMLRequest(url) {
|
||||
var req = getXMLHttpRequest();
|
||||
if (req.overrideMimeType) {
|
||||
req.overrideMimeType("text/xml");
|
||||
}
|
||||
req.open("GET", url, true);
|
||||
return sendXMLHttpRequest(req).addCallback(function (res) {
|
||||
return res.responseXML.documentElement;
|
||||
});
|
||||
};
|
||||
|
||||
function load_request(href, div, doc) {
|
||||
var functions = withDocument(doc, spider_doc);
|
||||
forEach(functions, function (func) {
|
||||
// fix anchors
|
||||
if (func[1].charAt(0) == "#") {
|
||||
func[1] = href + func[1];
|
||||
}
|
||||
});
|
||||
var showLink = A({"class": "force-pointer"}, "[+]");
|
||||
var hideLink = A({"class": "force-pointer"}, "[\u2013]");
|
||||
var functionIndex = DIV({"id": "function_index", "class": "invisible"},
|
||||
hideLink,
|
||||
P(null, map(function_ref, functions))
|
||||
);
|
||||
var toggleFunc = function (e) {
|
||||
toggleElementClass("invisible", showLink, functionIndex);
|
||||
};
|
||||
connect(showLink, "onclick", toggleFunc);
|
||||
connect(hideLink, "onclick", toggleFunc);
|
||||
replaceChildNodes(div,
|
||||
showLink,
|
||||
functionIndex
|
||||
);
|
||||
};
|
||||
|
||||
function global_index() {
|
||||
var distList = getElementsByTagAndClassName("ul")[0];
|
||||
var bullets = getElementsByTagAndClassName("li", null, distList);
|
||||
for (var i = 0; i < bullets.length; i++) {
|
||||
var tag = bullets[i];
|
||||
var firstLink = getElementsByTagAndClassName("a", "mochiref", tag)[0];
|
||||
var href = getNodeAttribute(firstLink, "href");
|
||||
var div = DIV(null, "[\u2026]");
|
||||
appendChildNodes(tag, BR(), div);
|
||||
var d = doXHTMLRequest(href).addCallback(load_request, href, div);
|
||||
}
|
||||
};
|
||||
|
||||
function spider_doc() {
|
||||
return map(
|
||||
function (tag) {
|
||||
return [scrapeText(tag), getNodeAttribute(tag, "href")];
|
||||
},
|
||||
getElementsByTagAndClassName("a", "mochidef")
|
||||
);
|
||||
};
|
||||
|
||||
function module_index() {
|
||||
var sections = getElementsByTagAndClassName("div", "section");
|
||||
var ptr = sections[1];
|
||||
var ref = DIV({"class": "section"},
|
||||
H1(null, "Function Index"),
|
||||
A({"id": "show_index", "href": "#", "onclick": toggle_docs}, "[show]"),
|
||||
DIV({"id": "function_index", "class": "invisible"},
|
||||
A({"href":"#", "onclick": toggle_docs}, "[hide]"),
|
||||
P(null, map(function_ref, spider_doc()))));
|
||||
ptr.parentNode.insertBefore(ref, ptr);
|
||||
};
|
||||
|
||||
addLoadEvent(create_toc);
|
||||
@@ -0,0 +1,573 @@
|
||||
.. title:: MochiKit.Async - manage asynchronous tasks
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Async - manage asynchronous tasks
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
var url = "/src/b/bo/bob/MochiKit.Async/META.json";
|
||||
/*
|
||||
|
||||
META.json looks something like this:
|
||||
|
||||
{"name": "MochiKit", "version": "0.5"}
|
||||
|
||||
*/
|
||||
var d = loadJSONDoc(url);
|
||||
var gotMetadata = function (meta) {
|
||||
if (MochiKit.Async.VERSION == meta.version) {
|
||||
alert("You have the newest MochiKit.Async!");
|
||||
} else {
|
||||
alert("MochiKit.Async "
|
||||
+ meta.version
|
||||
+ " is available, upgrade!");
|
||||
}
|
||||
};
|
||||
var metadataFetchFailed = function (err) {
|
||||
alert("The metadata for MochiKit.Async could not be fetched :(");
|
||||
};
|
||||
d.addCallbacks(gotMetadata, metadataFetchFailed);
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
MochiKit.Async provides facilities to manage asynchronous
|
||||
(as in AJAX [1]_) tasks. The model for asynchronous computation
|
||||
used in this module is heavily inspired by Twisted [2]_.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Deferred
|
||||
--------
|
||||
|
||||
The Deferred constructor encapsulates a single value that
|
||||
is not available yet. The most important example of this
|
||||
in the context of a web browser would be an ``XMLHttpRequest``
|
||||
to a server. The importance of the Deferred is that it
|
||||
allows a consistent API to be exposed for all asynchronous
|
||||
computations that occur exactly once.
|
||||
|
||||
The producer of the Deferred is responsible for doing all
|
||||
of the complicated work behind the scenes. This often
|
||||
means waiting for a timer to fire, or waiting for an event
|
||||
(e.g. ``onreadystatechange`` of ``XMLHttpRequest``).
|
||||
It could also be coordinating several events (e.g.
|
||||
``XMLHttpRequest`` with a timeout, or several Deferreds
|
||||
(e.g. fetching a set of XML documents that should be
|
||||
processed at the same time).
|
||||
|
||||
Since these sorts of tasks do not respond immediately, the
|
||||
producer of the Deferred does the following steps before
|
||||
returning to the consumer:
|
||||
|
||||
1. Create a ``new`` :mochiref:`Deferred();` object and keep a reference
|
||||
to it, because it will be needed later when the value is
|
||||
ready.
|
||||
2. Setup the conditions to create the value requested (e.g.
|
||||
create a new ``XMLHttpRequest``, set its
|
||||
``onreadystatechange``).
|
||||
3. Return the :mochiref:`Deferred` object.
|
||||
|
||||
Since the value is not yet ready, the consumer attaches
|
||||
a function to the Deferred that will be called when the
|
||||
value is ready. This is not unlike ``setTimeout``, or
|
||||
other similar facilities you may already be familiar with.
|
||||
The consumer can also attach an "errback" to the
|
||||
:mochiref:`Deferred`, which is a callback for error handling.
|
||||
|
||||
When the value is ready, the producer simply calls
|
||||
``myDeferred.callback(theValue)``. If an error occurred,
|
||||
it should call ``myDeferred.errback(theValue)`` instead.
|
||||
As soon as this happens, the callback that the consumer
|
||||
attached to the :mochiref:`Deferred` is called with ``theValue``
|
||||
as the only argument.
|
||||
|
||||
There are quite a few additional "advanced" features
|
||||
baked into :mochiref:`Deferred`, such as cancellation and
|
||||
callback chains, so take a look at the API
|
||||
reference if you would like to know more!
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Errors
|
||||
------
|
||||
|
||||
:mochidef:`AlreadyCalledError`:
|
||||
|
||||
Thrown by a :mochiref:`Deferred` if ``.callback`` or
|
||||
``.errback`` are called more than once.
|
||||
|
||||
|
||||
:mochidef:`BrowserComplianceError`:
|
||||
|
||||
Thrown when the JavaScript runtime is not capable of performing
|
||||
the given function. Currently, this happens if the browser
|
||||
does not support ``XMLHttpRequest``.
|
||||
|
||||
|
||||
:mochidef:`CancelledError`:
|
||||
|
||||
Thrown by a :mochiref:`Deferred` when it is cancelled,
|
||||
unless a canceller is present and throws something else.
|
||||
|
||||
|
||||
:mochidef:`GenericError`:
|
||||
|
||||
Results passed to ``.fail`` or ``.errback`` of a :mochiref:`Deferred`
|
||||
are wrapped by this ``Error`` if ``!(result instanceof Error)``.
|
||||
|
||||
|
||||
:mochidef:`XMLHttpRequestError`:
|
||||
|
||||
Thrown when an ``XMLHttpRequest`` does not complete successfully
|
||||
for any reason. The ``req`` property of the error is the failed
|
||||
``XMLHttpRequest`` object, and for convenience the ``number``
|
||||
property corresponds to ``req.status``.
|
||||
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
:mochidef:`Deferred()`:
|
||||
|
||||
Encapsulates a sequence of callbacks in response to a value that
|
||||
may not yet be available. This is modeled after the Deferred class
|
||||
from Twisted [3]_.
|
||||
|
||||
.. _`Twisted`: http://twistedmatrix.com/
|
||||
|
||||
Why do we want this? JavaScript has no threads, and even if it did,
|
||||
threads are hard. Deferreds are a way of abstracting non-blocking
|
||||
events, such as the final response to an ``XMLHttpRequest``.
|
||||
|
||||
The sequence of callbacks is internally represented as a list
|
||||
of 2-tuples containing the callback/errback pair. For example,
|
||||
the following call sequence::
|
||||
|
||||
var d = new Deferred();
|
||||
d.addCallback(myCallback);
|
||||
d.addErrback(myErrback);
|
||||
d.addBoth(myBoth);
|
||||
d.addCallbacks(myCallback, myErrback);
|
||||
|
||||
is translated into a :mochiref:`Deferred` with the following internal
|
||||
representation::
|
||||
|
||||
[
|
||||
[myCallback, null],
|
||||
[null, myErrback],
|
||||
[myBoth, myBoth],
|
||||
[myCallback, myErrback]
|
||||
]
|
||||
|
||||
The :mochiref:`Deferred` also keeps track of its current status (fired).
|
||||
Its status may be one of the following three values:
|
||||
|
||||
|
||||
===== ================================
|
||||
Value Condition
|
||||
===== ================================
|
||||
-1 no value yet (initial condition)
|
||||
0 success
|
||||
1 error
|
||||
===== ================================
|
||||
|
||||
A :mochiref:`Deferred` will be in the error state if one of the following
|
||||
conditions are met:
|
||||
|
||||
1. The result given to callback or errback is "``instanceof Error``"
|
||||
2. The callback or errback threw while executing. If the thrown object
|
||||
is not ``instanceof Error``, it will be wrapped with
|
||||
:mochiref:`GenericError`.
|
||||
|
||||
Otherwise, the :mochiref:`Deferred` will be in the success state. The state
|
||||
of the :mochiref:`Deferred` determines the next element in the callback
|
||||
sequence to run.
|
||||
|
||||
When a callback or errback occurs with the example deferred chain, something
|
||||
equivalent to the following will happen (imagine that exceptions are caught
|
||||
and returned as-is)::
|
||||
|
||||
// d.callback(result) or d.errback(result)
|
||||
if (!(result instanceof Error)) {
|
||||
result = myCallback(result);
|
||||
}
|
||||
if (result instanceof Error) {
|
||||
result = myErrback(result);
|
||||
}
|
||||
result = myBoth(result);
|
||||
if (result instanceof Error) {
|
||||
result = myErrback(result);
|
||||
} else {
|
||||
result = myCallback(result);
|
||||
}
|
||||
|
||||
The result is then stored away in case another step is added to the
|
||||
callback sequence. Since the :mochiref:`Deferred` already has a value
|
||||
available, any new callbacks added will be called immediately.
|
||||
|
||||
There are two other "advanced" details about this implementation that are
|
||||
useful:
|
||||
|
||||
Callbacks are allowed to return :mochiref:`Deferred` instances,
|
||||
so you can build complicated sequences of events with (relative) ease.
|
||||
|
||||
The creator of the :mochiref:`Deferred` may specify a canceller. The
|
||||
canceller is a function that will be called if
|
||||
:mochiref:`Deferred.prototype.cancel` is called before the
|
||||
:mochiref:`Deferred` fires. You can use this to allow an
|
||||
``XMLHttpRequest`` to be cleanly cancelled, for example. Note that
|
||||
cancel will fire the :mochiref:`Deferred` with a
|
||||
:mochiref:`CancelledError` (unless your canceller throws or returns
|
||||
a different ``Error``), so errbacks should be prepared to handle that
|
||||
``Error`` gracefully for cancellable :mochiref:`Deferred` instances.
|
||||
|
||||
|
||||
:mochidef:`Deferred.prototype.addBoth(func)`:
|
||||
|
||||
Add the same function as both a callback and an errback as the
|
||||
next element on the callback sequence. This is useful for code
|
||||
that you want to guarantee to run, e.g. a finalizer.
|
||||
|
||||
If additional arguments are given, then ``func`` will be replaced
|
||||
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
|
||||
differs from `Twisted`_, because the result of the callback or
|
||||
errback will be the *last* argument passed to ``func``.
|
||||
|
||||
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned ``Deferred`` is chained, it can no longer accept new
|
||||
callbacks.
|
||||
|
||||
|
||||
:mochidef:`Deferred.prototype.addCallback(func[, ...])`:
|
||||
|
||||
Add a single callback to the end of the callback sequence.
|
||||
|
||||
If additional arguments are given, then ``func`` will be replaced
|
||||
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
|
||||
differs from `Twisted`_, because the result of the callback will
|
||||
be the *last* argument passed to ``func``.
|
||||
|
||||
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned ``Deferred`` is chained, it can no longer accept new
|
||||
callbacks.
|
||||
|
||||
:mochidef:`Deferred.prototype.addCallbacks(callback, errback)`:
|
||||
|
||||
Add separate callback and errback to the end of the callback
|
||||
sequence. Either callback or errback may be ``null``,
|
||||
but not both.
|
||||
|
||||
If ``callback`` or ``errback`` returns a :mochiref:`Deferred`,
|
||||
then it will be chained (its value or error will be passed to the
|
||||
next callback). Note that once the returned ``Deferred`` is chained,
|
||||
it can no longer accept new callbacks.
|
||||
|
||||
:mochidef:`Deferred.prototype.addErrback(func)`:
|
||||
|
||||
Add a single errback to the end of the callback sequence.
|
||||
|
||||
If additional arguments are given, then ``func`` will be replaced
|
||||
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
|
||||
differs from `Twisted`_, because the result of the errback will
|
||||
be the *last* argument passed to ``func``.
|
||||
|
||||
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
|
||||
(its value or error will be passed to the next callback). Note that
|
||||
once the returned ``Deferred`` is chained, it can no longer accept new
|
||||
callbacks.
|
||||
|
||||
:mochidef:`Deferred.prototype.callback([result])`:
|
||||
|
||||
Begin the callback sequence with a non-``Error`` result. Result
|
||||
may be any value except for a :mochiref:`Deferred`.
|
||||
|
||||
Either ``.callback`` or ``.errback`` should
|
||||
be called exactly once on a :mochiref:`Deferred`.
|
||||
|
||||
|
||||
:mochidef:`Deferred.prototype.cancel()`:
|
||||
|
||||
Cancels a :mochiref:`Deferred` that has not yet received a value,
|
||||
or is waiting on another :mochiref:`Deferred` as its value.
|
||||
|
||||
If a canceller is defined, the canceller is called.
|
||||
If the canceller did not return an ``Error``, or there
|
||||
was no canceller, then the errback chain is started
|
||||
with :mochiref:`CancelledError`.
|
||||
|
||||
|
||||
:mochidef:`Deferred.prototype.errback([result])`:
|
||||
|
||||
Begin the callback sequence with an error result.
|
||||
Result may be any value except for a :mochiref:`Deferred`,
|
||||
but if ``!(result instanceof Error)``, it will be wrapped
|
||||
with :mochiref:`GenericError`.
|
||||
|
||||
Either ``.callback`` or ``.errback`` should
|
||||
be called exactly once on a :mochidef:`Deferred`.
|
||||
|
||||
|
||||
:mochidef:`DeferredLock()`:
|
||||
|
||||
A lock for asynchronous systems.
|
||||
|
||||
The ``locked`` property of a :mochiref:`DeferredLock` will be ``true`` if
|
||||
it locked, ``false`` otherwise. Do not change this property.
|
||||
|
||||
|
||||
:mochidef:`DeferredLock.prototype.acquire()`:
|
||||
|
||||
Attempt to acquire the lock. Returns a :mochiref:`Deferred` that fires on
|
||||
lock acquisition with the :mochiref:`DeferredLock` as the value.
|
||||
If the lock is locked, then the :mochiref:`Deferred` goes into a waiting
|
||||
list.
|
||||
|
||||
|
||||
:mochidef:`DeferredLock.prototype.release()`:
|
||||
|
||||
Release the lock. If there is a waiting list, then the first
|
||||
:mochiref:`Deferred` in that waiting list will be called back.
|
||||
|
||||
|
||||
:mochidef:`DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller])`:
|
||||
|
||||
Combine a list of :mochiref:`Deferred` into one. Track the callbacks and
|
||||
return a list of (success, result) tuples, 'success' being a boolean
|
||||
indicating whether result is a normal result or an error.
|
||||
|
||||
Once created, you have access to all :mochiref:`Deferred` methods, like
|
||||
addCallback, addErrback, addBoth. The behaviour can be changed by the
|
||||
following options:
|
||||
|
||||
``fireOnOneCallback``:
|
||||
Flag for launching the callback once the first Deferred of the list
|
||||
has returned.
|
||||
|
||||
``fireOnOneErrback``:
|
||||
Flag for calling the errback at the first error of a Deferred.
|
||||
|
||||
``consumeErrors``:
|
||||
Flag indicating that any errors raised in the Deferreds should be
|
||||
consumed by the DeferredList.
|
||||
|
||||
Example::
|
||||
|
||||
// We need to fetch data from 2 different urls
|
||||
var d1 = loadJSONDoc(url1);
|
||||
var d2 = loadJSONDoc(url2);
|
||||
var l1 = new DeferredList([d1, d2], false, false, true);
|
||||
l1.addCallback(function (resultList) {
|
||||
MochiKit.Base.map(function (result) {
|
||||
if (result[0]) {
|
||||
alert("Data is here: " + result[1]);
|
||||
} else {
|
||||
alert("Got an error: " + result[1]);
|
||||
}
|
||||
}, resultList);
|
||||
});
|
||||
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`callLater(seconds, func[, args...])`:
|
||||
|
||||
Call ``func(args...)`` after at least ``seconds`` seconds have elapsed.
|
||||
This is a convenience method for::
|
||||
|
||||
func = partial.apply(extend(null, arguments, 1));
|
||||
return wait(seconds).addCallback(function (res) { return func() });
|
||||
|
||||
Returns a cancellable :mochiref:`Deferred`.
|
||||
|
||||
|
||||
:mochidef:`doSimpleXMLHttpRequest(url[, queryArguments...])`:
|
||||
|
||||
Perform a simple ``XMLHttpRequest`` and wrap it with a
|
||||
:mochiref:`Deferred` that may be cancelled.
|
||||
|
||||
Note that currently, only ``200`` (OK) and ``304``
|
||||
(NOT_MODIFIED) are considered success codes at this time, other
|
||||
status codes will result in an errback with an ``XMLHttpRequestError``.
|
||||
|
||||
``url``:
|
||||
The URL to GET
|
||||
|
||||
``queryArguments``:
|
||||
If this function is called with more than one argument, a ``"?"``
|
||||
and the result of :mochiref:`MochiKit.Base.queryString` with
|
||||
the rest of the arguments are appended to the URL.
|
||||
|
||||
For example, this will do a GET request to the URL
|
||||
``http://example.com?bar=baz``::
|
||||
|
||||
doSimpleXMLHttpRequest("http://example.com", {bar: "baz"});
|
||||
|
||||
*returns*:
|
||||
:mochiref:`Deferred` that will callback with the ``XMLHttpRequest``
|
||||
instance on success
|
||||
|
||||
|
||||
:mochidef:`evalJSONRequest(req)`:
|
||||
|
||||
Evaluate a JSON [4]_ ``XMLHttpRequest``
|
||||
|
||||
``req``:
|
||||
The request whose ``.responseText`` property is to be evaluated
|
||||
|
||||
*returns*:
|
||||
A JavaScript object
|
||||
|
||||
|
||||
:mochidef:`fail([result])`:
|
||||
|
||||
Return a :mochiref:`Deferred` that has already had ``.errback(result)``
|
||||
called.
|
||||
|
||||
See ``succeed`` documentation for rationale.
|
||||
|
||||
``result``:
|
||||
The result to give to :mochiref:`Deferred.prototype.errback(result)`.
|
||||
|
||||
*returns*:
|
||||
A ``new`` :mochiref:`Deferred()`
|
||||
|
||||
|
||||
:mochidef:`gatherResults(deferreds)`:
|
||||
|
||||
A convenience function that returns a :mochiref:`DeferredList`
|
||||
from the given ``Array`` of :mochiref:`Deferred` instances
|
||||
that will callback with an ``Array`` of just results when
|
||||
they're available, or errback on the first array.
|
||||
|
||||
|
||||
:mochidef:`getXMLHttpRequest()`:
|
||||
|
||||
Return an ``XMLHttpRequest`` compliant object for the current
|
||||
platform.
|
||||
|
||||
In order of preference:
|
||||
|
||||
- ``new XMLHttpRequest()``
|
||||
- ``new ActiveXObject('Msxml2.XMLHTTP')``
|
||||
- ``new ActiveXObject('Microsoft.XMLHTTP')``
|
||||
- ``new ActiveXObject('Msxml2.XMLHTTP.4.0')``
|
||||
|
||||
|
||||
:mochidef:`maybeDeferred(func[, argument...])`:
|
||||
|
||||
Call a ``func`` with the given arguments and ensure the result is a
|
||||
:mochiref:`Deferred`.
|
||||
|
||||
``func``:
|
||||
The function to call.
|
||||
|
||||
*returns*:
|
||||
A new :mochiref:`Deferred` based on the call to ``func``. If ``func``
|
||||
does not naturally return a :mochiref:`Deferred`, its result or error
|
||||
value will be wrapped by one.
|
||||
|
||||
|
||||
:mochidef:`loadJSONDoc(url)`:
|
||||
|
||||
Do a simple ``XMLHttpRequest`` to a URL and get the response
|
||||
as a JSON [4]_ document.
|
||||
|
||||
``url``:
|
||||
The URL to GET
|
||||
|
||||
*returns*:
|
||||
:mochiref:`Deferred` that will callback with the evaluated JSON [4]_
|
||||
response upon successful ``XMLHttpRequest``
|
||||
|
||||
|
||||
:mochidef:`sendXMLHttpRequest(req[, sendContent])`:
|
||||
|
||||
Set an ``onreadystatechange`` handler on an ``XMLHttpRequest`` object
|
||||
and send it off. Will return a cancellable :mochiref:`Deferred` that will
|
||||
callback on success.
|
||||
|
||||
Note that currently, only ``200`` (OK) and ``304``
|
||||
(NOT_MODIFIED) are considered success codes at this time, other
|
||||
status codes will result in an errback with an ``XMLHttpRequestError``.
|
||||
|
||||
``req``:
|
||||
An preconfigured ``XMLHttpRequest`` object (open has been called).
|
||||
|
||||
``sendContent``:
|
||||
Optional string or DOM content to send over the ``XMLHttpRequest``.
|
||||
|
||||
*returns*:
|
||||
:mochiref:`Deferred` that will callback with the ``XMLHttpRequest``
|
||||
instance on success.
|
||||
|
||||
|
||||
:mochidef:`succeed([result])`:
|
||||
|
||||
Return a :mochiref:`Deferred` that has already had ``.callback(result)``
|
||||
called.
|
||||
|
||||
This is useful when you're writing synchronous code to an asynchronous
|
||||
interface: i.e., some code is calling you expecting a :mochiref:`Deferred`
|
||||
result, but you don't actually need to do anything asynchronous. Just
|
||||
return ``succeed(theResult)``.
|
||||
|
||||
See ``fail`` for a version of this function that uses a failing
|
||||
:mochiref:`Deferred` rather than a successful one.
|
||||
|
||||
``result``:
|
||||
The result to give to :mochiref:`Deferred.prototype.callback(result)`
|
||||
|
||||
*returns*:
|
||||
a ``new`` :mochiref:`Deferred`
|
||||
|
||||
|
||||
:mochidef:`wait(seconds[, res])`:
|
||||
|
||||
Return a new cancellable :mochiref:`Deferred` that will ``.callback(res)``
|
||||
after at least ``seconds`` seconds have elapsed.
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] AJAX, Asynchronous JavaScript and XML: http://en.wikipedia.org/wiki/AJAX
|
||||
.. [2] Twisted, an event-driven networking framework written in Python: http://twistedmatrix.com/
|
||||
.. [3] Twisted Deferred Reference: http://twistedmatrix.com/projects/core/documentation/howto/defer.html
|
||||
.. [4] JSON, JavaScript Object Notation: http://json.org/
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,481 @@
|
||||
.. title:: MochiKit.Color - color abstraction with CSS3 support
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Color - color abstraction with CSS3 support
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
// RGB color expressions are supported
|
||||
assert(
|
||||
objEqual(Color.whiteColor(), Color.fromString("rgb(255,100%, 255)"))
|
||||
);
|
||||
|
||||
// So is instantiating directly from HSL or RGB values.
|
||||
// Note that fromRGB and fromHSL take numbers between 0.0 and 1.0!
|
||||
assert( objEqual(Color.fromRGB(1.0, 1.0, 1.0), Color.fromHSL(0.0, 0.0, 1.0) );
|
||||
|
||||
// Or even SVG color keyword names, as per CSS3!
|
||||
assert( Color.fromString("aquamarine"), "#7fffd4" );
|
||||
|
||||
// NSColor-like colors built in
|
||||
assert( Color.whiteColor().toHexString() == "#ffffff" );
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
MochiKit.Color is an abstraction for handling colors and strings that
|
||||
represent colors.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
MochiKit.Color provides an abstraction of RGB, HSL and HSV colors with alpha.
|
||||
It supports parsing and generating of CSS3 colors, and has a full CSS3 (SVG)
|
||||
color table.
|
||||
|
||||
All of the functionality in this module is exposed through a Color constructor
|
||||
and its prototype, but a few of its internals are available for direct use at
|
||||
module level.
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
:mochidef:`Color()`:
|
||||
|
||||
Represents a color. Component values should be integers between ``0.0``
|
||||
and ``1.0``. You should use one of the :mochiref:`Color` factory
|
||||
functions such as :mochiref:`Color.fromRGB`, :mochiref:`Color.fromHSL`,
|
||||
etc. instead of constructing :mochiref:`Color` objects directly.
|
||||
|
||||
:mochiref:`Color` instances can be compared with
|
||||
:mochiref:`MochiKit.Base.compare` (though ordering is on RGB, so is not
|
||||
particularly meaningful except for equality), and the default ``toString``
|
||||
implementation returns :mochiref:`Color.prototype.toHexString()`.
|
||||
|
||||
:mochiref:`Color` instances are immutable, and much of the architecture is
|
||||
inspired by AppKit's NSColor [1]_
|
||||
|
||||
|
||||
:mochidef:`Color.fromBackground(elem)`:
|
||||
|
||||
Returns a :mochiref:`Color` object based on the background of the provided
|
||||
element. Equivalent to::
|
||||
|
||||
c = Color.fromComputedStyle(
|
||||
elem, "backgroundColor", "background-color") || Color.whiteColor();
|
||||
|
||||
|
||||
:mochidef:`Color.fromComputedStyle(elem, style, mozillaEquivalentCSS)`:
|
||||
|
||||
Returns a :mochiref:`Color` object based on the result of
|
||||
:mochiref:`MochiKit.DOM.computedStyle(elem, style, mozillaEquivalentCSS)`
|
||||
or ``null`` if not found.
|
||||
|
||||
|
||||
:mochidef:`Color.fromHexString(hexString)`:
|
||||
|
||||
Returns a :mochiref:`Color` object from the given hexadecimal color string.
|
||||
For example, ``"#FFFFFF"`` would return a :mochiref:`Color` with
|
||||
RGB values ``[255/255, 255/255, 255/255]`` (white).
|
||||
|
||||
|
||||
:mochidef:`Color.fromHSL(hue, saturation, lightness, alpha=1.0)`:
|
||||
|
||||
Return a :mochiref:`Color` object from the given ``hue``, ``saturation``,
|
||||
``lightness`` values. Values should be numbers between ``0.0`` and
|
||||
``1.0``.
|
||||
|
||||
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`Color.fromHSL({h: hue, s: saturation, l: lightness, a: alpha})`
|
||||
|
||||
|
||||
:mochidef:`Color.fromHSLString(hslString)`:
|
||||
|
||||
Returns a :mochiref:`Color` object from the given decimal hsl color string.
|
||||
For example, ``"hsl(0,0%,100%)"`` would return a :mochiref:`Color` with
|
||||
HSL values ``[0/360, 0/360, 360/360]`` (white).
|
||||
|
||||
|
||||
:mochidef:`Color.fromHSV(hue, saturation, value, alpha=1.0)`:
|
||||
|
||||
Return a :mochiref:`Color` object from the given ``hue``, ``saturation``,
|
||||
``value`` values. Values should be numbers between ``0.0`` and
|
||||
``1.0``.
|
||||
|
||||
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`Color.fromHSV({h: hue, s: saturation, v: value, a: alpha})`
|
||||
|
||||
|
||||
:mochidef:`Color.fromName(colorName)`:
|
||||
|
||||
Returns a :mochiref:`Color` object corresponding to the given
|
||||
SVG 1.0 color keyword name [2]_ as per the W3C CSS3
|
||||
Color Module [3]_. ``"transparent"`` is also accepted
|
||||
as a color name, and will return :mochiref:`Color.transparentColor()`.
|
||||
|
||||
|
||||
:mochidef:`Color.fromRGB(red, green, blue, alpha=1.0)`:
|
||||
|
||||
Return a :mochiref:`Color` object from the given ``red``, ``green``,
|
||||
``blue``, and ``alpha`` values. Values should be numbers between ``0``
|
||||
and ``1.0``.
|
||||
|
||||
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`Color.fromRGB({r: red, g: green, b: blue, a: alpha})`
|
||||
|
||||
|
||||
:mochidef:`Color.fromRGBString(rgbString)`:
|
||||
|
||||
Returns a :mochiref:`Color` object from the given decimal rgb color string.
|
||||
For example, ``"rgb(255,255,255)"`` would return a :mochiref:`Color` with
|
||||
RGB values ``[255/255, 255/255, 255/255]`` (white).
|
||||
|
||||
|
||||
:mochidef:`Color.fromText(elem)`:
|
||||
|
||||
Returns a :mochiref:`Color` object based on the text color of the provided
|
||||
element. Equivalent to::
|
||||
|
||||
c = Color.fromComputedStyle(elem, "color") || Color.whiteColor();
|
||||
|
||||
|
||||
:mochidef:`Color.fromString(rgbOrHexString)`:
|
||||
|
||||
Returns a :mochiref:`Color` object from the given RGB, HSL, hex, or name.
|
||||
Will return ``null`` if the string can not be parsed by any of these
|
||||
methods.
|
||||
|
||||
See :mochiref:`Color.fromHexString`, :mochiref:`Color.fromRGBString`,
|
||||
:mochiref:`Color.fromHSLString` and :mochiref:`Color.fromName` more
|
||||
information.
|
||||
|
||||
|
||||
:mochidef:`Color.namedColors()`:
|
||||
|
||||
Returns an object with properties for each SVG 1.0 color keyword
|
||||
name [2]_ supported by CSS3 [3]_. Property names are the color keyword
|
||||
name in lowercase, and the value is a string suitable for
|
||||
:mochiref:`Color.fromString()`.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.colorWithAlpha(alpha)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but with the provided
|
||||
``alpha`` value.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.colorWithHue(hue)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but with the provided
|
||||
``hue`` value.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.colorWithSaturation(saturation)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but with the provided
|
||||
``saturation`` value (using the HSL color model).
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.colorWithLightness(lightness)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but with the provided
|
||||
``lightness`` value.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.darkerColorWithLevel(level)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but darker by the given
|
||||
``level`` (between ``0`` and ``1.0``).
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.lighterColorWithLevel(level)`:
|
||||
|
||||
Return a new :mochiref:`Color` based on this color, but lighter by the given
|
||||
``level`` (between ``0`` and ``1.0``).
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.blendedColor(other, fraction=0.5)`:
|
||||
|
||||
Return a new :mochiref:`Color` whose RGBA component values are a weighted sum
|
||||
of this color and ``other``. Each component of the returned color
|
||||
is the ``fraction`` of other's value plus ``1 - fraction`` of this
|
||||
color's.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.isLight()`:
|
||||
|
||||
Return ``true`` if the lightness value of this color is greater than
|
||||
``0.5``.
|
||||
|
||||
Note that ``alpha`` is ignored for this calculation (color components
|
||||
are not premultiplied).
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.isDark()`:
|
||||
|
||||
Return ``true`` if the lightness value of this color is less than or
|
||||
equal to ``0.5``.
|
||||
|
||||
Note that ``alpha`` is ignored for this calculation (color components
|
||||
are not premultiplied).
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.toRGBString()`:
|
||||
|
||||
Return the decimal ``"rgb(red, green, blue)"`` string representation of this
|
||||
color.
|
||||
|
||||
If the alpha component is not ``1.0`` (fully opaque), the
|
||||
``"rgba(red, green, blue, alpha)"`` string representation will be used.
|
||||
|
||||
For example::
|
||||
|
||||
assert( Color.whiteColor().toRGBString() == "rgb(255,255,255)" );
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.toHSLString()`:
|
||||
|
||||
Return the decimal ``"hsl(hue, saturation, lightness)"``
|
||||
string representation of this color.
|
||||
|
||||
If the alpha component is not ``1.0`` (fully opaque), the
|
||||
``"hsla(hue, saturation, lightness, alpha)"`` string representation
|
||||
will be used.
|
||||
|
||||
For example::
|
||||
|
||||
assert( Color.whiteColor().toHSLString() == "hsl(0,0,360)" );
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.toHexString()`:
|
||||
|
||||
Return the hexadecimal ``"#RRGGBB"`` string representation of this color.
|
||||
|
||||
Note that the alpha component is completely ignored for hexadecimal
|
||||
string representations!
|
||||
|
||||
For example::
|
||||
|
||||
assert( Color.whiteColor().toHexString() == "#FFFFFF" );
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.asRGB()`:
|
||||
|
||||
Return the RGB (red, green, blue, alpha) components of this color as an
|
||||
object with ``r``, ``g``, ``b``, and ``a`` properties that have
|
||||
values between ``0.0`` and ``1.0``.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.asHSL()`:
|
||||
|
||||
Return the HSL (hue, saturation, lightness, alpha) components of this
|
||||
color as an object with ``h``, ``s``, ``l`` and ``a`` properties
|
||||
that have values between ``0.0`` and ``1.0``.
|
||||
|
||||
|
||||
:mochidef:`Color.prototype.asHSV()`:
|
||||
|
||||
Return the HSV (hue, saturation, value, alpha) components of this
|
||||
color as an object with ``h``, ``s``, ``v`` and ``a`` properties
|
||||
that have values between ``0.0`` and ``1.0``.
|
||||
|
||||
|
||||
:mochidef:`Color.blackColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0, 0, 0
|
||||
(#000000).
|
||||
|
||||
|
||||
:mochidef:`Color.blueColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0, 0, 1
|
||||
(#0000ff).
|
||||
|
||||
|
||||
:mochidef:`Color.brownColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0.6, 0.4, 0.2
|
||||
(#996633).
|
||||
|
||||
|
||||
:mochidef:`Color.cyanColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0, 1, 1
|
||||
(#00ffff).
|
||||
|
||||
|
||||
:mochidef:`Color.darkGrayColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1/3, 1/3, 1/3
|
||||
(#555555).
|
||||
|
||||
|
||||
:mochidef:`Color.grayColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0.5, 0.5, 0.5
|
||||
(#808080).
|
||||
|
||||
|
||||
:mochidef:`Color.greenColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0, 1, 0.
|
||||
(#00ff00).
|
||||
|
||||
|
||||
:mochidef:`Color.lightGrayColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 2/3, 2/3, 2/3
|
||||
(#aaaaaa).
|
||||
|
||||
|
||||
:mochidef:`Color.magentaColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1, 0, 1
|
||||
(#ff00ff).
|
||||
|
||||
|
||||
:mochidef:`Color.orangeColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1, 0.5, 0
|
||||
(#ff8000).
|
||||
|
||||
|
||||
:mochidef:`Color.purpleColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 0.5, 0, 0.5
|
||||
(#800080).
|
||||
|
||||
|
||||
:mochidef:`Color.redColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1, 0, 0
|
||||
(#ff0000).
|
||||
|
||||
|
||||
:mochidef:`Color.whiteColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1, 1, 1
|
||||
(#ffffff).
|
||||
|
||||
|
||||
:mochidef:`Color.yellowColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object whose RGB values are 1, 1, 0
|
||||
(#ffff00).
|
||||
|
||||
|
||||
:mochidef:`Color.transparentColor()`:
|
||||
|
||||
Return a :mochiref:`Color` object that is completely transparent
|
||||
(has alpha component of 0).
|
||||
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`clampColorComponent(num, scale)`:
|
||||
|
||||
Returns ``num * scale`` clamped between ``0`` and ``scale``.
|
||||
|
||||
:mochiref:`clampColorComponent` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
:mochidef:`hslToRGB(hue, saturation, lightness, alpha)`:
|
||||
|
||||
Computes RGB values from the provided HSL values. The return value is a
|
||||
mapping with ``"r"``, ``"g"``, ``"b"`` and ``"a"`` keys.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`hslToRGB({h: hue, s: saturation, l: lightness, a: alpha})`.
|
||||
|
||||
:mochiref:`hslToRGB` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
:mochidef:`hsvToRGB(hue, saturation, value, alpha)`:
|
||||
|
||||
Computes RGB values from the provided HSV values. The return value is a
|
||||
mapping with ``"r"``, ``"g"``, ``"b"`` and ``"a"`` keys.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`hsvToRGB({h: hue, s: saturation, v: value, a: alpha})`.
|
||||
|
||||
:mochiref:`hsvToRGB` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
:mochidef:`toColorPart(num)`:
|
||||
|
||||
Convert num to a zero padded hexadecimal digit for use in a hexadecimal
|
||||
color string. Num should be an integer between ``0`` and ``255``.
|
||||
|
||||
:mochiref:`toColorPart` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
:mochidef:`rgbToHSL(red, green, blue, alpha)`:
|
||||
|
||||
Computes HSL values based on the provided RGB values. The return value is
|
||||
a mapping with ``"h"``, ``"s"``, ``"l"`` and ``"a"`` keys.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`rgbToHSL({r: red, g: green, b: blue, a: alpha})`.
|
||||
|
||||
:mochiref:`rgbToHSL` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
:mochidef:`rgbToHSV(red, green, blue, alpha)`:
|
||||
|
||||
Computes HSV values based on the provided RGB values. The return value is
|
||||
a mapping with ``"h"``, ``"s"``, ``"v"`` and ``"a"`` keys.
|
||||
|
||||
Alternate form:
|
||||
:mochiref:`rgbToHSV({r: red, g: green, b: blue, a: alpha})`.
|
||||
|
||||
:mochiref:`rgbToHSV` is not exported by default when using JSAN.
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] Application Kit Reference - NSColor: http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html
|
||||
.. [2] SVG 1.0 color keywords: http://www.w3.org/TR/SVG/types.html#ColorKeywords
|
||||
.. [3] W3C CSS3 Color Module: http://www.w3.org/TR/css3-color/#svg-color
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,782 @@
|
||||
.. title:: MochiKit.DOM - painless DOM manipulation API
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.DOM - painless DOM manipulation API
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
var rows = [
|
||||
["dataA1", "dataA2", "dataA3"],
|
||||
["dataB1", "dataB2", "dataB3"]
|
||||
];
|
||||
row_display = function (row) {
|
||||
return TR(null, map(partial(TD, null), row));
|
||||
}
|
||||
var newTable = TABLE({'class': 'prettytable'},
|
||||
THEAD(null,
|
||||
row_display(["head1", "head2", "head3"])),
|
||||
TFOOT(null,
|
||||
row_display(["foot1", "foot2", "foot3"])),
|
||||
TBODY(null,
|
||||
map(row_display, rows)));
|
||||
// put that in your document.createElement and smoke it!
|
||||
swapDOM(oldTable, newTable);
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
As you probably know, the DOM APIs are some of the most painful Java-inspired
|
||||
APIs you'll run across from a highly dynamic language. Don't worry about that
|
||||
though, because they provide a reasonable basis to build something that
|
||||
sucks a lot less.
|
||||
|
||||
MochiKit.DOM takes much of its inspiration from Nevow's [1]_ stan [2]_.
|
||||
This means you choose a tag, give it some attributes, then stuff it full
|
||||
of *whatever objects you want*. MochiKit.DOM isn't stupid, it knows that
|
||||
a string should be a text node, and that you want functions to be called,
|
||||
and that ``Array``-like objects should be expanded, and stupid ``null`` values
|
||||
should be skipped.
|
||||
|
||||
Hell, it will let you return strings from functions, and use iterators from
|
||||
:mochiref:`MochiKit.Iter`. If that's not enough, just teach it new tricks with
|
||||
:mochiref:`registerDOMConverter`. If you have never used an API like this for
|
||||
creating DOM elements, you've been wasting your damn time. Get with it!
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
- :mochiref:`MochiKit.Iter`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
DOM Coercion Rules
|
||||
------------------
|
||||
|
||||
In order of precedence, :mochiref:`createDOM` coerces given arguments to DOM
|
||||
nodes using the following rules:
|
||||
|
||||
1. Functions are called with a ``this`` of the parent
|
||||
node and their return value is subject to the
|
||||
following rules (even this one).
|
||||
2. ``undefined`` and ``null`` are ignored.
|
||||
3. Iterables (see :mochiref:`MochiKit.Iter`) are flattened
|
||||
(as if they were passed in-line as nodes) and each
|
||||
return value is subject to all of these rules.
|
||||
4. Values that look like DOM nodes (objects with a
|
||||
``.nodeType > 0``) are ``.appendChild``'ed to the created
|
||||
DOM fragment.
|
||||
5. Strings are wrapped up with ``document.createTextNode``
|
||||
6. Objects that are not strings are run through the ``domConverters``
|
||||
:mochiref:`MochiKit.Base.AdapterRegistry`
|
||||
(see :mochiref:`registerDOMConverter`).
|
||||
The value returned by the adapter is subject to these same rules (e.g.
|
||||
adapters are allowed to return a string, which will be coerced into a
|
||||
text node).
|
||||
7. If no adapter is available, ``.toString()`` is used to create a text node.
|
||||
|
||||
|
||||
Creating DOM Element Trees
|
||||
--------------------------
|
||||
|
||||
:mochiref:`createDOM` provides you with an excellent facility for creating DOM trees
|
||||
that is easy on the wrists. One of the best ways to understand how to use
|
||||
it is to take a look at an example::
|
||||
|
||||
var rows = [
|
||||
["dataA1", "dataA2", "dataA3"],
|
||||
["dataB1", "dataB2", "dataB3"]
|
||||
];
|
||||
row_display = function (row) {
|
||||
return TR(null, map(partial(TD, null), row));
|
||||
}
|
||||
var newTable = TABLE({'class': 'prettytable'},
|
||||
THEAD(null,
|
||||
row_display(["head1", "head2", "head3"])),
|
||||
TFOOT(null,
|
||||
row_display(["foot1", "foot2", "foot3"])),
|
||||
TBODY(null,
|
||||
map(row_display, rows)));
|
||||
|
||||
|
||||
This will create a table with the following visual layout (if it
|
||||
were inserted into the document DOM):
|
||||
|
||||
+--------+--------+--------+
|
||||
| head1 | head2 | head3 |
|
||||
+========+========+========+
|
||||
| dataA1 | dataA2 | dataA3 |
|
||||
+--------+--------+--------+
|
||||
| dataB1 | dataB2 | dataB3 |
|
||||
+--------+--------+--------+
|
||||
| foot1 | foot2 | foot3 |
|
||||
+--------+--------+--------+
|
||||
|
||||
Corresponding to the following HTML::
|
||||
|
||||
<table class="prettytable">
|
||||
<thead>
|
||||
<tr>
|
||||
<td>head1</td>
|
||||
<td>head2</td>
|
||||
<td>head3</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<td>foot1</td>
|
||||
<td>foot2</td>
|
||||
<td>foot3</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>dataA1</td>
|
||||
<td>dataA2</td>
|
||||
<td>dataA3</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dataB1</td>
|
||||
<td>dataB2</td>
|
||||
<td>dataB3</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
DOM Context
|
||||
-----------
|
||||
|
||||
In order to prevent having to pass a ``window`` and/or ``document``
|
||||
variable to every MochiKit.DOM function (e.g. when working with a
|
||||
child window), MochiKit.DOM maintains a context variable for each
|
||||
of them. They are managed with the :mochiref:`withWindow` and
|
||||
:mochiref:`withDocument` functions, and can be acquired with
|
||||
:mochiref:`currentWindow()` and :mochiref:`currentDocument()`
|
||||
|
||||
For example, if you are creating DOM nodes in a child window, you
|
||||
could do something like this::
|
||||
|
||||
withWindow(child, function () {
|
||||
var doc = currentDocument();
|
||||
appendChildNodes(doc.body, H1(null, "This is in the child!"));
|
||||
});
|
||||
|
||||
Note that :mochiref:`withWindow(win, ...)` also implies
|
||||
:mochiref:`withDocument(win.document, ...)`.
|
||||
|
||||
|
||||
Element Visibility
|
||||
------------------
|
||||
|
||||
The :mochiref:`hideElement` and :mochiref:`showElement` functions are
|
||||
provided as a convenience, but only work for elements that are
|
||||
``display: block``. For a general solution to showing, hiding, and checking
|
||||
the explicit visibility of elements, we recommend using a solution that
|
||||
involves a little CSS. Here's an example::
|
||||
|
||||
<style type="text/css">
|
||||
.invisible { display: none; }
|
||||
</style>
|
||||
|
||||
<script type="text/javascript">
|
||||
function toggleVisible(elem) {
|
||||
toggleElementClass("invisible", elem);
|
||||
}
|
||||
|
||||
function makeVisible(elem) {
|
||||
removeElementClass(elem, "invisible");
|
||||
}
|
||||
|
||||
function makeInvisible(elem) {
|
||||
addElementClass(elem, "invisible");
|
||||
}
|
||||
|
||||
function isVisible(elem) {
|
||||
// you may also want to check for
|
||||
// getElement(elem).style.display == "none"
|
||||
return !hasElementClass(elem, "invisible");
|
||||
};
|
||||
</script>
|
||||
|
||||
MochiKit doesn't ship with such a solution, because there is no reliable and
|
||||
portable method for adding CSS rules on the fly with JavaScript.
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`$(id[, ...])`:
|
||||
|
||||
An alias for :mochiref:`getElement(id[, ...])`
|
||||
|
||||
|
||||
:mochidef:`addElementClass(element, className)`:
|
||||
|
||||
Ensure that the given ``element`` has ``className`` set as part of its
|
||||
class attribute. This will not disturb other class names.
|
||||
``element`` is looked up with :mochiref:`getElement`, so string identifiers
|
||||
are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`addLoadEvent(func)`:
|
||||
|
||||
Note that :mochiref:`addLoadEvent` can not be used in combination with
|
||||
:mochiref:`MochiKit.Signal` if the ``onload`` event is connected.
|
||||
Once an event is connected with :mochiref:`MochiKit.Signal`, no other APIs
|
||||
may be used for that same event.
|
||||
|
||||
This will stack ``window.onload`` functions on top of each other.
|
||||
Each function added will be called after ``onload`` in the
|
||||
order that they were added.
|
||||
|
||||
|
||||
:mochidef:`addToCallStack(target, path, func[, once])`:
|
||||
|
||||
Note that :mochiref:`addToCallStack` is not compatible with
|
||||
:mochiref:`MochiKit.Signal`. Once an event is connected with
|
||||
:mochiref:`MochiKit.Signal`, no other APIs may be used for that same event.
|
||||
|
||||
Set the property ``path`` of ``target`` to a function that calls the
|
||||
existing function at that property (if any), then calls ``func``.
|
||||
|
||||
If ``target[path]()`` returns exactly ``false``, then ``func`` will
|
||||
not be called.
|
||||
|
||||
If ``once`` is ``true``, then ``target[path]`` is set to ``null`` after
|
||||
the function call stack has completed.
|
||||
|
||||
If called several times for the same ``target[path]``, it will create
|
||||
a stack of functions (instead of just a pair).
|
||||
|
||||
|
||||
:mochidef:`appendChildNodes(node[, childNode[, ...]])`:
|
||||
|
||||
Append children to a DOM element using the `DOM Coercion Rules`_.
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to add children to
|
||||
(if a string is given, :mochiref:`getElement(node)`
|
||||
will be used to locate the node)
|
||||
|
||||
``childNode``...:
|
||||
All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
`DOM Coercion Rules`_.
|
||||
|
||||
*returns*:
|
||||
The given DOM element
|
||||
|
||||
|
||||
:mochidef:`computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS)`:
|
||||
|
||||
Looks up a CSS property for the given element. The element can be
|
||||
specified as either a string with the element's ID or the element
|
||||
object itself.
|
||||
|
||||
|
||||
:mochidef:`createDOM(name[, attrs[, node[, ...]]])`:
|
||||
|
||||
Create a DOM fragment in a really convenient manner, much like
|
||||
Nevow`s [1]_ stan [2]_.
|
||||
|
||||
Partially applied versions of this function for common tags are
|
||||
available as aliases:
|
||||
|
||||
- ``A``
|
||||
- ``BUTTON``
|
||||
- ``BR``
|
||||
- ``CANVAS``
|
||||
- ``DIV``
|
||||
- ``FIELDSET``
|
||||
- ``FORM``
|
||||
- ``H1``
|
||||
- ``H2``
|
||||
- ``H3``
|
||||
- ``HR``
|
||||
- ``IMG``
|
||||
- ``INPUT``
|
||||
- ``LABEL``
|
||||
- ``LEGEND``
|
||||
- ``LI``
|
||||
- ``OL``
|
||||
- ``OPTGROUP``
|
||||
- ``OPTION``
|
||||
- ``P``
|
||||
- ``PRE``
|
||||
- ``SELECT``
|
||||
- ``SPAN``
|
||||
- ``STRONG``
|
||||
- ``TABLE``
|
||||
- ``TBODY``
|
||||
- ``TD``
|
||||
- ``TEXTAREA``
|
||||
- ``TFOOT``
|
||||
- ``TH``
|
||||
- ``THEAD``
|
||||
- ``TR``
|
||||
- ``TT``
|
||||
- ``UL``
|
||||
|
||||
See `Creating DOM Element Trees`_ for a comprehensive example.
|
||||
|
||||
``name``:
|
||||
The kind of fragment to create (e.g. 'span'), such as you would
|
||||
pass to ``document.createElement``.
|
||||
|
||||
``attrs``:
|
||||
An object whose properties will be used as the attributes
|
||||
(e.g. ``{'style': 'display:block'}``), or ``null`` if no
|
||||
attributes need to be set.
|
||||
|
||||
See :mochiref:`updateNodeAttributes` for more information.
|
||||
|
||||
For convenience, if ``attrs`` is a string, ``null`` is used
|
||||
and the string will be considered the first ``node``.
|
||||
|
||||
``node``...:
|
||||
All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
`DOM Coercion Rules`_.
|
||||
|
||||
*returns*:
|
||||
A DOM element
|
||||
|
||||
|
||||
:mochidef:`createDOMFunc(tag[, attrs[, node[, ...]]])`:
|
||||
|
||||
Convenience function to create a partially applied createDOM
|
||||
function. You'd want to use this if you add additional convenience
|
||||
functions for creating tags, or if you find yourself creating
|
||||
a lot of tags with a bunch of the same attributes or contents.
|
||||
|
||||
See :mochiref:`createDOM` for more detailed descriptions of the arguments.
|
||||
|
||||
``tag``:
|
||||
The name of the tag
|
||||
|
||||
``attrs``:
|
||||
Optionally specify the attributes to apply
|
||||
|
||||
``node``...:
|
||||
Optionally specify any children nodes it should have
|
||||
|
||||
*returns*:
|
||||
function that takes additional arguments and calls
|
||||
:mochiref:`createDOM`
|
||||
|
||||
|
||||
:mochidef:`currentDocument()`:
|
||||
|
||||
Return the current ``document`` `DOM Context`_. This will always
|
||||
be the same as the global ``document`` unless :mochiref:`withDocument` or
|
||||
:mochiref:`withWindow` is currently executing.
|
||||
|
||||
|
||||
:mochidef:`currentWindow()`:
|
||||
|
||||
Return the current ``window`` `DOM Context`_. This will always
|
||||
be the same as the global ``window`` unless :mochiref:`withWindow` is
|
||||
currently executing.
|
||||
|
||||
|
||||
:mochidef:`elementDimensions(element)`:
|
||||
|
||||
Return the absolute pixel width and height of ``element`` as an object with
|
||||
``w`` and ``h`` properties, or ``undefined`` if ``element`` is not in the
|
||||
document. ``element`` may be specified as a string to be looked up with
|
||||
:mochiref:`getElement`, a DOM element, or trivially as an object with
|
||||
``w`` and/or ``h`` properties.
|
||||
|
||||
|
||||
:mochidef:`elementPosition(element[, relativeTo={x: 0, y: 0}])`:
|
||||
|
||||
Return the absolute pixel position of ``element`` in the document as an
|
||||
object with ``x`` and ``y`` properties, or ``undefined`` if ``element``
|
||||
is not in the document. ``element`` may be specified as a string to
|
||||
be looked up with :mochiref:`getElement`, a DOM element, or trivially
|
||||
as an object with ``x`` and/or ``y`` properties.
|
||||
|
||||
If ``relativeTo`` is given, then its coordinates are subtracted from
|
||||
the absolute position of ``element``, e.g.::
|
||||
|
||||
var elemPos = elementPosition(elem);
|
||||
var anotherElemPos = elementPosition(anotherElem);
|
||||
var relPos = elementPosition(elem, anotherElem);
|
||||
assert( relPos.x == (elemPos.x - anotherElemPos.x) );
|
||||
assert( relPos.y == (elemPos.y - anotherElemPos.y) );
|
||||
|
||||
``relativeTo`` may be specified as a string to be looked up with
|
||||
:mochiref:`getElement`, a DOM element, or trivially as an object
|
||||
with ``x`` and/or ``y`` properties.
|
||||
|
||||
|
||||
:mochidef:`emitHTML(dom[, lst])`:
|
||||
|
||||
Convert a DOM tree to an ``Array`` of HTML string fragments
|
||||
|
||||
You probably want to use :mochiref:`toHTML` instead.
|
||||
|
||||
|
||||
:mochidef:`escapeHTML(s)`:
|
||||
|
||||
Make a string safe for HTML, converting the usual suspects (lt,
|
||||
gt, quot, apos, amp)
|
||||
|
||||
|
||||
:mochidef:`focusOnLoad(element)`:
|
||||
|
||||
Add an onload event to focus the given element
|
||||
|
||||
|
||||
:mochidef:`formContents(elem)`:
|
||||
|
||||
Search the DOM tree, starting at ``elem``, for any elements with a
|
||||
``name`` and ``value`` attribute. Return a 2-element ``Array`` of
|
||||
``names`` and ``values`` suitable for use with
|
||||
:mochiref:`MochiKit.Base.queryString`.
|
||||
|
||||
|
||||
:mochidef:`getElement(id[, ...])`:
|
||||
|
||||
A small quick little function to encapsulate the ``getElementById``
|
||||
method. It includes a check to ensure we can use that method.
|
||||
|
||||
If the id isn't a string, it will be returned as-is.
|
||||
|
||||
Also available as :mochiref:`$(...)` for convenience and compatibility with
|
||||
other JavaScript frameworks.
|
||||
|
||||
If multiple arguments are given, an ``Array`` will be returned.
|
||||
|
||||
|
||||
:mochidef:`getElementsByTagAndClassName(tagName, className, parent=document)`:
|
||||
|
||||
Returns an array of elements in ``parent`` that match the tag name
|
||||
and class name provided. If ``parent`` is a string, it will be looked
|
||||
up with :mochiref:`getElement`.
|
||||
|
||||
If ``tagName`` is ``null`` or ``"*"``, all elements will be searched
|
||||
for the matching class.
|
||||
|
||||
If ``className`` is ``null``, all elements matching the provided tag are
|
||||
returned.
|
||||
|
||||
|
||||
:mochidef:`getNodeAttribute(node, attr)`:
|
||||
|
||||
Get the value of the given attribute for a DOM element without
|
||||
ever raising an exception (will return ``null`` on exception).
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to update (if a string is given,
|
||||
:mochiref:`getElement(node)` will be used to locate the node)
|
||||
|
||||
``attr``:
|
||||
The name of the attribute
|
||||
|
||||
Note that it will do the right thing for IE, so don't do
|
||||
the ``class`` -> ``className`` hack yourself.
|
||||
|
||||
*returns*:
|
||||
The attribute's value, or ``null``
|
||||
|
||||
|
||||
:mochidef:`getViewportDimensions()`:
|
||||
|
||||
Return the pixel width and height of the viewport as an object with ``w``
|
||||
and ``h`` properties. ``element`` is looked up with
|
||||
:mochiref:`getElement`, so string identifiers are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`hasElementClass(element, className[, ...])`:
|
||||
|
||||
Return ``true`` if ``className`` is found on the ``element``.
|
||||
``element`` is looked up with :mochiref:`getElement`, so string identifiers
|
||||
are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`hideElement(element, ...)`:
|
||||
|
||||
Partial form of :mochiref:`setDisplayForElement`, specifically::
|
||||
|
||||
partial(setDisplayForElement, "none")
|
||||
|
||||
For information about the caveats of using a ``style.display`` based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
`Element Visibility`_.
|
||||
|
||||
|
||||
:mochidef:`registerDOMConverter(name, check, wrap[, override])`:
|
||||
|
||||
Register an adapter to convert objects that match ``check(obj, ctx)``
|
||||
to a DOM element, or something that can be converted to a DOM
|
||||
element (i.e. number, bool, string, function, iterable).
|
||||
|
||||
|
||||
:mochidef:`removeElement(node)`:
|
||||
|
||||
Remove and return ``node`` from a DOM tree. This is technically
|
||||
just a convenience for :mochiref:`swapDOM(node, null)`.
|
||||
|
||||
``node``:
|
||||
the DOM element (or string id of one) to be removed
|
||||
|
||||
*returns*
|
||||
The removed element
|
||||
|
||||
|
||||
:mochidef:`removeElementClass(element, className)`:
|
||||
|
||||
Ensure that the given ``element`` does not have ``className`` set as part
|
||||
of its class attribute. This will not disturb other class names.
|
||||
``element`` is looked up with :mochiref:`getElement`, so string identifiers
|
||||
are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`replaceChildNodes(node[, childNode[, ...]])`:
|
||||
|
||||
Remove all children from the given DOM element, then append any given
|
||||
childNodes to it (by calling :mochiref:`appendChildNodes`).
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to add children to
|
||||
(if a string is given, :mochiref:`getElement(node)`
|
||||
will be used to locate the node)
|
||||
|
||||
``childNode``...:
|
||||
All additional arguments, if any, will be coerced into DOM
|
||||
nodes that are appended as children using the
|
||||
`DOM Coercion Rules`_.
|
||||
|
||||
*returns*:
|
||||
The given DOM element
|
||||
|
||||
|
||||
:mochidef:`scrapeText(node[, asArray=false])`:
|
||||
|
||||
Walk a DOM tree in-order and scrape all of the text out of it as a
|
||||
``string``.
|
||||
|
||||
If ``asArray`` is ``true``, then an ``Array`` will be returned with
|
||||
each individual text node. These two are equivalent::
|
||||
|
||||
assert( scrapeText(node) == scrapeText(node, true).join("") );
|
||||
|
||||
|
||||
:mochidef:`setDisplayForElement(display, element[, ...])`:
|
||||
|
||||
Change the ``style.display`` for the given element(s). Usually
|
||||
used as the partial forms:
|
||||
|
||||
- :mochiref:`showElement(element, ...)`
|
||||
- :mochiref:`hideElement(element, ...)`
|
||||
|
||||
Elements are looked up with :mochiref:`getElement`, so string identifiers
|
||||
are acceptable.
|
||||
|
||||
For information about the caveats of using a ``style.display`` based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
`Element Visibility`_.
|
||||
|
||||
|
||||
:mochidef:`setElementClass(element, className)`:
|
||||
|
||||
Set the entire class attribute of ``element`` to ``className``.
|
||||
``element`` is looked up with :mochiref:`getElement`, so string identifiers
|
||||
are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`setElementDimensions(element, dimensions[, units='px'])`:
|
||||
|
||||
Sets the dimensions of ``element`` in the document from an
|
||||
object with ``w`` and ``h`` properties.
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to update (if a string is given,
|
||||
:mochiref:`getElement(node)` will be used to locate the node)
|
||||
|
||||
``dimensions``:
|
||||
An object with ``w`` and ``h`` properties
|
||||
|
||||
``units``:
|
||||
Optionally set the units to use, default is ``px``
|
||||
|
||||
|
||||
:mochidef:`setElementPosition(element, position[, units='px'])`:
|
||||
|
||||
Sets the absolute position of ``element`` in the document from an
|
||||
object with ``x`` and ``y`` properties.
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to update (if a string is given,
|
||||
:mochiref:`getElement(node)` will be used to locate the node)
|
||||
|
||||
``position``:
|
||||
An object with ``x`` and ``y`` properties
|
||||
|
||||
``units``:
|
||||
Optionally set the units to use, default is ``px``
|
||||
|
||||
|
||||
:mochidef:`setNodeAttribute(node, attr, value)`:
|
||||
|
||||
Set the value of the given attribute for a DOM element without
|
||||
ever raising an exception (will return null on exception). If
|
||||
setting more than one attribute, you should use
|
||||
:mochiref:`updateNodeAttributes`.
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to update (if a string is given,
|
||||
:mochiref:`getElement(node)` will be used to locate the node)
|
||||
|
||||
``attr``:
|
||||
The name of the attribute
|
||||
|
||||
Note that it will do the right thing for IE, so don't do
|
||||
the ``class`` -> ``className`` hack yourself.
|
||||
|
||||
``value``:
|
||||
The value of the attribute, may be an object to be merged
|
||||
(e.g. for setting style).
|
||||
|
||||
*returns*:
|
||||
The given DOM element or ``null`` on failure
|
||||
|
||||
|
||||
:mochidef:`setOpacity(element, opacity)`:
|
||||
|
||||
Sets ``opacity`` for ``element``. Valid ``opacity`` values range from 0
|
||||
(invisible) to 1 (opaque). ``element`` is looked up with
|
||||
:mochiref:`getElement`, so string identifiers are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`showElement(element, ...)`:
|
||||
|
||||
Partial form of :mochiref:`setDisplayForElement`, specifically::
|
||||
|
||||
partial(setDisplayForElement, "block")
|
||||
|
||||
For information about the caveats of using a ``style.display`` based
|
||||
show/hide mechanism, and a CSS based alternative, see
|
||||
`Element Visibility`_.
|
||||
|
||||
|
||||
:mochidef:`swapDOM(dest, src)`:
|
||||
|
||||
Replace ``dest`` in a DOM tree with ``src``, returning ``src``.
|
||||
|
||||
``dest``:
|
||||
a DOM element (or string id of one) to be replaced
|
||||
|
||||
``src``:
|
||||
the DOM element (or string id of one) to replace it with, or
|
||||
``null`` if ``dest`` is to be removed (replaced with nothing).
|
||||
|
||||
*returns*:
|
||||
a DOM element (``src``)
|
||||
|
||||
|
||||
:mochidef:`swapElementClass(element, fromClass, toClass)`:
|
||||
|
||||
If ``fromClass`` is set on ``element``, replace it with ``toClass``.
|
||||
This will not disturb other classes on that element.
|
||||
``element`` is looked up with :mochiref:`getElement`, so string identifiers
|
||||
are also acceptable.
|
||||
|
||||
|
||||
:mochidef:`toggleElementClass(className[, element[, ...]])`:
|
||||
|
||||
Toggle the presence of a given ``className`` in the class attribute
|
||||
of all given elements. All elements will be looked up with
|
||||
:mochiref:`getElement`, so string identifiers are acceptable.
|
||||
|
||||
|
||||
:mochidef:`toHTML(dom)`:
|
||||
|
||||
Convert a DOM tree to a HTML string using :mochiref:`emitHTML`
|
||||
|
||||
|
||||
:mochidef:`updateNodeAttributes(node, attrs)`:
|
||||
|
||||
Update the attributes of a DOM element from a given object.
|
||||
|
||||
``node``:
|
||||
A reference to the DOM element to update (if a string is given,
|
||||
:mochiref:`getElement(node)` will be used to locate the node)
|
||||
|
||||
``attrs``:
|
||||
An object whose properties will be used to set the attributes
|
||||
(e.g. ``{'class': 'invisible'}``), or ``null`` if no
|
||||
attributes need to be set. If an object is given for the
|
||||
attribute value (e.g. ``{'style': {'display': 'block'}}``)
|
||||
then :mochiref:`MochiKit.Base.updatetree` will be used to set that
|
||||
attribute.
|
||||
|
||||
Note that it will do the right thing for IE, so don't do
|
||||
the ``class`` -> ``className`` hack yourself, and it deals with
|
||||
setting "on..." event handlers correctly.
|
||||
|
||||
*returns*:
|
||||
The given DOM element
|
||||
|
||||
|
||||
:mochidef:`withWindow(win, func)`:
|
||||
|
||||
Call ``func`` with the ``window`` `DOM Context`_ set to ``win`` and
|
||||
the ``document`` `DOM Context`_ set to ``win.document``. When
|
||||
``func()`` returns or throws an error, the `DOM Context`_ will be
|
||||
restored to its previous state.
|
||||
|
||||
The return value of ``func()`` is returned by this function.
|
||||
|
||||
|
||||
:mochidef:`withDocument(doc, func)`:
|
||||
|
||||
Call ``func`` with the ``doc`` `DOM Context`_ set to ``doc``.
|
||||
When ``func()`` returns or throws an error, the `DOM Context`_
|
||||
will be restored to its previous state.
|
||||
|
||||
The return value of ``func()`` is returned by this function.
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] Nevow, a web application construction kit for Python: http://nevow.com/
|
||||
.. [2] nevow.stan is a domain specific language for Python
|
||||
(read as "crazy getitem/call overloading abuse") that Donovan and I
|
||||
schemed up at PyCon 2003 at this super ninja Python/C++ programmer's
|
||||
(David Abrahams) hotel room. Donovan later inflicted this upon the
|
||||
masses in Nevow. Check out the Divmod project page for some
|
||||
examples: http://nevow.com/Nevow2004Tutorial.html
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,118 @@
|
||||
.. title:: MochiKit.DateTime - "what time is it anyway?"
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.DateTime - "what time is it anyway?"
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
stringDate = toISOTimestamp(new Date());
|
||||
dateObject = isoTimestamp(stringDate);
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Remote servers don't give you JavaScript Date objects, and they certainly
|
||||
don't want them from you, so you need to deal with string representations
|
||||
of dates and timestamps. MochiKit.Date does that.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
None.
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`isoDate(str)`:
|
||||
|
||||
Convert an ISO 8601 date (YYYY-MM-DD) to a ``Date`` object.
|
||||
|
||||
|
||||
:mochidef:`isoTimestamp(str)`:
|
||||
|
||||
Convert any ISO 8601 [1]_ timestamp (or something reasonably close to it)
|
||||
to a ``Date`` object. Will accept the "de facto" form:
|
||||
|
||||
YYYY-MM-DD hh:mm:ss
|
||||
|
||||
or (the proper form):
|
||||
|
||||
YYYY-MM-DDThh:mm:ssZ
|
||||
|
||||
If a time zone designator ("Z" or "[+-]HH:MM") is not present, then the
|
||||
local timezone is used.
|
||||
|
||||
|
||||
:mochidef:`toISOTime(date)`:
|
||||
|
||||
Convert a ``Date`` object to a string in the form of hh:mm:ss
|
||||
|
||||
|
||||
:mochidef:`toISOTimestamp(date, realISO=false)`:
|
||||
|
||||
Convert a ``Date`` object to something that's ALMOST but not quite an
|
||||
ISO 8601 [1]_timestamp. If it was a proper ISO timestamp it would be:
|
||||
|
||||
YYYY-MM-DDThh:mm:ssZ
|
||||
|
||||
However, we see junk in SQL and other places that looks like this:
|
||||
|
||||
YYYY-MM-DD hh:mm:ss
|
||||
|
||||
So, this function returns the latter form, despite its name, unless
|
||||
you pass ``true`` for ``realISO``.
|
||||
|
||||
|
||||
:mochidef:`toISODate(date)`:
|
||||
|
||||
Convert a ``Date`` object to an ISO 8601 [1]_ date string (YYYY-MM-DD)
|
||||
|
||||
|
||||
:mochidef:`americanDate(str)`:
|
||||
|
||||
Converts a MM/DD/YYYY date to a ``Date`` object
|
||||
|
||||
|
||||
:mochidef:`toPaddedAmericanDate(date)`:
|
||||
|
||||
Converts a ``Date`` object to an MM/DD/YYYY date, e.g. 01/01/2001
|
||||
|
||||
|
||||
:mochidef:`toAmericanDate(date)`:
|
||||
|
||||
Converts a ``Date`` object to an M/D/YYYY date, e.g. 1/1/2001
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] W3C profile of ISO 8601: http://www.w3.org/TR/NOTE-datetime
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,211 @@
|
||||
.. title:: MochiKit.Format - string formatting goes here
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Format - string formatting goes here
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
assert( truncToFixed(0.12345, 4) == "0.1234" );
|
||||
assert( roundToFixed(0.12345, 4) == "0.1235" );
|
||||
assert( twoDigitAverage(1, 0) == "0" );
|
||||
assert( twoDigitFloat(1.2345) == "1.23" );
|
||||
assert( twoDigitFloat(1) == "1" );
|
||||
assert( percentFormat(1.234567) == "123.46%" );
|
||||
assert( numberFormatter("###,###%")(125) == "12,500%" );
|
||||
assert( numberFormatter("##.000")(1.25) == "1.250" );
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Formatting strings and stringifying numbers is boring, so a couple useful
|
||||
functions in that domain live here.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
None.
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Formatting Numbers
|
||||
------------------
|
||||
|
||||
MochiKit provides an extensible number formatting facility, modeled loosely
|
||||
after the Number Format Pattern Syntax [1]_ from Java.
|
||||
:mochiref:`numberFormatter(pattern[, placeholder=""[, locale="default"])`
|
||||
returns a function that converts Number to string using the given information.
|
||||
``pattern`` is a string consisting of the following symbols:
|
||||
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| Symbol | Meaning |
|
||||
+===========+===============================================================+
|
||||
| ``-`` | If given, used as the position of the minus sign |
|
||||
| | for negative numbers. If not given, the position |
|
||||
| | to the left of the first number placeholder is used. |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| ``#`` | The placeholder for a number that does not imply zero |
|
||||
| | padding. |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| ``0`` | The placeholder for a number that implies zero padding. |
|
||||
| | If it is used to the right of a decimal separator, it |
|
||||
| | implies trailing zeros, otherwise leading zeros. |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| ``,`` | The placeholder for a "thousands separator". May be used |
|
||||
| | at most once, and it must be to the left of a decimal |
|
||||
| | separator. Will be replaced by ``locale.separator`` in the |
|
||||
| | result (the default is also ``,``). |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| ``.`` | The decimal separator. The quantity of ``#`` or ``0`` |
|
||||
| | after the decimal separator will determine the precision of |
|
||||
| | the result. If no decimal separator is present, the |
|
||||
| | fractional precision is ``0`` -- meaning that it will be |
|
||||
| | rounded to the nearest integer. |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
| ``%`` | If present, the number will be multiplied by ``100`` and |
|
||||
| | the ``%`` will be replaced by ``locale.percent``. |
|
||||
+-----------+---------------------------------------------------------------+
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`formatLocale(locale="default")`:
|
||||
|
||||
Return a locale object for the given locale. ``locale`` may be either a
|
||||
string, which is looked up in the ``MochiKit.Format.LOCALE`` object, or
|
||||
a locale object. If no locale is given, ``LOCALE.default`` is used
|
||||
(equivalent to ``LOCALE.en_US``).
|
||||
|
||||
|
||||
:mochidef:`lstrip(str, chars="\\s")`:
|
||||
|
||||
Returns a string based on ``str`` with leading whitespace stripped.
|
||||
|
||||
If ``chars`` is given, then that expression will be used instead of
|
||||
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
|
||||
``[character set]``.
|
||||
|
||||
|
||||
:mochidef:`numberFormatter(pattern, placeholder="", locale="default")`:
|
||||
|
||||
Return a function ``formatNumber(aNumber)`` that formats numbers
|
||||
as a string according to the given pattern, placeholder and locale.
|
||||
|
||||
``pattern`` is a string that describes how the numbers should be formatted,
|
||||
for more information see `Formatting Numbers`_.
|
||||
|
||||
``locale`` is a string of a known locale (en_US, de_DE, fr_FR, default) or
|
||||
an object with the following fields:
|
||||
|
||||
+-----------+-----------------------------------------------------------+
|
||||
| separator | The "thousands" separator for this locale (en_US is ",") |
|
||||
+-----------+-----------------------------------------------------------+
|
||||
| decimal | The decimal separator for this locale (en_US is ".") |
|
||||
+-----------+-----------------------------------------------------------+
|
||||
| percent | The percent symbol for this locale (en_US is "%") |
|
||||
+-----------+-----------------------------------------------------------+
|
||||
|
||||
|
||||
:mochidef:`percentFormat(someFloat)`:
|
||||
|
||||
Roughly equivalent to: ``sprintf("%.2f%%", someFloat * 100)``
|
||||
|
||||
In new code, you probably want to use:
|
||||
:mochiref:`numberFormatter("#.##%")(someFloat)` instead.
|
||||
|
||||
|
||||
:mochidef:`roundToFixed(aNumber, precision)`:
|
||||
|
||||
Return a string representation of ``aNumber``, rounded to ``precision``
|
||||
digits with trailing zeros. This is similar to
|
||||
``Number.toFixed(aNumber, precision)``, but this has implementation
|
||||
consistent rounding behavior (some versions of Safari round 0.5 down!)
|
||||
and also includes preceding ``0`` for numbers less than ``1`` (Safari,
|
||||
again).
|
||||
|
||||
For example, :mochiref:`roundToFixed(0.1357, 2)` returns ``0.14`` on every
|
||||
supported platform, where some return ``.13`` for ``(0.1357).toFixed(2)``.
|
||||
|
||||
|
||||
:mochidef:`rstrip(str, chars="\\s")`:
|
||||
|
||||
Returns a string based on ``str`` with trailing whitespace stripped.
|
||||
|
||||
If ``chars`` is given, then that expression will be used instead of
|
||||
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
|
||||
``[character set]``.
|
||||
|
||||
|
||||
:mochidef:`strip(str, chars="\\s")`:
|
||||
|
||||
Returns a string based on ``str`` with leading and trailing whitespace
|
||||
stripped (equivalent to :mochiref:`lstrip(rstrip(str, chars), chars)`).
|
||||
|
||||
If ``chars`` is given, then that expression will be used instead of
|
||||
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
|
||||
``[character set]``.
|
||||
|
||||
|
||||
:mochidef:`truncToFixed(aNumber, precision)`:
|
||||
|
||||
Return a string representation of ``aNumber``, truncated to ``precision``
|
||||
digits with trailing zeros. This is similar to
|
||||
``aNumber.toFixed(precision)``, but this truncates rather than rounds and
|
||||
has implementation consistent behavior for numbers less than 1.
|
||||
Specifically, :mochiref:`truncToFixed(aNumber, precision)` will always have a
|
||||
preceding ``0`` for numbers less than ``1``.
|
||||
|
||||
For example, :mochiref:`toFixed(0.1357, 2)` returns ``0.13``.
|
||||
|
||||
|
||||
:mochidef:`twoDigitAverage(numerator, denominator)`:
|
||||
|
||||
Calculate an average from a numerator and a denominator and return
|
||||
it as a string with two digits of precision (e.g. "1.23").
|
||||
|
||||
If the denominator is 0, "0" will be returned instead of ``NaN``.
|
||||
|
||||
|
||||
:mochidef:`twoDigitFloat(someFloat)`:
|
||||
|
||||
Roughly equivalent to: ``sprintf("%.2f", someFloat)``
|
||||
|
||||
In new code, you probably want to use
|
||||
:mochiref:`numberFormatter("#.##")(someFloat)` instead.
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] Java Number Format Pattern Syntax:
|
||||
http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,345 @@
|
||||
.. title:: MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
|
||||
theSum = sum(takewhile(
|
||||
partial(operator.gt, 10),
|
||||
imap(
|
||||
partial(operator.mul, 2),
|
||||
count()
|
||||
)
|
||||
)
|
||||
));
|
||||
|
||||
assert( theSum == (0 + 0 + 2 + 4 + 6 + 8) );
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
All of the functional programming missing from :mochiref:`MochiKit.Base` lives
|
||||
here. The functionality in this module is largely inspired by Python's iteration
|
||||
protocol [1]_, and the itertools module [2]_.
|
||||
|
||||
MochiKit.Iter defines a standard way to iterate over anything, that you can
|
||||
extend with :mochiref:`registerIterator`, or by implementing the ``.iter()``
|
||||
protocol. Iterators are lazy, so it can potentially be cheaper to build a
|
||||
filter chain of iterators than to build lots of intermediate arrays.
|
||||
Especially when the data set is very large, but the result is not.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Iteration for JavaScript
|
||||
------------------------
|
||||
|
||||
The best overview right now is in my Iteration for JavaScript [3]_ blog entry.
|
||||
This information will migrate here eventually.
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Errors
|
||||
------
|
||||
|
||||
:mochidef:`StopIteration`:
|
||||
|
||||
The singleton :mochiref:`MochiKit.Base.NamedError` that signifies the end
|
||||
of an iterator
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`applymap(fun, seq[, self])`:
|
||||
|
||||
``applymap(fun, seq)`` -->
|
||||
fun.apply(self, seq0), fun.apply(self, seq1), ...
|
||||
|
||||
|
||||
:mochidef:`chain(p, q[, ...])`:
|
||||
|
||||
``chain(p, q, ...)`` --> p0, p1, ... plast, q0, q1, ...
|
||||
|
||||
|
||||
:mochidef:`count(n=0)`:
|
||||
|
||||
``count(n=0)`` --> n, n + 1, n + 2, ...
|
||||
|
||||
|
||||
:mochidef:`cycle(p)`:
|
||||
|
||||
``cycle(p)`` --> p0, p1, ... plast, p0, p1, ...
|
||||
|
||||
|
||||
:mochidef:`dropwhile(pred, seq)`:
|
||||
|
||||
``dropwhile(pred, seq)`` --> seq[n], seq[n + 1], starting when
|
||||
pred(seq[n]) fails
|
||||
|
||||
|
||||
:mochidef:`every(iterable, func)`:
|
||||
|
||||
Return ``true`` if ``func(item)`` is ``true`` for every item in
|
||||
``iterable``.
|
||||
|
||||
|
||||
:mochidef:`exhaust(iterable)`:
|
||||
|
||||
Exhausts an iterable without saving the results anywhere,
|
||||
like :mochiref:`list(iterable)` when you don't care what the output is.
|
||||
|
||||
|
||||
:mochidef:`forEach(iterable, func[, self])`:
|
||||
|
||||
Call ``func`` for each item in ``iterable``, and don't save the results.
|
||||
|
||||
|
||||
:mochidef:`groupby(iterable[, keyfunc])`:
|
||||
|
||||
Make an iterator that returns consecutive keys and groups from the
|
||||
iterable. The key is a function computing a key value for each element.
|
||||
If not specified or is None, key defaults to an identity function and
|
||||
returns the element unchanged. Generally, the iterable needs to already be
|
||||
sorted on the same key function.
|
||||
|
||||
The returned group is itself an iterator that shares the underlying
|
||||
iterable with :mochiref:`groupby()`. Because the source is shared, when the
|
||||
groupby object is advanced, the previous group is no longer visible.
|
||||
So, if that data is needed later, it should be stored as an array::
|
||||
|
||||
var groups = [];
|
||||
var uniquekeys = [];
|
||||
forEach(groupby(data, keyfunc), function (key_group) {
|
||||
groups.push(list(key_group[1]));
|
||||
uniquekeys.push(key_group[0]);
|
||||
});
|
||||
|
||||
As a convenience, :mochiref:`groupby_as_array()` is provided to suit the above
|
||||
use case.
|
||||
|
||||
|
||||
:mochidef:`groupby_as_array(iterable[, keyfunc])`:
|
||||
|
||||
Perform the same task as :mochiref:`groupby()`, except return an array of
|
||||
arrays instead of an iterator of iterators.
|
||||
|
||||
|
||||
:mochidef:`iextend(lst, iterable)`:
|
||||
|
||||
Just like :mochiref:`list(iterable)`, except it pushes results on ``lst``
|
||||
rather than creating a new one.
|
||||
|
||||
|
||||
:mochidef:`ifilter(pred, seq)`:
|
||||
|
||||
``ifilter(pred, seq)`` --> elements of seq where ``pred(elem)`` is ``true``
|
||||
|
||||
|
||||
:mochidef:`ifilterfalse(pred, seq)`:
|
||||
|
||||
``ifilterfalse(pred, seq)`` --> elements of seq where ``pred(elem)`` is
|
||||
``false``
|
||||
|
||||
|
||||
:mochidef:`imap(fun, p, q[, ...])`:
|
||||
|
||||
``imap(fun, p, q, ...)`` --> fun(p0, q0, ...), fun(p1, q1, ...), ...
|
||||
|
||||
|
||||
:mochidef:`islice(seq, [start,] stop[, step])`:
|
||||
|
||||
``islice(seq, [start,] stop[, step])`` --> elements from
|
||||
seq[start:stop:step] (in Python slice syntax)
|
||||
|
||||
|
||||
:mochidef:`iter(iterable[, sentinel])`:
|
||||
|
||||
Convert the given argument to an iterator (object implementing
|
||||
``.next()``).
|
||||
|
||||
1. If ``iterable`` is an iterator (implements ``.next()``), then it will
|
||||
be returned as-is.
|
||||
2. If ``iterable`` is an iterator factory (implements ``.iter()``), then
|
||||
the result of ``iterable.iter()`` will be returned.
|
||||
3. Otherwise, the iterator factory :mochiref:`MochiKit.Base.AdapterRegistry`
|
||||
is used to find a match.
|
||||
4. If no factory is found, it will throw ``TypeError``
|
||||
|
||||
Built-in iterator factories are present for Array-like objects, and
|
||||
objects that implement the ``iterateNext`` protocol (e.g. the result of
|
||||
Mozilla's ``document.evaluate``).
|
||||
|
||||
When used directly, using an iterator should look like this::
|
||||
|
||||
var it = iter(iterable);
|
||||
try {
|
||||
while (var o = it.next()) {
|
||||
// use o
|
||||
}
|
||||
} catch (e) {
|
||||
if (e != StopIteration) {
|
||||
throw e;
|
||||
}
|
||||
// pass
|
||||
}
|
||||
|
||||
This is ugly, so you should use the higher order functions to work
|
||||
with iterators whenever possible.
|
||||
|
||||
|
||||
:mochidef:`izip(p, q[, ...])`:
|
||||
|
||||
``izip(p, q, ...)`` --> [p0, q0, ...], [p1, q1, ...], ...
|
||||
|
||||
|
||||
:mochidef:`list(iterable)`:
|
||||
|
||||
Convert ``iterable`` to a new ``Array``
|
||||
|
||||
|
||||
:mochidef:`next(iterator)`:
|
||||
|
||||
Return ``iterator.next()``
|
||||
|
||||
|
||||
:mochidef:`range([start,] stop[, step])`:
|
||||
|
||||
Return an iterator containing an arithmetic progression of integers.
|
||||
|
||||
``range(i, j)`` returns :mochiref:`iter([i, i + 1, i + 2, ..., j - 1])`
|
||||
|
||||
``start`` (!) defaults to ``0``. When ``step`` is given, it specifies the
|
||||
increment (or decrement). The end point is omitted!
|
||||
|
||||
For example, ``range(4)`` returns :mochiref:`iter([0, 1, 2, 3])`.
|
||||
This iterates over exactly the valid indexes for an array of 4 elements.
|
||||
|
||||
|
||||
:mochidef:`reduce(fn, iterable[, initial])`:
|
||||
|
||||
Apply ``fn(a, b)`` cumulatively to the items of an
|
||||
iterable from left to right, so as to reduce the iterable
|
||||
to a single value.
|
||||
|
||||
For example::
|
||||
|
||||
reduce(function (a, b) { return x + y; }, [1, 2, 3, 4, 5])
|
||||
|
||||
calculates::
|
||||
|
||||
((((1 + 2) + 3) + 4) + 5).
|
||||
|
||||
If initial is given, it is placed before the items of the sequence
|
||||
in the calculation, and serves as a default when the sequence is
|
||||
empty.
|
||||
|
||||
Note that the above example could be written more clearly as::
|
||||
|
||||
reduce(operator.add, [1, 2, 3, 4, 5])
|
||||
|
||||
Or even simpler::
|
||||
|
||||
sum([1, 2, 3, 4, 5])
|
||||
|
||||
|
||||
:mochidef:`registerIteratorFactory(name, check, iterfactory[, override])`:
|
||||
|
||||
Register an iterator factory for use with the iter function.
|
||||
|
||||
``check`` is a ``function(a)`` that returns ``true`` if ``a`` can be
|
||||
converted into an iterator with ``iterfactory``.
|
||||
|
||||
``iterfactory`` is a ``function(a)`` that returns an object with a
|
||||
``.next()`` method that returns the next value in the sequence.
|
||||
|
||||
``iterfactory`` is guaranteed to only be called if ``check(a)``
|
||||
returns a true value.
|
||||
|
||||
If ``override`` is ``true``, then it will be made the
|
||||
highest precedence iterator factory. Otherwise, the lowest.
|
||||
|
||||
|
||||
:mochidef:`repeat(elem[, n])`:
|
||||
|
||||
``repeat(elem, [,n])`` --> elem, elem, elem, ... endlessly or up to n times
|
||||
|
||||
|
||||
:mochidef:`reversed(iterable)`:
|
||||
|
||||
Return a reversed array from iterable.
|
||||
|
||||
|
||||
:mochidef:`some(iterable, func)`:
|
||||
|
||||
Return ``true`` if ``func(item)`` is ``true`` for at least one item in
|
||||
``iterable``.
|
||||
|
||||
|
||||
:mochidef:`sorted(iterable[, cmp])`:
|
||||
|
||||
Return a sorted array from iterable.
|
||||
|
||||
|
||||
:mochidef:`sum(iterable, start=0)`:
|
||||
|
||||
Returns the sum of a sequence of numbers plus the value
|
||||
of parameter ``start`` (with a default of 0). When the sequence is
|
||||
empty, returns start.
|
||||
|
||||
Equivalent to::
|
||||
|
||||
reduce(operator.add, iterable, start);
|
||||
|
||||
|
||||
:mochidef:`takewhile(pred, seq)`:
|
||||
|
||||
``takewhile(pred, seq)`` --> seq[0], seq[1], ... until pred(seq[n]) fails
|
||||
|
||||
|
||||
:mochidef:`tee(iterable, n=2)`:
|
||||
|
||||
``tee(it, n=2)`` --> [it1, it2, it3, ... itn] splits one iterator into n
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] The iteration protocol is described in
|
||||
PEP 234 - Iterators: http://www.python.org/peps/pep-0234.html
|
||||
.. [2] Python's itertools
|
||||
module: http://docs.python.org/lib/module-itertools.html
|
||||
.. [3] Iteration in JavaScript: http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,284 @@
|
||||
.. title:: MochiKit.Logging - we're all tired of alert()
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Logging - we're all tired of alert()
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
log("INFO messages are so boring");
|
||||
logDebug("DEBUG messages are even worse");
|
||||
log("good thing I can pass", objects, "conveniently");
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
MochiKit.Logging steals some ideas from Python's logging module [1]_, but
|
||||
completely forgot about the Java [2]_ inspiration. This is a KISS module for
|
||||
logging that provides enough flexibility to do just about anything via
|
||||
listeners, but without all the cruft.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Native Console Logging
|
||||
----------------------
|
||||
|
||||
As of MochiKit 1.3, the default logger will log all messages to your browser's
|
||||
native console. This is currently supported in Safari, Opera 9, and Firefox
|
||||
when the FireBug__ extension is installed.
|
||||
|
||||
.. __: http://www.joehewitt.com/software/firebug/
|
||||
|
||||
To disable this behavior::
|
||||
|
||||
MochiKit.Logging.logger.useNativeLogging = false;
|
||||
|
||||
|
||||
Bookmarklet Based Debugging
|
||||
---------------------------
|
||||
|
||||
JavaScript is at a serious disadvantage without a standard console for
|
||||
"print" statements. Everything else has one. The closest thing that
|
||||
you get in a browser environment is the ``alert`` function, which is
|
||||
absolutely evil.
|
||||
|
||||
This leaves you with one reasonable solution: do your logging in the page
|
||||
somehow. The problem here is that you don't want to clutter the page with
|
||||
debugging tools. The solution to that problem is what we call BBD, or
|
||||
Bookmarklet Based Debugging [3]_.
|
||||
|
||||
Simply create a bookmarklet for `javascript:MochiKit.Logging.logger.debuggingBookmarklet()`__,
|
||||
and whack it whenever you want to see what's in the logger. Of course, this
|
||||
means you must drink the MochiKit.Logging kool-aid. It's tangy and sweet,
|
||||
don't worry.
|
||||
|
||||
.. __: javascript:MochiKit.Logging.logger.debuggingBookmarklet()
|
||||
|
||||
Currently this is an ugly ``alert``, but we'll have something spiffy
|
||||
Real Soon Now, and when we do, you only have to upgrade MochiKit.Logging,
|
||||
not your bookmarklet!
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
:mochidef:`LogMessage(num, level, info)`:
|
||||
|
||||
Properties:
|
||||
|
||||
``num``:
|
||||
Identifier for the log message
|
||||
|
||||
``level``:
|
||||
Level of the log message (``"INFO"``, ``"WARN"``, ``"DEBUG"``,
|
||||
etc.)
|
||||
|
||||
``info``:
|
||||
All other arguments passed to log function as an ``Array``
|
||||
|
||||
``timestamp``:
|
||||
``Date`` object timestamping the log message
|
||||
|
||||
|
||||
:mochidef:`Logger([maxSize])`:
|
||||
|
||||
A basic logger object that has a buffer of recent messages
|
||||
plus a listener dispatch mechanism for "real-time" logging
|
||||
of important messages.
|
||||
|
||||
``maxSize`` is the maximum number of entries in the log.
|
||||
If ``maxSize >= 0``, then the log will not buffer more than that
|
||||
many messages. So if you don't like logging at all, be sure to
|
||||
pass ``0``.
|
||||
|
||||
There is a default logger available named "logger", and several
|
||||
of its methods are also global functions:
|
||||
|
||||
``logger.log`` -> ``log``
|
||||
``logger.debug`` -> ``logDebug``
|
||||
``logger.warning`` -> ``logWarning``
|
||||
``logger.error`` -> ``logError``
|
||||
``logger.fatal`` -> ``logFatal``
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.addListener(ident, filter, listener)`:
|
||||
|
||||
Add a listener for log messages.
|
||||
|
||||
``ident`` is a unique identifier that may be used to remove the listener
|
||||
later on.
|
||||
|
||||
``filter`` can be one of the following:
|
||||
|
||||
``null``:
|
||||
``listener(msg)`` will be called for every log message
|
||||
received.
|
||||
|
||||
``string``:
|
||||
:mochiref:`logLevelAtLeast(filter)` will be used as the function
|
||||
(see below).
|
||||
|
||||
``function``:
|
||||
``filter(msg)`` will be called for every msg, if it returns
|
||||
true then ``listener(msg)`` will be called.
|
||||
|
||||
``listener`` is a function that takes one argument, a log message. A log
|
||||
message is an object (:mochiref:`LogMessage` instance) that has at least these
|
||||
properties:
|
||||
|
||||
``num``:
|
||||
A counter that uniquely identifies a log message (per-logger)
|
||||
|
||||
``level``:
|
||||
A string or number representing the log level. If string, you
|
||||
may want to use ``LogLevel[level]`` for comparison.
|
||||
|
||||
``info``:
|
||||
An Array of objects passed as additional arguments to the ``log``
|
||||
function.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.baseLog(level, message[, ...])`:
|
||||
|
||||
The base functionality behind all of the log functions.
|
||||
The first argument is the log level as a string or number,
|
||||
and all other arguments are used as the info list.
|
||||
|
||||
This function is available partially applied as:
|
||||
|
||||
============== =========
|
||||
Logger.debug 'DEBUG'
|
||||
Logger.log 'INFO'
|
||||
Logger.error 'ERROR'
|
||||
Logger.fatal 'FATAL'
|
||||
Logger.warning 'WARNING'
|
||||
============== =========
|
||||
|
||||
For the default logger, these are also available as global functions,
|
||||
see the :mochiref:`Logger` constructor documentation for more info.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.clear()`:
|
||||
|
||||
Clear all messages from the message buffer.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.debuggingBookmarklet()`:
|
||||
|
||||
Display the contents of the logger in a useful way for browsers.
|
||||
|
||||
Currently, if :mochiref:`MochiKit.LoggingPane` is loaded, then a pop-up
|
||||
:mochiref:`MochiKit.LoggingPane.LoggingPane` will be used. Otherwise,
|
||||
it will be an alert with :mochiref:`Logger.prototype.getMessageText()`.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.dispatchListeners(msg)`:
|
||||
|
||||
Dispatch a log message to all listeners.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.getMessages(howMany)`:
|
||||
|
||||
Return a list of up to ``howMany`` messages from the message buffer.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.getMessageText(howMany)`:
|
||||
|
||||
Get a string representing up to the last ``howMany`` messages in the
|
||||
message buffer. The default is ``30``.
|
||||
|
||||
The message looks like this::
|
||||
|
||||
LAST {messages.length} MESSAGES:
|
||||
[{msg.num}] {msg.level}: {m.info.join(' ')}
|
||||
[{msg.num}] {msg.level}: {m.info.join(' ')}
|
||||
...
|
||||
|
||||
If you want some other format, use
|
||||
:mochiref:`Logger.prototype.getMessages` and do it yourself.
|
||||
|
||||
|
||||
:mochidef:`Logger.prototype.removeListener(ident)`:
|
||||
|
||||
Remove a listener using the ident given to :mochiref:`Logger.prototype.addListener`
|
||||
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`alertListener(msg)`:
|
||||
|
||||
Ultra-obnoxious ``alert(...)`` listener
|
||||
|
||||
|
||||
:mochidef:`logDebug(message[, info[, ...]])`:
|
||||
|
||||
Log an INFO message to the default logger
|
||||
|
||||
|
||||
:mochidef:`logDebug(message[, info[, ...]])`:
|
||||
|
||||
Log a DEBUG message to the default logger
|
||||
|
||||
|
||||
:mochidef:`logError(message[, info[, ...]])`:
|
||||
|
||||
Log an ERROR message to the default logger
|
||||
|
||||
|
||||
:mochidef:`logFatal(message[, info[, ...]])`:
|
||||
|
||||
Log a FATAL message to the default logger
|
||||
|
||||
|
||||
:mochidef:`logLevelAtLeast(minLevel)`:
|
||||
|
||||
Return a function that will match log messages whose level
|
||||
is at least minLevel
|
||||
|
||||
|
||||
:mochidef:`logWarning(message[, info[, ...]])`:
|
||||
|
||||
Log a WARNING message to the default logger
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] Python's logging module: http://docs.python.org/lib/module-logging.html
|
||||
.. [2] PEP 282, where they admit all of the Java influence: http://www.python.org/peps/pep-0282.html
|
||||
.. [3] Original Bookmarklet Based Debugging blather: http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,114 @@
|
||||
.. title:: MochiKit.LoggingPane - Interactive MochiKit.Logging pane
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.LoggingPane - Interactive MochiKit.Logging pane
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
// open a pop-up window
|
||||
createLoggingPane()
|
||||
// use a div at the bottom of the document
|
||||
createLoggingPane(true);
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
MochiKit.Logging does not have any browser dependencies and is completely
|
||||
unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane
|
||||
for your :mochiref:`MochiKit.Logging` output that can be used as a pop-up or
|
||||
inline.
|
||||
|
||||
It also allows for regex and level filtering! MochiKit.LoggingPane is used
|
||||
as the default :mochiref:`MochiKit.Logging.debuggingBookmarklet()` if it is
|
||||
loaded.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
- :mochiref:`MochiKit.Logging`
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
:mochidef:`LoggingPane(inline=false, logger=MochiKit.Logging.logger)`:
|
||||
|
||||
A listener for a :mochiref:`MochiKit.Logging` logger with an interactive
|
||||
DOM representation.
|
||||
|
||||
If ``inline`` is ``true``, then the ``LoggingPane`` will be a ``DIV``
|
||||
at the bottom of the document. Otherwise, it will be in a pop-up
|
||||
window with a name based on the calling page's URL. If there is an
|
||||
element in the document with an id of ``_MochiKit_LoggingPane``,
|
||||
it will be used instead of appending a new ``DIV`` to the body.
|
||||
|
||||
``logger`` is the reference to the :mochiref:`MochiKit.Logging.Logger` to
|
||||
listen to. If not specified, the global default logger is used.
|
||||
|
||||
Properties:
|
||||
|
||||
``win``:
|
||||
Reference to the pop-up window (``undefined`` if ``inline``)
|
||||
|
||||
``inline``:
|
||||
``true`` if the ``LoggingPane`` is inline
|
||||
|
||||
``colorTable``:
|
||||
An object with property->value mappings for each log level
|
||||
and its color. May also be mutated on ``LoggingPane.prototype``
|
||||
to affect all instances. For example::
|
||||
|
||||
MochiKit.LoggingPane.LoggingPane.prototype.colorTable = {
|
||||
DEBUG: "green",
|
||||
INFO: "black",
|
||||
WARNING: "blue",
|
||||
ERROR: "red",
|
||||
FATAL: "darkred"
|
||||
};
|
||||
|
||||
|
||||
:mochidef:`LoggingPane.prototype.closePane()`:
|
||||
|
||||
Close the :mochiref:`LoggingPane` (close the child window, or
|
||||
remove the ``_MochiKit_LoggingPane`` ``DIV`` from the document).
|
||||
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
|
||||
:mochidef:`createLoggingPane(inline=false)`:
|
||||
|
||||
Create or return an existing :mochiref:`LoggingPane` for this document
|
||||
with the given inline setting. This is preferred over using
|
||||
:mochiref:`LoggingPane` directly, as only one :mochiref:`LoggingPane`
|
||||
should be present in a given document.
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,349 @@
|
||||
.. title:: MochiKit.Signal - Simple universal event handling
|
||||
.. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
|
||||
:trim:
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Signal - Simple universal event handling
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
Signal for DOM events::
|
||||
|
||||
// DOM events are also signals. Connect freely! The functions will be
|
||||
// called with the custom event as a parameter.
|
||||
|
||||
// calls myClicked.apply(getElement('myID'), event)
|
||||
connect('myID', 'onclick', myClicked);
|
||||
|
||||
// calls wasClicked.apply(myObject, event)
|
||||
connect('myID', 'onclick', myObject, wasClicked);
|
||||
|
||||
// calls myObject.wasClicked(event)
|
||||
connect('myID', 'onclick', myObject, 'wasClicked');
|
||||
|
||||
// the event is normalized, no more e = e || window.event!
|
||||
myObject.wasClicked = function(e) {
|
||||
var crossBrowserCoordinates = e.mouse().page;
|
||||
// e.mouse().page is a MochiKit.DOM.Coordinates object
|
||||
}
|
||||
|
||||
|
||||
Signal for non-DOM events::
|
||||
|
||||
// otherObject.gotFlash() will be called when 'flash' signalled.
|
||||
connect(myObject, 'flash', otherObject, 'gotFlash');
|
||||
|
||||
// gotBang.apply(otherObject) will be called when 'bang' signalled.
|
||||
// You can access otherObject from within gotBang as 'this'.
|
||||
connect(myObject, 'bang', otherObject, gotBang);
|
||||
|
||||
// myFunc.apply(myObject) will be called when 'flash' signalled.
|
||||
// You can access myObject from within myFunc as 'this'.
|
||||
var ident = connect(myObject, 'flash', myFunc);
|
||||
|
||||
// You may disconnect with the return value from connect
|
||||
disconnect(ident);
|
||||
|
||||
// Signal can take parameters. These will be passed along to the connected
|
||||
// functions.
|
||||
signal(myObject, 'flash');
|
||||
signal(myObject, 'bang', 'BANG!');
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Event handling was never so easy!
|
||||
|
||||
This module takes care of all the hard work |---| figuring out which event
|
||||
model to use, trying to retrieve the event object, and handling your own
|
||||
internal events, as well as cleanup when the page is unloaded to clean up IE's
|
||||
nasty memory leakage.
|
||||
|
||||
This event system is largely based on Qt's signal/slot system. Read more on
|
||||
how that is handled and also how it is used in model/view programming at:
|
||||
http://doc.trolltech.com/
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
- :mochiref:`MochiKit.DOM`
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Using Signal for DOM Events
|
||||
---------------------------
|
||||
|
||||
When using MochiKit.Signal, do not use the browser's native event API. That
|
||||
means, no ``onclick="blah"``, no ``elem.addEventListener(...)``, and certainly
|
||||
no ``elem.attachEvent(...)``. This also means that
|
||||
:mochiref:`MochiKit.DOM.addToCallStack` and
|
||||
:mochiref:`MochiKit.DOM.addLoadEvent` should not be used in combination with
|
||||
this module.
|
||||
|
||||
Signals for DOM objects are named with the ``'on'`` prefix, e.g.:
|
||||
``'onclick'``, ``'onkeyup'``, etc.
|
||||
|
||||
When the signal fires, your slot will be called with one parameter, the custom
|
||||
event object.
|
||||
|
||||
|
||||
Custom Event Objects for DOM events
|
||||
-----------------------------------
|
||||
|
||||
Signals triggered by DOM events are called with a custom event object as a
|
||||
parameter. The custom event object presents a consistent view of the event
|
||||
across all supported platforms and browsers, and provides many conveniences
|
||||
not available even in a correct W3C implementation.
|
||||
|
||||
See the `DOM Custom Event Object Reference`_ for a detailed API description
|
||||
of this object.
|
||||
|
||||
If you find that you're accessing the native event for any reason, create a
|
||||
`new ticket`_ and we'll look into normalizing the behavior you're looking for.
|
||||
|
||||
.. _`new ticket`: http://trac.mochikit.com/newticket
|
||||
.. _`Safari bug 6595`: http://bugzilla.opendarwin.org/show_bug.cgi?id=6595
|
||||
.. _`Safari bug 7790`: http://bugzilla.opendarwin.org/show_bug.cgi?id=7790
|
||||
|
||||
|
||||
Memory Usage
|
||||
------------
|
||||
|
||||
Any object that has connected slots (via :mochiref:`connect()`) is referenced
|
||||
by the Signal mechanism until it is disconnected via :mochiref:`disconnect()`
|
||||
or :mochiref:`disconnectAll()`.
|
||||
|
||||
Signal does not leak. It registers an ``'onunload'`` event that disconnects all
|
||||
objects on the page when the browser leaves the page. However, memory usage
|
||||
will grow during the page view for every connection made until it is
|
||||
disconnected. Even if the DOM object is removed from the document, it
|
||||
will still be referenced by Signal until it is explicitly disconnected.
|
||||
|
||||
In order to conserve memory during the page view, :mochiref:`disconnectAll()`
|
||||
any DOM elements that are about to be removed from the document.
|
||||
|
||||
|
||||
Using Signal for non-DOM objects
|
||||
--------------------------------
|
||||
|
||||
Signals are triggered with the :mochiref:`signal(src, 'signal', ...)`
|
||||
function. Additional parameters passed to this are passed onto the
|
||||
connected slots. Explicit signals are not required for DOM events.
|
||||
|
||||
Slots that are connected to a signal are called in the following manner
|
||||
when that signal is signalled:
|
||||
|
||||
- If the slot was a single function, then it is called with ``this`` set
|
||||
to the object originating the signal with whatever parameters it was
|
||||
signalled with.
|
||||
|
||||
- If the slot was an object and a function, then it is called with
|
||||
``this`` set to the object, and with whatever parameters it was
|
||||
signalled with.
|
||||
|
||||
- If the slot was an object and a string, then ``object[string]`` is
|
||||
called with the parameters to the signal.
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
|
||||
Signal API Reference
|
||||
--------------------
|
||||
|
||||
:mochidef:`connect(src, signal, dest[, func])`:
|
||||
|
||||
Connects a signal to a slot, and return a unique identifier that can be
|
||||
used to disconnect that signal.
|
||||
|
||||
``src`` is the object that has the signal. You may pass in a string, in
|
||||
which case, it is interpreted as an id for an HTML element.
|
||||
|
||||
``signal`` is a string that represents a signal name. If 'src' is an HTML
|
||||
Element, ``window``, or the ``document``, then it can be one of the
|
||||
'on-XYZ' events. You must include the 'on' prefix, and it must be all
|
||||
lower-case.
|
||||
|
||||
``dest`` and ``func`` describe the slot, or the action to take when the
|
||||
signal is triggered.
|
||||
|
||||
- If ``dest`` is an object and ``func`` is a string, then
|
||||
``dest[func].apply(dest, ...)`` will be called when the signal
|
||||
is signalled.
|
||||
|
||||
- If ``dest`` is an object and ``func`` is a function, then
|
||||
``func.apply(dest, ...)`` will be called when the signal is
|
||||
signalled.
|
||||
|
||||
- If ``func`` is undefined and ``dest`` is a function, then
|
||||
``func.apply(src, ...)`` will be called when the signal is
|
||||
signalled.
|
||||
|
||||
No other combinations are allowed and will raise an exception.
|
||||
|
||||
The return value can be passed to :mochiref:`disconnect` to disconnect
|
||||
the signal.
|
||||
|
||||
|
||||
:mochidef:`disconnect(ident)`:
|
||||
|
||||
To disconnect a signal, pass its ident returned by :mochiref:`connect()`.
|
||||
This is similar to how the browser's ``setTimeout`` and ``clearTimeout``
|
||||
works.
|
||||
|
||||
|
||||
:mochidef:`disconnectAll(src[, signal, ...])`:
|
||||
|
||||
``disconnectAll(src)`` removes all signals from src.
|
||||
|
||||
``disconnectAll(src, 'onmousedown', 'mySignal')`` will remove all
|
||||
``'onmousedown'`` and ``'mySignal'`` signals from src.
|
||||
|
||||
|
||||
|
||||
:mochidef:`signal(src, signal, ...)`:
|
||||
|
||||
This will signal a signal, passing whatever additional parameters on to
|
||||
the connected slots. ``src`` and ``signal`` are the same as for
|
||||
:mochiref:`connect()`.
|
||||
|
||||
|
||||
DOM Custom Event Object Reference
|
||||
---------------------------------
|
||||
|
||||
:mochidef:`event()`:
|
||||
|
||||
The native event produced by the browser. You should not need to use this.
|
||||
|
||||
|
||||
:mochidef:`src()`:
|
||||
|
||||
The element that this signal is connected to.
|
||||
|
||||
|
||||
:mochidef:`type()`:
|
||||
|
||||
The event type (``'click'``, ``'mouseover'``, ``'keypress'``, etc.) as a
|
||||
string. Does not include the ``'on'`` prefix.
|
||||
|
||||
|
||||
:mochidef:`target()`:
|
||||
|
||||
The element that triggered the event. This may be a child of
|
||||
:mochiref:`src()`.
|
||||
|
||||
|
||||
:mochidef:`modifier()`:
|
||||
|
||||
Returns ``{shift, ctrl, meta, alt, any}``, where each property is ``true``
|
||||
if its respective modifier key was pressed, ``false`` otherwise. ``any``
|
||||
is ``true`` if any modifier is pressed, ``false`` otherwise.
|
||||
|
||||
|
||||
:mochidef:`stopPropagation()`:
|
||||
|
||||
Works like W3C's ``stopPropagation()``.
|
||||
|
||||
|
||||
:mochidef:`preventDefault()`:
|
||||
|
||||
Works like W3C's ``preventDefault()``.
|
||||
|
||||
|
||||
:mochidef:`stop()`:
|
||||
|
||||
Shortcut that calls ``stopPropagation()`` and ``preventDefault()``.
|
||||
|
||||
|
||||
:mochidef:`key()`:
|
||||
|
||||
Returns ``{code, string}``.
|
||||
|
||||
Use ``'onkeydown'`` and ``'onkeyup'`` handlers to detect control
|
||||
characters such as ``'KEY_F1'``. Use the ``'onkeypressed'`` handler to
|
||||
detect "printable" characters, such as ``'é'``.
|
||||
|
||||
When a user presses F1, in ``'onkeydown'`` and ``'onkeyup'`` this method
|
||||
returns ``{code: 122, string: 'KEY_F1'}``. In ``'onkeypress'``, it returns
|
||||
``{code: 0, string: ''}``.
|
||||
|
||||
If a user presses Shift+2 on a US keyboard, this method returns
|
||||
``{code: 50, string: 'KEY_2'}`` in ``'onkeydown'`` and ``'onkeyup'``.
|
||||
In ``'onkeypress'``, it returns ``{code: 64, string: '@'}``.
|
||||
|
||||
See ``_specialKeys`` in the source code for a comprehensive list of
|
||||
control characters.
|
||||
|
||||
|
||||
:mochidef:`mouse()`:
|
||||
|
||||
Properties for ``'onmouse*'``, ``'onclick'``, ``'ondblclick'``, and
|
||||
``'oncontextmenu'``:
|
||||
|
||||
- ``page`` is a :mochiref:`MochiKit.DOM.Coordinates` object that
|
||||
represents the cursor position relative to the HTML document.
|
||||
Equivalent to ``pageX`` and ``pageY`` in Safari, Mozilla, and
|
||||
Opera.
|
||||
|
||||
- ``client`` is a :mochiref:`MochiKit.DOM.Coordinates` object that
|
||||
represents the cursor position relative to the visible portion of
|
||||
the HTML document. Equivalent to ``clientX`` and ``clientY`` on
|
||||
all browsers.
|
||||
|
||||
Properties for ``'onmouseup'``, ``'onmousedown'``, ``'onclick'``, and
|
||||
``'ondblclick'``:
|
||||
|
||||
- ``mouse().button`` returns ``{left, right, middle}`` where each
|
||||
property is ``true`` if the mouse button was pressed, ``false``
|
||||
otherwise.
|
||||
|
||||
Known browser bugs:
|
||||
|
||||
- Current versions of Safari won't signal ``'ondblclick'`` when
|
||||
attached via ``connect()`` (`Safari Bug 7790`_).
|
||||
|
||||
- Mac browsers don't report right-click consistently. Firefox
|
||||
signals the slot and sets ``modifier().ctrl`` to true, Opera
|
||||
signals the slot and sets ``modifier().meta`` to ``true``, and
|
||||
Safari doesn't signal the slot at all (`Safari Bug 6595`_).
|
||||
|
||||
To find a right-click in Safari, Firefox, and IE, you can connect
|
||||
an element to ``'oncontextmenu'``. This doesn't work in Opera.
|
||||
|
||||
|
||||
:mochidef:`relatedTarget()`:
|
||||
|
||||
Returns the document element that the mouse has moved to. This is
|
||||
generated for ``'onmouseover'`` and ``'onmouseout'`` events.
|
||||
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Jonathan Gardner <jgardner@jonathangardner.net>
|
||||
- Beau Hartshorne <beau@hartshornesoftware.com>
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2006 Jonathan Gardner <jgardner@jonathangardner.net>, Beau
|
||||
Hartshorne <beau@hartshornesoftware.com>, and Bob Ippolito <bob@redivi.com>.
|
||||
This program is dual-licensed free software; you can redistribute it and/or
|
||||
modify it under the terms of the `MIT License`_ or the
|
||||
`Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,244 @@
|
||||
2006-04-29 v1.3.1 (bug fix release)
|
||||
|
||||
- Fix sendXMLHttpRequest sendContent regression
|
||||
- Internet Explorer fix in MochiKit.Logging (printfire exception)
|
||||
- Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async
|
||||
|
||||
2006-04-26 v1.3 "warp zone"
|
||||
|
||||
- IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)
|
||||
- IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)
|
||||
- New MochiKit.Base.method as a convenience form of bind that takes the
|
||||
object before the method
|
||||
- New MochiKit.Base.flattenArguments for flattening a list of arguments to
|
||||
a single Array
|
||||
- Refactored MochiRegExp example to use MochiKit.Signal
|
||||
- New key_events example demonstrating use of MochiKit.Signal's key handling
|
||||
capabilities.
|
||||
- MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
|
||||
null is used and the string will be considered the first node. This
|
||||
allows for the more natural P("foo") rather than P(null, "foo").
|
||||
- MochiKit Interpreter example refactored to use MochiKit.Signal and now
|
||||
provides multi-line input and a help() function to get MochiKit function
|
||||
signature from the documentation.
|
||||
- Native Console Logging for the default MochiKit.Logging logger
|
||||
- New MochiKit.Async.DeferredList, gatherResults, maybeDeferred
|
||||
- New MochiKit.Signal example: draggable
|
||||
- Added sanity checking to Deferred to ensure that errors happen when chaining
|
||||
is used incorrectly
|
||||
- Opera sendXMLHttpRequest fix (sends empty string instead of null by default)
|
||||
- Fix a bug in MochiKit.Color that incorrectly generated hex colors for
|
||||
component values smaller than 16/255.
|
||||
- Fix a bug in MochiKit.Logging that prevented logs from being capped at a
|
||||
maximum size
|
||||
- MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
|
||||
Error, so that the errback chain is used instead of the callback chain.
|
||||
- MochiKit.DOM.appendChildNodes and associated functions now append iterables
|
||||
in the correct order.
|
||||
- New MochiKit-based SimpleTest test runner as a replacement for Test.Simple
|
||||
- MochiKit.Base.isNull no longer matches undefined
|
||||
- example doctypes changed to HTML4
|
||||
- isDateLike no longer throws error on null
|
||||
- New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt
|
||||
- updated elementDimensions to calculate width from offsetWidth instead
|
||||
of clientWidth
|
||||
- formContents now works with FORM tags that have a name attribute
|
||||
- Documentation now uses MochiKit to generate a function index
|
||||
|
||||
2006-01-26 v1.2 "the ocho"
|
||||
|
||||
- Fixed MochiKit.Color.Color.lighterColorWithLevel
|
||||
- Added new MochiKit.Base.findIdentical function to find the index of an
|
||||
element in an Array-like object. Uses === for identity comparison.
|
||||
- Added new MochiKit.Base.find function to find the index of an element in
|
||||
an Array-like object. Uses compare for rich comparison.
|
||||
- MochiKit.Base.bind will accept a string for func, which will be immediately
|
||||
looked up as self[func].
|
||||
- MochiKit.DOM.formContents no longer skips empty form elements for Zope
|
||||
compatibility
|
||||
- MochiKit.Iter.forEach will now catch StopIteration to break
|
||||
- New MochiKit.DOM.elementDimensions(element) for determining the width and
|
||||
height of an element in the document
|
||||
- MochiKit.DOM's initialization is now compatible with
|
||||
HTMLUnit + JWebUnit + Rhino
|
||||
- MochiKit.LoggingPane will now re-use a ``_MochiKit_LoggingPane`` DIV element
|
||||
currently in the document instead of always creating one.
|
||||
- MochiKit.Base now has operator.mul
|
||||
- MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
|
||||
a custom value attribute
|
||||
- Added new MochiKit.Color constructors fromComputedStyle and fromText
|
||||
- MochiKit.DOM.setNodeAttribute should work now
|
||||
- MochiKit.DOM now has a workaround for an IE bug when setting the style
|
||||
property to a string
|
||||
- MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
|
||||
name and for properties
|
||||
- MochiKit.DOM.scrapeText now walks the DOM tree in-order
|
||||
- MochiKit.LoggingPane now sanitizes the window name to work around IE bug
|
||||
- MochiKit.DOM now translates usemap to useMap to work around IE bug
|
||||
- MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks
|
||||
- Added new MochiKit.DOM documentation on element visibility
|
||||
- New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
|
||||
for determining the position of an element in the document
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG
|
||||
|
||||
2005-11-14 v1.1
|
||||
|
||||
- Fixed a bug in numberFormatter with large numbers
|
||||
- Massively overhauled documentation
|
||||
- Fast-path for primitives in MochiKit.Base.compare
|
||||
- New groupby and groupby_as_array in MochiKit.Iter
|
||||
- Added iterator factory adapter for objects that implement iterateNext()
|
||||
- Fixed isoTimestamp to handle timestamps with time zone correctly
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
|
||||
LEGEND, FIELDSET
|
||||
- New MochiKit.DOM formContents and enhancement to queryString to support it
|
||||
- Updated view_source example to use dp.SyntaxHighlighter 1.3.0
|
||||
- MochiKit.LoggingPane now uses named windows based on the URL so that
|
||||
a given URL will get the same LoggingPane window after a reload
|
||||
(at the same position, etc.)
|
||||
- MochiKit.DOM now has currentWindow() and currentDocument() context
|
||||
variables that are set with withWindow() and withDocument(). These
|
||||
context variables affect all MochiKit.DOM functionality (getElement,
|
||||
createDOM, etc.)
|
||||
- MochiKit.Base.items will now catch and ignore exceptions for properties
|
||||
that are enumerable but not accessible (e.g. permission denied)
|
||||
- MochiKit.Async.Deferred's addCallback/addErrback/addBoth
|
||||
now accept additional arguments that are used to create a partially
|
||||
applied function. This differs from Twisted in that the callback/errback
|
||||
result becomes the *last* argument, not the first when this feature
|
||||
is used.
|
||||
- MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
|
||||
arguments which are used to create a GET query string
|
||||
- Did some refactoring to reduce the footprint of MochiKit by a few
|
||||
kilobytes
|
||||
- escapeHTML to longer escapes ' (apos) and now uses
|
||||
String.replace instead of iterating over every char.
|
||||
- Added DeferredLock to Async
|
||||
- Renamed getElementsComputedStyle to computedStyle and moved
|
||||
it from MochiKit.Visual to MochiKit.DOM
|
||||
- Moved all color support out of MochiKit.Visual and into MochiKit.Color
|
||||
- Fixed range() to accept a negative step
|
||||
- New alias to MochiKit.swapDOM called removeElement
|
||||
- New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
|
||||
an attribute on a node without raising, roughly equivalent to:
|
||||
updateNodeAttributes(node, {attr: value})
|
||||
- New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
|
||||
a node's attribute or returns null without raising
|
||||
- Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
|
||||
directly (addLoadEvent did not leak, since it clears the handler)
|
||||
|
||||
2005-10-24 v1.0
|
||||
|
||||
- New interpreter example that shows usage of MochiKit.DOM to make
|
||||
an interactive JavaScript interpreter
|
||||
- New MochiKit.LoggingPane for use with the MochiKit.Logging
|
||||
debuggingBookmarklet, with logging_pane example to show its usage
|
||||
- New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
|
||||
in order to provide a live regular expression matching tool
|
||||
- Added advanced number formatting capabilities to MochiKit.Format:
|
||||
numberFormatter(pattern, placeholder="", locale="default") and
|
||||
formatLocale(locale="default")
|
||||
- Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
|
||||
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE
|
||||
- Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
|
||||
to MochiKit.Format
|
||||
- MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
|
||||
isoTimestamp(isoString) will convert them to Date objects, and
|
||||
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC
|
||||
- Fixed missing errback for sendXMLHttpRequest when the server does not
|
||||
respond
|
||||
- Fixed infinite recusion bug when using roundClass("DIV", ...)
|
||||
- Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
|
||||
from being cancelled properly
|
||||
- Workaround in MochiKit.Base bind (and partial) for functions that don't
|
||||
have an apply method, such as alert
|
||||
- Reliably return null from the string parsing/manipulation functions if
|
||||
the input can't be coerced to a string (s + "") or the input makes no sense;
|
||||
e.g. isoTimestamp(null) and isoTimestamp("") return null
|
||||
|
||||
2005-10-08 v0.90
|
||||
|
||||
- Fixed ISO compliance with toISODate
|
||||
- Added missing operator.sub
|
||||
- Placated Mozilla's strict warnings a bit
|
||||
- Added JSON serialization and unserialization support to MochiKit.Base:
|
||||
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
|
||||
API.
|
||||
- Fixed a bug in the script loader that failed in some scenarios when a script
|
||||
tag did not have a "src" attribute (thanks Ian!)
|
||||
- Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
|
||||
P, FORM
|
||||
- Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
|
||||
and parseQueryString, when available.
|
||||
|
||||
2005-08-12 v0.80
|
||||
|
||||
- Source highlighting in all examples, moved to a view-source example
|
||||
- Added some experimental syntax highlighting for the Rounded Corners example,
|
||||
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib
|
||||
- Use an indirect binding for the logger conveniences, so that the global
|
||||
logger could be replaced by setting MochiKit.Logger.logger to something else
|
||||
(though an observer is probably a better choice).
|
||||
- Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
|
||||
which will be looked up with getElement
|
||||
- Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
|
||||
node.parentNode)
|
||||
- Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success
|
||||
- Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues
|
||||
- Possible workaround for Safari issue with swapDOM, where it would get
|
||||
confused because two elements were in the DOM at the same time with the
|
||||
same id
|
||||
- Added missing THEAD convenience function to MochiKit.DOM
|
||||
- Added lstrip, rstrip, strip to MochiKit.Format
|
||||
- Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
|
||||
MochiKit.DOM
|
||||
- MochiKit.Iter.iextend now has a fast-path for array-like objects
|
||||
- Added HSV color space support to MochiKit.Visual
|
||||
- Fixed a bug in the sortable_tables example, it now converts types
|
||||
correctly
|
||||
- Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
|
||||
scope
|
||||
|
||||
2005-08-04 v0.70
|
||||
|
||||
- New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
|
||||
a little TAL-ish DOM templating attribute language.
|
||||
- sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
|
||||
ignore requests with status == 0, which seems to happen for cached or local
|
||||
requests
|
||||
- Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.
|
||||
- Changed scrapeText API to return a string by default. This is API-breaking!
|
||||
It was dumb to have the default return value be the form you almost never
|
||||
want. Sorry.
|
||||
- Added special form to swapDOM(dest, src). If src is null, dest is removed
|
||||
(where previously you'd likely get a DOM exception).
|
||||
- Added three new functions to MochiKit.Base for dealing with URL query
|
||||
strings: urlEncode, queryString, parseQueryString
|
||||
- MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
|
||||
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
|
||||
new Function(v).
|
||||
- Another workaround for Internet "worst browser ever" Explorer's setAttribute
|
||||
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).
|
||||
- Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM
|
||||
- Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
|
||||
now!
|
||||
|
||||
2005-07-29 v0.60
|
||||
|
||||
- Beefed up the MochiKit.DOM test suite
|
||||
- Fixed return value for MochiKit.DOM.swapElementClass, could return
|
||||
false unexpectedly before
|
||||
- Added an optional "parent" argument to
|
||||
MochiKit.DOM.getElementsByTagAndClassName
|
||||
- Added a "packed" version in packed/MochiKit/MochiKit.js
|
||||
- Changed build script to rewrite the URLs in tests to account for the
|
||||
JSAN-required reorganization
|
||||
- MochiKit.Compat to potentially work around IE 5.5 issues
|
||||
(5.0 still not supported). Test.Simple doesn't seem to work there,
|
||||
though.
|
||||
- Several minor documentation corrections
|
||||
|
||||
2005-07-27 v0.50
|
||||
|
||||
- Initial Release
|
||||
@@ -0,0 +1,127 @@
|
||||
.. title:: MochiKit.Visual - visual effects
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
MochiKit.Visual - visual effects
|
||||
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
// round the corners of all h1 elements
|
||||
roundClass("h1", null);
|
||||
|
||||
// round the top left corner of the element with the id "title"
|
||||
roundElement("title", {corners: "tl"});
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
MochiKit.Visual provides visual effects and support functions for visuals.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- :mochiref:`MochiKit.Base`
|
||||
- :mochiref:`MochiKit.Iter`
|
||||
- :mochiref:`MochiKit.DOM`
|
||||
- :mochiref:`MochiKit.Color`
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
At this time, MochiKit.Visual provides one visual effect: rounded corners
|
||||
for your HTML elements. These rounded corners are created completely
|
||||
through CSS manipulations and require no external images or style sheets.
|
||||
This implementation was adapted from Rico_.
|
||||
|
||||
.. _Rico: http://www.openrico.org
|
||||
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
:mochidef:`roundClass(tagName[, className[, options]])`:
|
||||
|
||||
Rounds all of the elements that match the ``tagName`` and ``className``
|
||||
specifiers, using the options provided. ``tagName`` or ``className`` can
|
||||
be ``null`` to match all tags or classes. For more information about
|
||||
the options, see the :mochiref:`roundElement` function.
|
||||
|
||||
|
||||
:mochidef:`roundElement(element[, options])`:
|
||||
|
||||
Immediately round the corners of the specified element.
|
||||
The element can be given as either a string
|
||||
with the element ID, or as an element object.
|
||||
|
||||
The options mapping has the following defaults:
|
||||
|
||||
========= =================
|
||||
corners ``"all"``
|
||||
color ``"fromElement"``
|
||||
bgColor ``"fromParent"``
|
||||
blend ``true``
|
||||
border ``false``
|
||||
compact ``false``
|
||||
========= =================
|
||||
|
||||
corners:
|
||||
|
||||
specifies which corners of the element should be rounded.
|
||||
Choices are:
|
||||
|
||||
- all
|
||||
- top
|
||||
- bottom
|
||||
- tl (top left)
|
||||
- bl (bottom left)
|
||||
- tr (top right)
|
||||
- br (bottom right)
|
||||
|
||||
Example:
|
||||
``"tl br"``: top-left and bottom-right corners are rounded
|
||||
|
||||
blend:
|
||||
specifies whether the color and background color should be blended
|
||||
together to produce the border color.
|
||||
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. [1] Application Kit Reference - NSColor: http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html
|
||||
.. [2] SVG 1.0 color keywords: http://www.w3.org/TR/SVG/types.html#ColorKeywords
|
||||
.. [3] W3C CSS3 Color Module: http://www.w3.org/TR/css3-color/#svg-color
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Kevin Dangoor <dangoor@gmail.com>
|
||||
- Bob Ippolito <bob@redivi.com>
|
||||
- Originally adapted from Rico <http://openrico.org/> (though little remains)
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
|
||||
Portions adapted from `Rico`_ are available under the terms of the
|
||||
`Apache License, Version 2.0`_.
|
||||
|
||||
.. _`Apache License, Version 2.0`: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
@@ -0,0 +1,74 @@
|
||||
.. title:: MochiKit Documentation Index
|
||||
|
||||
Distribution
|
||||
============
|
||||
|
||||
MochiKit - makes JavaScript suck a bit less
|
||||
|
||||
- :mochiref:`MochiKit.Async` - manage asynchronous tasks
|
||||
- :mochiref:`MochiKit.Base` - functional programming and useful comparisons
|
||||
- :mochiref:`MochiKit.DOM` - painless DOM manipulation API
|
||||
- :mochiref:`MochiKit.Color` - color abstraction with CSS3 support
|
||||
- :mochiref:`MochiKit.DateTime` - "what time is it anyway?"
|
||||
- :mochiref:`MochiKit.Format` - string formatting goes here
|
||||
- :mochiref:`MochiKit.Iter` - itertools for JavaScript; iteration made HARD,
|
||||
and then easy
|
||||
- :mochiref:`MochiKit.Logging` - we're all tired of ``alert()``
|
||||
- :mochiref:`MochiKit.LoggingPane` - interactive :mochiref:`MochiKit.Logging`
|
||||
pane
|
||||
- :mochiref:`MochiKit.Signal` - simple universal event handling
|
||||
- :mochiref:`MochiKit.Visual` - visual effects
|
||||
|
||||
|
||||
Notes
|
||||
=====
|
||||
|
||||
To turn on MochiKit's compatibility mode, do this before loading MochiKit::
|
||||
|
||||
<script type="text/javascript">MochiKit = {__compat__: true};</script>
|
||||
|
||||
When compatibility mode is on, you must use fully qualified names for all
|
||||
MochiKit functions (e.g. ``MochiKit.Base.map(...)``).
|
||||
|
||||
|
||||
Screencasts
|
||||
===========
|
||||
|
||||
- `MochiKit 1.1 Intro`__
|
||||
|
||||
.. __: http://mochikit.com/screencasts/MochiKit_Intro-1
|
||||
|
||||
See Also
|
||||
========
|
||||
|
||||
.. _`mochikit.com`: http://mochikit.com/
|
||||
.. _`from __future__ import *`: http://bob.pythonmac.org/
|
||||
.. _`MochiKit on JSAN`: http://openjsan.org/doc/b/bo/bob/MochiKit/
|
||||
.. _`MochiKit tag on del.icio.us`: http://del.icio.us/tag/mochikit
|
||||
.. _`MochiKit tag on Technorati`: http://technorati.com/tag/mochikit
|
||||
.. _`Google Groups: MochiKit`: http://groups.google.com/group/mochikit
|
||||
|
||||
- `Google Groups: MochiKit`_: The official mailing list for discussions
|
||||
related to development of and with MochiKit
|
||||
- `mochikit.com`_: MochiKit's home on the web
|
||||
- `from __future__ import *`_: Bob Ippolito's blog
|
||||
- `MochiKit on JSAN`_: the JSAN distribution page for MochiKit
|
||||
- `MochiKit tag on del.icio.us`_: Recent bookmarks related to MochiKit
|
||||
- `MochiKit tag on Technorati`_: Recent blog entries related to MochiKit
|
||||
|
||||
|
||||
Version History
|
||||
===============
|
||||
|
||||
.. include:: VersionHistory.rst
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
|
||||
free software; you can redistribute it and/or modify it under the terms of the
|
||||
`MIT License`_ or the `Academic Free License v2.1`_.
|
||||
|
||||
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
|
||||
@@ -0,0 +1,69 @@
|
||||
h1 {
|
||||
font-size: 2em;
|
||||
color: #4B4545;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
table.datagrid {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.datagrid thead th {
|
||||
text-align: left;
|
||||
background-color: #4B4545;
|
||||
background-repeat: no-repeat;
|
||||
background-position: right center;
|
||||
color: white;
|
||||
font-weight: bold;
|
||||
padding: .3em .7em;
|
||||
font-size: .9em;
|
||||
padding-right: 5px;
|
||||
background-repeat: no-repeat;
|
||||
background-position: 95% right;
|
||||
}
|
||||
|
||||
table.datagrid thead th a {
|
||||
color: white;
|
||||
text-decoration: none;
|
||||
font-size: 1.0em;
|
||||
background-repeat: no-repeat;
|
||||
background-position: center right;
|
||||
padding-right: 15px;
|
||||
}
|
||||
|
||||
table.datagrid thead th.over {
|
||||
background-color: #746B6B;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
table.datagrid tbody th {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
table.datagrid tbody td, table.datagrid tbody th {
|
||||
text-align: left;
|
||||
padding: .3em .7em;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
table.datagrid tbody tr.alternate td, table.datagrid tbody tr.alternate th {
|
||||
background-color: #f1f1f1;
|
||||
}
|
||||
|
||||
table.datagrid tfoot td, table.datagrid tfoot th {
|
||||
background-color: #FFFEE3;
|
||||
color: #4B4545;
|
||||
padding: .5em;
|
||||
font-weight: bold;
|
||||
border-top: 2px solid #4B4545;
|
||||
}
|
||||
|
||||
table.datagrid tfoot th { text-align: left; }
|
||||
|
||||
table.datagrid tfoot td { }
|
||||
|
||||
.invisible { display: none; }
|
||||
|
||||
.mochi-template { display: none; }
|
||||
.mochi-example { display: none; }
|
||||
@@ -0,0 +1,402 @@
|
||||
/*
|
||||
|
||||
On page load, the SortableManager:
|
||||
|
||||
- Rips out all of the elements with the mochi-example class.
|
||||
- Finds the elements with the mochi-template class and saves them for
|
||||
later parsing with "MochiTAL".
|
||||
- Finds the anchor tags with the mochi:dataformat attribute and gives them
|
||||
onclick behvaiors to load new data, using their href as the data source.
|
||||
This makes your XML or JSON look like a normal link to a search engine
|
||||
(or javascript-disabled browser).
|
||||
- Clones the thead element from the table because it will be replaced on each
|
||||
sort.
|
||||
- Sets up a default sort key of "domain_name" and queues a load of the json
|
||||
document.
|
||||
|
||||
|
||||
On data load, the SortableManager:
|
||||
|
||||
- Parses the table data from the document (columns list, rows list-of-lists)
|
||||
and turns them into a list of [{column:value, ...}] objects for easy sorting
|
||||
and column order stability.
|
||||
- Chooses the default (or previous) sort state and triggers a sort request
|
||||
|
||||
|
||||
On sort request:
|
||||
|
||||
- Replaces the cloned thead element with a copy of it that has the sort
|
||||
indicator (↑ or ↓) for the most recently sorted column (matched up
|
||||
to the first field in the th's mochi:sortcolumn attribute), and attaches
|
||||
onclick, onmousedown, onmouseover, onmouseout behaviors to them. The second
|
||||
field of mochi:sortcolumn attribute is used to perform a non-string sort.
|
||||
- Performs the sort on the domains list. If the second field of
|
||||
mochi:sortcolumn was not "str", then a custom function is used and the
|
||||
results are stored away in a __sort__ key, which is then used to perform the
|
||||
sort (read: shwartzian transform).
|
||||
- Calls processMochiTAL on the page, which finds the mochi-template sections
|
||||
and then looks for mochi:repeat and mochi:content attributes on them, using
|
||||
the data object.
|
||||
|
||||
*/
|
||||
|
||||
processMochiTAL = function (dom, data) {
|
||||
/***
|
||||
|
||||
A TAL-esque template attribute language processor,
|
||||
including content replacement and repeat
|
||||
|
||||
***/
|
||||
|
||||
// nodeType == 1 is an element, we're leaving
|
||||
// text nodes alone.
|
||||
if (dom.nodeType != 1) {
|
||||
return;
|
||||
}
|
||||
var attr;
|
||||
// duplicate this element for each item in the
|
||||
// given list, and then process the duplicated
|
||||
// element again (sans mochi:repeat tag)
|
||||
attr = getAttribute(dom, "mochi:repeat");
|
||||
if (attr) {
|
||||
dom.removeAttribute("mochi:repeat");
|
||||
var parent = dom.parentNode;
|
||||
attr = attr.split(" ");
|
||||
var name = attr[0];
|
||||
var lst = valueForKeyPath(data, attr[1]);
|
||||
if (!lst) {
|
||||
return;
|
||||
}
|
||||
for (var i = 0; i < lst.length; i++) {
|
||||
data[name] = lst[i];
|
||||
var newDOM = dom.cloneNode(true);
|
||||
processMochiTAL(newDOM, data);
|
||||
parent.insertBefore(newDOM, dom);
|
||||
}
|
||||
parent.removeChild(dom);
|
||||
return;
|
||||
}
|
||||
// do content replacement if there's a mochi:content attribute
|
||||
// on the element
|
||||
attr = getAttribute(dom, "mochi:content");
|
||||
if (attr) {
|
||||
dom.removeAttribute("mochi:content");
|
||||
replaceChildNodes(dom, valueForKeyPath(data, attr));
|
||||
return;
|
||||
}
|
||||
// we make a shallow copy of the current list of child nodes
|
||||
// because it *will* change if there's a mochi:repeat in there!
|
||||
var nodes = list(dom.childNodes);
|
||||
for (var i = 0; i < nodes.length; i++) {
|
||||
processMochiTAL(nodes[i], data);
|
||||
}
|
||||
};
|
||||
|
||||
mouseOverFunc = function () {
|
||||
addElementClass(this, "over");
|
||||
};
|
||||
|
||||
mouseOutFunc = function () {
|
||||
removeElementClass(this, "over");
|
||||
};
|
||||
|
||||
ignoreEvent = function (ev) {
|
||||
if (ev && ev.preventDefault) {
|
||||
ev.preventDefault();
|
||||
ev.stopPropagation();
|
||||
} else if (typeof(event) != 'undefined') {
|
||||
event.cancelBubble = false;
|
||||
event.returnValue = false;
|
||||
}
|
||||
};
|
||||
|
||||
SortTransforms = {
|
||||
"str": operator.identity,
|
||||
"istr": function (s) { return s.toLowerCase(); },
|
||||
"isoDate": isoDate
|
||||
};
|
||||
|
||||
getAttribute = function (dom, key) {
|
||||
try {
|
||||
return dom.getAttribute(key);
|
||||
} catch (e) {
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
||||
datatableFromXMLRequest = function (req) {
|
||||
/***
|
||||
|
||||
This effectively converts domains.xml to the
|
||||
same form as domains.json
|
||||
|
||||
***/
|
||||
var xml = req.responseXML;
|
||||
var nodes = xml.getElementsByTagName("column");
|
||||
var rval = {"columns": map(scrapeText, nodes)};
|
||||
var rows = [];
|
||||
nodes = xml.getElementsByTagName("row")
|
||||
for (var i = 0; i < nodes.length; i++) {
|
||||
var cells = nodes[i].getElementsByTagName("cell");
|
||||
rows.push(map(scrapeText, cells));
|
||||
}
|
||||
rval.rows = rows;
|
||||
return rval;
|
||||
};
|
||||
|
||||
loadFromDataAnchor = function (ev) {
|
||||
ignoreEvent(ev);
|
||||
var format = this.getAttribute("mochi:dataformat");
|
||||
var href = this.href;
|
||||
sortableManager.loadFromURL(format, href);
|
||||
};
|
||||
|
||||
valueForKeyPath = function (data, keyPath) {
|
||||
var chunks = keyPath.split(".");
|
||||
while (chunks.length && data) {
|
||||
data = data[chunks.shift()];
|
||||
}
|
||||
return data;
|
||||
};
|
||||
|
||||
|
||||
SortableManager = function () {
|
||||
this.thead = null;
|
||||
this.thead_proto = null;
|
||||
this.tbody = null;
|
||||
this.deferred = null;
|
||||
this.columns = [];
|
||||
this.rows = [];
|
||||
this.templates = [];
|
||||
this.sortState = {};
|
||||
bindMethods(this);
|
||||
};
|
||||
|
||||
SortableManager.prototype = {
|
||||
|
||||
"initialize": function () {
|
||||
// just rip all mochi-examples out of the DOM
|
||||
var examples = getElementsByTagAndClassName(null, "mochi-example");
|
||||
while (examples.length) {
|
||||
swapDOM(examples.pop(), null);
|
||||
}
|
||||
// make a template list
|
||||
var templates = getElementsByTagAndClassName(null, "mochi-template");
|
||||
for (var i = 0; i < templates.length; i++) {
|
||||
var template = templates[i];
|
||||
var proto = template.cloneNode(true);
|
||||
removeElementClass(proto, "mochi-template");
|
||||
this.templates.push({
|
||||
"template": proto,
|
||||
"node": template
|
||||
});
|
||||
}
|
||||
// set up the data anchors to do loads
|
||||
var anchors = getElementsByTagAndClassName("a", null);
|
||||
for (var i = 0; i < anchors.length; i++) {
|
||||
var node = anchors[i];
|
||||
var format = getAttribute(node, "mochi:dataformat");
|
||||
if (format) {
|
||||
node.onclick = loadFromDataAnchor;
|
||||
}
|
||||
}
|
||||
|
||||
// to find sort columns
|
||||
this.thead = getElementsByTagAndClassName("thead", null)[0];
|
||||
this.thead_proto = this.thead.cloneNode(true);
|
||||
|
||||
this.sortkey = "domain_name";
|
||||
this.loadFromURL("json", "domains.json");
|
||||
},
|
||||
|
||||
"loadFromURL": function (format, url) {
|
||||
log('loadFromURL', format, url);
|
||||
var d;
|
||||
if (this.deferred) {
|
||||
this.deferred.cancel();
|
||||
}
|
||||
if (format == "xml") {
|
||||
var req = getXMLHttpRequest();
|
||||
if (req.overrideMimeType) {
|
||||
req.overrideMimeType("text/xml");
|
||||
}
|
||||
req.open("GET", url, true);
|
||||
d = sendXMLHttpRequest(req).addCallback(datatableFromXMLRequest);
|
||||
} else if (format == "json") {
|
||||
d = loadJSONDoc(url);
|
||||
} else {
|
||||
throw new TypeError("format " + repr(format) + " not supported");
|
||||
}
|
||||
// keep track of the current deferred, so that we can cancel it
|
||||
this.deferred = d;
|
||||
var self = this;
|
||||
// on success or error, remove the current deferred because it has
|
||||
// completed, and pass through the result or error
|
||||
d.addBoth(function (res) {
|
||||
self.deferred = null;
|
||||
log('loadFromURL success');
|
||||
return res;
|
||||
});
|
||||
// on success, tag the result with the format used so we can display
|
||||
// it
|
||||
d.addCallback(function (res) {
|
||||
res.format = format;
|
||||
return res;
|
||||
});
|
||||
// call this.initWithData(data) once it's ready
|
||||
d.addCallback(this.initWithData);
|
||||
// if anything goes wrong, except for a simple cancellation,
|
||||
// then log the error and show the logger
|
||||
d.addErrback(function (err) {
|
||||
if (err instanceof CancelledError) {
|
||||
return;
|
||||
}
|
||||
logError(err);
|
||||
logger.debuggingBookmarklet();
|
||||
});
|
||||
return d;
|
||||
},
|
||||
|
||||
"initWithData": function (data) {
|
||||
/***
|
||||
|
||||
Initialize the SortableManager with a table object
|
||||
|
||||
***/
|
||||
|
||||
// reformat to [{column:value, ...}, ...] style as the domains key
|
||||
var domains = [];
|
||||
var rows = data.rows;
|
||||
var cols = data.columns;
|
||||
for (var i = 0; i < rows.length; i++) {
|
||||
var row = rows[i];
|
||||
var domain = {};
|
||||
for (var j = 0; j < cols.length; j++) {
|
||||
domain[cols[j]] = row[j];
|
||||
}
|
||||
domains.push(domain);
|
||||
}
|
||||
data.domains = domains;
|
||||
this.data = data;
|
||||
// perform a sort and display based upon the previous sort state,
|
||||
// defaulting to an ascending sort if this is the first sort
|
||||
var order = this.sortState[this.sortkey];
|
||||
if (typeof(order) == 'undefined') {
|
||||
order = true;
|
||||
}
|
||||
this.drawSortedRows(this.sortkey, order, false);
|
||||
|
||||
},
|
||||
|
||||
"onSortClick": function (name) {
|
||||
/***
|
||||
|
||||
Return a sort function for click events
|
||||
|
||||
***/
|
||||
// save ourselves from doing a bind
|
||||
var self = this;
|
||||
// on click, flip the last sort order of that column and sort
|
||||
return function () {
|
||||
log('onSortClick', name);
|
||||
var order = self.sortState[name];
|
||||
if (typeof(order) == 'undefined') {
|
||||
// if it's never been sorted by this column, sort ascending
|
||||
order = true;
|
||||
} else if (self.sortkey == name) {
|
||||
// if this column was sorted most recently, flip the sort order
|
||||
order = !((typeof(order) == 'undefined') ? false : order);
|
||||
}
|
||||
self.drawSortedRows(name, order, true);
|
||||
};
|
||||
},
|
||||
|
||||
"drawSortedRows": function (key, forward, clicked) {
|
||||
/***
|
||||
|
||||
Draw the new sorted table body, and modify the column headers
|
||||
if appropriate
|
||||
|
||||
***/
|
||||
log('drawSortedRows', key, forward);
|
||||
|
||||
// save it so we can flip next time
|
||||
this.sortState[key] = forward;
|
||||
this.sortkey = key;
|
||||
var sortstyle;
|
||||
|
||||
// setup the sort columns
|
||||
var thead = this.thead_proto.cloneNode(true);
|
||||
var cols = thead.getElementsByTagName("th");
|
||||
for (var i = 0; i < cols.length; i++) {
|
||||
var col = cols[i];
|
||||
var sortinfo = getAttribute(col, "mochi:sortcolumn").split(" ");
|
||||
var sortkey = sortinfo[0];
|
||||
col.onclick = this.onSortClick(sortkey);
|
||||
col.onmousedown = ignoreEvent;
|
||||
col.onmouseover = mouseOverFunc;
|
||||
col.onmouseout = mouseOutFunc;
|
||||
// if this is the sorted column
|
||||
if (sortkey == key) {
|
||||
sortstyle = sortinfo[1];
|
||||
// \u2193 is down arrow, \u2191 is up arrow
|
||||
// forward sorts mean the rows get bigger going down
|
||||
var arrow = (forward ? "\u2193" : "\u2191");
|
||||
// add the character to the column header
|
||||
col.appendChild(SPAN(null, arrow));
|
||||
if (clicked) {
|
||||
col.onmouseover();
|
||||
}
|
||||
}
|
||||
}
|
||||
this.thead = swapDOM(this.thead, thead);
|
||||
|
||||
// apply a sort transform to a temporary column named __sort__,
|
||||
// and do the sort based on that column
|
||||
if (!sortstyle) {
|
||||
sortstyle = "str";
|
||||
}
|
||||
var sortfunc = SortTransforms[sortstyle];
|
||||
if (!sortfunc) {
|
||||
throw new TypeError("unsupported sort style " + repr(sortstyle));
|
||||
}
|
||||
var domains = this.data.domains;
|
||||
for (var i = 0; i < domains.length; i++) {
|
||||
var domain = domains[i];
|
||||
domain.__sort__ = sortfunc(domain[key]);
|
||||
}
|
||||
|
||||
// perform the sort based on the state given (forward or reverse)
|
||||
var cmp = (forward ? keyComparator : reverseKeyComparator);
|
||||
domains.sort(cmp("__sort__"));
|
||||
|
||||
// process every template with the given data
|
||||
// and put the processed templates in the DOM
|
||||
for (var i = 0; i < this.templates.length; i++) {
|
||||
log('template', i, template);
|
||||
var template = this.templates[i];
|
||||
var dom = template.template.cloneNode(true);
|
||||
processMochiTAL(dom, this.data);
|
||||
template.node = swapDOM(template.node, dom);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
// create the global SortableManager and initialize it on page load
|
||||
sortableManager = new SortableManager();
|
||||
addLoadEvent(sortableManager.initialize);
|
||||
|
||||
// rewrite the view-source links
|
||||
addLoadEvent(function () {
|
||||
var elems = getElementsByTagAndClassName("A", "view-source");
|
||||
var page = "ajax_tables/";
|
||||
for (var i = 0; i < elems.length; i++) {
|
||||
var elem = elems[i];
|
||||
var href = elem.href.split(/\//).pop();
|
||||
elem.target = "_blank";
|
||||
elem.href = "../view-source/view-source.html#" + page + href;
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"columns": [ "domain_name", "create_date", "expiry_date", "organization_name"],
|
||||
"rows": [
|
||||
["json.org", "2000-05-08", "2006-05-08", "Douglas Crockford"],
|
||||
["mochibot.com", "2005-02-10", "2007-02-10", "Jameson Hsu"],
|
||||
["pythonmac.org", "2003-09-24", "2006-09-24", "Bob Ippolito"],
|
||||
["undefined.org", "2000-01-10", "2006-01-10", "Robert J Ippolito"],
|
||||
["python.org", "1995-03-27", "2007-03-28", "Python Software Foundation"]
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
<datatable>
|
||||
<columns>
|
||||
<column>domain_name</column>
|
||||
<column>create_date</column>
|
||||
<column>expiry_date</column>
|
||||
<column>organization_name</column>
|
||||
</columns>
|
||||
<rows>
|
||||
<row>
|
||||
<cell>xml.com</cell>
|
||||
<cell>1996-09-30</cell>
|
||||
<cell>2012-09-29</cell>
|
||||
<cell>Tim Bray</cell>
|
||||
</row>
|
||||
<row>
|
||||
<cell>mochibot.com</cell>
|
||||
<cell>2005-02-10</cell>
|
||||
<cell>2007-02-10</cell>
|
||||
<cell>Jameson Hsu</cell>
|
||||
</row>
|
||||
<row>
|
||||
<cell>pythonmac.org</cell>
|
||||
<cell>2003-09-24</cell>
|
||||
<cell>2006-09-24</cell>
|
||||
<cell>Bob Ippolito</cell>
|
||||
</row>
|
||||
<row>
|
||||
<cell>undefined.org</cell>
|
||||
<cell>2000-01-10</cell>
|
||||
<cell>2006-01-10</cell>
|
||||
<cell>Robert J Ippolito</cell>
|
||||
</row>
|
||||
<row>
|
||||
<cell>python.org</cell>
|
||||
<cell>1995-03-27</cell>
|
||||
<cell>2007-03-28</cell>
|
||||
<cell>Python Software Foundation</cell>
|
||||
</row>
|
||||
</rows>
|
||||
</datatable>
|
||||
@@ -0,0 +1,96 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<!--
|
||||
|
||||
Using a made-up xmlns..
|
||||
|
||||
-->
|
||||
<html xmlns:mochi="http://mochikit.com/examples/ajax_tables">
|
||||
<head>
|
||||
<title>Sortable Tables from Scratch with MochiKit</title>
|
||||
<link href="ajax_tables.css" rel="stylesheet" type="text/css" />
|
||||
<script type="text/javascript" src="../../lib/MochiKit/MochiKit.js"></script>
|
||||
<script type="text/javascript" src="ajax_tables.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>
|
||||
Sortable Ajax Tables in JSON and XML with MochiKit
|
||||
</h1>
|
||||
<div>
|
||||
<div>
|
||||
<p>
|
||||
This is an example of how one might use <a href="http://mochikit.com/">MochiKit</a> to do
|
||||
sortable tables from data given by the server in either JSON
|
||||
or XML format. It uses
|
||||
<a href="../../doc/html/lib/MochiKit/Async.html">MochiKit.Async</a>
|
||||
to fetch the data, and
|
||||
<a href="../../doc/html/lib/MochiKit/DOM.html">MochiKit.DOM</a>
|
||||
to display it.
|
||||
</p>
|
||||
<p>
|
||||
Includes a micro implementation of something
|
||||
<a href="http://www.zope.org/Wikis/DevSite/Projects/ZPT/FrontPage">TAL</a>-esque
|
||||
(called "MochiTAL" in the source, using a mochi: namespace).
|
||||
For a more detailed description of what happens under the
|
||||
covers, view the <a href="ajax_tables.js" class="view-source">ajax_tables.js</a>
|
||||
source and look at the comments.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
View Source: [
|
||||
<a href="index.html" class="view-source">index.html</a> |
|
||||
<a href="ajax_tables.js" class="view-source">ajax_tables.js</a> |
|
||||
<a href="domains.json" class="view-source">domains.json</a> |
|
||||
<a href="domains.xml" class="view-source">domains.xml</a>
|
||||
]
|
||||
</div>
|
||||
<div>
|
||||
Load data: [
|
||||
<a href="domains.json" mochi:dataformat="json">domains.json</a>
|
||||
| <a href="domains.xml" mochi:dataformat="xml">domains.xml</a>
|
||||
]
|
||||
(current format: <span class="mochi-template" mochi:content="format">loading</span>)
|
||||
</div>
|
||||
<table id="sortable_table" class="datagrid">
|
||||
<thead>
|
||||
<tr>
|
||||
<th mochi:sortcolumn="domain_name str">Domain Name</th>
|
||||
<th mochi:sortcolumn="create_date isoDate">Creation Date</th>
|
||||
<th mochi:sortcolumn="expiry_date isoDate">Expiry Date</th>
|
||||
<th mochi:sortcolumn="organization_name istr">Organization Name</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tfoot class="invisible">
|
||||
<tr>
|
||||
<td colspan="0"></td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
<tbody class="mochi-template">
|
||||
<tr mochi:repeat="item domains">
|
||||
<td mochi:content="item.domain_name">mochibot.com</td>
|
||||
<td mochi:content="item.create_date">2005-02-10</td>
|
||||
<td mochi:content="item.expiry_date">2007-02-10</td>
|
||||
<td mochi:content="item.organization_name">Jameson Hsu</td>
|
||||
</tr>
|
||||
<tr class="mochi-example">
|
||||
<td>pythonmac.org</td>
|
||||
<td>2003-09-24</td>
|
||||
<td>2006-09-24</td>
|
||||
<td>Bob Ippolito</td>
|
||||
</tr>
|
||||
<tr class="mochi-example">
|
||||
<td>undefined.org</td>
|
||||
<td>2000-01-10</td>
|
||||
<td>2006-01-10</td>
|
||||
<td>Robert J Ippolito</td>
|
||||
</tr>
|
||||
<tr class="mochi-example">
|
||||
<td>python.org</td>
|
||||
<td>1995-03-27</td>
|
||||
<td>2007-03-28</td>
|
||||
<td>Python Software Foundation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,4 @@
|
||||
h1 { text-align: center; }
|
||||
#docs { text-align: center; }
|
||||
#source { text-align: center; }
|
||||
#color_wheel_container { position:absolute; left: 50%; top: 50% }
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user