Jump to content

WMDE Technical Wishes/Sub-referencing/ms

From Meta, a Wikimedia project coordination wiki
This page is a translated version of the page WMDE Technical Wishes/Sub-referencing and the translation is 48% complete.
Outdated translations are marked like this.
Menambah subrujukan
StatusDalam perkembangan
OriginTinjauan Hajat Teknikal 2013, 2015, 2022 dan lain-lain
Focus areaMemudahkan penggunaan semula rujukan
Phabricatorpapan projek
ResponsiblePasukan Hajat Teknikal

Beritahu kami pendapat anda

Kami mengundang anda untuk mencuba prototaip kami yang sentiasa dikemaskini dari semasa ke semasa. Pantaulah laman ini atau sertai langganan senarai mesej beramai untuk mempelajari lebih lanjut berkenaan perkara-perkara baharu yang anda boleh uji.
Baca lebih lanjut mengenai pengujian dan maklum balas

Pada waktu ini, penggunaan semula rujukan yang sama dengan butiran yang berbeza tidak dapat dilakukan di dalam rencana dengan mudah. Ahli-ahli komuniti telah berkali-kali memohon penyelesaian daripada MediaWiki yang berfungsi tanpa templat dan mengikut cara rujukan semasa ini berfungsi, dari segi teks wiki dan Penyunting Visual. » Pelajari lebih lanjut tentang masalahnya

Sebagai salah satu daripada kawasan tumpuan "Memudahkan penggunaan semula rujukan", Pasukan Hajat Teknikal Wikimedia Deutschland memperkenalkan subrujukan, satu ciri pilihan yang membolehkan anda untuk menambah butiran berbeza pada rujukan sedia ada dengan mudah, tanpa perlu menambah kutipan rujukan tersebut berulang kali.

Our plan is to bring sub-referencing to the Wikimedia wikis in 2025.

Ringkasan berkenaan subrujukan

Untuk memetik sumber lebih daripada sekali dengan butiran yang berbeza, anda memerlukan satu rujukan utama dan satu subrujukan.

  • Rujukan utama mengandungi maklumat bibliografi utama.
  • Subrujukan mengandungi maklumat terperinci seperti: nombor muka surat, atau maklumat tambahan lainnya yang berbeza untuk setiap petikan, seperti bab, ayat, atau nota tambahan.
  • 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.
sub-referencing – example


  • Pada bahagian rujukan, pembaca melihat semua subrujukan yang dikumpulkan di bawah rujukan utama. Ini memudahkan pembaca untuk faham berapa kerap sesuatu sumber itu dipetik dalam rencana tersebut.
  • 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.
  • Dalam Penyunting Visual, kami sedang mengubah dialog petikan sedia ada supaya ia dapat menyokong subrujukan.

Manfaat utama

  • Sub-referencing is largely based on the existing way references work.
  • It's designed to work for both VisualEditor and wikitext.
  • Penyelesaian ini akan disepadukan ke MediaWiki, dengan itu tersedia di semua wiki Wikimedia dan boleh digunakan tanpa mengatasinya dengan templat.
  • Subrujukan akan dipaparkan dengan betul di Pralihat Rujukan dan tetingkap timbul rujukan mudah alih.
  • Perkara tersebut tidak wajib: Anda masih boleh menggunakan kaedah lain untuk mencipta rujukan. Akan tetapi, anda mungkin akan menemui subrujukan dalam rencana yang ditulis oleh pengguna lain.
Beritahulah kami pendapat anda. Penting sekali ciri baharu ini tidak mengganggu aliran kerja pengguna, adalah intuitif dan berfungsi dengan baik untuk pengguna wikiteks dan Penyunting Visual tanpa mengira pengalaman atau pengetahuan mereka tentang wikiteks dan templat. Untuk memastikannya, kami perlu maklum balas anda:

Cara ia berfungsi

Dalam wikiteks

