Template:Doc

Izvor: Valve Developer Community
Prijeđi na navigaciju Prijeđi na pretraživanje
Warning icon.png
Ovaj se predložak koristi na mnogim stranicama i promjene se mogu primijetiti.

Testirajte promjene na /sandbox ili /testcases podstranicama predloška, ili na vlastitoj korisničkoj podstranici..
Razmislite o raspravi o izmjenama na stranica za razgovor prije njihove implementacije.

Dodatne informacije:
Over 1800+ template pages are using this template
Todo: Exclude Sandbox subpage and other from this template. Also do some code cleanup.
English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Icon-translate.png Available doc translations
Vidi
Povijest stranice
Icon-translate.png
Ovaj predložak koristi niz podstranicu
Za dodavanje prijevoda slijedite format na ovoj podstranici.
Broj nizova:16
Približan status prijevoda:English (en) 100% Deutsch (de) 43.75% Español (es) 50% Esperanto (eo) 50% Hrvatski (hr) 100% 日本語 (ja) 6.25% 한국어 (ko) 6.25% Ქართული (ka) 12.5% Nederlands (nl) 6.25% Polski (pl) 6.25% Português (pt) 6.25% Português do Brasil (pt-br) 6.25% Русский (ru) 68.75% Українська (uk) 6.25% Tiếng Việt (vi) 25% 中文 (zh) 93.75% 

Predložak {{doc}} dizajniran je za dodavanje bloka dokumentacije različitim stranicama (uglavnom stranicama predložaka). Podstranice određenog jezika učitavat će se u blok dokumentacije ovisno o jeziku korisničkog sučelja. U slučaju engleskog, dokumentacija će biti preuzeta iz /doc podstranica. Ali u svim drugim slučajevima, dokumentacija će biti preuzeta s podstranice /doc/<lang code>

Alati

Glavni alati nalaze se gore desno, iznad bloka dokumentacije:

  • Create – otvara stranicu za izradu dokumentacije. Pojavljuje se samo ako stranica s dokumentacijom ne postoji.
Note.pngNapomena:Ako nema nijedne dokumentacije, gumb će učitati dokumentaciju za prethodno učitavanje, Template:Doc/preload ili Template:Doc/preload/<jezik kod> (ako jezik korisničkog sučelja nije na engleskom i ako postoje prijevodi stranice za predučitavanje), kao sadržaj nove stranice i otvorite stranicu za uređivanje. Ako postoji dokumentacija na engleskom jeziku, gumb će unaprijed učitati dokumentaciju na engleskom kao sadržaj.
  • View – otvara stranicu s dokumentacijom.
  • Edit – otvara stranicu za uređivanje dokumentacije.
  • History – otvara povijest promjena na stranici dokumentacije.
Note.pngNapomena:Ako ne postoji nijedan od gore navedenih alata, tada je tekst dokumentacije napisan korištenjem parametra {{{content}}} ili je parametar {{{tools}}} postavljen na 0.

Također, u gornjem desnom kutu nalazi se gumb označen elipsom [ ]. Proširuje/sažima dodatne alate:

  • Sandbox – otvara izradu podstranice /sandbox i kopira kod izvorne stranice ili, ako ta stranica postoji, jednostavno je otvara.
  • Testcases – otvara /testcases podstranica. Korisno za testiranje predloška u različitim situacijama.
  • Subpages – otvara Special:PrefixIndex i umeće naziv stranice za traženje svih podstranica.
  • Purge – otvara prozor s porukom o čišćenju stranice.

Jezična traka

Gore desno, ispod alata, nalaze se zastavice koje prebacuju dokumentaciju na drugi jezik. Prebacivanje se provodi umetanjem &uselang=<jezik kod> u vezu stranice, pa ako kliknete na drugi jezik , tada će se zajedno s dokumentacijom promijeniti i jezik sučelja.

Ako nema dokumentacije na određenom jeziku, prikazat će se poruka “Stranica s dokumentacijom <stranica> ne postoji”. ako je {{{pagespace}}} ili stvarni prostor stranice User, tada se pojavljuje poruka “<korisnik> nije dao podatke o sebi na ovom jeziku (<stranica>).” umjesto toga će se prikazati. Također, nakon ove poruke će se prikazati dokumentacija na engleskom jeziku, ukoliko postoji.

