README.md

   1 #LunarCalendar#
   2
   3 此為正體中文版本
   4
   5 請參閱[原始專案](https://github.com/zzyss86/LunarCalendar)
   6
   7 農曆（陰曆）萬年曆，是一款支持Node.js和瀏覽器端使用的全功能農曆和公曆日曆類庫。支持農曆與公曆之間相互轉換，含有二十四節氣，天干地支紀年紀月紀日，生肖屬相，公曆節假日及農曆傳統節假日信息等功能。自帶2013-2014節假日安排數據，並可自行配置。帶有黃曆數據，可自行選擇配置。支持1891-2100年。使用**LunarCalendar**可快速開發一款屬於自己的萬年曆產品，行動起來吧！
   8
   9 ##Install##
  10
  11 1. Node.js服務器端(使用npm安裝)：
  12 `npm install lunar-calendar`
  13 2. 瀏覽器端使用，引用腳本：
  14 `<script type="text/javascript" src="lib/LunarCalendar.min.js"></script>`
  15
  16
  17 ##Usage##
  18 ###Node.js###
  19 var LunarCalendar = require("lunar-calendar");
  20
  21 ###瀏覽器###
  22 `window.LunarCalendar`是一個全局對象，可以全局作用域直接調用。
  23
  24 ##DEMO產品：小推萬年曆（手機版）##
  25 訪問方式：（手機掃瞄二維碼）
  26
  27 ![二維碼](http://cdn.tuijs.com/upload/1956115939.png)
  28
  29 ![小推萬年曆截圖](http://cdn.tuijs.com/upload/calendar_photo.png)
  30
  31 ##方法列表##
  32 ###LunarCalendar.calendar(year,month[,fill])###
  33 通過公曆獲取某月農曆數據
  34
  35 ####參數說明####
  36 - @param {Number} `year` 公曆年 範圍[1891-2100]
  37 - @param {Number} `month` 公曆月 範圍[1-12]
  38 - @param {Boolean} `fill`（可選） 是否填充當月日曆首尾日期，設為true時，會在首尾填入上下月數據，自動補全一個7*6陣列數據。（可更美觀的打造你的萬年曆產品）
  39
  40 ####返回數據####
  41         {
  42             "firstDay": 5, //該月1號星期幾（日曆開始位置）
  43             "monthDays": 28, //該月天數
  44             "monthData": [ //本月所有日曆數據
  45                 {
  46                     "year": 2014, //公曆年
  47                     "month": 2, //公曆月
  48                     "day": 1, //公曆日
  49                     "zodiac": "蛇", //生肖屬相
  50                     "GanZhiYear": "癸巳", //干支紀年
  51                     "GanZhiMonth": "乙丑", //干支紀月
  52                     "GanZhiDay": "癸卯", //干支紀日
  53                     "worktime": 2, //0無特殊安排，1工作，2放假
  54                     "lunarYear": 2014, //農曆年
  55                     "lunarMonth": 1, //農曆月（1-13，有閏月情況，比如當前閏9月，10表示閏9月，11表示10月）
  56                     "lunarDay": 2, //農曆日
  57                     "lunarMonthName": "正月", //農曆月中文名
  58                     "lunarDayName": "初二", //農曆日中文名
  59                     "lunarLeapMonth": 9, //農曆閏月所在月份，0表示無閏月
  60                                 "solarFestival": "", //公曆節假日，undefined或『勞動節』之類
  61                                 "lunarFestival": "", //農曆節假日，undefined或『除夕』之類
  62                                 "term": "" //二十四節氣名，undefined或『立春』之類
  63                 },
  64                         ...
  65             ]
  66         }
  67
  68 ###LunarCalendar.solarCalendar(year,month[,fill])###
  69 獲取公曆某月日曆數據（不帶農曆信息）
  70
  71 ####參數說明####
  72 - @param {Number} `year` 公曆年 範圍[1-~]公元後
  73 - @param {Number} `month` 公曆月 範圍[1-12]
  74 - @param {Boolean} `fill`（可選） 是否填充當月日曆首尾日期，設為true時，會在首尾填入上下月數據，自動補全一個7*6陣列數據。（可更美觀的打造你的萬年曆產品）
  75
  76 ####返回數據####
  77         {
  78             "firstDay": 5, //該月1號星期幾（日曆開始位置）
  79             "monthDays": 28, //該月天數
  80             "monthData": [ //本月所有日曆數據
  81                 {
  82                     "year": 2014, //公曆年
  83                     "month": 2, //公曆月
  84                     "day": 1 //公曆日
  85                 },
  86                         ...
  87             ]
  88         }
  89
  90 ###LunarCalendar.solarToLunar(year,month,day)###
  91 將公曆轉換為農曆
  92
  93 ####參數說明####
  94 - @param {Number} `year` 公曆年 範圍[1891-2100]
  95 - @param {Number} `month` 公曆月 範圍[1-12]
  96 - @param {Number} `day` 公曆日 範圍[1-31]
  97
  98 ####返回數據####
  99         {
 100             "zodiac": "蛇", //生肖屬相
 101             "GanZhiYear": "癸巳", //干支紀年
 102             "GanZhiMonth": "乙丑", //干支紀月
 103             "GanZhiDay": "癸卯", //干支紀日
 104             "worktime": 2, //0無特殊安排，1工作，2放假
 105             "lunarYear": 2014, //農曆年
 106             "lunarMonth": 1, //農曆月（1-13，有閏月情況，比如當前閏9月，10表示閏9月，11表示10月）
 107             "lunarDay": 2, //農曆日
 108             "lunarMonthName": "正月", //農曆月中文名
 109             "lunarDayName": "初二", //農曆日中文名
 110             "lunarLeapMonth": 9, //農曆閏月所在月份，0表示無閏月
 111                 "solarFestival": "", //公曆節假日，undefined或『勞動節』之類
 112                 "lunarFestival": "", //農曆節假日，undefined或『除夕』之類
 113                 "term": "" //二十四節氣名，undefined或『立春』之類
 114         }
 115
 116 ###LunarCalendar.lunarToSolar(year,month,day)###
 117 將農曆轉換為公曆
 118
 119 ####參數說明####
 120 - @param {Number} `year` 農曆年 範圍[1891-2100]
 121 - @param {Number} `month` 農曆月 範圍[1-13]（有閏月情況，比如當前閏9月，10表示閏9月，11表示10月）
 122 - @param {Number} `day` 農曆日 範圍[1-30]
 123
 124 ####返回數據####
 125         {
 126             "year": 2014, //公曆年
 127             "month": 1, //公曆月
 128             "day": 31 //公曆日
 129         }
 130
 131 ###LunarCalendar.setWorktime(data)###
 132 設置某年的節假日安排信息（類庫已內置2013-2014年的數據）
 133
 134 ####參數說明####
 135 - @param {Object} `data` 節假日安排信息(以年為key，可設置多年)
 136 - 0：無特殊安排，1：工作，2：放假
 137
 138 **參數data格式如下：**
 139
 140         {
 141             "y2014": {
 142                 "d0101": 2,
 143                 "d0126": 1,
 144                 "d0131": 2,
 145                 "d0201": 2,
 146                 "d0202": 2,
 147                 "d0203": 2,
 148                 "d0204": 2,
 149                 "d0205": 2,
 150                 "d0206": 2,
 151                 "d0208": 1,
 152                 "d0405": 2,
 153                 "d0407": 2,
 154                 "d0501": 2,
 155                 "d0502": 2,
 156                 "d0503": 2,
 157                 "d0504": 1,
 158                 "d0602": 2,
 159                 "d0908": 2,
 160                 "d0928": 1,
 161                 "d1001": 2,
 162                 "d1002": 2,
 163                 "d1003": 2,
 164                 "d1004": 2,
 165                 "d1005": 2,
 166                 "d1006": 2,
 167                 "d1007": 2,
 168                 "d1011": 1
 169             }
 170         }
 171
 172 ##黃曆數據##
 173 在目錄/hl/下有2008-2020年的黃曆數據，用戶可自行選擇在自己萬年曆中進行添加。
 174
 175 ##公用服務器API##
 176 用Node.js搭載lunar-calendar類庫。
 177
 178 - API:http://api.tuijs.com/
 179 - 請求類型：GET
 180 - 返回數據：JSON 或 JSONP
 181 - JSONP：支持，添加參數callback（僅支持數字，字母，下劃線）
 182
 183 ###API列表###
 184
 185 - 通過公曆獲取某月農曆數據 http://api.tuijs.com/calendar
 186 - 獲取公曆某月日曆數據（不帶農曆信息）http://api.tuijs.com/solarCalendar
 187 - 將公曆轉換為農曆http://api.tuijs.com/solarToLunar
 188 - 將農曆轉換為公曆http://api.tuijs.com/lunarToSolar
 189
 190 **例如：**
 191
 192 http://api.tuijs.com/lunarToSolar?year=2011&month=1&day=1&callback=fn
 193
 194 返回：
 195 `fn({"year":2011,"month":2,"day":16})`
 196
 197 ##其它##
 198 - 項目主頁：[http://www.tuijs.com/](http://www.tuijs.com/ "項目主頁")
 199 - 作者博客：[http://www.2fz1.com/](http://www.2fz1.com/ "作者博客")
 200
 201 JasonZhou