cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nikhi...@apache.org
Subject docs commit: CB-10436: The H2 Heading tag is of incorrect size in cordova-docs
Date Fri, 29 Jan 2016 02:33:43 GMT
Repository: cordova-docs
Updated Branches:
  refs/heads/master ba05989c5 -> e7bfcca11


CB-10436: The H2 Heading tag is of incorrect size in cordova-docs

The Heading tags are supposed to be of following size:
h1: 36px & h2: 30px & h3: 24px & h4: 18px & h5: 14px & h6: 12px

But, h2 is actually 18px (same as h4) which makes it smaller than h3
which is incorrect. So, I am fixing it to the correct size.


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

Branch: refs/heads/master
Commit: e7bfcca11b6e50368cd5ee4427e3d71131b99b10
Parents: ba05989
Author: Sarangan Rajamanickam <sarajama@microsoft.com>
Authored: Mon Jan 25 16:40:09 2016 -0800
Committer: Nikhil Khandelwal <nikhilkh@microsoft.com>
Committed: Thu Jan 28 18:33:14 2016 -0800

----------------------------------------------------------------------
 www/docs/en/dev/guide/overview/index.md         | 114 +++++++++++--------
 www/static/css-src/_docs.scss                   |   5 +
 www/static/img/guide/cordovaapparchitecture.png | Bin 0 -> 50647 bytes
 3 files changed, 69 insertions(+), 50 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e7bfcca1/www/docs/en/dev/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/dev/guide/overview/index.md b/www/docs/en/dev/guide/overview/index.md
index 146e358..7c75dcf 100644
--- a/www/docs/en/dev/guide/overview/index.md
+++ b/www/docs/en/dev/guide/overview/index.md
@@ -24,12 +24,10 @@ title: Overview
 
 Apache Cordova is an open-source mobile development framework. It allows you
 to use standard web technologies such as HTML5, CSS3, and JavaScript
-for cross-platform development, avoiding each mobile platforms' native
+for cross-platform development, avoiding each mobile platform's native
 development language.  Applications execute within wrappers targeted
 to each platform, and rely on standards-compliant API bindings to
