website/gems/lib/asciidoctor/musicbrainz-link-inline-macro
Gabriel Arazas f7e2b3a2b7
Update Asciidoctor extension dependency
Asciidoctor already handles the caching so we don't really need to. On
the plus side, it gives some choice whether the pipeline should have a
cache or not.
2023-05-28 17:49:15 +08:00
..
extension.rb Update Asciidoctor extension dependency 2023-05-28 17:49:15 +08:00
README.adoc Add MusicBrainz link inline macro 2023-05-27 19:37:24 +08:00

Table of Contents

An inline macro for easily linking objects from Musicbrainz database.

Synopsis

musicbrainz:$ID[$CAPTION, $TYPE]
  • $ID is the database identifier for that object (e.g., 9adcff14-7dba-4ccf-a6a6-298bcde3dd46).

  • $CAPTION is the link text. By default, it will be the name of the database object (if valid). Take note it will use the MusicBrainz API to query the title/name of the object. In other words, it costs an additional network request.

  • $TYPE is the database object type. It defaults to 'Release' object type.

Attributes

The macro can also accept some attributes.

  • caption is the link text to be used. This can be used instead of the first positional attribute.

  • type is the database object type to be queried. This can be used instead of the second positional attribute.

Example usage