Definičný box: Formát, pravidlá a príklady

Definičný box poskytuje hlavnému pojmu stránky jedno presné, ohraničené vysvetlenie ešte predtým, než článok pojem rozvedie. Ide o otvárací prvok: opätovne použiteľnú obsahovú komponentu, ktorá sa zobrazuje blízko začiatku, pretože čitateľ by nemal musieť odvodzovať centrálny pojem z príkladov, výhod alebo pozadia.

Tento živý príklad predstavuje kompletný prvok, nie ukážku definície umiestnenej nižšie na stránke. Jeho nadpis je voliteľný; jeho telo nie je. Produkčná špecifikácia nižšie určuje, kedy prvok patrí na stránku, čo znamená každé pole a ako sa rovnaký obsah mapuje naprieč publikačnými systémami.

Prečo na tomto prvku záleží

Čitatelia len zriedka začínajú čítať informatívnu stránku každé slovo v poradí. Skenujú nadpis, úvodné riadky, nadpisy a vizuálne odlíšené bloky, aby rozhodli, či stránka odpovedá na ich otázku. Definícia pochovaná v úvodnom odseku núti čitateľa oddeliť odpoveď od kontextu, tvrdení a scény. Box túto prácu odstraňuje: jeho ohraničenie hovorí „toto je definícia“.

Toto ohraničenie tiež dáva definícii stabilnú, adresovateľnú pozíciu. Editori vedia, kde ju skontrolovať, šablóny vedia, kde ju vykresliť, a budúce revízie nenútia čitateľa ani kontrolu kvality prehľadávať niekoľko úvodných odsekov. Konzistentné umiestnenie je dôležité v rámci knižnice, pretože rovnaká informačná úloha by sa nemala nepredvídateľne presúvať zo stránky na stránku.

Strojová extrahovateľnosť je schopnosť softvéru izolovať jednotku obsahu bez straty jej významu. Typovaná definícia s nadpisom a telom môže byť indexovaná, porovnávaná, citovaná alebo transformovaná nezávisle. Veta, ktorá len náhodou definuje pojem vo voľnom texte, sa rozpúšťa do okolitej prózy: softvér musí hádať, kde definícia začína, kde končí a či predchádzajúce tvrdenie je jej súčasťou. Dodržiavajte pravidlá písania prvkov , aby sémantická identita prežila aj pri zmene vizuálneho dizajnu.

Znenie musí fungovať aj bez boxu. Štylovanie vytvára kontrast pre ľudí; sebestačný subjekt, sloveso a rozlišovací význam vytvárajú extrahovateľnosť pre stroje. „Je to metóda na ich zlepšenie“ zlyhá, keď sa oddelí od svojho odseku. „Content pruning je proces odstraňovania, konsolidácie alebo aktualizácie stránok, ktoré už neslúžia užitočnému vyhľadávaciemu ani obchodnému účelu“ prežije.

Kedy ho použiť

Použite definičný box, keď je stránka organizovaná okolo jedného pojmu a tento pojem možno presne definovať v krátkom vyhlásení. Je povinný pre formáty glossary-term a what-is-X. Je tiež povinný pre obsah typu diagnóza alebo stav: čitateľ musí vedieť, čo je daný stav, predtým než zváži príčiny, testy alebo liečby.

Stránky zamerané na príznaky a stránky typu návod ho používajú zriedkavo. Pridajte ho len vtedy, keď jedna krátka definícia rieši skutočnú nejednoznačnosť potrebnú pre danú úlohu. Napríklad návod s názvom „Ako opraviť kanibalizáciu kľúčových slov“ môže definovať kanibalizáciu kľúčových slov pred krokmi, pretože diagnóza určuje, ktorá oprava sa uplatní. Návod s názvom „Ako zmeniť title tag“ nepotrebuje box definujúci title tag, ak publikum a úvodná inštrukcia už robia objekt jednoznačným.

Nepoužívajte definičný box na:

• Široký úvod, históriu, tvrdenie o prínose alebo vysvetlenie, prečo je téma dôležitá. Tieto pasáže rozvíjajú článok; nedefinujú pojem.
• Zhrnutie stránky. Zhrnutie zhromažďuje niekoľko záverov, zatiaľ čo definícia uvádza význam jedného pojmu.
• Produktový sľub ako „AmICited je najjednoduchší spôsob, ako zlepšiť viditeľnosť.“ To je positioning, nie testovateľná definícia.
• Varovanie, výhradu, predpoklad alebo tip. Ich komunikačná úloha je iná, aj keď by téma mohla spôsobiť, že vyzerajú ako rovnaký farebný panel.
• Sekundárny pojem zavedený v strede článku. Definujte tento pojem vo vete, kde sa prvýkrát objaví, alebo mu vytvorte vlastnú stránku, ak si zaslúži súvislé spracovanie.
• Citát, ktorého autorita nahrádza jasnosť. Priraďte formálnu definíciu v okolitej próze, keď je atribúcia potrebná; ponechajte box čitateľný ako priame vyhlásenie.

Častým takmer zásahom je „úvod k definícii“: „Odchod zákazníkov je jedným z najdôležitejších konceptov pre predplatné podniky a jeho pochopenie môže transformovať rast.“ Toto hovorí, že koncept je dôležitý, ale nikdy nehovorí, čím je. Box nedokáže urobiť prázdne scénické nastavenie presným.

Kam ho umiestniť

Umiestnenie kóduje prioritu. Umiestnite definičný box bezprostredne za úvodný odsek alebo krátky úvod ako prvý obsahový blok. Úvod stanovuje, prečo je čitateľ na stránke; box potom fixuje význam skôr, než na ňom začnú závisieť príčiny, príklady, výhody, kroky alebo porovnania.

Neumiestňujte navigáciu, obsah, kľúčové závery, galériu obrázkov ani propagačnú výzvu na akciu medzi úvod a definíciu. Tieto bloky nútia čitateľa prejsť cez nesúvisiaci materiál predtým, než dostane význam pojmu. Omrvinková navigácia a hero stránky sú šablónové prvky, nie autorovaný obsah, preto môžu predchádzať úvodu.

Používajte jeden definičný box na stránku. Toto pravidlo existuje, pretože komponent identifikuje primárny definičný objekt stránky. Dva boxy vytvárajú dva konkurenčné hlavné pojmy a robia extrakciu nejednoznačnou. Ak sú oba pojmy skutočne primárne, rozdeľte tému na dve stránky a prepojte ich v próze. Ak je druhý pojem podradený, definujte ho inline namiesto štylovania ako druhú kanonickú odpoveď.

Blok priamej odpovede môže koexistovať s definíciou len vtedy, keď odpovedá na inú hlavnú otázku. Na diagnostickej stránke môže definícia uvádzať, čo je daný stav, zatiaľ čo blok priamej odpovede uvádza odporúčaný prvý krok. Keď je hlavnou otázkou stránky „Čo je X?“, blok priamej odpovede a definícia sú tou istou odpoveďou. Zlúčte ich do jedného definičného boxu; susedné verzie len opakujú znenie a súťažia o extrakciu.

Anatómia

Prvok má dve autorované oblasti a jeden štrukturálny vzťah. Snímka obrazovky musí zobrazovať vykreslený prvok bez zapracovania vysvetľujúceho textu do obrázka; legenda nižšie zostáva vybrateľná, prístupná a udržiavateľná pri zmene dizajnu.

Vykreslená legenda

1. Voliteľný nadpis: Zvyčajne „Čo je X?“ Identifikuje presný pojem a nesmie pridávať druhé tvrdenie.
2. Povinné telo: Jedna sebestačná definícia, ktorá pomenúva pojem, zaraďuje ho do užitočnej kategórie a uvádza, čím sa odlišuje.
3. Otváracia pozícia: Box nasleduje za úvodom a predchádza prvú vysvetľujúcu sekciu. Tento vzťah je súčasťou kontraktu, aj keď nejde o pole.

Okraj, pozadie, výplň, ikony a typografia patria do vykresľovača. Autori dodávajú význam, nie vizuálne prvky. Prvok musí zostať zrozumiteľný, ak sa odstráni každý dekoratívny štýl.

Príklady dizajnu