-access each device's sensors, data, and network status. 
-
-Apache Cordova graduated in October 2012 as a top level project within the Apache Software
Foundation (ASF). Through the ASF, future Cordova development will ensure open stewardship
of the project. It will always remain free and open source under the Apache License, Version
2.0.  Visit [cordova.apache.org](http://cordova.apache.org) for more information.
+access each device's capabilities such as sensors, data, network status, etc. 
 
 Use Apache Cordova if you are:
 
@@ -45,39 +43,55 @@ Use Apache Cordova if you are:
   device-level APIs, or if you want to develop a plugin interface
   between native and WebView components.
 
-## Basic Components
+# Architecture
 
-Apache Cordova applications rely on a common `config.xml` file that provides
-information about the app and specifies parameters affecting how it
-works, such as whether it responds to orientation shifts. This file
-adheres to the W3C's
-[Packaged Web App](http://www.w3.org/TR/widgets/),
-or _widget_, specification.
+There are several components to a cordova application. The following 
+diagram shows a high-level view of the cordova application architecture. 
+    
+![]({{ site.baseurl }}/static/img/guide/cordovaapparchitecture.png)
 
-The application itself is implemented as a web page, by default a local
-file named _index.html_, that references whatever CSS, JavaScript,
-images, media files, or other resources are necessary for it to run.
-The app executes as a _WebView_ within the native application wrapper,
-which you distribute to app stores.
+## WebView
 
 The Cordova-enabled WebView may provide the application with its
 entire user interface. On some platforms, it can also be a component
 within a larger, hybrid application that mixes the WebView with native
-application components. (See [Embedding WebViews](../hybrid/webviews/index.html) for details.)
-
-A _plugin_ interface is available for Cordova and native components to
-communicate with each other. This enables you to invoke native code
-from JavaScript. Ideally, the JavaScript APIs to that native code are
-consistent across multiple device platforms. As of version 3.0, plugins provide
-bindings to standard device APIs.  Third-party plugins provide
-additional bindings to features not necessarily available on all
-platforms. You can find these third-party plugins in the
-[plugin registry](http://plugins.cordova.io) and use them in your
-application. You can also develop your own plugins, as described in the
-[Plugin Development Guide](../hybrid/plugins/index.html). Plugins may be necessary, for example,
to
-communicate between Cordova and custom native components.
-
-__NOTE__: As of version 3.0, when you create a Cordova project it does not have
+application components. 
+(See [Embedding WebViews](../hybrid/webviews/index.html) for details.)
+
+## Web App
+
+This is the part where your application code resides. The application itself is 
+implemented as a web page, by default a local file named _index.html_, that 
+references whatever CSS, JavaScript, images, media files, or other resources 
+are necessary for it to run. The app executes in a _WebView_ within the native 
+application wrapper, which you distribute to app stores.
+
+This container has a very crucial file - [config.xml](../../config_ref/index.html) 
+file that provides information about the app and specifies parameters affecting how it
+works, such as whether it responds to orientation shifts.
+
+## Plugins
+
+Plugins are an integral part of the cordova ecosystem. They provide 
+an interface for Cordova and native components to communicate with each 
+other and bindings to standard device APIs. This enables you to invoke native 
+code from JavaScript. 
+
+Apache Cordova project maintains a set of plugins called the 
+[core plugins](../../cordova/plugins/pluginapis.html). These core 
+plugins provide your application to access device capabilities such as 
+battery, camera, contacts, etc.
+
+In addition to the core plugins, there are several third-party plugins which 
+provide additional bindings to features not necessarily available on all 
+platforms. You can search for Cordova plugins using [plugin search](http://plugins.cordova.io)
 
+or [npm](https://www.npmjs.com/search?q=ecosystem%3Acordova). You can also 
+develop your own plugins, as described in the 
+[Plugin Development Guide](../hybrid/plugins/index.html). Plugins may be 
+necessary, for example, to communicate between Cordova and custom native 
+components.
+
+__NOTE__: When you create a Cordova project it does not have
 any plugins present. This is the new default behavior. Any plugins you
 desire, even the core plugins, must be explicitly added.
 
@@ -88,7 +102,7 @@ your application yourself as third-party material.
 
 ## Development Paths
 
-As of version 3.0, you can use two basic workflows to create a mobile
+Cordova provides you two basic workflows to create a mobile
 app. While you can often use either workflow to accomplish the same
 task, they each offer advantages:
 
@@ -96,10 +110,9 @@ task, they each offer advantages:
   to run on as many different mobile operating systems as possible,
   with little need for platform-specific development.  This workflow
   centers around the `cordova` utility, otherwise known as the Cordova
-  _CLI_, that was introduced with Cordova 3.0. The CLI is a high-level
-  tool that allows you to build projects for many platforms at once,
-  abstracting away much of the functionality of lower-level shell
-  scripts. The CLI copies a common set of web assets into
+  _CLI_. The CLI is a high-level tool that allows you to build projects 
+  for many platforms at once, abstracting away much of the functionality of 
+  lower-level shell scripts. The CLI copies a common set of web assets into
   subdirectories for each mobile platform, makes any necessary
   configuration changes for each, runs build scripts to generate
   application binaries. The CLI also provides a common interface to
@@ -111,18 +124,19 @@ task, they each offer advantages:
   focus on building an app for a single platform and need to be able
   to modify it at a lower level. You need to use this approach, for
   example, if you want your app to mix custom native components with
-  web-based Cordova components, as discussed in [Embedding WebViews](../hybrid/webviews/index.html).
-  As a rule of thumb, use this workflow if you need to modify the
-  project within the SDK.  This workflow relies on a set of
-  lower-level shell scripts that are tailored for each supported
-  platform, and a separate Plugman utility that allows you to apply
-  plugins.  While you can use this workflow to build cross-platform
+  web-based Cordova components, as discussed in 
+  [Embedding WebViews](../hybrid/webviews/index.html). As a rule of thumb, use 
+  this workflow if you need to modify the project within the SDK. This 
+  workflow relies on a set of lower-level shell scripts that are tailored for 
+  each supported platform, and a separate Plugman utility that allows you to 
+  apply plugins.  While you can use this workflow to build cross-platform
   apps, it is generally more difficult because the lack of a
   higher-level tool means separate build cycles and plugin
   modifications for each platform. Still, this workflow allows you
   greater access to development options provided by each SDK, and is
-  essential for complex hybrid apps. See the various [Platform Guides](../platforms/index.html)
-  for details on each platform's available shell utilities.
+  essential for complex hybrid apps. See the various 
+  [Platform Guides](../platforms/index.html) for details on each platform's 
+  available shell utilities.
 
 When first starting out, it may be easiest to use the cross-platform
 workflow to create an app, as described in [The Command-Line Interface](../cli/index.html).
@@ -152,9 +166,9 @@ you choose:
 
   * Platform-centered workflow: see the [Platform Guides](../platforms/index.html).
 
-After installing Cordova, it is recommended that you review the [Platform Guides](../platforms/index.html)
-for the mobile platforms that you will be developing for. It is also
-recommended that you also review the [Privacy Guide](../appdev/privacy/index.html), [Security
Guide](../appdev/security/index.html), and
-[Next Steps](../next/index.html). For configuring Cordova, see [The config.xml File](../../config_ref/index.html).
-For accessing native function on a device from JavaScript, refer
-to the [Plugin APIs](../../cordova/plugins/pluginapis.html). And refer to the other included
guides as necessary.
+After installing Cordova, it is recommended that you review the 
+[Platform Guides](../platforms/index.html) for the mobile platforms that you 
+will be developing for. It is also recommended that you also review the 
+[Privacy Guide](../appdev/privacy/index.html) and 
+[Security Guide](../appdev/security/index.html). And refer to the other 
+included guides as necessary.

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e7bfcca1/www/static/css-src/_docs.scss
----------------------------------------------------------------------
diff --git a/www/static/css-src/_docs.scss b/www/static/css-src/_docs.scss
index 2f83d8d..a34fe45 100644
--- a/www/static/css-src/_docs.scss
+++ b/www/static/css-src/_docs.scss
@@ -1,4 +1,9 @@
 .docs {
+    /* overriding h2 to correct value */
+    h2 {
+        font-size: 30px;
+    }
+
     margin-bottom: 20px;
 
     /* this is so that wide images don't stick out of their paragraphs */

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e7bfcca1/www/static/img/guide/cordovaapparchitecture.png
----------------------------------------------------------------------
diff --git a/www/static/img/guide/cordovaapparchitecture.png b/www/static/img/guide/cordovaapparchitecture.png
new file mode 100644
index 0000000..19e9276
Binary files /dev/null and b/www/static/img/guide/cordovaapparchitecture.png differ


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message