Модуль:Sources/doc

Принцип работы модуля

Данный модуль генерирует текст, используемый в сносках, ссылающихся на элемент викиданных.

Тесты [ править ]

9 тестов провалено.

test_personNameToAuthorName

	Тест	Ожидаемое значение	Фактическое значение
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Ломоносов, Михаил Васильевич }}	Ломоносов М. В.	Ломоносов М. В.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Ломоносов, Михаил }}	Ломоносов М.	Ломоносов М.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Михаил Васильевич Ломоносов }}	Ломоносов М. В.	Ломоносов М. В.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Михаил Ломоносов }}	Ломоносов М.	Ломоносов М.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | М. В. Ломоносов }}	Ломоносов М. В.	Ломоносов М. В.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | М. Ломоносов }}	Ломоносов М.	Ломоносов М.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Ломоносов М. В. }}	Ломоносов М. В.	Ломоносов М. В.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Ломоносов М. }}	Ломоносов М.	Ломоносов М.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Топчибашев, Мустафа Агабек оглы }}	Топчибашев М. А.	Топчибашев М. А.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Гельмонт, Ян Баптиста ван }}	ван Гельмонт Я. Б.	ван Гельмонт Я. Б.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Гельмонт, Ян ван }}	ван Гельмонт Я.	ван Гельмонт Я.
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToAuthorName | Jan Baptista van Helmont }}	van Helmont J. B.	van Helmont J. B.
Файл:X mark.svgN	{{#invoke:Sources | testPersonNameToAuthorName | Jan van Helmont }}	van Helmont J.	Helmont J. v.

test_personNameToResponsibleName

	Тест	Ожидаемое значение	Фактическое значение
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Ломоносов, Михаил Васильевич }}	М. В. Ломоносов	М. В. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Ломоносов, Михаил }}	М. Ломоносов	М. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Михаил Васильевич Ломоносов }}	М. В. Ломоносов	М. В. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Михаил Ломоносов }}	М. Ломоносов	М. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | М. В. Ломоносов }}	М. В. Ломоносов	М. В. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | М. Ломоносов }}	М. Ломоносов	М. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Ломоносов М. В. }}	М. В. Ломоносов	М. В. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Ломоносов М. }}	М. Ломоносов	М. Ломоносов
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Топчибашев, Мустафа Агабек оглы }}	М. А. Топчибашев	М. А. Топчибашев
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Гельмонт, Ян Баптиста ван }}	Я. Б. ван Гельмонт	Я. Б. ван Гельмонт
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Гельмонт, Ян ван }}	Я. ван Гельмонт	Я. ван Гельмонт
Файл:Yes check.svg	{{#invoke:Sources | testPersonNameToResponsibleName | Jan Baptista van Helmont }}	J. B. van Helmont	J. B. van Helmont
Файл:X mark.svgN	{{#invoke:Sources | testPersonNameToResponsibleName | Jan van Helmont }}	J. van Helmont	J. v. Helmont

test_renderSource

	Тест	Ожидаемое значение	Фактическое значение
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q20750516}}	президент Российской Федерации Указ Президента Российской Федерации от 15 января 1992 г. № 23 «О Генеральном директоре Агентства федеральной безопасности Российской Федерации и Министре внутренних дел Российской Федерации» // Собрание законодательства Российской Федерации — 1992.
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q21683979}}	Advances in Cryptology — EUROCRYPT 2004 (англ.): International Conference on the Theory and Applications of Cryptographic Techniques, Interlaken, Switzerland, May 2-6, 2004. Proceedings / C. Cachin, J. L. Camenisch — Springer, Berlin, Heidelberg, 2004. — 630 p. — ISBN 978-3-540-21935-4 — doi:10.1007/B97182
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q21683981}}	Nguyen P. Can We Trust Cryptographic Software? Cryptographic Flaws in GNU Privacy Guard v1.2.3 (англ.) // Advances in Cryptology — EUROCRYPT 2004: International Conference on the Theory and Applications of Cryptographic Techniques, Interlaken, Switzerland, May 2-6, 2004. Proceedings / C. Cachin, J. L. Camenisch — Springer, Berlin, Heidelberg, 2004. — P. 555—570. — 630 p. — ISBN 978-3-540-21935-4 — doi:10.1007/978-3-540-24676-3_33
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q21725400}}	Eichenauer J., Lehn J. A non-linear congruential pseudo random number generator (англ.) // Statistische Hefte — Springer Berlin Heidelberg, Springer Science+Business Media, 1986. — Vol. 27, Iss. 1. — P. 315—326. — ISSN 0932-5026; 1613-9798 — doi:10.1007/BF02932576
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q21725116}}	Menezes A. J., Oorschot P. v., Vanstone S. A. Handbook of Applied Cryptography (англ.) — CRC Press, 1996. — 816 p. — (Discrete Mathematics and Its Applications) — ISBN 978-0-8493-8523-0
Файл:X mark.svgN	{{#invoke:Sources | renderSource | Q27450585}}	Введение в криптографию / под ред. В. В. Ященко — М.: МЦНМО, 2000. — 271 с. — ISBN 978-5-900916-26-2

test_templates

	Тест	Ожидаемое значение	Фактическое значение
Файл:X mark.svgN	{{source | Q21725116}}	Menezes A. J., Oorschot P. v., Vanstone S. A. Handbook of Applied Cryptography (англ.) — CRC Press, 1996. — 816 p. — (Discrete Mathematics and Its Applications) — ISBN 978-0-8493-8523-0

Служебные подмодули

• Модуль:Sources/utils

Используемые параметры Викиданных

Свойство	Комментарий
	используется для указания названия статьи в энциклопедии
	если требуется переопределить название из метки элемента

Функции

Внешние

Внешние функции принимают объекты типа фрейм и предназначены для вызова из других модулей или через функцию парсера <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{#invoke:}}</syntaxhighlight>.

Прямое обращение к функциям модулей в статьях крайне нежелательно! Используйте для этих целей подходящие шаблоны.

p.renderSource(frame)

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

• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args[1]</syntaxhighlight> — анонимный аргумент, задающий идентификатор объекта на викиданных, по которому нужно сгенерировать ссылку. Например, Q20750516.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['ref']</syntaxhighlight> — задаёт метку ref, которую в дальнейшем можно будет использовать в шаблонах типа {{sfn}}.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['ref-year']</syntaxhighlight> — задаёт метку ref-year, которая используется аналогично метке ref.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['part']</syntaxhighlight> — дополнительный аргумент, позволяющий уточнить часть источника, на которую идёт ссылка (например, главу в книге).
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['parturl']</syntaxhighlight> — ссылка, которую следует поставить на часть, описанную предыдущим аргументом.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['pages']</syntaxhighlight> — конкретные страницы в источнике, на которые ведётся ссылка.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['url']</syntaxhighlight> — позволяет явно указать, какую ссылку нужно будет проставить на источник.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['volume']</syntaxhighlight> — позволяет явно указать том источника, на который идёт ссылка.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args['issue']</syntaxhighlight> — позволяет явно указать выпуск источника, на который идёт ссылка.

Пробрасывание большей части аргументов происходит в utils.copyArgsToSnaks. Сам переданный фрейм сохраняется в p.currentFrame для дальнейшего использования, а на основе переданных аргументов функцией artificialSnaks создаются искусственные снеки, которые ссылаются на источник, указанный в <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame.args[1]</syntaxhighlight>, через свойства P248 (stated in) и P805 (statement is subject of). Затем данные передаются в renderReferenceImpl для дальнейшей обработки.

p.renderReference(frame, currentEntity, reference)

Выдаёт вики-текст готовой сноски на заданный источник. Поддерживает те же аргументы, что и p.renderSource, кроме ref и ref-year. См. шаблоны {{source-ref}} и {{ВД-Сноска}}, использующие данную функцию. Также используется в Модуль:Wikidata для отображения ссылок, указанных возле утверждений на викиданных. Если currentEntity и reference отсутствуют, создаются искусственные снеки с помощью функции artificialSnaks, после чего они передаются в renderReferenceImpl. Если вики-текст для сноски был успешно сгенерирован, он оборачивается в тэг <syntaxhighlight lang="text" class="" id="" style="" inline="1"><ref></syntaxhighlight> с помощью frame: extensionTag, при этом имя для сноски генерируется путём хеширования её вики-текста через mw.hash.hashValue. Статьи, с такими сносками помещаются в Категория:Википедия:Статьи с источниками из Викиданных.

Внутренние

tokenizeName(fullName)

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

1. Фамилия, Имя
2. Фамилия, Имя Имя
3. Фамилия Фамилия, Имя
4. Имя Имя оглы Фамилия
5. Имя Имя де Фамилия
6. Имя … Имя Фамилия (хотя бы одно и не более четырёх единичных имён)

Здесь имя, в отличие от фамилии, может являться инициалом. Если ни один из форматов выше не выполнен, возвращает полное имя без изменений.

personNameToAuthorName(fullName)

Преобразует полное имя в формат Фамилия И. О. с помощью tokenizeName.

personNameToResponsibleName(fullName)

Преобразует полное имя в формат И. О. Фамилия с помощью tokenizeName.

getPeopleAsWikitext(context, value, options)

Преобразует список имён value в викитекст в соответствии со списком опций options. В опциях должны быть проставлены следующие поля:

1. separator — разделитель в списке;
2. conjunction — разделитель перед последним элементом списка;
3. format — функция, преобразующая имена к некоторому нормализованному виду (например, personNameToAuthorName);
4. nolinks — логическое значение, должно быть истинным если проставление ссылок нежелательно;
5. preferids — логическое значение, должно быть истинным если нужно вернуть id с викиданных, а не имена.

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

appendProperty(result, context, src, conjunctor, property, url)

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

generateAuthorLinks(context, src)

Возвращает список авторов src.author, оформленный через getPeopleAsWikitext и обрамлённый в <syntaxhighlight lang="text" class="" id="" style="" inline="1"><i class="wef_low_priority_links"></i></syntaxhighlight>.

appendTitle(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1">src.part // src.title</syntaxhighlight> либо только <syntaxhighlight lang="text" class="" id="" style="" inline="1">src.title</syntaxhighlight> если src.part не указан. Если возможно, обрамляет src.part (или src.title если src.part не указан) в src.url.

appendLanguage(result, context, src)

Если context.lang отличается от i18nDefaultLanguage (в нашем разделе русский), то указание об этом приписывается к result с помощью Модуль:Languages в формате {{ref-lang}}.

appendSubtitle(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1">: src.subtitle</syntaxhighlight> если src.subtitle определён.

appendOriginalTitle(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1"> = src.originaltitle</syntaxhighlight> если src.originaltitle определён.

appendPublication(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1"> // src.publication: src.publication.subtitle</syntaxhighlight> если определён src.publication.subtitle, либо <syntaxhighlight lang="text" class="" id="" style="" inline="1"> // src.publication</syntaxhighlight> если определён только src.publication.

appendEditor(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1"> / prefix src.editor</syntaxhighlight> если определён src.editor, где prefix определяется по context.lang (по умолчанию, <syntaxhighlight lang="text" class="" id="" style="" inline="1">под ред.</syntaxhighlight>).

appendEdition(result, context, src)

Дописывает к result строку <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — src.edition</syntaxhighlight> если src.edition определён.

appendPublicationData(result, context, src)

Добавляет к result строку вида <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — src.place: src.publisher, src.year.</syntaxhighlight> если хотя бы один из указанных параметров определён. Неуказанная часть опускается вместе с соответствующей пунктуацией. В частности, двоеточие ставится только если указано src.place и хотя бы что-то из src.publisher и src.year, запятая ставится только если указаны и src.publisher, и src.year. Тире и точка ставятся если указан хотя бы один из параметров.

appendVolumeAndIssue(result, context, src)

Добавляет к result строку виду <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — letter_vol src.volume, letter_iss src.issue.</syntaxhighlight> если хотя бы один из указанных параметров определён. Запятая ставится если указаны оба параметра. letter_vol и letter_iss определяются по context.lang (например, <syntaxhighlight lang="text" class="" id="" style="" inline="1">Т.</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">вып.</syntaxhighlight> для русских текстов, <syntaxhighlight lang="text" class="" id="" style="" inline="1">Vol.</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">Iss.</syntaxhighlight> для английских).

appendPages(result, context, src)

Добавляет к result строку вида <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — letter src.pages.</syntaxhighlight> если src.pages определён, при этом в качестве разделителя в src.pages, если это диапозон страниц, используется символ «—», а letter определяется исходя из context.lang (например, <syntaxhighlight lang="text" class="" id="" style="" inline="1">P.</syntaxhighlight> для английского и <syntaxhighlight lang="text" class="" id="" style="" inline="1">С.</syntaxhighlight> для русского).

appendNumberOfPages(result, context, src)

Добавляет к result строку вида <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — src.numberOfPages letter</syntaxhighlight> если src.numberOfPages определён. При этом letter определяется из context.lang (<syntaxhighlight lang="text" class="" id="" style="" inline="1">p.</syntaxhighlight> для английского и <syntaxhighlight lang="text" class="" id="" style="" inline="1">с.</syntaxhighlight> для русского).

appendBookSeries(result, context, src)

Добавляет к result строку вида <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — (src.bookSeries; letter_vol src.bookSeriesVolume, letter_iss src.bookSeriesIssue)</syntaxhighlight> если src.bookSeries определено. Точка с запятой ставится только если определено src.bookSeriesVolume или src.bookSeriesIssue, запятая ставится если определены оба параметра. letter_vol и letter_iss определяются из context.lang, аналогично тому, как это делается в appendVolumeAndIssue.

appendBookSeries(result, context, src)

Добавляет к result информацию из src.tirage если тот определён. Формат определяется из context.lang, для английского это <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — ed. size: src.tirage</syntaxhighlight>, а для русского <syntaxhighlight lang="text" class="" id="" style="" inline="1"> — src.tirage экз.</syntaxhighlight>.

appendIdentifiers(result, context, src)

Добавляет к result идентификаторы ISBN, ISSN, DOI, PMID и arXiv если те определены. Идентификаторы приписываются через тире, более точный формат определён в таблицах options_commas, options_issn, options_doi, options_pmid и options_arxiv.

appendSourceId(result, context, src)

Оборачивает result в <syntaxhighlight lang="text" class="" id="" style="" inline="1"><span class="wikidata_cite citetype" data-entity-id="src.sourceId"></span></syntaxhighlight>, где citetyle это src.type если это поле определено и citetype_unknown в противном случае.

appendAccessDate(result, context, src)

Добавляет к result строку виду <syntaxhighlight lang="text" class="" id="" style="" inline="1">Проверено dd month yyyy.</syntaxhighlight>, где dd, month и yyyy берутся из src.accessdate если данное поле определено.

populateUrl(context, src)

Если src.url не определено, но src.sourceId известен, пытается присвоить в src.url ссылку на викитеку.

populateYear(src)

Если src.year не определён, пытается заполнить его из src.dateOfPublication и src.dateOfCreation.

populateTitle(src)

Если src.title не определён, пытается присвоить ему src.url, если и это не получается, то присваивает <syntaxhighlight lang="text" class="" id="" style="" inline="1">(unspecified title)</syntaxhighlight>.

renderSource(context, src)

Внутренняя функция, генерирующая текст, который будет отображаться в сноске. Действует следующим образом:

1. Записывает src.lang в context.lang (или i18nDefaultLanguage если src.lang записать не получилось).
2. Вызывает populateUrl, populateTitle и populateYear.
3. Заводит переменную result, изначально равную generateAuthorLinks(context, src).
4. .Последовательно применяет к result функции appendTitle—appendAccessDate, при этом блок appendEditor—appendAccessDate дополнительно обрамляется в <syntaxhighlight lang="text" class="" id="" style="" inline="1"><span class="wef_low_priority_links"></span></syntaxhighlight>