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 2013/07/05 20:00:35 UTC
[1/3] docs commit: [CB-3961] Remove linebreak that suppresses CLI
from home page.
Updated Branches:
refs/heads/master 2a1e93283 -> c31204047
[CB-3961] Remove linebreak that suppresses CLI from home page.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/fb2f3e40
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/fb2f3e40
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/fb2f3e40
Branch: refs/heads/master
Commit: fb2f3e40f7b31eafbb93818f3de850ed40d3f937
Parents: 2a1e932
Author: Mike Sierra <le...@gmail.com>
Authored: Fri Jul 5 07:06:43 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Jul 5 10:53:09 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/cli/index.md | 2 +-
docs/en/edge/guide/overview/index.md | 2 +-
docs/en/edge/guide/platforms/android/index.md | 4 ++--
docs/en/edge/guide/platforms/index.md | 2 +-
docs/en/edge/guide/platforms/ios/index.md | 2 +-
docs/en/edge/guide/platforms/tizen/index.md | 2 +-
docs/en/edge/guide/platforms/wp7/index.md | 2 +-
docs/en/edge/index.md | 4 ++--
8 files changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cli/index.md b/docs/en/edge/guide/cli/index.md
index ca28310..2ccdf66 100644
--- a/docs/en/edge/guide/cli/index.md
+++ b/docs/en/edge/guide/cli/index.md
@@ -18,7 +18,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
---
-# The Cordova Command-line Interface
+# The Command-line Interface
This guide shows you how to create applications and deploy them to
various native mobile platforms using the `cordova` command-line
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
index 0da9f96..7e8a4a1 100644
--- a/docs/en/edge/guide/overview/index.md
+++ b/docs/en/edge/guide/overview/index.md
@@ -72,7 +72,7 @@ components to communicate with each other.
The easiest way to set up an application is to run the `cordova`
command-line utility, also known as the _command-line interface_
-(CLI). (To install the CLI, see The Cordova Command-line Interface.)
+(CLI). (To install the CLI, see The Command-line Interface.)
Depending on the set of platforms you wish to target, you can rely on
the CLI for progressively greater shares of the development cycle:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/platforms/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/index.md b/docs/en/edge/guide/platforms/android/index.md
index ed21185..71b171e 100644
--- a/docs/en/edge/guide/platforms/android/index.md
+++ b/docs/en/edge/guide/platforms/android/index.md
@@ -39,7 +39,7 @@ NOTE, doc said:
-->
Developers should use the the `cordova` utility in conjunction with
-the Android SDK. See The Cordova Command-line Interface for
+the Android SDK. See The Command-line Interface for
information how to install it, add projects, then build and deploy a
project.
@@ -91,7 +91,7 @@ run:
## Open a Project in the SDK
Use the `cordova` utility to set up a new project, as described in The
-Cordova Command-line Interface. For example, in a source-code directory:
+Cordova The Command-line Interface. For example, in a source-code directory:
$ cordova create hello com.example.hello "Hello World"
$ cd hello
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/platforms/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/index.md b/docs/en/edge/guide/platforms/index.md
index 5c366b8..6b9ce33 100644
--- a/docs/en/edge/guide/platforms/index.md
+++ b/docs/en/edge/guide/platforms/index.md
@@ -22,7 +22,7 @@ Platform Guides
Before developing for any of the platforms listed below, install
cordova's command-line interface (CLI).
-(For details, see The Cordova Command-line Interface.)
+(For details, see The Command-line Interface.)
To develop Cordova applications, you must install SDKs for each mobile
platform you are targeting. This installation is necessary regardless
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/platforms/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/index.md b/docs/en/edge/guide/platforms/ios/index.md
index a3398dc..afabb2b 100644
--- a/docs/en/edge/guide/platforms/ios/index.md
+++ b/docs/en/edge/guide/platforms/ios/index.md
@@ -59,7 +59,7 @@ __Command Line Tools__ listing.
## Open a Project in the SDK
Use the `cordova` utility to set up a new project, as described in The
-Cordova Command-line Interface. For example, in a source-code directory:
+Cordova The Command-line Interface. For example, in a source-code directory:
$ cordova create hello com.example.hello "Hello World"
$ cd hello
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/platforms/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/tizen/index.md b/docs/en/edge/guide/platforms/tizen/index.md
index 32dff75..0e1cbc6 100644
--- a/docs/en/edge/guide/platforms/tizen/index.md
+++ b/docs/en/edge/guide/platforms/tizen/index.md
@@ -26,7 +26,7 @@ the Tizen SDK requires Linux Ubuntu 10.04/10.10/11.04/11.10 (32-bit),
or Windows XP SP3/7 (32-bit).
Developers should use the the `cordova` utility in conjunction with
-the Tizen SDK. See The Cordova Command-line Interface for information
+the Tizen SDK. See The Command-line Interface for information
how to install it, add projects, then build and deploy a project.
## Install the SDK
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/guide/platforms/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp7/index.md b/docs/en/edge/guide/platforms/wp7/index.md
index beeb37c..4a74f0e 100644
--- a/docs/en/edge/guide/platforms/wp7/index.md
+++ b/docs/en/edge/guide/platforms/wp7/index.md
@@ -64,7 +64,7 @@ The SDK displays the directory's contents:
At this point you can modify the app within the SDK, but running the
`build` or `prepare` commands again wipes out local changes. If Visual
Studio is open, it alerts you about modified files and offers you the
-option to reload them. See The Cordova Command-line Interface for
+option to reload them. See The Command-line Interface for
more information.
## Deploy to Emulator
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fb2f3e40/docs/en/edge/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/index.md b/docs/en/edge/index.md
index 24bb0a6..08b910a 100644
--- a/docs/en/edge/index.md
+++ b/docs/en/edge/index.md
@@ -96,7 +96,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
<span>Setup each SDK and create your first Cordova app.</span>
</li>
<li>
- <h2>The Cordova<br/>Command-line Interface</h2>
+ <h2>The Command-line Interface</h2>
<span>Create, build, and deploy from the command-line.</span>
</li>
<li>
@@ -120,7 +120,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
<span>Grant an application access to external domains.</span>
</li>
<li>
- <h2>Embedding WebView</h2>
+ <h2>Embedding WebViews</h2>
<span>Implement the Cordova WebView in your project.</span>
</li>
<li>
[3/3] docs commit: [CB-3962] additional stylesheet items
Posted by mw...@apache.org.
[CB-3962] additional stylesheet items
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/c3120404
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/c3120404
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/c3120404
Branch: refs/heads/master
Commit: c31204047c55ee9c4f17ea2e6ec04b9f3d7d6c3b
Parents: 8c1ec3f
Author: Mike Sierra <le...@gmail.com>
Authored: Fri Jul 5 12:08:59 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Jul 5 10:58:55 2013 -0700
----------------------------------------------------------------------
STYLESHEET.md | 21 ++++++++++++++++-----
1 file changed, 16 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c3120404/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
index c2e8170..aab51b7 100644
--- a/STYLESHEET.md
+++ b/STYLESHEET.md
@@ -44,7 +44,7 @@ editorial guidelines.
* Do not combine in-line formatting such as _`monospace italic`_.
-## Language
+## Language and Tone
* Use present tense. "This happens," not "this will happen." (Future
tense sounds like a tenuous prediction.)
@@ -73,9 +73,13 @@ editorial guidelines.
am going to show you now." Likewise avoid "we," as in "We see
that..."
-* OK to refer to "you," the developer, but it should be minimized.
- E.g., instead of "...for which you need to invoke the `Contact.save`
- method", try "...for which the `Contact.save` method is required."
+* OK to refer to "you," the developer, but only if necessary, e.g., to
+ avoid passive voice.
+
+* Avoid unnecessarily imperative statements, especially using the word
+ "must." E.g., instead of "Commands must be run from a cmd or
+ powershell prompt," try "You can run commands either from a cmd or
+ powershell prompt."
## Usage
@@ -83,6 +87,8 @@ editorial guidelines.
developer. Refer to plural "users" as "they" to avoid singular
he/she pronoun problems.
+* WebView, not Webview. (OK to use lowercase webview in code)
+
* 'Directory', not 'folder'; may be exceptions in some GUI contexts
* 'Press' a button on the screen; 'type' a key; do not 'hit' either.
@@ -120,6 +126,12 @@ editorial guidelines.
sentences. No periods when bullets are sentence fragments. However,
bullet lists should be internally consistent.
+## Common Grammatical Errors
+
+* Do not use use apostrophes for plural, so "...manages core APIs,"
+ not api's or API's. Only use apostrophes for possessives, e.g. "the
+ API's members"
+
## Miscellaneous
* For procedure lists, don't break out separate items for (1) do this,
@@ -136,4 +148,3 @@ editorial guidelines.
matters, or __TIP:__ to pass along useful tricks or context.
* Use titles in link text, never 'click here'
-
[2/3] docs commit: [CB-3827] Suppress empty content for Win8/WP7/WP8.
Posted by mw...@apache.org.
[CB-3827] Suppress empty content for Win8/WP7/WP8.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/8c1ec3f7
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/8c1ec3f7
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/8c1ec3f7
Branch: refs/heads/master
Commit: 8c1ec3f7735f474ea1ae417b87cfbea19fc492d7
Parents: fb2f3e4
Author: Mike Sierra <le...@gmail.com>
Authored: Fri Jul 5 09:08:53 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Jul 5 10:58:28 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/index.md | 3 ---
docs/en/edge/guide/platforms/win8/config.md | 26 ------------------------
docs/en/edge/guide/platforms/wp7/config.md | 25 -----------------------
docs/en/edge/guide/platforms/wp8/config.md | 25 -----------------------
4 files changed, 79 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8c1ec3f7/docs/en/edge/guide/platforms/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/index.md b/docs/en/edge/guide/platforms/index.md
index 6b9ce33..9f6d91c 100644
--- a/docs/en/edge/guide/platforms/index.md
+++ b/docs/en/edge/guide/platforms/index.md
@@ -72,16 +72,13 @@ a lower-level alternative to the `cordova` command-line utility.
## Windows Phone
* Windows Phone 8 Platform Guide
-* Windows Phone 8 Configuration
* Windows Phone 7 Platform Guide
-* Windows Phone 7 Configuration
* Windows Phone Command-line Tools
* Upgrading Windows Phone
## Windows 8
* Windows 8 Platform Guide
-* Windows 8 Configuration
* Windows 8 Command-line Tools
* Upgrading Windows 8
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8c1ec3f7/docs/en/edge/guide/platforms/win8/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/win8/config.md b/docs/en/edge/guide/platforms/win8/config.md
deleted file mode 100644
index dfeb618..0000000
--- a/docs/en/edge/guide/platforms/win8/config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-<!--
-#
-# 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.
-#
--->
-
-Windows 8 Configuration
-===================================
-
-Windows 8 does not currently support this feature.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8c1ec3f7/docs/en/edge/guide/platforms/wp7/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp7/config.md b/docs/en/edge/guide/platforms/wp7/config.md
deleted file mode 100644
index 23c8304..0000000
--- a/docs/en/edge/guide/platforms/wp7/config.md
+++ /dev/null
@@ -1,25 +0,0 @@
-<!--
-#
-# 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.
-#
--->
-
-Windows Phone 7 Configuration
-===================================
-
-Windows Phone 7 does not currently have any additional configurable features.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8c1ec3f7/docs/en/edge/guide/platforms/wp8/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp8/config.md b/docs/en/edge/guide/platforms/wp8/config.md
deleted file mode 100644
index de0e54b..0000000
--- a/docs/en/edge/guide/platforms/wp8/config.md
+++ /dev/null
@@ -1,25 +0,0 @@
-<!--
-#
-# 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.
-#
--->
-
-Windows Phone 8 Configuration
-===================================
-
-Windows Phone 8 does not currently have any additional configurable features.