Support Multi-language, added traditional chinese translation

assets/js/manual.js

@@ -1,101 +1,133 @@
-var populateWindow = function(link) {
-	var markdownRequest = new Request({
-		"url": here + 'manual/en-US/' + link,
-		"method": "get",
-		"onSuccess": function(response) {
-			$('docwin').set('html', marked(response));
-		}
-	}).send();
+;(function($) {
+    var populateWindow = function(link) {
+        var markdownRequest = new Request({
+            "url": here + 'manual/' + locale + '/' + link,
+            "method": "get",
+            "onSuccess": function(response) {
+                $('docwin').set('html', marked(response));
+            }
+        }).send();
 
-	$$('.nav-list li').each(
-		function(item) {
-			if (item.getElements('a').length == 0) {
-				item.addClass('nav-header');
-			}
-		}
-	);
+        $$('.nav-list li').each(
+            function(item) {
+                if (item.getElements('a').length == 0) {
+                    item.addClass('nav-header');
+                }
+            }
+        );
 
-	$$('.nav-list a').each(
-		function(item, index)
-		{
-			if (link == item.get('href'))
-			{
-				item.getParent('li').addClass('active');
-			}
-			else
-			{
-				item.getParent('li').removeClass('active');
-			}
-		}.bind(this)
-	);
-}
+        $$('.nav-list a').each(
+            function(item, index)
+            {
+                if (link == item.get('href'))
+                {
+                    item.getParent('li').addClass('active');
+                }
+                else
+                {
+                    item.getParent('li').removeClass('active');
+                }
+            }.bind(this)
+        );
+    }
 
-var populateMenu = function() {
-	var markdownRequest = new Request({
-		"url": here + 'manual/en-US/menu.md',
-		"method": "get",
-		"onSuccess": function (response) {
-			$('doc-menu').set('html', marked(response));
-			$$('#doc-menu ul').each(function(el) {
-				el.addClass('nav');
-				el.addClass('nav-list');
-			});
+    var populateMenu = function() {
+        var markdownRequest = new Request({
+            "url": here + 'manual/' + locale + '/menu.md',
+            "method": "get",
+            "onSuccess": function (response) {
+                $('doc-menu').set('html', marked(response));
+                $$('#doc-menu ul').each(function(el) {
+                    el.addClass('nav');
+                    el.addClass('nav-list');
+                });
 
-			$$('.nav-list li').each(
-				function(item) {
-					if (item.getElements('a').length == 0) {
-						item.addClass('nav-header');
-					}
-				}
-			);
-		}
-	}).send();
-}
+                $$('.nav-list li').each(
+                    function(item) {
+                        if (item.getElements('a').length == 0) {
+                            item.addClass('nav-header');
+                        }
+                    }
+                );
+            }
+        }).send();
+    }
 
-var populateVersion = function() {
-	var versionRequest = new Request({
-		"url": here + 'manual/en-US/version.md',
-		"method": "get",
-		"onSuccess": function(response) {
-			$('version').set('html', marked(response));
-		}
-	}).send();
-}
+    var populateLanguage = function() {
+        var markdownRequest = new Request({
+            "url": here + 'manual/' + locale + '/language.md',
+            "method": "get",
+            "onSuccess": function (response) {
+                var parser = new DOMParser(),
+                    list = parser.parseFromString(marked(response), 'text/xml');
 
-window.addEvent('domready', function() {
-	var urlParts = document.URL.split('?', 2);
-	state = {};
-	here = urlParts[0];
+                $$(list.getElementsByTagName('li')).each(
+                    function(item) {
+                        $('language-items').grab(item);
+                    });
+            }
+        }).send();
+    }
 
-	if (urlParts.length > 1)
-	{
-		var currentDoc = urlParts[1];
-	}
-	else
-	{
-		var currentDoc = "coding-standards/introduction.md";
-	}
+    var populateVersion = function() {
+        var versionRequest = new Request({
+            "url": here + 'manual/' + locale + '/version.md',
+            "method": "get",
+            "onSuccess": function(response) {
+                $('version').set('html', marked(response));
+            }
+        }).send();
+    }
 
-	marked.setOptions({
-		gfm: true,
-		pedantic: false,
-		sanitize: false,
-		highlight: function(code, lang) {
-			var that;
-			Rainbow.color(code, lang, function(hl_code) { that = hl_code; });
-			return that;
-		}
-	})
-	populateMenu();
-	populateWindow(currentDoc);
-	populateVersion();
+    window.addEvent('domready', function() {
+        var urlParts = document.URL.split('?', 2);
+        state = {};
+        here = urlParts[0];
+        locale = 'en-US';
 
-	document.id('main').addEvent('click:relay(a)', function (event, target) {
-		if (target.get('href').substring(0, 4) != 'http' && target.get('href').substring(0, 1) != '#')
-		{
-			populateWindow(target.get('href'));
-			event.preventDefault();
-			history.pushState(state, target.get('href'), "?" + target.get('href'));
-		}
-	});
-});
+        if (urlParts.length > 1)
+        {
+            var currentDoc = urlParts[1];
+        }
+        else
+        {
+            var currentDoc = "coding-standards/introduction.md";
+        }
+
+        marked.setOptions({
+            gfm: true,
+            pedantic: false,
+            sanitize: false,
+            highlight: function(code, lang) {
+                var that;
+                Rainbow.color(code, lang, function(hl_code) { that = hl_code; });
+                return that;
+            }
+        })
+        populateMenu();
+        populateLanguage();
+        populateWindow(currentDoc);
+        populateVersion();
+
+        document.id('language-items').addEvent('click:relay(a)', function (event, target) {
+            locale = target.get('href');
+            populateMenu();
+            populateWindow(currentDoc);
+            event.preventDefault();
+
+            // Update display text on dropdown menu
+            var currentLang = target.get('html');
+            $('language-select').set('html', currentLang);
+        });
+
+        document.id('main').addEvent('click:relay(a)', function (event, target) {
+            if (target.get('href').substring(0, 4) != 'http' && target.get('href').substring(0, 1) != '#')
+            {
+                populateMenu();
+                populateWindow(target.get('href'));
+                event.preventDefault();
+                history.pushState(state, target.get('href'), "?" + target.get('href'));
+            }
+        });
+    });
+})(document.id)

