WMDE Technical Wishes/Sub-referencing/ru
| Вложенные сноски | |
|---|---|
| Status | В разработке |
| Origin | Технические пожелания 2013, 2015, 2022 и другие |
| Focus area | Сделать повторное использование примечаний проще |
| Phabricator | доска проекта |
| Responsible | Команда технических пожеланий |
 Расскажите нам, что вы думаете Мы приглашаем вас протестировать наш прототип, который мы постоянно обновляем. Добавьте в список наблюдения эту страницу или подпишитесь на этот список рассылки, чтобы узнать о новинках, которые вы можете протестировать | |
В настоящее время невозможно легко повторно использовать одну и ту же сноску с другими подробностями в статье. Члены сообщества неоднократно просили решение MediaWiki, которое работает без шаблонов и основано на существующем способе работы сносок, как для вики-текста, так и для визуального редактора. » Подробнее о проблеме
В рамках направления «Упрощение повторного использования ссылок» команда технических пожеланий Викимедиа Германия представляет вложенные сноски — дополнительную функцию, которая позволяет легко прикреплять различные сведения к существующей сноске без необходимости её дублирования.
Our plan is to bring Sub-referencing to the Wikimedia wikis in 2025.
О вложенных сносках кратко
Чтобы цитировать источник больше одного раза с разными подробностями, вам нужны основная сноска и вложенные сноски.
- Основная сноска содержит основную библиографическую информацию.
- Вложенная сноска содержит подробности: номера страниц или любую дополнительную информацию, которая может отличаться для каждого включения, например, главы, стихи или примечания.
- A sub-reference defines additional details, such as page numbers, chapters, verses, quotes, or video timestamps. In the screenshot, "1.1" and "1.2" followed by a page number represent two different sub-references.
- В разделе ссылок читатели видят все вложенные сноски, сгруппированные под их основной сноской. Это облегчает понимание того, как часто один источник цитировался в этой статье.
In wikitext you use a new attribute to define the details of a sub-reference. It’s called details. See below for more information and examples.
В визуальном редакторе мы изменяем существующее диалоговое окно цитирования, чтобы оно поддерживало вложенные сноски.
Основные преимущества
- Sub-referencing is largely based on the existing way references work.
- It's designed to work for both Visual Editor and wikitext.
- Решение будет интегрировано в MediaWiki, таким образом, доступно во всех вики-проектах Викимедиа и может быть использовано без решений на основе шаблонов.
- Вложенные сноски будут правильно отображаться в предпросмотре примечаний и мобильных попапах примечаний.
- Это не обязательно: вы можете использовать другие методы для сносок. Но вы можете столкнуться с вложенной сноской в статьях, написанных другими участниками.
- Протестируйте прототип! Узнайте больше о том, как тестировать.
- Оставьте общий отзыв на странице обсуждения.
- Добавьте в список наблюдения эту страницу или подпишитесь на этот список рассылок, чтобы узнать о новинках, которые вы можете протестировать.
Как это работает
В вики-тексте
Решение вложенных сносок в вики-тексте почти готово. Однако имя атрибута может измениться. Решение еще не развернуто, в основном потому, что мы хотим избежать того, чтобы пользователи визуального редактора имели совершенно другой опыт, чем пользователи, редактирующие вики-текст. Поддержка визуального редактора всё ещё находится в разработке.
Преимущества, специфичные для вики-текста
- Решение основывается на существующей и известной концепции именованных ссылок.
- Оно не требует знаний шаблонов.
- В вики-тексте можно удалить почти дублирующиеся сноски, что делает его чище, менее избыточным и более простым для чтения.
How to use Sub-referencing in wikitext
1) Define a Main Reference
Before creating sub-references, you need a main reference that contains the full bibliographic information. This reference must be assigned a name:
<ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref>
This main reference can either be defined in-line (within the article text) or in the reference section.
2) Creating a Sub-reference for Inline References
If the main reference is inline, you can create a sub-reference in two ways using the details attribute:
Option 1: Modify the main reference to include additional details (e.g. a page number)
<!-- Add the details attribute directly to the <ref> tag -->
<ref name="Miller" details="Page 23.">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref>
<!-- As a next step, you can add another sub-reference using the following statement: -->
<ref name="Miller" details="Page 48." />
Example Usage:
According to scientists, the Sun is pretty big. In fact, it is very big.<ref name="Miller" details="Page 23.">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref> Take their word for it.<ref name="Miller" details="Page 48." />
== References ==
{{reflist}} <!-- or <references /> -->
Option 2: Insert one or more separate sub-references directly within a new in-line statement while keeping the main reference intact.
<!-- Unchanged main reference (in-line): -->
<ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref>
<!-- New sub-references: -->
<ref name="Miller" details="Page 23." />
<ref name="Miller" details="Page 48." />
Example Usage:
According to scientists, the Sun is pretty big. <ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref> In fact, it is very big.<ref name="Miller" details="Page 23." /> Take their word for it.<ref name="Miller" details="Page 48." />.
== References ==
{{reflist}} <!-- or <references /> -->
3) Create Sub-References for List-Defined References
If the main reference is stored in the <references> tag or within {{reflist}} (or similar templates), you don't need to redefine it in-line. Instead, simply use the following syntax in-line:
<!-- Add this directly to the chosen location in the article text -->
<ref name="Miller" details="Page 23." />
<!-- The list-defined reference stays unchanged: -->
<references>
<ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref>
</references>
Example Usage:
According to scientists, the Sun is pretty big. In fact, it is very big.<ref name="Miller" details="Page 23." /> Take their word for it.<ref name="Miller" details="Page 48." />
== References ==
<references>
<ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005.</ref>
</references>
4) Reusing an Existing Sub-reference
Once a sub-reference has been defined, you can reuse it in multiple places without redefining the main reference. Simply repeat the same reference syntax in-line:
<ref name="Miller" details="Page 23." />
- Please note that while this is not a pure reuse like you are used to with main references and does create duplicates in wikitext, in the reader and Visual Editor view, identical statements will be merged to prevent unnecessary duplication in the rendered output. This is still work in progress.
- The same re-use statement applies for list-defined and inline main references.
- Tip: Copying and pasting an existing sub-reference statement remains a simple and recommended approach.
Example Usage for Reuse of Inline References:
According to scientists, the Sun is pretty big.<ref name="Miller" details="Page 23.">E. Miller, ''The Sun''. New York: Academic Press, 2005</ref> In fact, it is very big. Take their word for it.<ref name="Miller" details="Page 48." /> Don't look directly at the sun!<ref name="Miller" details="Page 23." />
== References ==
{{reflist}}
Example Usage for Reuse of List-defined References:
According to scientists, the Sun is pretty big.<ref name="Miller" details="Page 23." /> In fact, it is very big. Take their word for it.<ref name="Miller" details="Page 48." /> Don't look directly at the sun!<ref name="Miller" details="Page 23." />
== References ==
<references>
<ref name="Miller">E. Miller, ''The Sun''. New York: Academic Press, 2005</ref>
</references>
Keep In Mind
- Remember to always specify a reference name when using the details attribute. Using a reference name allows others to easily re-use the same reference with different details without needing to define a name first.
- Sub-referencing is not reserved for page numbers only. You can use it for other use cases, too. Some editors have mentioned to us that they’d like to use it for podcast timestamps, URLs, poetry verses, quotes, and other details.
- If you wish to use quotation marks
"withindetails="…"(e.g. when inserting a quote), make sure to use"instead, or delimit the details with single quotes. Visual Editor users will be able to type " when filling out sub-reference details and it will be converted automatically in wikitext. Other special characters which might need to be handled similarly when used withdetails="…"are<and>. - Some gadgets/scripts related to references might also need an update in order to properly work with the new sub-referencing solution.
- When using sub-references, please avoid templates that produce
<ref>tags, as these cause issues in Visual Editor which we cannot solve at this point in time.
В визуальном редакторе (в разработке)
We are actively refining the user experience and workflows for Sub-referencing in Visual Editor. Currently, there is one entry point via the “re-use” tab for creating a sub-reference, but the solution for Visual Editor is expected to evolve in the coming months.
You can also test the prototype with the current state of the Visual Editor solution. Please keep in mind that it will likely change. As always, we will keep you and these project pages updated as Visual Editor gains more capabilities and let you know when we need your feedback!
Преимущества, специфичные для визуального редактора
- Чтобы сослаться на один и тот же источник с разными подробностями, вам больше не нужно создавать новую сноску с нуля.
- Вложенные сноски полностью совместимы с визуальным редактором (в отличие от решений на шаблонах): вы можете создать их через диалог цитирования и редактировать их из раздела примечаний.
Рабочие процессы в текущем прототипе (вероятно, изменятся)
Создание вложенной сноски
- Создание вложенной сноски в настоящее время работает через существующий диалог цитирования.
- Во вкладке «Расширяет» выберите сноски, которую вы хотите повторно использовать. Эта вкладка, вероятно, будет улучшена после наших текущих сессий тестирования с пользователями.
- Введите подробности этой вложенной сноски и кликните на вставку.
- В окне сноски в визуальном редакторе вы видите, что эта сноска является вложенной, и как часто она используется повторно.
Редактирование существующей вложенной сноски
- Нажмите на маркер примечания в тексте статьи, чтобы редактировать вложенную сноску.
- Теперь вы можете изменить подробности вложенной сноски. Вы также информированы, что это сноска является вложенной.
- Вы пока не сможете редактировать вложенную сноску из списка примечаний.
- Чтобы редактировать основную сноску, нажмите на неё в разделе примечаний.
Повторное использование вложенной сноски
- Вы можете повторно использовать вложенную сноску с помощью вкладки «повторное использование» в диалоге цитирования.
Обратите внимание
- Существующая проблема с автоматическими именами сносок в визуальном редакторе возникает также и с вложенными сносками.
- We are actively working on creating an even more intuitive user experience for Visual Editor. What you see now is just the beginning, it will be refined and improved over time.
- Мы еще не проработали, что происходит, когда удаляется ссылка, которая используется повторно.
- Currently, if you re-use a sub-reference it will show as a duplicate in the reference list. Once the Visual Editor's UX has evolved, the duplicates will automatically be merged in Visual Editor and the reader view.
Тестирование прототипа
Нам нужны ваши отзывы, чтобы убедиться, что мы создаем правильные вещи. Отзывы и вопросы всегда приветствуются на странице обсуждения этого проекта.
Прототип доступен на бета-вики. В настоящее время мы прежде всего приглашаем вас протестировать решение для вики-текста:
- Они могут выглядеть по-другому (например, не использовать предпочитаемую вами тему оформления).
- Они могут предлагать некоторые новые функции, которые ещё испытываются.
- Они содержат только некоторые тестовые страницы и шаблоны, не весь контент вашей вики, как и не все шаблоны, модули, гаджеты и т. д., к которым вы привыкли.
- Ваш обычный логин в проектах Викимедиа не работает на бета-вики. Вы можете либо зарегистрировать учетную запись — обязательно используйте пароль, отличный от вашего обычной учётной записи Викимедиа — или протестировать функцию без учетной записи, что приведет к созданию временной учетной записи (на de-betawiki) — или отобразит ваш IP-адрес (на en-betawiki).
Проблема, которую мы решаем
В статьях Википедии принято ссылаться на источник несколько раз. Но хотя вы можете повторно использовать сноску точно такой, какая она есть, в настоящее время вы не можете повторно использовать ту же ссылку с другими подробностями (например, с другими номерами страниц). Единственный вариант — создать совершенно новую ссылку или использовать обходные пути.
Статус-кво: повторное использование сносок в вики-тексте и визуальном редакторе
Если вы хотите повторно использовать сноску в вики-тексте, вы можете превратить ее в именованную ссылку и ссылаться на это имя в другом месте статьи. Именованную сноску можно разместить в тексте статьи или в разделе примечаний. В визуальном редакторе вы можете использовать опцию «повторное использование» в диалоге цитирования. В разделе примечаний ссылки с одинаковым именем группируются вместе.
-
Вики-текст: <ref name> в тексте статьи -
Вики-текст: <ref name> в разделе примечаний -
Визуальный редактор: диалог цитирования -
Вид для читателя
Статус-кво: повторное использование сносок с различными подробностями в вики-тексте
Если вы хотите повторно использовать существующую сноску с другими подробностями в вики-тексте, вам в настоящее время необходимо скопировать и вставить существующую сноску и изменить подробности дубликата или создать новую (почти идентичную) сноску с нуля. Некоторые проекты используют обходные пути, такие как короткие цитаты или решения на основе шаблонов, такие как сокращенные сноски. В разделе примечаний исходная сноска и новая, которую вы создали, не группируются вместе.
-
Два почти идентичных сноски в вики-тексте. -
Вид для читателя: почти одинаковые сноски не объединены -
Обходной путь с короткими цитатами в вики-тексте -
Вид для читателя: обходной путь с короткими цитатами -
Обходной путь с {{sfn}} в вики-тексте -
Вид для читателя: обходной путь с {{sfn}}
Статус-кво: повторное использование сносок с различными подробностями в визуальном редакторе
Если вы хотите повторно использовать существующую сноску с другими подробностями в визуальном редакторе, ни опция «повторное использование» в диалоговом окне цитирования, ни метод копирования и вставки не сработают, поскольку оба варианта приводят к идентичным повторным использованиям, а изменение подробностей повторно используемой/скопированной сноски изменяет оба экземпляра этой сноски. Вместо этого вам нужно будет создать новую (почти идентичную) сноску с нуля. В разделе примечаний исходная сноска и новая, которую вы создали, не будут сгруппированы вместе.
Сноски, созданные на основе шаблонов, такие как {{sfn}}, не могут быть изменены из раздела сносок и не появляются в вкладке повторного использования диалога цитирования; но можно редактировать их вручную, найдя их в тексте статьи.
обходной путь с {{sfn}}:
-
Вид для читателя -
Сноски исчезают из раздела примечаний при клике на «редактировать». -
Невозможно использовать сноски {{sfn}} через диалог «повторное использование». -
Сноски можно редактировать только найдя их в тексте статьи
Проблемы для читателей
Обходные пути на основе шаблонов не отображаются должным образом в предварительном просмотре сносок, подсказках для сносок и мобильных всплывающих окнах со сносками.
обходной путь {{sfn}} с предварительным просмотром сносок:
-
Предварительный просмотр сносок: Основная информация не отображается во всплывающем окне. -
Подсказки для сносок: Основная информация не включена в начальное всплывающее окно. -
Подсказки для сносок: Основная информация отображается в отдельном всплывающем окне. -
Всплывающее окно сноски на мобильных: Основная информация не включена.
Основные проблемы со статус-кво
- Опыт пользователей визуального редактора и вики-текста очень отличается.
- Большинство решений для повторного использования сносок с различными деталями не работают должным образом в визуальном редакторе.
- Создание множества почти идентичных сносок с разными деталями делает вики-текст длиннее и, вероятно, труднее для чтения.
- Реализация методов решения на основе шаблонов не принимается во всех сообществах одинаково и, следовательно, не доступна в глобальном масштабе.
- Некоторые пользователи пытаются избежать этой проблемы, помещая источники в разделе библиографии без использования их в качестве сносок, что затрудняет проверку разделов статьи.
Недавние изменения и следующие шаги
Наша команда уже некоторое время работает над этой проблемой. Вот обзор истории этого проекта, включая наши исследования.
Спасибо всем, кто принимал участие в тестах и интервью и проявил интерес, а также всем, кто находил время, чтобы комментировать наши страницы обсуждения на протяжении многих лет. Мы это очень ценим. Если у вас есть дополнительные отзывы, пожалуйста, поделитесь ими на странице обсуждения.
Thank you to everyone who participated in tests and interviews and who showed interest, as well as everyone who took the time to comment on our talk pages over the years. It is deeply appreciated. If you have further feedback, please share it on the talk page.
Updates March 2025
In 2024 we worked on a prototype for discovery and testing purposes based on the extends syntax and engaged with the community through multiple on-wiki communications, user testing sessions, and workshops in different venues, including Wikimania 2024.- In October/November 2024, we explored possible changes to our wikitext approach, based on the community feedback we've received. We reached out to communities and presented a new solution to get their feedback on its usability. We found that the feedback was mixed but nothing spoke against the feature bringing its intended value to the community.
- In 2025, we started the development of the new syntax. The engineers and designer of the Technical Wishes team are working on building out Sub-referencing.
Next Steps
The Technical Wishes team’s focus remains on completing the sub-referencing feature.
- We’ll update you continuously as the feature evolves on the betawiki and we need you to test it.
- Conducting user testing sessions with community members to help us with intuitively designing the Visual Editor workflows.
- Once the development has reached a stable state, we will reach out to Pilot wikis to plan deployments.
- We are planning to deploy the sub-referencing feature to other Wikimedia wikis in 2025.
- We will continue to collect feedback to improve the solution after deployment.
Мы знаем о других проблемах в области «повторного использования сносок», и мы постараемся решить их по ходу дела. Однако наше внимание по-прежнему сосредоточено на создании решения для вложенных сносок.
Archived updates from 2024
- Прототип доступен на бета-вики. Он охватывает решение для вики-текста и некоторые основные функции решения для визуального редактора. Вы можете непрерывно тестировать прототип и давать отзывы.
- Мы будем публиковать анонсы во всех вики-проектах, чтобы сообщества знали об этой предстоящей функции, и приглашать их тестировать и давать отзывы.
- Our team presented Sub-referencing at Wikimania 2024 and discussed with participants. (YouTube)
- Moderated users tests took place across different projects in 2024.
- As of October/November 2024, we are currently exploring possible changes to our wikitext approach, based on the community feedback we've received. We'll reach out to communities soon to get more feedback on possible changes to the Sub-referencing feature.
- Pilot wiki deployment is stalled, pending discussions and potential changes to our feature.
- We are planning to deploy the Sub-referencing feature to other Wikimedia wikis in 2025.
- Мы будем продолжать собирать обратную связь для улучшения решения после его внедрения.
Часто задаваемые вопросы
Как мне найти статьи, которые используют вложенные сноски?
A tracking category called Category:Pages that use sub-references is added to any page where Sub-referencing is used, allowing you to explore or fix pages using the new feature. The name of this category might change.
Also, the team has created a number of examples on the English betawiki.
Can I insert a template into the details attribute?
The feedback we received so far from the community suggests that using templates in an attribute may cause more issues than benefits. As such, we are evaluating whether to allow templates based on technical feasibility, their impact on Visual Editor’s rendering of references, and other concerns raised by contributors.
We will update you once we have learned more and a decision has been made. Please know that we will always include the community before such a decision is made. If you already have specific ideas about the use of templates within the details attribute, please let us know on our talk page.
How will the new feature affect existing gadgets and scripts?
Some gadgets and scripts related to references might need an update in order to properly work with the new Sub-referencing solution. Because gadgets and scripts are in the hands of the wiki communities, we are unable to adapt them.
Please let us know, on the talk page, if you discover any problems or need some help updating citation templates to make them work with the new feature.
Почему вы выбрали такой синтаксис вики-текста?
This post provides a rationale for choosing the details syntax. We believe that the best and quickest path to delivering a usable feature is through the chosen syntax, even though it does come with some limitations.
Historically, no syntax has been perfect, and each solution has its shortcomings. After long discussions and consultations with multiple teams at the Wikimedia Foundation, we've concluded that this solution meets our technical requirements and is sustainable for long-term maintenance.
It's also fully compatible with wikis that continue to rely on or prefer using {{reflist}}. This syntax allows the main reference to be used in-line without needing to be placed in the References section, which would otherwise cause limitations in the Visual Editor.
Furthermore, we’re confident that this approach will work consistently across Visual Editor workflows as well.
Почему поиск решения занял так много времени?
Команда технических пожеланий работала над этой функцией с перерывами много лет. Если вы хотите узнать больше, вот обзор истории и сложности этой проблемы.