cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-10331) Improve Overview Page
Date Tue, 26 Jan 2016 01:14:39 GMT

    [ https://issues.apache.org/jira/browse/CB-10331?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15116437#comment-15116437
] 

ASF GitHub Bot commented on CB-10331:
-------------------------------------

Github user sarangan12 commented on a diff in the pull request:

    https://github.com/apache/cordova-docs/pull/465#discussion_r50784016
  
    --- Diff: www/docs/en/dev/guide/overview/index.md ---
    @@ -45,39 +43,56 @@ 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 your 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 as a _WebView_ within the native 
    --- End diff --
    
    Fixed it


> Improve Overview Page 
> ----------------------
>
>                 Key: CB-10331
>                 URL: https://issues.apache.org/jira/browse/CB-10331
>             Project: Apache Cordova
>          Issue Type: Task
>          Components: Docs
>            Reporter: Raghav
>            Assignee: Sarangan Rajamanickam
>              Labels: Docs-6.x
>
> URL: http://cordova.apache.org/docs/en/latest/guide/overview/
> The idea is to make it compact and remove unnecessary information.
> Remove history section. We can give the link to Wiki instead.
> Remove visit Cordova link.
> General guidelines:
> - While giving examples, keep them short. Do not repeat for all plugins/platforms.
> - Remove all references to cordova plugin registry.
> - Remove Tizen references. The platform is deprecated (http://markmail.org/message/hryg6sjswecpgndu)
> - Keep information up to date for the platforms, CLI and plugins



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

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


Mime
View raw message