You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| service | yes || The file page containing the image to use. See **Supported Streaming Services** below.|
38
+
| service | yes || The service name to look up users on. See **Supported Streaming Services**. |
39
39
| user | yes || The user identifier for user on the streaming service. |
40
40
| template | no | block |**Built In**: block, live, minilive, link, viewers, thumbnail <br/>Use a built in template or specify a custom template to use. |
41
41
| link | no || Fully qualifed URL to override the link in templates. |
Copy file name to clipboardExpand all lines: README.wiki
+58-12Lines changed: 58 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ service=[Service]
56
56
| <code>service</code>
57
57
| yes
58
58
|
59
-
| The file page containing the image to use.
59
+
| The service name to look up users on. See **Supported Streaming Services**.
60
60
|-
61
61
| <code>user</code>
62
62
| yes
@@ -88,7 +88,7 @@ service=Twitch
88
88
89
89
[[File:TwitchPlaysPokemonExample.png]]
90
90
91
-
==Supported Streaming Services==
91
+
====Supported Streaming Services====
92
92
93
93
{| class="wikitable"
94
94
|-
@@ -101,10 +101,10 @@ service=Twitch
101
101
| [http://www.twitch.tv/ http://www.twitch.tv/]
102
102
|}
103
103
104
-
==Templates==
104
+
====Templates====
105
105
There are six built in templates that come with the extension; block, live, minilive, link, viewers, and thumbnail. By default if no template is specified it uses the block template.
106
106
107
-
===Custom===
107
+
=====Custom=====
108
108
Which template is used to display streamer information can be customized through Mediawiki's templating system. Using the "template" parameter simply add the template page name into the parser call. '''Example: template=Template:BlockCustom'''
109
109
110
110
There are several replacement variables used in the templates that will be automatically filled in with the correct information.
@@ -115,10 +115,10 @@ There are several replacement variables used in the templates that will be autom
115
115
* '''%ONLINE%''' - Integer based boolean if the streamer is online. Use the {{#ifeq:...}} parser function to check against this.
116
116
* '''%LINK%''' - Link to the streamer's page on the service. If a custom page link is specified in the Special:StreamerInfo interface it will be used instead.
117
117
118
-
===Built In===
118
+
=====Built In=====
119
119
The built in templates below are copied from the StreamerTemplate class file and are placed here for reference purposes. They can be used to assist in building custom templates.
The #streamerinfo parser meta tag takes what service is being used and who the user is to tag an article as related to that person. It will cause any links automatically generated from the #streamer tag to use the article page as the destination and display name. Streamer information created from tagging or manually entered will be visible in the [[Special:StreamerInfo]] interface. Note: Articles tagged with the #streamerinfo tag will override any manually entered information.
176
+
177
+
Basic Syntax:
178
+
179
+
<pre><nowiki>
180
+
{{#streamerinfo:
181
+
service=[Service]
182
+
|user=[User]
183
+
}}
184
+
</nowiki></pre>
185
+
186
+
====Parameters for #streamerinfo Tag====
187
+
188
+
{| class="wikitable"
189
+
|-
190
+
! Parameter
191
+
! Required
192
+
! Default
193
+
! Description
194
+
|-
195
+
| <code>service</code>
196
+
| yes
197
+
|
198
+
| The service name to look up users on. See **Supported Streaming Services**.
199
+
|-
200
+
| <code>user</code>
201
+
| yes
202
+
|
203
+
| The user identifier for user on the streaming service.
204
+
|}
205
+
206
+
207
+
====Example====
208
+
209
+
To tag the article "Twitch Plays Pokemon" with the Twitch user "twitchplayspokemon":
210
+
211
+
<pre><nowiki>
212
+
{{#streamerinfo:
213
+
service=Twitch
214
+
|user=twitchplayspokemon
215
+
}}
216
+
</nowiki></pre>
217
+
218
+
This would cause all output from the #streamer tag to reference to the "Twitch Plays Pokemon" when generating links and display names.
0 commit comments