Module:Формат ТемплатеДата/доc

TemplateData – Модуле wитҳ аухиларй фунcтионс фор темплате доcументатион, эспеcиаллй бй ТемплатеДата.

Cоре фунcтионалитй ис импровед пресентатион он доcументатион пагес.

Импрове темплате доcументатион паге – МедиаWики дисаппоинтинг

Фор пресентатион оф темплате депиcтион ин Висуаледитор агреэмент wас маде то абандон алл маркуп анд cлиcкабле линкс, пермиттинг алл тоолтипс ин алл энвиронменц. Басиcаллй тҳис ис реасонабле, албеит тоолтипс wитҳ маркуп анд cлиcкабле линкс аре суппортед ас ҲТМЛ апплиcатион фор деcадес ноw анд ЖаваСcрипт ис пресент анйwай wҳен Висуаледитор ис усед.

• Ин cонсеқуэнcе ит wас деcидед, тҳат алсо пресентатион он темплате доcументатион виэwс невер эвер ис пермиттед то cонтаин эффеcтиве линкс ор маркуп.
• Тҳат инволвед, тҳат он манй темплате доcументатион пагес тwо сепаратед параметер доcументатион таблес аре неэдед анд реқуиред то бе маинтаинед симултанеоуслй: Оне плаин техт версион фор Висуаледитор, анд а усефул оне фор cомплех cирcумстанcес, wитҳ линкс анд маркуп анд лисц анд таблес. – БТW, Висуаледитор ҳас нот онлй тоолтипс, бут алсо а статиc ГУИ виэw, wҳере тҳе лаcк оф деэпенинг линкс ин параметер десcриптион ис паинфул.

Тҳис стате ис индефенсибле.

Импровед пресентатион

Ин аддитион то тҳе симпле сйнтах суппортед бй МедиаWики анд пресентед ин тҳе Висуаледитор, тҳе фоллоwинг феатурес cан бе аддед то тҳе ЖСОН cоде фор тҳе темплате доcументатион паге. Тҳей аффеcт тҳе элеменц cлассифиэд ас ИнтерфаcеТехт, бут аре онлй усефул фор десcриптион фиэлдс.

Wикилинкс (интернал формат)

• Усинг доубле сқуаре браcкец пагес cан бе линкед ас cоммон.
• Ин Висуаледитор, онлй линк титле ис висибле, ас ит ис дисплаед отҳерwисе.

Эхтернал линкс (УРЛ формат)

• Опен УРЛ аре линкед ас усуал бй тҳемселвес. Ин Висуаледитор тҳей аппеар ас нормал техт.
• Эхтернал линкс энcлосед ин симпле сқуаре браcкец аре дисплаед нормаллй он тҳе темплате доcументатион паге. Ин Висуаледитор тҳе титле ис омиттед анд тҳе УРЛ ис дисплаед со тҳат тҳе усерс cан c&п ит анд трансфер ит то тҳе аддресс фиэлд оф тҳе броwсер. Тҳере ис но отҳер wай.

Апостропҳс ' фор италиc анд болд

• Тҳей cан бе усед то эмпҳасизе он тҳе доcументатион паге анд аре миссинг ин Висуаледитор (регулар сcрипт).

ҲТМЛ энтитиэс

• Тҳе фоллоwинг энтитиэс cан бе усед: &лт; &гт; &амп; &қуот; &нбсп; анд алл нумериc формац.

ҲТМЛ тагс

• ҲТМЛ тагс (анд тҳе МедиаWики элеменц тҳат аре нот реплаcед ин адванcе) аре ремовед фор тҳе Висуаледитор. Отҳерwисе, тҳей ремаин эффеcтиве.
• Аттрибутес аре офтен инcлудед ин ", wҳич cонфлиcц wитҳ тҳе ЖСОН сйнтах. Ит ис импортант то маке суре тҳат ' ис усед, wҳич cан бе а проблем wитҳ темплате трансcлусионс.

<noexport> … </noexport>

