You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/02/15 00:02:44 UTC
[15/16] docs commit: Update files under guide,
fix typos in previous version and en docs
Update files under guide, fix typos in previous version and en docs
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/87908570
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/87908570
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/87908570
Branch: refs/heads/master
Commit: 8790857078ee662cabbf97b02bce7cf6563d478a
Parents: 2f0283b
Author: Keiko Oda <ke...@gmail.com>
Authored: Tue Feb 5 13:26:38 2013 -0800
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Feb 14 13:45:07 2013 -0800
----------------------------------------------------------------------
.../2.2.0/guide/getting-started/windows-8/index.md | 6 +-
.../1.8.1/guide/getting-started/android/index.md | 2 +-
.../1.9.0/guide/getting-started/android/index.md | 2 +-
.../2.0.0/guide/getting-started/android/index.md | 2 +-
.../2.1.0/guide/getting-started/android/index.md | 2 +-
docs/jp/2.2.0/guide/command-line/index.md | 2 +-
docs/jp/2.2.0/guide/cordova-webview/ios.md | 2 +-
.../2.2.0/guide/getting-started/android/index.md | 156 +++++++--------
docs/jp/2.2.0/guide/getting-started/index.md | 1 +
docs/jp/2.2.0/guide/getting-started/ios/index.md | 9 +-
.../guide/getting-started/windows-phone/index.md | 2 +
.../guide/plugin-development/android/index.md | 136 ++++++++-----
.../jp/2.2.0/guide/plugin-development/ios/index.md | 88 ++++----
docs/jp/2.2.0/guide/upgrading/android/index.md | 10 +
docs/jp/2.2.0/guide/upgrading/ios/index.md | 22 ++-
15 files changed, 250 insertions(+), 192 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/en/2.2.0/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.2.0/guide/getting-started/windows-8/index.md b/docs/en/2.2.0/guide/getting-started/windows-8/index.md
index 598f5e0..a52d545 100644
--- a/docs/en/2.2.0/guide/getting-started/windows-8/index.md
+++ b/docs/en/2.2.0/guide/getting-started/windows-8/index.md
@@ -47,11 +47,11 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
- Open Visual Studio 2012 and choose **New Project**.
- Select **Installed - Template - Other Languages - JavaScript - Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like. We're using **CordovaWin8Foo** in this guide.
- 
+ 
- Microsoft continues to use **default.html** as the default page for use in websites, whereas most "open web" developers use **index.html**. (Plus it's likely that in the other platform variants of your project you are using **index.html** as the name of your default page.) To fix this, in Solution Explorer rename the **default.html** file to **index.html**. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
- 
+ 
- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **corvoda.js** file in the **lib\windows-8** folder that we called out previously.
@@ -95,7 +95,7 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
- Run the project from Visual Studio. You'll see the message box appear.
- 
+ 
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/1.8.1/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/1.8.1/guide/getting-started/android/index.md b/docs/jp/1.8.1/guide/getting-started/android/index.md
index 1ce7714..f435867 100644
--- a/docs/jp/1.8.1/guide/getting-started/android/index.md
+++ b/docs/jp/1.8.1/guide/getting-started/android/index.md
@@ -35,7 +35,7 @@ Getting Started with Android
- [Eclipse Classic](http://www.eclipse.org/downloads/) のダウンロードとインストール
- [Android SDK](http://developer.android.com/sdk/index.html) のダウンロードとインストール
- [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) のダウンロードとインストール
-- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから windows ディレクトリと一緒に作業を進めます。
+- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから Android ディレクトリと一緒に作業を進めます。
3. 新規プロジェクトの作成
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/1.9.0/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/1.9.0/guide/getting-started/android/index.md b/docs/jp/1.9.0/guide/getting-started/android/index.md
index 7ffd01e..eebb74a 100644
--- a/docs/jp/1.9.0/guide/getting-started/android/index.md
+++ b/docs/jp/1.9.0/guide/getting-started/android/index.md
@@ -35,7 +35,7 @@ Getting Started with Android
- [Eclipse Classic](http://www.eclipse.org/downloads/) のダウンロードとインストール
- [Android SDK](http://developer.android.com/sdk/index.html) のダウンロードとインストール
- [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) のダウンロードとインストール
-- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから windows ディレクトリと一緒に作業を進めます。
+- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから Android ディレクトリと一緒に作業を進めます。
3. 新規プロジェクトの作成
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.0.0/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.0.0/guide/getting-started/android/index.md b/docs/jp/2.0.0/guide/getting-started/android/index.md
index 542942c..e7f04c0 100644
--- a/docs/jp/2.0.0/guide/getting-started/android/index.md
+++ b/docs/jp/2.0.0/guide/getting-started/android/index.md
@@ -35,7 +35,7 @@ Getting Started with Android
- [Eclipse Classic](http://www.eclipse.org/downloads/) のダウンロードとインストール
- [Android SDK](http://developer.android.com/sdk/index.html) のダウンロードとインストール
- [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) のダウンロードとインストール
-- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから windows ディレクトリと一緒に作業を進めます。
+- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから Android ディレクトリと一緒に作業を進めます。
3. 新規プロジェクトの作成
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.1.0/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.1.0/guide/getting-started/android/index.md b/docs/jp/2.1.0/guide/getting-started/android/index.md
index 9e96bf2..25cd8ad 100644
--- a/docs/jp/2.1.0/guide/getting-started/android/index.md
+++ b/docs/jp/2.1.0/guide/getting-started/android/index.md
@@ -35,7 +35,7 @@ Getting Started with Android
- [Eclipse Classic](http://www.eclipse.org/downloads/) のダウンロードとインストール
- [Android SDK](http://developer.android.com/sdk/index.html) のダウンロードとインストール
- [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) のダウンロードとインストール
-- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから windows ディレクトリと一緒に作業を進めます。
+- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから Android ディレクトリと一緒に作業を進めます。
3. 新規プロジェクトの作成
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/command-line/index.md b/docs/jp/2.2.0/guide/command-line/index.md
index 82af54c..1daf57a 100644
--- a/docs/jp/2.2.0/guide/command-line/index.md
+++ b/docs/jp/2.2.0/guide/command-line/index.md
@@ -37,7 +37,7 @@ shell ベースで Cordova プロジェクトを作成し、
## iOS
iOS コマンドラインツールはシェルスクリプトで作られており、
-Xcode のコマンドラインツール (`xcode-select` や `xcodebuild` など) に依存しています。
+XCode のコマンドラインツール (`xcode-select` や `xcodebuild` など) に依存しています。
### プロジェクトの作成
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/cordova-webview/ios.md b/docs/jp/2.2.0/guide/cordova-webview/ios.md
index 2e73f3c..fe6c748 100644
--- a/docs/jp/2.2.0/guide/cordova-webview/ios.md
+++ b/docs/jp/2.2.0/guide/cordova-webview/ios.md
@@ -30,7 +30,7 @@ Cordova 2.0.0 以降は、 Cleaver を実装したサブプロジェクトのみ
-------------
1. **Cordova 2.1.0** またはそれ以降
-2. **Xcode 4.3** またはそれ以降
+2. **Xcode 4.5** またはそれ以降
3. `Cordova.plist` ファイル ([新しく作成した](guide_command-line_index.md.html#Command-Line%20Usage_ios) Cordova プロジェクトから)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/getting-started/android/index.md b/docs/jp/2.2.0/guide/getting-started/android/index.md
index 9e96bf2..f60b1b1 100644
--- a/docs/jp/2.2.0/guide/getting-started/android/index.md
+++ b/docs/jp/2.2.0/guide/getting-started/android/index.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Getting Started with Android
============================
-このガイドは、 Cordova のための開発環境セットアップ方法、またシンプルなアプリの動かし方を解説します。 Cordova は以前は PhoneGap と呼ばれていたため、いくつかのサイトは PhoneGap という名前をまだ使用しています。
+このガイドは、 Cordova のための開発環境セットアップ方法、またシンプルなアプリの動かし方を解説します。
1. 必要なもの
@@ -35,96 +35,85 @@ Getting Started with Android
- [Eclipse Classic](http://www.eclipse.org/downloads/) のダウンロードとインストール
- [Android SDK](http://developer.android.com/sdk/index.html) のダウンロードとインストール
- [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) のダウンロードとインストール
-- [Cordova](http://phonegap.com/download) の最新版をダウンロードし解凍します。これから windows ディレクトリと一緒に作業を進めます。
+- [Cordova](http://incubator.apache.org/cordova/#download) の最新版をダウンロードし解凍します。これから Android ディレクトリと一緒に作業を進めます。
- 3. 新規プロジェクトの作成
+
+3A. PATH 環境変数の設定 (Mac OS)
+---------------------------------------
+
+- ターミナルを開きます (デフォルトでは、 Applications/Utilites フォルダーにあります)
+- 以下のコマンドを実行します
+
+`touch ~/.bash_profile; open ~/.bash_profile`
+
+- これにより、ファイルをあなたのデフォルトテキストエディタで開きます
+- Android SDK platform-tools と tools ディレクトリにパスを通す必要があります。この例では、 "/Development/android-sdk-macosx" を SDK がインストールされているフォルダーとします。以下の行を追加します:
+
+`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
+
+- ファイルを保存し、テキストエディタを終了します
+- PATH を更新するために、 .bash_profile を実行します
+
+`source ~/.bash_profile`
+
+- これで、ターミナルを開く度に Android SDK へのパスが通っているようになります
+
+3B. PATH 環境変数の設定 (Windows)
+---------------------------------------
+
+- デスクトップから、マイコンピューターを右クリックし、プロパティーをクリックします
+- 左側の列から、詳細設定をクリックします
+- システムプロパティーのウィンドウで、環境変数ボタンをクリックします
+- システム環境変数から、 PATH を選択します
+- 編集ボタンをクリックします
+- Android SDK platform-tools と tools ディレクトリにパスを通す必要があります。この例では、 "C:\Development\android-sdk-macosx" を SDK がインストールされているフォルダーとします。以下をテキストボックスに追加します:
+
+`;C:\Development\android-sdk-windows\platform-tools;C:\Development\android-sdk-windows\tools`
+
+- 編集を保存します。環境変数ダイアログを閉じます
+- 追加で、 `%JAVA_HOME%\bin` も PATH に追加する必要があるかもしれません。この作業が必要かどうかを確認するには、コマンドプロンプトで `java` を入力してください。もしプログラムが見つからなかった場合は、 `%JAVA_HOME%\bin` を PATH に追加してください。場合によっては、 %JAVA_HOME% の環境変数ではなくフルパスを指定する必要があるかもしれません
+- `%ANT_HOME%\bin` も PATH に追加する必要があるかもしれません。この作業が必要かどうかを確認するには、コマンドプロンプトで `ant` を入力してください。もしプログラムが見つからなかった場合は、 `%ANT_HOME%\bin` を PATH に追加してください。場合によっては、 %ANT_HOME% の環境変数ではなくフルパスを指定する必要があるかもしれません
+
+
+4. 新規プロジェクトの作成
---------------------
+- ターミナルで、 Cordova の `android` サブフォルダーの中にある `bin` ディレクトリまで移動します
+- `./create <project_folder_path> <package_name> <project_name>` と入力し、 **"Enter"** を押します
+
+ <project_folder_path> は新規 Cordova Android プロジェクトへのパスです
+ <package_name> はパッケージ名です。例: com.YourCompany.YourAppName
+ <project_name> はプロジェクト名です。例: YourApp (スペースを含まない)
+
- Eclipse を起動し、メニューから **新規プロジェクト** を選択します
- 
-- 新しいアプリケーションプロジェクトを指定します
- 
-- アプリケーション名、プロジェクト名、ネームスペースを伴ったパッケージ名を指定します
- 
-- ランチャーアイコンの設定をします
- 
-- Blank Activity を作成します
- 
-- Activity が何も継承していないことを確認して下さい。 PhoneGap が Eclipse のワークスペースに無いような状態です。これが終わったら、 Finish をクリックします
-
-- 作成したプロジェクトのルートディレクトリに、以下の2つの新しいディレクトリを作成します:
- - **/libs**
- - **assets/www**
-- ダウンロードした Cordova から **cordova-2.0.0.js** を **assets/www** にコピーしてください。
-- ダウンロードした Cordova から **cordova-2.0.0.jar** を **/libs** にコピーしてください。
-- ダウンロードした Cordova から **xml** フォルダーを **/res** にコピーしてください。
-
-- **cordova-2.0.0.jar** がプロジェクトのビルドパスに追加されていることを確認してください。 /libs フォルダーを右クリックし、 **ビルド・パス > ビルド・パスの構成** を選択します。ライブラリータブで、 **cordova-2.0.0.jar** をプロジェクトに追加します。もしうまくいかない場合は、 F5 キーを押してプロジェクトをリフレッシュする必要があるかもしれません。
-
- 
-
-- 作成したプロジェクトの **src** フォルダーにあるメインの Java ファイルを編集します:
- - **import org.apache.cordova.*;** を追加
- - クラスの継承元を **Activity** から **DroidGap** に変更
- - **setContentView()** の行を **super.loadUrl("file:///android_asset/www/index.html");** に置き換え
-
- 
-
-- AndroidManifest.xml を右クリックし、 **アプリケーションから開く > テキスト・エディター** を選択します
-- 以下のコードを、 **<uses-sdk.../>** と **<application.../>** タグの間に貼り付けてください。
-
- <supports-screens
- android:largeScreens="true"
- android:normalScreens="true"
- android:smallScreens="true"
- android:resizeable="true"
- android:anyDensity="true" />
- <uses-permission android:name="android.permission.VIBRATE" />
- <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
- <uses-permission android:name="android.permission.READ_PHONE_STATE" />
- <uses-permission android:name="android.permission.INTERNET" />
- <uses-permission android:name="android.permission.RECEIVE_SMS" />
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
- <uses-permission android:name="android.permission.READ_CONTACTS" />
- <uses-permission android:name="android.permission.WRITE_CONTACTS" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
- <uses-permission android:name="android.permission.GET_ACCOUNTS" />
- <uses-permission android:name="android.permission.BROADCAST_STICKY" />
-*これにより、パーミッションの包括的なリストを追加していることに注意してください。 Google Play にアプリケーションを提出する前に、使用していないパーミッションは削除してください。
-- 画面の回転をサポートするために、以下を **<activity>** タグの中に貼り付けてください。
-
- android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale"
-
-- AndroidManifest.xml は以下のようになります。
-
- 
-
-4. Hello World の作成
---------------
-
-- **index.html** という名前のファイルを **assets/www** ディレクトリに新規作成します。 以下のコードを貼り付けます:
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>Cordova</title>
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- </head>
- <body>
- <h1>Hello World</h1>
- </body>
- </html>
-
-5A. シミュレーターへのデプロイ
+ 
+- `<project_folder_path>` で使用したディレクトリを選択します
+- Finish をクリックします
+
+もしプロジェクトがa red X indicatingを保つ場合には問題があるので、以下の追加の手順が必要です
+
+- プロジェクトフォルダーを右クリックします
+- プロパティーダイアログで、ナビゲーションパネルから Android を選択します
+- Project build target には、インストールしてある中での最新バージョンの Android API を選択します
+- OK をクリックします
+- プロジェクトメニューバーから Clean を選択します
+- これでプロジェクトからエラーが無くなるはずです
+
+5A. エミュレーターへのデプロイ
-----------------------
- プロジェクトを右クリックし、次を **実行 > Android Application** を選択
- 適切な AVD を選択。 もしない場合は、作成する必要があります
+**注意: より早く動かすために、 Intel ベースのエミュレーターを使用します:**
+
+- Android SDK Manager を開きます
+ 
+- ひとつ以上の `Intel x86 Atom` システムイメージおよび `Intel Hardware Accelerated Execution Manager` (Extras 以下にあります) をインストールします
+- Android SDK の中の `extras/intel/Hardware_Accelerated_Execution_Manager` にダウンロードされた Intel installer を実行します
+- Target を Intel のイメージとした新しい AVD を作成します
+- エミュレーターがスタートするとき、 HAX モジュールのロードに失敗したといったエラーメッセージが出力されないことを確認します
+
5B. デバイスへのデプロイ
--------------------
@@ -132,6 +121,3 @@ Getting Started with Android
- デバイスの設定で USB デバッグが有効になっていること、またコンピュータに接続されていることを確認 (**設定 > アプリケーション > 開発**)
- プロジェクトを右クリックし、次を **実行 > Android Application** を選択
-
-終了
------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/getting-started/index.md b/docs/jp/2.2.0/guide/getting-started/index.md
index 0a4300f..9717bff 100644
--- a/docs/jp/2.2.0/guide/getting-started/index.md
+++ b/docs/jp/2.2.0/guide/getting-started/index.md
@@ -26,5 +26,6 @@ license: Licensed to the Apache Software Foundation (ASF) under one
- Getting Started with Symbian
- Getting Started with WebOS
- Getting Started with Windows Phone
+- Getting Started with Windows 8
- Getting Started with Bada
- Getting Started with Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/getting-started/ios/index.md b/docs/jp/2.2.0/guide/getting-started/ios/index.md
index 155c633..b71f156 100644
--- a/docs/jp/2.2.0/guide/getting-started/ios/index.md
+++ b/docs/jp/2.2.0/guide/getting-started/ios/index.md
@@ -24,7 +24,7 @@ Getting Started with iOS
必要なもの
---------------
-- Xcode 4.3+
+- Xcode 4.5+
- Xcode コマンドラインツール
- Intel ベースの Mac OS X Lion 以上 (10.7+)
- デバイスへのインストールに必要なもの:
@@ -64,6 +64,13 @@ CordovaLib のインストール
- たった今作成した新しいプロジェクトフォルダーを **見つけます**
- フォルダーの中の .xcodeproj を **起動します**
+**注意:**
+Cordova 2.2 から、プロジェクトが Cordova インストール内の CordovaLib のコピーへ依存していたのに代わり、
+プロジェクトが CordovaLib のコピーをプロジェクト内に持つようになりました。
+
+もしプロジェクトが Cordova インストール内の CordovaLib に直接依存するようにしたい場合は、
+`./create --shared` が使用できます。または、プロジェクトを作成した後で
+`./update_cordova_subproject path/to/you/project` とすることで、参照を変更できます。
シミュレーターへのデプロイ
-----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/getting-started/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/getting-started/windows-phone/index.md b/docs/jp/2.2.0/guide/getting-started/windows-phone/index.md
index 1d94d88..2d1ce7c 100644
--- a/docs/jp/2.2.0/guide/getting-started/windows-phone/index.md
+++ b/docs/jp/2.2.0/guide/getting-started/windows-phone/index.md
@@ -64,6 +64,8 @@ Getting Started with Windows Phone
- 'Finish' をクリックします
+
+
3. 新規プロジェクトの作成
--------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/plugin-development/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/plugin-development/android/index.md b/docs/jp/2.2.0/guide/plugin-development/android/index.md
index 910c54e..c2f165c 100644
--- a/docs/jp/2.2.0/guide/plugin-development/android/index.md
+++ b/docs/jp/2.2.0/guide/plugin-development/android/index.md
@@ -23,9 +23,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Cordova-Android は Android WebView とそれに付属するコールバックから構成されます。
これらのプラグインは config.xml ファイル内にクラスマッピングとして表されています。
-プラグインは `Pluguin` クラスを継承した少なくとも1つの Java クラスによって構成されます。
-プラグインは `PluginResult` オブジェクトを返す `execute` メソッドを **必ず **実装しなければなりません。
+プラグインは `CordovaPlugin` クラスを継承した少なくとも1つの Java クラスによって構成されます。
+プラグインは `CordovaPlugin` の中の `execute` メソッドのうち1つを必ずオーバーライドしなければなりません。
加えて、プラグイン作成のベストプラクティスとして、プラグインは pause と resume イベントをサポートし、またプラグイン間のメッセージのやりとりもサポートしているべきです。
+実行に時間がかかったり、バックグラウンドで動く (例: media の再生) もの、リスナーや内部状態を持つプラグインは `onReset()` メソッドが実装されているべきです。このメソッドは `WebView` が新しいページに遷移、もしくはリフレッシュした時、つまり JavaScript がリロードされた時に実行されます。
## プラグインクラスのマッピング
@@ -54,26 +55,61 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
プラグインのクラスの `execute` メソッドに渡されます。大半の `execute`
の実装は以下のようになります:
- public PluginResult execute(String action, JSONArray args, String callbackId) {
- PluginResult.Status status = PluginResult.Status.OK;
- String result = "";
-
- try {
- if (action.equals("beep")) {
- this.beep(args.getLong(0));
- }
- return new PluginResult(status, result);
- } catch (JSONException e) {
- return new PluginResult(PluginResult.Status.JSON_EXCEPTION);
+ @Override
+ public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ this.beep(args.getLong(0));
+ callbackContext.success();
+ return true;
}
+ return false; // "MethodNotFound" エラーのため false を返す
}
-基本的に `action` パラメーターの値を見て、クラス内の
+`action` パラメーターの値を見て、クラス内の
(プライベート) メソッドに割り振っていきます。
また、任意でいくつかのパラメーターをそのメソッドに渡します。
例外をキャッチしエラーを返すとき、 JavaScript へ返すエラーが Java で発生した例外に可能なかぎり近づけることは、明瞭さのためにも重要です。
+### スレッド
+
+WebView の中の JavaScript は UI スレッド上で実行 *されません*。
+WebCore スレッド上で動いています。 `execute` メソッドもまた WebCore スレッド上で実行されます。
+
+もし UI と何か処理をしたい場合は、以下のようにします:
+
+ @Override
+ public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ final long duration = args.getLong(0);
+ cordova.getActivity().runOnUiThread(new Runnable() {
+ public void run() {
+ ...
+ callbackContext.success(); // スレッドセーフ
+ }
+ });
+ return true;
+ }
+ return false;
+ }
+
+もし UI スレッド上で動かす必要がなく、しかし WebCore スレッドをブロックしたくない場合は以下のようにします:
+
+ @Override
+ public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ final long duration = args.getLong(0);
+ cordova.getThreadPool().execute(new Runnable() {
+ public void run() {
+ ...
+ callbackContext.success(); // スレッドセーフ
+ }
+ });
+ return true;
+ }
+ return false;
+ }
+
### Android プラグインの Echo プラグイン
次を config.xml に追加します:
@@ -84,7 +120,7 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
`src/org/apache/cordova/plugin/Echo.java` に追加します:
- package org.apache.cordova.plugin;
+ package org.apache.cordova.CordovaPlugin;
import org.apache.cordova.api.Plugin;
import org.apache.cordova.api.PluginResult;
@@ -95,50 +131,42 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
/**
* このクラスは JavaScript から呼び出された文字列をecho します。
*/
- public class App extends Plugin {
-
- /**
- * リクエストを実行し、 PluginResult を返します。
- *
- * @param action 実行するアクション名です。
- * @param args プラグインへの引数の JSONArry です。
- * @param callbackId JavaScript へコールバックするときに使うコールバック id です。
- * @return ステータスとメッセージを伴った PluginResult オブジェクトです。
- */
- public PluginResult execute(String action, JSONArray args, String callbackId) {
- try {
- if (action.equals("echo")) {
- String echo = args.getString(0);
- if (echo != null && echo.length() > 0) {
- return new PluginResult(PluginResult.Status.OK, echo);
- } else {
- return new PluginResult(PluginResult.Status.ERROR);
- }
- } else {
- return new PluginResult(PluginResult.Status.INVALID_ACTION);
- }
- } catch (JSONException e) {
- return new PluginResult(PluginResult.Status.JSON_EXCEPTION);
+ public class Echo extends CordovaPlugin {
+ @Override
+ public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+ if (action.equals("echo")) {
+ String message = args.getString(0);.
+ this.echo(message);
+ return true;
+ }
+ return false;
+ }
+
+ private void echo(String message, CallbackContext callbackContext) {
+ if (message != null && message.length() > 0) {.
+ callbackContext.success(message);
+ } else {
+ callbackContext.error("Expected one non-empty string argument.");
}
}
}
コードを見ていきましょう。一番上には、必要なすべての Cordova に関する
-`import` 文が並んでいます。クラスは `Plugin` を継承しています - これはとても
-重要です。 `Plugin` インターフェースは `execute` メソッドを実装する必要が
-あります。メソッドは、最初に `action` を見ていきます。このプラグインは1つ
-のアクション `echo` のみをサポートしています。ほかのアクションは、ステータス
-が `INVALID_ACTION` となった `PluginResult` が返されます - これは JavaScript
+`import` 文が並んでいます。クラスは `CordovaPlugin` を継承しています。
+exec() からメッセージを受け取るために、 execute() メソッドをオーバーライドします。
+メソッドは、最初に `action` を見ていきます。このプラグインは1つ
+のアクション `echo` のみをサポートしています。ほかのアクションは、 false を返します。
+これは、タイプが `INVALID_ACTION` のエラーとなります - これは JavaScript
側でエラーコールバックへの呼び出しに変換されます。次に、 `args` に対して
`getString` メソッドを使い、パラメーター配列から0番目のパラメーターを取得
することにより、 echo する文字列を取り出します。ここで、少しパラメーターに
対してチェックを行います: `null` チェックや文字列の長さが0でないかどうかなど
-です。もしそうであった場合は、ステータスが `ERROR` の `PluginResult` を
-返します (これはもうご存知の通り JavaScript 側でエラーコールバックを
-呼び出します)。もしこれらのチェックをパスしたら、ステータスが `OK` の
-`PluginResult` を返し、パラメーターとして受け取った `echo` 文字列を
-渡します。これが、 JavaScript 側で成功コールバック関数に変換されます。
-また、 `echo` パラメーターを JavaScript の成功コールバック関数に
+です。もしそうであった場合は、 callbackContext.error() を呼びます (これはもう
+ご存知の通り JavaScript 側でエラーコールバックを呼び出します)。
+もしこれらのチェックをパスしたら、 callbackContext.success() を呼び出し、
+パラメーターとして渡された `message` 文字列を渡します。これが、
+JavaScript 側で成功コールバック関数に変換されます。
+また、 `message` パラメーターを JavaScript の成功コールバック関数に
パラメーターとして渡します。
## プラグインのデバッグ
@@ -151,4 +179,10 @@ Eclipse は Android プロジェクトのデバッグに使用でき、 Java の
`CordovaInterface` は、結果として `Activity` を開始すること、また `Intent` がアプリケーションに戻ってきたときにコールバックをセットすることをプラグインに許可します。
`Intent` システムは Android のプロセス間の連携に使われるため、これは非常に重要です。
* プラグインは `Context` への直接アクセス権を以前のように持っていません。以前の `ctx` はもう廃止され、 2.0 リリースの6ヶ月後に削除されます。 `Context` にあった `ctx` が存在するすべてのメソッド、 `getContext()` と `getActivity()` は必要な正しいオブジェクトを返すことが可能です。
-* `webView.loadUrl()` を使って JavaScript を呼び出すことは避けてください。コールバックサーバーがある理由は、 JavaScript がスレッドセーフで実行されるためです。 `loadUrl` は明確に UI スレッドに割り込み、プラグインのユーザビリティーに影響します。
+
+## ソースコードを活用する
+
+プラグインを作成の準備としてもっとも良い方法のうちの一つは、
+[既に存在するプラグインを参考にすること](https://github.com/apache/incubator-cordova-android/tree/master/framework/src/org/apache/cordova) です。
+
+また、 [CordovaPlugin.java](https://github.com/apache/incubator-cordova-android/blob/master/framework/src/org/apache/cordova/api/CordovaPlugin.java) のコメントもひと通り読むべきでしょう。
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/plugin-development/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/plugin-development/ios/index.md b/docs/jp/2.2.0/guide/plugin-development/ios/index.md
index 591ff95..1bc1bb5 100644
--- a/docs/jp/2.2.0/guide/plugin-development/ios/index.md
+++ b/docs/jp/2.2.0/guide/plugin-development/ios/index.md
@@ -19,10 +19,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Developing a Plugin on iOS
-プラグインの開発には、 Cordova-iOS のアーキテクチャの理解が必要です。 Conrdova-iOS は UIWebView から構成されています。インターセプト命令は、 URL の変化に応じて UIWebView に渡されます。これらのプラグインは .plist ファイルの Plugins キーにクラスマッピングとして表されています。
-
プラグインは `CDVPlugin` クラスを継承した Objective-C のクラスです。
+各プラグインクラスは Cordova.plist ファイルの Plugins キーを使用し登録されている必要があります。
+
## プラグインクラスのマッピング
プラグインの JavaScript 部分は常に `cordova.exec` メソッドを以下のように使います:
@@ -31,6 +31,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
これは UIWebView から iOS ネイティブ側へのリクエストを整理し、おおよそ要約すると `service` クラスで `action` メソッドを、 `args` 配列で渡された引数と一緒に呼び出すということになります。
+実行に時間がかかったり、バックグラウンドで動く (例: media の再生) もの、リスナーや内部状態を持つプラグインは `onReset()` メソッドが実装され、これらの動作を停止またはリセットすべきです。このメソッドは `UIWebView` が新しいページに遷移、もしくはリフレッシュした時、つまり JavaScript がリロードされた時に実行されます。
+
このプラグインは、 Cordova-iOS アプリケーションのプロジェクトフォルダーの中の `Cordova.plist` ファイルの `Plugins` キー (辞書) に追加される必要があります。
<key>service_name</key>
@@ -44,24 +46,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
JavaScript の `exec` 関数によってプラグインに割り当てられたものは、プラグインクラスの対応する `action` メソッドに渡されます。プラグインメソッドのシグネチャは次のようになります:
- - (void) myMethod:(CDVInvokedUrlCommand*)command
+ - (void)myMethod:(CDVInvokedUrlCommand*)command
{
CDVPluginResult* pluginResult = nil;
- NSString* javaScript = nil;
-
- @try {
- NSString* myarg = [command.arguments objectAtIndex:0];
-
- if (myarg != nil) {
- pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
- javaScript = [pluginResult toSuccessCallbackString:command.callbackId];
- }
- } @catch (id exception) {
- pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_JSON_EXCEPTION messageAsString:[exception reason]];
- javaScript = [pluginResult toErrorCallbackString:command.callbackId];
- }
+ NSString* myarg = [command.arguments objectAtIndex:0];
- [self writeJavascript:javaScript];
+ if (myarg != nil) {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
+ } else {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Arg was null"];
+ }
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
1. [CDVInvokedUrlCommand.h](https://github.com/apache/incubator-cordova-ios/blob/master/CordovaLib/Classes/CDVInvokedUrlCommand.h)
@@ -72,11 +67,11 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
**Cordova 2.1.0** からサポートされた **新しいシグネチャ** は次のとおりです:
- - (void) myMethod:(CDVInvokedUrlCommand*)command;
+ - (void)myMethod:(CDVInvokedUrlCommand*)command;
**古い (非推奨)** シグネチャはつぎのとおりです:
- - (void) myMethod:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options;
+ - (void)myMethod:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options;
基本的に、オプション辞書は新しいシグネチャでは削除されており、 callbackId は引数配列の 0 番目の要素ではなく、別のプロパティーとなっています。
@@ -96,7 +91,7 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
@interface Echo : CDVPlugin
- - (void) echo:(CDVInvokedUrlCommand*)command;
+ - (void)echo:(CDVInvokedUrlCommand*)command;
@end
@@ -107,27 +102,18 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
@implementation Echo
- - (void) echo:(CDVInvokedUrlCommand*)command
+ - (void)echo:(CDVInvokedUrlCommand*)command
{
CDVPluginResult* pluginResult = nil;
- NSString* javaScript = nil;
-
- @try {
- NSString* echo = [command.arguments objectAtIndex:0];
-
- if (echo != nil && [echo length] > 0) {
- pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:echo];
- javaScript = [pluginResult toSuccessCallbackString:command.callbackId];
- } else {
- pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR];
- javaScript = [pluginResult toErrorCallbackString:command.callbackId];
- }
- } @catch (NSException* exception) {
- pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_JSON_EXCEPTION messageAsString:[exception reason]];
- javaScript = [pluginResult toErrorCallbackString:command.callbackId];
+ NSString* echo = [command.arguments objectAtIndex:0];
+
+ if (echo != nil && [echo length] > 0) {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:echo];
+ } else {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR];
}
- [self writeJavascript:javaScript];
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
@end
@@ -137,9 +123,26 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
このプラグインは 1 つのアクション `echo` のみをサポートしています。最初に、 `objectAtIndex` メソッドを `args` に使って引数配列 0 番目の要素である echo 用文字列を取得します。次に、 `objectAtIndex` メソッドを使って、引数配列の1番目の要素である echo 用文字列を取得します。ここで、少しパラメーターに対してチェックを行います: `nil` チェックや文字列の長さが0でないかどうかなどです。
-もしそうであった場合は、ステータスが `ERROR` の `PluginResult` を返します。もしこれらのチェックをパスしたら、ステータスが `OK` の `PluginResult` を返し、パラメーターとして受け取った `echo` 文字列を渡します。そして、もし正常な場合は `toSuccessCallbackString` メソッド、エラーの場合は `toErrorCallbackString` メソッドを呼びだして `PluginResult` を JavaScript に変換します。
+もしそうであった場合は、ステータスが `ERROR` の `PluginResult` を返します。もしこれらのチェックをパスしたら、ステータスが `OK` の `PluginResult` を返し、パラメーターとして受け取った `echo` 文字列を渡します。
+
+最後に、 `self.commandDelegate` に結果を返します。これは、 JavaScript 側で成功またはエラーコールバック関数を実行するような JavaScript を実行します。もし成功コールバックが呼ばれた場合は、 `echo` パラメーターをパラメーターとして渡します。
+
+## スレッド
+
+たとえ UIWebView が dedicated thread 上で実行されるとしても、プラグインメソッドは UI スレッドで実行されます。もしプラグインが尋常じゃない数のプロセスが必要、または処理をブロックする必要がある場合は、バックグラウンドスレッドを使用するべきです。使用例は次のとおりです:
+
+ - (void)myPluginMethod:(CDVInvokedUrlCommand*)command
+ {
+ // Check command.arguments here.
+ [self.commandDelegate runInBackground:^{
+ NSString* payload = nil;
+ // Some blocking logic...
+ CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:payload];
+ // The sendPluginResult method is thread-safe.
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+ }];
+ }
-最後に、 JavaScript 側で成功またはエラーコールバック関数を実行するような JavaScript を書き出します。もし成功コールバックが呼ばれた場合は、 `echo` パラメーターをパラメーターとして渡します。
## 一歩進んだプラグインの機能
@@ -152,7 +155,7 @@ JavaScript の `exec` 関数によってプラグインに割り当てられた
## プラグインのデバッグ
-Objective-C 側でデバッグするには、 Xcode のビルトインのデバッガーを使用します。 JavaScript 側では、 [Apache Cordova Project の Weinre](https://github.com/apache/incubator-cordova-weinre) または [サードパーティ製の iWebInspector](http://www.iwebinspector.com/) を使用できます。
+Objective-C 側でデバッグするには、 Xcode のビルトインのデバッガーを使用します。 JavaScript 側では、 iOS 5.0 では [Apache Cordova Project の Weinre](https://github.com/apache/incubator-cordova-weinre) または [サードパーティ製の iWebInspector](http://www.iwebinspector.com/) を使用できます。
iOS 6 では、 Safari 6.0 を使用して簡単に iOS 6 シミュレーター上で動いているアプリをデバッグできます。
@@ -160,11 +163,6 @@ iOS 6 では、 Safari 6.0 を使用して簡単に iOS 6 シミュレーター
* Cordova.plist にプラグインマッピングを追加することを忘れないでください - もし忘れている場合は、 Xcode のコンソールログにエラーが表示されます
* 接続するすべてのホストを [ホワイトリスト](guide_whitelist_index.md.html#Domain%20Whitelist%20Guide) に追加することを忘れないで下さい - もし忘れている場合は、 Xcode のコンソールログにエラーが表示されます
-* もしアプリが復帰する際にイベント処理をしていて、イベント復帰時にアラートといったようなネイティブ関数を実行すると、アプリケーションが停止してしまいます。安全のため、 JavaScript 呼び出しをタイムアウト値0の setTimeout でラップしてください:
-
- setTimeout(function() {
- // 任意のコード
- }, 0);
## 非推奨のプラグインシグネチャに関する注意点
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/upgrading/android/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/upgrading/android/index.md b/docs/jp/2.2.0/guide/upgrading/android/index.md
index c97de1e..db7272d 100644
--- a/docs/jp/2.2.0/guide/upgrading/android/index.md
+++ b/docs/jp/2.2.0/guide/upgrading/android/index.md
@@ -23,6 +23,16 @@ Upgrading Cordova Android
これは、 Cordova を古いバージョンから新しいバージョンにアップグレードする必要がある人のためのドキュメントです。
+## 2.1.0 から 2.2.0 へのアップグレード ##
+
+1. プロジェクトの libs ディレクトリから cordova-2.1.0.jar を削除します
+2. プロジェクトの libs ディレクトリに cordova-2.2.0.jar を追加します
+3. もし Eclipse を使用している場合は、プロジェクトをリフレッシュし clean を実行します
+4. 新しい cordova-2.2.0.js をプロジェクトにコピーします
+5. HTML を、新しい cordova-2.2.0.js を使って更新します
+6. res/xml/config.xml を framework/res/xml/config.xml と同じとなるようにコピーします
+
+
## 2.0.0 から 2.1.0 へのアップグレード ##
1. プロジェクトの libs ディレクトリから cordova-2.0.0.jar を削除します
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/87908570/docs/jp/2.2.0/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/jp/2.2.0/guide/upgrading/ios/index.md b/docs/jp/2.2.0/guide/upgrading/ios/index.md
index 5606d2e..ac0c297 100644
--- a/docs/jp/2.2.0/guide/upgrading/ios/index.md
+++ b/docs/jp/2.2.0/guide/upgrading/ios/index.md
@@ -20,7 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Upgrading Cordova iOS
=====================
-**Xcode 4 が必須** であることに注意してください。 Apple App Store に提出するためには、最新バージョンの iOS SDK (iOS 5.1) を使用する必要があります。 iOS 5.1 は Xcode 4 を必要とします。
+**Xcode 4.5 が必須** であることに注意してください。 Apple App Store に提出するためには、最新バージョンの iOS SDK (iOS 6) を使用する必要があります。 iOS 6 は Xcode 4.5 を必要とします。
+
+## 2.1.0 から 2.2.0 へのアップグレード ##
+
+1. ハードディスクの**恒久的なフォルダー** (例: ~/Documents/Cordova-2.2.0) に **Cordova 2.2.0 をダウンロードし解凍**します
+2. Xcode が起動している場合、 **終了** します
+3. **Terminal.app** を使用して、Cordova をダウンロードしたディレクトリまで **移動**します
+4. コマンドラインツールから [**新規プロジェクトを作成**](guide_command-line_index.md.html#Command-Line%20Usage_ios) します - この新規プロジェクトからアセットを持っていきます
+5. 新規プロジェクトから **www/cordova-2.2.0.js** ファイルを **www** フォルダーに **コピー** し、 **www/cordova-2.1.0.js** ファイルを削除します
+6. **www/index.html** ファイル (また、他に Cordova script を参照しているファイル) の Cordova script 参照部分を、新しい **cordova-2.2.0.js** ファイルを参照するように **更新** します
+7. **MainViewController.m** を新規プロジェクトから更新 (または、もしファイルを変更してなかった場合は置換) します:
+ - 追加されたもの -> viewWillAppear
+8. **"cordova"** フォルダーを新しいプロジェクトから既存プロジェクトのルートフォルダーにコピーします **(2.2.0 では、 'emulate' スクリプトのアップデートがあります)**
+9. 次に、 CordovaLib のサブプロジェクトの参照を更新します。 Cordova 2.1.0 から、 CordovaLib がどこに存在するかを示す CORDOVALIB という Xcode の変数は使用しなくなり、絶対ファイル参照となりました。
+ 1. **Terminal.app** を起動します
+ 2. **ステップ 1** で Cordova をインストールした位置の、 **bin** サブフォルダーに移動します
+ 3. 以下のスクリプトを走らせます。パラメーターは、プロジェクトの **.xcodeproj** ファイルへのパスです
+
+ `update_cordova_subproject path/to/your/project/xcodeproj`
+
+**注意** 2.2.0 では、 **bin/create** スクリプトが プロジェクトの CordovaLib サブプロジェクト内にコピーされるようになります。同じようなセットアップを保持するためにも、正しい CordovaLib をプロジェクトのフォルダーにコピーして、 CordovaLib サブプロジェクトの位置情報 (プロジェクトに関係) を Xcode File Inspector で更新してください。
## 2.0.0 から 2.1.0 へのアップグレード ##