Parametri

  • {{{1}}}: parametar za promjenu dodjele predloška:
    • Ako trebate standardni blok dokumentacije, nemojte ništa unositi u ovaj parametar.
    • 0 – prikazat će poruku “Ovo je dokumentacijska podstranica za <stranica>”.
    • 1 – prikazat će poruku “Ovo je podstranica sandboxa za <stranica>”.
    • 2 – prikazat će poruku “Ova stranica nije sandbox”.
    • 3 – prikazat će poruku “Ovo je info podstranica <page>”. Korisno za korisničke podstranice.
    • 4 – prikazat će poruku "Ovo je podstranica dokumentacije za korištenje na više stranica". Ako se koristi parametar {{{list}}}, tada će tekst biti: “Ovo je dokumentacijska podstranica za korištenje na više stranica navedenih u <stranica popisa>”.
  • {{{list}}}: specificira stranicu ili kategoriju koja ispisuje stranice koristeći određenu stranicu dokumentacije. Koristi se samo ako je parametar {{{1}}} postavljen na 4.
  • {{{docpage}}}: stranica koja će se koristiti kao dokumentacija.
  • {{{content</lang code>}}}: sadržaj koji će se koristiti kao dokumentacija, umjesto posebne stranice. Kada se koriste, glavni alati su skriveni.
  • {{{pagespace}}}: prostor stranice određuje se automatski, ali možete unijeti vlastiti. Tekst u zaglavlju ovisi o ovom parametru:
    • Template → “Dokumentacija predloška”
    • File → “Sažetak”
    • User → “Oko”
    • U svim drugim slučajevima to će biti "Dokumentacija"
Note.pngNapomena:ako je {{{pagespace}}} ili stvarni prostor stranice "Korisnik", tada će tekst biti preuzet s podstranice /about, a ne /doc.
  • {{{tools}}}: kontrolira koji gumbi alata trebaju biti prikazani:
    • 0 – bez gumba.
    • 1 – samo gumbi “Stvori”, “Prikaži”, “Uredi” i “Povijest”.
    • U svim ostalim slučajevima tu će biti svi gumbi

Izrada dokumentacije

Warning.pngWarning:Ako želite dodati simbol “|” negdje u tekstu (predlošci i drugi elementi MediaWikija nisu zahvaćeni), koristite &#124;.

Kako biste započeli izradu dokumentacije, kliknite na gumb "Izradi" u gornjem desnom kutu. Gumb učitava unaprijed učitani dokument (ili kao unaprijed učitani dokument ako postoji engleski dokument). Zatim se ispisuje sam tekst dokumentacije. Prvo je kratak opis, a zatim - ovisno o tome za što je dokumentacija napisana. Ako želite dodati kategorije, samo ih dodajte tamo gdje je navedeno u dokumentaciji za prethodno učitavanje.

Podstranice

Postoje neke podstranice i podpredlošci na {{Doc}}. Oni su stvoreni da olakšaju stvari.

{{Doc/subpage}}

Ovaj predložak je zamjena za <noinclude>{{doc|0}}</noinclude>. Može biti umjesto <noinclude>{{doc|0}}</noinclude>.

Namjena mu je ista kao {{Documentation subpage}}.

Može izbjeći problem da se predučitana stranica ne učitava <noinclude>{{doc|0}}</noinclude>.

{{Doc/Sandbox other}}

Ovaj predložak dodaje sadržaj zasebno glavnom predlošku i njegovim podstranicama (dokumentima). Korisno je za dodavanje kategorija.

Namjena mu je ista kao {{Sandbox other}}.

Template:Doc/preload

Ovo je stranica koja se predučitava kada kliknete gumb za stvaranje. Možete mu dodati prijevode.

{{Doc/PreviewBlock}}

Zastarjelo. Umjesto toga koristite {{Capsule}}.

Template:Doc
Logo-template.png
Summary
Uključuje podstranicu dokumentacije
Type
Predložak za omot
Contributors
N/B
Creation date
22/08/2022
(22. kolovoza 2022)
Notes
N/B
Subpages
Documentation
Preload
Sandbox
Strings
Testcases
N/B
Revision information
Latest editor
THE OWL
Last edited
17/11/2024
20241117020633
Revision size
12479 bytes
12.479 kilobytes
0.012479 megabytes
Technical information
Page identifier
47769
Contains translations
Da
Uses parser functions?
Da
Uses variables?
Da