WMDE Technical Wishes/Sub-referencing/pl
| Rozszerzanie przypisów | |
|---|---|
| Status | W trakcie |
| Origin | Ankiety życzeń Społeczności 2013, 2015, 2022 i inne |
| Focus area | Uczyńmy ponowne używanie przypisów łatwiejszym |
| Phabricator | tablica projektu |
| Responsible | Zespół ds. Życzeń Technicznych |
 Powiedz nam, co sądzisz Zapraszamy do przetestowania naszego prototypu, który jest stale aktualizowany. Obserwuj tę stronę lub zapisz się na tę listę wiadomości masowych, aby dowiedzieć się o nowych rzeczach, które można przetestować. | |
Obecnie nie ma możliwości łatwego ponownego wykorzystania tego samego źródła z różnymi szczegółami w artykule. Członkowie społeczności wielokrotnie prosili o rozwiązanie w MediaWiki, które działałoby bez szablonów i było oparte na istniejącym sposobie funkcjonowania przypisów, zarówno w edytorze wikikodu, jak i w edytorze wizualnym. » Dowiedz się więcej o problemie
W ramach obszaru fokusowego "Ułatwienie ponownego wykorzystania referencji", zespół ds. Życzeń Technicznych Wikimedia Deutschland wprowadza podprzypisy – opcjonalną funkcję, która umożliwia łatwe dodawanie różnych szczegółów do istniejących przypisów bez konieczności ich duplikowania.
Our plan is to bring Sub-referencing to the Wikimedia wikis in 2025.
Podprzypisy w skrócie
Aby cytować źródło więcej niż raz, lecz podając różne szczegóły, potrzebny jest przypis główny oraz podprzypis.
- Przypis główny zawiera podstawowe informacje bibliograficzne.
- Podprzypis zawiera szczegóły: numery stron lub wszelkie dodatkowe informacje, które różnią się dla każdego cytatu, takie jak rozdziały, wersety czy uwagi.
- 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.
- W sekcji przypisów czytelnicy widzą wszystkie podprzypisy pogrupowane pod głównym przypisem. Ułatwia to zrozumienie, jak często jedno źródło zostało cytowane w artykule.
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.
W edytorze wizualnym, zmieniamy istniejące okno dialogowe przypisów, aby obsługiwało podprzypisy.
Główne korzyści
- Sub-referencing is largely based on the existing way references work.
- It's designed to work for both Visual Editor and wikitext.
- Rozwiązanie zostanie zintegrowane z MediaWiki, dzięki czemu będzie dostępne na wszystkich wiki i będzie można z niego korzystać bez obejść opartych na szablonach.
- Podprzypisy będą prawidłowo wyświetlane w podglądach przypisów i wyskakujących okienkach przypisów mobilnych.
- Jest to opcjonalne: nadal możesz używać innych metod cytowania. Możesz jednak napotkać podprzypisy w artykułach napisanych przez innych użytkowników.
- Przetestuj prototyp! Czytaj więcej o tym jak testować.
- Przekaż ogólną opinię na stronie dyskusji.
- Obserwuj tę stronę lub zapisz się na listę masowych wiadomości, aby dowiedzieć się o nowych rzeczach, które możesz przetestować.
Jak to działa
W edytorze wikikodu
Funkcjonalność podprzypisów dla edytora wikikodu jest prawie gotowa. Jednakże nazwa atrybutu może ulec zmianie. Rozwiązanie to nie zostało jeszcze wdrożone, głównie dlatego, że chcemy uniknąć sytuacji, w której użytkownicy edytora wizualnego będą mieli zupełnie inne doświadczenia niż użytkownicy edytora wikikodu. Obsługa edytora wizualnego jest wciąż w fazie rozwoju.
Korzyści dla edytora kodu
- Rozwiązanie opiera się na istniejącym i znanym rozwiązaniu nazywania przypisów.
- Nie wymaga znajomości szablonów.
- Prawie zduplikowane przypisy można usunąć w wikikodzie, co sprawia, że tekst jest czytelniejszy i łatwiejszy do edytowania.
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.
W edytorze wizualnym (w fazie rozwoju):
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!
Korzyści dla edytora wizualnego
- Aby zacytować to samo źródło z innymi szczegółami, nie trzeba już tworzyć nowego przypisu.
- Podprzypisy są w pełni kompatybilne z edytorem wizualnym (w przeciwieństwie do obejść opartych na szablonach): można je tworzyć za pomocą okna dialogowego i edytować z poziomu sekcji przypisów.
Workflows in the current prototype (likely to change)
Tworzenie podprzypisu
- Tworzenie podprzypisu odbywa się obecnie za pośrednictwem okna dialogowego istniejącego przypisu.
- W zakładce „extends” wybierz przypis, który chcesz ponownie użyć. Ta zakładka zostanie prawdopodobnie ulepszona po fazie testów.
- Wpisz szczegóły danego podprzypisu i kliknij wstaw.
- Wyskakujące okienko w edytorze wizualnym pokazuje, że jest to podprzypis, a także ile razy jest on użyty.
Edycja istniejącego podprzypisu
- Kliknij na symbol podprzypisu w tekście artykułu, aby go edytować.
- Możesz zmienić jego szczegóły. Widzisz także informację, że jest to podprzypis.
- Nie można jeszcze edytować podprzypisów z poziomu listy przypisów.
- Aby edytować przypis główny, kliknij na niego w sekcji przypisów.
Ponowne użycie istniejącego podprzypisu
- Możesz ponownie użyć podprzypisu za pomocą odpowiedniej zakładki w oknie dialogowym.
Uwagi
- Istniejący problem z automatycznymi nazwami przypisów w edytorze wizualnym występuje również w przypadku podprzypisów.
- 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.
- Musimy jeszcze popracować nad tym, co dzieje się po usunięciu przypisu, który jest ponownie użyty.
- 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.
Przetestuj nasz prototyp
Potrzebujemy Twojej opinii, aby upewnić się, że działamy dobrze. Opinie i pytania są zawsze mile widziane na stronie dyskusji tego projektu.
Prototyp jest dostępny na beta wiki. Obecnie zapraszamy do przetestowania tej funkcjonalności dla edytora wikikodu:
- Może wyglądać inaczej (np. nie używać ustawionej przez Ciebie skórki).
- Może zawierać nowe funkcje, które są aktualnie testowane.
- Zawiera tylko kilka stron testowych i szablonów, nie posiada wszystkich modułów, gadżetów itp.
- Używany przez Ciebie w projektach Wikimedia login nie działa na beta wiki. Możesz albo zarejestrować konto (upewnij się, że używasz innego hasła niż to z konta Wikimedia), albo przetestować funkcję bez konta, co doprowadzi do utworzenia konta tymczasowego (na de-betawiki) lub wyświetlenia Twojego adresu IP (na en-betawiki).
Problem, nad którym pracujemy
W artykułach na Wikipedii powszechne jest wielokrotne odwoływanie się do tego samego źródła. Ale chociaż można ponownie użyć przypisu poprzez „kopiuj-wklej”, to nie jest możliwe ponowne użycie go z „różnymi szczegółami” (np. różnymi numerami stron). Jedyną opcją jest utworzenie zupełnie nowego przypisu lub skorzystanie z jakiegoś obejścia.
Status quo: ponowne użycie przypisu w edytorze wikikodu i edytorze wizualnym
Jeśli chcesz ponownie użyć przypisu w edytorze wikikodu, możesz przekształcić go w nazwany przypis i odwołać się do tej nazwy w innym miejscu artykułu. Nazwany przypis może być umieszczony w tekście artykułu lub w sekcji przypisów. W edytorze wizualnym można użyć opcji „użyj ponownie” w oknie dialogowym cytowania. W sekcji przypisów przypisy o tej samej nazwie są grupowane razem.
-
Edytor wikikodu: <ref name> w tekście artykułu -
Edytor wikikodu: <ref name> w sekcji przypisów -
Edytor wizualny: okno dialogowe cytowania -
Widok czytelnika
Status quo: ponowne użycie przypisu z różnymi szczegółami w edytorze wikikodu
Obecnie, jeśli chcesz ponownie użyć istniejącego przypisu z innymi szczegółami w edytorze wikikodu, musisz skopiować i wkleić istniejące przypisy i zmienić szczegóły drugiego lub utworzyć nowy (prawie identyczny) przypis. Niektóre projekty stosują obejścia, takie jak krótkie cytaty lub rozwiązania oparte na szablonach, takie jak skrócone przypisy. W sekcji przypisów, oryginalny przypis i nowy, który został utworzony, nie są zgrupowane razem.
-
Dwa prawie identyczne przypisy w edytorze wikikodu. -
Widok czytelnika: Prawie identyczne przypisy nie są zgrupowane -
Obejście z krótkimi cytatami w edytorze wikikodu -
Widok czytelnika: obejście z krótkimi cytatami -
Obejście z {{sfn}} w edytorze wikikodu -
Widok czytelnika: obejście z {{sfn}}
Status quo: ponowne użycie przypisu z różnymi szczegółami w edytorze wikikodu
Jeśli chcesz ponownie użyć istniejącego przypisu z innymi szczegółami w edytorze wizualnym, ani opcja „re-use” w oknie dialogowym cytowania, ani metoda kopiuj-wklej nie zadziałają, ponieważ obie prowadzą do „identycznych” efektów, a zmiana szczegółów ponownie używanego/kopiowanego przypisu zmienia „obie” instancje tego przypisu. Zamiast tego należy utworzyć nowy (prawie identyczny) przypis. W sekcji przypisów oryginalny i nowy nie są zgrupowane razem.
Przypisy stworzone przez rozwiązania oparte na szablonie, takie jak {{sfn}}, nie mogą być edytowane w sekcji przypisów i nie pojawiają się w zakładce ponownego użycia; można je edytować ręcznie w tekście artykułu.
Obejście z {{sfn}}:
-
Widok czytelnika -
Przypisy znikają z sekcji przypisów po kliknięciu "Edytuj". -
Nie można używać {{sfn}} poprzez zakładkę "re-use". -
Przypisy można edytować tylko w tekście artykułu
Problemy dla czytelników
Obejścia oparte na szablonach nie są poprawnie wyświetlane w Reference Previews, Reference Tooltips i wyskakujących okienkach mobilnych.
Obejście z użyciem {{sfn}} przy podglądzie przypisów:
-
Podgląd przypisów (Reference Previews): szczegółowe informacje nie pokazują się w okienku. -
Podgląd przypisów (Reference Tooltips): szczegółowe informacje nie pokazują się w okienku. -
Podgląd przypisów (Reference Tooltips): szczegółowe informacje pokazują się w osobnym okienku. -
Mobilne okienko: szczegółowe informacje się nie pokazują.
Najważniejsze problemy ze statusem quo
- Doświadczenia użytkowników edytora wizualnego i edytora wikikodu są bardzo różne.
- Większość rozwiązań dla ponownego użycia przypisów z różnymi szczegółami nie działa prawidłowo w edytorze wizualnym.
- Stworzenie wielu prawie identycznych przypisów z różnymi szczegółami sprawia, że wikikod strony jest dłuższy i potencjalnie trudniejszy do czytania.
- Rozwiązania oparte na szablonach nie są akceptowane przez wszystkie społeczności, a zatem nie są dostępne we wszystkich wersjach językowych.
- Niektórzy użytkownicy próbują uniknąć tego problemu, umieszczając źródła w sekcji bibliografii bez użycia ich jako przypisu, co utrudnia weryfikację treści w poszczególnych akapitach artykułu.
Ostatnie zmiany i następne kroki
Our team has worked on this problem on and off for some time now. Here is an overview of this project’s history, including our research.
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.
We are aware of other problems in the focus area "reusing references", and we will try to address them along the way. Our focus, however, remains on creating a solution for sub-referencing.
Archived updates from 2024
- A prototype is available on beta wiki. It covers the wikitext solution and some of the basic features of the Visual Editor solution. You can continuously test the prototype and give feedback.
- We've sent out announcements across all wikis to let communities know about this upcoming feature, and have invited them to test and give feedback.
- 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.
- We will continue to collect feedback to improve the solution after deployment.
Najczęściej zadawane pytania
How can I find articles that use Sub-referencing?
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.
Why did you choose this wikitext syntax?
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.
Why did it take so long to find a solution?
The Technical Wishes team has worked on this feature on and off for many years. If you want to know more, here’s an overview of the history and complexity of this problem.