2011年10月6日 星期四

說明文件產生工具

寫程式如果只是自己寫,在程式碼裡註解寫一寫,自己看得懂就可以。但如果程式是要給其他人呼叫使用,會需要有個API的說明文件,說明程式架構、有哪些函數和變數可以使用等。這時候如果有個方便的工具,能幫忙把寫完的程式碼自動輸出成說明文件,會省時省力很多。介紹幾款常見的工具:

  1. Javadoc
    Javadoc is a tool for generating API documentation in HTML format from doc comments in source code.
  2. Doxygen
    Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.
  3. Sandcastle
    Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments.

五種開源授權規範的比較 (BSD, Apache, GPL, LGPL, MIT)

當Adobe、Microsoft、Sun等一系列巨頭開始表現出對"開源"的青睞時,"開源"的時代即將到來!

現今存在的開源協議很多,而經過Open Source Initiative組織通過批准的開源協議目前有58種(http://www.opensource.org/licenses/alphabetical)。我們在常見的開源協議如BSD, GPL, LGPL, MIT等都是OSI批准的協議。如果要開源自己的代碼,最好也是選擇這些被批准的開源協議。

這裡我們來看四種最常用的開源協議及它們的適用範圍,供那些準備開源或者使用開源產品的開發人員/廠家參考。


BSD開源協議(original BSD license、FreeBSD license、Original BSD license)

BSD開源協議是一個給於使用者很大自由的協議。基本上使用者可以"為所欲為",可以自由的使用,修改源代碼,也可以將修改後的代碼作為開源或者專有軟件再發佈。

但"為所欲為"的前提當你發佈使用了BSD協議的代碼,或則以BSD協議代碼為基礎做二次開發自己的產品時,需要滿足三個條件:

  1. 如果再發佈的產品中包含源代碼,則在源代碼中必須帶有原來代碼中的BSD協議。
  2. 如果再發佈的只是二進制類庫/軟件,則需要在類庫/軟件的文檔和版權聲明中包含原來代碼中的BSD協議。
  3. 不可以用開源代碼的作者/機構名字和原來產品的名字做市場推廣。

BSD代碼鼓勵代碼共享,但需要尊重代碼作者的著作權。BSD由於允許使用者修改和重新發佈代碼,也允許使用或在BSD代碼上開發商業軟件發佈和銷售,因此是對商業集成很友好的協議。而很多的公司企業在選用開源產品的時候都首選BSD協議,因為可以完全控制這些第三方的代碼,在必要的時候可以修改或者二次開發。


Apache Licence 2.0(Apache License, Version 2.0、Apache License, Version 1.1、Apache License, Version 1.0)

Apache Licence是著名的非盈利開源組織Apache採用的協議。該協議和BSD類似,同樣鼓勵代碼共享和尊重原作者的著作權,同樣允許代碼修改,再發佈(作為開源或商業軟件)。需要滿足的條件也和BSD類似:

  1. 需要給代碼的用戶一份Apache Licence
  2. 如果你修改了代碼,需要再被修改的文件中說明。
  3. 在延伸的代碼中(修改和有源代碼衍生的代碼中)需要帶有原來代碼中的協議,商標,專利聲明和其他原來作者規定需要包含的說明。
  4. 如果再發佈的產品中包含一個Notice文件,則在Notice文件中需要帶有Apache Licence。你可以在Notice中增加自己的許可,但不可以表現為對Apache Licence構成更改。

Apache Licence也是對商業應用友好的許可。使用者也可以在需要的時候修改代碼來滿足需要並作為開源或商業產品發佈/銷售。


GPL(GNU General Public License)

我們很熟悉的Linux就是採用了GPL。GPL協議和BSD, Apache Licence等鼓勵代碼重用的許可很不一樣。GPL的出發點是代碼的開源/免費使用和引用/修改/衍生代碼的開源/免費使用,但不允許修改後和衍生的代 碼做為閉源的商業軟件發佈和銷售。這也就是為什麼我們能用免費的各種linux,包括商業公司的linux和linux上各種各樣的由個人,組織,以及商業軟件公司開發的免費軟件了。

GPL協議的主要內容是只要在一個軟件中使用("使用"指類庫引用,修改後的代碼或者衍生代碼)GPL 協議的產品,則該軟件產品必須也採用GPL協議,既必須也是開源和免費。這就是所謂的"傳染性"。GPL協議的產品作為一個單獨的產品使用沒有任何問題, 還可以享受免費的優勢。

由於GPL嚴格要求使用了GPL類庫的軟件產品必須使用GPL協議,對於使用GPL協議的開源代碼,商業軟件或者對代碼有保密要求的部門就不適合集成/採用作為類庫和二次開發的基礎。

其它細節如再發佈的時候需要伴隨GPL協議等和BSD/Apache等類似。


LGPL(GNU Lesser General Public License)

LGPL是GPL的一個為主要為類庫使用設計的開源協議。和GPL要求任何使用/修改/衍生之GPL類庫的的軟件必須採用GPL協議不同。LGPL允許商 業軟件通過類庫引用(link)方式使用LGPL類庫而不需要開源商業軟件的代碼。這使得採用LGPL協議的開源代碼可以被商業軟件作為類庫引用並發布和 銷售。

但是如果修改LGPL協議的代碼或者衍生,則所有修改的代碼,涉及修改部分的額外代碼和衍生的代碼都必須採用LGPL協議。因此LGPL協議的開源代碼很 適合作為第三方類庫被商業軟件引用,但不適合希望以LGPL協議代碼為基礎,通過修改和衍生的方式做二次開發的商業軟件採用。

GPL/LGPL都保障原作者的知識產權,避免有人利用開源代碼複製並開發類似的產品。


MIT(MIT)

MIT是和BSD一樣寬範的許可協議,作者只想保留版權,而無任何其他了限制。也就是說,你必須在你的發行版裡包含原許可協議的聲明,無論你是以二進制發佈的還是以源代碼發佈的。



參考網址:
五種開源授權規範的比較 (BSD, Apache, GPL, LGPL, MIT)

2011年9月30日 星期五

Firefox - 網址列

Firefox的網址列也可以打關鍵字進行搜尋,預設是google,但最近發生被bing綁架的現象,所以找了firefox的組態設定檔進行修改:
  1. 在網址列輸入
    about:config
  2. 會有一個警告頁面出現,按下確認按鈕進入。
  3. 尋找keyword.URL。
  4. 如果想用google的搜尋可以在值(value)那一欄位輸入
    http://www.google.com.tw/search?q=
    如果想用google的智慧搜尋則輸入
    http://www.google.com.tw/search?btnI&q=
    如果想改回預設,可以直接按滑鼠右鍵,選擇重設。(不過預設就是google)
    也是可以設定成自己喜歡的搜尋引擎,就仿照上面的輸入方式,將搜尋引擎的語法輸入進去。

2011年9月28日 星期三

Putty - vim編輯器顏色顯示

事件狀況:
Putty登入Linux伺服器,使用vim編輯器進行編輯,但文字顏色皆為灰階,無論怎麼修改vim的顏色設定皆無法呈現色彩。

解決辦法:
  1. 進入Putty的組態設定介面,左側目錄選擇「Connection」底下的「Data」,右側選單有一項是「Terminal-type string」,若原設定值為「xterm」,則修改為「xterm-color」即可。

2011年8月10日 星期三

LyX - 中文列印

LyX版本:2.0

事件狀況:
LyX初始設定是無法列印中文字,早期版本要列印中文字需要安裝額外的TeX編碼元件,但2.0版本僅需要修改設定值,

解決辦法:
  1. 到LyX工具列的「文件」→「設定值」,在「字型」裡,

    將「CJK」輸入:bsmi(明體)或bkai(楷書)。




  2. 一樣在LyX工具列的「文件」→「設定值」裡,在「語言」裡,

    將「語言」調整為中文,
    並將「Encoding」調整為Unicode(CJK)(utf8)。



這兩個地方調整完後,就能將有中文的文件印出來。

參考網址:
LyX: 更改與設定CJK字型

2011年2月12日 星期六

Windows 7 - Windows Live Messenger

作業系統:Windows 7 64bit
網路卡:Marvell Yukon 88E8056 PCI-E Gigabit Ethernet Controller
Windows Live Messenger:版本 2009 (Build 14.0.8117.416)

事件狀況:
Windows Live Messenger會持續性的斷線。

解決辦法:

  1. 用記事本開啟C:\WINDOWS\system32\drivers\etc\hosts。
  2. 在檔案內容的最下面加入下列兩行字
    65.54.239.80 messenger.hotmail.com
    65.54.239.80 dp.msnmessenger.akadns.net
  3. 存檔後重新啟動Windows Live Messenger。

參考網址:
Windows Live Messenger 登入方法

JavaScript - 建立form,用post方法送出request

用JavaScript寫一隻小程式,能送出表單請求給伺服器。

若伺服器是用get的方法接收請求,只需在網址後面加入「?name1=value1&name2=value2&……」;但若伺服器是用post的方法接收請求,則要用建立表單的方式送出請求。



傳送post請求的函式:

function sendPost(url, params){
  var form = document.createElement("form");

  // 設定表單的一些屬性,包含網頁接收伺服器回應的頁面或框架
  form.setAttribute("method", "post");
  form.setAttribute("action", url);
  form.setAttribute("target", "Iframe1");

  // 建立隱藏的表單控制項
  for(var key in params){
    var hiddenField = document.createElement("input");
    hiddenField.setAttribute("type", "hidden");
    hiddenField.setAttribute("name", key);
    hiddenField.setAttribute("value", params[key]);
    form.appendChild(hiddenField);
  }

  // 隱藏的submit按鈕,預防瀏覽器不支援模糊的表單設計。(可不用)
  var hiddenSubmit = document.createElement("input");
  hiddenSubmit.setAttribute("type", "submit");
  hiddenSubmit.setAttribute("style", "display:none;");
  form.appendChild(hiddenSubmit);

  // 將表單加入網頁中
  document.body.appendChild(form); 

  // 送出請求
  form.submit();
}



這裡的params是用Name-Value的方式建立陣列,方式為:

var params = {'name1':'value1','name2':'value2'};