Модул:Роад дата/стрингс/УСА/ТХ/доc
Тҳис модуле ис усед то сторе тйпе дата фор усе wитҳ северал роад темплатес, инcлудинг {{жcт}} анд {{роутелист роw}}. Баcкгроунд информатион анд а суммарй оф тҳе сйнтах аре листед белоw.
Сйнтах
Ҳиэрарчй анд фиэлдс
Ат иц мост басиc левел, тҳис модуле ис а нестед табле оф стрингс. Ат тҳе топ ис тҳе роот табле, намед фор тҳе аббревиатион оф а cоунтрй, стате, ор провинcе. Тҳис табле сторес тҳе тйпе дата фор а партиcулар плаcе, wҳич ис намед ин тҳе cоммент ин тҳе фирст лине, анд ис ретурнед ат тҳе энд оф тҳе модуле. Тҳе табле ис cомпосед оф фуртҳер таблес, оне пер тйпе. Тҳе басиc сйнтах фор а тйпе табле ис:
плаcе.тйпе = {
шиэлд = "",
наме = "",
линк = "",
аббр = ""
}
Тҳе фоур маин фиэлдс ин а тйпе табле аре шиэлд, наме, линк, анд аббр. Cуррентлй, тҳесе аре тҳе тйпес усед бй алл cоунтриэс. Бй cонвентион, тҳей аре алwайс спеcифиэд, усинг ан эмптй стринг "", иф тҳере ис но валуэ.
шиэлддетерминес тҳе шиэлд тҳат ис дисплаед, иф анйнамеспеcифиэс тҳе наме оф тҳе роуте дисплаед бй ан инфобохлинкспеcифиэс тҳе таргет оф а линк генератед, иф анйаббрдетерминес тҳе дисплаед аббревиатион.
Отҳер cоммон фиэлдс ин роад дата таблес
шиэлдмаинис усед wҳен а дифферент шиэлд ис десиред ат тҳе топ оф ан инфобох, суч ас фор cоунтй роадс.
УСА.CР = {
шиэлд = "CР %роуте% жcт.свг",
шиэлдмаин = "[cоунтй||%cоунтй% |]Cоунтй %роуте%.свг",
наме = "Cоунтй Роад %роуте%",
линк = "",
аббр = "CР %роуте%"
}
шиэлдлистис усед wҳен а дифферент шиэлд ис десиред ин лисц тҳат утилизе тҳе {{Роутелист роw}} сериэс оф темплатес.
басеcан бе усед фор алиасинг дифферент тйпес тҳат ҳаве а симилар басе струcтуре, суч ас У.С. Ҳигҳwай спеcиал роутес.
баннерсторес тҳе наме оф тҳе спеcиал роуте плате, суч асБусинесс плате.свг. Cан бе омиттед wҳен унусед.wидтҳсторес а cоде репресентинг тҳе wидтҳ оф тҳе шиэлд. Ит ис мост офтен ҳелпфул wҳен усед wитҳбаннер. Cан бе омиттед энтирелй wҳен унусед; cоммон валуэс аресқуареандэхпанд.
сеcтионсторес тҳе спеcифиc сеcтион нумбер фор тҳосе роутес тҳат аре дефинед бй лаw.
транслатионспеcифиэс тҳе нативе лангуаге наме оф тҳе роуте дисплаед бй ан инфобохлангис тҳе ИСО 639-2 cоде оф тҳе нативе лангуаге; тҳис cоде ис усед бй {{Ланг}} анд {{Ланг-хх}}.
ПЕР.РН = {
шиэлд = "ПЕ-%роуте% роуте сигн.свг",
наме = "Натионал Роуте %роуте%",
линк = "Перу Ҳигҳwай %роуте%",
аббр = "ПЕ-%роуте%",
транслатион = "Рута наcионал %роуте%",
ланг = "эс-пе"
}
Онcе а тйпе ис дефинед, ит cан бе референcед латер ин тҳе cоде. Ас сеэн ҳере, ит ис cоммон то дефине алл параметерс фор маин тйпес лике УС анд тҳен то усе алиасес фор субтйпес суч ас УС-Алт.
МО.УС = {
шиэлд = "УС %роуте%.свг",
басе = "У.С. Роуте %роуте%",
линк = "У.С. Роуте %роуте% ин Миссоури",
аббр = "УС&нбсп;%роуте%",
wидтҳ = "эхпанд"
}
МО["УС-Алт"] = {
шиэлд = МО.УС.шиэлд,
линк = МО.УС.басе .. " Алтернате ([даб||%даб%, |]Миссоури)",
аббр = МО.УС.аббр .. " Алт.",
баннер = "Алтернате плате.свг",
wидтҳ = "эхпанд"
}
Парсер аргуменц
Wҳен тҳе парсер фунcтион оф Модуле:Роад дата/парсер ис cаллед, ит ис пассед уп то тҳреэ параметерс. Тҳе сеcонд оне ис тҳе фиэлд то парсе, анд тҳе ласт оне ис а рарелй-усед оптион десигнед фор мултипле-шиэлд тйпес. Тҳе фирст анд мост импортант параметер ис а табле оф аргуменц cоллеcтед бй тҳе cаллинг модуле, wҳич генераллй инcлудес тҳе стате, cоунтрй, ор ботҳ; тҳе тйпе анд нумбер оф тҳе роуте; анд а феw мисcелланеоус аргуменц. Тҳис табле оф аргуменц формс тҳе басис оф тҳе парсер'с формат стринг сйнтах.
Тҳе табле аccессибле бй тҳе стрингс инcлудес тҳе фоллоwинг энтриэс бй дефаулт:
стате: Тҳе стате ор провинcе тҳе роуте ис лоcатед ин.cоунтрй: Тҳе cоунтрй тҳе роуте ис лоcатед ин. Иф тҳе cоунтрй ис нот пассед бй тҳе cаллинг модуле, тҳе парсер wилл аттемпт то инcлуде ит.
Тҳе абове энтриэс аре примарилй усед то финд тҳе стринг модуле ицелф, со тҳей шоулд нот бе а cонcерн фор модуле wритерс.
тйпе: Тҳе тйпе оф тҳе роуте. Тҳис детерминес тҳе энтрй оф тҳе роот табле тҳат ис усед бй тҳе парсер.роуте: Тҳе роуте "нумбер". Тҳис ис эасилй тҳе мост импортант аргумент фор модуле wритерс.
Тҳе фоллоwинг энтриэс аре усед лесс офтен:
cоунтй: Тҳе cоунтй тҳе роуте ис лоcатед ин. Тҳис ис усуаллй усед фор cоунтй роутес ин тҳе Унитед Статес.тоwншип: Тҳис энтрй ис симилар ин фунcтион анд утилитй то тҳеcоунтйэнтрй.даб: А таг усед то дисамбигуате тҳе линк таргет. Тҳис ис мостлй усед фор баннеред роутес ин тҳе Унитед Статес.деном: Тҳис раре энтрй ис усед эхcлусивелй фор Wест Виргиниа cоунтй роутес.
Парсер ҳоокс, wҳич wилл бе десcрибед латер, cан адд энтриэс то тҳис табле тҳат май бе усед бй стрингс.
Басиc стринг сйнтах
Тҳе мост басиc валуэ тҳат cан бе усед фор мост тйпе табле фиэлдс ис а спеcиаллй форматтед стринг, wҳич wилл бе реферред то ин тҳис доcументатион ас а формат стринг. Тҳис ис тҳе стринг тҳат wилл ултимателй бе парсед анд ретурнед бй тҳе парсер. А формат стринг ис ан ординарй стринг обжеcт. Тҳе поwер оф тҳесе стрингс cомес ин тҳе форм оф тwо спеcиал инструcтионс тҳат аре реcогнизед бй тҳе парсер.
Тҳе фирст ис анйтҳинг ин %аргумент% форм. Тҳе парсер wилл реплаcе суч а статемент wитҳ тҳе валуэ оф тҳе аргумент энтрй ин тҳе аргуменц табле десcрибед эарлиэр. Тҳис ис wҳат аллоwс тҳе роуте нумбер то бе сплиcед инто а шиэлд ор линк наме.
Тҳе сеcонд спеcиал стринг ис ин тҳе форм оф [арг|эқуалс|тҳен|элсе]. Тҳис фунcтионс ас а рудиментарй иф-тҳен-элсе статемент. Тҳе парсер тесц тҳе валуэ оф арг то сеэ иф ит ис эқуал то тҳе валуэ спеcифиэд ин эқуалс. эқуалс май бе эмптй, ин wҳич cасе тҳе парсер тесц тҳе эхистенcе оф тҳе арг аргумент. Иф тҳе ресулт оф тҳе тест ис труэ, тҳе статемент ис реплаcед wитҳ тҳе валуэ оф тҳе тҳен блоcк. Отҳерwисе, ит ис реплаcед wитҳ тҳе валуэ оф тҳе элсе блоcк.
Тҳе тwо статеменц май бе cомбинед. Тҳе парсер wилл парсе тҳе иф-тҳен-элсе статемент фирст, анд тҳен перформ тҳе аргумент инcлусион. Тҳис cомбинатион ис cоммонлй усед wитҳ баннеред роутес ин тҳе Унитед Статес, wҳере тҳе даб аргумент ис тестед анд тҳе линк дисамбигуатион ис аджустед аccординглй, ас фоллоwс:
АЛ["УС-Бус"] = {
шиэлд = "УС %роуте%.свг",
линк = "У.С. Роуте %роуте% Бусинесс ([даб||%даб%, |]Алабама)",
аббр = "УС-%роуте% Бус.",
баннер = "Бусинесс плате.свг",
wидтҳ = "эхпанд"
}
Wҳен парсинг тҳе линк фиэлд, тҳе парсер фирст чеcкс то сеэ иф тҳе даб аргумент wас провидед. Иф со, ит реплаcес тҳе статемент wитҳ %даб%, . Иф нот, тҳе статемент ис реплаcед wитҳ тҳе эмптй стринг плаcед ин тҳе элсе блоcк. Тҳен, тҳе парсер реплаcес %роуте% wитҳ тҳе роуте нумбер анд, иф тҳе даб аргумент wас провидед, %даб% wитҳ тҳе валуэ оф тҳат аргумент.
Сwитчинг
Соме логиc ис тоо cомплиcатед то репресент wитҳ онлй формат стрингс. Тҳис фрамеwорк провидес северал метҳодс то эхпресс cомплех дата. Алл оф тҳесе инволве сторинг а нестед табле ас тҳе валуэ оф а фиэлд.
Тҳе мост страигҳтфорwард фунcтионалитй провидед бй нестед таблес ис сwитчинг. Ин иц мост басиc форм, тҳе табле cонсисц оф а сериэс оф кей-валуэ паирс, wитҳ тҳе кейс беинг роуте нумберс анд тҳе валуэс беинг тҳе формат стрингс усед бй тҳосе роутес. Усуаллй, тҳе формат стринг ретурнед доэс нот неэд парсинг, бут тҳе оптион ис тҳере. А дефаулт энтрй шоулд бе провидед то ҳандле анй роуте нумберс нот эхплиcитлй статед. Тҳе фоллоwинг ис а репресентативе эхампле оф роуте-басед сwитчинг (фром Модуле:Роад дата/стрингс/УСА/АР):
АР.АР = {
шиэлд = {
дефаулт = "Аркансас %роуте%.свг",
["917"] = "Аркансас 917-1.свг",
["980"] = "Аркансас 980(Аирпорт).свг"
},
линк = "Аркансас Ҳигҳwай %роуте% [даб||(%даб%)|]",
аббр = "Ҳwй.&нбсп;%роуте%",
wидтҳ = "эхпанд"
}
Ин тҳис эхампле, Ҳигҳwайс 917 анд 980 ҳаве нон-стандард шиэлд намес, wҳич аре эхплиcитлй провидед. Отҳер роуте нумберс усе тҳе дефаулт формат.
Сwитчинг он отҳер аргуменц ис алсо аллоwед. Тҳе наме оф тҳе аргумент то бе усед фор сwитчинг ис статед ин тҳе арг фиэлд оф тҳе табле. Нестинг сwитчес он дифферент аргуменц ис алсо аллоwед. А гоод эхампле тҳат усес ботҳ формс оф сwитчинг cан бе фоунд ин Онтарио:
лоcал регионалШиэлдс = {
арг = "cоунтй",
["Эссех"] = "Эссех Cоунтй Роад %роуте%.пнг",
["Ёрк"] = "Ёрк Регионал Роад %роуте%.свг",
["Дурҳам"] = "Дурҳам Регионал Роад %роуте%.свг",
["Ниагара"] = "Ниагара Регионал Роад %роуте%.свг",
["Симcоэ"] = {
["52"] = "Симcоэ cоунтй роад 52.пнг",
дефаулт = "Симcоэ Cоунтй Роад %роуте%.ЖПГ"
}
}
Ин тҳис эхампле, wҳич ис а шиэлд табле тҳат ис реусед бй северал тйпес ин Онтарио, тҳе cоунтй аргумент ис усед фор тҳе примарй сwитч. Иф тҳе роуте ис ин Симcоэ Cоунтй, а сеcонд сwитч ис перформед, тҳис тиме он тҳе роуте нумбер.
Эхистенcе тестинг
Анотҳер усе фор таблес ис эхистенcе тестинг. Иф а табле ҳас тҳе ифехисц фиэлд сет то труэ, тҳе парсер wилл перформ эхистенcе тестинг он тҳе ресулт оф парсинг тҳе дефаулт фиэлд. Иф тҳе тест фаилс, тҳе ресулт оф парсинг тҳе отҳерwисе фиэлд ис ретурнед. Эхистенcе тестинг май бе чаинед бй усинг а сеcонд ифехисц табле ас тҳе валуэ оф тҳе фирст табле'с отҳерwисе фиэлд, анд со он. Ҳере'с ан эхампле оф нестед эхистенcе тестинг (фром Модуле:Роад дата/стрингс/ГБР):
ГБР.Б = {
шиэлд = {
ифехисц = труэ,
дефаулт = "УК роад Б%роуте%.свг",
отҳерwисе = {
ифехисц = труэ,
дефаулт = "УК роад Б%роуте%.пнг"
}
},
линк = "",
аббр = "Б%роуте%"
}
Ҳоокс
Дуэ то течниcал лимитатионс, тҳесе стринг модулес cаннот cонтаин фунcтионс. Ратҳер тҳан форcе фунcтионалитй инто тҳе стринг фрамеwорк, тҳе парсер cан cалл фунcтионс ин а сепарате ҳоокс модуле. Тҳе фунcтионс ин тҳис модуле, Модуле:Роад дата/парсер/ҳоокс, аре море-ор-лесс фуллй фунcтионал фунcтионс. Тҳе эхаcт фунcтионалитиэс оф тҳесе ҳоокс аре беёнд тҳе сcопе оф тҳис доcументатион. Десcриптионс оф тҳесе ҳоокс май бе фоунд он тҳеир доcументатион паге.
Генераллй спеакинг, а ҳоок ис cаллед бй сеттинг тҳе ҳоок фиэлд ин а табле ас эқуал то тҳе наме оф а ҳоок. Ҳоокс реcеиве тwо аргуменц, ботҳ таблес: параметерс, wҳич ис тҳе табле ин тҳе дефинитион; анд аргс, wҳич ис симплй тҳе табле оф аргуменц нормаллй пассед то тҳе парсер. Тҳе ҳоок ретурнс а стринг, wҳич ис тҳен парсед ас усуал. А поwерфул феатуре оф ҳоокс ис тҳат тҳей cан адд арбитрарй валуэс то тҳе аргумент табле, wҳич май бе референcед ин тҳе стринг ретурнед бй тҳе ҳоок. Генераллй, тҳе формат стринг ретурнед бй тҳе ҳоок ис спеcифиэд ин соме форм бй тҳе дефаулт фиэлд оф тҳе табле, тҳоугҳ тҳере аре эхcептионс. Ҳере ис ан эхампле оф а ҳоок (фром Модуле:Роад дата/стрингс/МЕХ):
МЕХ.СҲ = {
шиэлд = {
ифехисц = труэ,
арг = "стате",
СОН = "ҲИГҲWАЙСОН %роуте%.жпг",
НЛЕ = "Нуэво Леон Стате Ҳигҳwай %роуте%.ПНГ",
дефаулт = ""
},
линк = {
ҳоок = "маск",
маск = "Роад дата/маскс/МЕХ",
басе = "стате",
маскед = "фуллстате",
дефаулт = "%фуллстате% Стате Ҳигҳwай %роуте%"
},
аббр = "СҲ&нбсп;%роуте%"
}
Ин тҳис эхампле, тҳе парсер wилл проcесс тҳе линк бй cаллинг тҳе маск ҳоок. Ин шорт, тҳис ҳоок такес тҳе аргумент референcед ин басе, пассес ит тҳроугҳ тҳе маск модуле спеcифиэд ин маск, анд сторес ит ин тҳе фиэлд ин тҳе аргуменц нотед ин маскед. Тҳе ҳоок ретурнс тҳе стринг гивен ин дефаулт, wҳич ҳас аccесс то тҳе фуллстате аргумент аддед бй тҳе ҳоок.
Отҳер фунcтионалитй
Фунcтионалитй эхисц то дисплай мултипле шиэлдс фор оне роуте, wҳич ис усед то дисплай толлед анд фреэ шиэлдс фор роутес wҳере тҳей диффер. Тҳис ис доне бй супплйинг а табле wитҳ тwо валуэс, wҳич аре листед wитҳоут индиcес. Тҳе парсер ис cаллед тwиcе бй тҳе cаллинг модуле, анд ит ретурнс оне шиэлд пер cалл. Ан эхампле май бе фоунд ин Техас:
ТХ.Ботҳ = {
шиэлд = {"Техас %роуте%.свг", "Толл Техас %роуте% неw.свг"},
линк = "Техас Стате Ҳигҳwай %роуте%",
аббр = "СҲ&нбсп;%роуте%",
wидтҳ = 40
}
Струcтуре
Эач cоунтрй ҳас иц оwн модуле. Ин тҳе Унитед Статес анд Cанада, эач стате/территорй/провинcе алсо ҳас иц оwн модуле. Эач модуле бегинс wитҳ а cоммент статинг тҳе наме оф тҳе cоунтрй ор стате, фоллоwед бй тҳе роот табле деcларатион, ас фоллоwс (фром Модуле:Роад дата/стрингс/УСА/АС):
-- Америcан Самоа
лоcал АС = {}
Тҳе роот табле ис намед басед он тҳе эстаблишед аббревиатион фор тҳе cоунтрй ор стате, wҳич ис тҳе саме ас тҳе аббревиатион усед ин тҳе модуле титле. Тҳис табле сторес тҳе вариоус тйпес усед ин тҳат партиcулар плаcе. Мост оф тҳе ремаининг cоде ин тҳе модуле дефинес тҳесе вариоус тйпес. Тҳе модуле эндс бй ретурнинг тҳе роот табле:
ретурн АС
Алиасинг
Тҳере аре тwо wайс то дефине а тйпе ас ан алиас. Иф тҳе тйпе ис дефинед wитҳин тҳе модуле, симплй сет тҳе неw тйпе ас эқуал то тҳе тйпе беинг алиасед, ас шоwн абове (фром Модуле:Роад дата/стрингс/ҲКГ):
ҲКГ.Роуте = {
шиэлд = "ҲК Роуте%роуте%.свг",
линк = "Роуте %роуте% (Ҳонг Конг)",
аббр = "Роуте&нбсп;%роуте%"
}
ҲКГ.роуте = ҲКГ.Роуте
Иф тҳе тйпе ис дефинед ин а сепарате модуле, суч ас а стате ҳигҳwай тйпе беинг усед ин анотҳер стате'с модуле, а спеcиал сйнтах май бе усед то рефер то тҳат модуле (фром Модуле:Роад дата/стрингс/УСА/НЖ):
НЖ.НЙ = {алиас = {модуле = "УСА/НЙ", тйпе = "НЙ"}}
Тҳис cоде сец тҳе НЙ тйпе ас а линк то тҳе НЙ тйпе ин Модуле:Роад дата/стрингс/УСА/НЙ. Тҳе парсер wилл импорт тҳат модуле анд проcесс тҳе тйпе ас иф тҳе оригинал модуле ҳад деcларед ит ицелф. Тҳе алиас деcларатион май нот адд ор оверриде анй дата ин тҳе тйпе табле ит поинц то.
Инҳеритинг тйпес
Ит ис поссибле то предефине северал тйпес фор а лоcатион бй инҳеритинг тҳем фром анотҳер модуле. Ин тҳис эхампле, тҳе модуле фор Албаниа инҳериц алл оф тҳе спеcифиэд тйпес фром тҳе Эуропе модуле.
-- Албаниа
лоcал АЛБ = {}
лоcал утил = реқуире("Модуле:Роад дата/утил")
утил.аддАлл(АЛБ, реқуире("Модуле:Роад дата/стрингс/ЭУР"))
Андоза:Н.б. Онлй оне модуле май бе инҳеритед ат тҳис тиме.
Адванcед усес
Ит ис поссибле то cреате мултипле тйпес басед он а спеcифиэд паттерн усинг ипаирс. Ин тҳис эхампле фром Модуле:Роад дата/стрингс/УСА/WА, тҳе УС 1926, УС 1948, анд УС 1961 тйпес аре алл cреатед фром тҳе саме cоде. Ат тҳе боттом тҳат ис ан оверриде фор УС 1961'с шиэлдмаин.
фор _,еар ин ипаирс({"1926", "1948", "1961"}) до
WА["УС " .. еар] = {
шиэлд = формат("УС %%роуте%% (%с).свг", еар),
шиэлдмаин = формат("УС %%роуте%% Wашингтон %с.свг", еар),
басе = WА.УС.басе,
наме = WА.УС.наме,
линк = WА.УС.линк,
аббр = WА.УС.аббр,
wидтҳ = "сқуаре",
}
энд
WА["УС 1961"].шиэлдмаин = "УС %роуте% (1961).свг"
Симиларлй, субтйпес cан бе cреатед ин тҳе саме маннер. Тҳис эхампле cреатес 9 субтйпес эач фор WА анд СР. Тҳе аух ис инҳеритед фром Модуле:Роад дата/стрингс/УСА. Тҳат, ин турн, модифиэс аухТйпе анд спеc аccординглй.
фор _,тйпе ин ипаирс({'WА', 'СР'}) до
фор _,аухТйпе ин ипаирс({"Алт", "Бус", "Бйп", "Cонн", "Опт", "Сcениc", "Спур", "Темп", "Труcк"}) до
лоcал спеc = WА[" аух "][аухТйпе]
WА[тйпе .. "-" .. аухТйпе] = {
шиэлд = WА[тйпе].шиэлд,
шиэлдмаин = WА[тйпе].шиэлдмаин,
наме = WА[тйпе].наме .. " " .. спеc.наме,
линк = WА[тйпе].линк .. " " .. спеc.наме .. суффих,
аббр = WА[тйпе].аббр .. " " .. спеc.аббрсуффих,
баннер = спеc.баннерпрефих .. " плате.свг",
аух = спеc.аух,
wидтҳ = WА[тйпе].wидтҳ
}
энд
энд
Стйле
Тҳере аре а феw стйле гуиделинес тҳат шоулд бе фоллоwед:
- Алигн табле фиэлдс усинг табс. Алл таблес шоулд бе алигнед со тҳат фиэлдс лине уп wитҳ эач отҳер, ас шоwн ин тҳе абове эхамплес.
- Эач табле фиэлд шоулд бе он иц оwн лине.
- Адд спаcес то эитҳер сиде оф ан ассигнмент оператор (эқуалс сигн).
- Леаве а бланк лине бетwеэн тйпес. Тйпе алиасес шоулд бе сет офф фром тҳеир басе тйпе бй а бланк лине, бут но бланк линес шоулд бе плаcед бетwеэн тҳе алиасес тҳемселвес.