Added zh-TW documents
This commit is contained in:
John-Lin
parent
357dea506a
commit
27b77a06ed
2 changed files with 235 additions and 0 deletions
70
docs-translations/zh-TW/README.md
Normal file
70
docs-translations/zh-TW/README.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
## 導引
|
||||
|
||||
* [應用程式發布](tutorial/application-distribution.md)
|
||||
* [應用程式打包](tutorial/application-packaging.md)
|
||||
* [使用原生模組](tutorial/using-native-node-modules.md)
|
||||
* [Debug 主行程](tutorial/debugging-main-process.md)
|
||||
* [使用 Selenium 和 WebDriver](tutorial/using-selenium-and-webdriver.md)
|
||||
* [DevTools 擴充](tutorial/devtools-extension.md)
|
||||
* [使用 Pepper Flash 套件](tutorial/using-pepper-flash-plugin.md)
|
||||
|
||||
## 教學
|
||||
|
||||
* [快速入門](tutorial/quick-start.md)
|
||||
* [桌面環境整合](tutorial/desktop-environment-integration.md)
|
||||
* [在線/離線事件偵測](tutorial/online-offline-events.md)
|
||||
|
||||
## API 參考
|
||||
|
||||
* [提要](api/synopsis.md)
|
||||
* [行程物件](api/process.md)
|
||||
* [支援的 Chrome 命令行開關](api/chrome-command-line-switches.md)
|
||||
|
||||
客製的 DOM 元素:
|
||||
|
||||
* [`File`對象](api/file-object.md)
|
||||
* [`<webview>`物件](api/web-view-tag.md)
|
||||
* [`window.open`函數](api/window-open.md)
|
||||
|
||||
主行程可用的模組:
|
||||
|
||||
* [app](api/app.md)
|
||||
* [auto-updater](api/auto-updater.md)
|
||||
* [browser-window](api/browser-window.md)
|
||||
* [content-tracing](api/content-tracing.md)
|
||||
* [dialog](api/dialog.md)
|
||||
* [global-shortcut](api/global-shortcut.md)
|
||||
* [ipc (main process)](api/ipc-main-process.md)
|
||||
* [menu](api/menu.md)
|
||||
* [menu-item](api/menu-item.md)
|
||||
* [power-monitor](api/power-monitor.md)
|
||||
* [power-save-blocker](api/power-save-blocker.md)
|
||||
* [protocol](api/protocol.md)
|
||||
* [session](api/session.md)
|
||||
* [webContents](api/web-contents.md)
|
||||
* [tray](api/tray.md)
|
||||
|
||||
渲染行程可用的模組 (網頁):
|
||||
|
||||
* [ipc (renderer)](api/ipc-renderer.md)
|
||||
* [remote](api/remote.md)
|
||||
* [web-frame](api/web-frame.md)
|
||||
|
||||
兩種行程都可用的模組:
|
||||
|
||||
* [clipboard](api/clipboard.md)
|
||||
* [crash-reporter](api/crash-reporter.md)
|
||||
* [native-image](api/native-image.md)
|
||||
* [screen](api/screen.md)
|
||||
* [shell](api/shell.md)
|
||||
|
||||
## 開發
|
||||
|
||||
* [Coding style](development/coding-style.md)
|
||||
* [源碼目錄結構](development/source-code-directory-structure.md)
|
||||
* [與 NW.js (原名node-webkit) 在技術上的差異](development/atom-shell-vs-node-webkit.md)
|
||||
* [構建系統概況](development/build-system-overview.md)
|
||||
* [構建步驟 (Mac)](development/build-instructions-mac.md)
|
||||
* [構建步驟 (Windows)](development/build-instructions-windows.md)
|
||||
* [構建步驟 (Linux)](development/build-instructions-linux.md)
|
||||
* [在 debugger 中使用 symbol server](development/setting-up-symbol-server.md)
|
||||
165
docs-translations/zh-TW/tutorial/quick-start.md
Normal file
165
docs-translations/zh-TW/tutorial/quick-start.md
Normal file
|
|
@ -0,0 +1,165 @@
|
|||
# 快速入門
|
||||
|
||||
## 簡介
|
||||
|
||||
Electron 可以讓你使用純 JavaScript 提供豐富的原生的 APIs 來創造桌面應用程式。
|
||||
你可以把它視為一個 io.js 的變體，專注於桌面應用程式而不是 web 伺服器。
|
||||
|
||||
這不表示 Electron 是一個用 JavaScript 去綁定 GUI 函式庫。取而代之的，Electron 是使用網頁介面來作為它的 GUI ，
|
||||
所以你可以把它看作是一個被 JavaScript 所控制且精簡化的 Chromium 瀏覽器。
|
||||
|
||||
## 主行程
|
||||
|
||||
在 Electron 裡，有個行程會去運行 `package.json` 裡的 `main` 腳本被稱為 __主行程__ 。
|
||||
這個腳本運行在主行程裏可以顯示一個 GUI 就由創建一個 web 頁面。
|
||||
|
||||
## 渲染行程
|
||||
|
||||
因為 Electron 使用 Chromium 來顯示網頁，所以 Chromium 的多行程架構也被充分利用。
|
||||
每一個網頁在 Electron 裏執行各自的行程，被稱為 __渲染行程__。
|
||||
|
||||
在一般瀏覽器中，網頁通常會在沙盒環境下運行，並且不允許存取原生資源。然而，
|
||||
Electron 的用戶擁有在網頁中呼叫 io.js APIs 的能力，允許低級別操作與作業系統的交互作用。
|
||||
|
||||
## 主行程與渲染行程的區別
|
||||
|
||||
主行程創造網頁透過創造 `BroswerWindow` 實例。每一個 `BroswerWindow` 實例都在自己的渲染行程裡運行著一個網頁。
|
||||
當一個 `BroswerWindow` 實例被銷毀，對應的渲染行程也會被終止。主行程管理所有網頁和與之對應的渲染行程。
|
||||
每一個渲染行程都是相互獨立的，並且只關心他們自己的網頁。
|
||||
|
||||
在網頁中，是不允許呼叫原生 GUI 相關 APIs 因為管理原生 GUI 資源在網頁上是非常危險而且容易造成資源洩露。
|
||||
如果你想要在網頁中呼叫 GUI 相關的 APIs 的操作，網頁的渲染行程必須與主行程進行通訊，請求主行程進行相關的操作。
|
||||
|
||||
在 Electron ，我們提供用於在主行程與渲染行程之間通訊的 [ipc][1] 模組。並且也有一個遠端模使用 RPC 通訊方式 [remote][2]。
|
||||
|
||||
# 打造你第一個 Electron 應用
|
||||
|
||||
一般來說，一個 Electron 應用程式的目錄結構像下面這樣：
|
||||
|
||||
```text
|
||||
your-app/
|
||||
├── package.json
|
||||
├── main.js
|
||||
└── index.html
|
||||
```
|
||||
|
||||
`package.json ` 的格式與 Node 的模組完全一樣，並且有個腳本被指定為 `main` 是用來啟動你的應用程式，它運行在主行程上。
|
||||
你應用裡的 一個範例在你的 `package.json` 看起來可能像這樣：
|
||||
|
||||
```json
|
||||
{
|
||||
"name" : "your-app",
|
||||
"version" : "0.1.0",
|
||||
"main" : "main.js"
|
||||
}
|
||||
```
|
||||
|
||||
__注意__：如果 `main` 沒有在 `package.json` 裏， Electron會嘗試載入 `index.js`。
|
||||
|
||||
`main.js` 用於創建視窗和處理系統事件，一個典型的例子如下：
|
||||
|
||||
``` javascript
|
||||
var app = require('app'); // 控制應用程式生命週期的模組。
|
||||
var BrowserWindow = require('browser-window'); // 創造原生瀏覽器窗口的模組
|
||||
|
||||
// 對我們的伺服器傳送異常報告。
|
||||
require('crash-reporter').start();
|
||||
|
||||
// 保持一個對於 window 物件的全域的引用，不然，當 JavaScript 被GC，
|
||||
// window 會被自動地關閉
|
||||
var mainWindow = null;
|
||||
|
||||
// 當所有窗口被關閉了，退出。
|
||||
app.on('window-all-closed', function() {
|
||||
// 在OS X 上，通常使用者在明確地按下 Cmd + Q 之前
|
||||
// 應用會保持活動狀態
|
||||
if (process.platform != 'darwin') {
|
||||
app.quit();
|
||||
}
|
||||
});
|
||||
|
||||
// 當Electron 完成了初始化並且準備創建瀏覽器視窗的時候
|
||||
// 這個方法就被調用
|
||||
app.on('ready', function() {
|
||||
// 創建瀏覽器視窗
|
||||
mainWindow = new BrowserWindow({width: 800, height: 600});
|
||||
|
||||
// 載入應用程式的 index.html
|
||||
mainWindow.loadUrl('file://' + __dirname + '/index.html');
|
||||
|
||||
// 打開開發者工具
|
||||
mainWindow.openDevTools();
|
||||
|
||||
// 當window 被關閉，這個事件會被觸發
|
||||
mainWindow.on('closed', function() {
|
||||
// 取消引用 window 物件，如果你的應用程式支援多視窗的話，
|
||||
// 通常會把多個 window 物件存放在一個數組裡面，
|
||||
// 但這次不是。
|
||||
mainWindow = null;
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
最後，你想顯示的 `index.html` ：
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Hello World!</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Hello World!</h1>
|
||||
We are using io.js <script>document.write(process.version)</script>
|
||||
and Electron <script>document.write(process.versions['electron'])</script>.
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
# 運行你的應用程式
|
||||
|
||||
一旦你創造了最初的 `main.js` ， `index.html` 和 `package.json` 這幾個文件，你可能會想嘗試在本地運行並測試，看看是不是和期望的那樣正常運行。
|
||||
|
||||
## electron-prebuild
|
||||
如果你已經使用 `npm` 安裝了全域的 `electron-prebuilt`，那麼你只需要按照如下方式直接運行你的應用程式：
|
||||
|
||||
```bash
|
||||
electron .
|
||||
```
|
||||
|
||||
如果你是局部性地安裝，那運行：
|
||||
|
||||
```bash
|
||||
./node_modules/.bin/electron .
|
||||
```
|
||||
|
||||
## 手動下載 Electron Binary
|
||||
|
||||
如果你手動下載了 Electron ，你可以直接使的 Binary 直接運行你的應用程式。
|
||||
|
||||
### Windows
|
||||
|
||||
``` bash
|
||||
$ .\electron\electron.exe your-app\
|
||||
```
|
||||
|
||||
### Linux
|
||||
|
||||
``` bash
|
||||
$ ./electron/electron your-app/
|
||||
```
|
||||
|
||||
### OS X
|
||||
|
||||
``` bash
|
||||
$ ./Electron.app/Contents/MacOS/Electron your-app/
|
||||
```
|
||||
|
||||
`Electron.app` 裡面是 Electron 釋出包，你可以在[這裡](https://github.com/atom/electron/releases)下載到。
|
||||
|
||||
# 作為版本發行
|
||||
在你完成了你的應用程式後，你可以依照 [應用部署](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) 指南發布一個版本，並且運行已經打包好的應用程式。
|
||||
|
||||
[1]: https://github.com/atom/electron/blob/master/docs/api/ipc-renderer.md
|
||||
|
||||
[2]: https://github.com/atom/electron/blob/master/docs/api/remote.md
|
||||
Loading…
Reference in a new issue