Definitionsruta: Format, regler och exempel

En definitionsruta ger sidans huvudterm en exakt, avgränsad förklaring innan artikeln utvecklar den. Det är ett inledningselement: en återanvändbar innehållskomponent som visas nära början eftersom en läsare inte ska behöva härleda den centrala termen från exempel, fördelar eller bakgrund.

Det där levande exemplet är hela elementet, inte en förhandstitt på en definition längre ner på sidan. Dess titel är valfri; dess brödtext är det inte. Produktionskontraktet nedan avgör när elementet hör hemma, vad varje fält betyder och hur samma innehåll mappas över publiceringssystem.

Varför detta element är viktigt

Läsare börjar sällan en informativ sida med att läsa vartenda ord i ordning. De skannar titeln, inledande rader, rubriker och visuellt avgränsade block för att avgöra om sidan besvarar deras fråga. En definition begravd i ett inledande stycke tvingar läsaren att separera svaret från sammanhang, påståenden och scenariouppbyggnad. Rutan eliminerar det arbetet: dess avgränsning signalerar “det här är definitionen.”

Den avgränsningen ger också definitionen en stabil, adresserbar position. Redaktörer vet var de ska granska den, mallar vet var de ska rendera den, och framtida revideringar tvingar inte en läsare eller kvalitetskontroll att söka igenom flera inledande stycken. Konsekvent placering är viktig över ett helt bibliotek eftersom samma informationsuppgift inte bör flytta sig oförutsägbart från sida till sida.

Maskinell utdragbarhet är förmågan hos programvara att isolera en innehållsenhet utan att förlora dess innebörd. En typad definition med en titel och brödtext kan indexeras, jämföras, citeras eller transformeras oberoende. En mening som bara råkar definiera en term inuti fritext upplöses i sin omgivande prosa: programvara måste gissa var definitionen börjar, var den slutar och om föregående påstående är en del av den. Följ skrivreglerna för element så att den semantiska identiteten överlever även när den visuella designen ändras.

Formuleringen måste fortfarande fungera utan rutan. Styling skapar kontrast för människor; ett självständigt subjekt, verb och särskiljande innebörd skapar utdragbarhet för maskiner. “Det är en metod för att förbättra dem” misslyckas när det tas bort från sitt stycke. “Innehållsbeskärning är processen att ta bort, konsolidera eller uppdatera sidor som inte längre tjänar ett användbart sök- eller affärssyfte” överlever.

När ska det användas

Använd en definitionsruta när sidan är organiserad kring en term och den termen kan definieras precist i ett kort uttalande. Den är obligatorisk för ordlisteterm- och vad-är-X-format. Den är också obligatorisk för diagnos- eller tillståndsinnehåll: en läsare måste veta vad det namngivna tillståndet är innan hen överväger orsaker, tester eller behandlingar.

Symtomledda sidor och instruktionssidor använder elementet sällan. Lägg till det endast när en kort definition löser en verklig otydlighet som är nödvändig för uppgiften. Till exempel kan en guide med titeln “Så här åtgärdar du sökordskannibalisering” definiera sökordskannibalisering före stegen eftersom diagnosen styr vilken åtgärd som gäller. En guide med titeln “Så här ändrar du en titeltagg” behöver ingen ruta som definierar en titeltagg om målgruppen och den inledande instruktionen redan gör objektet otvetydigt.

Använd inte en definitionsruta för:

• En bred introduktion, historia, fördelspåstående eller förklaring av varför ämnet är viktigt. Dessa avsnitt utvecklar artikeln; de definierar inte termen.
• En sammanfattning av sidan. En sammanfattning samlar flera slutsatser, medan en definition anger innebörden av en term.
• Ett produktlöfte som “AmICited är det enklaste sättet att förbättra synligheten.” Det är positionering, inte en testbar definition.
• En varning, förbehåll, förkunskapskrav eller tips. Dess kommunikativa uppgift skiljer sig även när ett tema skulle kunna få det att se ut som samma färgade panel.
• En sekundär term som introduceras mitt i artikeln. Definiera den termen i meningen där den först förekommer, eller ge den en egen sida när den förtjänar utförlig behandling.
• Ett citat vars auktoritet ersätter tydlighet. Tillskriv en formell definition i den omgivande prosan när tillskrivning är nödvändig; håll rutan läsbar som ett direkt uttalande.

Det vanliga närapå-misset är en “introduktion till definitionen”: “Kundbortfall är ett av de viktigaste koncepten för prenumerationsföretag, och att förstå det kan förändra tillväxten.” Detta säger att konceptet är viktigt men säger aldrig vad det är. Rutan kan inte göra tom scenariouppbyggnad precis.

