You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2012/05/18 20:20:48 UTC
[1/2] docs commit: Add White List Guide to home page.
Updated Branches:
refs/heads/master 6ed613410 -> 12330b99c
Add White List Guide to home page.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/12330b99
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/12330b99
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/12330b99
Branch: refs/heads/master
Commit: 12330b99cafbeb8bc2bf61085dbca436076ffd57
Parents: 8ee2457
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Fri May 18 11:20:41 2012 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri May 18 11:20:41 2012 -0700
----------------------------------------------------------------------
docs/en/edge/guide/white-list/index.md | 66 +++++++++++++++++++++++++++
docs/en/edge/guide/whitelist/index.md | 66 ---------------------------
docs/en/edge/index.md | 4 ++
3 files changed, 70 insertions(+), 66 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/12330b99/docs/en/edge/guide/white-list/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/white-list/index.md b/docs/en/edge/guide/white-list/index.md
new file mode 100644
index 0000000..384dde3
--- /dev/null
+++ b/docs/en/edge/guide/white-list/index.md
@@ -0,0 +1,66 @@
+---
+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.
+---
+
+White List Guide
+================
+
+This guide will introduce you to Cordova's newest addition: Whitelists. It's intention is to be simple and easy to understand so new and senior Cordova developers can avoid errors while upgrading a project or creating a new one.
+
+Why was this introduced?
+------------------------
+
+A question I asked myself as soon as I got a error while debugging a project after upgrading to 1.6.1.
+
+This feature was introduced, for developers that weren't sanitizing their links, as to prevent an app state where there is no way back.
+
+Its current status
+------------------
+
+ * **iOS**: Full whitelist support
+ * **Android**: Unknown
+ * **Windows Phone**: Unknown
+ * **BlackBerry**: Unknown
+ * **WebOS, Symbian, Bada**: Unknown
+
+How to edit the whitelist?
+--------------------------
+
+**iOS**
+
+The easiest way of doing this is by going to your project's *cordova.plist* file and adding a new *String* to the *ExternalHosts* key. That's all!
+
+How should a whitelist key look like?
+-------------------------------------
+
+For example, if you want to add [google.com][1] to your whitelist all you have to do is add a new key, as described above, with the following value: `google.com`
+
+**Wildcards**
+
+You can also use wildcards on whitelist keys. If you want to enable all domains possible it's easy, just add a key with the value `*`. If you want to add all the sub-domains to the whitelist, just add a key with a value like this: `*.domain.com`.
+
+Be warned that you should not include a full URL, with the `http://` part, just the sub-domain/domain, like on the examples.
+
+The End
+-------
+
+This guide is a contribution of [Nathan Campos][2] to the Cordova project.
+
+
+[1]: http://google.com
+[2]: http://about.me/nathanpc
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/12330b99/docs/en/edge/guide/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/whitelist/index.md b/docs/en/edge/guide/whitelist/index.md
deleted file mode 100644
index e552944..0000000
--- a/docs/en/edge/guide/whitelist/index.md
+++ /dev/null
@@ -1,66 +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.
----
-
-Whitelisting
-============
-
-This guide will introduce you to Cordova's newest addition: Whitelists. It's intention is to be simple and easy to understand so new and senior Cordova developers can avoid errors while upgrading a project or creating a new one.
-
-Why was this introduced?
-------------------------
-
-A question I asked myself as soon as I got a error while debugging a project after upgrading to 1.6.1.
-
-This feature was introduced, for developers that weren't sanitizing their links, as to prevent an app state where there is no way back.
-
-Its current status
-------------------
-
- * **iOS**: Full whitelist support
- * **Android**: Unknown
- * **Windows Phone**: Unknown
- * **BlackBerry**: Unknown
- * **WebOS, Symbian, Bada**: Unknown
-
-How to edit the whitelist?
---------------------------
-
-**iOS**
-
-The easiest way of doing this is by going to your project's *cordova.plist* file and adding a new *String* to the *ExternalHosts* key. That's all!
-
-How should a whitelist key look like?
--------------------------------------
-
-For example, if you want to add [google.com][1] to your whitelist all you have to do is add a new key, as described above, with the following value: `google.com`
-
-**Wildcards**
-
-You can also use wildcards on whitelist keys. If you want to enable all domains possible it's easy, just add a key with the value `*`. If you want to add all the sub-domains to the whitelist, just add a key with a value like this: `*.domain.com`.
-
-Be warned that you should not include a full URL, with the `http://` part, just the sub-domain/domain, like on the examples.
-
-The End
--------
-
-This guide is a contribution of [Nathan Campos][2] to the Cordova project.
-
-
-[1]: http://google.com
-[2]: http://about.me/nathanpc
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/12330b99/docs/en/edge/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/index.md b/docs/en/edge/index.md
index 83d6a20..01e062e 100644
--- a/docs/en/edge/index.md
+++ b/docs/en/edge/index.md
@@ -84,6 +84,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
<span>Upgrade an application to the latest Cordova release.</span>
</li>
<li>
+ <h2>White List Guide</h2>
+ <span>Grant an application access to external domains.</span>
+ </li>
+ <li>
<h2><a href="_index.html">Keyword Index</a></h2>
<span>Full index of the Cordova Documentation.</span>
</li>