Definitionsboks: Format, regler og eksempler

En definitionsboks giver sidens hovedbegreb én præcis, afgrænset forklaring, før artiklen udfolder det. Det er et åbningselement: en genanvendelig indholdskomponent, der optræder nær starten, fordi en læser ikke bør være nødt til at udlede hovedbegrebet ud fra eksempler, fordele eller baggrund.

Dette levende eksempel er det komplette element, ikke en teaser til en definition længere nede på siden. Dens titel er valgfri; dens brødtekst er ikke. Produktionskontrakten nedenfor afgør, hvornår elementet hører til, hvad hvert felt betyder, og hvordan det samme indhold kortlægges på tværs af publiceringssystemer.

Hvorfor dette element er vigtigt

Læsere begynder sjældent på en informativ side ved at læse hvert ord i rækkefølge. De skanner titlen, indledende linjer, overskrifter og visuelt adskilte blokke for at afgøre, om siden besvarer deres spørgsmål. En definition begravet i et indledende afsnit tvinger læseren til at adskille svaret fra kontekst, påstande og scenesætning. Boksen fjerner det arbejde: dens afgrænsning siger “dette er definitionen.”

Den afgrænsning giver også definitionen en stabil, adresserbar position. Redaktører ved, hvor de skal gennemgå den, skabeloner ved, hvor de skal gengive den, og fremtidige revisioner tvinger ikke en læser eller en kvalitetskontrol til at søge gennem flere indledende afsnit. Konsekvent placering er vigtig på tværs af et bibliotek, fordi den samme informationsopgave ikke bør flytte sig uforudsigeligt fra side til side.

Maskinel udtrækkelighed er evnen for software til at isolere en indholdsenhed uden at miste dens betydning. En typet definition med en titel og brødtekst kan indekseres, sammenlignes, citeres eller transformeres uafhængigt. En sætning, der blot tilfældigvis definerer et begreb inde i fri tekst, opløses i sin omgivende prosa: software skal gætte, hvor definitionen begynder, hvor den slutter, og om den foregående påstand er en del af den. Følg element skrivereglerne , så den semantiske identitet overlever, selv når det visuelle design ændrer sig.

Formuleringen skal stadig fungere uden boksen. Styling skaber kontrast for mennesker; et selvstændigt subjekt, verbum og adskillende betydning skaber udtrækkelighed for maskiner. “Det er en metode til at forbedre dem” fejler, når det fjernes fra sin paragraf. “Indholdsbeskæring er processen med at fjerne, konsolidere eller opdatere sider, der ikke længere tjener et nyttigt søge- eller forretningsformål” overlever.

Hvornår skal det bruges

Brug en definitionsboks, når siden er organiseret omkring ét begreb, og det begreb kan defineres præcist i en kort erklæring. Det er obligatorisk for ordlistebegreb- og hvad-er-X-formater. Det er også obligatorisk for diagnose- eller tilstandsorienteret indhold: en læser skal vide, hvad den navngivne tilstand er, før vedkommende overvejer årsager, tests eller behandlinger.

Symptomsstyrede sider og hvordan-sider bruger elementet sjældent. Tilføj det kun, når én kort definition løser ægte tvetydighed, der er nødvendig for opgaven. For eksempel kan en guide med titlen “Sådan fikser du keyword-kannibalisering” definere keyword-kannibalisering før trinene, fordi diagnosen styrer, hvilken løsning der gælder. En guide med titlen “Sådan ændrer du et title-tag” har ikke brug for en boks, der definerer et title-tag, hvis målgruppen og den indledende instruktion allerede gør objektet utvetydigt.

Brug ikke en definitionsboks til:

• En bred introduktion, historie, fordelspåstand eller forklaring af, hvorfor emnet er vigtigt. Disse passager udvikler artiklen; de definerer ikke begrebet.
• Et resumé af siden. Et resumé samler flere konklusioner, mens en definition angiver betydningen af ét begreb.
• Et produktløfte som “AmICited er den nemmeste måde at forbedre synlighed på.” Det er positionering, ikke en testbar definition.
• En advarsel, forbehold, forudsætning eller tip. Dets kommunikative opgave er anderledes, selv når et tema kunne få det til at ligne det samme farvede panel.
• Et sekundært begreb, der introduceres midt i artiklen. Definer det begreb i den sætning, hvor det først optræder, eller giv det sin egen side, når det fortjener vedvarende behandling.
• Et citat, hvis autoritet erstatter klarhed. Tilskriv en formel definition i den omgivende prosa, når tilskrivning er nødvendig; hold boksen læsbar som en direkte erklæring.

Den almindelige nærved-fejl er en “introduktion til definitionen”: “Kundefrafald er et af de vigtigste begreber for abonnementsvirksomheder, og at forstå det kan forandre vækst.” Dette siger, at konceptet er vigtigt, men siger aldrig, hvad det er. Boksen kan ikke gøre tom scenesætning præcis.

