Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 418 lines (269 sloc) 10.022 kb
ebf2fac @xavierm02 Javascript -> JavaScript except if it was intentional to avoid letting n...
xavierm02 authored
1 [jQuery](http://jquery.com/) - New Wave JavaScript
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
2 ==================================================
a1bb3ee from txt to markdown
Michael Bensoussan authored
3
65d3dc6 @rwaldron Landing pull request 611. Adds Contributing to jQuery Guidelines section...
rwaldron authored
4 Contribution Guides
5 --------------------------------------
6
7 In the spirit of open source software development, jQuery always encourages community code contribution. To help you get started and before you jump into writing code, be sure to read these important contribution guidelines thoroughly:
b290b1f @rwaldron Fix Contribution Guides list of links, hopefully easier to notice and re...
rwaldron authored
8
65d3dc6 @rwaldron Landing pull request 611. Adds Contributing to jQuery Guidelines section...
rwaldron authored
9 1. [Getting Involved](http://docs.jquery.com/Getting_Involved)
10 2. [Core Style Guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines)
11 3. [Tips For Bug Patching](http://docs.jquery.com/Tips_for_jQuery_Bug_Patching)
12
13
a1bb3ee from txt to markdown
Michael Bensoussan authored
14 What you need to build your own jQuery
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
15 --------------------------------------
a1bb3ee from txt to markdown
Michael Bensoussan authored
16
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
17 In order to build jQuery, you need to have GNU make 3.8 or later, Node.js/npm latest, and git 1.7 or later.
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
18 (Earlier versions might work OK, but are not tested.)
a1bb3ee from txt to markdown
Michael Bensoussan authored
19
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
20 Windows users have two options:
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
21
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
22 1. Install [msysgit](https://code.google.com/p/msysgit/) (Full installer for official Git),
23 [GNU make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm), and a
24 [binary version of Node.js](http://node-js.prcn.co.cc/). Make sure all three packages are installed to the same
25 location (by default, this is C:\Program Files\Git).
3d0aa19 @csnover Clarify cygwin instructions slightly and swap the order of arguments to ...
csnover authored
26 2. Install [Cygwin](http://cygwin.com/) (make sure you install the git, make, and which packages), then either follow
27 the [Node.js build instructions](https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-%28Windows%29) or install
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
28 the [binary version of Node.js](http://node-js.prcn.co.cc/).
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
29
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
30 Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from
31 [Apple's Xcode site](http://developer.apple.com/technologies/xcode.html)) and
86f8d9f @joyvuu-dave Minor typo with Homebrew link. Close gh-929.
joyvuu-dave authored
32 [Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run `brew install git` to install git,
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
33 and `brew install node` to install Node.js.
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
34
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
35 Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source
36 if you swing that way. Easy-peasy.
a1bb3ee from txt to markdown
Michael Bensoussan authored
37
38
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
39 How to build your own jQuery
40 ----------------------------
a1bb3ee from txt to markdown
Michael Bensoussan authored
41
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
42 First, clone a copy of the main jQuery git repo by running:
43
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
44 ```bash
45 git clone git://github.com/jquery/jquery.git
46 ```
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
47
6b9fde1 @mathiasbynens Add README info on how to create custom builds. Close gh-892.
mathiasbynens authored
48 Enter the directory and install the Node dependencies:
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
49
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
50 ```bash
51 cd jquery && npm install
52 ```
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
53
54
55 Make sure you have `grunt` installed by testing:
56
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
57 ```bash
58 grunt -version
59 ```
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
60
61
62
d487b06 @rwaldron Fixes two typos
rwaldron authored
63 Then, to get a complete, minified (w/ Uglify.js), linted (w/ JSHint) version of jQuery, type the following:
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
64
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
65 ```bash
66 grunt
67 ```
950b5d6 @jeresig Added in integrated JSLint checking against the jQuery source. Just run ...
jeresig authored
68
69
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
70 The built version of jQuery will be put in the `dist/` subdirectory.
a1bb3ee from txt to markdown
Michael Bensoussan authored
71
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
72
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
73 ### Modules (new in 1.8)
74
47298a7 @kborchers Fix typo in README
kborchers authored
75 Starting in jQuery 1.8, special builds can now be created that optionally exclude or include any of the following modules:
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
76
5019277 @jaubourg Adds ajax to the list of optional modules.
jaubourg authored
77 - ajax
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
78 - css
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
79 - dimensions
80 - effects
81 - offset
82
83
6b9fde1 @mathiasbynens Add README info on how to create custom builds. Close gh-892.
mathiasbynens authored
84 Before creating a custom build for use in production, be sure to check out the latest stable version:
85
86 ```bash
87 git pull; git checkout $(git describe --abbrev=0 --tags)
88 ```
89
90 Then, make sure all Node dependencies are installed and all Git submodules are checked out:
91
92 ```bash
93 npm install && grunt
94 ```
95
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
96 To create a custom build, use the following special `grunt` commands:
97
5019277 @jaubourg Adds ajax to the list of optional modules.
jaubourg authored
98 Exclude **ajax**:
99
100 ```bash
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
101 grunt custom:-ajax
102 ```
103
104 Exclude **css**:
105
106 ```bash
107 grunt custom:-css
5019277 @jaubourg Adds ajax to the list of optional modules.
jaubourg authored
108 ```
109
a275837 @rwaldron Adds src/deprecated.js, test/unit/deprecated.js; -deprecated flag; Moves...
rwaldron authored
110 Exclude **deprecated**:
111
112 ```bash
113 grunt custom:-deprecated
114 ```
115
a86ed30 @rwaldron Make exclusion list less confusing to read
rwaldron authored
116 Exclude **dimensions**:
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
117
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
118 ```bash
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
119 grunt custom:-dimensions
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
120 ```
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
121
a86ed30 @rwaldron Make exclusion list less confusing to read
rwaldron authored
122 Exclude **effects**:
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
123
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
124 ```bash
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
125 grunt custom:-effects
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
126 ```
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
127
a86ed30 @rwaldron Make exclusion list less confusing to read
rwaldron authored
128 Exclude **offset**:
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
129
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
130 ```bash
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
131 grunt custom:-offset
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
132 ```
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
133
134 Exclude **all** optional modules:
135
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
136 ```bash
d8f9dec @mathiasbynens README: Add to the full list of optional modules. Closes gh-855
mathiasbynens authored
137 grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-offset
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
138 ```
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
139
140
f13de6b @rwaldron Simplify the terminal command args syntax for custom builds. Update READ...
rwaldron authored
141 Note: dependencies will be handled internally, by the build process.
142
c68ab27 @mikesherov Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. Fix...
mikesherov authored
143
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
144 Running the Unit Tests
145 --------------------------------------
146
147
148 Start grunt to auto-build jQuery as you work:
149
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
150 ```bash
151 cd jquery && grunt watch
152 ```
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
153
154
155 Run the unit tests with a local server that supports PHP. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:
156
157 - Windows: [WAMP download](http://www.wampserver.com/en/)
158 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
159 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
160 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
161
162
a1bb3ee from txt to markdown
Michael Bensoussan authored
163
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
164
165 Building to a different directory
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
166 ---------------------------------
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
167
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
168 If you want to build jQuery to a directory that is different from the default location:
a1bb3ee from txt to markdown
Michael Bensoussan authored
169
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
170 ```bash
171 grunt && grunt dist:/path/to/special/location/
172 ```
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
173 With this example, the output files would be:
174
175 ```bash
9fb3c01 @rwaldron Make custom dist example less OSX specific
rwaldron authored
176 /path/to/special/location/jquery.js
177 /path/to/special/location/jquery.min.js
7c23b77 @rwaldron Strips IIFEs from modules; Always require built jQuery for tests.
rwaldron authored
178 ```
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
179
8265fa0 @rwaldron Allow users to store custom dist destinations in dist/.destination.json
rwaldron authored
180 If you want to add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
181
182 ```json
183
184 {
185 "/Absolute/path/to/other/destination": true
186 }
187 ```
188
189
190 Additionally, both methods can be combined.
191
192
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
193
ef31b67 @rwaldron Adds "grunt submodules" docs to readme, removes old make command docs
rwaldron authored
194 Updating Submodules
195 -------------------
196
197 Update the submodules to what is probably the latest upstream code.
198
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
199 ```bash
200 grunt submodules
201 ```
ef31b67 @rwaldron Adds "grunt submodules" docs to readme, removes old make command docs
rwaldron authored
202
203 Note: This task will also be run any time the default `grunt` command is used.
204
205
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
206
5dde3eb @azatoth Git for dummies
azatoth authored
207 Git for dummies
208 ---------------
209
210 As the source code is handled by the version control system Git, it's useful to know some features used.
211
212 ### Submodules ###
213
467747d @robmorgan Fixing typos in the README.md file
robmorgan authored
214 The repository uses submodules, which normally are handled directly by the Makefile, but sometimes you want to
5dde3eb @azatoth Git for dummies
azatoth authored
215 be able to work with them manually.
216
217 Following are the steps to manually get the submodules:
218
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
219 ```bash
220 git clone https://github.com/jquery/jquery.git
c210e08 @mathiasbynens README: Adds missing commands to setup instructions. Closes gh-854
mathiasbynens authored
221 cd jquery
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
222 git submodule init
223 git submodule update
224 ```
5dde3eb @azatoth Git for dummies
azatoth authored
225
226 Or:
227
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
228 ```bash
229 git clone https://github.com/jquery/jquery.git
c210e08 @mathiasbynens README: Adds missing commands to setup instructions. Closes gh-854
mathiasbynens authored
230 cd jquery
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
231 git submodule update --init
232 ```
5dde3eb @azatoth Git for dummies
azatoth authored
233
234 Or:
235
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
236 ```bash
237 git clone --recursive https://github.com/jquery/jquery.git
c210e08 @mathiasbynens README: Adds missing commands to setup instructions. Closes gh-854
mathiasbynens authored
238 cd jquery
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
239 ```
5dde3eb @azatoth Git for dummies
azatoth authored
240
241 If you want to work inside a submodule, it is possible, but first you need to checkout a branch:
242
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
243 ```bash
244 cd src/sizzle
245 git checkout master
246 ```
5dde3eb @azatoth Git for dummies
azatoth authored
247
467747d @robmorgan Fixing typos in the README.md file
robmorgan authored
248 After you've committed your changes to the submodule, you'll update the jquery project to point to the new commit,
5dde3eb @azatoth Git for dummies
azatoth authored
249 but remember to push the submodule changes before pushing the new jquery commit:
250
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
251 ```bash
252 cd src/sizzle
253 git push origin master
254 cd ..
255 git add src/sizzle
256 git commit
257 ```
5dde3eb @azatoth Git for dummies
azatoth authored
258
259
260 ### cleaning ###
261
262 If you want to purge your working directory back to the status of upstream, following commands can be used (remember everything you've worked on is gone after these):
263
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
264 ```bash
265 git reset --hard upstream/master
266 git clean -fdx
267 ```
5dde3eb @azatoth Git for dummies
azatoth authored
268
269 ### rebasing ###
270
271 For feature/topic branches, you should always used the `--rebase` flag to `git pull`, or if you are usually handling many temporary "to be in a github pull request" branches, run following to automate this:
272
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
273 ```bash
274 git config branch.autosetuprebase local
275 ```
276 (see `man git-config` for more information)
5dde3eb @azatoth Git for dummies
azatoth authored
277
278 ### handling merge conflicts ###
279
280 If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature
281 `git mergetool`. Even though the default tool `xxdiff` looks awful/old, it's rather useful.
282
283 Following are some commands that can be used there:
284
285 * `Ctrl + Alt + M` - automerge as much as possible
286 * `b` - jump to next merge conflict
287 * `s` - change the order of the conflicted lines
288 * `u` - undo an merge
289 * `left mouse button` - mark a block to be the winner
290 * `middle mouse button` - mark a line to be the winner
291 * `Ctrl + S` - save
292 * `Ctrl + Q` - quit
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
293
a8d9d05 @timmywil Add quick-start documentation for testing with QUnit and using jQuery's ...
timmywil authored
294 [QUnit](http://docs.jquery.com/QUnit) Reference
295 -----------------
296
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
297 ### Test methods ###
298
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
299 ```js
300 expect( numAssertions );
301 stop();
302 start();
303 ```
304
305
306 note: QUnit's eventual addition of an argument to stop/start is ignored in this test suite so that start and stop can be passed as callbacks without worrying about their parameters
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
307
308 ### Test assertions ###
309
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
310
311 ```js
312 ok( value, [message] );
313 equal( actual, expected, [message] );
314 notEqual( actual, expected, [message] );
315 deepEqual( actual, expected, [message] );
316 notDeepEqual( actual, expected, [message] );
317 strictEqual( actual, expected, [message] );
318 notStrictEqual( actual, expected, [message] );
319 raises( block, [expected], [message] );
320 ```
321
a8d9d05 @timmywil Add quick-start documentation for testing with QUnit and using jQuery's ...
timmywil authored
322
323 Test Suite Convenience Methods Reference (See [test/data/testinit.js](https://github.com/jquery/jquery/blob/master/test/data/testinit.js))
324 ------------------------------
325
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
326 ### Returns an array of elements with the given IDs ###
327
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
328 ```js
329 q( ... );
330 ```
331
332 Example:
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
333
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
334 ```js
335 q("main", "foo", "bar");
336
337 => [ div#main, span#foo, input#bar ]
338 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
339
162ffe7 @timmywil Update README: IDs are without hashes in t()
timmywil authored
340 ### Asserts that a selection matches the given IDs ###
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
341
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
342 ```js
343 t( testName, selector, [ "array", "of", "ids" ] );
344 ```
345
346 Example:
347
348 ```js
349 t("Check for something", "//[a]", ["foo", "baar"]);
350 ```
351
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
352
353
354 ### Fires a native DOM event without going through jQuery ###
355
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
356 ```js
357 fireNative( node, eventType )
358 ```
359
360 Example:
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
361
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
362 ```js
363 fireNative( jQuery("#elem")[0], "click" );
364 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
365
366 ### Add random number to url to stop caching ###
367
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
368 ```js
369 url( "some/url.php" );
370 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
371
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
372 Example:
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
373
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
374 ```js
375 url("data/test.html");
376
377 => "data/test.html?10538358428943"
378
379
380 url("data/test.php?foo=bar");
381
382 => "data/test.php?foo=bar&10538358345554"
383 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
384
385
386 ### Load tests in an iframe ###
387
388 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
389 and fires the given callback on jQuery ready (using the jQuery loading from that page)
390 and passes the iFrame's jQuery to the callback.
391
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
392 ```js
393 testIframe( fileName, testName, callback );
394 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
395
396 Callback arguments:
397
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
398 ```js
399 callback( jQueryFromIFrame, iFrameWindow, iFrameDocument );
400 ```
5660b6d @timmywil Update README to stylize docs on jQuery's test suite methods
timmywil authored
401
402 ### Load tests in an iframe (window.iframeCallback) ###
403
404 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
405 The given callback is fired when window.iframeCallback is called by the page
406 The arguments passed to the callback are the same as the
407 arguments passed to window.iframeCallback, whatever that may be
408
3b2d2b0 @rwaldron Make readme code examples consistent; Update to use GH syntax fences
rwaldron authored
409 ```js
410 testIframeWithCallback( testName, fileName, callback );
411 ```
a8d9d05 @timmywil Add quick-start documentation for testing with QUnit and using jQuery's ...
timmywil authored
412
4e337f5 @dcneiner Updated README file with updated information for the Rake addtions
dcneiner authored
413 Questions?
414 ----------
a1bb3ee from txt to markdown
Michael Bensoussan authored
415
d503845 @csnover Replace build system with a faster new one that uses Node and UglifyJS a...
csnover authored
416 If you have any questions, please feel free to ask on the
417 [Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.
Something went wrong with that request. Please try again.