root/trunk/mt-js-to-jquery/README.markdown

Revision 1514, 1.7 kB (checked in by bsmith, 8 months ago)

initial project commit

Line 
1# mt-js-to-jquery
2
3The following files are a work in progress to convert mt's js to use the jQuery javascript framework.
4
5This is not a plugin... yet. Ideally this project will be converted into a
6
7## Project Goals
8
9* Update MT to use jQuery framework in order to minimize the amount of custom javascript functions.
10* Allow all js scripts to be placed at the bottom of html in published page.
11* Abstract any js to be simple to read and customize.
12* Convert MT core functions into a jQuery plugin
13* (add more project goals here)
14
15## To Do
16
17* Create template set using these new jquery files.
18* Abstract references to specific ids and classes within the html. ie. comments-open, comments-form, comments-open-footer, comments-open-data, comments-open-captcha,
19* Update js published by MT template tags. ie. <mt:IfLoggedIn>, et. al.
20* (add more tasks here)
21* (add more tasks here)
22* (add more tasks here)
23
24## MT Blog Javascript (mt-blog.js)
25
26* This file defines blog variables and phrases which are used by javascript functions.
27* This file should be published as an index template in each MT blog.
28* This file should be published as mt-blog.js and included before mt.js
29* Ideally this file could be published once in an environment where SingleCommunity config directive is true.
30
31## MT Site Javascript (mt.js)
32
33* This file has a prerequsite of the a mt-blog.js file to for defining variables in the following functions
34* This file does not need to be published by MT and can be placed in the mt-static directory.
35
36## Notes
37
38* These files were initially developed for the MT Motion template set, and have been further developed for client work at Six Apart Services.
39* Contributors:
40    * Beau Smith - beau@sixapart.com
41    * (add more contributors here)
Note: See TracBrowser for help on using the browser.