Code wiki

Ajouter une aide contextuelle à des canaux

Ajoute une aide contextuelle pour un canal, accessible par une icône dans la barre de titre du canal. La page de l'aide s'ouvre dans un nouvel onglet ou fenêtre.

Version concernée :

uPortal-esup-DLM et esupdev-DLM 2.6

Procédure :

Modifier la feuille de rendu :

Modifier le fichier ${esup.root}/custom/uPortal/webpages/stylesheets/org/esupportail/portal/layout/tab-column/xhtml-theme/xhtml-theme.xsl :

A la ligne 348 (dans le "template" controls), ajouter :

<xsl:template name="controls">
.....
        <xsl:if test="not(@hasHelp='false')">
            <xsl:choose>
                <xsl:when test="parameter[@name='helpUrl']">
                    <a href="{parameter[@name='helpUrl']/@value}" target="_blank">
                        <img src="{$mediaPath}/{$skin}/controls/help.png" alt="Aide" title="Aide" />
                    </a>
                </xsl:when>
                <xsl:otherwise>
                    <a href="{$baseActionURL}?uP_help_target={@ID}#{@ID}"><img src="{$mediaPath}/{$skin}/controls/help.png" alt="Aide" title="Aide" /></a>
                </xsl:otherwise>
            </xsl:choose>
        </xsl:if>

(re)publier le canal, en valuant le paramètre "hasHelp" à vrai et en ajoutant un paramètre "helpUrl" contenant l'adresse de la page d'aide. Exemple avec un fichier de publication :

<channel-definition>
    <title>Canal 1</title>

...
    <hashelp>T</hashelp>
...

    <parameters>
        <parameter>
            <name>helpUrl</name>
            <value>http://www.univ.fr/aide/aide-canal1.html</value>
            <description></description>
            <ovrd></ovrd>
        </parameter>
...
    </parameters>

</channel-definition>