Penyelesaian subrujukan dalam wikiteks ini hampir selesai. Walau bagaimanapun, nama atribut mungkin berubah. Penyelesaian ini masih belum dilancarkan, sebahagian besarnya kerana kami ingin mengelakkan pengguna Penyunting Visual mengalami pengalaman yang jauh berbeza daripada pengguna wikiteks. Sokongan Penyunting Visual masih dibangunkan.

Manfaat khusus bagi wikiteks

  • Penyelesaian ini berasaskan rujukan bernama yang sedia ada dan diketahui ramai.
  • Sebarang pengetahuan tentang templat tidak diperlukan.
  • Rujukan yang hampir sama boleh dikeluarkan dalam wikiteks, menjadikannya lebih bersih, kurang lewah dan lebih mudah dibaca.

 


 

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:

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:

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:

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 this is not a regular reuse like you are used to with other references. While it does create some duplicates in wikitext, identical sub-references will be automatically merged in the reader and VisualEditor view to prevent unnecessary duplication in the rendered output.
  • Auto-merging of identical sub-references – as shown in the example screenshots below – is still work in progress, currently "Page 23." would be displayed twice in the reference list.
  • The same re-use option already works for regular references (both list-defined and inline).
  • Tip: Copying and pasting an existing sub-reference statement remains a simple and recommended approach.

Example – reuse of inline sub-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 – 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 " within details="…" (e.g. when inserting a quote), make sure to use &quot; instead, or delimit the details with single quotes. VisualEditor 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 with details="…" 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 VisualEditor which we cannot solve at this point in time.


Dalam Penyunting Visual (sedang dibangunkan)

We are refining the user experience and workflows for sub-referencing in VisualEditor. Currently, there is one primary entry point via the "re-use" tab for creating a sub-reference, but the solution for VisualEditor is expected to evolve in the coming months.

You can test the current state of the VisualEditor solution on betawiki. Please keep in mind that there will still be changes. As always, we will keep you and these project pages updated as VisualEditor gains more capabilities and let you know when we need your feedback!

Manfaat khusus bagi Penyunting Visual

  • Untuk memetik sumber yang sama dengan butiran yang berbeza, anda tidak perlu lagi membuat rujukan baharu dari awal.
  • Rujukan-rujukan sub adalah serasi sepenuhnya dengan Penyunting Visual (berbanding cara lain yang menggunakan templat): Anda boleh menciptanya melalui dialog petikan dan anda boleh menyuntingnya terus dalam bahagian rujukan.

 


 

Mencipta sebuah subrujukan

  • Mencipta sebuah subrujukan pada masa ini berfungsi dengan menggunakan dialog petikan sedia ada.
  • Dalam tab "extends", pilih rujukan yang ingin anda gunakan semula. Tab ini mungkin akan dipertingkatkan selepas sesi ujian pengguna semasa kami.
  • Masukkan butiran subrujukan itu dan klik masukkan.
  • Alternatively, the option to add details can also be selected via the reference popup if the reference is already re-used.

Menyunting subrujukan sedia ada

  • Klik pada penanda catatan kaki di teks rencana untuk menyunting subrujukan.
  • Sekarang anda boleh mengubah butiran subrujukan. Anda juga akan dimaklumkan bahawa ia merupakan sebuah subrujukan.
  • Anda tidak boleh menyunting subrujukan daripada senarai rujukan.

Menggunakan semula subrujukan

  • Anda boleh menggunakan semula subrujukan dengan menggunakan tab "gunakan semula" dalam dialog petikan.
  • Alternatively, you can – as with regular references – select the footnote of a sub-reference and copy it to the desired location in the article using copy & paste, which also creates a re-use.

Sila ingat

  • We are working on creating an even more intuitive user experience for using references in VisualEditor. What you see now is just the beginning, among other things we have ideas for an improved reference editing dialogue. We will ask for feedback on some prototypes after deploying sub-referencing to the first pilot wikis.
  • Masalah sedia ada dengan nama automatik untuk rujukan dalam Penyunting Visual juga berlaku dengan membuat subrujukan.
  • Currently, if you re-use a sub-reference it will show as a duplicate in the reference list. Once we've improved the feature, the duplicates will automatically be merged in VisualEditor and the reader view.


 Uji prototaip

