Definisjonsboks: Format, regler og eksempler

En definisjonsboks gir sidens hovedbegrep én nøyaktig, avgrenset forklaring før artikkelen utdyper det. Den er et åpningselement: en gjenbrukbar innholdskomponent som vises nær starten fordi en leser ikke skal måtte utlede det sentrale begrepet fra eksempler, fordeler eller bakgrunn.

Det levende eksemplet er det komplette elementet, ikke en teaser for en definisjon lenger ned på siden. Tittelen er valgfri; brødteksten er det ikke. Produksjonskontrakten nedenfor avgjør når elementet hører hjemme, hva hvert felt betyr, og hvordan det samme innholdet kartlegges på tvers av publiseringssystemer.

Hvorfor dette elementet betyr noe

Lesere begynner sjeldent med å lese hvert ord på en informasjonsside i rekkefølge. De skanner tittelen, åpningslinjene, overskriftene og visuelt distinkte blokker for å avgjøre om siden svarer på spørsmålet deres. En definisjon som er begravd i et innledende avsnitt tvinger leseren til å skille svaret fra kontekst, påstander og scenesetting. Boksen fjerner det arbeidet: dens avgrensning sier «dette er definisjonen.»

Den avgrensningen gir også definisjonen en stabil, adresserbar posisjon. Redaktører vet hvor de skal vurdere den, maler vet hvor de skal gjengi den, og fremtidige revisjoner tvinger ikke leseren eller en kvalitetssjekk til å søke gjennom flere innledende avsnitt. Konsistent plassering betyr noe på tvers av et bibliotek fordi den samme informasjonsejobben ikke bør flytte seg uforutsigbart fra side til side.

Maskinuttrekkbarhet er programvares evne til å isolere en innholdsenhet uten å miste meningen. En typet definisjon med en tittel og brødtekst kan indekseres, sammenlignes, siteres eller transformeres uavhengig. En setning som tilfeldigvis definerer et begrep inne i fri tekst, løses opp i den omkringliggende prosaen: programvare må gjette hvor definisjonen begynner, hvor den slutter, og om den foregående påstanden er en del av den. Følg skrivereglene for elementer slik at den semantiske identiteten overlever selv når det visuelle designet endres.

Formuleringen må fortsatt fungere uten boksen. Stilsetting skaper kontrast for mennesker; et selvstendig subjekt, verb og særpreg skaper uttrekkbarhet for maskiner. «Det er en metode for å forbedre dem» fungerer ikke når det fjernes fra avsnittet sitt. «Innholdsbeskjæring er prosessen med å fjerne, konsolidere eller oppdatere sider som ikke lenger tjener et nyttig søke- eller forretningsformål» overlever.

Når skal den brukes

Bruk en definisjonsboks når siden er organisert rundt ett begrep, og det begrepet kan defineres presist i en kort uttalelse. Den er obligatorisk for ordliste-term- og hva-er-X-formater. Den er også obligatorisk for diagnose- eller tilstandspreget innhold: en leser må vite hva den navngitte tilstanden er før de vurderer årsaker, tester eller behandlinger.

Symptomsstyrte sider og hvordan-gjøre-sider bruker elementet sjelden. Legg den kun til når én kort definisjon løser en genuin tvetydighet som er nødvendig for oppgaven. For eksempel kan en guide med tittelen «Hvordan fikse søkeordkannibalisering» definere søkeordkannibalisering før stegene fordi diagnosen styrer hvilken løsning som gjelder. En guide med tittelen «Hvordan endre en tittel-tag» trenger ikke en boks som definerer en tittel-tag hvis målgruppen og åpningsinstruksen allerede gjør objektet utvetydig.

Ikke bruk en definisjonsboks til:

• En bred introduksjon, historie, nytteverdi-påstand eller forklaring på hvorfor emnet betyr noe. Disse avsnittene utvikler artikkelen; de definerer ikke begrepet.
• Et sammendrag av siden. Et sammendrag samler flere konklusjoner, mens en definisjon oppgir betydningen av ett begrep.
• Et produktløfte som «AmICited er den enkleste måten å forbedre synlighet på.» Det er posisjonering, ikke en testbar definisjon.
• En advarsel, forbehold, forutsetning eller et tips. Dens kommunikative jobb er annerledes, selv om et tema kunne få det til å se ut som samme fargede panel.
• Et sekundært begrep som introduseres midt i artikkelen. Definer det begrepet i setningen der det først opptrer, eller gi det sin egen side når det fortjener en mer omfattende behandling.
• Et sitat hvis autoritet erstatter klarhet. Tilskriv en formell definisjon i den omkringliggende prosaen når attribusjon er nødvendig; hold boksen lesbar som en direkte uttalelse.

Den vanlige nesten-tabben er en «introduksjon til definisjonen»: «Kundefrafall er et av de viktigste konseptene for abonnementsbedrifter, og det å forstå det kan forvandle vekst.» Dette sier at konseptet betyr noe, men sier aldri hva det er. Boksen kan ikke gjøre tom scenesetting presis.

Hvor skal den plasseres

Plassering koder prioritet. Plasser definisjonsboksen umiddelbart etter det innledende avsnittet eller den korte introduksjonen, som den første innholdsblokken. Introduksjonen etablerer hvorfor leseren er på siden; boksen fastsetter deretter betydningen før noen årsaker, eksempler, fordeler, trinn eller sammenligninger avhenger av den.

Ikke plasser navigasjon, en innholdsfortegnelse, hovedfunn, et bildegalleri eller en salgsfremmende handlingsknapp mellom introduksjonen og definisjonen. Disse blokkene tvinger leseren til å krysse irrelevant materiale før de mottar begrepets betydning. Brødsmuler og sideheroen er mal-krom fremfor forfattet innhold, så de kan komme før introduksjonen.

Bruk én definisjonsboks per side. Regelen eksisterer fordi komponenten identifiserer sidens primære definisjonsobjekt. To bokser skaper to konkurrerende hovedbegreper og gjør uttrekk tvetydig. Hvis begge begrepene virkelig er primære, del emnet opp i to sider og koble dem sammen i prosa. Hvis det andre begrepet er underordnet, definer det innline i stedet for å style det som et andre kanonisk svar.

En direkte svar-blokk kan sameksistere med en definisjon bare når den svarer på et annet hovedspørsmål. På en diagnoseside kan definisjonen si hva tilstanden er, mens det direkte svaret angir den anbefalte første handlingen. Når sidens hovedspørsmål er «Hva er X?», er det direkte svaret og definisjonen det samme svaret. Slå dem sammen til én definisjonsboks; ved siden av hverandre gjentar de bare ordlyden og konkurrerer om uttrekk.

Anatomi

Elementet har to forfattede områder og ett strukturelt forhold. Skjermbildet må vise det gjengitte elementet uten å bake forklarende tekst inn i bildet; forklaringen nedenfor forblir valgbar, tilgjengelig og vedlikeholdbar når designet endres.

Gjengitt forklaring

1. Valgfri tittel: Vanligvis «Hva er X?» Den identifiserer det nøyaktige begrepet og må ikke legge til en ny påstand.
2. Obligatorisk brødtekst: Én selvstendig definisjon som navngir begrepet, plasserer det i en nyttig kategori, og angir hva som skiller det ut.
3. Åpningsposisjon: Boksen følger introduksjonen og kommer før den første forklarende delen. Dette forholdet er en del av kontrakten selv om det ikke er et felt.

Kantlinje, bakgrunn, utfylling, ikonbehandling og typografi tilhører gjengiveren. Forfattere leverer mening, ikke visuelle signaler. Elementet må forbli forståelig hvis hver dekorative stil fjernes.

Designeksempler