Galéria pokrýva podporované varianty obsahu, nie vymýšľa rôzne sémantické typy. Každý záber by mal pokiaľ možno používať rovnakú definíciu, aby recenzenti mohli posudzovať spracovanie nadpisu, zalamovanie tela a správanie vo viewporte namiesto porovnávania nesúvisiacich textov.

S nadpisom: Preferovaný variant, keď je pojem neznámy, nejednoznačný, skrátený alebo odlišný od presného názvu stránky.

Bez nadpisu: Povolené, keď hlavička stránky a bezprostredne predchádzajúci úvod robia predmet nepochybným. Telo musí stále pomenúvať pojem; vynechanie nadpisu nikdy nepovoľuje zámená ako „to“ na nahradenie subjektu.

Maximálna dĺžka: Vykresľovač zalamuje celé telo. Nesmie ho skracovať, zbaliť, posúvať ani zmenšovať písmo, aby sa prispôsobil textu na edičnom maxime.

Úzky viewport: Nadpis a telo si zachovávajú svoje poradie, čitateľnú dĺžku riadkov a viditeľné ohraničenie. Žiadny význam nesmie závisieť od ikony pohybujúcej sa vedľa textu.

Parametre

Parametre oddeľujú obsah od prezentácie. Ich limity udržiavajú definície porovnateľné naprieč stránkami a bránia premene komponentu na univerzálny callout.

Parametre definičného boxu

Vykresľovač môže odvodiť pojem pre indexovanie, ale autori nikdy nesmú napísať telo, ktoré závisí od zobrazenia tohto odvodeného poľa. Skopírovaná definícia musí explicitne pomenovať svoj subjekt.

Syntax a príklady kódu

Všetky tri formy nesú rovnaký nadpis a telo. Prenosná Markdown direktíva je kanonická autorovaná forma; Hugo a WordPress sú adaptéry. Príklady zámerne používajú identické znenie, aby migračný test mohol porovnávať hodnoty, nielen vzhľad.

Prenosná Markdown direktíva

:::definition
## Čo je content pruning?

Content pruning je proces odstraňovania, konsolidácie alebo aktualizácie stránok, ktoré už neslúžia užitočnému vyhľadávaciemu ani obchodnému účelu.
:::

Prvý nadpis sa mapuje na title; všetko za ním sa mapuje na body. Vynechajte nadpis pre variant bez nadpisu, ale ponechajte pojem v tele.

Hugo shortcode

{{< callout type="note" title="Čo je content pruning?" >}}Content pruning je proces odstraňovania, konsolidácie alebo aktualizácie stránok, ktoré už neslúžia užitočnému vyhľadávaciemu ani obchodnému účelu.{{< /callout >}}

Stránka používa existujúci callout renderer na viditeľné Hugo spracovanie. Definičný kontrakt stále pochádza z typovaného prenosného zdroja: note je tu adaptér vykresľovania, nie povolenie vkladať bežné poznámky do definičných boxov.

WordPress blok alebo shortcode

[definition title="Čo je content pruning?"]Content pruning je proces odstraňovania, konsolidácie alebo aktualizácie stránok, ktoré už neslúžia užitočnému vyhľadávaciemu ani obchodnému účelu.[/definition]

WordPress implementácia môže vystaviť rovnaké polia ako vlastný blok. Uložené hodnoty zostávajú title a body; editačné ovládacie prvky, farby a medzery sú nastavenia prezentácie a nesmú meniť význam definície.

Príklady

Toto je dobré, pretože pomenúva pojem, identifikuje podmienku a uvádza rozlišovací dôsledok. Netvrdí, že každý pár stránok zdieľajúcich slovo súťaží; fráza „rovnaký vyhľadávací zámer“ poskytuje potrebnú hranicu. Telo je užitočné bez nadpisu a dosť krátke na to, aby ho bolo možné citovať celé.

Toto je zlé, pretože nikdy nedefinuje kanibalizáciu kľúčových slov. Ponúka dôležitosť, publikum, naliehavosť a neurčitý účinok, ale žiadnu kategóriu ani rozlišovaciu podmienku. Nahradenie „jedným z najdôležitejších“ za „situácia, keď viacero stránok súťaží o rovnaký vyhľadávací zámer“ mení propagáciu na význam.