Kami perlukan maklum balas anda untuk memastikan kami membina perkara yang betul. Maklum balas atau soalan sentiasa dialu-alukan di halaman perbincangan projek ini.

Prototaip tersedia di wiki beta. Pada masa ini, kami menjemput anda untuk menguji penyelesaian wikiteks:

Uji di wiki beta Leave feedback Book a call

Sila ambil perhatian bahawa wiki-wiki beta berbeza sedikit daripada wiki biasa:
  • Ia mungkin nampak berbeza (contohnya tidak menggunakan kulit yang anda sukai).
  • Ia mungkin menawarkan beberapa ciri baharu yang masih diuji.
  • Ia hanya mengandungi beberapa halaman ujian dan templat, bukan seluruh kandungan wiki anda, dan bukan semua templat, modul, gajet dsb. yang anda biasa gunakan.
  • Pendaftaran masuk Wikimedia biasa anda tidak berfungsi pada wiki beta. Anda boleh sama ada cipta satu akaun – pastikan anda menggunakan kata laluan yang berbeza daripada akaun Wikimedia biasa anda – atau uji ciri ini tanpa akaun, yang akan menciptakan akaun sementara (pada de-betawiki) – atau paparkan alamat IP anda (pada en-betawiki).

Masalah yang sedang kami selesaikan

Dalam rencana-rencana Wikipedia, sesuatu sumber biasa dirujuk beberapa kali. Namun walaupun anda boleh menggunakan semula rujukan seperti seadanya, pada masa ini anda tidak boleh menggunakan semula rujukan yang sama dengan butiran berbeza (cth. nombor halaman berbeza). Anda hanya boleh membuat rujukan baharu atau menggunakan cara lain.

Status quo: Menggunakan semula rujukan di wikiteks dan Penyunting Visual

Jika anda ingin menggunakan semula rujukan dalam wikiteks, anda boleh mengubahnya menjadi rujukan bernama dan rujuk nama itu di tempat lain dalam rencana. Rujukan bernama itu boleh diletakkan dalam teks rencana atau di seksyen rujukan. Dalam Penyunting Visual anda boleh menggunakan pilihan "guna semula" dalam dialog petikan. Dalam bahagian rujukan, rujukan dengan nama yang sama dikumpulkan bersama.

Status quo: Menggunakan semula rujukan dengan butiran berbeza dalam wikiteks

Jika anda ingin menggunakan semula rujukan sedia ada dengan butiran berbeza dalam wikiteks, pada masa ini anda perlu menyalin dan menampal rujukan sedia ada dan tukar butiran pendua atau cipta rujukan (hampir serupa) yang baharu dari muka. Sesetengah projek menggunakan cara lain seperti petikan pendek atau menggunakan templat seperti nota kaki dipendekkan. Dalam seksyen rujukan, rujukan asal dan rujukan baharu yang anda buat tidak dikumpulkan bersama.

Status quo: Menggunakan semula rujukan dengan butiran yang berbeza dalam Penyunting Visual

Jika anda ingin menggunakan semula rujukan sedia ada dengan butiran berbeza dalam Penyunting Visual, pilihan "guna semula" dalam dialog petikan mahupun kaedah salin dan tampal tidak akan berfungsi, kerana kedua-duanya membawa kepada Penggunaan semula serupa, dan mengubah butiran rujukan yang digunakan semula/disalin mengubah kedua-dua contoh rujukan itu. Sebaliknya anda perlu membuat rujukan baharu (hampir sama) dari mula. Dalam seksyen rujukan, rujukan asal dan rujukan baharu yang anda buat tidak dikumpulkan bersama.

