Читання/Веб/Стаціонарні покращення/Функції/Зміст

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

Основна мета проєкту Стаціонарних покращень — зробити часто використовувані інструменти більш доступними читачам і редакторам. Одним з ключових таких інструментів є зміст. Ця функція відіграє дві важливі ролі. Вона дає інформацію про контекст і дозволяє навігувати між сторінками.

Наразі зміст доступний лише угорі сторінки, що обмежує його корисність. Ми плануємо зробити його постійним, доступним з усіх місць сторінки. Наша мета — полегшити читачам і редакторам доступ до змісту. Ми хочемо полегшити орієнтування в контексті сторінки і навігацію по ній без потреби прокручувати нагору.

Передумови та цілі

Ми б хотіли, щоб інтерфейс був простішим для використання, включно з елементами навігації. Наразі ми створили згортувану бічну панель і фіксовану шапку. Тепер готуємо новий зміст.

Зараз:

  • Зміст доступний лише угорі сторінки. Важко розуміти контекст і навігувати по сторінці, не повертаючись нагору
  • На сторінках з довгою преамбулою / вступним розділом зміст не видно, аж поки не прокрутити трохи вниз
  • Користувачі користуються змістом, щоб намалювати собі ментальну модель сторінки. Ця роль подібна до тієї, яку виконує преамбула. Користувачі дізнаються, що містить сторінка, наскільки довгою вона може бути, які її частини можуть бути найдовшими тощо. Це використання втрачається, якщо відсутня можливість звертатися до змісту частіше.
  • Зміст створює багато невикористаного простору у районі вмісту. Цей простір можна використати для відображення вмісту й іншого функціоналу

Новий, постійний зміст полегшить те, як читачі

  • розуміють контекст сторінки
  • навігують до різних частин сторінки без потреби прогортувати її догори щоразу, коли треба скористатися змістом

Випадки використання

  • Як читач чи редактор, я хочу мати змогу осягати контекст (вміст і структуру) сторінки, яку я збираюсь прочитати
  • Як читач чи редактор, я хочу мати змогу звернутися до наступних кількох розділів сторінки з будь-якої позиції на сторінці, щоб можна було вибрати, що читати далі
  • Як читач чи редактор, я хочу мати змогу дізнатися, скільки на сторінці розділів, без потреби прогортувати її догори

Опис функції і вимоги

Зміст буде постійно збоку на сторнці. Він міститиме усі розділі і підрозділі, доступні у попередній версії змісту.

Зміст матиме такий функціонал:

  • Згортувані підрозділи — для користувачів, які хочуть бачити лише найвищий рівень заголовків розділів
  • Виділення розділу — розділ, який наразі видимий на сторінці, буде виділено жирним. Користувачі зможуть визначити, де вони є на сторінці, звернувши увагу на жирне виділення в змісті.
  • Навігація — вибравши розділ у змісті можна потрапити у відповідний розділ на сторінці.
  • На екранах завширшки менше 1000px зміст буде згорненим і змістом будуть заголовки розділів
Зміст на прикладі англійської Вікіпедії

Дизайнові вимоги і настанови

Прототип

Загальний функціонал змісту: https://en-toc.wmcloud.org/wiki/Moon

Функціонал згортуваних розділів: https://di-toc-collapsible-sections.web.app/Aretha_Franklin

 
Прототип постійного змісту, розроблений для тестування користувачами

Якісне тестування

Користувацьке тестування читачами й редакторами

Ми провели користувацьке тестування змісту читачами й редакторами. Тести відбувалися у трьох різних країнах (Аргентина, Гана, Індонезія) і рзними мовами. Учасників просили повзаємодіяти з різними версіями постійного змісту. Їхнім завданням було дати відгук щодо версії, якій вони віддають перевагу. Тест також включав відкрите дослідження того, як читачі й редактори бачать і використовують зміст.

Усі користувачі вважають зміст невід'ємною частиною читацького досвіду. Він потрібен їм як в цілях навігації, так і для отримання загального контексту сторінки.

Основні спостереження:

  • Тестувальники віддали перевагу постійному доступу. У всіх текстах найкращим прототипом був постійний
  • Тестувальники віддали перевагу тому, щоб мати більше інформації. Прототипи, що містили усі розділи й підрозділи, отримали більше позитивних відгуків
  • Тестувальники не бажають, щоб зміст накладався на вміст. Навіть у випадках, коли він був додатковим порівняно з основним змістом угорі сторінки
  • Тестувальникам подобається можливість зорієнтуватися, де вони на сторінці. Вони відзначили, що додаткове виділення жирним заголовка чи розділу допомогло їм з орієнтуванням

Результати тесту були використані для відбору найкращого прототипу. Далі ми працювали над тим, щоб він краще відповідав потребам учасників. Див. повні результати цього тесту.

Тестування прототипу редакторами

У грудні 2021 року ми провели тестування прототипу залогіненими користувачами у 30 вікі. Ми розробили тест для збору відгуків щодо використовності й функціональності змісту. Більша частина відгуків була позитивною. Більшість членів спільноти вподобали нове розташування й функціонал змісту і підтримують зміну.

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

Кількісне тестування

Ми проведемо A/B-тестування функціоналу поточного змісту пру порівнянні з його новою версією.

Головні запитання:

  1. Чи використовується новий зміст частіше, ніж попередній зміст
  2. Чи зменшує новий зміст потребу прогортувати сторінку догори
  3. Чи зменшує новий зміст кількість часу, який люди витрачають на прогортування / швидке прогортування (за можливості)
  4. Як новий зміст впливає на час, проведений на сторінці

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.