11[[plugin-authors]]
22== Help for plugin authors
33
4+ :plugin-properties-files: {docdir}/../../buildSrc/src/main/resources
5+
46The Elasticsearch repository contains examples of:
57
68* a https://github.com/elastic/elasticsearch/tree/master/plugins/jvm-example[Java plugin]
@@ -24,10 +26,13 @@ All plugin files must be contained in a directory called `elasticsearch`.
2426[float]
2527=== Plugin descriptor file
2628
27- All plugins must contain a file called `plugin-descriptor.properties` in the folder named `elasticsearch`. The format
28- for this file is described in detail here :
29+ All plugins must contain a file called `plugin-descriptor.properties` in the folder named `elasticsearch`.
30+ The format for this file is described in detail in this example :
2931
30- https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/resources/plugin-descriptor.properties[`/buildSrc/src/main/resources/plugin-descriptor.properties`].
32+ ["source","properties",subs="attributes"]
33+ --------------------------------------------------
34+ include-tagged::{plugin-properties-files}/plugin-descriptor.properties[plugin-descriptor.properties]
35+ --------------------------------------------------
3136
3237Either fill in this template yourself or, if you are using Elasticsearch's Gradle build system, you
3338can fill in the necessary values in the `build.gradle` file for your plugin.
@@ -125,8 +130,12 @@ for more information.
125130It is also possible to bundle multiple plugins into a meta plugin.
126131A directory for each sub-plugin must be contained in a directory called `elasticsearch.
127132The meta plugin must also contain a file called `meta-plugin-descriptor.properties` in the directory named
128- `elasticsearch`. The format for this file is described in detail here:
133+ `elasticsearch`.
134+ The format for this file is described in detail in this example:
129135
130- https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/resources/plugin-descriptor.properties[`/buildSrc/src/main/resources/meta-plugin-descriptor.properties`].
136+ ["source","properties",subs="attributes"]
137+ --------------------------------------------------
138+ include-tagged::{plugin-properties-files}/meta-plugin-descriptor.properties[meta-plugin-descriptor.properties]
139+ --------------------------------------------------
131140
132141A meta plugin can be installed/removed like a normal plugin with the `bin/elasticsearch-plugin` command.
0 commit comments