Rujukan yang dibuat oleh cara lain berasaskan templat seperti {{sfn}} tidak boleh disunting dari dalam seksyen rujukan dan tidak muncul dalam tab guna semula petikan; tetapi ia boleh diedit secara manual apabila mencarinya dalam teks rencana.

cara lain dengan {{sfn}}:

Masalah untuk pembaca

Cara lain berasaskan templat tidak dipaparkan dengan betul dalam Pratonton Rujukan, Petua Alat Rujukan dan tetimbul rujukan mudah alih.

cara lain {{sfn}} dengan pratonton untuk rujukan:

Masalah utama dengan status quo

  • Pengalaman Penyunting Visual dan pengguna wikiteks sangat berbeza.
  • Kebanyakan cara lain untuk menggunakan semula rujukan dengan butiran berbeza tidak berfungsi dengan betul dalam Penyunting Visual.
  • Mencipta banyak rujukan yang hampir sama dengan butiran yang berbeza menjadikan wikiteks lebih panjang dan berpotensi lebih susah untuk dibaca.
  • Cara lain berasaskan templat tidak diterima bulat-bulat oleh semua komuniti dan oleh itu tidak tersedia secara global.
  • Sesetengah pengguna cuba mengelak isu ini dengan meletakkan sumber dalam bahagian bibliografi tanpa menggunakannya sebagai rujukan sama sekali, yang menjadikannya lebih sukar untuk mengesahkan seksyen-seksyen rencana.

Perubahan terkini dan langkah seterusnya

Pasukan kami telah menyelesaikan masalah ini secara sekali-sekala sudah sekian lama sekarang. Berikut ialah gambaran keseluruhan sejarah projek ini, termasuk penyelidikan kami.
Terima kasih kepada semua orang yang turut serta dalam ujian dan temu duga dan yang menunjukkan minat, serta semua orang yang meluangkan masa untuk mengulas di halaman perbincangan kami selama ini. Ia sangat dihargai. Jika anda mempunyai maklum balas lanjut, sila kongsikannya di halaman perbincangan.

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

  • Green tickY 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.
  • Green tickY 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.
  • Green tickY 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.
  • We will deploy sub-referencing in July 2025 to German Wikipedia as our first pilot wiki. We will reach out to other potential pilot wikis soon.

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 VisualEditor workflows.
  • Once the development has reached a stable state, we will reach out to other potential 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.

Kami sedar tentang masalah lain dalam skop "mengguna semula rujukan", dan kami akan cuba menanganinya pada masa yang sama. Akan tetapi, fokus kami kekal pada mencipta penyelesaian untuk penambahan subrujukan.

Archived updates from 2024

  • Green tickY Prototaip tersedia di wiki beta. Ia merangkumi penyelesaian wikiteks dan beberapa ciri asas penyelesaian Penyunting Visual. Anda boleh terus menguji prototaip dan ini memberi maklum balas.
  • Green tickY Kami telah menghantar pengumuman di semua wiki untuk memberitahu komuniti tentang ciri yang akan datang ini, dan menjemput mereka untuk menguji dan memberi maklum balas.
  • Green tickY Our team presented sub-referencing at Wikimania 2024 and discussed with participants. (YouTube)
  • Green tickY 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.
  • Kami akan terus mengumpulkan maklum balas untuk menambah baik penyelesaian ini selepas pelancaran.


Soalan Lazim

Bagaimana hendak mencari rencana yang menggunakan subrujukan?

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 VisualEditor’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.

Mengapa anda memilih sintaks wikiteks ini?

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 VisualEditor.

Furthermore, we’re confident that this approach will work consistently across VisualEditor workflows as well.

Mengapa penyelesaian ini baru sekarang ada?

Pasukan Hasrat Teknikal telah mengusahakan ciri ini secara sekejap-sekejap selama bertahun-tahun. Jika anda ingin mengetahui lebih lanjut, berikut ialah ikhtisar sejarah dan kerumitan masalah ini.