Šablon:Calculator button/dok

Ovo je dokumentacijska podstranica za Šablon:Calculator button.
Sadrži informacije o upotrebi, kategorije i ostali sadržaj koji nije dio izvorne stranice šablona.

Ovaj je šablon zasnovan na Šablonu:Calculator.

Funkcionalnost ovog šablona omogućuju sljedeće spravice:

MediaWiki:Gadget-calculator.js

'Calculator button' komplementira {{Calculator}}. Služi za asocijaciju Calculator dugmadi s drugim Calculator elementima.

Za stvaranje obične poveznice u obliku dugmeta, koristite šablon {{Klikabilno dugme}}. Ovaj šablon se treba koristiti isključivo kao dio Calculator logike.

Upotreba

Nakon što se klikne, dugme izračuna vrijednost svog parametra formula i umetne rezultat u polje određeno parametrom for. Moguće je navesti više parova for/formula odvojenih točkom-zarezom (;).

Na primjer:

x = {{calculator|type=plain|id=x|default=0}}<br />
{{calculator button|contents=Dodaj 1|for=x|formula=x+1|type=plain}}

Stvara

x = 0
Dodaj 1

Sadržaj dugmeta smije sadržavati samo neinteraktivni tekstualni sadržaj (bez poveznica i bez <div> elemenata). Slike su dopuštene.

Dugmad s ponavljanjem

Ako je postavljen parametar delay ('odgoda'), dugme će se ponavljati svakih toliko sekundi. Najmanja vrijednost ovog parametra je pola sekunde (0.5). Ponavljanje traje dok se ne dostigne vrijednost parametra max iterations ili dok se ne zaustavi na drugi način (u protivnom se nastavlja beskonačno). U jednom trenutku ponavljati se može samo jedno dugme, pa pokretanje jednog ponavljajućeg dugmeta prekida sva ostala ponavljanja unutar istog Calculator kontejnera (pogledajte {{Calculator § Doseg identifikatora (scoping)}}). Ako je postavljen parametar toggle, ponovni klik na dugme zaustavlja ponavljanje. Parametar until može se koristiti za zaustavljanje ponavljanja kada neka formula postane istinita.

U formulama se također mogu koristiti funkcije timertime(), timer() i timeriterations() za dobivanje informacija o trenutačnom ponavljajućem dugmetu.

{{calculator button
|id=buttoncount
|contents=
	{{calculator
		|type=plain
		|formula=timer()
		|mapping={"Počni brojati":0,"Zaustavi brojanje": 1}
		|default=Počni brojati
	}}
|for=y
|type=progressive
|formula=y+1
|delay=0.5
|toggle=1
|max iterations=40
}}. Izbrojao sam do {{calculator|type=plain|id=y|default=0}} ukupno. Brojim već {{calculator|type=plain|formula=timertime(buttoncount)|default=?}} sekundi od zadnje pauze.

Stvara:

Počni brojati. Izbrojao sam do 0 ukupno. Brojim već ? sekundi od zadnje pauze.

Tipovi dugmadi

Prečica

{{Codex button}}

Zadana vrijednost parametra |type= jest plain. Izgled dugmadi tipa plain može se razlikovati ovisno o korisnikovom web pregledniku, operacijskom sustavu ili temi. Wikimedijin stilski priručnik Codex je za ovu komponentu omogućio 'CSS-only' verziju pogodnu za implementaciju na Wikipediji. {{Codex button}} služi kao omotač šablona 'Calculator button' s unaprijed postavljenim parametrom |type=default. Vrijednost default se odnosi na zadano (engleski: default) stanje Codex dugmeta kojeg prikazujemo, a alternativno se može naglasiti plavom ili crvenom bojom (pratite smjernice stilskog priručnika).

type	normal	primary	quiet	disabled
plain (bez Codexa)	Klikni ovdje			Klikni ovdje
default	Klikni ovdje	Klikni ovdje	Klikni ovdje	Klikni ovdje
progressive	Klikni ovdje	Klikni ovdje	Klikni ovdje	Klikni ovdje
destructive	Klikni ovdje	Klikni ovdje	Klikni ovdje	Klikni ovdje