• Тҳе энcлосед ареас аре нот эхпортед то тҳе Висуаледитор.
• Море cомплех wики сйнтах анд эхтенсиве эхпланатионс cан бе рестриcтед то тҳе доcументатион паге.
• Wитҳин а ноэхпорт ареа, тҳе лине струcтуре оф тҳе соурcе техт ис cонсидеред. Отҳерwисе эверйтҳинг ис руннинг ин а сингле лине, ас ит wоулд алсо бе репресентед ин тҳе Висуаледитор.

Темплатес

• Ин партиcулар wҳен тҳе темплате параметер JSON= ис усед, темплатес cан бе дистрибутед анйwҳере ин тҳе ЖСОН cоде. Ҳоwевер, тҳе эхпандед сйнтах мигҳт cоллиде wитҳ тҳе ЖСОН сйнтах.

Море эффеcц

• Аccординг то тҳе стате (реқуиред, суггестед, оптионал, депреcатед) тҳе табле роwс аре ҳигҳлигҳтед ин лигҳт блуэ, wҳите, грай анд пале ред.
• Wҳен сортинг бй стате, тҳис импортанcе ис такен инто аccоунт анд нот тҳе алпҳабетиcал сеқуэнcе оф тҳе кейwордс.
• Эач параметер cан бе аддрессед ас а жумп дестинатион. Тҳе фрагмент ис #templatedata:параметер-наме.
• Миссинг лабелс аре ҳигҳлигҳтед ас эррорс.
• А маинтенанcе cатегорй ис триггеред иф эррорс оccур.
• Иф тҳере аре но параметерс, тҳе элемент params:{} ис нот реқуиред.

Элиминате дисадвантагес

Тwо аспеcц wере фоунд то бе партиcуларлй дистурбинг ин 2013–2017:

1. Эвен иф но параметерс ат алл wере дефинед, а табле ҳеад ис алwайс дисплаед фор а табле wитҳоут cонтент. Эвен море, тҳис ис сортабле.
   • А редуcтион wас режеcтед wитҳ Андоза:Пҳаб. А сортабле табле оф тҳе параметерс wоулд бе алwайс неcессарй, эвен иф тҳе табле ҳас но роwс ат алл анд cонсисц онлй оф тҳе ҳеадер роw.
   • Тҳис ридиcулоус статемент лед то тҳе девелопмент оф тҳис модуле ин 2016.
2. Эвен иф тҳе cонтехт доэс нот пермит тҳат дефаулт валуэс ор эвен АутоВалуэ спеcифиcатионс wилл бе дефинед эвер, а cонтент-фреэ сих-лине дефинитион лист ис оутпут фор эач индивидуал параметер валуэ.
   • Андоза:Пҳаб / Андоза:Пҳаб / Андоза:Пҳаб / Андоза:Пҳаб
   • МедиаWики дид нот эвен деигн то ансwер тҳе дисастроус доcументатион паге ситуатион.

Тҳе генерал cомменц шоw тҳат МедиаWики онлй регардс тҳе пресентатион оф ТемплатеДата спеcифиcатионс ин тҳе Висуаледитор ас импортант. Ҳоwевер, сомеоне ҳас то програм анд маинтаин тҳе темплатес анд сомеоне неэдс то генерате тҳе темплате десcриптион анд маке ит манагеабле бесиде тҳе фунcтионалитй ин тҳе Висуаледитор форм, бут тҳат ис беёнд кен.

Генерал wоркфлоw

• Ан аттемпт ис маде то реад тҳе ЖСОН обжеcт (стринг) фром пассед темплате параметерс.
• Иф тҳис фаилед, тҳе соурcе cоде оф тҳе cуррент анд тҳе доcументатион паге ис сеарчед фор <templatedata> элеменц.
• Тwо репресентатионс аре обтаинед фром тҳе ЖСОН обжеcт инпут:
  1. А лоcализед версион, маркуп этc. стриппед офф, ин ЖСОН формат.
  2. Ан ҲТМЛ струcтуре, басиcаллй симилар то тҳе МедиаWики репресентатион, поссиблй wитҳ табле оф тҳе параметерс, wитҳ энҳанcед феатурес.
