Ede: Modèl manyèl

Soti nan Wikipedia, ansiklopedi gratis.
Ale nan navigasyon Ale nan rechèch
Manyèl yo te itilize pou syèk men yo toujou trè itil

Modèl yo se yon karakteristik trè pwisan nan lojisyèl MediaWiki , men yo ka difisil pou nouvo itilizatè yo itilize, e menm ekspè yo ka gen pwoblèm pou konprann ki jan pi konplèks yo travay. Pou rezon sa a, modèl yo ta dwe toujou vini ak yon manyèl itilizatè, lizib sou paj la modèl tèt li.

Manyèl la dwe eksplike ki sa yon modèl fè ak kouman yo sèvi ak li, nan yon fason ase klè menm pou itilizatè ki pa ekspè nan modèl sentaks pwogramasyon, pa kèk menm nan mitan veteran Wikipedia.

Osi lwen ke estrikti a konsène, tout manyèl yo ta dwe konfòme yo otank posib ak gid sa a, yo nan lòd pou yo eseye estandadize fonctionnalités li yo ak aparans grafik.

Gnome-help.svg - Enfòmasyon Biwo

Ki sa ki enkli nan manyèl la

Yon manyèl modèl ta dwe gen ladan:

  • Objektif la nan modèl la: rezilta a, si li pa imedyatman evidan, itilite a, ansanm ak deskripsyon ki kalite paj ak atik pou ki li posib oswa ou pa posib yo sèvi ak yo.
  • Paramèt modèl yo : si li sifi pou endike yo sekans oswa si yo ta dwe klèman rele yo, si yo obligatwa oswa si ou vle, ki valè yo pèmèt pou chak paramèt, ki valè default ak ki efè yo genyen. Tout bagay sa yo dwe eksplike klèman, pou tout paramèt.
  • Kit modèl la ka ak / oswa yo ta dwe poste oswa ou pa.
  • Egzanp Itilizasyon : endikasyon kòd lang wiki egzak la ki ta dwe itilize ak rezilta li pwodui. Egzanp lan ta dwe enkli ant <code>...</code> , pou fè li klè e fasil pou kopye, tankou:
    {{non firmato|pinco pallino|01:19, 13 set 2010}}
    Si modèl la ka itilize nan plizyè fason diferan, avèk oswa san paramèt si ou vle, yo ta dwe bay egzanp apwopriye. Li kapab trè itil pou mete modèl li menm nan manyèl ou de twa fwa, nan plizyè egzanp reyèl, ak diferan paramèt, ki endike menm bagay la.
  • Paj ki gen rapò yo : si modèl la fè pati yon seri, enkli wikilinks lòt modèl yo nan menm seri a, nan lòd pou fè navigasyon pi fasil (yon modèl navigasyon espesyal kapab itil). Sepandan, modèl ki sanble yo dwe endike, ak diferans yo nan lòd yo chwazi youn ki pi apwopriye. Finalman, li nesesè pou endike paj èd, direktiv ak pwojè ki itil pou konprann kouman pou itilize modèl la.

Kreye yon manyèl

Dokiman modèl la souvan ekri nan yon subpaj modèl tèt li ki enkli lè sa a nan fen kòd modèl la.
Pou kreye yon manyèl, asire w ke paj modèl la pa deja prezan nan modèl la: service man ( {{ man }} ). Si absan, mete l ant <noinclude></noinclude> (pou anpeche manyèl la rapòte nan paj ki itilize modèl la), sove paj la epi klike sou mo Kreye enstriksyon yo! .

Manyèl la se eleman nan yon sub-paj paske nan fason sa a se kòd la souvan konplèks separe de dokiman an, ki fè pati nan dokiman pi fasil yo konpile ak jere. Li pèmèt tou pwoteksyon pi fasil nan kòd modèl la, kote sa nesesè, pandan y ap kite nenpòt moun posiblite pou modifye oswa entegre manyèl la.

Edite yon manyèl

Menm si modèl la pwoteje, manyèl la ka toujou modifye

Manyèl Modèl ka toujou modifye. Si ou te antre nan {{ man }} kòrèkteman Lè sa a, pral gen yon lyen edite li.

Estrikti nan manyèl la

Nan manyèl la ou ta dwe Se poutèt sa jwenn seksyon sa yo esansyèl:
Incipit
== Uso ==
== Parametri ==
== Esempi d'uso ==
== Note ==
== Pagine correlate ==
[[Categoria:Manuali dei template]]

Kòmanse ekri manyèl la pa ekri bi ak sèvis piblik pou ki modèl la te kreye.

Sèvi ak

Bay detay sou ki kalite paj ak atik nan ki itilize se posib oswa ou pa posib, ak konparezon ak modèl menm jan an.

Paramèt

Operasyon chak paramèt dwe eksplike. Yon bon metòd se ekri kòd la modèl nan fòm lan nan ki li pral itilize, ak yon eksplikasyon sou paramèt yo ansanm.
Eg:

