Szablon:Listen/opis

Szablon {{Listen}} (ang. słuchaj) służy do osadzania w treści artykułów plików dźwiękowych i wideo.

Użycie

Ze względu na to, że pierwsza wersja szablonu została przekopiowana do polskojęzycznej Wikipedii w 2008 roku i od początku wykorzystywała angielskie nazwy parametrów, w nowszej wersji opartej o lua zachowano angielskie nazwy.

Najprostszy przykład

{{Listen
| filename    =
| title       =
| description =
| pos         =
}}

• filename (wymagane): nazwa pliku, bez przedrostka Plik:
• title (wymagane): tytuł pod jakim ma zostać wyświetlony utwór. Nie używaj cudzysłowów ani linków (pierwsze wykrzaczą szablon, drugie zwyczajnie się nie wyświetlą)
• description: opis/podpis pliku
• pos: pozycja szablonu (left lub right; domyślnie: right)

Wiele plików

Dodając cyfry do kolejnych parametrów można wywołać więcej niż jeden plik w tej samej ramce.

{{Listen
| filename     =
| title        =
| alt          =
| description  =
| filename2    =
| title2       =
| alt2         =
| description2 =
| filename3    =
| title3       =
| alt3         =
| description3 =
}}

• alt: tekst alternatywny, dla osób z zaburzeniami widzenia, niewidomych, słabowidzących itp. Wymagany przy plikach wideo. Tekst powinien opisywać nieruchome zdjęcie widoczne przed kliknięciem przycisku uruchamiającego odtwarzanie, nie całe wideo.

Dodatkowe parametry

Wyglądem szablonu można sterować za pomocą dodatkowych parametrów opisanych poniżej:

• type: zmienia ikonę widoczną po lewej stronie. Domyślnie jest to sound (dosł. dźwięk), dopuszczalne są także parametry speech (dla tekstu mówionego) oraz music (dla muzyki)
• header: pozwala na dodanie nagłówka do szablonu
• help: jeśli podany w formie help=no, nie wyświetli się link do pomocy dot. plików multimedialnych, widoczny na dole.
• image: pozwala na określenie innego obrazu niż wskazany jako plik. Na przykład |image=[[Plik:Example.jpg|50px]] wyświetli Plik:Example.jpg zamiast miniaturki podanego wideo. Można również ustawić |image=none, wtedy miniaturka nie wyświetli się w ogóle.
• style: Pozwala na podawanie dodatkowych parametrów stylu. Choćby float:none, float:none; clear:none (by dwa wywołania szablonu mogły występować obok siebie na stronie) itd.
• play: niektóre pliki multimedialne nie dają się wyświetlić w miniaturze na stronie. W takiej sytuacji użyj parametru play=no
• plain: wyłącza większość stylu w szablonie. Jeśli podasz parametr w formie plain=yes, szablon wyświetli się bez ramki, ikony i linków do pomocy, a także bez osadzenia po lewej lub prawej (przydatne, jeśli chcesz osadzić szablon w konkretnym miejscu zdefiniowanym w polu „style“ (na przykład style=float:right)).
• embed: w formie embed=yes służy dla łatwiejszego osadzenia go w innym szablonie, na przykład w infoboksie. Patrz przykłady poniżej.
• format (przestarzały): dawniej służył do podawania rozszerzenia pliku w formie linku do hasła o danym formacie. Obecnie nie wyświetla się, choć podanie go nie skutkuje wysypaniem się szablonu.

Przykłady użycia

prosty

{{Listen
| filename    = Accordion chords-01.ogg
| title       = Accordion chords
| description = Chords being played on an accordion
}}

wideo

{{Listen
| image       = [[File:Crystal Project video camera.png|50px]]
| help        = no
| filename    = Barack Obama inaugural address.ogv
| alt         = A black man in a black coat gestures and talks at a lecturn surrounded by teleprompters. Behind him, in the background, are about a dozen warmly-dressed onlookers.
| title       = Inaugural address of Barack Obama
| description = Barack Obama's [[First inauguration of Barack Obama|first inaugural address]], January 20, 2009<br />(Duration: 21 minutes, 21 seconds)
}}

Z nagłówkiem

{{Listen
| header      = Recordings of this phrase:
| type        = speech
| filename    = Frase de Neil Armstrong.ogg
| title       = "One small step for a man..."
| description = First words spoken on the [[Moon]].
}}

Czysty

{{Listen | filename = Accordion chords-01.ogg | title = Accordion chords | plain = yes | style = float:left }}

Wiele plików

{{Listen
| type         = music
| filename     = Accordion chords-01.ogg
| title        = Accordion chords
| description  = Chords being played on an accordion
| filename2    = Moonlight.ogg
| title2       = ''Moonlight Sonata''
| description2 = [[Ludwig van Beethoven|Beethoven]]'s [[Piano Sonata No. 14 (Beethoven)|Sonata in C-sharp minor]]
| filename3    = Brahms-waltz15.ogg
| title3       = Waltz No. 15
| description3 = From [[Sixteen Waltzes, Op. 39 (Brahms)|Sixteen Waltzes, Op. 39]] by [[Johannes Brahms|Brahms]]
}}

