https://github.com/suchesqiu/360UXC
http://uxc.btbtd.org/document.html
http://uxc.btbtd.org/uxc_docs/classes/window.UXC.html
uxc_docs/classes/window.UXC.html
http://360.75team.com/~qiushaowei/uxcjs/
http://360.75team.com/~qiushaowei/uxcjs/document.html
http://360.75team.com/~qiushaowei/uxcjs/uxc_docs/classes/window.UXC.html
git clone https://github.com/suchesqiu/360UXC.git
如果发现 https clone 比较慢的话, 可以尝试一下 http
git clone http://github.com/suchesqiu/360UXC.git
https://github.com/suchesqiu/360UXC/archive/master.zip
library root //组件库所在目录
├── document.html //本说明文档
├── lib.js //lib.js = jquery.js + common.js + UXC.js
├── jquery.js //jquery 1.9.1
├── common.js //一些通用函数，组件中用到的函数如果出现在多个地方，可以考虑转移到这里
├── UXC.js //UXC 资源控制器
├── _demo //UXC 资源控制器 使用例子
├── uxc_docs //UXC 组件库 API 文档
├── comps //comps 目录存放由UXC Project开发人员开发的jquery组件
│ ├── Calendar //日历组件
│ ├── Form //表单常用功能组件
│ ├── LunarCalendar //农历日历组件
│ ├── Panel //弹框组件( UXC.Panel, UXC.alert, UXC.confirm, UXC.Dialog, UXC.Dialog.alert, UXC.Dialog.config );
│ ├── Tab //Tab组件
│ ├── Test //测试组件, 新建组件时，直接拷贝这个目录变更一个名字
│ ├── Tips //Tips组件
│ ├── Tree //树菜单组件
│ └── Valid //表单验证组件
├── plugins //这个目录存放一些常用的第三方脚本
│ ├── base64.js
│ ├── jquery.form.js
│ ├── json2.js
│ ├── md5.js
│ ├── rate
│ └── swfobject.js
├── widgets //这个目录存放一些HTML小部件
│ └── IframeUpload
└── tools //这个目录存放一些有用的工具
├── generate_yuidoc_for_uxc.sh //生成API文档shell
├── node_remove_View_Model.js //nodejs API 文档过滤脚本
└── php //PHP 工具，列目录用
源码托管使用 git, 项目主页: https://github.com/suchesqiu/360UXC
http://dojotoolkit.org/reference-guide/1.9/developer/styleguide.html
http://yui.github.io/yuidoc/syntax/index.html
写注释时请务必按照YUIDoc规范书写, API文档是从注释里直接生成的~
推荐使用: TortoiseGit https://code.google.com/p/tortoisegit/
或者到 github 官网下载官方客户端
不用windows的同学自己会知道怎么弄的~
从开发人员列表中找到 qiushaowei 的联系方式~ 告知你的github用户名
然后 qiushaowei 会把你加入到开发人员列表中
在没有加入到开发人员名单之前, 你可以 clone 项目, 但是没有提交更改的权限
注意: 你建立的分支应该是 master 的一个 copy, 不是 dev 的 copy
什么是组件?
组件在UXC项目里是指那些需要 使用 new 关键字初始化的 应用.
组件应该存放在那个目录?
目前组件的存放目录规划位于 libpath/comps 目录
组件的基础结构?
每个组件都有自己的独立文件夹, 并且脚本名称大小写与文件夹保持一致
开始开发组件
请查看 libpath/comps/Test 目录, 这是个示例组件,
开发组件时可以直接copy Test组件然后改一下文件和内容命名
Library/comsp/Test 示例组件
├── _demo 效果演示
│ ├── index.php 列目录资源的PHP
│ └── simple_demo.html 演示默认例子
├── index.php 列目录资源的PHP
├── res 资源目录, 这个目录规划是可以各种themes, 每个 themes有自己对象的目录
│ └── default 默认 themes
│ ├── style.css
│ └── style.html
└── Test.js 组件的js脚本, 命名应该与组件目录大小写保持一致
什么是jquery插件?
jquery插件在UXC项目里是指那些 扩展 jquery 对象的应用
jquery插件应该存放在那个目录?
目前jquery插件的存放目录规划位于 libpath/plugins
jquery插件的基础结构?
jquery 插件可以是独立的一个脚本, 或者是带有自己的文件夹
example:
libpath/plugins/json2.js
libpath/plugins/rate/rate.js
jquery插件的开发规范请见官方文档:
http://learn.jquery.com/plugins/basic-plugin-creation/
什么是小部件?
小部件在UXC项目里是指那些不是 jquery组件 也不是 jquery插件的应用
比如目前小部件里的 IframeUpload
BaiduEditor, FCKEditor, swfupload 也可以归类到 小部件里
那到底什么是小部件?
简单的说法就是用 javascript写的小工具, 但不限于 javascript小工具~
也可以是其他语言写的小工具~ 比如 as, java~
小部件应该存放在那个目录?
目前小部件的存放目录规划位于 libpath/widgets
生成文档需要的运行环境: nodejs, yuidocjs(nodejs plugin)
cd libpath/tools
sh generate_yuidoc_for_uxc.sh
cd libpath/tools
generate_yuidoc_for_uxc.sh
生成后的文档存放在 libpath/uxc_docs
确保一切无误后, 把要发布的组件 copy到master分支里
当前的开发分支不是master分支, 怎么 copy到master分支里?
最简单的方法就是用 git clone 获取一个新的 master分支
如果你已经获取过一个 master分支, 记得先 git pull origin master 更新一下 master分支
然后在master分支里运行一下 文档生成脚本~
再次检查一下文档和代码是否正常
没有问题当然就是提交更改了~