Var ska den placeras

Placering kodar prioritet. Placera definitionsrutan omedelbart efter det inledande stycket eller korta introduktionen, som det första innehållsblocket. Introduktionen etablerar varför läsaren är på sidan; rutan fastställer sedan innebörden innan några orsaker, exempel, fördelar, steg eller jämförelser bygger på den.

Placera inte navigering, en innehållsförteckning, viktiga slutsatser, ett bildgalleri eller en uppmaning till handling mellan introduktionen och definitionen. Dessa block tvingar läsaren att passera ovidkommande material innan hen får termens innebörd. Brödsmulor och sidans hjälte är mallkrom snarare än skapat innehåll, så de kan föregå introduktionen.

Använd en definitionsruta per sida. Regeln finns eftersom komponenten identifierar sidans primära definitionsobjekt. Två rutor skapar två konkurrerande huvudtermer och gör utdragning tvetydig. Om båda termerna verkligen är primära, dela upp ämnet i två sidor och koppla samman dem i prosa. Om den andra termen är underordnad, definiera den inline istället för att formatera den som ett andra kanoniskt svar.

Ett block för direkt svar kan samexistera med en definition endast när det besvarar en annan huvudfråga. På en diagnossida kan definitionen ange vad tillståndet är medan det direkta svaret anger den rekommenderade första åtgärden. När sidans huvudfråga är “Vad är X?”, är det direkta svaret och definitionen samma svar. Slå samman dem till en definitionsruta; intilliggande versioner upprepar bara formulering och konkurrerar om utdragning.

Anatomi

Elementet har två skapade regioner och ett strukturellt förhållande. Skärmbilden måste visa det renderade elementet utan att baka in förklarande text i bilden; förklaringen nedan förblir valbar, tillgänglig och underhållsbar när designen ändras.

Renderad förklaring

1. Valfri titel: Vanligtvis “Vad är X?” Den identifierar den exakta termen och får inte lägga till ett andra påstående.
2. Obligatorisk brödtext: En självständig definition som namnger termen, placerar den i en användbar kategori och anger vad som särskiljer den.
3. Inledningsposition: Rutan följer introduktionen och föregår det första förklarande avsnittet. Detta förhållande är en del av kontraktet även om det inte är ett fält.

Kantlinje, bakgrund, utfyllnad, ikonbehandling och typografi tillhör renderaren. Författare tillhandahåller innebörd, inte visuella symboler. Elementet måste vara förståeligt om varje dekorativ stil tas bort.

Designexempel

Galleriet täcker de innehållsvarianter som stöds snarare än att hitta på olika semantiska typer. Varje bild ska återanvända samma definition där det är möjligt så att granskare kan bedöma rubrikhantering, brödtextombrytning och visningsportbeteende istället för att jämföra orelaterad text.

Med titel: Den föredragna varianten när termen är obekant, tvetydig, förkortad eller skiljer sig från den exakta sidtiteln.

Utan titel: Tillåten när sidrubriken och den omedelbart föregående introduktionen gör ämnet omisskännligt. Brödtexten måste fortfarande namnge termen; utelämnande av titeln tillåter aldrig pronomen som “det” att ersätta subjektet.

Maximal längd: Renderaren bryter hela brödtexten. Den får inte trunkera, komprimera, scrolla eller minska teckensnittet för att anpassa text vid det redaktionella maximumet.

Smal visningsport: Titel och brödtext behåller sin ordning, läsbar radlängd och synlig avgränsning. Ingen innebörd får bero på en ikon som flyttas bredvid texten.

Parametrar

Parametrarna separerar innehåll från presentation. Deras gränser håller definitioner jämförbara mellan sidor och förhindrar att komponenten förvandlas till en allmän uppmärksamhetsruta.

Parametrar för definitionsruta

Renderaren kan härleda termen för indexering, men författare får aldrig skriva en brödtext som är beroende av att det härledda fältet visas. En kopierad definition måste namnge sitt subjekt explicit.

Syntax och kodexempel

Alla tre formerna har samma titel och brödtext. Det portabla Markdown-direktivet är den kanoniska författarformen; Hugo och WordPress är adaptrar. Exemplen använder medvetet identisk formulering så att ett migrationstest kan jämföra värden, inte bara utseende.

Portabelt Markdown-direktiv

:::definition
## Vad är innehållsbeskärning?

Innehållsbeskärning är processen att ta bort, konsolidera eller uppdatera sidor som inte längre tjänar ett användbart sök- eller affärssyfte.
:::

