Difference between revisions of "Template:StreamLinkTable"

From Hackerspace ACKspace
Jump to: navigation, search
(fixed rowspan using a little css magic)
(created fancy readme, set stages to generic name)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 +
__TOC__
 +
=== synopsis ===
 +
This is the "{{PAGENAME}}" template.
  
−
{{#vardefine:variablename|specifiedvalue}}
+
It will generate a table with various links derived from the <code>stages</code>, <code>languages</code>, <code>formats</code> and <code>types</code>.
  
−
{{#var:variablename}}
+
It should be called in the following format (all parameters are '''optional'''):
  
−
TODO: write descent info
+
<nowiki>{{</nowiki>{{PAGENAME}}
 +
|baseURL=
 +
|stages=
 +
|languages=
 +
|languageCount=
 +
|formats=
 +
|types=
 +
|typeCount=
 +
}}
  
−
{{{stages|Tent-1;s1,Tent-2;s2,BER stage;s3}}}
+
=== parameters ===
−
{{{language|Native;_native_,Translated;_translated_}}}
+
The parameters all default to something useful for [[CCC]] and each has a specific syntax:
−
todo: {{{languageCount|2}}}
+
baseURL
−
{{{types|HD;hd,SD;sd,Slides;slides}}}
+
* <code>baseURL</code>: first common part of the link, defaults to '''<nowiki>http://cdn.c3voc.de/</nowiki>'''
−
{{{typeCount|3}}}
+
* <code>stages</code>: comma separated (''',''') list of ''<code>Stage Label;urlPart</code>'' (note the semicolon ''';'''), defaults to 3 &times; '''Stage ''n'';s''n'''''
−
{{{formats|WebM;.webm,HLS;.m3u8}}}
+
* <code>languages</code>: comma separated (''',''') list of ''<code>Language Label;urlPart</code>'' (note the semicolon ''';'''), defaults to '''Native;_native_,Translated;_translated_'''
−
{{{baseURL|http://cdn.c3voc.de/}}}
+
* <code>languageCount</code>: number used for setting the correct table header span, set to reflect the amount of languages, defaults to '''2'''
 +
* <code>formats</code>: comma separated (''',''') list of ''<code>Format Label;urlPart</code>'' (note the semicolon ''';'''), defaults to '''WebM;.webm,HLS;.m3u8'''
 +
* <code>types</code>: comma separated (''',''') list of ''<code>Type Label;urlPart</code>'' (note the semicolon ''';'''), defaults to '''HD;hd,SD;sd,Slides;slides'''
 +
* <code>typeCount</code>: number used for setting the correct table header span, set to reflect the amount of types, defaults to '''3'''
  
−
----
+
The links are generated as followed (always using the item part ''after'' the semicolon:
 +
<code>baseURL</code>+<code>stage</code>(outer row)+<code>language</code>(inner row)+<code>type</code>(inner column)+<code>format</code>(outer column), for example ''Stage 3 Native Slides as HLS'' will have the link: <code>http://cdn.c3voc.de/s3_native_slides.m3u8</code>
 +
 
 +
=== css ===
 +
Note that for the best results, this table needs extra CSS in [[MediaWiki:Common.css]]:
 +
<pre>
 +
/* CSS span table rowspan only showing the first header */
 +
table.span tr>th.span2,
 +
table.span tr>th.span3,
 +
table.span tr>th.span4,
 +
table.span tr>th.span5
 +
{
 +
    display: none;
 +
}
 +
 
 +
table.span tr:nth-of-type(2n+1)>th.span2,
 +
table.span tr:nth-of-type(3n+1)>th.span3,
 +
table.span tr:nth-of-type(4n+1)>th.span4,
 +
table.span tr:nth-of-type(5n+1)>th.span5
 +
{
 +
    display: table-cell;
 +
}
 +
</pre>
 +
 
 +
If it is not possible to have this CSS added, make sure to set <code>languageCount = 1</code>, or the table layout will break.
 +
 
 +
=== example ===
 +
Edit the page to see how the following table is generated:
 
</noinclude>
 
</noinclude>
 
<table class="wikitable span">
 
<table class="wikitable span">
Line 27: Line 68:
 
|}}
 
|}}
 
</tr>
 
</tr>
−
{{#arraymap:{{{stages|Tent-1;s1,Tent-2;s2,BER stage;s3}}}|,|stage|
+
{{#arraymap:{{{stages|Stage 1;s1, Stage 2;s2,Stage 3;s3}}}|,|stage|
  
−
   {{#arraymap:{{{language|Native;_native_,Translated;_translated_}}}|,|language|
+
   {{#arraymap:{{{languages|Native;_native_,Translated;_translated_}}}|,|language|
 
     <tr>
 
     <tr>
−
       <th class="span2" rowspan="2">{{#explode:stage|;|0}}</th>
+
       <th class="span{{{languageCount|2}}}" rowspan="{{{languageCount|2}}}">{{#explode:stage|;|0}}</th>
 
       <th>{{#explode:language|;|0}}</th>
 
       <th>{{#explode:language|;|0}}</th>
 
         {{#arraymap:{{{formats|WebM;.webm,HLS;.m3u8}}}|,|format|
 
         {{#arraymap:{{{formats|WebM;.webm,HLS;.m3u8}}}|,|format|

Revision as of 09:56, 7 December 2017

synopsis

This is the "StreamLinkTable" template.

It will generate a table with various links derived from the stages, languages, formats and types.

It should be called in the following format (all parameters are optional): 

{{StreamLinkTable
|baseURL=
|stages=
|languages=
|languageCount=
|formats=
|types=
|typeCount=
}}

parameters

The parameters all default to something useful for CCC and each has a specific syntax: baseURL

  • baseURL: first common part of the link, defaults to http://cdn.c3voc.de/
  • stages: comma separated (,) list of Stage Label;urlPart (note the semicolon ;), defaults to 3 × Stage n;sn
  • languages: comma separated (,) list of Language Label;urlPart (note the semicolon ;), defaults to Native;_native_,Translated;_translated_
  • languageCount: number used for setting the correct table header span, set to reflect the amount of languages, defaults to 2
  • formats: comma separated (,) list of Format Label;urlPart (note the semicolon ;), defaults to WebM;.webm,HLS;.m3u8
  • types: comma separated (,) list of Type Label;urlPart (note the semicolon ;), defaults to HD;hd,SD;sd,Slides;slides
  • typeCount: number used for setting the correct table header span, set to reflect the amount of types, defaults to 3

The links are generated as followed (always using the item part after the semicolon: baseURL+stage(outer row)+language(inner row)+type(inner column)+format(outer column), for example Stage 3 Native Slides as HLS will have the link: http://cdn.c3voc.de/s3_native_slides.m3u8

css

Note that for the best results, this table needs extra CSS in MediaWiki:Common.css: 

/* CSS span table rowspan only showing the first header */
table.span tr>th.span2,
table.span tr>th.span3,
table.span tr>th.span4,
table.span tr>th.span5
{
    display: none;
}

table.span tr:nth-of-type(2n+1)>th.span2,
table.span tr:nth-of-type(3n+1)>th.span3,
table.span tr:nth-of-type(4n+1)>th.span4,
table.span tr:nth-of-type(5n+1)>th.span5
{
    display: table-cell;
}

If it is not possible to have this CSS added, make sure to set languageCount = 1, or the table layout will break.

example

Edit the page to see how the following table is generated:

WebMHLS
HDSDSlidesHDSDSlides
Stage 1 Native linklinklinklinklinklink
Stage 1 Translated linklinklinklinklinklink
Stage 2 Native linklinklinklinklinklink
Stage 2 Translated linklinklinklinklinklink
Stage 3 Native linklinklinklinklinklink
Stage 3 Translated linklinklinklinklinklink
Retrieved from "https://ackspace.nl/w/index.php?title=Template:StreamLinkTable&oldid=7823"