Galleriet dekker de støttede innholdsvariantene i stedet for å finne opp ulike semantiske typer. Hvert bilde bør gjenbruke samme definisjon der det er mulig, slik at vurderere kan bedømme tittelhåndtering, tekstbryting og visningsatferd i stedet for å sammenligne ikke-relatert tekst.

Med tittel: Den foretrukne varianten når begrepet er ukjent, tvetydig, forkortet eller forskjellig fra den nøyaktige sidetittelen.

Uten tittel: Tillatt når sideoverskriften og den umiddelbart foregående introduksjonen gjør emnet utvetydig. Brødteksten må fortsatt navngi begrepet; utelatelse av tittelen tillater aldri pronomen som «det» å erstatte subjektet.

Maksimal lengde: Gjengiveren bryter hele brødteksten. Den må ikke forkorte, skjule, rulle eller redusere skrifttypen for å tilpasse seg tekst ved redaksjonelt maksimum.

Smalt visningsområde: Tittel og brødtekst beholder sin rekkefølge, lesbar linjelengde og synlig avgrensning. Ingen mening må avhenge av et ikon som flytter seg ved siden av teksten.

Parametere

Parametrene skiller innhold fra presentasjon. Grensene deres holder definisjoner sammenlignbare på tvers av sider og hindrer komponenten i å bli en generell oppmerksomhetsboks.

Parametere for definisjonsboks

Gjengiveren kan utlede begrepet for indeksering, men forfattere må aldri skrive en brødtekst som avhenger av at det utledede feltet vises. En kopiert definisjon må navngi subjektet sitt eksplisitt.

Syntaks og kodeeksempler

Alle tre formene bærer samme tittel og brødtekst. Det bærbare Markdown-direktivet er den kanoniske forfattede formen; Hugo og WordPress er tilpassere. Eksemplene bruker bevisst identisk ordlyd slik at en migrasjonstest kan sammenligne verdier, ikke bare utseende.

Bærbart Markdown-direktiv

:::definition
## Hva er innholdsbeskjæring?

Innholdsbeskjæring er prosessen med å fjerne, konsolidere eller oppdatere sider som ikke lenger tjener et nyttig søke- eller forretningsformål.
:::

Den første overskriften kartlegges til title; alt etter den kartlegges til body. Utelat overskriften for varianten uten tittel, men behold begrepet i brødteksten.

Hugo-kortkode

{{< callout type="note" title="Hva er innholdsbeskjæring?" >}}Innholdsbeskjæring er prosessen med å fjerne, konsolidere eller oppdatere sider som ikke lenger tjener et nyttig søke- eller forretningsformål.{{< /callout >}}

Nettstedet gjenbruker den eksisterende oppmerksomhetsboks-gjengiveren for den synlige Hugo-behandlingen. Definisjonskontrakten kommer fortsatt fra den typede bærbare kilden: note er en gjengivelsestilpasser her, ikke tillatelse til å plassere vanlige notater i definisjonsbokser.

WordPress-blokk eller kortkode

[definition title="Hva er innholdsbeskjæring?"]Innholdsbeskjæring er prosessen med å fjerne, konsolidere eller oppdatere sider som ikke lenger tjener et nyttig søke- eller forretningsformål.[/definition]

En WordPress-implementering kan eksponere de samme feltene som en tilpasset blokk. De lagrede verdiene forblir title og body; redigeringskontroller, farger og mellomrom er presentasjonsinnstillinger og må ikke endre definisjonens betydning.

Eksempler

Dette er bra fordi det navngir begrepet, identifiserer tilstanden og angir den særpregede konsekvensen. Det påstår ikke at hvert par av sider som deler et ord konkurrerer; uttrykket «samme søkeintensjon» gir den nødvendige avgrensningen. Brødteksten er nyttig uten tittelen og kort nok til å siteres i sin helhet.

Dette er dårlig fordi det aldri definerer søkeordkannibalisering. Det tilbyr viktighet, målgruppe, haster og en vag effekt, men ingen kategori eller særpreget tilstand. Å erstatte «et av de viktigste» med «en situasjon der flere sider konkurrerer om samme søkeintensjon» forvandler promotering til mening.