Den första rubriken mappas till title; allt efter den mappas till body. Utelämna rubriken för varianten utan titel, men behåll termen i brödtexten.

Hugo-kortkod

{{< callout type="note" title="Vad är innehållsbeskärning?" >}}Innehållsbeskärning är processen att ta bort, konsolidera eller uppdatera sidor som inte längre tjänar ett användbart sök- eller affärssyfte.{{< /callout >}}

Webbplatsen återanvänder den befintliga uppmärksamhetsrenderaren för den synliga Hugo-behandlingen. Definitionskontraktet kommer fortfarande från den typade portabla källan: note är en renderingsadapter här, inte tillstånd att lägga vanliga anteckningar i definitionsrutor.

WordPress-block eller kortkod

[definition title="Vad är innehållsbeskärning?"]Innehållsbeskärning är processen att ta bort, konsolidera eller uppdatera sidor som inte längre tjänar ett användbart sök- eller affärssyfte.[/definition]

En WordPress-implementering kan exponera samma fält som ett anpassat block. De lagrade värdena förblir title och body; redigeringskontroller, färger och mellanrum är presentationsinställningar och får inte ändra definitionens innebörd.

Exempel

Detta är bra eftersom det namnger termen, identifierar tillståndet och anger den särskiljande konsekvensen. Det påstår inte att varje par av sidor som delar ett ord konkurrerar; frasen “samma sökintention” tillhandahåller den nödvändiga avgränsningen. Brödtexten är användbar utan titeln och tillräckligt kort för att citeras i sin helhet.

Detta är dåligt eftersom det aldrig definierar sökordskannibalisering. Det erbjuder viktighet, målgrupp, brådska och en vag effekt, men ingen kategori eller särskiljande villkor. Att ersätta “ett av de viktigaste” med “en situation där flera sidor konkurrerar om samma sökintention” förvandlar marknadsföring till innebörd.

Ett andra dåligt mönster är att överbelasta rutan: en definition följd av orsaker, fem exempel, en varning och ett rekommenderat verktyg. Även om den första meningen är korrekt förstör det extra materialet den stabila avgränsningen. Behåll definitionen; flytta orsaker och exempel till nästa avsnitt, varningen till dess korrekta element och rekommendationen till den punkt där läsaren kan agera på den.

Schema-markering och tillgänglighet

En definitionsruta skapar inte automatiskt en fristående Schema.org-entitet. På en vanlig artikel förblir dess text en del av den omgivande Article eller TechArticle. På en ordlistesida kan en publiceringsimplementering mappa termen och definitionen till en lämplig vokabulär endast när webbplatsen har antagit den schemapolicyn. Hitta inte på en typ DefinitionBox: den finns inte i Schema.org.

Duplicera inte heller brödtexten i JSON-LD bara för att rutan ser viktig ut. Schema-markering måste beskriva sidan sanningsenligt, och att duplicera synlig prosa till en orelaterad egenskap skapar brus snarare än starkare innebörd. Om en schemaegenskap fylls i måste dess värde överensstämma med den synliga definitionen i sak och uppdateras med den.

Elementet behöver ingen interaktiv ARIA-roll. Rendera det i normal dokumentordning som en märkt region eller semantisk behållare, med titeln före brödtexten. Använd inte role="alert", eftersom en statisk definition inte är brådskande eller nyligen ankommen information. Använd inte färg eller en ikon som den enda signalen att blocket är en definition. Om titeln implementeras som en rubrik måste dess nivå följa sidhierarkin; källans ## är en fältmappningskonvention, inte en instruktion att skapa ett ogiltigt rubrikhopp.

Tangentbordsbeteende är vanligt läsbeteende: själva rutan är inte fokuserbar. Eventuella länkar inuti följer normal länksemantik och behöver ett beskrivande ankare. Skärmläsarutdata måste bevara samma titel-före-brödtext-ordning som syns på skärmen.

Skrivregler

Skriv definitionen innan du skriver dess fördelar. Börja med själva termen, använd sedan ett kopplingsverb som “är”, “betyder” eller “uppstår när.” Ange den närmaste användbara kategorin och egenskapen som skiljer termen från närliggande begrepp. Denna sekvens finns eftersom kategori utan särskiljning är bred, medan särskiljning utan kategori lämnar läsaren osäker på vad för slags sak termen är.

