Тусламж:Documenting templates and modules

Загвар болон модулиуд MediaWiki маш хүчирхэг боломжууд байгаа боловч шинэ хэрэглэгчдэд үл ойлгогдохоор байж болох, тэр ч байтугай туршлагатай хэрэглэгчид илүү нарийн хүмүүсийнхээ саад хийх мэдрэмж байх болно. Тиймээс энгийн байдал сайжруулах баримт бичгийг хавсаргана байх ёстой. Баримт бичиг нь загвар буюу модуль юу тайлбарлах ёстой, үүнийг хэрхэн ашиглах талаар. Өөр газар нь анхаарал тавьж байгаа олон туршлагатай хувь нэмэр оруулагчдыг багтаасан - - зөв ашиглаж болно ялангуяа маягтын хувьд загвар синтаксын бүрэн мэдэхгүйгээр нь хэрэглэгч нь хангалттай хялбар байх ёстой. Энэ нь маш өргөн хэрэглэгддэг маягтын тохиолдолд ялангуяа үнэн байдаг.

Баримтжуулалтын subpage хэрхэн үүсгэх бэ?

Баримтжуулалтын subpages тууштай, дараах ерөнхий загварыг ашиглах гэж нэрлэгдсэн бөгөөд загварчлагдсан байх ёстой. Гэж бодъё дүн таны хайсан Загвар Загварын нэрлэсэн байна: X, эсвэл модуль Модулийн нэрлэсэн байна: X дээр ажилладаг X / баримт бичиг, эсвэл Модулийн: X / баримт бичгийг нэр Загвар нь subpage үүсгэнэ. {{documentation subpage}} нь дэлгэрэнгүй мэдээллийг үзнэ үү, эсвэл таны бичиг баримт нь эхэнд дараах wikitext хуулах, Paste:

  == Хэрэглээ ==

Дээд шугам нь одоогийн хуудас тайлбарласан мэдэгдэл болон загвар буюу модулийн гол хуудас руу холбоос үзүүлэх болно. Хуудас ирээдүйд засварлах үед төлөвлөгөө хадгалагдан үлдсэн байдаг болохоор газар дээр нь тайлбар орхих - тохиромжтой санал шугамын дагуу дээд шугам, ангилал болон дараа бичиг баримтыг бичиж өгдөг.

  Энэ загвар хуудасны доод талд {{documentation}} болно.

Анхаарах зүйл: нээх <noinclude> загвар хууль эсвэл текст сүүлийн тэмдэгт адил шугам биш, шинэ мөрнөөс эхлэх эсэхийг шалгаарай. Үгүй бол, нэмэлт зай нь ихэвчлэн хүсч байгаа бол энэ нь ашиглаж байгаа үед загвар , доор оруулна.

Загвар нь аль хэдийн тусгай хамгаалалттай бол, үүнийг хийхийн тулд администраторт асуух эсвэл Загвар -ийн хэлэлцүүлэг хуудас дээр нь засвар хүсч байна. Баримт бичиг, ангилал ба interwiki холбоос аль хэдийн <noinclude>…</noinclude> савны дотор хавсаргасан нэг хэсэгт байдаг бол хоёр тусдаа хуудсууд даяар баримт бичиг хуваах байх нь хамгийн тохиромжтой юм шиг , баримт бичиг subpage болгон шилжүүлээрэй.

Баримт бичиг хуудас хараахан байхгүй бол , энэ засварлах холбоос дээр дарж , {{documentation}} загварын анхны загвар хуудсан дээр тавьсан бол нэг урьдчилан дүүрэн Doc хуудас араг ясыг авах preload онцлог давуу талтай байх болно гэдгийг анхаараарай / Doc subpage бий болгох editbox руу бичиг баримт / preload : загвар:documentation/preload болно.