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/10/22 00:42:27 UTC
[1/3] docs commit: new WebView intro text
Updated Branches:
refs/heads/master 8b1b333d3 -> b54c7d980
new WebView intro text
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/aad4414c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/aad4414c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/aad4414c
Branch: refs/heads/master
Commit: aad4414cb06ed5f22889a19565eb58e6afc213bf
Parents: 8b1b333
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Oct 17 10:29:51 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Oct 21 15:42:38 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/hybrid/webviews/index.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/aad4414c/docs/en/edge/guide/hybrid/webviews/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/hybrid/webviews/index.md b/docs/en/edge/guide/hybrid/webviews/index.md
index 937db59..106a000 100644
--- a/docs/en/edge/guide/hybrid/webviews/index.md
+++ b/docs/en/edge/guide/hybrid/webviews/index.md
@@ -19,7 +19,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Embedding WebViews
-> Implement the Cordova WebView in your own project.
+Cordova applications are ordinarily implemented as a browser-based
+_WebView_ within the native mobile platform. This section shows how,
+for supporting platforms, to create your own WebView components that
+make full use of Cordova APIs. You can then deploy these Cordova
+application components along with native components in a hybrid
+application.
+
+To deploy a WebView, you will need to be familiar with each native
+programming environment. The following provides instructions for
+supported platforms:
- Android WebViews
- iOS WebViews
[3/3] docs commit: cleanup iOS WebViews
Posted by mw...@apache.org.
cleanup iOS WebViews
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/b54c7d98
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/b54c7d98
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/b54c7d98
Branch: refs/heads/master
Commit: b54c7d980f018f024017d8e8e1128f15719c2854
Parents: 572353c
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Oct 17 12:33:09 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Oct 21 15:42:39 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/ios/webview.md | 138 ++++++++++++++---------
1 file changed, 83 insertions(+), 55 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b54c7d98/docs/en/edge/guide/platforms/ios/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/webview.md b/docs/en/edge/guide/platforms/ios/webview.md
index e755392..d63eba2 100644
--- a/docs/en/edge/guide/platforms/ios/webview.md
+++ b/docs/en/edge/guide/platforms/ios/webview.md
@@ -19,55 +19,66 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# iOS WebViews
-Beginning with Cordova 1.4, you can use Cordova as a component in your
-iOS applications. This component is code-named 'Cleaver'.
+This section shows how to embed a Cordova-enabled WebView component
+within a larger iOS application. For details on how these components
+can communicate with each other, see Application Plugins.
-New Cordova-based applications created using the Xcode template
-provided in Cordova 1.4 or greater use Cleaver. (The template is
-Cleaver's reference implementation.)
+Support for iOS WebViews started with Cordova version 1.4, using a
+`Cleaver` component for which the Xcode template serves as a reference
+implementation. Cordova 2.0 and later versions only support the
+subproject-based Cleaver implementation.
-Cordova 2.0.0 and subsequent versions only support the sub-project
-based Cleaver implementation.
+These instructions require at least Cordova 2.3 and Xcode 4.5, along
+with a `config.xml` file from a newly created iOS project. You can use
+the procedure in The Command-line Interface to create a new project,
+then obtain the `config.xml` file from within the named application's
+subdirectory within `platforms/ios`.
-## Prerequisites
+To follow these instructions, make sure you have the latest Cordova
+distribution. Download it from
+[cordova.apache.org](http://cordova.apache.org) and unzip its iOS
+package.
-* Cordova 2.3.0 or greater
+## Adding Cleaver to the Xcode project (CordovaLib sub-project)
-* Xcode 4.5 or greater
+1. Quit Xcode if it is running.
-* `config.xml` file (from a newly created iOS project)
+1. Open a terminal and navigate to the source directory for Cordova
+ iOS.
-## Adding Cleaver to your Xcode project (CordovaLib sub-project)
+1. Copy the `config.xml` file described above into the project
+ directory.
-1. Download and extract the Cordova source to a permanent directory location on your hard drive, for example to `~/Documents/Cordova`.
+1. Open Xcode and use the Finder to copy the `config.xml` file into
+ its __Project Navigator__ window.
-2. Quit Xcode if it is running.
+1. Choose __Create groups for any added folders__ and press
+ __Finish__.
-3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+1. Use the Finder to copy the `CordovaLib/CordovaLib.xcodeproj` file
+ into Xcode's __Project Navigator__
-4. Copy the `config.xml` file into your project directory on disk (see the Prerequisites above).
+1. Select `CordovaLib.xcodeproj` within the __Project Navigator__.
-5. Drag and drop the `config.xml` file into the Project Navigator of Xcode.
+1. Type the __Option-Command-1__ key combination to show the __File
+ Inspector__.
-6. Choose the __Create groups for any added folders__ radio button and press __Finish__.
+1. Choose __Relative to Group__ in the __File Inspector__ for the
+ drop-down menu for __Location__.
-7. Drag and drop the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent directory location above, and it should be in the `CordovaLib` subdirectory).
+1. Select the __project icon__ in the __Project Navigator__, select
+ the __Target__, then select the __Build Settings__ tab.
-8. Select `CordovaLib.xcodeproj` in the Project Navigator.
+1. Add `-all_load` and `-Obj-C` for the __Other Linker Flags__ value.
-9. Type the __Option-Command-1__ key combination to show the __File Inspector__.
+1. Click on the __project icon__ in the Project Navigator, select the
+ __Target__, then select the __Build Phases__ tab.
-10. Choose __Relative to Group__ in the __File Inspector__ for the drop-down menu for __Location__.
+1. Expand __Link Binaries with Libraries__.
-11. Select the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Settings__ tab.
-
-12. Add `-all_load` and `-Obj-C` for the __Other Linker Flags__ value.
-
-13. Click on the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Phases__ tab.
-
-14. Expand __Link Binaries with Libraries__.
-
-15. Select the __+__ button, and add the following __frameworks__. Optionally in the Project Navigator, move them under the __Frameworks__ group):
+1. Select the __+__ button, and add the following __frameworks__.
+ Optionally within the __Project Navigator__, move them under the
+ __Frameworks__ group:
AddressBook.framework
AddressBookUI.framework
@@ -80,72 +91,89 @@ based Cleaver implementation.
MobileCoreServices.framework
CoreMedia.framework
-16. Expand __Target Dependencies__, the top box labeled like this if you have multiple boxes!
+1. Expand __Target Dependencies__, the top box with that label if
+ there's more than one box.
-17. Select the __+__ button, and add the `CordovaLib` build product.
+1. Select the __+__ button, and add the `CordovaLib` build product.
-18. Expand __Link Binaries with Libraries__, the top box labeled like
- this if you have multiple boxes!
+1. Expand __Link Binaries with Libraries__, the top box with that label
+ if there's more than one box.
-19. Select the __+__ button, and add `libCordova.a`.
+1. Select the __+__ button, and add `libCordova.a`.
-20. Set the Xcode preference __Xcode Preferences → Locations → Derived Data → Advanced...__ to __Unique__.
+1. Set the __Xcode Preferences → Locations → Derived Data
+ → Advanced...__ to __Unique__.
-21. Select the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Settings__ tab.
+1. Select the __project icon__ in the Project Navigator, select your
+ __Target__, then select the __Build Settings__ tab.
-22. Search for __Header Search Paths__. For that setting, add these three values below (with quotes):
+1. Search for __Header Search Paths__. For that setting, add these
+ three values below, including the quotes:
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
"$(OBJROOT)/UninstalledProducts/include"
"$(BUILT_PRODUCTS_DIR)"
- With Cordova 2.1.0, `CordovaLib` has been upgraded to use __Automatic Reference Counting (ARC)__. You don't need to upgrade to __ARC__ to use CordovaLib, but if you want to upgrade your project to use __ARC__, please use the Xcode migration wizard from the menu: __Edit → Refactor → Convert to Objective-C ARC...__, __de-select libCordova.a__, then run the wizard to completion.
+ As of Cordova 2.1.0, `CordovaLib` has been upgraded to use
+ __Automatic Reference Counting (ARC)__. You don't need to upgrade
+ to __ARC__ to use `CordovaLib`, but if you want to upgrade your
+ project to use __ARC__, you should use the Xcode migration wizard
+ from the __Edit → Refactor → Convert to Objective-C
+ ARC...__ menu, __de-select libCordova.a__, then run the wizard to
+ completion.
-## Using CDVViewController in your code
+## Using CDVViewController
-1. Add this header:
+1. Add the following header:
#import <Cordova/CDVViewController.h>
-2. Instantiate a new `CDVViewController`, and retain it somewhere (e.g., to a property in your class):
+1. Instantiate a new `CDVViewController` and retain it somewhere,
+ e.g., to a class property:
CDVViewController* viewController = [CDVViewController new];
-3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `www`):
+1. Optionally, set the `wwwFolderName` property, which defaults to `www`:
viewController.wwwFolderName = @"myfolder";
-4. (_OPTIONAL_) Set the start page in your config.xml, the `<content>` tag.
+1. Optionally, set the start page in the `config.xml` file's
+ `<content>` tag, either a local file:
<content src="index.html" />
- OR
+ ...or a remote site:
<content src="http://apache.org" />
-5. (_OPTIONAL_) Set the `useSplashScreen` property (defaults to `NO`):
+1. Optionally, set the `useSplashScreen` property, which defaults to
+ `NO`:
viewController.useSplashScreen = YES;
-6. Set the __view frame__ (always set this as the last property):
+1. Set the __view frame__. Always set this as the last property:
viewController.view.frame = CGRectMake(0, 0, 320, 480);
-7. Add Cleaver to your view:
+1. Add Cleaver to the view:
[myView addSubview:viewController.view];
-## Adding your HTML, CSS and JavaScript assets
+## Adding HTML, CSS and JavaScript assets
-1. Create a new directory in your project on disk, `www` for example.
+1. Create a new directory within the project, `www` for example.
-2. Put your HTML, CSS and JavaScript assets into this directory.
+1. Place HTML, CSS and JavaScript assets into this directory.
-3. Drag and drop the directory into the Project Navigator of Xcode.
+1. Use the Finder to copy the directory into Xcode's __Project
+ Navigator__ window.
-4. Choose the __Create folder references for any added folders__ radio button.
+1. Select __Create folder references for any added folders__.
-5. Set the appropriate `wwwFolderName` and `startPage` properties for the folder you initially created, or use the defaults (see previous section) when you instantiate the `CDVViewController`.
+1. Set the appropriate `wwwFolderName` and `startPage` properties for
+ the directory you initially created, or use the defaults (specified
+ in the previous section) when instantiating the
+ `CDVViewController`.
/*
if you created a folder called 'myfolder' and
[2/3] docs commit: tightened up Android WebView page
Posted by mw...@apache.org.
tightened up Android WebView page
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/572353c5
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/572353c5
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/572353c5
Branch: refs/heads/master
Commit: 572353c50bfd550150f6c7cc624b6aae307b1b08
Parents: aad4414
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Oct 17 11:23:45 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Oct 21 15:42:39 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/android/webview.md | 61 +++++++++++---------
1 file changed, 35 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/572353c5/docs/en/edge/guide/platforms/android/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/webview.md b/docs/en/edge/guide/platforms/android/webview.md
index c3eb8f8..875ccaf 100644
--- a/docs/en/edge/guide/platforms/android/webview.md
+++ b/docs/en/edge/guide/platforms/android/webview.md
@@ -19,39 +19,44 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android WebViews
-Beginning in Cordova 1.9, with the assistance of the
-`CordovaActivity`, you can use Cordova as a component in a larger
-native Android application. Android refers to this component as the
-`CordovaWebView`. New Cordova-based applications from 1.9 onwards use
-the `CordovaWebView` as its main view, regardless of whether the
-legacy `CordovaActivity` approach is used.
+This section shows how to embed a Cordova-enabled WebView component
+within a larger Android application. For details on how these
+components can communicate with each other, see Application Plugins.
-If you're unfamiliar with Android application development, please read
-the Android Platform Guide to developing a Cordova Application before
-attempting to include a WebView. It's not the main way to author
-Android Cordova applications. These instructions are currently manual,
-but may be eventually be automated.
+If you're unfamiliar with Android, you should first familiarize
+yourself with the Android Platform Guide and have the latest Android
+SDK installed before you attempt the more unusual development option
+of embedding a WebView. Starting with Cordova 1.9, the Android
+platform relies on a `CordovaWebView` component, which builds on a
+legacy `CordovaActivity` component that pre-dates the 1.9 release.
-## Prerequisites
+1. To follow these instructions, make sure you have the latest Cordova
+ distribution. Download it from
+ [cordova.apache.org](http://cordova.apache.org) and unzip its
+ Android package.
-* Cordova 1.9 or greater
+1. Navigate to the Android package's `/framework` directory and run
+ `ant jar`. It creates the Cordova `.jar` file, formed as
+ `/framework/cordova-x.x.x.jar`.
-* Android SDK updated to the latest SDK
+1. Copy the `.jar` file into the Android project's `/libs` directory.
-## Guide to using CordovaWebView in an Android Project
-
-1. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-x.x.x.jar` in the `/framework` directory.
-
-2. Copy the cordova jar into your Android project's `/libs` directory.
-
-3. Edit your application's `main.xml` file (under `/res/xml`) to look like the following, with the `layout_height`, `layout_width` and `id` modified to suit your application:
+1. Add the following to the application's `/res/xml/main.xml` file,
+ with the `layout_height`, `layout_width` and `id` modified to suit
+ the application:
<org.apache.cordova.CordovaWebView
android:id="@+id/tutorialView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
-4. Modify your activity so that it implements the `CordovaInterface`. You should implement the included methods. You may wish to copy them from `/framework/src/org/apache/cordova/CordovaActivity.java`, or implement them on your own. The code fragment below shows a basic application that uses the interface. Note how the referenced view id matches the `id` attribute specified in the XML fragment shown above:
+1. Modify the activity so that it implements the `CordovaInterface`.
+ It should implement the included methods. You may wish to copy
+ them from `/framework/src/org/apache/cordova/CordovaActivity.java`,
+ or else implement them on your own. The following code fragment
+ shows a basic application that relies on the interface. Note how
+ the referenced view id matches the `id` attribute specified in the
+ XML fragment shown above:
public class CordovaViewTestActivity extends Activity implements CordovaInterface {
CordovaWebView cwv;
@@ -65,7 +70,8 @@ but may be eventually be automated.
cwv.loadUrl(Config.getStartUrl());
}
-If you use the camera, you should also implement this:
+1. If the application needs to use the camera, implement the
+ following:
@Override
public void setActivityResultCallback(CordovaPlugin plugin) {
@@ -110,13 +116,16 @@ If you use the camera, you should also implement this:
}
}
-Finally, remember to add the thread pool, otherwise the plugins have no threads to run on:
+1. Finally, remember to add the thread pool, otherwise plugins
+ have no threads on which to run:
@Override
public ExecutorService getThreadPool() {
return threadPool;
}
-6. Copy your application's HTML and JavaScript files to your Android project's `/assets/www` directory.
+1. Copy the application's HTML and JavaScript files to the Android
+ project's `/assets/www` directory.
-7. Copy `config.xml` from `/framework/res/xml` to your project's `/res/xml` directory.
+1. Copy the `config.xml` file from `/framework/res/xml` to the
+ project's `/res/xml` directory.