Parametry szablonu (strukturyzacja VE)

Szablon służy do osadzania w treści artykułów plików dźwiękowych i wideo.

Parametry szablonu

Dla tego szablonu preferowane jest formatowanie parametrów w bloku.

Parametr		Opis	Typ	Status
Plik	filename	Nazwa pliku, bez przedrostka Plik: Przykład Chopin-Etiuda Ges-dur-Greiss.ogg	Plik	wymagany
Tytuł	title	Tytuł pod jakim ma zostać wyświetlony utwór. Nie używaj cudzysłowów ani linków. Przykład Pieśń Legionów w wykonaniu Kiepury	Treść	wymagany
Opis	description	Opis/podpis pliku Przykład Pierwsze słowa wypowiedziane na [[Księżyc]]u	Treść	sugerowany
Pozycja	pos	Domyślnie right, akceptuje również left Domyślne right Przykład left Wartość automatyczna left	Wartość logiczna	opcjonalny
Alt	alt	tekst alternatywny, dla osób z zaburzeniami widzenia, niewidomych, słabowidzących itp. Wymagany przy plikach wideo. Tekst powinien opisywać nieruchome zdjęcie widoczne przed kliknięciem przycisku uruchamiającego odtwarzanie, nie całe wideo. Przykład Widok Ziemi z Księżyca, widoczne obie Ameryki i część Afryki, Europa schowana za chmurami. Wartość automatyczna	Treść	opcjonalny
Plik 2	filename2	Nazwa drugiego pliku, bez przedrostka Plik: Przykład Frederic Chopin - Opus 25 - Twelve Grand Etudes - G Flat Major.ogg	Plik	opcjonalny
Title2	title2	brak opisu	Nieznany	opcjonalny
Alt2	alt2	brak opisu	Nieznany	opcjonalny
Description2	description2	brak opisu	Nieznany	opcjonalny
Plik 3	filename3	Nazwa trzeciego pliku, bez przedrostka Plik: Przykład Przykład.wmv	Plik	opcjonalny
Alt3	alt3	brak opisu	Nieznany	opcjonalny
Title3	title3	brak opisu	Nieznany	opcjonalny
Description3	description3	brak opisu	Nieznany	opcjonalny
Ikona	type	zmienia ikonę widoczną po lewej stronie. Domyślnie jest to sound (dosł. dźwięk), dopuszczalne są także parametry speech (dla tekstu mówionego) oraz music (dla muzyki) Domyślne sound Przykład music	Treść	opcjonalny
Nagłówek	header	pozwala na dodanie nagłówka do szablonu Przykład Suity Chopina	Treść	opcjonalny
Pomoc	help	jeśli podany w formie help=no, nie wyświetli się link do pomocy dot. plików multimedialnych, widoczny na dole Domyślne yes Przykład no Wartość automatyczna no	Wartość logiczna	opcjonalny
Miniatura	image	pozwala na określenie innego obrazu niż wskazany jako plik. Na przykład image=[[Plik:Example.jpg|50px]] wyświetli Plik:Example.jpg zamiast miniaturki podanego wideo. Można również ustawić none, wtedy miniaturka nie wyświetli się w ogóle. Przykład Example.jpg	Treść	opcjonalny
Style	style	Pozwala na podawanie dodatkowych parametrów stylu. Choćby float:none, float:none; clear:none (by dwa wywołania szablonu mogły występować obok siebie na stronie) itd. Przykład float:none Wartość automatyczna	Treść	opcjonalny
Play	play	niektóre pliki multimedialne nie dają się wyświetlić w miniaturze na stronie. W takiej sytuacji użyj parametru play=no Domyślne yes Przykład no Wartość automatyczna no	Wartość logiczna	opcjonalny
Czysty	plain	wyłącza większość stylu w szablonie. Jeśli podasz parametr w formie plain=yes, szablon wyświetli się bez ramki, ikony i linków do pomocy, a także bez osadzenia po lewej lub prawej (przydatne, jeśli chcesz osadzić szablon w konkretnym miejscu zdefiniowanym w polu "style" (na przykład style=float:right). Przykład yes Wartość automatyczna	Wartość logiczna	opcjonalny
Osadź	embed	w formie embed=yes służy dla łatwiejszego osadzenia go w innym szablonie, na przykład w infoboksie. Patrz przykłady poniżej. Domyślne no Przykład yes Wartość automatyczna yes	Wartość logiczna	opcjonalny
Format pliku	format	dawniej służył do podawania rozszerzenia pliku w formie linku do hasła o danym formacie. Obecnie nie wyświetla się, choć podanie go nie skutkuje wysypaniem się szablonu. Przykład ogg Wartość automatyczna	Treść	przestarzały