Extension talk:Winter

Jump to: navigation, search

The following discussion has been transferred from meta.wikimedia.org.
Any user names refer to users of that site, who are not necessarily users of MediaWiki.org (even if they share the same username).

[edit] Improving and Extending Winter

Winter is still in active development. If you spot any bugs or have ideas to add any new features or make other improvements, please feel free to comment.

[edit] addFunction method

New functions can be added via the hooking method addFunction provided by the Winter parser

$Winter->addFunction('Winter_function_name','PHP_function_to_call');

PHP_function_to_call will take a single parameter: an array of the parameters of the Winter function. The value of the 0 index is the name of the calling function (e.g. 'Winter_function_name'). This allows for the same PHP function to handle multiple hooks for Winter functions.

[edit] Known bugs

[edit] v2.1.1

hello i'm using MW-1.12 and i'm getting this error

Notice: Undefined index: SCRIPT_URL in /opt/mediawiki-1.12.0-ZCUEdition/extensions/Winter.php on line 121
Notice: Undefined index: SCRIPT_URI in /opt/mediawiki-1.12.0-ZCUEdition/extensions/Winter.php on line 120

seems that problem is in these lines

$this->scriptVars['_system']['uri'] = $_SERVER['SCRIPT_URI'];
$this->scriptVars['_system']['url'] = $_SERVER['SCRIPT_URL'];

after commenting them everythink works fine (i think)

[edit] v1.1

