New Feature: Easy Abbreviation

new feature

Posted on: 25 May 2021 purlPURL:

Thanks to the great tutorial developed by first time contributor AvatarErik Schill and edited by AvatarSimon Bray, we noticed that they defined a number of abbreviations and re-used those throughout their tutorial.

As the GTN is intended to be easy for contributors and easy for learners, we wanted to make use of the <abbr> tag which allows you to define commonly re-used terms in your HTML. However this is a bit clumsy to write every time, so we’ve implemented a tag and some metadata which permits easily defining and referencing abbreviations throughout your text.

In your tutorial metadata you can add an abbreviations section like:

title: My awesome tutorial
  API: Application Programming Interface
  JSON: JavaScript Object Notation

And in your text you can use braces to refer to the term

code-in Input: Markdown

The `/jobs` {API} will return {JSON}. When we call the {API} we'll get back this result {JSON}.

code-out Output

The /jobs Application Programming Interface (API) will return JavaScript Object Notation (JSON). When we call the API we’ll get back this result JSON.

These will even generate an automatic Glossary at the end. Check out the use of this new feature in the BioBlend Dev Tutorial!

View Material
GTN logo with a multi-coloured star and the words Galaxy Training Network

Recent News

See all news

ELIXIR-UK Fellow Launches New FAIR Data Management Training

21 June 2023   new topic new tutorial

Katarzyna Kamieniecka (University of Bradford), a member of the ELIXIR-UK Fellowship Programme, has just launched a new series of lessons to improve {FAIR} data management in the life sciences. The lessons are designed to help researchers and research support staff understand the principles of FAIR data management and apply them to their own work.

New Feature: Pan-Galactic Tool Search

7 June 2023   new feature gtn

Did you ever want to run a tool, but not know where it might be available? The GTN has you covered with the Pan-Galactic Tool Search that is now available.