Merge pull request NativeScript#222 from NativeScript/plamen5kov/link_plugin_specifics

Plamen5kov · Plamen5kov · commit b92300d20960 · 2016-02-16T10:00:20.000+02:00
removed android speciffic docs, still need to add link to android spe…
diff --git a/plugins/plugins.md b/plugins/plugins.md
@@ -15,7 +15,6 @@ Starting with NativeScript CLI 1.1.0, you can develop or use plugins in your Nat
 * [Create a Plugin](#create-a-plugin)
   * [Directory Structure](#directory-structure)
   * [Package.json Specification](#packagejson-specification)
-  * [Include.gradle Specification](#includegradle-specification)
 * [Install a Plugin](#install-a-plugin)
   * [Valid Plugin Sources](#valid-plugin-sources)
   * [Installation Specifics](#installation-specifics)
@@ -32,7 +31,7 @@ A NativeScript plugin is any npm package, published or not, that exposes a nativ
 * A `package.json` file which contains the following metadata: name, version, supported runtime versions, dependencies and others. For more information, see the [Package.json Specification](#packagejson-specification) section.
 * One or more CommonJS modules that expose a native API via a unified JavaScript API. For more information about Common JS modules, see the [CommonJS Wiki](http://wiki.commonjs.org/wiki/CommonJS).
 * `AndroidManifest.xml` and `Info.plist` which describe the permissions, features or other configurations required or used by your app for Android and iOS, respectively.
-* (Optional) Native Android libraries and the native Android `include.gradle` configuration file which describes the native dependencies. For more information, see the [Include.gradle Specification](#includegradle-specification) section
+* (Optional) Native Android libraries and the native Android `include.gradle` configuration file which describes the native dependencies. See android specific structure [here]({% slug android-plugins-infrastructure% }).
 * (Optional) Native iOS dynamic libraries.
 
 The plugin must have the directory structure, described in the [Directory Structure](#directory-structure) section.
@@ -47,7 +46,7 @@ If the NativeScript framework does not expose a native API that you need, you ca
 * The plugin directory structure must comply with the specification described below.
 * The plugin must contain a valid `package.json` which complies with the specification described below.
 * If the plugin requires any permissions, features or other configuration specifics, it must contain `AndroidManifest.xml` and `Info.plist` file which describe them.
-* (Android-only) If the plugin depends on native libraries, it must contain a valid `include.gradle file`, which describes the dependencies.
+* (Android-only) If the plugin depends on native libraries, it must contain a valid `include.gradle file`, which describes the dependencies. See android specific structure [here]({% slug android-plugins-infrastructure% }).
 
 ### Directory Structure
 
@@ -59,7 +58,6 @@ my-plugin/
 ├── package.json
 └── platforms/
     ├── android/
-    │   └── res/
     │   └── AndroidManifest.xml
     └── ios/
         └── Info.plist
@@ -78,7 +76,6 @@ my-plugin/
 │   └── package.json
 └── platforms/
     ├── android/
-    │   └── res/
     │   └── AndroidManifest.xml
     └── ios/
         └── Info.plist
@@ -88,21 +85,16 @@ my-plugin/
 * `index.js`: This file is the CommonJS module which exposes the native API. You can use platform-specific `*.platform.js` files. For example: `index.ios.js` and `index.android.js`. During the plugin installation, the NativeScript CLI will copy the platform resources to the `tns_modules` subdirectory in the correct platform destination in the `platforms` directory of your project.<br/>Alternatively, you can give any name to this CommonJS module. In this case, however, you need to point to this file by setting the `main` key in the `package.json` for the plugin. For more information, see [Folders as Modules](https://nodejs.org/api/modules.html#modules_folders_as_modules).
 * `package.json`: This file contains the metadata for your plugin. It sets the supported runtimes, the plugin name and version and any dependencies. The `package.json` specification is described in detail below.
 * `platforms\android\AndroidManifest.xml`: This file describes any specific configuration changes required for your plugin to work. For example: required permissions. For more information about the format of `AndroidManifest.xml`, see [App Manifest](http://developer.android.com/guide/topics/manifest/manifest-intro.html).<br/>During build, gradle will merge the plugin `AndroidManifest.xml` with the `AndroidManifest.xml` for your project. The NativeScript CLI will not resolve any contradicting or duplicate entries during the merge. After the plugin is installed, you need to manually resolve such issues.
-* `platforms\android\include.gradle`: This file modifies the native Android configuration of your NativeScript project such as native dependencies, build types and configurations. For more information about the format of `include.gradle`, see [include.gradle file](#includegradle-specification).
-* `platforms/android/res`:  (Optional) This directory contains resources declared by the `AndroidManifest.xml` file. You can look at the folder structure [here](http://developer.android.com/guide/topics/resources/providing-resources.html#ResourceTypes).
 * `platforms/ios/Info.plist`: This file describes any specific configuration changes required for your plugin to work. For example: required permissions. For more information about the format of `Info.plist`, see [About Information Property List Files](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html).<br/>During the plugin installation, the NativeScript CLI will merge the plugin `Info.plist` with the `Info.plist` for your project. The NativeScript CLI will not resolve any contradicting or duplicate entries during the merge. After the plugin is installed, you need to manually resolve such issues.
 * `platforms/ios/Podfile`: This file describes the dependency to the library that you want to use. For more information, see [the CocoaPods article](CocoaPods.md).
 
-NativeScript plugins which contain both native Android and iOS libraries might have the following directory structure.
+NativeScript plugins can contain both native Android and iOS libraries. See android specific structure [here]({% slug android-plugins-infrastructure% }).
 
 ```
 my-plugin/
 ├── ...
 └── platforms/
     ├── android/
-    │   └── res/
-    │   └── MyLibrary.jar
-    │   └── MyLibrary.aar
     │   └── include.gradle
     │   └── AndroidManifest.xml
     └── ios/
@@ -111,9 +103,8 @@ my-plugin/
 ```
 
 * `platforms\android`: This directory contains any native Android libraries packaged as `*.jar` and `*.aar` packages. These native libraries can reside in the root of this directory or in a user-created sub-directory. During the plugin installation, the NativeScript CLI will configure the Android project in `platforms\android` to work with the plugin. 
-* `platforms\android\res`:  (Optional) This directory contains resources declared by the `AndroidManifest.xml` file. You can look at the folder structure [here](http://developer.android.com/guide/topics/resources/providing-resources.html#ResourceTypes).
-* `platforms\ios`: This directory contains native iOS dynamic libraries (`.framework`). During the plugin installation, the NativeScript CLI will copy these files to `lib\iOS` in your project and will configure the Android project in `platforms\ios` to work with the library.
 * `platforms\android\include.gradle`: This file modifies the native Android configuration of your NativeScript project such as native dependencies, build types and configurations. For more information about the format of `include.gradle`, see [include.gradle file](#includegradle-specification).
+* `platforms\ios`: This directory contains native iOS dynamic libraries (`.framework`). During the plugin installation, the NativeScript CLI will copy these files to `lib\iOS` in your project and will configure the Android project in `platforms\ios` to work with the library.
 
 ### Package.json Specification
 
@@ -140,33 +131,6 @@ The following is an example of a `package.json` file for a NativeScript plugin w
 }
 ```
 
-### Include.gradle Specification
-
-Every NativeScript plugin, which contains native Android dependencies, should also contain a valid `include.gradle` file in the root of its `platforms\android` directory. This `include.gradle` file must meet the following requirements.
-
-* It must contain its own [configuration](http://developer.android.com/tools/building/configuring-gradle.html).
-* It might contain native dependencies required to build the plugin properly.
-* Any native dependencies should be available in [jcenter](https://bintray.com/bintray/jcenter) or from the Android SDK installed on your machine.
-
-> **IMPORTANT:** If you don't have an `include.gradle` file, at build time, gradle will create a default one containing all default elements.
- 
-#### Include.gradle Example
-```
-//default elements
-android { 
-	productFlavors {
-		"my-plugin" {
-			dimension "my-plugin"
-		}
-	}
-}
-
-//optional elements
-dependencies {
-    compile "groupName:pluginName:ver"
-}
-```
-
 ## Install a Plugin
 
 To install a plugin for your project, inside your project, run the following command.