Et annet dårlig mønster er å overbelaste boksen: en definisjon etterfulgt av årsaker, fem eksempler, en advarsel og et anbefalt verktøy. Selv om den første setningen er nøyaktig, ødelegger det ekstra materialet den stabile avgrensningen. Behold definisjonen; flytt årsaker og eksempler til neste seksjon, advarselen til sitt rette element, og anbefalingen til punktet der leseren kan handle på den.

Schema-markering og tilgjengelighet

En definisjonsboks oppretter ikke automatisk en frittstående Schema.org-enhet. På en vanlig artikkel forblir teksten en del av den omsluttende Article eller TechArticle. På en ordliste-side kan en publiseringsimplementering kartlegge begrepet og definisjonen til et passende vokabular bare når nettstedet har tatt i bruk den skjema-policyen. Ikke finn opp en DefinitionBox-type: den finnes ikke i Schema.org.

Dupliser heller ikke brødteksten i JSON-LD bare fordi boksen ser viktig ut. Schema-markering må beskrive siden sannferdig, og duplisering av synlig prosa til en ikke-relatert egenskap skaper støy snarere enn sterkere mening. Hvis en skjema-egenskap fylles ut, må verdien samsvare med den synlige definisjonen i substans og oppdateres med den.

Elementet trenger ingen interaktiv ARIA-rolle. Gjengi det i normal dokumentrekkefølge som et merket område eller semantisk beholder, med tittelen før brødteksten. Ikke bruk role="alert", fordi en statisk definisjon ikke er hastende eller nylig ankommet informasjon. Ikke bruk farge eller et ikon som det eneste signalet på at blokken er en definisjon. Hvis tittelen implementeres som en overskrift, må nivået følge sidehierarkiet; kildens ## er en feltkartleggingskonvensjon, ikke en instruks om å lage et ugyldig overskuddshopp.

Tastaturatferd er vanlig leseatferd: selve boksen er ikke fokuserbar. Eventuelle lenker inni følger vanlig lenkesemantikk og trenger et beskrivende anker. Skjermleser-utdata må bevare samme tittel-så-brødtekst-rekkefølge som er synlig på skjermen.

Skriveregler

Skriv definisjonen før du skriver fordelene. Begynn med selve begrepet, bruk deretter et kopuleringsverb som «er», «betyr» eller «oppstår når». Oppgi den nærmeste nyttige kategorien og egenskapen som skiller begrepet fra nærliggende konsepter. Denne sekvensen eksisterer fordi kategori uten distinksjon er bred, mens distinksjon uten kategori lar leseren være usikker på hva slags ting begrepet er.

Hold brødteksten på maksimalt omtrent 300 tegn, inkludert mellomrom. Foretrekk én setning. En andre kort setning er akseptabelt bare når en nødvendig avgrensning ikke kan uttrykkes klart i den første. Grensen er redaksjonell snarere enn en invitasjon til å komprimere tegnsetting, fjerne artikler eller stable leddsetninger. Hvis nøyaktighet krever mer plass, legg den eksakte kjernen i boksen og kvalifiser den umiddelbart etterpå.

Bruk en nøytral, deklarativ tone. Unngå «viktig», «kraftfull», «banebrytende», «du trenger å vite» og lignende vurderinger. Unngå sirkulære definisjoner som «innholdsoptimalisering er handlingen med å optimalisere innhold.» Utvid forkortelser ved første gangs bruk med mindre selve forkortelsen er sidens begrep. Bruk samme kanoniske navn som vises i sidetittelen.

Plasser aldri disse inni brødteksten:

• Mer enn ett primært begrep eller en liste over relaterte begreper.
• Fordeler, historie, årsaker, symptomer, eksempler, trinn, produktpresentasjoner eller handlingspåbud.
• Tabeller, bilder, videoer, skjemaer, knapper, fotnoter eller nestede oppmerksomhetsbokser.
• Ustøttede superlativer, oppfunne statistikker eller påstander som krever et avsnitt med bevis.
• En andre overskrift, punktliste eller blokksitat.
• Pronomen hvis betydning avhenger av den foregående introduksjonen.

Én attribusjonslenke er unntaket, ikke målet. Bruk den bare når en juridisk, vitenskapelig eller standardbasert definisjon avhenger av en navngitt kilde. Legg utvidede henvisninger og uenighet mellom kilder i vanlig prosa, der leseren kan se kvalifiseringen i stedet for å forveksle én omstridt ordlyd med en universell definisjon.

Innleggstyper som bruker den

postTypes-frontmatteren registrerer de registrerte forbindelsene. Tabellen oversetter disse forbindelsene til redaksjonelle regler. Diagnose-/tilstandsformater og symptomstyrte formater beskrives her som bruksmønstre, men de er ikke lenket som separate spillebok-innleggstyper fordi de ikke er i det gjeldende kanoniske registeret.

Krav til innleggstyper

For diagnose- eller tilstandssider, bruk boksen alltid og plasser den før symptomer, årsaker, alvorlighetsgrad eller behandlinger. For symptomstyrte sider, bruk den bare når symptomnavnet har en genuint kort, stabil definisjon. Hvis boksen bare ville gjenta tittelen — «Et tregt nettsted er et nettsted som er tregt» — utelat den og begynn med den diagnostiske terskelen eller det observerbare problemet i prosa.

QA-sjekkliste

En vurderer sjekker mening før utseende. En polert boks som inneholder en vag introduksjon er fortsatt en mislykket definisjon.

• Ett hovedbegrep: Siden og boksen definerer nøyaktig ett primært konsept.
• Riktig posisjon: Boksen er den første forfattede innholdsblokken etter introduksjonen, uten innholdsfortegnelse, hovedfunn, galleri eller promotering satt inn før den.
• Én forekomst: Ingen andre definisjonsbokser konkurrerer med det kanoniske svaret.
• Faktisk definisjon: Brødteksten angir hva begrepet er eller når tilstanden eksisterer; den sier ikke bare hvorfor begrepet betyr noe.
• Selvstendig ordlyd: Brødteksten navngir subjektet sitt og gir mening når den kopieres uten nærliggende prosa eller stilsetting.
• Presisjon: Kategori, særpreg og eventuelle vesentlige avgrensninger er nøyaktige. Ordlyden overgeneraliserer ikke.
• Lengde: Brødteksten er ikke mer enn omtrent 300 tegn og forblir lesbar snarere enn komprimert.
• Rene innhold: Ingen fordeler, historie, eksempler, trinn, produktpåstander, media, tabeller eller nestede elementer vises inni.
• Direkte svar-beslutning: Hvis siden spør «Hva er X?», er definisjonsboksen det eneste direkte svar-elementet. Hvis begge elementene vises, svarer de på tydelig forskjellige spørsmål.
• Tilgjengelig semantikk: Tittel kommer før brødtekst, overskriftsnivå er gyldig, farge er ikke den eneste identifikatoren, og ingen varselrolle eller unødvendig fokusmål er til stede.
• Bærbar paritet: Markdown-, Hugo- og WordPress-kartlegginger beholder samme tittel og definisjon.
• Strukturert data-begrensning: Eventuelle skjemaverdier samsvarer med den synlige teksten, og ingen oppfunnet Schema.org-type brukes.
• Skjermbildestatus: Kommentarer forblir ikke-gjengivende opptaksinstrukser inntil de navngitte filene eksisterer; ingen ikke-eksisterende bildesti refereres til som et bilde.

FAQ

Akademimalen gjengir de fem vurderte spørsmålene som er lagret i denne sidens [[faq]]-frontmatter. Sammen dekker de nødvendighet, sameksistens med direkte svar, lenker og kilder, lengdegrensen og én-per-side-regelen.