<project name="jQuery" default="all" basedir=".">
- <property name="SRC_DIR" value="src" />
- <property name="BUILD_DIR" value="build" />
- <property name="JAR" value="${BUILD_DIR}/js.jar" />
+ <!--
+ - Using this build file to create your own custom distribution -
- <property name="PREFIX" value="." />
- <property name="DOCS_DIR" value="${PREFIX}/docs" />
- <property name="TEST_DIR" value="${PREFIX}/test" />
- <property name="DIST_DIR" value="${PREFIX}/dist" />
+ If you want to include jQuery on your site with a certain set of plugins,
+ follow these steps to create your custom build:
+ 1. Copy the plugins you need to the plugins folder (if you haven't already, checkout
+ the plugins folder from SVN.
+ 2. Modify the PLUGINS property to include all plugins you want, see PLUGINS_ALL for syntax
+ eg. if you need form and tabs plugin, set the value for PLUGINS to this:
+ form/*.js, tabs/*.js
+ 3. Execute the standard jquery and packed targets to build your distribution
+
+ TODO Using this build file to create docs for a single plugin
+ -->
+
+ <!-- SETUP -->
+
+ <property description="Source Folder" name="SRC_DIR" value="src" />
+ <property description="Files for parsing etc." name="BUILD_DIR" value="build" />
+ <property description="Rhino JS Engine" name="JAR" value="${BUILD_DIR}/js.jar" />
+
+ <property description="Dir to look for plugins" name="PLUGIN_DIR" location="../plugins" />
+ <property description="Add single plugins here" name="PLUGINS" value="none" />
+ <property description="Add all plugins here" name="PLUGINS_ALL"
+ value="button/*.js,center/*.js,cookie/*.js,form/*.js,greybox/*.js,interface/*.js,pager/*.js,tablesorter/*.js,tabs/*.js,tooltip/*.js,accordion/*.js" />
+
+ <property description="Target parent folder for built files" name="PREFIX" value="." />
+ <property description="Folder for docs target" name="DOCS_DIR" value="${PREFIX}/docs" />
+ <property description="Folder for test target" name="TEST_DIR" value="${PREFIX}/test" />
+ <property description="Folder for jquery, min, lite and packed target" name="DIST_DIR" value="${PREFIX}/dist" />
+
+ <!-- Files names for distribution -->
<property name="JQ" value="${DIST_DIR}/jquery.js" />
<property name="JQ_LITE" value="${DIST_DIR}/jquery.lite.js" />
<property name="JQ_MIN" value="${DIST_DIR}/jquery.min.js" />
<property name="JQ_PACK" value="${DIST_DIR}/jquery.pack.js" />
- <target name="jquery">
+ <!-- MAIN -->
+
+ <target name="jquery" description="Main jquery build, set PLUGINS property to include plugins">
<echo message="Building ${JQ}" />
<mkdir dir="${DIST_DIR}" />
- <concat destfile="${JQ}">\r
- <fileset dir="${SRC_DIR}" includes="intro.js" />
- <fileset dir="${SRC_DIR}" includes="jquery/*.js" />
- <fileset dir="${SRC_DIR}" includes="event/*.js" />
- <fileset dir="${SRC_DIR}" includes="fx/*.js" />
- <fileset dir="${SRC_DIR}" includes="ajax/*.js" />\r
- <fileset dir="${SRC_DIR}" includes="outro.js" />
+ <concat destfile="${JQ}">
+ <fileset dir="${SRC_DIR}" includes="intro.js" />
+ <fileset dir="${SRC_DIR}" includes="core.js" />
+ <fileset dir="${SRC_DIR}" includes="selector.js" />
+ <fileset dir="${SRC_DIR}" includes="event.js" />
+ <fileset dir="${SRC_DIR}" includes="ajax.js" />
+ <fileset dir="${SRC_DIR}" includes="fx.js" />
+ <fileset dir="${SRC_DIR}" includes="offset.js" />
+ <fileset dir="${PLUGIN_DIR}" includes="${PLUGINS}" />
+ <fileset dir="${SRC_DIR}" includes="outro.js" />
</concat>
<echo message="${JQ} built." />
</target>
- <target name="lite" depends="jquery">
+ <target name="jquery_with_plugins" description="Build jquery with all plugins, useful to full documentation">
+ <antcall target="jquery">
+ <param name="PLUGINS" value="${PLUGINS_ALL}" />
+ </antcall>
+ </target>
+
+ <target name="lite" depends="jquery" description="Remove all /** */ comments">
<echo message="Building ${JQ_LITE}" />
<java jar="${JAR}" fork="true">
<arg value="${BUILD_DIR}/build/lite.js" />
<echo message="${JQ_LITE} built." />
</target>
- <target name="min" depends="jquery">
+ <target name="min" depends="jquery" description="Remove all comments and whitespace, no compression">
<echo message="Building ${JQ_MIN}" />
<java jar="${JAR}" fork="true">
<arg value="${BUILD_DIR}/build/min.js" />
<echo message="${JQ_MIN} built." />
</target>
- <target name="pack" depends="jquery">
+ <target name="pack" depends="jquery" description="Remove all comments and whitespace and compress">
<echo message="Building ${JQ_PACK}" />
<java jar="${JAR}" fork="true">
<arg value="${BUILD_DIR}/build/pack.js" />
<echo message="${JQ_PACK} built." />
</target>
- <target name="test" depends="jquery">
+ <target name="pack_with_plugins" depends="jquery_with_plugins" description="Pack jquery with all plugins, not very useful">
+ <echo message="Building ${JQ_PACK}" />
+ <java jar="${JAR}" fork="true">
+ <arg value="${BUILD_DIR}/build/pack.js" />
+ <arg value="${JQ}" />
+ <arg value="${JQ_PACK}" />
+ </java>
+ <echo message="${JQ_PACK} built." />
+ </target>
+
+ <target name="test" depends="jquery" description="Copy files for the test suite into their own directory.">
<echo message="Building Test Suite" />
+ <!--
<delete dir="${TEST_DIR}" />
- <mkdir dir="${TEST_DIR}/js" />\r
- <copy todir="${TEST_DIR}" file="${BUILD_DIR}/test/index.html" />
- <copy todir="${TEST_DIR}/js">
- <fileset dir="${BUILD_DIR}/test/js">
- <include name="**/*.js"/>
- </fileset>
+ <mkdir dir="${TEST_DIR}/data" />
+ <copy todir="${TEST_DIR}/data">
+ <fileset dir="${BUILD_DIR}/test/data/" />
</copy>
+ <copy todir="${TEST_DIR}" file="${BUILD_DIR}/test/index.html" />
+ -->
+ <echo message="Test Suite built." />
+ </target>
+ <target name="docs" depends="jquery" description="Reads inline docs from source and compiles into xml file">
+ <echo message="Building Documentation" />
+ <delete dir="${DOCS_DIR}" />
+ <mkdir dir="${DOCS_DIR}/data" />
+ <copy todir="${DOCS_DIR}" file="${BUILD_DIR}/docs/.htaccess" />
+ <mkdir dir="${DOCS_DIR}/js" />
+ <copy todir="${DOCS_DIR}/js">
+ <fileset dir="${BUILD_DIR}/docs/js">
+ <include name="**/*.js" />
+ </fileset>
+ </copy>
+ <copy todir="${DOCS_DIR}/style">
+ <fileset dir="${BUILD_DIR}/docs/style">
+ <include name="**" />
+ </fileset>
+ </copy>
<java jar="${JAR}" fork="true">
- <arg value="${BUILD_DIR}/test/test.js" />
+ <arg value="${BUILD_DIR}/docs/docs.js" />
<arg value="${JQ}" />
- <arg value="${TEST_DIR}" />
+ <arg value="${DOCS_DIR}" />
</java>
- <echo message="Test Suite built." />
+ <echo message="Documentation built." />
</target>
- <target name="docs" depends="jquery">
+ <!-- TODO refactor to remove duplication with above -->
+ <target name="docs_with_plugins" depends="jquery_with_plugins">
<echo message="Building Documentation" />
<delete dir="${DOCS_DIR}" />
<mkdir dir="${DOCS_DIR}/data" />
- <copy todir="${DOCS_DIR}" file="${BUILD_DIR}/docs/.htaccess" />
+ <copy todir="${DOCS_DIR}" file="${BUILD_DIR}/docs/.htaccess" />
<mkdir dir="${DOCS_DIR}/js" />
- <copy todir="${DOCS_DIR}/js" >
+ <copy todir="${DOCS_DIR}/js">
<fileset dir="${BUILD_DIR}/docs/js">
- <include name="**/*.js"/>
+ <include name="**/*.js" />
</fileset>
</copy>
- <copy todir="${DOCS_DIR}/style" >
+ <copy todir="${DOCS_DIR}/style">
<fileset dir="${BUILD_DIR}/docs/style">
- <include name="**"/>
+ <include name="**" />
</fileset>
</copy>
<java jar="${JAR}" fork="true">
</java>
<echo message="Documentation built." />
</target>
+
+ <target name="runtest">
+ <echo message="Running Automated Test Suite" />
+ <java jar="${JAR}" fork="true">
+ <arg value="${BUILD_DIR}/runtest/test.js" />
+ </java>
+ <echo message="Test Suite Finished" />
+ </target>
<target name="clean">
<delete dir="${DOCS_DIR}" />
- <delete dir="${TEST_DIR}" />
+ <!-- <delete dir="${TEST_DIR}" /> -->
<delete dir="${DIST_DIR}" />
</target>
- <target name="all" depends="clean,jquery,lite,min,pack,docs,test" >
+ <target name="all" depends="clean,jquery,lite,min,pack,docs">
<echo message="Build complete." />
</target>