Skip to content

Commit a87839b

Browse files
committed
Conflicts: entries/jQuery.ajax.xml
2 parents d3ccb43 + 2a93e01 commit a87839b

File tree

320 files changed

+11436
-7466
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

320 files changed

+11436
-7466
lines changed

.gitattributes

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# JS files must always use LF for tools to work
5+
*.js eol=lf

.gitignore

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
dist
2-
entries_tmp
3-
node_modules
4-
config.json
5-
.project
6-
*~
7-
*.diff
8-
*.patch
9-
.DS_Store
10-
.settings
1+
/dist/
2+
/node_modules/
3+
config.js*

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Matic Potočnik <maticpotocnik@gmail.com> <hairyfotr@gmail.com>

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ Welcome! Thanks for your interest in contributing to api.jquery.com. You're **al
22

33
You may also want to take a look at our [commit & pull request guide](http://contribute.jquery.org/commits-and-pull-requests/) and [style guides](http://contribute.jquery.org/style-guide/) for instructions on how to maintain your fork and submit your code. Before we can merge any pull request, we'll also need you to sign our [contributor license agreement](http://contribute.jquery.org/cla).
44

5-
You can find us on [IRC](http://irc.jquery.org), specifically in [#jquery-dev](irc://irc.freenode.net/#jquery-dev) and [#jquery-content](irc://irc.freenode.net/#jquery-content) should you have any questions. If you've never contributed to open source before, we've put together [a short guide with tips, tricks, and ideas on getting started](http://contribute.jquery.org/open-source/).
5+
You can find us on [IRC](http://irc.jquery.org), specifically in #jquery-dev and #jquery-content should you have any questions. If you've never contributed to open source before, we've put together [a short guide with tips, tricks, and ideas on getting started](http://contribute.jquery.org/open-source/).

Gruntfile.js

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
module.exports = function( grunt ) {
2+
3+
grunt.loadNpmTasks( "grunt-jquery-content" );
4+
5+
grunt.initConfig({
6+
xmllint: {
7+
all: [
8+
"entries/**",
9+
"includes/**",
10+
"categories.xml",
11+
"entries2html.xsl",
12+
"notes.xsl"
13+
]
14+
},
15+
"build-posts": {
16+
page: "pages/**"
17+
},
18+
"build-xml-entries": {
19+
all: "entries/**"
20+
},
21+
"build-resources": {
22+
all: "resources/**"
23+
},
24+
wordpress: (function() {
25+
var config = require( "./config" );
26+
config.dir = "dist/wordpress";
27+
return config;
28+
})()
29+
});
30+
31+
grunt.registerTask( "lint", [ "xmllint" ]);
32+
33+
grunt.registerTask( "build", [
34+
"build-posts",
35+
"build-resources",
36+
"build-xml-entries",
37+
"build-xml-categories",
38+
"build-xml-full"
39+
]);
40+
41+
};

LICENSE-MIT.txt renamed to LICENSE.txt

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
Copyright (c) 2009 Packt Publishing, http://packtpub.com/
2-
Copyright (c) 2013 jQuery Foundation, http://jquery.org/
1+
Copyright Packt Publishing (http://packtpub.com/),
2+
jQuery Foundation (https://jquery.org/), and other contributors.
33

44
This software consists of voluntary contributions made by many
55
individuals. For exact contribution history, see the revision history
6-
and logs, available at http://github.com/jquery/api.jquery.com
6+
available at https://github.com/jquery/api.jquery.com
7+
8+
The following license applies to all parts of this software except as
9+
documented below:
10+
11+
====
712

813
Permission is hereby granted, free of charge, to any person obtaining
914
a copy of this software and associated documentation files (the
@@ -23,3 +28,18 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
2328
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
2429
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
2530
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31+
32+
====
33+
34+
Copyright and related rights for sample code are waived via CC0. Sample
35+
code is defined as all source code displayed within the prose of the
36+
documentation and all examples and demos.
37+
38+
CC0: http://creativecommons.org/publicdomain/zero/1.0/
39+
40+
====
41+
42+
All files located in the node_modules directory are externally
43+
maintained libraries used by this software which have their own
44+
licenses; we recommend you read them, as their terms may differ from the
45+
terms above.

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
1-
## Referencing Bug Tracker Tickets
1+
# api.jquery.com
22

3-
* Pull requests for changes that were requested or recommended via the [jQuery Bug Tracker](http://bugs.jquery.com) should include a link back to the relevant ticket.
3+
## Building and Deploying
44

5-
## Building
5+
To build and deploy your changes for previewing in a [`jquery-wp-content`](https://github.com/jquery/jquery-wp-content) instance, follow the [workflow instructions](http://contribute.jquery.org/web-sites/#workflow) from our documentation on [contributing to jQuery Foundation web sites](http://contribute.jquery.org/web-sites/).
66

77
### Requirements
8-
* <a href="http://www.xmlsoft.org/">libxml2</a>
9-
* <a href="http://xmlsoft.org/XSLT/">libxslt</a>
108

11-
The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://www.zlatkovic.com/libxml.en.html">zlatkovic.com</a>.
12-
13-
### Build
9+
* [libxml2](http://xmlsoft.org/)
10+
* [libxslt](http://xmlsoft.org/libxslt/)
1411

15-
To build and deploy your changes for previewing in a [jquery-wp-content](https://github.com/jquery/jquery-wp-content) instance, follow the [workflow instructions](http://contribute.jquery.org/web-sites/#workflow) from our documentation on [contributing to jQuery Foundation web sites](http://contribute.jquery.org/web-sites/).
12+
The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://www.zlatkovic.com/libxml.en.html">zlatkovic.com</a>.
1613

1714
## Style Guidelines
1815

@@ -27,11 +24,13 @@ To build and deploy your changes for previewing in a [jquery-wp-content](https:/
2724
* **No**: The `load`, `scroll` and `error` events (e.g., on an `<img>` element) do not bubble
2825

2926
#### Spelling
27+
3028
* The documentation standardizes on American English spelling. For example:
3129
* **Yes**: color, while, among, customize, argument
3230
* **No**: colour, whilst, amongst, customise, arguement
3331

3432
#### Pronoun Usage
33+
3534
* Use second-person pronoun ("you") when necessary, but try to avoid it.
3635
* Favor the definite article ("the") over second-person possesive ("your").
3736
* **Yes**: Insert the paragraph after the unordered list.
@@ -41,28 +40,32 @@ To build and deploy your changes for previewing in a [jquery-wp-content](https:/
4140
* **No**: And now we have our paragraph beneath the unordered list.
4241

4342
#### "Voice"
43+
4444
* Prefer active voice over passive.
4545
* **Active**: Calling `.click()` binds a click handler to the elements in the collection
4646
* **Passive**: Click handlers are bound to elements in the collection when `.click()` is called
4747

4848
### Code Style
49-
Code in the API documentation should follow the [jQuery Core Style Guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines) with the following addition and exception:
49+
50+
Code in the API documentation should follow the [jQuery Core Style Guide](http://contribute.jquery.org/style-guide/) with the following addition:
5051

5152
* **Document ready syntax**: Use `$( document ).ready(function() {` instead of `$(function() {` as it's harder for new users to distinguish the difference between the latter and an IIFE.
52-
* **Indentation**: Core guidelines say to use tabs. In API documentation, *use 2 spaces instead*. This helps keep the line width manageable and avoid horizontal scrollbars.
5353

5454
#### Code within prose content (paragraphs and the like):
55-
* Methods: use a dot, followed by the method name, followed by parentheses: e.g. The `.focus()` method is a shortcut for `.bind('focus', handler)` in the first and second variations, and `.trigger('focus')` in the third.
55+
56+
* Methods: use a dot, followed by the method name, followed by parentheses: e.g. The `.focus()` method is a shortcut for `.on( "focus", handler )` in the first and second variations, and `.trigger( "focus" )` in the third.
5657
* Properties: use a dot, followed by the property name: e.g. `.length`.
5758
* Functions: use the function name, followed by parentheses: `myFunction()`.
5859

5960
#### Examples
61+
6062
* Examples should indicate what the expected result will be before presenting the code. This makes code clearer and skimming easier, especially for newer coders who may not understand what is supposed to be happening from reading the code itself.
6163
* **Yes**: Find all p elements that are children of a div element and apply a border to them.
6264
* **No**: Find all p elements that are children of a div element.
6365
* Make your example easy to follow with good comments so that the explanation isn't necessary.
6466

6567
### Rhetorical Context
68+
6669
* Subject
6770
* The entirety of jQuery's public API
6871
* Audience

categories.xml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
<?xml version="1.0"?>
22
<categories>
33
<category name="Ajax" slug="ajax">
4-
<desc><![CDATA[The jQuery library has a full suite of AJAX capabilities. The functions and methods therein allow us to load data from the server without a browser page refresh. ]]></desc>
4+
<desc><![CDATA[The jQuery library has a full suite of Ajax capabilities. The functions and methods therein allow us to load data from the server without a browser page refresh. ]]></desc>
55
<category name="Global Ajax Event Handlers" slug="global-ajax-event-handlers">
6-
<desc><![CDATA[These methods register handlers to be called when certain events, such as initialization or completion, take place for any AJAX request on the page. The global events are fired on each AJAX request if the <code>global</code> property in <a href="http://api.jquery.com/jQuery.ajaxSetup/"><code>jQuery.ajaxSetup()</code></a> is <code>true</code>, which it is by default. <em>Note: Global events are never fired for cross-domain script or JSONP requests, regardless of the value of <code>global</code>.</em>]]></desc>
6+
<desc><![CDATA[These methods register handlers to be called when certain events, such as initialization or completion, take place for any Ajax request on the page. The global events are fired on each Ajax request if the <code>global</code> property in <a href="/jQuery.ajaxSetup/"><code>jQuery.ajaxSetup()</code></a> is <code>true</code>, which it is by default. <em>Note: Global events are never fired for cross-domain script or JSONP requests, regardless of the value of <code>global</code>.</em>]]></desc>
77
</category>
88
<category name="Helper Functions" slug="helper-functions">
9-
<desc><![CDATA[These functions assist with common idioms encountered when performing AJAX tasks.]]></desc>
9+
<desc><![CDATA[These functions assist with common idioms encountered when performing Ajax tasks.]]></desc>
1010
</category>
1111
<category name="Low-Level Interface" slug="low-level-interface">
12-
<desc><![CDATA[These methods can be used to make arbitrary AJAX requests.]]></desc>
12+
<desc><![CDATA[These methods can be used to make arbitrary Ajax requests.]]></desc>
1313
</category>
1414
<category name="Shorthand Methods" slug="shorthand-methods">
15-
<desc><![CDATA[These methods perform the more common types of AJAX requests in less code.]]></desc>
15+
<desc><![CDATA[These methods perform the more common types of Ajax requests in less code.]]></desc>
1616
</category>
1717
</category>
1818
<category name="Attributes" slug="attributes">
@@ -38,7 +38,7 @@
3838
<desc/>
3939
<category name="Deprecated 1.3" slug="deprecated-1.3">
4040
<desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
41-
<p>For more information, see the <a href="http://docs.jquery.com/Release:jQuery_1.3">jQuery 1.3 Release Notes</a>.</p>
41+
<p>For more information, see the <a href="http://blog.jquery.com/2009/01/14/jquery-1-3-released/">jQuery 1.3 Release Notes</a>.</p>
4242
]]></desc>
4343
</category>
4444
<category name="Deprecated 1.4" slug="deprecated-1.4">
@@ -56,6 +56,11 @@
5656
<p>For more information, see the Release Notes/Changelog at <a href="http://blog.jquery.com/2012/08/09/jquery-1-8-released/">http://blog.jquery.com/2012/08/09/jquery-1-8-released/</a></p>
5757
]]></desc>
5858
</category>
59+
<category name="Deprecated 1.9" slug="deprecated-1.9">
60+
<desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
61+
<p>For more information, see the Release Notes/Changelog at <a href="http://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/">http://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/</a></p>
62+
]]></desc>
63+
</category>
5964
<category name="Deprecated 1.10" slug="deprecated-1.10">
6065
<desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
6166
<p>For more information, see the Release Notes/Changelog at <a href="http://blog.jquery.com/2013/05/24/jquery-1-10-0-and-2-0-1-released/">http://blog.jquery.com/2013/05/24/jquery-1-10-0-and-2-0-1-released/</a></p>
@@ -138,7 +143,7 @@ jQuery( "body" ).trigger( e );
138143
</li>
139144
</ul>
140145
<p>The following properties are also copied to the event object, though some of their values may be undefined depending on the event:</p>
141-
<p>altKey, bubbles, button, cancelable, charCode, clientX, clientY, ctrlKey, currentTarget, data, detail, eventPhase, metaKey, offsetX, offsetY, originalTarget, pageX, pageY, prevValue, relatedTarget, screenX, screenY, shiftKey, target, view, which</p>
146+
<p>altKey, bubbles, button, cancelable, charCode, clientX, clientY, ctrlKey, currentTarget, data, detail, eventPhase, metaKey, offsetX, offsetY, originalTarget, pageX, pageY, relatedTarget, screenX, screenY, shiftKey, target, view, which</p>
142147
<h4>OtherProperties</h4>
143148
<p>Certain events may have properties specific to them. Those can be accessed as properties of the <code>event.originalEvent</code> object.</p>
144149
<p>Example:</p>
@@ -328,22 +333,22 @@ jQuery.event.props.push( "dataTransfer" );
328333
</category>
329334
<category name="Version 1.2" slug="1.2">
330335
<desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
331-
<a href="http://docs.jquery.com/Release:jQuery_1.2">jQuery 1.2 Release Notes</a>
336+
<a href="http://blog.jquery.com/2007/09/10/jquery-1-2-released/">jQuery 1.2 Release Notes</a>
332337
]]></desc>
333338
</category>
334339
<category name="Version 1.2.3" slug="1.2.3">
335340
<desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
336-
Release Notes: <a href="http://docs.jquery.com/Release:jQuery_1.2.1">1.2.1</a>, <a href="http://docs.jquery.com/Release:jQuery_1.2.2">1.2.2</a>, <a href="http://docs.jquery.com/Release:jQuery_1.2.3">1.2.3</a>.
341+
Release Notes: <a href="http://blog.jquery.com/2007/09/16/jquery-1-2-1-released/">1.2.1</a>, <a href="http://blog.jquery.com/2008/01/14/jquery-1-2-2-released/">1.2.2</a>, <a href="http://blog.jquery.com/2008/02/07/jquery-1-2-3-released/">1.2.3</a>.
337342
]]></desc>
338343
</category>
339344
<category name="Version 1.2.6" slug="1.2.6">
340345
<desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
341-
<a href="http://docs.jquery.com/Release:jQuery_1.2.6">jQuery 1.2.6 Release Notes</a>.
346+
<a href="http://blog.jquery.com/2008/05/24/jquery-1-2-6-released/">jQuery 1.2.6 Release Notes</a>.
342347
]]></desc>
343348
</category>
344349
<category name="Version 1.3" slug="1.3">
345350
<desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
346-
Release Notes: <a href="http://docs.jquery.com/Release:jQuery_1.3">1.3</a>, <a href="http://docs.jquery.com/Release:jQuery_1.3.1">1.3.1</a>, <a href="http://docs.jquery.com/Release:jQuery_1.3.2">1.3.2</a>
351+
Release Notes: <a href="http://blog.jquery.com/2009/01/14/jquery-1-3-released/">1.3</a>, <a href="http://blog.jquery.com/2009/01/21/jquery-131-released/">1.3.1</a>, <a href="http://blog.jquery.com/2009/02/20/jquery-1-3-2-released/">1.3.2</a>
347352
]]></desc>
348353
</category>
349354
<category name="Version 1.4" slug="1.4">

config-sample.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"url": "dev.api.jquery.com",
3-
"username": "admin",
4-
"password": "secret"
2+
"url": "vagrant.api.jquery.com",
3+
"username": "admin",
4+
"password": "secret"
55
}

0 commit comments

Comments
 (0)