{{non modèl
| paramèt1 =
| paramèt2 =
...
}}


  • paramèt1 = eksplikasyon sou paramèt1
  • paramèt2 = eksplikasyon sou paramèt2
...

Pou antre nan paramèt, espesyalman si gen anpil, ou ka itilize modèl yo {{ TableTemplate }} ak {{ Parameter }} ak tab la koulè relatif yo asiyen priyorite.
Gen obligatwa , opsyonèl , rekòmandasyon ak sa yo dwe peye atansyon a , se sa yo ki nan ki sèlman sèten valè yo aksepte, pou ki si sa nesesè li rekòmande insert yon sou-seksyon (pou egzanp == Valori accettati dal parametro "pincopallino" == ) pi byen eksplike kijan li fonksyone.

Egzanp itilizasyon

Pafwa eksplikasyon sou paramèt yo pou kont li ka pa ase pou fè li klè kouman pou itilize modèl la. Se poutèt sa rekòmande bay kèk egzanp pratik kote modèl la te itilize pa kreye header la == Esempi d'uso == .
Anjeneral yo itilize fòm " kòd - egzanp lan ", se sa ki, sou bò goch la kòd la jan li ta dwe mete ak sou bò dwat la ki sa kòd la jenere, se sa ki modèl la jan li parèt nan paj sa yo nan ki li te itilize.
Kòd egzanp lan ap fèmen nan <poem><code><nowiki>...</nowiki></code></poem> (" kòd ") oswa <pre>..</pre> (" pre -formate ") pou pi fasil lizibilite.
Eg:

Avèk <poem><code><nowiki>...</nowiki></code></poem> tag la

{{Libro
|titolo=commedia
|titoloalfa=Divina Commedia
|immagine=Gustave Doré - Dante Alighieri - Inferno - Plate 18 (Canto V - Dante has a touch of the vapours).jpg
|didascalia=Scena del poema illustrata da<br>[[Gustave Doré]]
|autore=[[Dante Alighieri]]
|annoorig=tra il [[1304]] e il [[1321]]
|genere=[[Poema]]
|protagonista=[[Dante]]
|altri_personaggi=[[Virgilio]], [[Beatrice]]
}}

Avèk tag <pre>..</pre>

 {{Liv
| tit = komedyen
| titoloalfa = Divine Comedy
| imaj = Gustave Doré - Dante Alighieri - Inferno - Plak 18 (Canto V - Dante gen yon touche nan vapè yo) .jpg
| caption = Sèn nan powèm nan ilistre pa <br> [[Gustave Doré]]
| otè = [[Dante Alighieri]]
| annoorig = ant [[1304]] ak [[1321]]
| genre = [[Powèm]]
| protagonist = [[Dante]]
| lòt_karaktè = [[Virgil]], [[Beatrice]]
}} 
komedyen
Gustave Doré - Dante Alighieri - Inferno - Plak 18 (Canto V - Dante gen yon touche nan vapè yo) .jpg
Sèn nan powèm nan ilistre pa
Gustave Doré
Otè Dante Alighieri
1ye ed. orijinal la ant 1304 ak 1321
Kalite Powèm
Pwotagonis Dante
Lòt karaktè Virgil , Beatrice

Nan ka a nan modèl ki twò lajè, oswa ki okipe tout lajè paj la, ou ka insert modèl la pwodwi kòm yon egzanp anba kòd la eksplikasyon.

Remak

Itilize nòt yo pèmèt tou nan manyèl modèl yo, pou yo ka bay tout enfòmasyon posib.

Paj ki gen rapò

Pou fasilite navigasyon ant modèl yo, ki ka souvan konplèks, li rekòmande pou w mete, anba tit == Pagine correlate == , nenpòt modèl ki lye ak yon sèl nan kesyon an. Itilize yon lis bal rekòmande pou lis yo .
Pou egzanp, pou modèl la {{ Kolòn }} ekri:

Finalman, pami paj ki gen rapò yo, yo dwe mete paj èd oswa direktiv konsènan itilizasyon modèl la tou.

Finalman, li rekòmande pou ou mete modèl {{ Pwojè }} ki gen lis pwojè a (yo) nan ki modèl la tonbe tematikman, anplis Pwojè a: Modèl la .
Pou egzanp, pou modèl la {{ Film }} (ki te itilize nan atik yo ki gen rapò ak Pwojè a: Cinema ) ekri:
{{Progetto|Cinema|Template}}
jwenn:

Abreviyasyon itil (redireksyon) nan non modèl la ka rapòte nan kòmansman manyèl la atravè {{ abrevyasyon }}.

Kategorizasyon

Chak manyèl dwe mete nan Kategori: Modèl manyèl yo pa ekri fisèl la nan fen paj la:
<noinclude>[[Categoria:Manuali dei template]]</noinclude>
Tags yo noinclude evite kategorizasyon sa a menm pou paj sa yo ki pral modèl la dwe eleman.

Paj ki gen rapò

modèl Pwojè Modèl : kolabore avèk Wikipedia sou sijè modèl la