Jump to content

Läsning/Webb/Stationära förbättringar/Funktioner/Innehållsförteckning

From mediawiki.org
This page is a translated version of the page Reading/Web/Desktop Improvements/Features/Table of contents and the translation is 100% complete.

Ett huvudmål för projektet Stationära förbättringar är att göra välanvända verktyg mer tillgängliga för läsare och redigerare. En av de viktigaste av dessa verktyg är innehållsförteckningen (ToC, table of contents). Denna funktion har två viktiga roller. Den ger en överblick över sammanhanget och låter användaren navigera på sidan.

För tillfället är innehållsförteckningen bara tillgänglig längst upp på sidan vilket begränsar dess användbarhet. Vi planerar att göra den bestående tillgänglig på hela sidan. Vårt mål är att underlätta för läsare och redigerare att nå innehållsförteckningen. Vi vill underlätta att utläsa sammanhang och navigera genom sidan utan att behöva skrolla upp till toppen.

Bakgrund och målsättning

Vi skulle vilja att gränssnittet, däribland navigeringselementen, blir lättare att använda. Hittills har vi byggt en ihopfällbar sidospalt och en fästbar rubrik. Nu förbereder vi en ny innehållsförteckning.

Nuvarande:

  • Den nuvarande innehållsförteckningen är bara tillgänglig längst upp på sidan. Det är svårt att utläsa sammanhanget och navigera inom sidan utan att behöva skrolla hela vägen upp
  • På sidor med en lång ingress syns inte innehållsförteckningen förrän man skrollar ner en bit
  • Användare använder innehållsförteckningen för att skapa en mental bild av sidan. Sidors introduktion har en liknande roll. Användare lär sig vad sidan innehåller, hur lång den kan vara, vilka delar som kan vara längst, osv. Detta förloras utan förmågan att oftare hänvisa till innehållsförteckningen
  • Innehållsförteckningen skapar en massa tomrum i innehållsutrymmet. Det tomrummet skulle kunna användas för att visa innehåller och annan funktionalitet

Den nya, beständiga innehållsförteckningen kommer underlätta för läsare att

  • Ta till sig sidans sammanhang
  • Navigera till olika delar av sidan utan att behöva skrolla längst upp på sidan varje gång de vill komma åt innehållsförteckningen

Användningsområden

  • Som en läsare eller redigerare vill jag ha möjligheten att utläsa sammanhang (innehåll och struktur) för sidan tänker läsa
  • Som en läsare eller redigerare vill jag ha möjligheten att hänvisa till nästa avsnitt på sidan så att jag kan välja vad jag ska läsa härnäst
  • Som en läsare eller redigerare vill jag ha möjligheten att veta hur många avsnitt en sida har utan att behöva skrolla hela vägen upp

Funktionsbeskrivning och krav

Innehållsförteckningen kommer konsekvent visas på sidans ena sida. Den kommer innehålla alla avsnitt och underavsnitt i tidigare versioner av innehållsförteckningen.

Innehållsförteckningen kommer innehålla följande funktionalitet:

  • Ihopfällbara underavsnitt - för användare som bara vill se rubrikerna i den högsta nivån
  • Fettext för nuvarande avsnitt - avsnittet som för tillfället befinner sig på sidan kommer visas i fettext. Användare kommer kunna identifiera var de är på sidan genom att titta på vilket avsnitt i innehållsförteckningen som skrivs i fettext
  • Navigering - när man väljer ett avsnitt i innehållsförteckningen tas man till det avsnittet på sidan
  • För skärmar som är smalare än 1000px kommer innehållsförteckningen och avsnittstitlarna användas som innehållsförteckning
Innehållsförteckning på engelskspråkiga Wikipedia

Designkrav och riktlinjer

Prototyp

Allmän innehållsförteckningsfunktionalitet: https://sv-toc.wmcloud.org/wiki/Månen

Ihopfällbar avsnittsfunktionalitet: https://di-toc-collapsible-sections.web.app/Aretha_Franklin

En prototyp för den bestående innehållsförteckningen som är skapad för användartester

Kvalitetstester

Användartest med läsare och redigerare

Vi testade innehållsförteckningen med läsare och redigerare. Testerna utfördes på tre olika platser (Argentina, Ghana, Indonesien) och olika språk. Deltagarna ombads interagera med olika versioner av den bestående innehållsförteckningen. Deras uppgift var att ge återkoppling om vilken version de föredrog. Testet innefattade en öppen studie på hur läsare och redigerare såg på och använde innehållsförteckningen.

