indico_custom_footer - Footer Customisation for Indico¶
Installation¶
The plugin can be installed using standard Python package managers. To enable the plugin, it must be added to the configuration file of indico.
Note that at least indico 2.0 is required, and will be installed automatically if it is missing.
Installing the package¶
The indico_custom_footer plugin must be installed for the python version running indico.
With a standard indico installation, you must activate the indico python virtual environment first.
su - indico
source ~/.venv/bin/activate
The latest release version is available for the default python package managers.
You can directly install the module using pip:
pip install indico-plugin-custom-footer
This can also be used to upgrade to a newer version:
pip install indico-plugin-custom-footer --upgrade
Enabling the package¶
All plugins must be enabled in indico’s configuration file.
By default, the configuration is located in /opt/indico/etc/indico.conf.
PLUGINS = {'custom_footer'}
Note that if you need multiple plugins, you must include them all in the set of PLUGINS:
PLUGINS = {'payment_manual', 'payment_paypal', 'payment_sixpay', 'custom_footer'}
Configuration¶
Once installed, the plugin can be configured from the Administration panel.
From the main page, select Administration -> Plugins -> Footer Customisation.
Adding and Ordering Links¶
Configuration gives you access to an ordered list of links.
To add new links, use the + Add button below the list.
The footer is populated with the links in the same order as in the list.
You can drag and drop entries to change their ordering.
Configuring Links¶
Each link consists of three settings:
- Name
- The link name as shown in the footer.
- Link
- The address as pointed to by the link.
- Target
- Where to open the link:
_selffor the current window/tab or_blankfor a new window/tab.
You can configure each link separately by hitting the pencil button next to it.
Note that changes to a link must stored individually by hitting the disk button.
Only afterwards can changes be saved with the Save button.
The indico_custom_footer allows you to add custom links to the Indico footer.
Overview¶
If the plugin is enabled, administrators can add additional links to the Indico footer.
For example, in addition to the Terms and conditions
you can now add a legal disclaimers link to your organization’s disclaimers.
Once installed, the administrator panel allows adding new footer links. Each link consists of the following settings:
- Name
- The link name as shown in the footer.
- Link
- The address as pointed to by the link.
- Target
- Where to open the link:
_selffor the current window or_blankfor a new window/tab.
Quick Guide¶
To enable the plugin, it must be installed for the python version running indico.
python -m pip install indico-plugin-custom-footer
Once installed, the plugin called custom_footer can be enabled in the Indico configuration.
New footer elements can be added by configuring the plugin in the administrator settings.
Contributing and Feedback¶
The project is hosted on github.
Feedback, pull requests and other contributions are always welcome.
If you have issues or suggestions, check the issue tracker: 
Disclaimer¶
This plugin is in no way endorsed, supported or provided by Indico or any other service, provider or entity.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation built from indico_custom_footer 2.0.1 at May 30, 2018.