New Feature: Easy Abbreviation

new feature

Posted on: 25 May 2021 purlPURL: https://gxy.io/GTN:N00013

Thanks to the great tutorial developed by first time contributor Erik Schill avatar Erik Schill and edited by Simon Bray avatar Simon 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
...
abbreviations:
  API: Application Programming Interface
  JSON: JavaScript Object Notation
---

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

Markdown

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

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

GTN in Discourse

30 January 2024   gtn infrastructure new feature beta

Howdy teachers and support staff! We are exploring displaying GTN content directly in the Galaxy Help site, furthering the integration between the GTN and the Galaxy community infrastructure. When you paste a GTN Frequently Asked Questions URL into the Galaxy Discourse, it will now be rendered directly in Discourse!

Simplified GTN News submission via Google Form

29 January 2024   gtn infrastructure new feature automation

Based on user feedback of the difficulties of the GTN news submission process we have significantly simplified and removed the need for manually editing a YAML file by providing a quick and easy Google Form

Galaxy Single-cell Community: Year in Review

22 December 2023   gtn communications single-cell

🚀Embarking on a cosmic journey, the Galaxy Single-cell Community has clustered together to unveil a constellation of tools, making strides in RNA-stellar discoveries and creating out-of-this-world workflows. With a commitment to battling work duplication across the multiverse, this community is boldly charting a course for global domination, proving that when it comes to bioinformatics, the Galaxy is the limit!✨