Druhým zlým vzorcom je preťaženie boxu: definícia nasledovaná príčinami, piatimi príkladmi, varovaním a odporúčaným nástrojom. Aj keď je prvá veta presná, extra materiál ničí stabilné ohraničenie. Ponechajte definíciu; presuňte príčiny a príklady do nasledujúcej sekcie, varovanie do jeho správneho prvku a odporúčanie na miesto, kde naň čitateľ môže reagovať.

Schema značkovanie a prístupnosť

Definičný box nevytvára samostatnú entitu Schema.org automaticky. Na bežnom článku zostáva jeho text súčasťou obklopujúceho Article alebo TechArticle. Na slovníkovej stránke môže publikačná implementácia mapovať pojem a definíciu na vhodný slovník len vtedy, ak stránka prijala túto politiku schemy. Nevymýšľajte typ DefinitionBox: v Schema.org neexistuje.

Podobne nezdvojujte telo v JSON-LD len preto, že box vyzerá dôležito. Schema značkovanie musí opisovať stránku pravdivo a zdvojovanie viditeľnej prózy do nesúvisiacej vlastnosti vytvára šum, nie silnejší význam. Ak je vlastnosť schemy vyplnená, jej hodnota sa musí zhodovať s viditeľnou definíciou v podstate a aktualizovať sa s ňou.

Prvok nepotrebuje interaktívnu ARIA rolu. Vykreslite ho v normálnom poradí dokumentu ako označenú oblasť alebo sémantický kontajner s nadpisom pred telom. Nepoužívajte role="alert", pretože statická definícia nie je naliehavá ani novo prichádzajúca informácia. Nepoužívajte farbu ani ikonu ako jediný signál, že blok je definíciou. Ak je nadpis implementovaný ako nadpis, jeho úroveň musí nasledovať hierarchiu stránky; zdrojové ## je konvencia mapovania polí, nie inštrukcia na vytvorenie neplatného skoku v nadpisoch.

Správanie klávesnice je bežné správanie čítania: samotný box nie je zamerateľný. Akýkoľvek odkaz vo vnútri sa riadi bežnou sémantikou odkazov a potrebuje popisnú kotvu. Výstup pre čítačky obrazovky musí zachovávať rovnaké poradie najprv nadpis, potom telo, aké je viditeľné na obrazovke.

Pravidlá písania

Napíšte definíciu skôr, ako napíšete jej výhody. Začnite samotným pojmom, potom použite sponové sloveso ako „je“, „znamená“ alebo „nastáva, keď“. Uveďte najbližšiu užitočnú kategóriu a charakteristiku, ktorá oddeľuje pojem od susedných konceptov. Táto postupnosť existuje, pretože kategória bez rozlíšenia je široká, zatiaľ čo rozlíšenie bez kategórie necháva čitateľa neistého, o aký typ veci ide.

Udržujte telo na maximálne približne 300 znakov vrátane medzier. Uprednostnite jednu vetu. Druhá krátka veta je prijateľná len vtedy, keď nemožno nevyhnutnú hranicu jasne vyjadriť v prvej. Limit je edičný, nie pozvánka na kompresiu interpunkcie, odstraňovanie členov alebo hromadenie klauzúl. Ak presnosť vyžaduje viac miesta, vložte presné jadro do boxu a kvalifikujte ho hneď potom.

Používajte neutrálny, oznamovací tón. Vyhýbajte sa „dôležitý“, „silný“, „prelomový“, „musíte vedieť“ a podobným hodnoteniam. Vyhýbajte sa kruhovým definíciám ako „optimalizácia obsahu je činnosť optimalizácie obsahu“. Skratky rozbaľte pri prvom použití, pokiaľ skratka sama o sebe nie je pojmom stránky. Používajte rovnaký kanonický názov, aký sa vyskytuje v nadpise stránky.

Nikdy neumiestňujte do tela tieto prvky:

• Viac ako jeden primárny pojem alebo zoznam súvisiacich pojmov.
• Výhody, históriu, príčiny, príznaky, príklady, kroky, produktové ponuky alebo výzvy na akciu.
• Tabuľky, obrázky, videá, formuláre, tlačidlá, poznámky pod čiarou alebo vnorené callouty.
• Nepodložené superlatívy, vymyslené štatistiky alebo tvrdenia vyžadujúce odsek dôkazov.
• Druhý nadpis, odrážkový zoznam alebo blokový citát.
• Zámená, ktorých význam závisí od predchádzajúceho úvodu.

