DataTables

mirror of https://github.com/DataTables/DataTables.git synced 2025-03-21 13:29:04 +01:00

Go to file

Allan Jardine a0455fa858 New: The primary public interface for DataTables' initialisation options is now camel case parameters rather than the Hungarian notation that was used before. There are a number of reasons for doing this, the primary one being that the Hungarian notation used by DataTables is actively stopping people from using the library due to their aversion to using Hungarian notation. Without doubt the Hungarian notation used was a mistake (the reason it was used was that when DataTables was originally written, the company I worked for at the time required the use of Hungarian notation, and thus I was trained in it...).

Backwards compatibility issues: The main goal here (other than to use camel-case notation!) is to preserve backwards compatibility. Unfortunately this isn't 100% possible:
	- DataTable.defaults.columns has been renamed to be DataTable.defaults.column
		- Otherwise it conflicts with aoColumns in the defaults.

Without doubt this is going to be a long process - for example the unit tests and examples need to be completely updated for this change. The JSDoc comments have been updated, so the site should take care of itself for the most part, when released.

In terms of implementation, it is important to note that I have not broken backwards compatibility here - the way it is does is that the current defaults are retained, and a camel-case to Hungarian mapping is automatically generated and then applied to the objects given by the end user. This adds around 0.5K to the size of DataTables, but writing the mapping manually would require at least 3K, and changing DataTables wholesale to camel-case would utterly break backwards compatibility. This is the least 'evil' way to accomplish this. It is important to note that this is a step along the roadmap for DataTables - come v2 Hungarian notation will likely be dropped completely.

One important note to make about this mapping is that if you use camel-case DataTables will copy the value from the camel-case properties to their Hungarian counterparts, so you will end up with additional properties on your source object. As I say, this appears to be to be the least 'evil' option, although still not perfect itself. The challenges of working with legacy software and installs...!

2012-10-07 11:50:29 +01:00

examples

New: The primary public interface for DataTables' initialisation options is now camel case parameters rather than the Hungarian notation that was used before. There are a number of reasons for doing this, the primary one being that the Hungarian notation used by DataTables is actively stopping people from using the library due to their aversion to using Hungarian notation. Without doubt the Hungarian notation used was a mistake (the reason it was used was that when DataTables was originally written, the company I worked for at the time required the use of Hungarian notation, and thus I was trained in it...).

2012-10-07 11:50:29 +01:00

media

2012-10-07 11:50:29 +01:00

scripts

New: component.json file for Bower ( http://twitter.github.com/bower/ ) support. Both component.json and package.json are generated with the correct version number in them.

2012-09-15 10:52:19 +01:00

.gitignore

Dev: Ignore the Plugins repo

2012-06-22 08:18:53 +01:00

component.json

2012-10-07 11:50:29 +01:00

license-bsd.txt

Initial commit - DataTables 1.7.0

2010-08-17 08:42:13 +01:00

license-gpl2.txt

Initial commit - DataTables 1.7.0

2010-08-17 08:42:13 +01:00

package.json

2012-10-07 11:50:29 +01:00

Readme.txt

Update readme for v1.9 and note that the license can be either/or for the GPLv2 or BSD

2011-12-14 15:11:14 +00:00

Readme.txt

This DataTables plugin (v1.9.x) for jQuery was developed out of the desire to allow highly configurable access to HTML tables with advanced access features.

For detailed installation, usage and API instructions, please refer to the DataTables web-pages: http://www.datatables.net

Questions, feature requests and bug reports (etc) can all be asked on the DataTables forums: http://www.datatables.net/forums/

The DataTables source can be found in the media/js/ directory of this archive.

DataTables is released with dual licensing, using the GPL v2 (license-gpl2.txt) and an BSD style license (license-bsd.txt). You may select which of the two licenses you wish to use DataTables under. Please see the corresponding license file for details of these licenses. You are free to use, modify and distribute this software, but all copyright information must remain.

If you discover any bugs in DataTables, have any suggestions for improvements or even if you just like using it, please free to get in touch with me: www.datatables.net/contact