Alla användare tyckte att innehållsförteckningen var viktig för läsupplevelsen. De behövde den både för att navigera samt för att utläsa sidans sammanhang.

Huvudobservationer:

  • Testarna föredrog bestående tillgång. Över alla tester var den bästa prototypen den bestående
  • Testarna föredrog att ha mer information. Prototyper som innehåll alla avsnitt och underavsnitt fick mer positiv respons
  • Testerna ville inte att innehållsförteckningen skulle överlappa med innehållet. Även om det var ett komplement till den huvudsakliga innehållsförteckningen längst upp på sidan
  • Testarna gillade att få ett hum om var de befann sig på sidan. De tillade att det underlättade att navigera på sidan om titeln eller avsnittet skrevs ut i fettext

Resultatet från testen användes för att välja den bästa prototypen. Sen arbetade vi på den så att den bättre passade deltagarnas behov. Läs testets fullständiga resultat.

Prototyptester med redigerare

I december 2021 utförde vi prototyptester med inloggade användare på 30 wikier. Vi utformade testet för att samla återkoppling om innehållsförteckningens användbarhet och funktionalitet. Större delen av återkopplingen var positiv. De flesta gemenskapsmedlemmar gillar innehållsförteckningens nya placering och funktionalitet, och stödjer förändringen.

Summary of Results of the Prototype testing
Topic Feedback Next steps
ToC The majority of the feedback we received was positive, with only 23 of the tested 236 users reporting a negative experience with the ToC (110 were explicitly positive, and 38 were neutral and did not prefer either the new or old versions) Continue with proposed overall design for ToC
Expanded sections People leaned towards having the ability to expand sections when necessary. We have changed the design to allow for expanding sections when possible/enough space is available on the page, and collapsing them for pages with longer ToC's, thus optimizing for seeing the highest number of sections possible
ToC on Talk Pages The majority of people who tested the ToC on talk pages agreed that the ToC should take the form it does on article pages and reported a positive experience with the new ToC. Users also suggested a number of customizations and ideas for the ToC on talk pages, such as including the number of replies for each topic, or the number of people participating in a given discussion
  • Continue with the current version for talk pages for the first A/B test of the feature
  • Begin requirements and testing for the configurations necessary for talk pages in the future (see this Phabricator ticket for future plans)
Lower resolution solutions The majority of users preferred the presented solution for lower resolutions. However, a large number of people also expressed concerns around their ability to navigate the article with the proposed solution that presented sections as collapsible We are continuing discussions for the optimal lower resolution solution for the table of contents and have explored a few more options. Progress can be tracked in this ticket
Main menu access A large number of users were unhappy with the proposal to display the ToC or the sidebar at a time and expressed the need to have access to the main menu alongside the ToC. We have restored persistent access to the sidebar. The sidebar and ToC can now both appear at a time. See our Page Tools page for more details on our plans for the main menu in the future
Magic words Most users suggested that the usage of magic words should continue where relevant We will continue respecting all magic words that do not move the location of the table of contents across the page

Kvantitetstester

Vi kommer utföra ett A/B-test av funktionaliteten hos den nuvarande gentemot den nya innehållsförteckningen.

Huvudfrågor:

  1. Används den nya innehållsförteckningen oftare än den gamla
  2. Minskar behovet att skrolla tillbaka upp på sidan med den nya innehållsförteckningen
  3. Minskar den nya innehållsförteckningen hur mycket tid folk lägger på att skrolla (om det går)
  4. Hur påverkar innehållsförteckningen hur länge folk är på en sida

FAQ

How can I get the old table of contents?

We intentionally do not add the old table of contents to the article in addition to the new sidebar location. This is because it increases the overall size of HTML that is shipped to clients, increases the storage requirement for our parser cache, and requires additional CSS to render. It's a trade off we've taken to reduce the work involved maintaining the code and keeping the site optimized.

Users can restore the old table of contents position with the following JavaScript code:

document.querySelector('mw\\3Atocplace,meta[property="mw:PageProp/toc"]').replaceWith( document.getElementById('mw-panel-toc') )

How do magic words work with this feature?

The __TOC__ magic word do not work in Vector 2022 as the table of contents is always in the sidebar and this cannot be changed. However magic words relating to presence of table of contents continue to work i.e. an article can disable the default table of contents and apply its own if necessary.

All magic words will continue to work for other skins which render the table of contents within the article.