You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[CB-3159] Initial draft of getting started for BlackBerry 10
[BlackBerry10][CB-3159] Adding BlackBerry10 getting started plugin development docs
Fixed hyperlinks on getting started and plugin dev guides for bb10
Code review changes
Copy file name to clipboardExpand all lines: docs/en/edge/guide/getting-started/blackberry10/index.md
-81Lines changed: 0 additions & 81 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
20
20
Getting Started with BlackBerry 10
21
21
==================================
22
22
23
-
<<<<<<< HEAD
24
23
Apache Cordova is an application development platform that allows you to use common web technologies—primarily HTML5, JavaScript, and CSS—to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS.
25
-
=======
26
-
Apache Cordova is an application development platform that allows you to use common web technologies-—primarily HTML5, JavaScript, and CSS—-to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS.
27
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
28
24
29
25
Requirements
30
26
------------
@@ -38,11 +34,7 @@ Cordova for BlackBerry has the following software requirements:
38
34
Setting up your signing keys
39
35
----------------------------
40
36
41
-
<<<<<<< HEAD
42
37
Before starting development, you’ll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself; if you supply the keystore password, the build script will create and install the debug token for you.
43
-
=======
44
-
Before starting development, you’ll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself, however; if you supply the keystore password, the build script will create and install the debug token for you.
45
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
46
38
47
39
-[Register for your code signing key now.](https://www.blackberry.com/SignedKeys/codesigning.html)
48
40
-[Set your computer up for code signing. ](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
@@ -55,56 +47,11 @@ To create a new project, you use the `create` command to set up the folder struc
55
47
56
48
1. On the command line, navigate to the folder where you extracted Cordova.
57
49
2. Run the `create` command using the following syntax:
58
-
<<<<<<< HEAD
59
50
```
60
51
bin/create <path-to-project>
61
52
```
62
53
63
54
This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
64
-
=======
65
-
```bin/create <path-to-project>```
66
-
67
-
This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
68
-
69
-
Adding and managing plugins
70
-
---------------------------
71
-
72
-
To add additional functionality that is outside of the core features of Cordova, you’ll need to add plugins. A plugin represents a set of APIs that provide access to additional features of the platform. For example, the `com.blackberry.bbm.platform` plugin allows you to integrate your app with features of the BBM social platform.
73
-
74
-
In order to use a plugin, you must first install it into your project. Once installed into your project, the plugin will be bundled with your project during the build process, to ensure that your app has access to all the APIs it needs.
75
-
76
-
Plugins hosted locally must be fetched before they can be installed. Plugins hosted remotely can simply be installed.
77
-
78
-
###Fetch a locally-hosted plugin
79
-
80
-
To fetch a locally-hosted plugin, on the command line, type the following command:
Once fetched, the plugin can be installed by name, just as a remotely hosted plugin.
86
-
87
-
###View a list of remote plugins
88
-
89
-
To view a list of remotely hosted plugins, on the command line, type the following command:
90
-
91
-
```<path-to-project>/cordova/plugin ls
92
-
```
93
-
94
-
###Install a plugin
95
-
96
-
To install a plugin, on the command line, type the following command:
97
-
98
-
```<path-to-project>/cordova/plugin add <name>
99
-
```
100
-
101
-
###Remove a plugin
102
-
103
-
To remove a plugin, on the command line, type the following command:
104
-
105
-
```<path-to-project>/cordova/plugin rm <name>
106
-
```
107
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
108
55
109
56
Adding and managing targets
110
57
---------------------------
@@ -121,17 +68,10 @@ To add a target, on the command line, type the following command:
121
68
122
69
where
123
70
124
-
<<<<<<< HEAD
125
71
- `<name>` specifies a unique name for the target.
126
72
- `<ip-address>` specifies the ip address of the BlackBerry device or simulator.
127
73
- `-p|--password <password>` specifies the password for the device or simulator. This is required only if the device or simulator is password protected.
128
74
- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
129
-
=======
130
-
-`<name> `specifies a unique name for the target.
131
-
-`<ip-address> `specifies the ip address of the BlackBerry device or simulator.
132
-
-`-p|--password <password> `specifies the password for the device or simulator. This is required only if the device or simulator is password protected.
133
-
-`--pin <device-pin>` specifies the PIN of the BlackBerry device.
134
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
135
75
136
76
###Remove a target
137
77
@@ -145,12 +85,8 @@ To remove a target, on the command line, type the following command:
145
85
146
86
To specify a specific target as the default, on the command line, type the following command:
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
154
90
```
155
91
156
92
Building your app
@@ -187,17 +123,10 @@ To build your app in release mode, on the command line, type the following comma
187
123
188
124
where
189
125
190
-
<<<<<<< HEAD
191
126
- `<target>` specifies the name of a previously added target. If `<target>` is not specified, the default target is used, if one has been created. This argument is only required if you want the script to deploy your app to a BlackBerry device or simulator and you have not created a default target. Additionally, if `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
192
127
- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
193
128
- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools.
194
129
- `-ll|--loglevel <level>` specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
195
-
=======
196
-
-`<target> `specifies the name of a previously added target. This argument is only required if you want the script to deploy your app to a BlackBerry device or simulator. If `<target> `is a device, then that device must be connected to your computer by USB connection.
197
-
-`-k|--keystorepass <password> `specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
198
-
-`-p|--params <params-JSON-file> `specifies a JSON file containing additional parameters to pass to downstream tools.
199
-
-`-ll|--loglevel <level> `specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
200
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
201
130
202
131
Note that all of these parameters are optional. If you have previously defined a default target (and installed a debug token, if that target is a BlackBerry device), you can run the script with no arguments, and the script will package your app and deploy it to the default target. For example:
203
132
@@ -208,15 +137,9 @@ Note that all of these parameters are optional. If you have previously defined a
208
137
Deploying an app
209
138
-------------------------
210
139
211
-
<<<<<<< HEAD
212
140
You can test your app using either a BlackBerry device or a simulator. Before deploying your app, you must first create a target for the device or simulator you want to deploy your app to.
213
141
214
142
The run script will deploy the most recent build of your app, which may or may not be signed. If you intend to deploy an app to a physical device for testing and you most recently built your app in debug mode, you must first install a debug token on that device. If you specify the `--keystorepass <password>` argument when running the build script, the script will create and install the debug token for you. You do not need a debug token to test your app on a simulator, even if that app is unsigned.
215
-
=======
216
-
You can test an unsigned app using either a BlackBerry device or a simulator. Before deploying your app, you must first create a target for the device or simulator you want to deploy your app to.
217
-
218
-
If you intend to deploy an unsigned app to a physical device for testing, you must first install a debug token on that device. If you specify the `--keystorepass <password>` argument when running the build script, the script will create and install the debug token for you. You do not need a debug token to test your app on a simulator.
219
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
220
143
221
144
To deploy your app to a device or simulator, on a command line type the following command:
222
145
@@ -225,7 +148,6 @@ To deploy your app to a device or simulator, on a command line type the followin
225
148
```
226
149
227
150
where
228
-
<<<<<<< HEAD
229
151
- `<target>` specifies the name of a previously added target. If `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
230
152
231
153
Adding and managing plugins
@@ -271,6 +193,3 @@ To remove a plugin, on the command line, type the following command:
271
193
<path-to-project>/cordova/plugin rm <name>
272
194
```
273
195
274
-
=======
275
-
-`<target> `specifies the name of a previously added target. If `<target> `is a device, than that device must be connected to your computer by USB connection.
276
-
>>>>>>> 31853da... Fixed hyperlinks on getting started and plugin dev guides for bb10
0 commit comments