Mapping Plugin link (routes) inside Indico's menus

10caret100 · December 8, 2019, 1:48pm

Hi guys!

How/where does one “define” the functional links to a plugin and where to show these inside one of Indico’s menus?

Thanks

ThiefMaster · December 8, 2019, 1:54pm

Which menu? But usually you use the signals.menu.items signal for it. Make sure to specify the correct sender to put your item in the correct menu (e.g. 'event-management-sidemenu' or 'admin-sidemenu')

10caret100 · December 8, 2019, 2:46pm

I want to add a simple link (Invoices) next to “Create Event” inside the menu toolbar (class=“global-menu toolbar”).

ThiefMaster · December 8, 2019, 2:49pm

You need the top-menu sender in this case, and return a TopMenuItem instance from the signal handler. Searching for that should give you some examples; there’s also at least one plugin in the indico-plugins-cern repo using that particular signal so you can find example code there as well.

10caret100 · December 8, 2019, 2:58pm

I think this is what I need, correct?

github.com

indico/indico-plugins-cern/blob/cc01735a35fc58eb1c430f39f6f81765b5253995/room_assistance/indico_room_assistance/plugin.py

# This file is part of the CERN Indico plugins.
# Copyright (C) 2014 - 2019 CERN
#
# The CERN Indico plugins are free software; you can redistribute
# them and/or modify them under the terms of the MIT License; see
# the LICENSE file for more details.

from __future__ import unicode_literals

from datetime import datetime

import dateutil.parser
import pytz
from flask import flash, request, session
from flask_pluginengine import render_plugin_template, url_for_plugin

from indico.core import signals
from indico.core.config import config
from indico.core.plugins import IndicoPlugin
from indico.core.settings.converters import ModelListConverter

This file has been truncated. show original

ThiefMaster · December 8, 2019, 3:00pm

Yes, just omit the section arg (unless you want it nested inside a “Services” menu) and use your own name, title and endpoint.

10caret100 · December 8, 2019, 3:09pm

Got it. What is a Services menu?

ThiefMaster · December 8, 2019, 3:14pm

It’s simply a menu item labelled “Services” that expands and shows options inside:

By default it’s hidden since it only has entries if you have some plugin adding something there.

10caret100 · December 8, 2019, 3:36pm

Got it. Thanks you (as always) @ThiefMaster!