Hvor skal den placeres

Placering koder prioritet. Placer definitionsboksen umiddelbart efter det indledende afsnit eller den korte introduktion som den første indholdsblok. Introduktionen etablerer, hvorfor læseren er på siden; boksen fastlægger derefter betydningen, før nogen årsager, eksempler, fordele, trin eller sammenligninger afhænger af den.

Placer ikke navigation, en indholdsfortegnelse, vigtige pointer, et billedgalleri eller en salgsfremmende call-to-action mellem introduktionen og definitionen. Disse blokke tvinger læseren til at krydse uvedkommende materiale, før de modtager begrebets betydning. Brødkrummer og sidens hero er skabelon-chrome snarere end redaktionelt indhold, så de kan gå forud for introduktionen.

Brug én definitionsboks per side. Reglen eksisterer, fordi komponenten identificerer sidens primære definitionsobjekt. To bokse skaber to konkurrerende hovedbegreber og gør udtræk tvetydigt. Hvis begge begreber virkelig er primære, opdel emnet i to sider og forbind dem i brødtekst. Hvis det andet begreb er underordnet, definér det inline i stedet for at style det som et andet kanonisk svar.

En direkte svar-blok kan kun sameksistere med en definition, når den besvarer et andet hovedspørgsmål. På en diagnosedefinitionsside kan definitionen angive, hvad tilstanden er, mens den direkte svar-blok angiver den anbefalede første handling. Når sidens hovedspørgsmål er “Hvad er X?”, er den direkte svar-blok og definitionen det samme svar. Slå dem sammen til én definitionsboks; ved siden af hinanden gentager de blot formuleringen og konkurrerer om udtræk.

Anatomi

Elementet har to redaktionelle områder og en strukturel relation. Skærmbilledet skal vise det gengivne element uden at bage forklarende tekst ind i billedet; forklaringen nedenfor forbliver valgbar, tilgængelig og vedligeholdelsesvenlig, når designet ændrer sig.

Gengivet forklaring

1. Valgfri titel: Normalt “Hvad er X?” Den identificerer det præcise begreb og må ikke tilføje en anden påstand.
2. Påkrævet brødtekst: Én selvstændig definition, der navngiver begrebet, placerer det i en nyttig kategori og angiver, hvad der adskiller det.
3. Åbningsposition: Boksen følger introduktionen og går forud for det første forklarende afsnit. Dette forhold er en del af kontrakten, selvom det ikke er et felt.

Kant, baggrund, polstring, ikonbehandling og typografi tilhører gengiveren. Forfattere leverer betydning, ikke visuelle tokens. Elementet skal forblive forståeligt, hvis enhver dekorativ stil fjernes.

Designeksempler

Galleriet dækker de understøttede indholdsvariationer frem for at opfinde forskellige semantiske typer. Hver optagelse bør genbruge den samme definition, hvor det er muligt, så anmeldere kan vurdere titelhåndtering, brødtekstombrydning og viewport-adfærd i stedet for at sammenligne ikke-relateret tekst.

Med titel: Den foretrukne variant, når begrebet er ukendt, tvetydigt, forkortet eller forskelligt fra den præcise sidetitel.

Uden titel: Tilladt, når sideoverskriften og den umiddelbart foregående introduktion gør emnet umiskendeligt. Brødteksten skal stadig navngive begrebet; udeladelse af titlen tillader aldrig stedord som “det” til at erstatte subjektet.

Maksimal længde: Gengiveren ombryder hele brødteksten. Den må ikke afkorte, kollapse, rulle eller reducere skrifttypen for at rumme tekst ved det redaktionelle maksimum.

Smalt viewport: Titel og brødtekst bevarer deres rækkefølge, læsbar linjelængde og synlig afgrænsning. Ingen betydning må afhænge af et ikon, der flytter sig ved siden af teksten.

Parametre

Parametrene adskiller indhold fra præsentation. Deres grænser holder definitioner sammenlignelige på tværs af sider og forhindrer komponenten i at blive til en generel callout.

Definitionsboks parametre

Gengiveren kan udlede begrebet til indeksering, men forfattere må aldrig skrive en brødtekst, der afhænger af, at det afledte felt vises. En kopieret definition skal navngive sit subjekt eksplicit.

Syntaks og kodeeksempler

Alle tre former bærer den samme titel og brødtekst. Den bærbare Markdown-direktiv er den kanoniske forfatterform; Hugo og WordPress er tilpasninger. Eksemplerne bruger bevidst identisk formulering, så en migrationstest kan sammenligne værdier, ikke blot udseende.

Bærbart Markdown-direktiv

:::definition
## Hvad er indholdsbeskæring?