It seems that Winter 2.1.1 inhibits templates from parsing particularly long pieces of data. We use Winter on WikiPaltz (http://www.wikipaltz.com) and it's like a dream come true. However, after upgrading to 2.1.1, certain templates ceased to function when called with long strings of text. An example can be found here:

• http://www.wikipaltz.com/index.php?title=Test&oldid=43226

The "WriteLeg" template simply stopped showing with this code with Winter 2.1.1. Thus, we had to revert to 2.1.0. -RadicalHarmony on WikiPedia, JustinHolmes on WikiPaltz

[edit] v1.0

All bugs below from v1.0 have been fixed in v1.1

• nested functions with spaces inbetween the function name and the first pipe cause a time out error. ex: {#var | a {{#ifeq | a | b | c | d}} }}' . a work around for this bug is to omit the space. The followin code works {#var| a {{#ifeq| a | b | c | d}} }} This bug was dure to an error in a regular expression and has been fixed for later versions
• the operator != does not always work as expected. Current work around is to avoid using this operator. This error was caused because the mediawiki parser prepends an &nbps; to ! if there is a space inbetween it and a |

[2 bugs added 05:01, 18 November 2005 (UTC)]

[edit] Questions

• I tried to run the extension on Mediawiki 1.5.3. It seemed to work, until i tried nested functions like the Example 1 from the mainpage. I always get Error messages about Timouts. Now the server is killed - though i am not sure, if the extension has something to do with it, but it seems so. Any ideas, what i can do about it? mail: tiefling at gmx.de -- Phonkeal

strange.. I haven't tested it on 1.5.3 but it works fine on 1.5.2 . You copied example 1 directly and it's not working? Frantik 23:33, 17 November 2005 (UTC)

Your email revealed a bug in Winter code.. it doesn't like it if you put a space in between the function name and the first pipe (|). This has been fixed for future releases Frantik 05:01, 18 November 2005 (UTC)

[edit] How to enable this extension?

I'v dropped it into extensions directory, but it does not seem to work. It's mediawiki 1.5.2.

you need to add require_once("extensions/Winter.php"); to the bottom of LocalSettings.php

[edit] Small improvements

Hello, your extension ist very good. But I have a few small improvements still.

1. It could be contained version information
2. The function "wfWinterScriptExtension" needs a return value, since otherwise different extension could not fade in itself into the hook.

to 1. the code

// Process page text using Winter scripting engine
function wfWinterScriptExtension( &$parser, &$text)
{  global $Winter;

   $text = $Winter->processText($text);

   return true;
}

to 2. the code

$wgExtensionCredits['parserhook'][] = array(
                                    	    'name' => 'Winter (Wiki INTERpreter)',
	                                    'author' => 'frantik',
	                                    'url' => 'http://meta.wikimedia.org/wiki/User:Frantik/Winter',
                                            'description' => 'Is an extension which adds an interpreted language to Mediawiki pages.',
                                            'version' => '1.3.1');

--Thomas Klein 18:40, 11 December 2005 (UTC)

Cheers for the advice. I will include these changes in the next update. Glad you like the extension :) --Frantik 14:23, 14 December 2005 (UTC)

[edit] Problems with tables in templates

I have a template with a table. So lines in the table don't include in the table, if the parameter is null.

Template source:

{| border="0" cellpadding="2" cellspacing="1" style="background:#8CAFE6; float:right; margin-left:15px; margin-top:10px; margin-bottom:10px" width="30%"
! colspan="2" align="left" | Mitarbeiter
|---- style="background:#FAFAF5"
|Name:||'''{{{Name}}}'''
|---- style="background:#FAFAF5"
|Tel:||{{{Telefon}}}
|---- style="background:#FAFAF5"
|{{#default|Arbeitsplatz|}}
{{#if| {{{Arbeitsplatz}}} | 
|Arbeitsplatz:||{{{Arbeitsplatz}}} 
|---- style="background:#FAFAF5" }}
{{#default|Besonderheit|}}
{{#if| {{{Besonderheit}}} | 
|Besonderes:||{{{Besonderheit}}} 
|---- style="background:#FAFAF5" }}
|}

Template call:

{{Mitarbeiter|Name = Thomas Klein
|Telefon = +49 111/555-888
|Besonderheit = The line Arbeitsplatz is delete, because the parameter is missing
}}

What is wrong? --Thomas Klein 21:12, 11 December 2005 (UTC)

You need to tell Winter the default values of any value that may be NULL. Include this text at the top of your template page:

{{#default | Arbeitsplatz | }}
{{#default | Besonderheit | }}

--Frantik 14:18, 14 December 2005 (UTC)

That works!

{{#default | Besonderheit | }}
{{#if| {{{Besonderheit}}} | 
|Besonderes:||{{{Besonderheit}}} }} 
|---- style="background:#FAFAF5" 
|}

But not that,

{{#default | Besonderheit | }}
{{#if| {{{Besonderheit}}} | 
|Besonderes:||{{{Besonderheit}}} 
|---- style="background:#FAFAF5" }}
|}

and not that

{{#default | Besonderheit | }}
{{#if| {{{Besonderheit}}} | 
|Besonderes:||{{{Besonderheit}}} 
{{#if| {{{Besonderheit}}} | 
|---- style="background:#FAFAF5" }}
|}

Why not? --Thomas Klein 21:56, 14 December 2005 (UTC)

It seems as if not all of the code is passed to Winter if it is inside a table. I'll try to see if I can make this work as I'm sure it would be a popular feature --Frantik 23:02, 14 December 2005 (UTC)

Ok, I see the problem. The closing }} for the if statement needs to be on a new line, otherwise mediawiki assumes it is part of the table definition. Try this:

{{#default|Arbeitsplatz|}}
{{#default|Besonderheit|}}
{| border="0" cellpadding="2" cellspacing="1" style="background:#8CAFE6; float:right; margin-left:15px; margin-top:10px; margin-bottom:10px" width="30%"
! colspan="2" align="left" | Mitarbeiter
|---- style="background:#FAFAF5"
|Name:||'''{{{Name}}}'''
|---- style="background:#FAFAF5"
|Tel:||{{{Telefon}}}
|---- style="background:#FAFAF5" 
{{#if| {{{Arbeitsplatz}}} | 
|Arbeitsplatz: ||{{{Arbeitsplatz}}}
|---- style="background:#FAFAF5" 
}}
{{#if| {{{Besonderheit}}} |
|Besonderheit: ||{{{Besonderheit}}}
|---- style="background:#FAFAF5" 
}}

--Frantik 06:30, 15 December 2005 (UTC)

That is ok, but not if i use the varibale more than one. --Thomas Klein 07:53, 16 December 2005 (UTC)

What do you mean? Can you give an example? --Frantik 11:23, 17 December 2005 (UTC)

[edit] nowiki is not honored!

This is really a minor nit -- so far, I love Winter! But I was making an example page for my users, showing entered versus displayed and it appears that Winter merrily cruises right through <nowiki> tags! So I went to see how you made your Winter code show up, and it appears your examples have formatting inside, which must keep Winter from taking action. --Bytesmiths 05:19, 20 December 2005 (UTC)

The example code displays here on meta.wikimedia.org because Winter isn't installed. Nowiki isn't honored because Winter isn't part of the wiki rendering engine, though I can see how there is a need for a way to display Winter code on a wiki that is running Winter so i'll have to add a command --Frantik 16:19, 21 December 2005 (UTC)

[edit] Fatal error

{{#function
           | unitdictionary
          || {{#substr
                      | {{Units:{{#var|1}}}}
                      | {{#strpos
                                 | {{Units:{{#var|1}}}}
                                 | "^!dictionary=                  "
                        }}
                      | {{#strpos
                                 | {{Units:{{#var|1}}}}
                                 | "            ^!category="
                        }}
             }}
}}

returned

Fatal error: Call to undefined function: hasparamnum() in /wiki/extensions/Winter.php on line 602

Thought you'd want to know. Simetrical 06:08, 9 January 2006 (UTC)

To clarify, I was trying to create a function that, given an input x, would go to the page "Units:x" (Units: is a namespace on the wiki I'm using) and return all text between

"|dictionary=                  "

and

"            |category="

(with no quote marks in the file). Simetrical 06:22, 9 January 2006 (UTC)

oops, there is a bug in the strpos code. I fixed it for the next release. The syntax of your function definition has quite a few errors in it though. You probably only want two } after each var call.. the set of 4 is actualy closing the strpos function before you tell it the string.. ie: your code translates to this: (strpos (var 1)) "string") when it should be (strpost, (var 1) "string) Frantik 02:02, 12 January 2006 (UTC)

actually, i see what you're trying to do.. you need to use a 'trans:' call to get the text of the wiki page. you also might want to use escape characters because mediawiki might try to trans {{#var|1}} instead of trans:(pagenane). Frantik 02:59, 12 January 2006 (UTC)

Thanks. I figured I may well have been doing something wrong, but I'm glad to hear I could help you fix a bug as well. What do you mean by a trans: call? {{trans:User:Frantik}}, for instance, just gives a redlink to Template:Trans:User:Frantik, and Help:Template makes no mention of a trans: prefix. Simetrical 05:20, 12 January 2006 (UTC)

You need to transclude the page. it's not done by trans: like i thought, just by prepending a : to the link (eg {{:User:Frantik}}) Frantik 09:01, 12 January 2006 (UTC)

Actually, transclusion works differently depending on the namespace.. your use is probably fine, though you still may want to use escape characters [Transclusion_costs_and_benefits] Frantik 09:28, 12 January 2006 (UTC)

[edit] Inefficiency

How resource-efficient is Winter? I would think a string-position search should take near-zero processing time regardless of string length, but a strpos of the form

{{#strpos|{{insert a page here}}
         | word
}}

seems to take forever if I don't get a server error. I'm worried that I'll exceed my server capacity if I use too many of these commands. Is this normal? Simetrical 06:51, 9 January 2006 (UTC)

Hmm I would expect it to take very little time as well. let me investigate. Frantik 01:50, 12 January 2006 (UTC)

I fixed this problem as well.. the error was created when strpos returned false. Your query was returning false due to your use of whitespace; strpos was searching for word</pre> and not just word. try this: {{#strpos|{{insert a page here}} | word }} instread. Unline most languages, whitespace IS important in Winter. This is because certain text formatting will cause Mediawiki to add html to it, before Winter sees the code --Frantik 02:15, 12 January 2006 (UTC)

On a more general note, I've tried to make Winter as resource efficient as possible. I also have made it a goal to never allow Winter to cause a server 500 error.. if you ever get one please let me know how you got it so i can fix it :) Frantik 02:41, 12 January 2006 (UTC)

Hmm, I've gotten a number of server 500 errors. I'll be sure to make a note of them in the future and tell you.

As for the specific strpos I mentioned, would adding quotes to the string allow me to split it up across lines? It's much easier to read that way for more complicated functions. Simetrical 05:22, 12 January 2006 (UTC)

since the problem is wikimedia adding formatting before winter sees it, you might try putting the code inside of a <nowiki> block. Frantik 09:05, 12 January 2006 (UTC)

[edit] Problems with Variablename

I have problems with variable some minus sign to have (example: super-param). This variables are not correctly recognized! --Thomas Klein 07:56, 6 February 2006 (UTC)

Only alphanumeric characters and _ are allowed in a variable name if you want to use the variable shortcut syntax (ie {{#varname | + | 1}} as opposed to {{#var | varname | + | 1 }}

try using "super_param" instead :)

Frantik 18:16, 11 February 2006 (UTC)

With _, i have the same problem. --Thomas Klein 11:43, 14 February 2006 (UTC)

When I add this to a page, it displays 2

{{#setvar s_1 1}}{{#s_1 + 1}}

I'm not sure why _ isn't working on your system. --Frantik 08:07, 16 February 2006 (UTC)

[edit] Simple questions

I have some questions. Can Winter variable be a string or only number? When I write template in Winter, can i use template parametr as Winter variable?

variable names and values can be numbers or strings. You can use template parameters just you you normally would in templates: {{#substr| {{{1}}} | 1 | 2}}

--Frantik 10:41, 24 March 2006 (UTC)

[edit] Arrays

I'm trying to get array functionality out of winter. I have a template with the following code in it:

<div style="border:solid #cccccc 1px;margin:0;padding:0;line-height:0;font-size:0;display:block;">
{{#setvar|width|{{{1}}}}}
{{#setvar|height|{{{2}}}}}
{{#for | {{#setvar|i|0}} || {{#i | < | {{#height}} }} || {{#i|++}}
|| {{#for | {{#setvar|j|0}} || {{#j | < | {{#width}} }} || {{#j|++}}
|| [[Image:^_(^_(^_({{#op | {{#i}} | * | {{#height}} | + | {{#j}} | + | 3}}^_)^_)^_)Tet.png]]
}}
<br/>
}}
</div>

The line in question here is the one with the wiki Image markup. What I'm looking to do is access the template parameter number (i*height)+j+3. This is just the math needed to store a matrix in a 1d array, with an offset since params 1 and 2 are width and height.
Right now a call like this:

{{WinterPlayingField|10|1|j|j|j|j| | |j|j|j|j}}

Evaluates like this:

[[Image:{{{3}}}Tet.png]][[Image:{{{4}}}Tet.png]][[Image:{{{5}}}Tet.png]][[Image:{{{6}}}Tet.png]][[Image:{{{7}}}Tet.png]][[Image:{{{8}}}Tet.png]][[Image:{{{9}}}Tet.png]][[Image:{{{10}}}Tet.png]][[Image:{{{11}}}Tet.png]][[Image:{{{12}}}Tet.png]]

If only those {{{x}}} were parsed by the template I'd have my solution! I already tried using ^( instead of ^_(, but that causes the curly braces to be interpreted wrong. Thanks in advance for your help.

this problem is occuring because the triple brace variable replacement only occurs once before control is passed to Winter. The best way to solve this is to set the parameters to Winter variables. Unfortunately you'll have to set them all explicitly, so the code will not allow for an unlimited amount of parameters.

Try this:

{{#setvar|param1|{{{1}}}}}
{{#setvar|param2|{{{2}}}}}
{{#setvar|param3|{{{3}}}}}
{{#setvar|param4|{{{4}}}}}
{{#setvar|param5|{{{5}}}}}
{{#setvar|param6|{{{6}}}}}
{{#setvar|param7|{{{7}}}}}
{{#setvar|param8|{{{8}}}}}
{{#setvar|param9|{{{9}}}}}
{{#setvar|param10|{{{10}}}}}
{{#setvar|param11|{{{11}}}}}
{{#setvar|param12|{{{12}}}}}

<div style="border:solid #cccccc 1px;margin:0;padding:0;line-height:0;font-size:0;display:block;">
{{#setvar|width|{{{1}}}}}
{{#setvar|height|{{{2}}}}}
{{#for | {{#setvar|i|0}} || {{#i | < | {{#height}} }} || {{#i|++}}
|| {{#for | {{#setvar|j|0}} || {{#j | < | {{#width}} }} || {{#j|++}}
|| [[Image:{{#var|param{{#op | {{#i}} | * | {{#height}} | + | {{#j}} | + | 3}}}}Tet.png]]
}}
<br/>
}}
</div>

--Frantik 08:48, 11 August 2006 (UTC)

[edit] Dynamic categories

I've been using (and loving) Winter now, but came across something I just haven't been able to do. In Winter, this code:

{{#if | {{#op {{{1}}} < 100 }} | [[Category:Value 0-99]]}}

doesn't parse as I'd like it. The hope is to create categories that group items together. Their value is sent to a template and the grouping/categories are done by the template.

The categories seem to be evaluated before winter gets to them, however. In the above example, all items are put in that category.

This:

[[{{#if | {{#op {{{1}}} < 100 }} | Category:Value 0-99]]}}]]

Adds either [[]] or [[Category:Value 0-99]] to the text of the article - it is not turned into a link or category note.

I've tried some other variations (using #if to add/remove <noinclude></noinclude> statements, for instance), but haven't had luck. It just seems every way I try the category check is done before Winter is run. I was hoping there was some way or another I could fool the system, but no luck so far. Is there any way this can be done with Winter (or some other tool you know off hand, if Winter runs too late in the process)?

I'm not sure if this is possible unfortunately --Frantik 22:35, 11 August 2006 (UTC)

[edit] Question on variable scoping

I couldn't find any description of variable scoping. Can I reference a varaiable defined outside of a function inside the function? For example:

<nowinter>

{{#setvar|rate|20}}
{{#function|foo||{{#var|rate}}}}
foo={{#foo}}
rate={{#rate}}

</nowinter>

Gives me:

 foo=
 rate=20

Variables are always local, never global. If you define one outside a function, you cannot use it inside the function, and vice-verse

--Frantik 10:58, 17 December 2006 (UTC)

Line 1643:
$ret = call_user_func($functionString[1],&$arr);
to
$ret = $functionString[1]($arr);

Line 1658
$ret = call_user_func($functionString[1],&$arr, $flag);
to
$ret = $functionString[1]($arr, $flag);

{{Article info
  | frameworks     = ISO 9000, ISO 20000
}}

<table>
  <tr style=' vertical-align: top;'>
    <th style="text-align: right;">Frameworks:</th>
    <td>
      {{#setvar | FW | {{{frameworks}}} }}
      {{#explode | , | {{#var|FW}} | myarr }}
      {{#foreach | myarr || [[:Category:{{#_v}}]] }}
    </td>
  </tr>
</table>

 Frameworks: 	[[:Category:ISO 9000]][[:Category: ISO 20000]]