opensource/galaxy
3
0
Fork 0
mirror of https://github.com/galaxyproject/galaxy.git synced 2026-09-24 16:30:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

update webhooks docs

Browse Source
This commit is contained in:
Evgeny Anatskiy
2018-02-01 12:22:21 -05:00
committed by Dannon Baker
parent 9b4465efd3
commit 29c766167a
1 changed files with 11 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/admin/special_topics/webhooks.rst
+11 -55
View File
@@ -64,21 +64,17 @@ Each plugin has the following folder structure:
.. code-block::
- plugin_name
- config
- plugin_name.yaml (mandatory)
- helper
- __init__.py (optional)
- static
- script.js (optional)
- styles.css (optional)
- config.yml (mandatory)
- __init__.py (optional)
- script.js (optional)
- styles.css (optional)
config
------
config.yml
----------
The configuration file is just a .yml (or .yaml) file with a few options. The following options are mandatory:
- **name** - must be the same as the plugin's root directory name
- **id** - must be the same as the plugin's root directory name
- **type** (see Entry points) - can be combined with others
- **activate** - *true* or *false* - whether show the plugin on a page or not
- **icon** Icon to show (if masthead)
@@ -88,8 +84,8 @@ The configuration file is just a .yml (or .yaml) file with a few options. The fo
All other options can be anything used by the plugin and accessed later via *webhook.config['...']*.
helper/__init__.py
------------------
__init__.py
-----------
*__init__.py has* to have the **main()** function with the following (or similar) structure:
@@ -116,10 +112,8 @@ helper/__init__.py
As an example please take a look at the *phdcomics* example plugin: https://github.com/galaxyproject/galaxy/blob/release_17.05/test/functional/webhooks/phdcomics/helper/__init__.py
static
------
The *static* folder contains only two files with the specified above names (otherwise, they won’t be read on Galaxy run).
static files
------------
- script.js - all JavaScript code (with all third-party dependencies) must be here
- styles.css - all CSS styles, used by the plugin
@@ -149,41 +143,3 @@ tool/workflow
If a tool or a workflow plugin has script.js and/or styles.css, the content of these files will be read as two strings and sent to the client and appended to DOM’s <head>.
Such approach is a possible bottleneck if the two files are big (however, this shouldn’t ever happen because plugins are supposed to be small and simple).
masthead
--------
Topbar buttons are hard coded, so they’re rendered only after *make client*.
The plugin system is entirely dynamic. All plugins are detected during Galaxy load and their configs and statics are being saved. So, every plugin must be shown/rendered dynamically.
I found a not very optimal way to add buttons to the topbar (masthead):
.. code-block:: javascript
$(document).ready(function() {
Galaxy.page.masthead.collection.add({
id : ... ,
icon : ... ,
url : ... ,
tooltip : ... ,
onlick : function() { ... }
});
});
history-menu
------------
History Panel items are again hard coded, but in the current implementation they’re rendered as html elements (so, they’re not even stored in a collection or any other object).
To add new menu items, I do the following:
.. code-block:: javascript
menu.push({
html : _l( ... ),
anon : true,
func : function() { ... }
});
But in order to fetch all plugin menu items before rendering, I get them via API in a synchronous manner. The problem is that History Panel now may load a bit longer.