• Тҳе ресулт оф тҳе темплате ис а висибле доcументатион wитҳ маркуп, фоллоwед бй а ҳидден <templatedata> элемент. Тҳис ис доне фор тҳе эхпорт анд cорреспондс то тҳе МедиаWики гуиделинес.
  • Иф cуррент паге ҳас беэн идентифиэд ас доcументатион паге тҳе ҳидден <templatedata> ис суппрессед, анд тҳосе пагес до нот аппеар сепарателй ин Спеcиал:ПагесWитҳПроп/темплатедата.

Фунcтионс фор темплатес

Детаилс

ф

Импрове ТемплатеДата-пресентатион; усед ин Темплате:Формат ТемплатеДата

Параметерс оф темплате трансcлусион энвиронмент (алл оптионал):

1

ЖСОН стринг ор <templatedata> обжеcт

ЖСОН

ЖСОН стринг

(преcедес 1)

Транситион фром <templatedata> обжеcц wитҳ пипе сймболс неэдс спеcиал аттентион: Пипес аре то бе репресентед ас {{!}}, он доубле cурлй браcкец оне шоулд бе энcодед бй ҲТМЛ энтитй.

ТОC

1 – Инсерт табле оф cонтенц афтер генерал пурпосе десcриптионс; бут бефоре параметер лист, иф пресент

лазй

1 – Пресентатион онлй, до нот генерате ан эффеcтиве дата блоcк

Фор генерал метҳод десcриптионс.

дебуг

1 – девелопер моде

Параметерс оф #invoke фор партиcулар прожеcт адаптион (алл оптионал):

cат

Титле оф а маинтенанcе cатегорй он инвалид параметер валуэ этc.

дебуг

Девелопмент моде, иф провидед анд нот эқуал 0

доcпагеCреате

Паттерн фор cреатион оф субпаге намес; %s/Doku

доcпагеДетеcт

Паттерн фор реcогнитион оф субпаге намес; /Doku$

мсгДесcМисс

Лоcалисатион: cомплаинт техт он миссинг description

Ретурнс: ҲТМЛ cоде; анд/ор эррор мессаге, пробаблй wитҳ class="error"

фаилсафе

Версион идентифиcатион: 2017-11-06

Оптионал аддитионал параметер 1 – реқуэстед минимал версион идентифиcатион

Ретурнс: (эмптй), иф минимал версион cондитион нот матчед

Эхамплес (тест паге)

А тест паге иллустратес праcтиcал усе.

Фунcтионс фор Луа модулес (АПИ)

Соме фунcтионс десcрибед абове cан бе усед бй отҳер модулес:

local lucky, TemplateData = pcall( require, "Module:Format TemplateData" )
if type( TemplateData ) == "table" then
    TemplateData = TemplateData.TemplateData()
else
    -- failure; TemplateData is the error message
    return "<span class='error'>" .. TemplateData .. "</span>"
end

ТемплатеДата.фаилсафе(атлеаст)

1. атлеаст
   оптионал
   нил ор минимал версион реқуэст

Ретурнс: стринг ор фалсе

ТемплатеДата.гетПлаинЖСОН(адапт)

Редуcе энҳанcед ЖСОН информатион то МедиаWики ЖСОН

1. адапт
   стринг, wитҳ ЖСОН (энҳанcед)

Ретурнс: стринг, wитҳ ЖСОН (МедиаWики )

ТемплатеДата.тест(адапт, арглист)

Симулатион оф темплате фунcтионалитй

1. адапт
   табле, #invoke параметерс
2. арглист
   табле, темплате параметерс

Ретурнс: стринг

Усаге

Cуррентлй фоcусинг он оне темплате онлй:

• Темплате:Формат ТемплатеДата

Депенденcиэс

• Модуле:Плаин техт
• Модуле:ТНТ (фор тҳе |ТНТ= параметер)