Модуль:Sources/doc

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

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

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

• Модуль:Sources/utils

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

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

Функции

Внешние

Внешние функции принимают объекты типа фрейм и предназначены для вызова из других модулей или через функцию парсера Шаблон:Code.

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

p.renderSource(frame)

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

• Шаблон:Code — анонимный аргумент, задающий идентификатор объекта на викиданных, по которому нужно сгенерировать ссылку. Например, Q20750516.
• Шаблон:Code — задаёт метку ref, которую в дальнейшем можно будет использовать в шаблонах типа {{sfn}}.
• Шаблон:Code — задаёт метку ref-year, которая используется аналогично метке ref.
• Шаблон:Code — дополнительный аргумент, позволяющий уточнить часть источника, на которую идёт ссылка (например, главу в книге).
• Шаблон:Code — ссылка, которую следует поставить на часть, описанную предыдущим аргументом.
• Шаблон:Code — конкретные страницы в источнике, на которые ведётся ссылка.
• Шаблон:Code — позволяет явно указать, какую ссылку нужно будет проставить на источник.
• Шаблон:Code — позволяет явно указать том источника, на который идёт ссылка.
• Шаблон:Code — позволяет явно указать выпуск источника, на который идёт ссылка.

Пробрасывание большей части аргументов происходит в utils.copyArgsToSnaks. Сам переданный фрейм сохраняется в p.currentFrame для дальнейшего использования, а на основе переданных аргументов функцией artificialSnaks создаются искусственные снеки, которые ссылаются на источник, указанный в Шаблон:Code, через свойства 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. Если вики-текст для сноски был успешно сгенерирован, он оборачивается в тэг Шаблон:Code с помощью 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 и обрамлённый в Шаблон:Code.

appendTitle(result, context, src)

Дописывает к result строку Шаблон:Code либо только Шаблон:Code если 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 строку Шаблон:Code если src.subtitle определён.

appendOriginalTitle(result, context, src)

Дописывает к result строку Шаблон:Code если src.originaltitle определён.

appendPublication(result, context, src)

Дописывает к result строку Шаблон:Code если определён src.publication.subtitle, либо Шаблон:Code если определён только src.publication.

appendEditor(result, context, src)

Дописывает к result строку Шаблон:Code если определён src.editor, где prefix определяется по context.lang (по умолчанию, Шаблон:Code).

appendEdition(result, context, src)

Дописывает к result строку Шаблон:Code если src.edition определён.

appendPublicationData(result, context, src)

Добавляет к result строку вида Шаблон:Code если хотя бы один из указанных параметров определён. Неуказанная часть опускается вместе с соответствующей пунктуацией. В частности, двоеточие ставится только если указано src.place и хотя бы что-то из src.publisher и src.year, запятая ставится только если указаны и src.publisher, и src.year. Тире и точка ставятся если указан хотя бы один из параметров.

appendVolumeAndIssue(result, context, src)

Добавляет к result строку виду Шаблон:Code если хотя бы один из указанных параметров определён. Запятая ставится если указаны оба параметра. letter_vol и letter_iss определяются по context.lang (например, Шаблон:Code и Шаблон:Code для русских текстов, Шаблон:Code и Шаблон:Code для английских).

appendPages(result, context, src)

Добавляет к result строку вида Шаблон:Code если src.pages определён, при этом в качестве разделителя в src.pages, если это диапозон страниц, используется символ «—», а letter определяется исходя из context.lang (например, Шаблон:Code для английского и Шаблон:Code для русского).

appendNumberOfPages(result, context, src)

Добавляет к result строку вида Шаблон:Code если src.numberOfPages определён. При этом letter определяется из context.lang (Шаблон:Code для английского и Шаблон:Code для русского).

appendBookSeries(result, context, src)

Добавляет к result строку вида Шаблон:Code если src.bookSeries определено. Точка с запятой ставится только если определено src.bookSeriesVolume или src.bookSeriesIssue, запятая ставится если определены оба параметра. letter_vol и letter_iss определяются из context.lang, аналогично тому, как это делается в appendVolumeAndIssue.

appendBookSeries(result, context, src)

Добавляет к result информацию из src.tirage если тот определён. Формат определяется из context.lang, для английского это Шаблон:Code, а для русского Шаблон:Code.

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 в Шаблон:Code, где citetyle это src.type если это поле определено и citetype_unknown в противном случае.

appendAccessDate(result, context, src)

Добавляет к result строку виду Шаблон:Code, где 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, если и это не получается, то присваивает Шаблон:Code.

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 дополнительно обрамляется в Шаблон:Code

artificialSnaks(args)

Создаёт искусственные снеки, которые ссылаются на источник с идентификатором frame.args[1] через свойства P248 (stated in) и P805 (statement is subject of), а также пробрасывает в них аргументы (том, выпуск и т. д.).