Indholdsbeskæring er processen med at fjerne, konsolidere eller opdatere sider, der ikke længere tjener et nyttigt søge- eller forretningsformål.
:::

Den første overskrift kortlægges til title; alt efter den kortlægges til body. Udelad overskriften til den titelløse variant, men behold begrebet i brødteksten.

Hugo shortcode

{{< callout type="note" title="Hvad er indholdsbeskæring?" >}}Indholdsbeskæring er processen med at fjerne, konsolidere eller opdatere sider, der ikke længere tjener et nyttigt søge- eller forretningsformål.{{< /callout >}}

Siden genbruger den eksisterende callout-gengiver til den synlige Hugo-behandling. Definitionskontrakten kommer stadig fra den typed bærbare kilde: note er her en gengivelsestilpasning, ikke tilladelse til at putte almindelige noter i definitionsbokse.

WordPress-blok eller shortcode

[definition title="Hvad er indholdsbeskæring?"]Indholdsbeskæring er processen med at fjerne, konsolidere eller opdatere sider, der ikke længere tjener et nyttigt søge- eller forretningsformål.[/definition]

En WordPress-implementering kan eksponere de samme felter som en brugerdefineret blok. De lagrede værdier forbliver title og body; redigeringskontroller, farver og mellemrum er præsentationsindstillinger og må ikke ændre definitionens betydning.

Eksempler

Dette er godt, fordi det navngiver begrebet, identificerer tilstanden og angiver den adskillende konsekvens. Det påstår ikke, at hvert par af sider, der deler et ord, konkurrerer; udtrykket “samme søgehensigt” leverer den nødvendige afgrænsning. Brødteksten er nyttig uden titlen og kort nok til at citeres intakt.

Dette er dårligt, fordi det aldrig definerer keyword-kannibalisering. Det tilbyder vigtighed, målgruppe, hastende karakter og en vag effekt, men ingen kategori eller adskillende tilstand. At erstatte “et af de vigtigste” med “en situation, hvor flere sider konkurrerer om den samme søgehensigt” forvandler markedsføring til mening.

Endnu et dårligt mønster er overbelastning af boksen: en definition efterfulgt af årsager, fem eksempler, en advarsel og et anbefalet værktøj. Selv hvis den første sætning er præcis, ødelægger det ekstra materiale den stabile afgrænsning. Behold definitionen; flyt årsager og eksempler til næste afsnit, advarslen til sit korrekte element og anbefalingen til det punkt, hvor læseren kan handle på den.

Schema-markup og tilgængelighed

En definitionsboks opretter ikke automatisk en selvstændig Schema.org-enhed. På en almindelig artikel forbliver dens tekst en del af den omsluttende Article eller TechArticle. På en ordlisteside kan en publiceringsimplementering kortlægge begrebet og definitionen til et passende vokabular, kun når webstedet har vedtaget den skemapolitik. Opfind ikke en DefinitionBox-type: den findes ikke i Schema.org.

Dublér heller ikke brødteksten i JSON-LD blot fordi boksen ser vigtig ud. Schema-markup skal beskrive siden sandfærdigt, og dublering af synlig prosa til en ikke-relateret egenskab skaber støj snarere end stærkere betydning. Hvis en skemaegenskab udfyldes, skal dens værdi matche den synlige definition i substans og opdateres med den.

Elementet har brug for ingen interaktiv ARIA-rolle. Gengiv det i normal dokumentrækkefølge som et mærket område eller semantisk container med titlen før brødteksten. Brug ikke role="alert", da en statisk definition ikke er hastende eller ny information. Brug ikke farve eller et ikon som det eneste signal om, at blokken er en definition. Hvis titlen implementeres som en overskrift, skal dens niveau følge sidehierarkiet; kildens ## er en feltkortlægningskonvention, ikke en instruktion om at skabe et ugyldigt overskriftsspring.

Tastaturadfærd er almindelig læseadfærd: selve boksen kan ikke fokuseres. Ethvert link indeni følger normal linksemantik og har brug for et beskrivende anker. Skærmlæseroutput skal bevare den samme titel-så-brødtekst rækkefølge, der er synlig på skærmen.

Skriveregler

Skriv definitionen, før du skriver dens fordele. Begynd med selve begrebet, brug derefter et koblingsverbum som “er,” “betyder” eller “opstår når.” Angiv den nærmeste nyttige kategori og den egenskab, der adskiller begrebet fra beslægtede koncepter. Denne rækkefølge eksisterer, fordi kategori uden adskillelse er bred, mens adskillelse uden kategori efterlader læseren usikker på, hvilken slags ting begrebet er.

Hold brødteksten på maksimalt omkring 300 tegn inklusive mellemrum. Foretræk én sætning. En anden kort sætning er kun acceptabel, når en nødvendig afgrænsning ikke kan udtrykkes klart i den første. Grænsen er redaktionel snarere end en invitation til at komprimere tegnsætning, fjerne artikler eller stable ledsætninger sammen. Hvis nøjagtighed kræver mere plads, put den nøjagtige kerne i boksen og kvalificer den umiddelbart efter.