Jeden atribučný odkaz je výnimka, nie cieľ. Použite ho len vtedy, keď právna, vedecká alebo normatívna definícia závisí od menovaného zdroja. Rozšírené citácie a nezhody medzi zdrojmi umiestnite do bežnej prózy, kde čitateľ vidí kvalifikáciu namiesto toho, aby si zamieňal jedno sporné znenie za univerzálnu definíciu.

Typy príspevkov, ktoré ho používajú

Frontmatter postTypes zaznamenáva registrované prepojenia. Tabuľka nižšie prekladá tieto prepojenia do edičných pravidiel. Formáty typu diagnóza/stav a zamerané na príznaky sú tu opísané ako vzory použitia, ale nie sú prepojené ako samostatné typy príspevkov playbooku, pretože nie sú v aktuálnom kanonickom registri.

Požiadavky podľa typu príspevku

Pre stránky typu diagnóza alebo stav používajte box vždy a umiestnite ho pred príznaky, príčiny, závažnosť alebo liečby. Pre stránky zamerané na príznaky ho používajte len vtedy, keď má názov príznaku skutočne krátku, stabilnú definíciu. Ak by box len parafrázoval nadpis – „Pomalá webová stránka je webová stránka, ktorá je pomalá“ – vynechajte ho a začnite diagnostickým prahom alebo pozorovateľným problémom v próze.

Kontrolný zoznam QA

Recenzent kontroluje význam pred vzhľadom. Vyleštený box obsahujúci vágny úvod je stále zlyhanou definíciou.

• Jeden hlavný pojem: Stránka a box definujú presne jeden primárny koncept.
• Správna pozícia: Box je prvým autorovaným obsahovým blokom po úvode, bez vloženého obsahu, kľúčových záverov, galérie alebo propagácie pred ním.
• Jeden výskyt: Žiadny druhý definičný box nesúťaží s kanonickou odpoveďou.
• Skutočná definícia: Telo uvádza, čím pojem je alebo kedy podmienka existuje; nehovorí len, prečo je pojem dôležitý.
• Sebestačné znenie: Telo pomenúva svoj subjekt a dáva zmysel, keď je skopírované bez okolitej prózy alebo štylovania.
• Presnosť: Kategória, rozlišovacia charakteristika a akákoľvek nevyhnutná hranica sú presné. Znenie nezovšeobecňuje.
• Dĺžka: Telo nemá viac než približne 300 znakov a zostáva čitateľné, nie komprimované.
• Čistý obsah: Vo vnútri nie sú žiadne výhody, história, príklady, kroky, produktové tvrdenia, médiá, tabuľky ani vnorené prvky.
• Rozhodnutie o priamej odpovedi: Ak stránka kladie otázku „Čo je X?“, definičný box je jediným prvkom priamej odpovede. Ak sú prítomné oba prvky, odpovedajú na jasne odlišné otázky.
• Prístupná sémantika: Nadpis predchádza telo, úroveň nadpisov je platná, farba nie je jediným identifikátorom a nie je prítomná žiadna rola alert ani zbytočný cieľ zamerania.
• Prenosná parita: Mapovania Markdown, Hugo a WordPress si zachovávajú rovnaký nadpis a definíciu.
• Zdržanlivosť pri štruktúrovaných údajoch: Akákoľvek hodnota schemy sa zhoduje s viditeľným textom a nepoužíva sa žiadny vymyslený typ Schema.org.
• Stav snímok obrazovky: Komentáre zostávajú nevykresľujúcimi inštrukciami na zachytenie, kým pomenované súbory neexistujú; žiadna neexistujúca cesta k obrázku sa nereferencuje ako obrázok.

FAQ

Akademická šablóna vykresľuje päť recenzovaných otázok uložených v frontmatter [[faq]] tejto stránky. Spolu pokrývajú nevyhnutnosť, koexistenciu s priamymi odpoveďami, odkazy a citácie, limit dĺžky a pravidlo jedného boxu na stránku.