cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fil...@apache.org
Subject docs commit: CB-1365: overview of config.xml documentation. added stubs for platform-specific project settings.
Date Fri, 01 Feb 2013 00:16:46 GMT
Updated Branches:
  refs/heads/master 3d36159b9 -> 0a0b693c8


CB-1365: overview of config.xml documentation. added stubs for platform-specific project settings.


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0a0b693c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0a0b693c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0a0b693c

Branch: refs/heads/master
Commit: 0a0b693c813fca99db9ae46651deb5824d763285
Parents: 3d36159
Author: Fil Maj <maj.fil@gmail.com>
Authored: Thu Jan 31 16:20:21 2013 -0800
Committer: Fil Maj <maj.fil@gmail.com>
Committed: Thu Jan 31 16:20:21 2013 -0800

----------------------------------------------------------------------
 docs/en/edge/guide/project-settings/bada/index.md  |   24 ++++++++
 .../guide/project-settings/blackberry/index.md     |   24 ++++++++
 .../edge/guide/project-settings/firefoxos/index.md |   24 ++++++++
 docs/en/edge/guide/project-settings/index.md       |   46 +++++++++++++++
 docs/en/edge/guide/project-settings/webos/index.md |   24 ++++++++
 .../edge/guide/project-settings/windows8/index.md  |   24 ++++++++
 docs/en/edge/guide/project-settings/wp7/index.md   |   24 ++++++++
 docs/en/edge/guide/project-settings/wp8/index.md   |   24 ++++++++
 8 files changed, 214 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/bada/index.md b/docs/en/edge/guide/project-settings/bada/index.md
new file mode 100644
index 0000000..f5507d9
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/bada/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for Bada 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/blackberry/index.md b/docs/en/edge/guide/project-settings/blackberry/index.md
new file mode 100644
index 0000000..8563ebe
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/blackberry/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for BlackBerry 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/firefoxos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/firefoxos/index.md b/docs/en/edge/guide/project-settings/firefoxos/index.md
new file mode 100644
index 0000000..89f53b8
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/firefoxos/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for FirefoxOS 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/index.md b/docs/en/edge/guide/project-settings/index.md
index a6e6a9b..5c230bd 100644
--- a/docs/en/edge/guide/project-settings/index.md
+++ b/docs/en/edge/guide/project-settings/index.md
@@ -20,4 +20,50 @@ license: Licensed to the Apache Software Foundation (ASF) under one
 Project Settings
 ================
 
+You can set various application configuration parameters using a platform-agnostic configuration
file, `config.xml`.
+This file is based on the W3C [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/)
specification. 
+
+The location of the `config.xml` file is different depending on the platform. The contents,
in general, are not. 
+
+## Platform-Specific Properties
+
+As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such,
some native and platform-specific
+properties, characterstics and behaviours are encapsulated as much as possible as `<preference>`
elements inside the
+`config.xml` file. The following sub-sections linked to are guides which go into more details
about these preferences.
+
 - Project Settings for iOS
+- Project Settings for Android
+- Project Settings for BlackBerry
+- Project Settings for Windows Phone 7
+- Project Settings for Windows Phone 8
+- Project Settings for Windows 8
+- Project Settings for webOS
+- Project Settings for Bada
+- Project Settings for FirefoxOS
+
+## config.xml Elements
+
+The [Apache Cordova](http://cordova.io) project strives abstract away native platform specifics
via web-inspired and web-based
+abstractions that are heavily standards driven and adopted by the web community. Please take
a few minutes to familiarize
+yourself with the [config.xml specification](http://www.w3.org/TR/widgets/), to understand
the type of application metadata the
+Apache Cordova project aims to abstract and provide simple entry points for.
+
+A list of supported elements across major platforms which are supported in Apache Cordova
follow.
+
+### `<plugin>`
+
+These elements map to native APIs that the application will be able to access. At runtime,
the Apache Cordova framework checks
+the `<plugin>` elements and maps them to native code to enable your Cordova application
to access device APIs otherwise
+unavailable to typical web-based applications.
+
+#### `<plugin>` quirks
+
+- Android supports `<feature>` elements as analogues to `<plugin>`.
+
+### `<access>`
+
+These elements define how your whitelist works. Please see the Domain Whitelist Guide for
more information.  
+
+### `<content>`
+
+This element defines the start page of your application. The default is "index.html". 

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/webos/index.md b/docs/en/edge/guide/project-settings/webos/index.md
new file mode 100644
index 0000000..13101ff
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/webos/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for webOS 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/windows8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/windows8/index.md b/docs/en/edge/guide/project-settings/windows8/index.md
new file mode 100644
index 0000000..6d7a783
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/windows8/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for Windows 8 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/wp7/index.md b/docs/en/edge/guide/project-settings/wp7/index.md
new file mode 100644
index 0000000..9b6e4d9
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/wp7/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for Windows Phone 7 
+===================================
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a0b693c/docs/en/edge/guide/project-settings/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/wp8/index.md b/docs/en/edge/guide/project-settings/wp8/index.md
new file mode 100644
index 0000000..dcf4b50
--- /dev/null
+++ b/docs/en/edge/guide/project-settings/wp8/index.md
@@ -0,0 +1,24 @@
+<!--
+#
+# 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.
+#
+-->
+
+Project Settings for Windows Phone 8
+===================================
+


Mime
View raw message