Community Wishlist Survey 2022/Better diff handling of paragraph splits/nl
Deze pagina documenteert een project van het Wikimedia Foundation team Community Tech waaraan het in het verleden heeft gewerkt of zou gaan werken. Het technische werk aan dit project is voltooid of vervallen.
We nodigen u uit om deel te nemen aan de discussie op de overlegpagina.
Betere diff-afhandeling bij het splitsen van alinea's  | |
|---|---|
| Verbeter weergave verschillen voor gesplitste en gewijzigde alinea's. | |
| Groep: | Community Tech |
| Teamleden: | Tim Starling, Joydeep Sengupta, Dayllan Maza, Harumi Monroy, MusikAnimal, Sam Wilson, Karolin Siebert, Sandister Tei, Sammy Tarling |
| Hoofd: | Joydeep Sengupta, Dayllan Maza and Karolin Siebert (Product eigenaren) |
| Updates: | Wijzigingen |
Betere weergave van verschillen bij het splitsen van een alinea was de wens #1 in de Wensenlijst enquête 2022. Het doel van de wens is om kijkers te laten begrijpen wanneer er alinea gesplitst is tussen twee versies van een pagina. Deze pagina beschrijft de aanpak van Community Tech om in de behoeften te voorzien die in het voorstel van deze wens worden uitgedrukt. Geef a.u.b. feedback, als u die heeft.
Achtergrond en probleem
Een diff (afkorting van difference) geeft het verschil weer tussen twee revisies van een pagina.
De platforms in het wiki-systeem hebben verschillende versies van een Diff, afhankelijk van welk apparaat en installatie van Mediawiki wordt gebruikt.
Een manier waarop gebruikers een voorbeeld van een diff kunnen vinden is door naar de geschiedenis van een bepaalde pagina te navigeren en twee versies te selecteren om die te vergelijken.
Op Desktop zijn er twee ervaringen beschikbaar voor de meeste wiki's:
- WikiDiff2 is een interne extensie voor PHP die een snellere differentiaalengine biedt voor MediaWiki. Het is deels gebaseerd op de originele wikidiff, en deels op MediaWiki's class DifferenceEngine. Het produceert diffs uit invoertekst (regelgebaseerd of op woordniveau) en kan deze opmaken als HTML of JSON. Wikidiff2 bevat ondersteuning voor karakterniveau-differentiëlen voor tekst die uit karakters bestaat.
- Visual diff is nu een bètafunctie en vergelijkt en toont verschillen tussen gegenereerde (of weergegeven) documenten, in tegenstelling tot het tonen van de tekst (of opmaak) die wordt gebruikt om dergelijke documenten te formatteren.
Voor een mobiel device zijn er drie ervaringen:
- Mobile Web
- Android
- IOS
Daarnaast hebben gebruikers ook populaire scripts ontwikkeld om hun verschillende ervaringen aan te passen.
De populairste wens van de wensenlijst enquête 2022 was een betere behandeling van het splitsen van alinea's. Deze wens is meer dan eens op de verschillende wenslijsten verschenen.
Dit betekende dat de diff-viewer verbeterd moest worden wanneer een alinea gesplitst wordt, omdat een lap tekst lijkt te worden verwijderd en weer toegevoegd in plaats van gesplitst.
Bestaande hiaten: Product, technisch en Ontwerp
Tijdens het onderzoeken van dit probleem ontdekten we dat andere aspecten van de diff-viewer niet intuïtief zijn voor gebruikers (of in ieder geval voor nieuwkomers):
- Het gebruik van kleurcontrast is op sommige platforms ontoegankelijk. Kleur mag niet de enige indicator van betekenis zijn; het gebruik van strepen of andere symbolen moet het gebruik van kleur ondersteunen.
- De twee kolommen die voor (links) en na (rechts) met de symbolen + en – in Wikidiff2 betekenden, waren voor sommigen niet logisch
- Mensen kunnen "rood" associëren met slecht en "groen" met goed, wat kan leiden tot verwarring over de kwaliteit van een bewerking
- Regelnummers worden niet weergegeven in de meeste bewerkingservaringen van de platforms, maar ze verschijnen wel op verschillen als eenheid
- Geen pariteit tussen platforms
Waarom is het verwarrend om een gesplitste alinea te zien bij het controleren?
De huidige ervaring Wikidiff2 organiseert veranderingen met regelnummers.
Dit betekent dat het een toevoeging van een tekst of een karakter in een zin als verwijderd en opnieuw toegevoegd zal weergeven. Aangezien het opbreken van een alinea betekent "een spatie toevoegen binnen een regel en het creëren van een nieuwe regel" de huidige Wikidiff2 ervaring weergeeft als verwijderde inhoud, en dan worden de regels verdeeld in een die is weer toegevoegd en een andere die is toegevoerd. De regel die opnieuw wordt toegevoegd zal geen individuele woorden onderstrepen die zijn veranderd in de bewerking.
Werkterrein en gebruikersverhalen
Gebruikersverhalen vereisten
Als bezoeker van de wiki's, wanneer ik twee versies van een pagina vergelijk:
- Ik wil duidelijk zien wat er is toegevoegd zodat ik kan begrijpen wat er veranderd is
- Ik wil duidelijk zien wat er is verwijderd zodat ik kan begrijpen wat er veranderd is
- Ik wil duidelijk de invoeging van regelafbrekingen zien zodat ik kan begrijpen wat er veranderd is
- Ik wil duidelijk veranderingen in woorden binnen de alinea's zien die zijn opgesplitst, zodat ik kan begrijpen wat er veranderd is
Als bekijker van de twee-kolommen Wikitext Diff op Desktop
- Ik kan een visuele markering zien die aangeeft wanneer een woord binnen een alinea is veranderd die als een aparte alinea is opgesplitst
Als schermlezergebruiker van het verschil,
- Ik heb toegang tot nauwkeurige en nuttige beschrijvingen van de veranderingen in de verwijderde en toevoegde delen, evenals de visuele beschrijvingen van de veranderingen
Ideale Scope Vereisten
Als kijker van de Wikitext diffs op Desktop,
- zal ik kunnen kiezen tussen het bekijken van een verenigde inline of twee-koloms weergave van de verschillen
Als kijker van de verenigde inline Wikitext Diff op het bureaublad,
- Ik kan een visuele markering zien over verwijderde tekst
- Ik kan een visuele markering zien die aangeeft wanneer een woord binnen een alinea is veranderd die als een aparte alinea is opgesplitst
- Ik kan een visuele markering zien die de toevoeging van nieuwe regels aangeeft
- Ik zal een legenda kunnen zien zodat ik kan begrijpen wat de visuele markeringen betekenen
Scope en beperkingen
Voor deze verbetering, geleid door Community Tech, zullen we GEEN prioriteit geven aan UX-verbeteringen aan de volgende verschillende ervaringen:
- Mobiel web
- iOS
- Android
- VisualDiff
Hoewel we misschien vergaderingen houden met die teams en kennis delen over wat ons gebruikersonderzoek en technische onderzoeken aan het licht brengen, zullen we het werk van het ontwerpen van de oplossingen voor die platforms niet op ons nemen.
We zullen alleen werken aan de kern ervaring van het vergelijken van twee versies van een pagina, dit betekent dat er expliciet geen ontwerpvereisten zullen zijn rond:
- Vindbaarheid van het verschil: We zullen ons niet richten op hoe mensen navigeren bij het vergelijken van twee revisies
- Andere acties die gebruikers kunnen ondernemen ten aanzien van de verschillen die niet verband houden met het vergelijken van wijzigingen
Bovenstaande valt allemaal buiten de scope van waar dit team zich op zal richten vanwege de middelen. We zijn op de hoogte van andere interne inspanningen van het team Moderator Tools om Mobile Web aan te pakken, en de teams IOS- en Android die respectievelijk deze platforms bezitten.
Ontwerp verbeteren en plannen:
- Gaan we de stijl Visual Diff overeenstemmend maken met die in de Wikitext Diffs?
Afhankelijk van de complexiteit, waarschijnlijk wel.
- Gaan we de stijl Mobile Web Diff overeenstemmend maken met die in de Wikitext-diffs?
We zullen ons onderzoek en de laatste opzetjes in realtime delen met het team Moderator Tools dat nu aan die ervaring werkt
Onderzoek gegevens
- Hoeveel gebruikers bezoeken de twee-kolom-verschillenpagina's?
- Hoeveel gebruikers bezoeken de inline-verschillenpagina?
Waarom en hoe hebben we deze wens geaccepteerd?
Deze wens scoorde hoog in ons prioriteringsproces voor 2022. Het was erg populair qua aantal stemmen, impactvol voor de gemeenschap en had een relatief lage complexiteitsschatting. Diffs zijn een kernonderdeel van de wiki's. Gebruikers moeten begrijpen wat er veranderd is in een collaboratief bewerkingsecosysteem.
Ontwerponderzoek
Tot nu toe hebben we een aantal ongemodereerde zoekopdrachten gedaan om te begrijpen hoe intuïtief onze verschillende "verschillen" ervaringen zijn. Zie het onderzoeksprotocol bijgevoegd in de PDF samen met de inzichtenanalyse in videovorm.
Visuele diff scores:
- 4.5/5: de ervaring met het toevoegen van inhoud heeft een score gekregen in termen van duidelijkheid.
- 4.5/5: de ervaring met het verwijderen van inhoud heeft een score gekregen in termen van duidelijkheid.
- 2.75/5: de ervaring met het splitsen van alinea's heeft een score gekregen in termen van duidelijkheid.
Wikitext2 diff scores:
- 4.75/5: de ervaring met het toevoegen van inhoud kreeg een score op het gebied van duidelijkheid.
- 4/5: de ervaring met het verwijderen van inhoud kreeg een score in termen van duidelijkheid.
Statuswijzigingen
29 september 2023
Tegen het einde van september 2023 zijn de hieronder vermelde updates vrijgegeven. De wijzigingen zijn van toepassing op wiki's waar Wikidiff2 is geïnstalleerd.
In gebruikname van widget "inline switch"
De nieuwe widget inline-to-line-switch in verschillende pagina's is door Community Tech uitgebracht.
Deze switch stelt lezers in staat om te wisselen tussen het bekijken van wikitextdiffs in een twee-kolommen weergave of in een verenigde inline weergave.
Alinea splitsen detectie
De weergave van alinea splitsing in Wikidiff2 is in alle wiki's geïnstalleerd. De algemene nauwkeurigheid van de opsporing van het splitsen is verbeterd.
Het systeem identificeert beter waar nieuwe regels zijn toegevoegd en verwijderd. We wachten op feedback van gebruikers voor meldingen van onnauwkeurige verschillen zodat we het algoritme kunnen aanpassen om betere resultaten te krijgen.
We hebben problemen aangepakt die zijn vastgesteld in de wens Better Diff ook genoemd op Phabricator, dus splitsen en verplaatsen zouden nu correct in de verschillen moeten worden geïdentificeerd.
Een legenda en tooltips toevoegen
Het project "Better Diff" heeft ook legenda's en tooltips geïntroduceerd voor inline diffs, zodat gebruikers die de blauwe en gele markeringen zien, die veranderingen aangeven, beter kunnen begrijpen welk type bewerkingen er daar zijn aangebracht.
In de twee-kolommen diff-weergave van Wikitext, zijn individuele woorden veranderd in een alinea die is gesplitst, nergens wordt benadrukt of gemearkeerd. Dit kan ervoor zorgen dat gebruikers vandalisme over het hoofd zien. In de modus inline diff wordt de toegevoegde inhoud echter blauw en de verwijderde inhoud geel onderstreept.
Als de schakelaar de stand aan heeft, geeft een legende aan de linkerkant van de diff-pagina aan dat bewerkingen die met blauw zijn onderstreept inhoud weergeeft die is toegevoegd en dat tekst die met geel is onderstreept is verwijderd.
Bovendien verschijnt er een tooltip wanneer gebruikers hun cursor over een gemarkeerd gedeelte houden om te weten welk soort bewerking (en toevoeging of verwijdering) is gedaan.
Toevoegen en verwijderen regels
Als een gebruiker één of meer regels toevoegt, wordt deze weergegeven met de tekst "newline" met blauw gemarkeerd. Het verwijderen van één of meer regels wordt weergegeven met de tekst "deleted" met een gele markering.
14 april 2023
Community Tech heeft een paar komende releases over Better Diffs in de komende maanden. De releases zullen verbeteringen zijn aan het Wikidiff2-algoritme van de gebruikersinterface (UI).
Het Wikidiff2-algoritme zal in staat zijn om alineasplitsingen beter vast te leggen en veranderingen in woorden binnen de alinea's die werden gesplitst aan te geven.
De verbeteringen van de gebruikersinterface bevatten upgrades naar het inline-formaat en een formatschakelaar. Het format inline laat legenda's en tooltips zien zodat gebruikers bewerkingen beter kunnen begrijpen.
De schakelaar stelt gebruikers in staat om gemakkelijk te wisselen tussen de verschillende mogelijke formaten, waaronder inline, twee-kolommen en visueel.
De onderstaande tabel volgt de releases op Phabricator.
| # | Taak | Code (Core, VE, Wikidiff2) | Release datums |
|---|---|---|---|
| 1 | Inline Diff: Legenda en tooltips toevoegen | Core | Week of July 3 |
| 2 | Better Diffs: Wikidiff2 algoritme herzien | Wikidiff2 | Week of July 17 |
| 3 | Inline Diff: één of meer regels toegevoegd of verwijderd | Core and Wikidiff2 | Week of July 17 |
| 4 | Better Diffs: volledige implementatie van Wikidiff2 verbeterde detectie splitsen voor alle wiki's | Core | Week of August 30 |
| 5 | Inline Switch: Inline format schakelaar toevoegen wanneer wikidiff2 geïnstalleerd is | Core and VE | Week of September 11 |
10 maart 2023
Het team heeft weer aan deze wens gewerkt, zowel op het gebied van engineering als design. Wij willen de voortgang met u delen.
Dank aan iedereen die de tijd heeft genomen om met ons in gesprek te gaan en feedback te geven op de Overlegpagina. We hebben alle feedback doorgenomen en een samengestelde analyse gemaakt van de gemaakte punten. We hebben vervolgens uw feedback op die voorgestelde ontwerpen gecombineerd, evenals ongemodereerd gebruikersonderzoek, en we hebben de voorgestelde ontwerpen afgerond om in de engineering te gaan voor de verbeteringen met betrekking tot de wenswijzigingen. Bekijk de ontwerpen in deze update, waaronder:
- Schakelen tussen verschillende modi via een dropdown
- Verbetering van de toegankelijkheid van inline diffs met legenda's en tooltips voor desktop
- Het verbeteren van de weergave van een wijziging die een nieuwe regel of alinea introduceert
- Het verbeteren van de weergave van een wijziging waarbij een bestaande regel of alinea is verwijderd
Daarnaast is er een demo van de wijzigingen gemaakt voor de onderliggende vergelijkingsmotor. Voordat u de demo probeert om ons feedback te geven, let op:
- Het is een werk in uitvoering, onze QA-engineers gebruiken nu een lijst met uitgebreide verschillen om ervoor te zorgen dat de wijzigingen consistent zijn met de huidige versie van de tweekoloms-diff-ervaring of een verbetering van de gebruikersinterface
- De demopagina bevat NIET alle definitieve UI-wijzigingen, maar kan testers een goed beeld geven van hoe de voltooide tweekoloms-diff-ervaring er uiteindelijk uit zal zien.
- Om de demo te gebruiken, plakt u dezelfde tekst in de twee vakken en wijzigt u de tekst in het rechtervak. Eronder moet u dan zien wat er veranderd is.
Wij horen graag uw feedback op onze overlegpagina
Volgende stappen
- Toegankelijkheid van ontwerpkleuren: Onze ontwerper werkt nauw samen met ons team Design Systems om de toegankelijkheid van de ontwerpen te bepalen. We verwachten dat we de tint ervan enigszins moeten veranderen om het toegankelijker te maken, maar de kleuren blijven vergelijkbaar met het blauw en geel dat nu wordt weergegeven op tweekoloms en inline diffs.
- Releaseplan: We zijn bezig met een releaseplan en een tijdlijn van de volgende stappen en zullen dit opnemen in onze volgende projectupdates! Het uitbrengen van wijzigingen aan de onderliggende engine op het differentieel volgt een ander proces dan traditionele releases in Mediawiki-software, dus we zullen u de volgende keer zeker bijpraten met stappen en details.
We willen in deze update ook een niet-Community Tech-medewerker, Tim Starling hartelijk bedanken, die vriendelijk naar voren kwam om ons te helpen met de onderliggende veranderingen in de C++-engine van wikidiff2. We ontvangen altijd graag ondersteuning en vervullen wensen van andere leden van de Foundation die de expertise hebben om een wens te vervullen, zelfs als ze niet tot het team Community behoren.
We kijken ernaar uit om van jullie te horen!
Open vragen van de eerste update: We horen graag van u!
- Bent u geïnteresseerd in het uitvoeren van gebruikersonderzoek over de nieuwe voorgestelde interface voor verschillende alineasplitsingen? Als dat zo is, wilt u dan in de overlegpagina posten dat u geïnteresseerd bent?
- Welke andere pijnpunten manifesteert zich wanneer u het verschil bekijkt?
- Hoe kunnen we deze pijnpunten aanpakken die de verwarring rond d splitsingen aanpakken?
- Hoe geeft het gebruik van kleur aan welke inhoud wordt toegevoegd, verwijderd of hetzelfde blijft?