incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject docs commit: Add White Listing Guide to homepage.
Date Fri, 18 May 2012 17:40:27 GMT
Updated Branches:
  refs/heads/master af0145587 -> 6ed613410


Add White Listing Guide to homepage.


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/6ed61341
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/6ed61341
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/6ed61341

Branch: refs/heads/master
Commit: 6ed6134105cfaa2dab6b61decc9b32a92f05eca1
Parents: af01455
Author: Michael Brooks <michael@michaelbrooks.ca>
Authored: Fri May 18 10:40:19 2012 -0700
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Fri May 18 10:40:19 2012 -0700

----------------------------------------------------------------------
 docs/en/edge/guide/white-listing/index.md |   66 ++++++++++++++++++++++++
 docs/en/edge/index.md                     |    4 ++
 2 files changed, 70 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ed61341/docs/en/edge/guide/white-listing/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/white-listing/index.md b/docs/en/edge/guide/white-listing/index.md
new file mode 100644
index 0000000..78fb0a3
--- /dev/null
+++ b/docs/en/edge/guide/white-listing/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 Listing 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/6ed61341/docs/en/edge/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/index.md b/docs/en/edge/index.md
index 83d6a20..6d695ef 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 Listing Guide</h2>
+            <span>Given 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>


Mime
View raw message