index.html

@@ -33,7 +33,18 @@
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
           </a>
-          <a class="brand" href="/coding-standards/">Joomla! Coding Standards Manual</a>
+          <a class="brand" href="">Joomla! Coding Standards Manual</a>
+          <ul class="nav pull-right">
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+                Language:
+                <span id="language-select">English</span>
+                <b class="caret"></b>
+              </a>
+              <ul id="language-items" class="dropdown-menu">
+              </ul>
+            </li>
+          </ul>
         </div>
       </div>
     </div>
@@ -74,6 +85,7 @@ <h4>License</h4>
     <!-- Le javascript
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
+	<script src="assets/js/jquery-1.11.1.min.js"></script>
 	<script src="assets/js/mootools.js"></script>
 	<script src="assets/js/marked.js"></script>
 	<script src="assets/js/rainbow.js"></script>
@@ -83,6 +95,6 @@ <h4>License</h4>
 	<script src="assets/js/language/javascript.js"></script>
 	<script src="assets/js/language/php.js"></script>
 	<script src="assets/js/manual.js"></script>
-
+	<script src="assets/js/bootstrap.js"></script>
 	</body>
 </html>

manual/en-US/language.md

@@ -0,0 +1,2 @@
+- [English](en-US)
+- [中文 (繁體)](zh-TW)

manual/language.md

@@ -0,0 +1,2 @@
+- [English](en-US)
+- [中文 (繁體)](zh-TW)

manual/zh-TW/appendices/analysis.md

