From Ametys 4.9
A graphic charter can have a default behavior in the absence of a plugin on which it depends.
Classic dependency
The plugin dependency in an XSL or SCSS file uses an import via theplugin:PLUGINNAME://" protocol, for example :
<xsl:import href="plugin:rocket.chat://stylesheets/rocket.chat.xsl" />
or
@import "plugin:rocket.chat://resources/css/Rocket.Chat";
This "classic" dependency requires that the Rocket.Chat plugin exists and includes the imported XSL and SCSS files.
Otherwise, the XSL or SCSS will cause an error.
Optional dependency
Making a dependency optional involves 2 steps: indicating that the dependency is optional and providing the default behavior.
Making depenance optional
In url of the formplugin:PLUGINNAME://location", add a "?" behind the plugin name.
The above examples become :
<xsl:import href="plugin:rocket.chat?://stylesheets/rocket.chat.xsl" />
or
@import "plugin:rocket.chat?://resources/css/Rocket.Chat";
Default or fallback behavior
You need to create or modify the"skins/MASKIN/conf/optional-source-fallbacks.xml" file to indicate which url to send optional urls to.
It's important that all the optional urls used find a match here.
Ce fichier comporte une balise racine <fallbacks>suivi de 0..n balises <fallback>.
Chaque balise fallback comporte 2 sous-balises :
- <uri> indique l'url optionelle (incluant le caractère "?" après le nom du plugin).
L'attribut regexp à true, permet d'indiquer que le contenu d'uri est une expression régulière qui va vérifier l'uri optionelle. - <fallback> qui indique l'url de redirection.
Si l'uri est une expression régulière, il faut utiliser $1...$N pour récupérer les contenus des groupes définis dans l'expression régulière.
For example, the following content will indicate that all optional urls for the Rocket.Chat plugin should be redirected to the"plugin.chat" graphics folder.
<fallbacks> <fallback> <uri regexp="true">^plugin:rocket\.chat\?://(.*)$</uri> <fallback>fallbacks/plugin/rocket.chat/$1</fallback> </fallback> </fallbacks>
which eliminates the need to describe each url to be redirected.
In the examples above, this would require :
<fallbacks> <fallback> <uri>plugin:rocket.chat?://stylesheets/rocket.chat.xsl</uri> <fallback>fallbacks/plugin/rocket.chat/stylesheets/rocket.chat.xsl</fallback> </fallback> <fallback> <uri>plugin:rocket.chat?://resources/css/Rocket.Chat.scss</uri> <fallback>fallbacks/plugin/rocket.chat/resources/css/Rocket.Chat.scss</fallback> </fallback> </fallbacks>
The scss import used above does not specify the .scss extension, as this is optional in SCSS
@importplugin:rocket.chat:css.Chat";
However, the redirection here requires .scss, as this is the url that will be used in the end.
Default files
All that remains now is to actually write the default version of the files referenced with the content required to run XSL or SCSS.
In the examples above, the Rocket.Chat plugin provides a"stylesheet/rocket.chat" xsl containing the following templates:"rocket.css" and"rocket.chat-scripts".
The XSL of the grpahic charter importingplugin:rocket.chat?://stylesheets/rocket.chatxsl" contains the instructions :
<xsl:call-template name="rocket.chat-css"/> <xsl:call-template name="rocket.chat-scripts"/>
The default files must be able to replace those of the plugin by defining these templates:
"plugin.chat/stylesheet/rocket.chat.xsl"
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <!-- empty fallbacks --> <xsl:template name="rocket.chat-scripts"/> <xsl:template name="rocket.chat-css"/> </xsl:stylesheet>
For the Rocket.Chat scss that's just imported, an empty SCSS file is sufficient: "plugin.css.Chat.scss".
But if the SCSS that imports Rocket.Chat.scss requires a variable defined by it, the fallback file would have to define this variable (and its default value) too.
Back to top