Brug en neutral, deklarativ tone. Undgå “vigtig,” “kraftfuld,” “spilskiftende,” “du skal vide,” og lignende vurderinger. Undgå cirkulære definitioner som “indholdsoptimering er handlingen at optimere indhold.” Forklar forkortelser ved første brug, medmindre forkortelsen i sig selv er sidens begreb. Brug det samme kanoniske navn, der optræder i sidetitlen.

Placer aldrig disse inde i brødteksten:

• Mere end ét primært begreb eller en liste over relaterede begreber.
• Fordele, historie, årsager, symptomer, eksempler, trin, produktpræsentationer eller call-to-actions.
• Tabeller, billeder, videoer, formularer, knapper, fodnoter eller indlejrede callouts.
• Uunderbyggede superlativer, opfundne statistikker eller påstande, der kræver et helt afsnit med dokumentation.
• En anden overskrift, punktopstilling eller blokcitat.
• Stedord, hvis betydning afhænger af den foregående introduktion.

Ét tilskrivningslink er undtagelsen, ikke målet. Brug det kun, når en juridisk, videnskabelig eller standardbaseret definition afhænger af en navngiven kilde. Placer udvidede citater og uenighed mellem kilder i almindelig prosa, hvor læseren kan se kvalifikationen i stedet for at forveksle én omstridt formulering med en universel definition.

Posttyper, der bruger det

Frontmatterens postTypes registrerer de registrerede tilknytninger. Tabellen oversætter disse tilknytninger til redaktionelle regler. Diagnose-/tilstandsorienterede og symptomsstyrede formater beskrives her som brugsmønstre, men de er ikke linket som separate playbook-posttyper, fordi de ikke er i det nuværende kanoniske register.

Krav til posttyper

Til diagnose- eller tilstandsorienterede sider skal du altid bruge boksen og placere den før symptomer, årsager, sværhedsgrad eller behandlinger. Til symptomsstyrede sider skal du kun bruge den, når symptomnavnet har en ægte kort, stabil definition. Hvis boksen blot ville gentage titlen—“Et langsomt websted er et websted, der er langsomt”—så udelad den og begynd med den diagnostiske tærskel eller observerbare problem i brødtekst.

QA-tjekliste

En anmelder kontrollerer betydning før udseende. En poleret boks, der indeholder en vag introduktion, er stadig en mislykket definition.

• Ét hovedbegreb: Siden og boksen definerer præcis ét primært koncept.
• Korrekt position: Boksen er den første redigerede indholdsblok efter introduktionen, med ingen indholdsfortegnelse, pointer, galleri eller markedsføring indsat før den.
• Én forekomst: Ingen anden definitionsboks konkurrerer med det kanoniske svar.
• Faktisk definition: Brødteksten angiver, hvad begrebet er, eller hvornår tilstanden eksisterer; den siger ikke blot, hvorfor begrebet er vigtigt.
• Selvstændig formulering: Brødteksten navngiver sit subjekt og giver mening, når den kopieres uden nærliggende prosa eller styling.
• Præcision: Kategori, adskillende egenskab og eventuel nødvendig afgrænsning er nøjagtige. Formuleringen overgeneraliserer ikke.
• Længde: Brødteksten er på højst omkring 300 tegn og forbliver læsbar frem for komprimeret.
• Rent indhold: Ingen fordele, historie, eksempler, trin, produktpåstande, medier, tabeller eller indlejrede elementer optræder indeni.
• Direkte svar-beslutning: Hvis siden spørger “Hvad er X?”, er definitionsboksen det eneste direkte svar-element. Hvis begge elementer optræder, besvarer de klart forskellige spørgsmål.
• Tilgængelig semantik: Titel går forud for brødtekst, overskriftsniveau er gyldigt, farve er ikke den eneste identifikator, og ingen alert-rolle eller unødvendigt fokusmål er til stede.
• Bærbar paritet: Markdown-, Hugo- og WordPress-kortlægninger bevarer den samme titel og definition.
• Struktureret data-begrænsning: Enhver skemaværdi matcher den synlige tekst, og ingen opfundet Schema.org-type bruges.
• Skærmbilledestatus: Kommentarer forbliver ikke-gengivende optagelsesinstruktioner, indtil de navngivne filer eksisterer; ingen ikke-eksisterende billedsti refereres som et billede.

FAQ

Akademiskabelonen gengiver de fem gennemgåede spørgsmål, der er gemt i denne sides [[faq]] frontmatter. Tilsammen dækker de nødvendighed, sameksistens med direkte svar, links og citater, længdegrænsen og reglen om én per side.