Extension:Variables
 Status wydania: stabilne |
|
|---|---|
| Realizacja | Funkcja parsera |
| Opis | Dodaje funkcje parsera, obsługujące zmienne z zasięgiem do końca strony. |
| Autor(zy) |
|
| Opiekun(owie) | MGChecker |
| Ostatnia wersja | 2.5.2 (2019-07-11) |
| MediaWiki | 1.29+ |
| PHP | 5.5+ |
| Zmiany w bazie danych | Nie |
| Licencja | ISC License |
| Pobieranie | README RELEASE-NOTES |
|
|
| Przetłumacz rozszerzenie Variables jeżeli jest dostępne na translatewiki.net | |
| Sprawdź wykorzystywanie i matrycę wersji. | |
| Rola Vagrant | variables |
| Problemy | Otwarte zadania · Zgłoś błąd |
Rozszerzenie "Variables" pozwala na zdefiniowanie zmiennych na stronie i późniejsze wykorzystanie ich na tej samej stronie oraz w użytych na niej szablonach. Wartości zmiennych mogą być następnie modyfikowane bezpośrednio, przez przypisanie wprost nowej wartości lub za pomocą wbudowanych funkcji oprogramowania Wiki (np. funkcje parsera) oraz innych rozszerzeń.
Zmienne działają podobnie do szablonów, z tą jednak różnicą, że, wpływają tylko na stronę, na której są używane, a nie na całą wiki. Można użyć na stronie wiele zmiennych bez obawy o spowolnienie działania ("zamulenie") wiki dużą liczbą załączonych szablonów. Najlepsze rezultaty daje używanie rozszerzenia "Variables" w połączeniu z rozszerzeniem ParserFunctions.
Przypisanie wartości do zmiennej
#vardefine
{{#vardefine:nazwa_zmiennej|przypisana_wartość}}
Przypisuje zmiennej nazwa_zmiennej (nowej lub już istniejącej) wartość przypisana_wartość.
- Przykład:
{{#vardefine:iconwidth|25}}
przypisuje zmiennej iconwidth wartość 25
#vardefineecho
{{#vardefineecho:"nazwa_zmiennej"|"przypisana_wartość"}}
Działa tak samo, jak #vardefine, z tą różnicą, że zwraca wartość zmiennej na ekran.
- Przykład: making iconwidth = <code>{{#vardefineecho:iconwidth|25}}</code>
Pobieranie wartości zmiennej (#var)
#var
Wartość zmiennej nazwa_zmiennej jest wyświetlana przez
{{#var:nazwa_zmiennej}}
Jeżeli zmienna nie została zdefiniowana, to wyrażenie to zwróci pusty ciąg znaków bez komunikatu o błędzie.
Można określić domyślną wartość, która zostanie użyta w przypadku gdy zmienna nie została zdefiniowana lub jest pusta.
{{#var:nazwa_zmiennej | "wartość_domyślna" }}
Jest to równoważne:
{{#if: {{#var:"nazwa_zmiennej"}} | {{#var:"nazwa_zmiennej" }} | "wartość_domyślna" }}
ale jest krótsze i bardziej czytelne. W wersjach starszych niż 2.0 wartość domyślna zawsze była wyświetlana (rozwijana). Począwszy od wersji 2.0 jest wyświetlana jedynie wtedy, kiedy jest faktycznie potrzebna.
Wartość może zostać użyta np. z funkcją parsera.
#varexists
{{#varexists:"nazwa_zmiennej" }}
zwraca "1" gdy zmienna jest już zdefiniowana (także wtedy gdy jest pusta). Gdy zmienna nie jest zdefiniowana zwraca wartość pustą.
It supports a second and a third parameter to replace these values.
{{#varexists:variablename | if-value | else-value }}
This is equivalent to:
{{#if: {{#varexists: variablename }} | if-value | else-value }}
but it is much shorter and better arranged. Before version 2.5 though, both were always expanded. From version 2.5 on the if and else values only get expanded when their cases are actually entered.
#var_final
Jest to funkcja eksperymentalna wprowadzona w wersji 2.0. Funkcja zwraca ostateczną wartość zmiennej uzyskaną po przetworzeniu całego kodu strony. W związku z powyższym funkcja nie może zostać wykorzystana w innych funkcjach.
{{#var_final:"nazwa_zmiennej" | defaultvalue}}
Wartość domyślna zostanie użyta wtedy, gdy w wyniku przetworzenia całego kodu strony zmienna albo nie została zdefiniowana albo jest pusta. Wartość domyślna zawsze zostanie wyświetlona na ekranie w miejscu, w którym użyto tej funkcji, niezależnie od tego, czy rzeczywiście jest potrzebna.
Przykłady
W celu użycia #expr niezbędne jest wcześniejsze zainstalowanie rozszerzenia ParserFunctions.
Oblicz x = 2*a + b:
{{#vardefine:x|{{#expr:2*{{#var:a}}+{{#var:b}}}}}}
Dodaj 1 do "n":
{{#vardefine:n|{{#expr:{{#var:n}}+1}}}}
Instalacja
- Pobierz i umieść plik(i) w katalogu o nazwie
Variablesw swoim kataloguextensions/.
- Dodaj poniższy kod na dole swojego pliku LocalSettings.php:
wfLoadExtension( 'Variables' );
- Configure as required
Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.
Do użytkowników mających wersję MediaWiki 1.30 lub wcześniejszą:
Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia, poprzez wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.30 i wcześniejsze), zamiast wfLoadExtension( 'Variables' ); użyj:
require_once "$IP/extensions/Variables/Variables.php";
Configuration
This extension provides two configuration parameters:
$egVariablesAreVolatile- Allows to disable the parser frame being marked as volatile by the extension, i.e. disable template caching.
- Default:
true; $egVariablesDisabledFunctions- Allows to disable specified parser functions provided by this extension.
- Default:
[]; - Example:
[ 'var_final', 'vardefineecho' ];
Compatibility
The recommended version of the Variables extension for recent MediaWiki releases is listed below. Older versions of the extensions might work as well, but aren't tested for new MediaWiki releases.
| 1.19 | 1.20 | 1.21 | 1.22 | 1.23 | 1.24 | 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | master | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2.x | 2.1.x | 2.2.x | 2.5.x, master | ||||||||||||||
Alternatives
As this extension will not be enabled for wikis run by the Wikimedia Foundation (WMF)[1][2][3][4], here are some alternatives:
- If you use Variables as cache for expensive operations, you can transform the section where you need them into a template and pass the required information as template parameters instead. This will work until you reach the expansion depth limit.
- If you use Variables to do more complex template operations than possible with simple ParserFunctions, you can use Scribunto's Lua functionality instead. Note that this does not add support for global Variables. However, Extension:VariablesLua adds a Scribunto interface for the Variables store.
- Don't use variables, instead duplicate the information you need as a variable. If that information is acquired by an expensive template call, performance may suffer. This will work until you reach the node count limit.
Zobacz też
- Extension:PhpTags
- Extension:MyVariables - * Extension:DynamicFunctions##arg:
- Extension:MyVariables - dostarcza nowe "magiczne słowa"
- Extension:Loops - umożliwia tworzenie pętli
- Extension:Arrays - umożliwia tworzenie tablic i przeprowadzanie operacji na nich
- Extension:HashTables - dodatkowa funkcja parsera umożliwiająca tworzenie tablic mieszających (hash tables)
- Extension:Loops - Provides parser functions for performing loops
- Extension:Arrays - Create an array and provide array functions (such as search, split, and sort) and set operations (such as intersect, union and diff)
- Extension:HashTables - New parser functions for handling hash tables in MediaWiki
References
- ↑ 1.0 1.1 phab:T9865
- ↑ 2.0 2.1 phab:T65324
- ↑ 3.0 3.1 phab:T113859
- ↑ 4.0 4.1 phab:T151192