Håll brödtexten på maximalt cirka 300 tecken, inklusive mellanslag. Föredra en mening. En andra kort mening är acceptabel endast när en nödvändig avgränsning inte kan uttryckas tydligt i den första. Gränsen är redaktionell snarare än en inbjudan att komprimera skiljetecken, ta bort artiklar eller stapla satser. Om noggrannhet kräver mer utrymme, lägg den exakta kärnan i rutan och kvalificera den omedelbart efteråt.

Använd en neutral, deklarativ ton. Undvik “viktigt”, “kraftfullt”, “game-changing”, “du behöver veta” och liknande omdömen. Undvik cirkeldefinitioner som “innehållsoptimering är handlingen att optimera innehåll.” Utveckla förkortningar vid första användningen om inte förkortningen i sig är sidans term. Använd samma kanoniska namn som visas i sidtiteln.

Placera aldrig följande i brödtexten:

• Mer än en primär term eller en lista med relaterade termer.
• Fördelar, historia, orsaker, symptom, exempel, steg, produktargument eller uppmaningar till handling.
• Tabeller, bilder, videor, formulär, knappar, fotnoter eller nästlade uppmärksamhetsrutor.
• Ogrundade superlativ, påhittad statistik eller påståenden som kräver ett helt stycke bevis.
• En andra rubrik, punktlista eller blockcitat.
• Pronomen vars innebörd beror på den föregående introduktionen.

En tillskrivningslänk är undantaget, inte målet. Använd den endast när en juridisk, vetenskaplig eller standardbaserad definition är beroende av en namngiven källa. Placera utökade citat och oenighet mellan källor i vanlig prosa, där läsaren kan se kvalificeringen istället för att missta en omtvistad formulering för en universell definition.

Posttyper som använder den

Frontmatter-fältet postTypes registrerar de dokumenterade kopplingarna. Tabellen översätter dessa kopplingar till redaktionella regler. Diagnos-/tillstånds- och symtomledda format beskrivs här som användningsmönster, men de är inte länkade som separata spelboksposttyper eftersom de inte finns i det aktuella kanoniska registret.

Krav per posttyp

För diagnos- eller tillståndssidor, använd rutan alltid och placera den före symptom, orsaker, allvarlighetsgrad eller behandlingar. För symtomledda sidor, använd den endast när symptomnamnet har en verkligt kort, stabil definition. Om rutan bara skulle omformulera titeln — “En långsam webbplats är en webbplats som är långsam” — utelämna den och börja med det diagnostiska tröskelvärdet eller observerbara problemet i prosa.

Checklista för kvalitetssäkring

En granskare kontrollerar innebörd före utseende. En polerad ruta som innehåller en vag introduktion är fortfarande en misslyckad definition.

• En huvudterm: Sidan och rutan definierar exakt ett primärt koncept.
• Korrekt position: Rutan är det första skapade innehållsblocket efter introduktionen, utan innehållsförteckning, slutsatser, galleri eller reklam insatt före den.
• En förekomst: Ingen andra definitionsruta konkurrerar med det kanoniska svaret.
• Faktisk definition: Brödtexten anger vad termen är eller när tillståndet finns; den säger inte bara varför termen är viktig.
• Självständig formulering: Brödtexten namnger sitt subjekt och är begriplig när den kopieras utan närliggande prosa eller styling.
• Precision: Kategori, särskiljande egenskap och eventuell nödvändig avgränsning är korrekta. Formuleringen övergeneraliserar inte.
• Längd: Brödtexten är högst cirka 300 tecken och förblir läsbar snarare än komprimerad.
• Ren innehåll: Inga fördelar, historia, exempel, steg, produktpåståenden, media, tabeller eller nästlade element visas inuti.
• Beslut om direkt svar: Om sidan frågar “Vad är X?”, är definitionsrutan det enda elementet för direkt svar. Om båda elementen visas, besvarar de tydligt olika frågor.
• Tillgänglig semantik: Titel föregår brödtext, rubrikordning är giltig, färg är inte den enda identifieraren och ingen varningsroll eller onödigt fokusmål finns.
• Portabel paritet: Markdown-, Hugo- och WordPress-mappningar behåller samma titel och definition.
• Återhållsamhet med strukturerad data: Eventuella schemavärden matchar den synliga texten och ingen påhittad Schema.org-typ används.
• Status för skärmbilder: Kommentarer förblir icke-renderande fångstinstruktioner tills de namngivna filerna finns; ingen obefintlig bildsökväg refereras som en bild.

FAQ

Academy-mallen renderar de fem granskade frågorna som lagras i denna sidas [[faq]]-frontmatter. Tillsammans täcker de nödvändighet, samexistens med direkta svar, länkar och citat, längdbegränsningen och en-per-sida-regeln.