Zadana vrijednost parametra |size= je medium, a za iznimne slučajeve može poslužiti i large (npr. ako dugme sadrži malu ikonu). Vrijednost parametra |alt= je alternativni tekst vidljiv čitačima zaslona. Treba ga koristiti samo ako tekst dugmeta ne objašnjava njegovu svrhu; u većini slučajeva bolje je da sadržaj dugmeta bude opisni tekst.

TemplateData

Ispod je pružena dokumentacija u formatu TemplateData koju koriste Čarobnjak za šablone, Vizualni uređivač i drugi alati.

TemplateData za šablon Calculator button

Stvara dugme za interakciju s ostalim Calculator elementima.

Parametri šablona[Uredi podatke o šablonu]
Parametar		Opis	Vrsta	Status
for	`for`	ID Calculator polja na koje ovo dugme djeluje u formula-načinu rada.	tekst	predloženo
formula	`formula`	Formula kojom se postavlja vrijednost polja zadanog parametrom for. Primjer x+1	tekst	predloženo
contents	`contents` `1`	Sadržaj dugmeta. Primjer Klikni ovdje	wikitekst	predloženo
type	`type`	Stil dugmeta. Zadano je "plain". Vrijednost "default" znači Codex dugme tipa default, a ne zadanu vrijednost ovog šablona. Predložene vrijednosti `plain` `default` `progressive` `destructive` Zadano plain Primjer progressive	tekst	predloženo
id	`id`	ID HTML elementa dugmeta.	tekst	neobavezno
alt	`alt`	Alt tekst za čitače zaslona. Koristiti samo ako tekst dugmeta nije dovoljno jasan.	tekst	neobavezno
class	`class`	Dodatne CSS klase za dugme. Ako želite da izgleda kao dugme i kada je gadget isključen, dodajte "cdx-button cdx-button--fake-button cdx-button--fake-button--enabled".	tekst	neobavezno
class-live	`class-live`	Dodatne CSS klase koje se dodaju samo kada je Calculator gadget uključen.	tekst	neobavezno
disabled	`disabled`	Formula koja određuje treba li dugme biti onemogućeno. Dugme je onemogućeno kada formula vrati true.	tekst	neobavezno
size	`size`	Veličina Codex dugmeta. Predložene vrijednosti `medium` `large` Zadano medium	tekst	neobavezno
style	`style`	Dodatni CSS stil za dugme.	tekst	neobavezno
title	`title`	Tooltip za dugme.	tekst	neobavezno
weight	`weight`	Težina odnosno vizualni naglasak Codex dugmeta. Ne primjenjuje se na plain dugmad. Predložene vrijednosti `normal` `primary` `quiet` Zadano normal Primjer primary	tekst	neobavezno
role	`role`	ARIA uloga dugmeta. Obično je nije potrebno postavljati.	kratak tekst	neobavezno
aria-live	`aria-live`	Vrijednost aria-live atributa. Kontrolira objavljuju li čitači zaslona promjene. Predložene vrijednosti `off` `polite` `assertive`	kratak tekst	neobavezno
delay	`delay`	Pretvara dugme u ponavljajuće dugme. Vrijeme između ponavljanja u sekundama; najmanje 0.5.	broj	neobavezno
max iterations	`max iterations`	Koliko puta se dugme ponavlja. Vrijednost 0 prekida trenutno ponavljanje. Ako nije postavljeno, smatra se beskonačno ako je delay postavljen, inače 1.	broj	neobavezno
toggle	`toggle`	Za ponavljajuća dugmad: drugi klik zaustavlja ponavljanje.	uvjetni izraz	neobavezno
until	`until`	Ponavljaj dok ova formula ne postane istinita. Parametar delay mora biti postavljen.	tekst	neobavezno
target	`target`	Identifikator drugog Calculator containera na koji se dugme odnosi. Vrijednost treba odgovarati atributu id ili data-calculator-id ciljnog containera.	kratak tekst	neobavezno
action	`action`	Pokreće imenovanu akciju dugmeta umjesto formula-načina rada. Podržani su "search", "create" i "categorymembers". Predložene vrijednosti `search` `create` `categorymembers` Primjer create	kratak tekst	neobavezno
method	`method`	Način izvršenja za action-dugmad. "open" otvara odgovarajuću wiki-radnju, a "post" pokušava odmah spremiti izmjenu. "post" se koristi uz action=create. Predložene vrijednosti `open` `post` Zadano open Primjer post	kratak tekst	neobavezno
expandfrom	`expandfrom`	Ime Calculator polja koje sadrži wikitext za proširivanje prije post radnje. Koristi se uz action=create i method=post. Prošireni rezultat mora biti strukturirani JSON odgovor koji gadget koristi za edit-parametre. Primjer draft_registry_maintenance_request	kratak tekst	neobavezno
required-right	`required-right`	Korisničko pravo koje korisnik mora imati da bi se action-radnja izvršila. Ako pravo nedostaje, radnja se prekida prije API zahtjeva. Primjer patrol	kratak tekst	neobavezno
success-target	`success-target`	ID HTML elementa koji se prikazuje nakon uspješne post radnje. Koristi se uz action=create i method=post. Ako nije zadan ili element nije pronađen, prikazuje se zadana mw.notify poruka. Primjer post-success-message	kratak tekst	neobavezno
error-target	`error-target`	ID HTML elementa koji se prikazuje ako post radnja ne uspije. Koristi se uz action=create i method=post. Ako nije zadan ili element nije pronađen, prikazuje se zadana mw.notify poruka. Primjer post-error-message	kratak tekst	neobavezno
success-notification	`success-notification`	Tekst prilagođene mw.notify poruke koja se prikazuje nakon uspješne post radnje ako nije zadan ili nije pronađen success-target. Primjer Zahtjev je uspješno poslan. Osvježite stranicu.	tekst	neobavezno
error-notification	`error-notification`	Tekst prilagođene mw.notify poruke koja se prikazuje ako post radnja ne uspije i ako nije zadan ili nije pronađen error-target. Primjer Dogodila se pogreška pri slanju zahtjeva. Provjerite unos, uvjerite se da imate ovlasti za uređivanje stranice i pokušajte ponovo.	tekst	neobavezno
disable-after-success	`disable-after-success`	Ako je postavljeno na istinitu vrijednost, dugme ostaje onemogućeno nakon uspješne post radnje. Korisno za jednokratne radnje poput slanja zahtjeva. Primjer 1	uvjetni izraz	neobavezno
reload-after-success	`reload-after-success`	Ako je postavljeno na istinitu vrijednost, stranica se ponovno učitava nakon uspješne post radnje. Primjer 1	uvjetni izraz	neobavezno
success-pagefrom	`success-pagefrom`	Ime Calculator polja koje sadrži naslov stranice koja se otvara nakon uspješne post radnje. Primjer success_page	kratak tekst	neobavezno
success-extra-params	`success-extra-params`	Dodatni URL parametri koji se dodaju stranici otvorenoj pomoću success-pagefrom nakon uspješne post radnje. Primjer action=history	kratak tekst	neobavezno
results-target	`results-target`	ID HTML elementa u koji se ispisuju rezultati action=categorymembers. Primjer category-results	kratak tekst	neobavezno
results-wrapper	`results-wrapper`	HTML oznaka kojom se omataju rezultati action=categorymembers, npr. ul, ol ili div. Predložene vrijednosti `ul` `ol` `div` Primjer ul	kratak tekst	neobavezno
exclude-selector	`exclude-selector`	CSS selektor za elemente koje action=categorymembers treba isključiti iz rezultata ili obrade. Primjer .hidden, .noinclude	tekst	neobavezno
autoload	`autoload`	Ako je postavljeno na istinitu vrijednost, action=categorymembers se automatski pokreće nakon učitavanja Calculatora. Primjer 1	uvjetni izraz	neobavezno
max-results	`max-results`	Najveći broj rezultata koje action=categorymembers ili prepare=category-revision-snapshot smije obraditi. Stvarni gadget može imati tvrdu gornju granicu. Primjer 500	broj	neobavezno
strip-namespace	`strip-namespace`	Ako je postavljeno na istinitu vrijednost, action=categorymembers prikazuje naslove bez imenskog prostora. Primjer 1	uvjetni izraz	neobavezno
queryfrom	`queryfrom`	Ime Calculator polja iz kojeg se uzima glavni tekst za action-dugme. Kod action=search to je tekst upita, kod action=create naslov ciljne stranice, a kod action=categorymembers naslov kategorije. Primjer upit	kratak tekst	neobavezno
namespaces	`namespaces`	Popis imenskih prostora koje treba uključiti u pretragu ili dohvat članova kategorije, odvojen pomoću ; ili {{!}}. Navode se pomoću engleskih ili lokalnih naziva/aliasa, odnosno brojčanim identifikatorima. Pogledajte tabelu u [[Wikipedija:Imenski prostor]]. Primjer 0;10;14	kratak tekst	neobavezno
search-page	`search-page`	Posebna stranica kojom se izvršava pretraga. Zadano Special:Search	naziv stranice	neobavezno
search-param	`search-param`	Ime GET parametra u koji se upisuje tekst iz polja queryfrom. Ako nije zadano, koristi se search. Pogledajte Help:CirrusSearch na MediaWiki wikiju. Zadano search Primjer prefix	kratak tekst	neobavezno
extra-params	`extra-params`	Dodatni parametri u obliku query stringa, npr. key=value&key2=value2. Za action=search tretiraju se kao URL parametri pretrage. Za action=create koriste se za dodatne parametre akcije, npr. prefix, summary, preloadfrom ili summaryfrom. Uz method=post mogu se koristiti i textfrom, prependfrom ili appendfrom. Parametri sa završetkom from upućuju na ID drugog Calculator polja iz kojeg se uzima vrijednost. Za dodavanje teksta u sekciju po naslovu može se koristiti section-mode=title uz sectiontitlefrom i appendfrom. Ako se doda missing-section=create, sekcija se stvara ako ne postoji; inače se nedostajuća sekcija tretira kao greška. Primjer section-mode=title&missing-section=create&sectiontitlefrom=section_title&appendfrom=items	kratak tekst	neobavezno
prepare	`prepare`	Ime pripremne radnje koja se izvršava prije action-radnje. Pripremna radnja može dohvatiti podatke preko API-ja i popuniti Calculator polja prije nastavka standardne radnje. Predložene vrijednosti `category-revision-snapshot` Primjer category-revision-snapshot	kratak tekst	neobavezno
prepare-category	`prepare-category`	Naslov kategorije koju koristi prepare=category-revision-snapshot. Primjer Kategorija:Nacrti članaka u izradi	naziv stranice	neobavezno
prepare-namespace	`prepare-namespace`	Imenski prostor kojim se ograničava prepare=category-revision-snapshot. Može biti brojčani ID, engleski naziv, lokalni naziv ili alias imenskog prostora. Primjer Nacrt	kratak tekst	neobavezno
prepare-target	`prepare-target`	Ime Calculator polja u koje se upisuje rezultat pripremne radnje. Primjer draft_registry_maintenance_request	kratak tekst	neobavezno
prepare-template-from	`prepare-template-from`	Ime Calculator polja koje sadrži predložak teksta u koji se umeće rezultat pripremne radnje. Placeholder __CALCULATOR_PREPARE_RESULT__ zamjenjuje se JSON rezultatom pripreme, a konačni tekst se upisuje u polje zadano parametrom prepare-target. Primjer draft_registry_maintenance_request_template	kratak tekst	neobavezno
prepare-include-redirects	`prepare-include-redirects`	Ako je postavljeno na istinitu vrijednost, prepare=category-revision-snapshot uključuje i preusmjerenja. Ako nije postavljeno, preusmjerenja se preskaču. Primjer 1	uvjetni izraz	neobavezno