Модуль:Sources/doc: различия между версиями

нет описания правки
(Новая страница: «{{СИШ}} {{module rating|p}} {{Используйте песочницу}} == Принцип работы модуля == Данный модуль генер...»)
 
Нет описания правки
Строка 4: Строка 4:


== Принцип работы модуля ==
== Принцип работы модуля ==
Данный модуль генерирует текст, используемый в сносках, ссылающихся на элемент Тептарданных.
Данный модуль генерирует текст, используемый в сносках, ссылающихся на элемент тептар-данных.
 
== Тесты [ [//ru.wikipedia.org/w/index.php?title=Модуль:Sources/тесты&action=edit править] ] ==
<includeonly>
{{#invoke: Sources/тесты | run_tests}}
</includeonly>
 
== Служебные подмодули ==
 
* [[Модуль:Sources/utils]]
 
== Используемые параметры Тептар-данных ==
{| class="standard"
! Свойство !! Комментарий
|-
| {{WD property|P50}} ||
|-
| {{WD property|P2093}} ||
|-
| {{WD property|P407}} ||
|-
| {{WD property|P364}} ||
|-
| {{WD property|P958}} || используется для указания названия статьи в энциклопедии
|-
| {{WD property|P1476}} || если требуется переопределить название из метки элемента
|-
| {{WD property|P1680}} ||
|-
| {{WD property|P953}} ||
|-
| {{WD property|P1065}} ||
|-
| {{WD property|P854}} ||
|-
| {{WD property|P1433}} ||
|-
| {{WD property|P393}} ||
|-
| {{WD property|P123}} ||
|-
| {{WD property|P291}} ||
|-
| {{WD property|P98}} ||
|-
| {{WD property|P304}} ||
|-
| {{WD property|P1104}} ||
|-
| {{WD property|P478}} ||
|-
| {{WD property|P433}} ||
|-
| {{WD property|P571}} ||
|-
| {{WD property|P577}} ||
|-
| {{WD property|P212}} ||
|-
| {{WD property|P957}} ||
|-
| {{WD property|P236}} ||
|-
| {{WD property|P1545}} ||
|-
| {{WD property|P818}} ||
|-
| {{WD property|P888}} ||
|}


== Функции ==
== Функции ==
Строка 14: Строка 82:


==== '''p.renderSource('''''frame''''')''' ====
==== '''p.renderSource('''''frame''''')''' ====
Выдаёт Тептар-текст ссылки на заданный источник для подстановки внутрь сноски или списка литературы. См. шаблоны {{tl|source}} и {{tl|ВД-Источник}}, использующие данную функцию''.'' Поддерживает следующие аргументы:
Выдаёт тептар-текст ссылки на заданный источник для подстановки внутрь сноски или списка литературы. См. шаблоны {{tl|source}} и {{tl|ВД-Источник}}, использующие данную функцию''.'' Поддерживает следующие аргументы:


*{{Code|frame.args[1]}} — анонимный аргумент, задающий идентификатор объекта на Тептарданных, по которому нужно сгенерировать ссылку. Например, [[d:Q20750516|Q20750516]].
*{{Code|frame.args[1]}} — анонимный аргумент, задающий идентификатор объекта на тептар-данных, по которому нужно сгенерировать ссылку. Например, [[d:Q20750516|Q20750516]].
*{{Code|frame.args['ref']}} — задаёт метку ''ref'', которую в дальнейшем можно будет использовать в шаблонах типа {{Tl|sfn}}.
*{{Code|frame.args['ref']}} — задаёт метку ''ref'', которую в дальнейшем можно будет использовать в шаблонах типа {{Tl|sfn}}.
*{{Code|frame.args['ref-year']}} — задаёт метку ''ref-year'', которая используется аналогично метке ''ref''.
*{{Code|frame.args['ref-year']}} — задаёт метку ''ref-year'', которая используется аналогично метке ''ref''.
Строка 26: Строка 94:
*{{Code|frame.args['issue']}} — позволяет явно указать выпуск источника, на который идёт ссылка.
*{{Code|frame.args['issue']}} — позволяет явно указать выпуск источника, на который идёт ссылка.


Пробрасывание большей части аргументов происходит в ''[[Модуль:Sources-utils|utils.copyArgsToSnaks]]''. Сам переданный фрейм сохраняется в ''p.currentFrame'' для дальнейшего использования, а на основе переданных аргументов функцией ''artificialSnaks'' создаются искусственные [[d:Wikidata:Glossary|снеки]],  которые ссылаются на источник, указанный в {{Code|frame.args[1]}}, через свойства [[d:Property:P248|P248]] (''stated in'') и [[d:Property:P805|P805]] (''statement is subject of''). Затем данные передаются в ''renderReferenceImpl'' для дальнейшей обработки.
Пробрасывание большей части аргументов происходит в ''[[Модуль:Sources/utils|utils.copyArgsToSnaks]]''. Сам переданный фрейм сохраняется в ''p.currentFrame'' для дальнейшего использования, а на основе переданных аргументов функцией ''artificialSnaks'' создаются искусственные [[d:Wikidata:Glossary|снеки]],  которые ссылаются на источник, указанный в {{Code|frame.args[1]}}, через свойства [[d:Property:P248|P248]] (''stated in'') и [[d:Property:P805|P805]] (''statement is subject of''). Затем данные передаются в ''renderReferenceImpl'' для дальнейшей обработки.


==== '''p.renderReference('''''frame, currentEntity, reference''''')''' ====
==== '''p.renderReference('''''frame, currentEntity, reference''''')''' ====
Выдаёт Тептар-текст готовой сноски на заданный источник. Поддерживает те же аргументы, что и ''p.renderSource'', кроме ''ref'' и ''ref-year''. См. шаблоны {{tl|source-ref}} и {{tl|ВД-Сноска}}, использующие данную функцию''.'' Также используется в [[Модуль:Wikidata]] для отображения ссылок, указанных возле утверждений на Тептарданных. Если ''currentEntity'' и ''reference'' отсутствуют, создаются искусственные снеки с помощью функции ''artificialSnaks,'' после чего они передаются в ''renderReferenceImpl''. Если Тептар-текст для сноски был успешно сгенерирован, он оборачивается в тэг {{Code|<nowiki><ref></nowiki>}} с помощью [[mw:Extension:Scribunto/Lua reference manual#frame:extensionTag|frame:extensionTag]], при этом имя для сноски генерируется путём хеширования её Тептар-текста через [[mw:Extension:Scribunto/Lua reference manual#mw.hash.hashValue|mw.hash.hashValue]]. Статьи, с такими сносками помещаются в [[:Категория:Тептар:Статьи с источниками из Тептарданных]].
Выдаёт тептар-текст готовой сноски на заданный источник. Поддерживает те же аргументы, что и ''p.renderSource'', кроме ''ref'' и ''ref-year''. См. шаблоны {{tl|source-ref}} и {{tl|ВД-Сноска}}, использующие данную функцию''.'' Также используется в [[Модуль:Wikidata]] для отображения ссылок, указанных возле утверждений на тептар-данных. Если ''currentEntity'' и ''reference'' отсутствуют, создаются искусственные снеки с помощью функции ''artificialSnaks,'' после чего они передаются в ''renderReferenceImpl''. Если тептар-текст для сноски был успешно сгенерирован, он оборачивается в тэг {{Code|<nowiki><ref></nowiki>}} с помощью [[mw:Extension:Scribunto/Lua reference manual#frame:extensionTag|frame:extensionTag]], при этом имя для сноски генерируется путём хеширования её тептар-текста через [[mw:Extension:Scribunto/Lua reference manual#mw.hash.hashValue|mw.hash.hashValue]]. Статьи, с такими сносками помещаются в [[:Категория:Тептар:Статьи с источниками из Тептар-данных]].


=== Внутренние ===
=== Внутренние ===


==== '''tokenizeName('''''fullName''''')''' ====
==== '''tokenizeName('''''fullName''''')''' ====
Преобразует полное имя в пару ''{фамилии через пробел, инициалы имён через пробел}''. Реализована в виде разбора случаев, которые можно встретить на Тептарданных:
Преобразует полное имя в пару ''{фамилии через пробел, инициалы имён через пробел}''. Реализована в виде разбора случаев, которые можно встретить на тептар-данных:


# ''Фамилия, Имя''
# ''Фамилия, Имя''
Строка 52: Строка 120:


==== '''getPeopleAsWikitext('''''context, value, options''''')''' ====
==== '''getPeopleAsWikitext('''''context, value, options''''')''' ====
Преобразует список имён ''value'' в Тептартекст в соответствии со списком опций ''options''. В опциях должны быть проставлены следующие поля:
Преобразует список имён ''value'' в тептар-текст в соответствии со списком опций ''options''. В опциях должны быть проставлены следующие поля:


# ''separator'' — разделитель в списке;
# ''separator'' — разделитель в списке;
Строка 58: Строка 126:
# ''format'' — функция, преобразующая имена к некоторому нормализованному виду (например, ''personNameToAuthorName'');
# ''format'' — функция, преобразующая имена к некоторому нормализованному виду (например, ''personNameToAuthorName'');
# ''nolinks'' — логическое значение, должно быть истинным если проставление ссылок нежелательно;
# ''nolinks'' — логическое значение, должно быть истинным если проставление ссылок нежелательно;
#''preferids'' — логическое значение, должно быть истинным если нужно вернуть id с Тептарданных, а не имена.
#''preferids'' — логическое значение, должно быть истинным если нужно вернуть id с тептар-данных, а не имена.


Если в списке больше ''maxAuthors'' (на текущий момент 10) людей, заменяет остальных на ''и др.'' или его аналоги (если в контексте указан язык, то используется ''i18nEtAl[context.lang]'', иначе используется ''i18nEtAlDefault'').
Если в списке больше ''maxAuthors'' (на текущий момент 10) людей, заменяет остальных на ''и др.'' или его аналоги (если в контексте указан язык, то используется ''i18nEtAl[context.lang]'', иначе используется ''i18nEtAlDefault'').


==== '''''appendProperty''('''''result, context, src, conjunctor, property, url''''')''' ====
==== '''appendProperty('''''result, context, src, conjunctor, property, url''''')''' ====
Приписывает ''src[property]'' к ''result'', разделяя их строкой, записанной в ''conjunctor''. Если возможно, оформляет его ссылкой на ''src[url].''
Приписывает ''src[property]'' к ''result'', разделяя их строкой, записанной в ''conjunctor''. Если возможно, оформляет его ссылкой на ''src[url].''


Строка 117: Строка 185:


==== '''populateUrl('''''context, src''''')''' ====
==== '''populateUrl('''''context, src''''')''' ====
Если ''src.url'' не определено, но ''src.sourceId'' известен, пытается присвоить в ''src.url'' ссылку на [[Тептартека|Тептартеку]].
Если ''src.url'' не определено, но ''src.sourceId'' известен, пытается присвоить в ''src.url'' ссылку на [[Тептар-тека|тептар-теку]].


==== '''populateYear('''''src''''')''' ====
==== '''populateYear('''''src''''')''' ====
Строка 135: Строка 203:
==== '''artificialSnaks('''''args''''')''' ====
==== '''artificialSnaks('''''args''''')''' ====
Создаёт искусственные [[d:Wikidata:Glossary|снеки]], которые ссылаются на источник с идентификатором ''frame.args[1]'' через свойства [[d:Property:P248|P248]] (''stated in'') и [[d:Property:P805|P805]] (''statement is subject of''), а также пробрасывает в них аргументы (том, выпуск и т. д.).
Создаёт искусственные [[d:Wikidata:Glossary|снеки]], которые ссылаются на источник с идентификатором ''frame.args[1]'' через свойства [[d:Property:P248|P248]] (''stated in'') и [[d:Property:P805|P805]] (''statement is subject of''), а также пробрасывает в них аргументы (том, выпуск и т. д.).
 
<noinclude>
== Служебные подмодули ==
 
* [[Модуль:Sources-utils]]
* [[Модуль:Sources-authors]] (не используется)
 
== Используемые параметры Тептарданных ==
{| class="standard"
! Свойство !! Комментарий
|-
| {{WD property|P50}} ||
|-
| {{WD property|P2093}} ||
|-
| {{WD property|P407}} ||
|-
| {{WD property|P364}} ||
|-
| {{WD property|P958}} || используется для указания названия статьи в энциклопедии
|-
| {{WD property|P1476}} || если требуется переопределить название из метки элемента
|-
| {{WD property|P1680}} ||
|-
| {{WD property|P953}} ||
|-
| {{WD property|P1065}} ||
|-
| {{WD property|P854}} ||
|-
| {{WD property|P1433}} ||
|-
| {{WD property|P393}} ||
|-
| {{WD property|P123}} ||
|-
| {{WD property|P291}} ||
|-
| {{WD property|P98}} ||
|-
| {{WD property|P304}} ||
|-
| {{WD property|P1104}} ||
|-
| {{WD property|P478}} ||
|-
| {{WD property|P433}} ||
|-
| {{WD property|P571}} ||
|-
| {{WD property|P577}} ||
|-
| {{WD property|P212}} ||
|-
| {{WD property|P957}} ||
|-
| {{WD property|P236}} ||
|-
| {{WD property|P1545}} ||
|-
| {{WD property|P818}} ||
|-
| {{WD property|P888}} ||
|}
 
== Тесты [ [//ru.wikipedia.org/w/index.php?title=Модуль:Sources/тесты&action=edit править] ] ==
<includeonly>
{{#invoke: Sources/тесты | run_tests}}
</includeonly><noinclude>
[[Категория:Модули:Документация]]</noinclude>
[[Категория:Модули:Документация]]</noinclude>