[gnome-builder] help: update various plugin docs
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] help: update various plugin docs
- Date: Tue, 12 Mar 2019 22:01:43 +0000 (UTC)
commit f2f5e1f98b8d44875bae134efc31341f1c86f1d1
Author: Christian Hergert <chergert redhat com>
Date: Tue Mar 12 15:01:20 2019 -0700
help: update various plugin docs
doc/help/plugins/creating.rst | 8 ++++++--
doc/help/plugins/editor/highlighting.rst | 2 +-
2 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/doc/help/plugins/creating.rst b/doc/help/plugins/creating.rst
index cc7a3176f..3ee52f37e 100644
--- a/doc/help/plugins/creating.rst
+++ b/doc/help/plugins/creating.rst
@@ -14,7 +14,7 @@ The file should have the file-suffix of ".plugin" and it's format is familiar.
It starts with a line containing "[Plugin]" indicating this is extension metadata.
Then it is followed by a series of "Key=Value" key-pairs.
-.. note:: We often use the words "extension" and "plugin" interchangeably.
+We will often use the words "extension" and "plugin" interchangeably.
.. code-block:: ini
@@ -24,6 +24,10 @@ Then it is followed by a series of "Key=Value" key-pairs.
Loader=python3
Module=my_plugin
Author=Angela Avery
+ X-Builder-ABI=3.32
+ X-Has-Resources=true
+
+.. note:: ``X-Builder-ABI`` should be set to the version of Builder you are targeting (not including the
micro release number). It will only be loaded if the Builder version matches.
Now we can create a simple plugin that will print "hello" when Builder starts and "goodbye" when Builder
exits.
@@ -88,7 +92,7 @@ placed alongside the ``$module_name.plugin`` file.
<?xml version="1.0" encoding="UTF-8"?>
<gresources>
- <gresource prefix="/org/gnome/builder/plugins/my-plugin">
+ <gresource prefix="/plugins/my-plugin">
<file preprocess="xml-stripblanks" compressed="true">gtk/menus.ui</file>
</gresource>
</gresources>
diff --git a/doc/help/plugins/editor/highlighting.rst b/doc/help/plugins/editor/highlighting.rst
index f82c83144..e2b23422a 100644
--- a/doc/help/plugins/editor/highlighting.rst
+++ b/doc/help/plugins/editor/highlighting.rst
@@ -26,7 +26,7 @@ Then append the directory path of your language-specs to the ``GtkSource.Languag
manager = GtkSource.LanguageManager.get_default()
paths = manager.get_search_path()
- paths.append('resources:///org/gnome/builder/plugins/my-plugin/language-specs/')
+ paths.append('resources:///plugins/my-plugin/language-specs/')
manager.set_search_path(paths)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]