This is an automated email from the ASF dual-hosted git repository.
erisu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-docs.git
The following commit(s) were added to refs/heads/master by this push:
new b764651bf6 doc: cleanup content for cli 12 (#1312)
b764651bf6 is described below
commit b764651bf621bdecd5f1ec8ae9239d6ffbbd77be
Author: エリス <[email protected]>
AuthorDate: Wed May 24 21:43:40 2023 +0900
doc: cleanup content for cli 12 (#1312)
* docs: remove deprecated osx and windows platfrom
* doc: refactor platform pinning page
* doc(windows): remove customize app icons
* doc(electron|windows): update icon attribute target for Electron usage
* doc(windows): remove events data
* doc(windows): remove hooks example
* doc(windows): remove from create first app
* doc(osx|windows): remove from config.xml
---
www/docs/en/dev/config_ref/images.md | 66 +--
www/docs/en/dev/config_ref/index.md | 57 +--
www/docs/en/dev/cordova/events/events.md | 64 +--
www/docs/en/dev/guide/appdev/hooks/index.md | 7 -
www/docs/en/dev/guide/cli/index.md | 1 -
www/docs/en/dev/guide/platforms/osx/config.md | 87 ----
www/docs/en/dev/guide/platforms/osx/index.md | 146 -------
www/docs/en/dev/guide/platforms/osx/plugin.md | 27 --
www/docs/en/dev/guide/platforms/windows/index.md | 448 ---------------------
www/docs/en/dev/guide/platforms/windows/plugin.md | 209 ----------
www/docs/en/dev/guide/platforms/windows/upgrade.md | 76 ----
www/docs/en/dev/platform_pinning/index.md | 43 +-
12 files changed, 39 insertions(+), 1192 deletions(-)
diff --git a/www/docs/en/dev/config_ref/images.md
b/www/docs/en/dev/config_ref/images.md
index 28ec6860d5..8874f9c5c6 100644
--- a/www/docs/en/dev/config_ref/images.md
+++ b/www/docs/en/dev/config_ref/images.md
@@ -41,8 +41,7 @@ src | *Required* <br/> Location of the image file,
relative to your pr
platform | *Optional* <br/> Target platform
width | *Optional* <br/> Icon width in pixels
height | *Optional* <br/> Icon height in pixels
-target | *Optional* <br/> ==Windows== <br/> Destination filename for
the image file and all its MRT companions
-
+target | *Optional* <br/> ==Electron== <br/> Set target to supply
unique icons for `application` and `installer`
The following configuration can be used to define a single default icon
which will be used for all platforms.
@@ -189,69 +188,6 @@ Icons are not applicable to the Browser platform.
### See Also
- [App Icons on iPad and
iPhone](https://developer.apple.com/library/content/qa/qa1686/_index.html)
-## Windows
-
-For Windows the recommended approach to define application icons is to use the
`target` attribute.
-
-```xml
- <platform name="windows">
- <icon src="res/windows/storelogo.png" target="StoreLogo" />
- <icon src="res/windows/smalllogo.png" target="Square30x30Logo" />
- <icon src="res/windows/Square44x44Logo.png" target="Square44x44Logo" />
- <icon src="res/windows/Square70x70Logo.png" target="Square70x70Logo" />
- <icon src="res/windows/Square71x71Logo.png" target="Square71x71Logo" />
- <icon src="res/windows/Square150x150Logo.png"
target="Square150x150Logo" />
- <icon src="res/windows/Square310x310Logo.png"
target="Square310x310Logo" />
- <icon src="res/windows/Wide310x150Logo.png" target="Wide310x150Logo" />
- </platform>
-```
-
-where `src` is the path to the icon which needs to be added.
-
-The Windows platform handles MRT icons automatically, so if you specify
`src="res/windows/storelogo.png"` the following files will be copied into the
application's `images` folder: `res/windows/storelogo.scale-100.png`,
`res/windows/storelogo.scale-200.png`, etc.
-
-TODO Define what MRT is.
-
-The `target` attribute specifies the base name for the resultant icons. For
every icon file, its destination filename is calculated as `target + '.' +
MRT_qualifiers + extension(src)`. For the icons to display properly in the
application, every `target` value should be one of the icon filenames defined
in the application's `.appxmanifest` file.
-
-Summarizing the above... using the `target` attribute it is possible to:
-
- * define a group of icons for different device scale factors using a single
`<icon ...>` element, for example:
-```xml
- <icon src="res/windows/AppListIcon.png" target="Square44x44Logo" />
-```
- which is equivalent to the following lines:
-```xml
- <icon src="res/windows/Square44x44Logo.scale-100.png" width="44"
height="44" />
- <icon src="res/windows/Square44x44Logo.scale-150.png" width="66"
height="66" />
- <icon src="res/windows/Square44x44Logo.scale-200.png" width="88"
height="88" />
- <icon src="res/windows/Square44x44Logo.scale-240.png" width="106"
height="106" />
-```
- * define icons with scale factors other than `scale-100` and `scale-240`
(and any other MRT qualifiers)
-
-Although it is not recommended, it is also possible to define icons using the
`width` and `height` attributes:
-
-```xml
- <platform name="windows">
- <icon src="res/windows/logo.png" width="150" height="150" />
- <icon src="res/windows/smalllogo.png" width="30" height="30" />
- <icon src="res/windows/storelogo.png" width="50" height="50" />
- <icon src="res/windows/Square44x44Logo.scale-100.png" width="44"
height="44" />
- <icon src="res/windows/Square44x44Logo.scale-240.png" width="106"
height="106" />
- <icon src="res/windows/Square70x70Logo.scale-100.png" width="70"
height="70" />
- <icon src="res/windows/Square71x71Logo.scale-100.png" width="71"
height="71" />
- <icon src="res/windows/Square71x71Logo.scale-240.png" width="170"
height="170" />
- <icon src="res/windows/Square150x150Logo.scale-240.png" width="360"
height="360" />
- <icon src="res/windows/Square310x310Logo.scale-100.png" width="310"
height="310" />
- <icon src="res/windows/Wide310x150Logo.scale-100.png" width="310"
height="150" />
- <icon src="res/windows/Wide310x150Logo.scale-240.png" width="744"
height="360" />
- </platform>
-```
-
-### See Also:
-- [Windows 10 platform guidelines for
icons](https://msdn.microsoft.com/en-us/library/windows/apps/mt412102.aspx).
-- [Windows 8.1 tiles and icons
sizes](https://msdn.microsoft.com/en-us/library/windows/apps/xaml/hh781198.aspx)
-
[splashscreen_plugin]: ../reference/cordova-plugin-splashscreen/
## Electron
diff --git a/www/docs/en/dev/config_ref/index.md
b/www/docs/en/dev/config_ref/index.md
index 7623e26f79..b340f4c8cd 100644
--- a/www/docs/en/dev/config_ref/index.md
+++ b/www/docs/en/dev/config_ref/index.md
@@ -63,12 +63,9 @@ id(string) | *Required* <br/> Specifies the app's
identifier. The `id` should be
version(string) | *Required* <br/> Full version number expressed in
major/minor/patch notation.
android-versionCode(string) <br/> ==Android== | Alternative version for
Android. Sets the [version
code](https://developer.android.com/tools/publishing/versioning.html) for the
application. See [the Android
guide](../guide/platforms/android/index.html#setting-the-version-code) for
information on how this attribute may be modified.
ios-CFBundleVersion(string) <br/> ==iOS== | Alternative version for iOS. For
further details, see [iOS
versioning](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364).
-osx-CFBundleVersion(string) <br/> ==OS X== | Alternative version for OS X. For
further details, see [OS X
versioning](https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364).
-windows-packageVersion(string) <br/> ==Windows== | Alternative version for
Windows. For futher details, see [Windows
versioning](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
android-packageName(string) <br/> ==Android== | Alternative package name for
Android, overrides `id`.
ios-CFBundleIdentifier(string) <br/> ==iOS== | Alternative bundle id for iOS.
Overrides `id`.
-packageName(string) <br/> ==Windows== | *Default: Cordova.Example* <br/>
Package name for Windows.
-defaultlocale <br /> ==iOS== ==Windows== | Specified the default language of
the app, as an IANA language code.
+defaultlocale <br /> ==iOS== | Specified the default language of the app, as
an IANA language code.
android-activityName(string) <br/> ==Android== | Set the activity name for
your app in AndroidManifest.xml. Note that this is only set once after the
Android platform is first added.
xmlns(string) | *Required* <br/> Namespace for the config.xml document.
xmlns:cdv(string) | *Required* <br/> Namespace prefix.
@@ -83,14 +80,6 @@ Examples:
<!-- iOS -->
<widget id="io.cordova.hellocordova" version="0.0.1"
ios-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets";
xmlns:cdv="http://cordova.apache.org/ns/1.0";>
</widget>
-
-<!-- Windows -->
-<widget id="io.cordova.hellocordova" version="0.0.1"
windows-packageVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets";
xmlns:cdv="http://cordova.apache.org/ns/1.0";>
-</widget>
-
-<!-- OS X -->
-<widget id="io.cordova.hellocordova" version="0.0.1"
osx-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets";
xmlns:cdv="http://cordova.apache.org/ns/1.0";>
-</widget>
```
## name
@@ -292,19 +281,16 @@ android-maxSdkVersion(integer) <br/> ==Android== |
*Default: Not Specified* <br/
android-minSdkVersion(integer) <br/> ==Android== | *Default: Dependent on
cordova-android Version* <br/> Sets the `minSdkVersion` attribute of the
`<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]).
android-targetSdkVersion(integer) <br/> ==Android== | *Default: Dependent on
cordova-android Version* <br/> Sets the `targetSdkVersion` attribute of the
`<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]).
AppendUserAgent(string) <br/> ==Android== ==iOS== | If set, the value will
append to the end of old UserAgent of webview. When using with
OverrideUserAgent, this value will be ignored.
-BackgroundColor(string) <br/> ==Android== ==iOS== ==Windows== | Sets the app's
background color. Supports a four-byte hex value, with the first byte
representing the alpha channel, and standard RGB values for the following three
bytes. <br/> For Windows, the alpha channel is ignored. <br/> __Note__:
`transparent` value will set the application tile background to the accent
color on Windows.
+BackgroundColor(string) <br/> ==Android== ==iOS== | Sets the app's background
color. Supports a four-byte hex value, with the first byte representing the
alpha channel, and standard RGB values for the following three bytes.
<br/>__Note__: `transparent` value will set the application tile background to
the accent color on Windows.
BackupWebStorage(string) <br/> ==iOS== | *Default: cloud* <br/> Allowed
values: none, local, cloud. <br/> Set to cloud to allow web storage data to
backup via iCloud. Set to local to allow only local backups via iTunes sync.
Set to none prevent web storage backups.
CordovaWebViewEngine(string) <br/> ==iOS== | *Default: CDVWebViewEngine* <br/>
This sets the WebView engine plugin to be used to render the host app. The
plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here
should match the 'feature' name of the WebView engine plugin that is installed.
This preference usually would be set by the WebView engine plugin that is
installed, automatically.
DefaultVolumeStream(string) <br/> ==Android== | *Default: default* <br/>
Added in cordova-android 3.7.0, This preference sets which volume the hardware
volume buttons link to. By default this is "call" for phones and "media" for
tablets. Set this to "media" to have your app's volume buttons always change
the media volume. Note that when using Cordova's media plugin, the volume
buttons will dynamically change to controlling the media volume when any Media
objects are active.
DisallowOverscroll(boolean) <br/> ==iOS== ==Android== | *Default: false* <br/>
Set to **true** if you don't want the interface to display any feedback when
users scroll past the beginning or end of content. On iOS, overscroll gestures
cause content to bounce back to its original position. on Android, they produce
a more subtle glowing effect along the top or bottom edge of the content. <br/>
EnableViewportScale(boolean) <br/> ==iOS== | *Default: false* <br/> Set to
true to allow a viewport meta tag to either disable or restrict the range of
user scaling, which is enabled by default. Place a viewport such as the
following in the HTML to disable scaling and fit content flexibly within the
rendering WebView: <br/> ```<meta name='viewport' content='width=device-width,
initial-scale=1, user-scalable=no' />```
-EnableWebGL(boolean) <br/> ==OS X== | *Default: false* <br/> **(OS X
4.0.0+)** Set to true to enable WebGL on the web view.
ErrorUrl(URL) <br/> ==Android== | *Default: null* <br/> If set, will display
the referenced page upon an error in the application instead of a dialog with
the title "Application Error".
ErrorUrl(string) <br/> ==iOS== | If set, will display the referenced local
page upon an error in the application.
-ForegroundText(string) <br/> ==Windows== | *Default: "light"* <br/> Works
for Windows 8.1 projects only. Allowed values: "light", "dark". Set to "dark"
if you use the `BackgroundColor="white"` or another light color to avoid
Windows Store submissions errors.
FullScreen(boolean) <br/> ==Android== | *Default: false* <br/> Allows you to
hide the status bar at the top of the screen. <br/> __Note__: Recommended
platform-agnostic way to achieve this is to use the [StatusBar
plugin][statusbar_plugin].
GapBetweenPages(float) <br/> ==iOS== | *Default: 0* <br/> The size of the
gap, in points, between pages.
-HideMousePointer(integer) <br/> ==OS X== | *Default: -1* <br/> **(OS X
4.0.0+)** Sets the timeout for hiding the mouse pointer. Set to 0 for
immediate, set to -1 for never.
GradlePluginGoogleServicesEnabled (boolean) <br/> ==Android== | *Default:
false* <br/> Set to true to enable the Google Services Gradle plugin.
GradlePluginGoogleServicesEnabled (semver) <br/> ==Android== | *Default:
4.2.0* <br/> Set version of Google Services Gradle plugin to be used.
GradlePluginKotlinEnabled (boolean) <br/> ==Android== | *Default: false* <br/>
Set to true to allow Kotlin files to be built.
@@ -319,9 +305,7 @@ LoadingDialog(string) <br/> ==Android== | *Default: null*
<br/> If set, display
LogLevel(string) <br/> ==Android== | *Default: DEBUG* <br/> Allowed values:
ERROR, WARN, INFO, DEBUG, VERBOSE <br/> Sets the minimum log level through
which log messages from your application will be filtered.
MediaPlaybackAllowsAirPlay(boolean) <br/> ==iOS== | *Default: true* <br/> Set
to false to prevent Air Play from being used in this view. Available in default
UIWebView and WKWebView.
MediaPlaybackRequiresUserAction(boolean) <br/> ==iOS== | *Default: false*
<br/> Set to true to prevent HTML5 videos or audios from playing automatically
with the autoplay attribute or via JavaScript.
-Min/Max Version(Regex) <br/> ==Windows== | Allowed values: **/(Microsoft.+?
| Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> Identifies
the ecosystems and their min/max versions the app is compatible with. There are
three parts to each value: the **SDK**, the **version restriction**, and the
**version value**. These preferences are detected by beginning with `Windows`
or `Microsoft` and ending in `-MinVersion` or `-MaxVersionTested`: <ul><li>The
**SDK** defines what spe [...]
Orientation(string) | *Default: default* <br/> Allowed values: default,
landscape, portrait <br/> Allows you to lock orientation and prevent the
interface from rotating in response to changes in orientation. <br/> **NOTE:**
The default value means Cordova will strip the orientation preference entry
from the platform's manifest/configuration file allowing the platform to
fallback to its default behavior. For iOS, to specify both portrait & landscape
mode you would use the platform specifi [...]
-OSXLocalStoragePath(string) <br/> ==OS X== | *Default: `~/Library/Application
Support/{bundle.id}`* <br/> **(OS X 4.0.0+)** Sets the directory for the local
storage path.
OverrideUserAgent(string) <br/> ==Android== ==iOS== | If set, the value will
replace the old UserAgent of webview. It is helpful to identify the request
from app/browser when requesting remote pages. Use with caution, this may cause
compatibility issues with web servers. For most cases, use AppendUserAgent
instead.
PageLength(float) <br/> ==iOS== | *Default: 0* <br/> The size of each page,
in points, in the direction that the pages flow. When PaginationMode is right
to left or left to right, this property represents the width of each page. When
PaginationMode is topToBottom or bottomToTop, this property represents the
height of each page. The default value is 0, which means the layout uses the
size of the viewport to determine the dimensions of the page.
PaginationBreakingMode(string) <br/> ==iOS== | *Default: page* <br/> Allowed
values: page, column <br/> Valid values are page and column.The manner in
which column- or page-breaking occurs. This property determines whether certain
CSS properties regarding column- and page-breaking are honored or ignored. When
this property is set to column, the content respects the CSS properties related
to column-breaking in place of page-breaking.
@@ -330,24 +314,14 @@ PreferredContentMode(string) <br/> ==iOS== | *Default:
auto* <br/> Sets the con
InAppBrowserStatusBarStyle(string) <br/> ==iOS== | *Default: default* <br/>
Set text color style of the StatusBar for InAppBrowser for iOS. Valid values
are: `lightcontent` and `default`.
SetFullscreen(boolean) <br/> ==Android== | *Default: false* <br/> Same as the
Fullscreen parameter in the global configuration of this xml file. This
Android-specific element is deprecated in favor of the global Fullscreen
element, and will be removed in a future version.
ShowTitle(boolean) <br/> ==Android== | *Default: false* <br/> Show the title
at the top of the screen.
-SplashScreenBackgroundColor <br/> ==Windows== | *Default: #464646* <br/> Sets
the splashscreen background color. Supports a CSS color name or a four-byte hex
value, with the first byte representing the alpha channel, and standard RGB
values for the following three bytes. <br/> The alpha channel is ignored
although `transparent` value will cause black/white background color in case of
Dark/Light theme accordingly.
Suppresses3DTouchGesture(boolean) <br/> ==iOS== | *Default: false* <br/> Set
to true to avoid 3D Touch capable iOS devices rendering a magnifying glass
widget when the user applies force while longpressing the webview. Test your
app thoroughly since this disables onclick handlers, but plays nice with
ontouchend. If this setting is true, SuppressesLongPressGesture will
effectively be true as well.
SuppressesIncrementalRendering(boolean) <br/> ==iOS== | *Default: false* <br/>
Set to true to wait until all content has been received before it renders to
the screen.
SuppressesLongPressGesture(boolean) <br/> ==iOS== | *Default: false* <br/>
Set to true to avoid iOS9+ rendering a magnifying glass widget when the user
longpresses the webview. Test your app thoroughly since this may interfere with
text selection capabilities.
SwiftVersion(string) <br/> ==iOS== | *Default: (empty)* <br /> Set to specify
the Swift Version.
TopActivityIndicator(string) <br/> ==iOS== | *Default: gray* <br/> Allowed
values: whiteLarge, white, gray. <br/> <br/> Controls the appearance of the
small spinning icon in the status bar that indicates significant processor
activity.
-uap-target-min-version(string) <br/> ==Windows== | This property sets the
MinTargetVersion for the Windows UAP. If not specified, this is set to the
initial release version 10.0.10240.0 <br/> **Note:** This preference is set in
the jsproj file and not in the appxmanifest file. So users with OS version
lower than this value would not be able to run the app.
UIWebViewDecelerationSpeed(string) <br/> ==iOS== | *Default: normal* <br/>
Allowed values: normal, fast <br/> This property controls the deceleration
speed of momentum scrolling. normal is the default speed for most native apps,
and fast is the default for Mobile Safari.
-WindowSize(string) <br/> ==OS X== | *Default: auto* <br/> **(OS X 4.0.0+)**
Sets the size of the application window. <br/> Accepts the format `WxH` for a
specific width and height or the special values `auto` and `fullscreen`. The
latter will open a borderless window spanning the entire desktop area. Please
note, that this is different from the _normal_ OS X fullscreen mode, which
would never span multiple displays. <br/> **Note**: The global cordova
`fullscreen` preference has no effect [...]
-WindowsDefaultUriPrefix(string) <br/> ==Windows== | Allowed values:
`ms-appx://`, `ms-appx-web://` <br/> Identifies whether you want your app to
target the local context or remote context as its startup URI. When building
for Windows 10, the default is the remote context (`ms-appx-web://`). <br/> In
order to have a local-mode application that is not impacted by Remote Mode
capability restrictions, you must set this preference to `ms-appx://` and not
declare any `<access>` elements with [...]
-WindowsStoreDisplayName(string) <br/> ==Windows== | A friendly name for the
publisher that can be displayed to users.
-WindowsStoreIdentityName(string) <br/> ==Windows== | Identity name used for
Windows store. The identity defines a globally unique identifier for a package.
A package identity is represented as a tuple of attributes of the package. See
the [identity page on the package manifest schema
reference](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
for further details.
-WindowsStorePublisherName(string) <br/> ==Windows== | Publisher Display Name.
-WindowsToastCapable(boolean) <br/> ==Windows== | *Default: false* <br/> A
value of ```true``` indicates that the app is allowed to provide 'toast
notifications'.
deployment-target(string) <br/> ==iOS== | This sets the
IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately translates to the
MinimumOSVersion in the ipa. For more details please refer to Apple's
documentation on Deployment Target Settings
target-device(string) <br/> ==iOS== | *Default: universal* <br/> Allowed
values: handset, tablet, universal <br/> This property maps directly to
TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal
(which is the default) you will need to supply screen shots for both iPhone and
iPad or your app may be rejected.
-windows-phone-target-version(string) <br/> ==Windows== | Sets the version of
Windows Phone for which the package (resulting from ```cordova build```) will
target. If none is specified, it will be set to the same version as
```windows-target-version``` (if found).
-windows-target-version(string) <br/> ==Windows== | Sets the version of Windows
for which the package (resulting from ```cordova build```) will target. If none
is specified, it will be set to '8.1'.
Examples:
@@ -399,23 +373,6 @@ Examples:
<preference name="GradlePluginKotlinEnabled" value="true" />
<preference name="GradlePluginKotlinCodeStyle" value="official" />
<preference name="GradlePluginKotlinVersion" value="1.3.50" />
-
-<!-- Windows only preferences -->
-<preference name="windows-target-version" value="8.1" />
-<preference name="windows-phone-target-version" value="8.1" />
-<preference name="WindowsDefaultUriPrefix" value="ms-appx://" />
-<preference name="Windows.Mobile-MaxVersionTested" value="10.0.10031.0" />
-<preference name="Windows.Universal-MinVersion" value="10.0.0.0" />
-<preference name="WindowsStoreIdentityName"
value="Cordova.Example.ApplicationDataSample" />
-<preference name="WindowsStorePublisherName" value="CN=Contoso Corp, O=Contoso
Corp, L=Redmond, S=Washington, C=US" />
-<preference name="WindowsToastCapable" value="true" />
-<preference name="uap-target-min-version" value="10.0.10586.0" />
-
-<!-- OS X only preferences -->
-<preference name="HideMousePointer" value="5"/>
-<preference name="OSXLocalStoragePath" value="~/.myapp/database"/>
-<preference name="WindowSize" value="800x400"/>
-<preference name="EnableWebGL" value="true"/>
```
## feature
@@ -433,8 +390,8 @@ Used to specify certain plugin parameters such as: what
package to retrieve the
Attributes(type) <br/> <span class="sub-header">Only for platform:</span> |
Description
----------------- | ------------
-name(string) <br/> ==iOS== ==OS X== ==Android== | *Required* <br/> Allowed
values: android-package, ios-package, osx-package, onload. <br/>
'ios-package', 'osx-package' and 'android-package' are used to specify the name
of the package (as specified by the 'value' attribute) to be used to initialize
the plugin code, while 'onload' is used to specify whether the corresponding
plugin (as specified in the 'value' attribute) is to be instantiated when the
controller is initialized.
-value(string or boolean) <br/> ==iOS== ==OS X== ==Android== | *Required* <br/>
Specifies the name of the package to be used to initialize the plugin code
(when the 'name' attribute is android-package, ios-package or osx-package),
specifies the name of the plugin to be loaded during controller initialization
(when 'name' attribute is set to 'onload').
+name(string) <br/> ==iOS== ==Android== | *Required* <br/> Allowed values:
android-package, ios-package, onload. <br/> 'ios-package' and
'android-package' are used to specify the name of the package (as specified by
the 'value' attribute) to be used to initialize the plugin code, while 'onload'
is used to specify whether the corresponding plugin (as specified in the
'value' attribute) is to be instantiated when the controller is initialized.
+value(string or boolean) <br/> ==iOS== ==Android== | *Required* <br/>
Specifies the name of the package to be used to initialize the plugin code
(when the 'name' attribute is android-package or ios-package), specifies the
name of the plugin to be loaded during controller initialization (when 'name'
attribute is set to 'onload').
Examples:
@@ -450,12 +407,6 @@ Examples:
<param name="ios-package" value="CDVDevice" />
<param name="onload" value="true" />
</feature>
-
-<!-- Here's how the element appears for OS X projects -->
-<feature name="Device">
- <param name="osx-package" value="CDVDevice" />
- <param name="onload" value="true" />
-</feature>
```
diff --git a/www/docs/en/dev/cordova/events/events.md
b/www/docs/en/dev/cordova/events/events.md
index 7f4d2451d6..3e1f1bea1b 100644
--- a/www/docs/en/dev/cordova/events/events.md
+++ b/www/docs/en/dev/cordova/events/events.md
@@ -90,7 +90,6 @@ The following table lists the cordova events and the
supported platforms:
<th>Supported Platforms/<br/>Events</th>
<th>android</th>
<th>ios</th>
- <th>Windows</th>
</tr>
</thead>
<tbody>
@@ -98,73 +97,61 @@ The following table lists the cordova events and the
supported platforms:
<th><a href="#deviceready">deviceready</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="win" class="y"></td>
</tr>
<tr>
<th><a href="#pause">pause</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="win" class="y"></td>
</tr>
<tr>
<th><a href="#resume">resume</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="win" class="y"></td>
</tr>
<tr>
<th><a href="#backbutton">backbutton</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="y"></td>
</tr>
<tr>
<th><a href="#menubutton">menubutton</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#searchbutton">searchbutton</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#startcallbutton">startcallbutton</a></th>
<td data-col="android" class="n"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#endcallbutton">endcallbutton</a></th>
<td data-col="android" class="n"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#volumedownbutton">volumedownbutton</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#volumeupbutton">volumeupbutton</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="n"></td>
</tr>
<tr>
<th><a href="#activated">activated</a></th>
<td data-col="android" class="n"></td>
<td data-col="ios" class="n"></td>
- <td data-col="win" class="y"></td>
</tr>
<tr>
<th><a href="#cordovacallbackerror">cordovacallbackerror</a></th>
<td data-col="android" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="win" class="y"></td>
</tr>
</tbody>
</table>
@@ -304,24 +291,6 @@ function onBackKeyDown() {
}
```
-### Windows Quirks
-
-Throw an error in a `backbutton` callback to force the default behavior, which
is an app exit:
-
-```javascript
-document.addEventListener('backbutton', function (evt) {
- if (cordova.platformId !== 'windows') {
- return;
- }
-
- if (window.location.href !== firstPageUrl) {
- window.history.back();
- } else {
- throw new Error('Exit'); // This will suspend the app
- }
-}, false);
-```
-
## menubutton
The event fires when the user presses the menu button. Applying an event
handler
@@ -415,38 +384,7 @@ function onVolumeUpKeyDown() {
## activated
-The event fires when Windows Runtime activation has occurred. See [MSDN
docs][MSDNActivatedEvent] for further details and activation types.
-
-### Quick Example
-
-```javascript
-document.addEventListener("activated", activated, false);
-
-function activated(args) {
- if (args && args.kind ===
Windows.ApplicationModel.Activation.ActivationKind.file) {
- // Using args.raw to get the native StorageFile object
-
Windows.Storage.FileIO.readTextAsync(args.raw.detail[0].files[0]).done(function
(text) {
- console.log(text);
- }, function (err) {
- console.error(err);
- });
- }
-}
-```
-
-### Windows Quirks
-
-* Original activated event args are available in `args.raw.detail[0]` property
and can be used to get a type information or invoke methods of one of the
activation arguments,
-
-* Original activated event args are also cloned to `args.detail[0]` and can be
used as a fallback in case an inner args property has been lost.
-See https://issues.apache.org/jira/browse/CB-10653 for details.
-
-* `activated` event might be fired before `deviceready` so you should save the
activation flag and args to the app context in case you need them - for example
in the [Share target case](https://issues.apache.org/jira/browse/CB-11924).
-The subscription to the `activated` event should be done before `deviceready`
handler (in `app.bindEvents` in terms of the Cordova template).
-
-[UIApplicationExitsOnSuspend]:
https://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html
-[AndroidLifeCycleGuide]:
../../guide/platforms/android/index.html#lifecycle-guide
-[MSDNActivatedEvent]:
https://msdn.microsoft.com/en-us/library/windows/apps/br212679.aspx
+This event is not fired for Cordova.
## cordovacallbackerror
diff --git a/www/docs/en/dev/guide/appdev/hooks/index.md
b/www/docs/en/dev/guide/appdev/hooks/index.md
index 647d627c2d..edcf19b586 100644
--- a/www/docs/en/dev/guide/appdev/hooks/index.md
+++ b/www/docs/en/dev/guide/appdev/hooks/index.md
@@ -201,13 +201,6 @@ Hooks could be defined in project's `config.xml` using
`<hook>` elements, for ex
<hook type="before_plugin_install"
src="scripts/android/appAndroidBeforePluginInstall.js" />
...
</platform>
-
-<platform name="windows">
- <hook type="before_build" src="scripts/windows/appWinBeforeBuild.bat" />
- <hook type="before_build" src="scripts/windows/appWinBeforeBuild.js" />
- <hook type="before_plugin_install"
src="scripts/windows/appWinBeforePluginInstall.js" />
- ...
-</platform>
```
### Plugin hooks (plugin.xml)
diff --git a/www/docs/en/dev/guide/cli/index.md
b/www/docs/en/dev/guide/cli/index.md
index 8ef72bac03..df36bfd6bb 100644
--- a/www/docs/en/dev/guide/cli/index.md
+++ b/www/docs/en/dev/guide/cli/index.md
@@ -141,7 +141,6 @@ Error: Some of requirements check failed
### See Also
- [Android platform
requirements](../../guide/platforms/android/index.html#requirements-and-support)
- [iOS platform
requirements](../../guide/platforms/ios/index.html#requirements-and-support)
-- [Windows platform
requirements](../../guide/platforms/windows/index.html#requirements-and-support)
## Build the App
diff --git a/www/docs/en/dev/guide/platforms/osx/config.md
b/www/docs/en/dev/guide/platforms/osx/config.md
deleted file mode 100644
index 8bc2b1990f..0000000000
--- a/www/docs/en/dev/guide/platforms/osx/config.md
+++ /dev/null
@@ -1,87 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: OS X Configuration
----
-
-# OS X Configuration
-
-The `config.xml` file controls an app's basic settings that apply
-across each application and CordovaWebView instance. This section
-details preferences that only apply to OS X builds. See [The config.xml
-File](../../../config_ref/index.html#The%20config.xml%20File) for information
on global configuration options.
-
-## Overview
-
-| Name | Default | Version | Comment |
-|------|---------|---------|---------|
-| `HideMousePointer` | _disabled_ | 4.0.0 | Sets the timeout for hiding the
mouse pointer |
-| `OSXLocalStoragePath` | `~/Library/Application Support/{bundle.id}`| 4.0.0
| Sets the local storage path |
-| `WindowSize` | `auto`| 4.0.0 | Sets the size of the application window. |
-| `EnableWebGL` | `false`| 4.0.0 | Enables WebGL on the web view. |
-
-
-## Details
-
-### HideMousePointer
-(integer, defaults to _disabled_)
-Idle duration in seconds after which the mouse pointer should be hidden.
-Set it to `0` for immediate.
-
-Example: hide mouse pointer after 5 seconds:
-
-```xml
-<preference name="HideMousePointer" value="5"/>
-```
-
-### OSXLocalStoragePath
-(string, defaults to `~/Library/Application Support/{bundle.id}`)
-Sets the directory for the local storage path.
-
-Example: use custom path:
-
-```xml
-<preference name="OSXLocalStoragePath" value="~/.myapp/database"/>
-```
-
-### WindowSize
-(string, defaults to `auto`)
-Defines the size of the application window in the format `WxH` or the special
values `auto` and
-`fullscreen`. The latter will open a borderless window spanning the entire
desktop area. Please note,
-that this is different from the _normal_ OS X fullscreen mode, which would
never span multiple displays.
-
-Example: set the window size to 800 x 400:
-
-```xml
-<preference name="WindowSize" value="800x400"/>
-```
-
-> **Note**: The global cordova `fullscreen` preference is not supported.
-
-### EnableWebGL
-(boolean, defaults to `false`)
-If set to `true` it enables WebGL on the webview.
-
-Example: enable WebGL
-
-```xml
-<preference name="EnableWebGL" value="true" />
-```
-
-
diff --git a/www/docs/en/dev/guide/platforms/osx/index.md
b/www/docs/en/dev/guide/platforms/osx/index.md
deleted file mode 100644
index 0f97c50637..0000000000
--- a/www/docs/en/dev/guide/platforms/osx/index.md
+++ /dev/null
@@ -1,146 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: OS X Platform Guide
-toc_title: OS X (deprecated)
----
-
-# OS X Platform Guide
-
-**NOTICE:** The OS X platform is now deprecated and may be removed from a
future version of Cordova.
-
-This guide shows how to set up your SDK development environment to
-deploy Cordova apps for OS X computers. See the
-following for more detailed platform-specific information:
-
-* [OS X Configuration](config.html)
-* [OS X Plugins](plugin.html)
-
-The command-line tools above refer to versions prior to Cordova 3.0.
-See [The Command-Line Interface](../../cli/index.html) for information about
the
-current interface.
-
-## Requirements and Support
-
-Apple® tools required to build OS X applications run only on the OS X
-operating system on Intel-based Macs. Xcode® 6.0 (the minimum required
-version) runs only on OS X version 10.9 (Mavericks) or greater, and
-includes the OS X SDK (Software Development Kit). To submit apps to
-the Apple App Store℠ requires the latest versions of the Apple tools.
-
-You can test all of the Cordova features using the XCode or any other
-IDE such as [JetBrain's AppCode](https://www.jetbrains.com/objc/), but
-you need to use XCode to sign before submitting to the
-App Store. To sign the apps, you must also be a member of Apple's
-[OS X Developer Program](https://developer.apple.com/osx/).
-
-## Install the SDK
-
-There are two ways to download Xcode:
-
-* from the [App
Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12),
- available by searching for "Xcode" in the __App Store__ application.
-
-* from [Apple Developer
Downloads](https://developer.apple.com/downloads/index.action),
- which requires registration as an Apple Developer.
-
-Once Xcode is installed, several command-line tools need to be enabled
-for Cordova to run. From the __Xcode__ menu, select __Preferences__,
-then the __Downloads__ tab. From the __Components__ panel, press the
-__Install__ button next to the __Command Line Tools__ listing.
-
-## Create a New Project
-
-Use the `cordova` utility to set up a new project, as described in The
-Cordova [The Command-Line Interface](../../cli/index.html). For example, in a
source-code directory:
-
-```bash
-$ cordova create hello com.example.hello "HelloWorld"
-$ cd hello
-$ cordova platform add osx
-$ cordova prepare # or "cordova build"
-```
-
-## Run the app
-
-To run the app on your desktop:
-
-```bash
-$ cordova run
-```
-
-And you should see a bordered window with the example app:
-
-
-
-You can also use __cordova run --help__ to see additional build and run
-options.
-
-## Open a Project in the SDK
-
-Once osx platform is added to your project, you can open it from
-within Xcode. Double-click to open the
`hello/platforms/osx/HelloWorld.xcodeproj`
-file. The screen should look like this:
-
-
-
-> **TIP**
-> You can also use the `open` command to open the XCode project directly
-> from the command line:
-> ```
-> $ open platforms/osx/HelloWorld.xcodeproj
-> ```
-
-## Common Problems
-
-__Deprecation Warnings__: When an application programming interface
-(API) is changed or replaced by another API, it is marked as
-_deprecated_. The API still works in the near term, but is eventually
-removed. Some of these deprecated interfaces are reflected in Apache
-Cordova, and Xcode issues warnings about them when you build and
-deploy an application.
-
-__Missing Headers__: Compilation errors relating to missing headers
-result from problems with the build location, and can be fixed
-via Xcode preferences:
-
-1. Select __Xcode → Preferences → Locations__.
-
-2. In the __Derived Data__ section, press the __Advanced__ button and
- select __Unique__ as the __Build Location__ as shown here:
-
- 
-
-This is the default setting for a new Xcode install, but it may be set
-differently following an upgrade from an older version of Xcode.
-
-For further information, consult Apple's documentation:
-
-* [Member Center home
page](https://developer.apple.com/membercenter/index.action)
- provides links to several OS X technical resources including
- technical resources, the provisioning portal, distribution guides
- and community forums.
-
-* [Xcode User
Guide](https://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
-
-* The [xcode-select
command](https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html),
- which helps specify the correct version of Xcode if more than one is
installed.
-
-(Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder®
are Trademarks of Apple Inc.)
-
diff --git a/www/docs/en/dev/guide/platforms/osx/plugin.md
b/www/docs/en/dev/guide/platforms/osx/plugin.md
deleted file mode 100644
index d0eddb8404..0000000000
--- a/www/docs/en/dev/guide/platforms/osx/plugin.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: OS X Plugins
----
-
-# OS X Plugins
-
-This section is not written yet.
-Please refer to the [iOS Plugin Guide](../ios/plugin.html) that has many
-similarities to OS X.
diff --git a/www/docs/en/dev/guide/platforms/windows/index.md
b/www/docs/en/dev/guide/platforms/windows/index.md
deleted file mode 100644
index 1a0c0c942f..0000000000
--- a/www/docs/en/dev/guide/platforms/windows/index.md
+++ /dev/null
@@ -1,448 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: Windows Platform Guide
-toc_title: Windows (deprecated)
----
-
-# Windows Platform Guide
-
-**NOTICE:** The Windows platform is now deprecated and may be removed from a
future version of Cordova.
-
-This guide shows how to set up your SDK development environment to build and
deploy Cordova apps Windows 10 (Universal Windows Platform [= UWP], formerly
known as Universal App Platform [= UAP]), Windows 8.1 and Windows Phone 8.1.
It shows how to use either shell tools to generate and build apps, or the
cross-platform Cordova CLI. (See the
[Overview](../../overview/index.html#development-paths) for a comparison of
these development options.) This section also shows how to modify Cordova [...]
-
-Cordova Windows on Windows 8.1 and Windows Phone 8.1 rely on Internet Explorer
11 as their rendering engine, so as a practical matter you can use IE's
powerful debugger to test any web content that doesn't invoke Cordova APIs.
The Windows Phone Developer Blog provides [helpful
guidance](https://blogs.windows.com/buildingapps/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10/#qYPwLJDbYKToOveG.97)
on how to support IE along with comparable WebKit browsers.
-
-## Requirements and Support
-
-To develop apps for Windows 10 you need:
-
-- [Windows] 10 or 8.1
-- [Visual Studio] 2017 or 2015
-
-> ❗ Visual Studio 2019 does not support Cordova-Windows. See
[apache/cordova-windows#327](https://github.com/apache/cordova-windows/issues/327)
-
-To develop apps for Windows 8.1:
-
-- [Windows] 8.1
-- [Visual Studio] 2015 or 2013
-
-> ❗ Windows Phone 8 Emulator requires Windows 8.1 (x64) Professional
edition or higher, and a processor that supports [Client Hyper-V and Second
Level Address Translation
(SLAT)](https://msdn.microsoft.com/en-us/library/windows/apps/ff626524(v=vs.105).aspx#hyperv)
-
-Cordova apps targeting Windows can be developed on a Mac, either by running a
-virtual machine environment or by using Boot Camp to dual-boot a
-Windows partition. Consult these resources to set up the required
-Windows development environment on a Mac:
-
-- [VMWare
Fusion](https://msdn.microsoft.com/en-US/library/windows/apps/jj945426)
-- [Parallels
Desktop](https://msdn.microsoft.com/en-US/library/windows/apps/jj945424)
-- [Boot Camp](https://msdn.microsoft.com/en-US/library/windows/apps/jj945423)
-
-## Installing the Requirements
-
-Install any edition of [Visual Studio](https://www.visualstudio.com/downloads)
matching the version
-requirements listed above.
-
-### Visual Studio 2017
-
-You also need to install the Workload "Universal Windows Platform development"
and the "Windows 10 SDK (10.0.10240.0)" as individual component.
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/vs17_workload.png" /></p><br/>
-
-See [here if you get error messages regarding `MSBuild
v4.0`](#visual-studio-2017-and-msbuild-v40-is-not-supported-aborting).
-
-### Visual Studio 2015
-
-The tools and SDKs for the target Windows platforms (UWP, 8.1, etc.) must also
be selected in the installer. They can be found under the "Windows and Web
Development" heading.
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_installTools.png" /></p><br/>
-
-## Project Configuration
-
-After installation, you should be ready to develop apps targetting Windows
platform. Refer to [Create your first app](../../cli/index.html) guide for
details.
-
-### Target Windows version
-
-By default the `cordova build` command produces one package for Windows 10.
-
-App compatibility is determined by the OS that the app targeted. Apps are
forwardly-compatible but not backwardly-compatible, so an app targeting Windows
10 cannot run on 8.1, but an app built for 8.1 can run on 10.
-
-#### Target version configuration
-
-If you want to build Windows 8.1 and Windows Phone 8.1 packages by default,
you have to target `8.1` and the following configuration setting must be added
to configuration file (`config.xml`).
-
-```xml
-<preference name="windows-target-version" value="8.1" />
-```
-
-Once you add this setting, the `build` command will start producing Windows
8.1 and Windows Phone 8.1 packages.
-
-#### Overriding configuration with the --appx parameter
-
-You may decide that you want to build a particular version of your application
targeting a particular OS (for example, you might have set that you want to
target Windows 10, but you want to build for Windows Phone 8.1). To do this,
you can use the `--appx` parameter:
-
-```
-cordova build windows -- --appx=8.1-phone
-```
-
-The build system will ignore the preference set in `config.xml` for the target
Windows version and strictly build a package for Windows Phone 8.1.
-
-Valid values for the `--appx` flag are `8.1-win`, `8.1-phone`, and `uwp` or
`uap` (for Windows 10 Universal Apps / Universal Windows Apps). These options
also apply to the `cordova run` command.
-
-#### Considerations for target Windows version
-
-Windows 10 supports a new "Remote" mode for Cordova apps (and HTML apps in
general). This mode enables
-apps to have much more freedom with respect to use of DOM manipulation and
common web patterns such as the use
-of inline script, but does so by reducing the set of capabilities your app may
use when
-submitted to the public Windows Store. For more information about Windows 10
and Remote Mode, look at
-the [Understanding Remote Mode vs Local
Mode](#understanding-remote-mode-vs-local-mode) section.
-
-When using Remote Mode, developers are encouraged to apply a Content Security
Policy (CSP) to their application
-to prevent script injection attacks.
-
-### Deploy options
-
-To deploy Windows package:
-
-```
-cordova run windows
-```
-
-This command will give you the list of all available targets:
-
-```
-cordova run windows --list
-```
-
-This allows you to run the application on a specific device or emulator, in
this case "Emulator 8.1 720p 4.7 inch"
-
-```
-cordova run windows --target="Emulator 8.1 720P 4.7 inch" -- --phone
-```
-
-#### Architecture option
-
-- `--archs`
-- Specific chip architectures (`anycpu`, `arm`, `x86`, `x64`)
-
-#### Bundle option
-
-- `--bundle`
-- Generates an .appxbundle. Not valid if anycpu AND chip-specific
architectures are used (at the same time)
-
-You can also use __cordova run --help__ to see additional build and run
options.
-
-#### Deploy options when targetting Windows (Phone) 8.1
-
-With Windows (Phone) 8.1 packages you have more options for deployment.
-
-##### `--phone` and `--win`
-
-To deploy Windows 8.1 package:
-
-```
-cordova run windows -- --win # explicitly specify Windows as deployment target
-```
-
-To deploy Windows Phone 8.1 package:
-
-```
-cordova run windows -- --phone # deploy app to Windows Phone 8.1 emulator
-cordova run windows --device -- --phone # deploy app to connected device
-```
-
-##### `--win10tools`
-
-- `--win10tools`
-- Uses Windows 10 deployment tools (used for a Windows 8.1 app when) being
deployed to a Windows 10 device
-
-### Using Visual Studio to deploy the app
-
-Once you build a Cordova app, you can open it with Visual Studio. The various
`build` commands generate a Visual Studio
-Solution (_.sln_) file. Open the file in the File Explorer to modify the
project within Visual Studio:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_openSLN.png" /></p><br/>
-
-The `CordovaApp` component displays within the solution, and its `www`
directory contains the web-based source code, including the `index.html` home
page:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk.png" /></p><br/>
-
-The projects for different Windows versions are displayed separately in the
solution explorer. You can choose the deploy target version by right clicking
the 'solution' (topmost entry in the solution explorer) and then going into
'Properties'. Here you can update the 'Single start up' field. The controls
below Visual Studio's main menu allow you to test or deploy the app:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_deploy.png" /></p><br/>
-
-With __Local Machine__ selected, press the green arrow to install the app on
the same machine running Visual Studio. Once you do so, the app appears in
Windows' app listings:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_runApp.png" /></p><br/>
-
-Each time you rebuild the app, the version available in the interface is
refreshed.
-
-Once available in the app listings, holding down the __CTRL__ key while
selecting the app allows you to pin it to the main screen:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_runHome.png" /></p><br/>
-
-Note that if you open the app within a virtual machine environment, you may
need to click in the corners or along the sides of the windows to switch apps
or access additional functionality:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_run.png" /></p><br/>
-
-Alternately, choose the __Simulator__ deployment option to view the app as if
it were running on a tablet device:
-
-<br/><p align="center"><img src="{{ site.baseurl
}}/static/img/guide/platforms/windows/win8_sdk_sim.png" /></p><br/>
-
-Unlike desktop deployment, this option allows you to simulate the tablet's
orientation, location, and vary its network settings.
-
-__NOTE__: Consult the [Overview](../../overview/index.html) for advice on how
to use Cordova's
-command-line tools or the SDK in your workflow. The Cordova CLI relies
-on cross-platform source code that routinely overwrites the
-platform-specific files used by the SDK. If you want to use the SDK to
-modify the project, use the lower-level shell tools as an alternative
-to the CLI.
-
-## Debugging
-
-Visual Studio provides powerful tools to debug your application. You can refer
to [this article](https://msdn.microsoft.com/en-us/library/7seh8d72.aspx) to
get started with it.
-
-**Note:** Resume and pause events are not triggered normally when debugging
apps using Visual Studio. This is because Windows does not suspend your app
when it is being debugged. The only way to change the application state is
through the 'Lifecycle event' options inside Visual Studio. The events should
work as expected when the app is run on a device/emulator without the debugger
attached.
-
-## Signing an App
-
-You can learn more about signing and packaging of Windows Store Apps on
[MSDN][1].
-
-To be able to correctly package and sign Windows apps there are few things
required:
-
-- A signing certificate
-- Identity details matching the provided signing certificate
-
-In Windows project, identity details are kept in a file named
`package.appxmanifest`. This file is automatically populated every time a
Cordova app is built. Identity holds 3 important fields.
-
-- Name
-- Publisher
-- Version
-
-*Name* and *Version* can be set from `config.xml`. *Publisher* can be provided
as a build parameter or can be set on `build.json` file.
-
-
-
-*Name* and *Version* can also be set as platform-specific preferences in
**config.xml** in the following way:
-
-```xml
-<widget windows-packageVersion="2.0.0" ...> <!-- windows-packageVersion
overrides version -->
-<preference name="WindowsStoreIdentityName" value="12345FakeCorp.CoolApp"/>
<!-- WindowsStoreIdentityName overrides widget.id -->
-```
-
-*PublisherDisplayName* and *DisplayName* can also be overriden:
-
-```xml
-<preference name="WindowsStorePublisherName" value="FakeCorp"/> <!--
WindowsStorePublisherName overrides author -->
-<preference name="WindowsStoreDisplayName" value="CoolApp"/> <!--
WindowsStorePublisherName overrides name -->
-```
-
-A signing certificate can be provided from either CLI or through `build.json`
file. The certificate related CLI flags are:
-
-| Parameter | Flag | Description
-|-----------------------|-------------------|-----------------------------------
-| Certificate File | `--packageCertificateKeyFile` | Path to the
package signing certificate to be associated with the app
-| Thumb Print | `--packageThumbprint` | Used to
validate the authenticity of package certificate key file. When creating a
certificate key file, this value will be provided to the end user
-
-Example:
-```
-cordova build --
--packageCertificateKeyFile="platforms\windows\CordovaApp_TemporaryKey.pfx"
--packageThumbprint="ABCABCABCABC123123123123"
-```
-
-Alternatively, these values could be specified using a build configuration
file (`build.json`) using CLI (`--buildConfig`). A sample build configuration
file:
-
-```json
-{
- "windows": {
- "debug": {
- "packageCertificateKeyFile":
"platforms\\windows\\CordovaApp_TemporaryKey.pfx"
- },
- "release": {
- "packageCertificateKeyFile": "c:\\path-to-key\\keycert.pfx",
- "packageThumbprint": "ABCABCABCABC123123123123",
- "publisherId": "CN=FakeCorp.com, L=Redmond, S=Washington, C=US"
- }
- }
-}
-```
-
-There is also support to mix and match command line arguments and parameters
in `build.json` file. Values from the command line arguments will get
precedence.
-
-### Creating a certificate key
-
-Signing is required for distributing and installing Windows Store apps. This
process is normally handled by Visual Studio when you deploy a package for
release. To do this without Visual Studio we need to create our own
certificates. [This
article](https://msdn.microsoft.com/en-us/library/windows/desktop/jj835832(v=vs.85).aspx)
has instructions on how to do that.
-
-Once you have the `.pfx` file created and provided to `build.json` file, you
might get the following error: "The key file may be password protected. To
correct this, try to import the certificate manually into the current user's
personal certificate store.". In order to import it you have to use
[certutil][2] from an admin prompt:
-
-`certutil -user -p PASSWORD -importPFX FakeCorp.com.pfx`
-
-Where:
-
-- user : Specifies "current user" personal store
-- p : Password for pfx file
-- importPFX : Name of pfx file
-
-Once installed, next step is to add packageThumbprint and
packageCertificateKeyFile to build.json. In order to find the
packageThumbprint, search for the CommonName you've associated with the
certificate:
-
-```powershell
-powershell -Command " & {dir -path cert:\CurrentUser\My | where { $_.Subject
-like \"*FakeCorp.com*\" }}"
-```
-
-Once these final values are provided. Cordova should successfully package and
sign the app.
-
-## MSBuild build flags
-
-Similar to other platforms ([`--gradleArg` on
Android](../android/index.html#setting-gradle-properties), [`--buildFlag` on
iOS](../ios/index.html#xcode-build-flags)) you can pass custom flags to
MSBuild. To do this you have two options:
-
-- add one or more `--buildFlag` options to `cordova build windows` or `cordova
run windows` commands:
-
- ```
- cordova build windows -- --buildFlag /clp:Verbosity=normal --buildFlag
/p:myCustomProperty=Value
- cordova run windows -- --buildFlag /clp:Verbosity=minimal
- ```
-
-- add `buildFlag` option to `build.json` file:
-
- ```json
- {
- "windows": {
- "debug": {
- "buildFlag": [
- "/clp:Verbosity=normal",
- "/p:myCustomProperty=Value"
- ]
- }
- }
- }
- ```
-
-
-Note that `cordova-windows` appends build flags from `build.json` and CLI
arguments in specific order. In particular, flags from `build.json` are being
appended _before_ build flags from CLI, which basically means that CLI flags
_override_ ones from `build.json` in case of any conflicts.
-
-For the list of MSBuild's available command-line options please refer to
[official MSBuild command-line
reference](https://msdn.microsoft.com/library/ms164311.aspx).
-
-## Platform Centered Workflow
-
-If you want to use Cordova's Windows-centered shell tools in conjunction with
the SDK, you have two basic options:
-
-- Access them locally from project code generated by the CLI. They are
- available in the `platforms/windows/` directory after you add
- the `windows` platform as described below.
-
-- Download them from a separate distribution
- [here](https://www.apache.org/dist/cordova/platforms/).
- The Cordova distribution contains separate archives for each platform.
- Be sure to expand the appropriate archive, `cordova-windows` in
- this case, within an empty directory. The relevant batch utilities
- are available in `package/bin` directory. (Consult the
- __README__ file if necessary for more detailed directions.)
-
-These shell tools allow you to create, build, and run Windows apps. Each
cordova command corresponds to one of these shell tool scripts.
-
-For example, the lower-level shell-tool approach corresponding to `cordova
create HelloWorld` is:
-
-```
-C:\path\to\cordova-windows\package\bin\create.bat C:\path\to\new\hello
HelloWorld
-```
-
-Similarly for `cordova build --debug`:
-
-```
-C:\path\to\project\cordova\build.bat --debug
-```
-
-## Upgrading
-
-Refer to [this](upgrade.html) article for instructions to upgrade your
`cordova-windows` version.
-
-## Supporting Toasts
-
-Windows requires an app manifest capability declaration in order to support
-toast notifications. When using the `cordova-plugin-local-notifications`
-plugin, or any other plugin that is attempting to use toast notifications,
-add the following preference to your config.xml to enable it to publish
-toast notifications, unless the plugin makes that change on it's own:
-
-```xml
-<preference name="WindowsToastCapable" value="true" />
-```
-
-This preference sets the corresponding flag in your app manifest. Plugins
-should do the work necessary to configure the appearance of the
-displayed notifications.
-
-## Understanding Remote Mode vs Local Mode
-
-Windows 10 introduces a new feature called "Remote mode" for HTML
applications. Prior to it, Windows 8.1 apps
-worked on what is now termed as "Local Mode" in Windows 10, in which HTML
Applications have full access to the native
-Windows API surface and capabilities. Local Mode disallows inline script in
order to prevent script injection attacks,
-which could result in leaking personally-identifiable information due to
malicious code. It also requires developers who
-perform DOM manipulation to do so within an explicit context
-(`MSApp.execUnsafeLocalFunction`).
-
-Remote Mode eliminates those requirements, which makes it possible to use
unmodified libraries like jQuery
-or AngularJS directly in your code, without any changes. To do so, it removes
your ability to declare certain
-capabilities when certifying your app in the Windows Store. The removal of
these capabilities usually doesn't
-prevent accessing certain functionality, but it might require the use of a
different combination of APIs or tactics.
-
-### Effect of Remote Mode on capabilities
-
-The following capabilities are unavailable when deploying your Remote Mode
application to the Windows Store:
-
-- Enterprise Authentication (`enterpriseAuthentication`)
-- Shared User Certificates (`sharedUserCertificates`)
-- Documents Library (`documentsLibrary`)
-- Music Library (`musicLibrary`)
-- Pictures Library (`picturesLibrary`)
-- Videos Library (`videosLibrary`)
-- Removable [Storage](../../../cordova/storage/storage.html)
(`removableStorage`)
-- Internet client/server (`internetClientServer`) - note that `internetClient`
is still permitted
-- Private network client/server (`privateNetworkClientServer`)
-
-Each of the library restrictions may be worked around by requesting that the
user interact with the file system via a [File
Picker](https://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.pickers.fileopenpicker.aspx).
This prevents malicious injected code from arbitrarily accessing the file
system.
-
-The network-related restrictions must be worked around by either using an API
that doesn't use capability checks or by brokering communication via standard
internet communication channels, such as `XMLHttpRequest` or Web Sockets.
-
-The Enterprise Authentication and Shared User Certificates capabilities are
specifically targeted at Enterprise scenarios. These capabilities are
supported for private/enterprise-enabled App Stores, so if you are building
apps which are going to be deployed to an internal deployment mechanism, you
can still support these. However, they are not supported for Remote Mode apps
in the public Windows Store. When you build targeting Windows 10, if one of
these capabilities is detected in yo [...]
-
-### Scrolling in Local Mode
-
-While scrolling of the WebView is enabled by default in "Remote mode" and on
the other platforms, in "Local Mode" this is not the case. If scrolling is
required in "Local Mode", it can be enabled using the CSS `overflow` property.
-
-
-## Common Problems and Workarounds
-
-### Visual Studio 2017 and `MSBuild v4.0 is not supported, aborting.`
-
-The support for Visual Studio 2017 in Cordova Windows unfortunately is not
very stable and Cordova Windows sometime can not find MSBuild, Visual Studio's
command line build tools. If this affects you, when trying to build a Cordova
Windows project you will get an error message simlar to this:
-
-```
-MSBuild v4.0 is not supported, aborting.
-```
-
-To work around this problem, we implemented two environment variables that you
can set to tell Cordova Windows where to look.
-- The first is `VSINSTALLDIR `and should be set to the installation directory
of your Visual Studio (e.g. `C:\Program Files (x86)\Microsoft Visual
Studio\2017\Community`).
-- If this doesn't work, the second one is called `MSBUILDDIR` and describes
the path of your MSBuild `bin` directory (which is most often found at
`C:\Program Files (x86)\Microsoft Visual
Studio\2017\Community\MSBuild\15.0\Bin`).
-
-You can either set the environment variable on demand manually by executing
`set KEY=VALUE` (e.g. `set MSBUILDDIR=C:\Program Files (x86)\Microsoft Visual
Studio\2017\Community\MSBuild\15.0\Bin`) or [set it permanently via the "System
Properties"](https://www.computerhope.com/issues/ch000549.htm).
-
-[1]: https://msdn.microsoft.com/en-us/library/hh446593(v=vs.85).aspx
-[2]: https://technet.microsoft.com/en-us/library/ee624045(v=ws.10).aspx
-[Visual Studio]: https://visualstudio.microsoft.com/vs/older-downloads/
-[Windows]: https://www.microsoft.com/windows
diff --git a/www/docs/en/dev/guide/platforms/windows/plugin.md
b/www/docs/en/dev/guide/platforms/windows/plugin.md
deleted file mode 100644
index 6793a08eef..0000000000
--- a/www/docs/en/dev/guide/platforms/windows/plugin.md
+++ /dev/null
@@ -1,209 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: Windows Plugins
-toc_title: Windows
----
-
-# Windows Plugins
-
-This section provides details for how to implement a plugin for use in
-a Windows Store app for Windows 8.1 phone and desktop, and Universal Windows
Platform (Windows 10+). Before reading this, see [Create your first
plugin](../../hybrid/plugins/index.html) for an overview of the plugin's
structure and its common JavaScript interface. This section continues to
demonstrate the sample _echo_ plugin that communicates from the Cordova webview
to the native platform and back.
-
-## Creating a Windows Plugin in JavaScript
-
-Windows Cordova plugins are essentially a thin wrapper around existing WinJS
provided functions, but assuming you will want to define your JS common
interface for multiple devices, you will typically have one JS file that
provides the API:
-
-```js
-// inside file www/echoplugin.js
-var EchoPlugin = {
- // the echo function calls successCallback with the provided text in
strInput
- // if strInput is empty, it will call the errorCallback
- echo:function(successCallback, errorCallback, strInput) {
-
cordova.exec(successCallback,errorCallback,"EchoPlugin","echo",[strInput]);
- }
-}
-```
-
-The `cordova.exec` function is defined differently on every platform, this is
because each platform has it's own way of communicating between the application
js code, and the native wrapper code. But in the case of Windows, there is no
native wrapper, so the exec call is there for consistency. So even though you
could write the Windows specific code as a part of plugin's common JS code
directly, this is not recommended and plugin authors should use the same exec
API for Windows as for ot [...]
-
-### Plugin Exec Proxy
-
-On Windows, Cordova provides a proxy that you can use to register an object
that will handle all `cordova.exec` calls to an API. So in our case, we will
assume that the code in `echoplugin.js` is handling cross platform relevant
JavaScript, and we can simply write a proxy for Windows.
-
-```js
-// in file www/echoplugin.js
-window.echo = function(str, callback) {
- cordova.exec(callback, function(err) {
- callback('Nothing to echo.');
- }, "Echo", "echo", [str]);
-};
-```
-
-```js
-// in file src/windows/echopluginProxy.js
-cordova.commandProxy.add("Echo",{
- echo:function(successCallback,errorCallback,strInput) {
- if(!strInput || !strInput.length) {
- errorCallback("Error, something was wrong with the input string.
=>" + strInput);
- }
- else {
- successCallback(strInput + "echo");
- }
- }
-});
-
-// or alternative syntax
-
-module.exports = {
- echo: function(successCallback, errorCallback, strInput) {
- if(!strInput || !strInput.length) {
- errorCallback("Error, something was wrong with the input string.
=>" + strInput);
- }
- else {
- successCallback(strInput + "echo");
- }
- }
-};
-
-require('cordova/exec/proxy').add('Echo', module.exports);
-```
-
-The `www/echoplugin.js` file will forward the `echo` function call to this
proxy through the `cordova.exec` command and execute this implementation in
`src/windows/echopluginProxy.js`.
-
-The `plugin.xml` file will have the settings required for our plugin. In this
case, we want to add our `echoplugin.js` file in the `www` directory and the
`echopluginProxy.js` file inside the `windows` source code of our application.
Details of these elements can be found in the
[Plugin.xml](../../../plugin_ref/spec.html) reference.
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0";
- id="echoplugin"
- version="0.1.0">
-
- <js-module src="www/echoplugin.js" name="echoplugin">
- <clobbers target="window.echoplugin" />
- </js-module>
-
- <!-- windows -->
- <platform name="windows">
- <js-module src="src/windows/echopluginProxy.js" name="EchoProxy">
- <merges target="" />
- </js-module>
- </platform>
-
- <!-- other platforms -->
-
-</plugin>
-```
-
-
-This gives us a working Windows JavaScript plugin that uses a common file
(`www/echoplugin.js`) and uses a proxy to provide the Windows only portion of
implementation (`src/windows/echopluginProxy.js`). So how do we add
native/managed code to this? Well we are going to start the same, the only
difference will be what we do inside in echopluginProxy methods.
-
-## Creating a Windows Plugin in C++ or managed code.
-
-In Windows, Javascript authored apps are able to interop with native (C++) and
managed code (C#, VB) by creating a Windows runtime component. You can learn
the basics here and checkout more details in guides on MSDN:
-- [Creating Windows Runtime Components in C# and Visual
Basic](https://msdn.microsoft.com/en-us/library/windows/apps/br230301.aspx)
-- [Creating Windows Runtime Components in
C++](https://msdn.microsoft.com/en-us/library/windows/apps/hh441569.aspx)
-
-When you create your Windows Runtime Component, any class that is defined as
`public ref class sealed` is considered an 'activatable class' and will be
callable from JavaScript.
-
-```cpp
-// in your header file .h
-namespace EchoRuntimeComponent
-{
- public ref class EchoPluginRT sealed
- {
- public:
- static Platform::String^ Echo(Platform::String^ input);
- }
-}
-
-// in the implementation file .cpp
-using namespace EchoRuntimeComponent;
-using namespace Platform;
-
-Platform::String^ EchoPluginRT::Echo(Platform::String^ input)
-{
- if(input->IsEmpty())
- {
- return "Error: input string is empty.";
- }
- else
- {
- return input->ToString() + "echo";
- }
-}
-```
-
-Now in order for us to call the native code, we use the namespace, classname,
and lowerCamelCase the method we are calling.
-
-```js
-var res = EchoRuntimeComponent.EchoPluginRT.echo("boom");
-```
-
-Moving this to our echopluginProxy.js file, we get:
-
-```js
-// in file echopluginProxy.js
-cordova.commandProxy.add("EchoPlugin",{
- echo:function(successCallback, errorCallback, strInput) {
- var res = EchoRuntimeComponent.EchoPluginRT.echo(strInput);
- if(res.indexOf("Error") == 0) {
- errorCallback(res);
- }
- else {
- successCallback(res);
- }
- }
-});
-```
-
-And that's it, we have an end to end C++ backed js callable plugin for use in
Apache Cordova Windows!
-
-### Considerations
-
-- The callback is typically async, so calling the callback right away is
probably not expected by the caller. In practice, if the call is not async, you
should at least use a javascript timeout to force the callback to be called
asynchronously.
-- Activatable classes can be used to do event dispatching, async callbacks,
passing your own object types, arrays, collections, overloaded methods and much
more. Refer to [Creating Windows Runtime Components in
C++](https://msdn.microsoft.com/en-us/library/windows/apps/hh441569.aspx) for
details.
-
-### Defining your plugin in plugin.xml
-
-Now that we have a working plugin, we need to revisit the plugin definition
from earlier so we can publish it. We can now add the runtime component as a
framework, through the `<framework>` tag inside our platfrom settings. Note
that the output type of a WindowsRuntimeComponent can be either .winmd or .dll
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0";
- id="echoplugin"
- version="0.2.0">
-
- <js-module src="www/echoplugin.js" name="echoplugin">
- <clobbers target="window.echoplugin" />
- </js-module>
-
- <!-- windows -->
- <platform name="windows">
- <js-module src="src/windows/echopluginProxy.js" name="EchoProxy">
- <merges target="" />
- </js-module>
- <framework src="src/windows/EchoRuntimeComponent.winmd" custom="true"/>
- </platform>
-
- <!-- other platforms -->
-</plugin>
-```
-
-That's it, you now have a distributable plugin that you can share with the
world!
diff --git a/www/docs/en/dev/guide/platforms/windows/upgrade.md
b/www/docs/en/dev/guide/platforms/windows/upgrade.md
deleted file mode 100644
index 6afb707465..0000000000
--- a/www/docs/en/dev/guide/platforms/windows/upgrade.md
+++ /dev/null
@@ -1,76 +0,0 @@
----
-license: >
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-title: Upgrading Windows
----
-
-# Upgrading Windows
-
-For upgrading from `windows` version 4.0.0 or higher, run `cordova platform
update windows`.
-
-For projects not created with the cordova CLI, run:
-
-```
-bin\update <project_path>
-```
-
-# Upgrading Windows 8
-
-This is for people still using `windows8` platform to upgrade from older
versions of Cordova.
-Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See [The
Command-Line Interface](../../cli/index.html) for information how to update the
-version of the CLI.
-
-## Upgrade to 4.0.0 from 3.1.0 or later
-
-For projects that were created with the cordova CLI:
-
-1. Update the `cordova` CLI version. See [The Command-Line
Interface](../../cli/index.html).
-
-2. Run `cordova platform update windows8`.
-
-For projects not created with the cordova CLI, run:
-
-```
-bin\update <project_path>
-````
-
-## Upgrade to 3.1.0
-
-Cordova CLI support for Windows 8 was introduced in Cordova 3.1.0. To upgrade,
we suggest creating a new Cordova CLI project and moving over all necessary
assets.
-
-## Upgrade to 2.9.0 from 2.8.0
-
-The following commands should be done from within Visual Studio to be sure
that the any project references are updated/deleted.
-
-1. Remove `cordova-2.8.0.js` from the project's `www` directory.
-
-2. Add `cordova.js` file from the source to the project's `www` directory.
(Note that the file no longer contains a version number in the filename.)
-
-3. Build and test!
-
-## Upgrade to 2.8.0 from 2.7.0
-
-The following commands should be done from within Visual Studio to be sure
that the any project references are updated/deleted.
-
-1. Remove `cordova-2.7.0.js` from the project's `www` directory.
-
-2. Add `cordova.js` file from the source to the project's `www` directory.
(Note that the file no longer contains a version number in the filename.)
-
-3. Build and test!
diff --git a/www/docs/en/dev/platform_pinning/index.md
b/www/docs/en/dev/platform_pinning/index.md
index 21529b116e..5b403330d7 100644
--- a/www/docs/en/dev/platform_pinning/index.md
+++ b/www/docs/en/dev/platform_pinning/index.md
@@ -24,25 +24,48 @@ description: Cordova CLI pinned platform versions.
## Platform Pinning
-Cordova CLI manages a list of pinned Apache Cordova maintained platforms. When
there is a major release of Cordova CLI, the platform's pinned version is
updated to the latest released version. Typically, the updating of this pin is
made only on a major release of CLI. This is because the pinned versions are
pinned with a caret `^` allowing CLI to continue to fetch new minor and patch
releases of any given pinned platform.
+### Cordova CLI 12.x & Higher
-To see the pinned platforms for your CLI version, execute the command `cordova
platform list` in a brand new project directory.
+Starting from Cordova CLI 12.0.0, the CLI no longer maintains a list of pinned
Apache Cordova platforms.
-**Cordova CLI 9.x:**
+When you run the `cordova platform add <PLATFORM>` command, it will always
fetch the latest available platform from the npm registry. This ensures
immediate access to newly released platforms.
+
+If you want to consistently fetch a specific version, you need to modify the
command and include the version pinning. For example, use `cordova platform add
<PLATFORM>@<VERSION>`.
+
+The `cordova platform list` command displays the list of platforms without
their versions. However, it will continue to show the versions of the installed
platforms.
+
+**Example Output:**
+
+```bash
+$ cordova platform list
+Installed platforms:
+ android 12.0.0
+Available platforms:
+ browser
+ electron
+ ios
+```
+
+### Cordova CLI 11.x & Lower
+
+Cordova CLI 11.x and lower versions still use platform pinning but won't
receive further updates since Cordova CLI 12.0.0 has been released. Platforms
are pinned with a `^` symbol, allowing the CLI to fetch new minor and patch
releases for the pinned platforms.
+
+To view the pinned platforms for your CLI version, run the command `cordova
platform list` in a new project directory.
+
+**Example Output:**
```bash
$ cordova platform list
Installed platforms:
Available platforms:
- android ^8.0.0
+ android ^10.1.1
browser ^6.0.0
- electron ^1.0.0
- ios ^5.0.0
- osx ^5.0.0
- windows ^7.0.0
+ electron ^3.0.0
+ ios ^6.2.0
+ osx ^6.0.0 (deprecated)
```
-Using the above information, when `cordova platform add android` is executed,
the latest minor/patch release version starting from 8.0.0 or after (8.x.x)
will be fetched. If a version is provided, it will fetch the given version. E.g
`cordova platform add [email protected]` will fetch Cordova iOS 5.0.1.
+Based on the above information, executing `cordova platform add android` will
fetch the latest minor/patch release version starting from 10.1.1 or higher. If
you specify a version, it will fetch the specified version. For example,
`cordova platform add [email protected]` will fetch Cordova iOS 5.0.1.
-_Note: When a platform is installed, the "**Installed platforms:**" section
will display the actual installed platform version. The installed platform will
no longer display in the "**Available platforms:**" section until it is removed
from the project._
+_Note: After installing a platform, the "**Installed platforms:**" section
will display the actual installed platform version. The installed platform will
no longer appear in the "**Available platforms:**" section until it is removed
from the project._
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
