Skip to content

Commit ebb285e

Browse files
committed
Documentation update.
1 parent 7b70b10 commit ebb285e

File tree

2 files changed

+61
-15
lines changed

2 files changed

+61
-15
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Basic Syntax:
3535

3636
| Parameter | Required | Default | Description |
3737
|----------------------:|----------|---------|---------------------------------------------------------------------------------------------------------------------------------|
38-
| 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**. |
3939
| user | yes | | The user identifier for user on the streaming service. |
4040
| template | no | block | **Built In**: block, live, minilive, link, viewers, thumbnail <br/>Use a built in template or specify a custom template to use. |
4141
| link | no | | Fully qualifed URL to override the link in templates. |
@@ -126,11 +126,11 @@ Basic Syntax:
126126
|user=[User]
127127
}}
128128

129-
####Parameters for #streamer Tag
129+
####Parameters for #streamerinfo Tag
130130

131131
| Parameter | Required | Default | Description |
132132
|----------------------:|----------|---------|---------------------------------------------------------------------------------------------------------------------------------|
133-
| service | yes | | The file page containing the image to use. See **Supported Streaming Services**. |
133+
| service | yes | | The service name to look up users on. See **Supported Streaming Services**. |
134134
| user | yes | | The user identifier for user on the streaming service. |
135135

136136
####Example

README.wiki

Lines changed: 58 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ service=[Service]
5656
| <code>service</code>
5757
| yes
5858
|
59-
| The file page containing the image to use.
59+
| The service name to look up users on. See **Supported Streaming Services**.
6060
|-
6161
| <code>user</code>
6262
| yes
@@ -88,7 +88,7 @@ service=Twitch
8888

8989
[[File:TwitchPlaysPokemonExample.png]]
9090

91-
==Supported Streaming Services==
91+
====Supported Streaming Services====
9292

9393
{| class="wikitable"
9494
|-
@@ -101,10 +101,10 @@ service=Twitch
101101
| [http://www.twitch.tv/ http://www.twitch.tv/]
102102
|}
103103

104-
==Templates==
104+
====Templates====
105105
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.
106106

107-
===Custom===
107+
=====Custom=====
108108
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'''
109109

110110
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
115115
* '''%ONLINE%''' - Integer based boolean if the streamer is online. Use the {{#ifeq:...}} parser function to check against this.
116116
* '''%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.
117117
118-
===Built In===
118+
=====Built In=====
119119
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.
120120

121-
====block====
121+
======block======
122122
<pre><nowiki>
123123
<div class='stream block'>
124124
<div class='logo'><img src='{{#if:%THUMBNAIL%|%THUMBNAIL%|%LOGO%}}'/></div>
@@ -129,7 +129,7 @@ The built in templates below are copied from the StreamerTemplate class file and
129129
</div>
130130
</nowiki></pre>
131131

132-
====live====
132+
======live======
133133
<pre><nowiki>
134134
<div class='stream live'>
135135
<div class='stream_info'>
@@ -139,7 +139,7 @@ The built in templates below are copied from the StreamerTemplate class file and
139139
</div>
140140
</nowiki></pre>
141141

142-
====minilive====
142+
======minilive======
143143
<pre><nowiki>
144144
<div class='stream minilive'>
145145
<div class='stream_info'>
@@ -149,12 +149,12 @@ The built in templates below are copied from the StreamerTemplate class file and
149149
</div>
150150
</nowiki></pre>
151151

152-
====link====
152+
======link======
153153
<pre><nowiki>
154154
<div class='name'><a href='%LINK%'>%NAME%</a></div>
155155
</nowiki></pre>
156156

157-
====viewers====
157+
======viewers======
158158
<pre><nowiki>
159159
<div class='stream viewers'>
160160
<div class='stream_info'>
@@ -164,9 +164,55 @@ The built in templates below are copied from the StreamerTemplate class file and
164164
</div>
165165
</nowiki></pre>
166166

167-
====thumbnail====
167+
======thumbnail======
168168
<pre><nowiki>
169169
<div class='stream thumbnail'>
170170
<div class='logo'><img src='{{#if:%THUMBNAIL%|%THUMBNAIL%|%LOGO%}}'/></div>
171171
</div>
172-
</nowiki></pre>
172+
</nowiki></pre>
173+
174+
===#streamer - Parser Tag===
175+
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

Comments
 (0)