Template:Macro/hr

Upotreba
Ovaj predložak je glavni alat za dokumentiranje makronaredbe. Trebao bi biti umetnut kao prvi redak na stranicama dokumentacije, nakon i oznake. See a sample to the right.

Potrebni parametri su:

Ostali parametri mogu biti izostavljeni ili njihova vrijednost ostavljena prazna.

Potrebni parametri
Parametri se navode s vrijednošću nakon znaka jednakosti,.

Svaki parametar na popisu odvojen je simbolom cijevi. |... |Name=SomeMacro|Author=WikiUserName| ... Parametri mogu biti smješteni u istom retku, ili svaki u zasebnom retku. |...
 * Name=SomeMacro
 * Author=WikiUserName

Potrebni su sljedeći parametri.


 * Name
 * Ispravno kapitalizirano ime makronaredbe koja će se dokumentirati.
 * Naziv se koristi za dohvaćanje ikone  ili   iz wiki repozitorija. Predložak radi ispravno ako ikona ne postoji; u ovom slučaju, generička ikona [[Image:Text-x-python.png|24px]] prikazuje se.


 * Description
 * Opis makronaredbe, ovaj opis će biti prikazan u Addon manager.


 * Author
 * Autor makronaredbe. Ovo ime je povezano s korisnikovom stranicom u wikiju, to jest, User: Author. Budući da makronaredbe nisu dio službenog FreeCAD koda, korisnici bi trebali usmjeriti svoja pitanja o njima određenim kreatorima. Autor makronaredbe trebao bi biti dostupan u forum, s istim korisničkim imenom kao na wikiju.


 * Date
 * Svi makroi moraju imati datum. Ovo je korisno za označavanje posljednjeg puta kada je makronaredba izmijenjena i upozorava korisnika na dob koda. Makroi koji su vrlo stari mogu biti zastarjeli i možda neće raditi s novijom verzijom FreeCAD-a.

Izborni parametri
Sljedeći parametri su opcionalni. Ako nisu uključeni u predložak, prikazat će zadanu vrijednost.
 * Translate
 * Ime prevedeno na vaš jezik koje će biti prikazano u naslovu prozora. Na primjer


 * Version
 * Verzija makronaredbe. Ako nema vrijednosti, ona će biti zadana za . To je korisno za autore, tako da mogu dokumentirati određene verzije svojih makronaredbi.


 * Shortcut
 * Neki makroi mogu uvesti prečace za pokretanje određenih alata. Označite tipke prečaca kako biste pritisnuli ovu vrijednost. Ako nema vrijednosti, zadana je vrijednost None.


 * SeeAlso
 * Neobavezne veze na druge srodne naredbe, na primjer,.


 * Icon
 * Slikovna datoteka različita od  ili   za upotrebu kao ikone. To se može koristiti za uključivanje određene ikone koja nije nazvana po naredbi, na primjer,