@@ -0,0 +1,33 @@
+## 代碼標準分析
+
+對於接受所貢獻出新的程式碼時，我們將會執行代碼標準，以確保源程式碼的風格是一致的。也能確保你的代碼能符合此標準以順暢的進行程式碼的貢獻。
+
+## 配置代碼分析工具
+
+為了提高源程式碼的一致性和可讀性，Joomla 會使用代碼分析工具，CodeSniffer，並為了保持最新狀態，會把重要的變更與變化都會更新上 Joomla 專案的程式庫。
+
+### 執行 CodeSniffer
+
+Joomla 的代碼標準規則都會交由名為 PHP CodeSniffer 的工具來寫入。若要安裝 PHP CodeSniffer 至您的系統，請到這個連結: [PHP CodeSniffer Pear Page](http://pear.php.net/package/PHP_CodeSniffer)查詢相關資訊。
+
+你可以透過 CMS (內容管理系統)，Framework (框架)，或 Issue Tracker (問題追蹤) 這些型態的系統，並置於這些程式軟體的根目錄下執行這個工具。
+
+```
+phpcs --report=checkstyle --report-file=build/logs/checkstyle.xml --standard=/path/to/<your root>/build/phpcs/Joomla /path/to/<your root>
+```
+
+此外，如果在你的系統安裝了 Ant，你必須在它所配置的中的 `<root directory>` 裡的 Joomla 根目錄下執行 CodeSniffer 來測試與運行程式碼的分析。
+
+```
+ant phpcs
+```
+
+#### 已知的問題
+
+-   在 Simplepie 的函式庫上執行 Code Sniffer 會產生一些問題，可將目標指向 libraries/joomla 即可避免。
+
+## 其它工具
+
+這裡有些其它可用的工具讓開發者能計畫發送源程式碼至現在的專案。
+
+### PhpStorm 代碼樣式表

manual/zh-TW/appendices/examples.md

@@ -0,0 +1 @@
+## Code Examples

manual/zh-TW/coding-standards/chapters/basic-guidelines.md

@@ -0,0 +1,33 @@
+## 基礎大綱
+
+本章節旨在說明基礎的檔案規則
+
+## 檔案格式
+
+所有針對 Joomla 開發的檔案格式都必須存為 ASCII text、使用 UTF-8 編碼字型並且經過 Unix 格式化。以行為單位的程式碼必須使用換行字元(LF)作為結尾。換行字元的表示法為：10(序數)、012(八進位)、0A(十六進位)。不要使用純CR回車符(例如蘋果電腦)或是CRLF組合(例如windows電腦)。
+
+## 拼字
+
+所有使用在程式碼註解、類別、函式、變數、常數的命名原則都必須根據英式英文(en_GB)原則。但有些例外是可允許的，例如某些已內建在 PHP API 中常見的程式用語，或其他慣例用語如 "color" 這樣已制定的用法便可沿用美式英文
+
+## 縮排
+
+縮排一律使用 Tab 鈕(根據國際 PEAR 準則)。編碼時使用的 IDE 如 Eclipse 需設定 Tab 為4個空白字元長度。
+
+## 行寬
+
+原則上每行程式碼並沒有最大長度限制，但根據國際標準值，150字元能夠在不需要水平滾動的狀況下達到最好的可讀性。若遇到換行會影響輸出結果的情況(例如 PHP/HTML 混合的結構檔案)，更長的程式碼也是被允許的。
+
+## 優良範例
+
+以下提供一些外部資源，讓大家可以參考這些資源以及相關寫法：
+
+* [Joomla 開發者網路](http://developer.joomla.org/) - 所有開發相關資源都可由此尋找
+* [Joomla 開發教學文件](http://docs.joomla.org/Developers) - 官方完整的開發教學 Wiki
+* [PEAR 編碼標準](http://pear.php.net/manual/en/standards.php)
+* [Allman 縮排風格 (Wiki)](http://en.wikipedia.org/wiki/Indent_style#Allman_style)
+* [Joomla Coding Standards Github](https://github.com/joomla/coding-standards) - 儲存 PHP Codesniffer 設定檔等等
+* [Joomla CodeSniffer](http://docs.joomla.org/Joomla_CodeSniffer) - Joomla 開發過程與 IDE 的整合
+* [Secure coding guidelines](http://docs.joomla.org/Secure_coding_guidelines) - 安全性編碼導覽
+
+本清單將隨時補充~~~