Template:Soundcloud/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
(Updating documentation with new features)
Tag: sourceedit
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The '''{{tlx|Soundcloud}}''' template creates [https://soundcloud.com SoundCloud] embeds on articles. There are two ways to use it. The first creates an embed that will take up the full width of the article:
The '''{{tlx|soundcloud}}''' template creates [https://soundcloud.com SoundCloud] embeds on articles. There are two ways to use it. The first creates an embed that will take up the full width of the article:


{{tlx|soundcloud|url}}
{{tlx|soundcloud|url}}
Line 7: Line 7:
{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls}}
{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls}}


This respects infoboxes and will display side by side instead of being pushed beneath. There is also an optional width parameter. {{tlx|soundcloud|width{{=}}50%|https://soundcloud.com/big-finish/doctor-who-urgent-calls}} gives:
This respects infoboxes and will display side by side instead of being pushed beneath. There are also optional width and height parameter. {{tlx|soundcloud|width{{=}}50%|height{{=}}150%|https://soundcloud.com/big-finish/doctor-who-urgent-calls}} gives:


{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls|width=50%}}
{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls|width=50%|height=150%}}


The second way creates a small embed to the side, in the same place an image would go. Just add an "i" as the second parameter.<ref>Technically, anything could go in place of the "i".</ref> By default, the player will snap to the right. To display it on the left, add <tt>left=1</tt>. To add a caption, add <tt>caption=whatever</tt>. Captions are particularly important because the smaller player size truncates the track title.
The second way creates a small embed to the side, in the same place an image would go. Just add "left" or "right" as the second parameter, depending on which side you want to snap to. To add a caption, add <tt>caption=whatever</tt>. Captions are particularly important because the smaller player size truncates the track title.


{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls|i|caption=This is an example.}}
{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls|right|caption=This is an example.}}
{{tlx|soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls{{nbsp}}|i|caption{{=}}This is an example.}} is demonstrated to the right.
{{tlx|soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls{{nbsp}}|right|caption{{=}}This is an example.}} is demonstrated to the right.


{{reflist}}


<nowiki />
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 19:12, 18 September 2022

The {{soundcloud}} template creates SoundCloud embeds on articles. There are two ways to use it. The first creates an embed that will take up the full width of the article:

{{soundcloud|url}}

For example, {{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls}} creates:

This respects infoboxes and will display side by side instead of being pushed beneath. There are also optional width and height parameter. {{soundcloud|width=50%|height=150%|https://soundcloud.com/big-finish/doctor-who-urgent-calls}} gives:

The second way creates a small embed to the side, in the same place an image would go. Just add "left" or "right" as the second parameter, depending on which side you want to snap to. To add a caption, add caption=whatever. Captions are particularly important because the smaller player size truncates the track title.

This is an example.

{{soundcloud|https://soundcloud.com/big-finish/doctor-who-urgent-calls |right|caption=This is an example.}} is demonstrated to the right.