Definition Box: Formát, pravidla a příklady

Definition box poskytuje hlavnímu pojmu stránky jednu přesnou a ohraničenou definici dříve, než článek téma rozvine. Jedná se o úvodní prvek: znovupoužitelnou obsahovou komponentu, která se objevuje na začátku, protože čtenář by neměl muset odvozovat ústřední pojem z příkladů, výhod nebo kontextu.

Tento živý příklad je kompletní prvek, nikoli upoutávka na definici umístěnou dále na stránce. Jeho nadpis je volitelný; jeho tělo nikoli. Níže uvedená produkční specifikace určuje, kdy prvek patří, co jednotlivá pole znamenají a jak se stejný obsah mapuje napříč publikačními systémy.

Proč na tomto prvku záleží

Čtenáři málokdy začínají číst informační stránku v pořadí každé slovo. Prohlížejí nadpis, úvodní řádky, nadpisy a vizuálně odlišené bloky, aby rozhodli, zda stránka odpovídá na jejich otázku. Definice zahrabaná v úvodním odstavci nutí čtenáře oddělovat odpověď od kontextu, tvrzení a uvádění do scény. Box tuto práci odstraňuje: jeho ohraničení říká „toto je definice."

Toto ohraničení také dává definici stabilní a adresovatelnou pozici. Editoři vědí, kde ji zkontrolovat, šablony vědí, kde ji vykreslit, a budoucí revize nenutí čtenáře ani kontrolu kvality prohledávat několik úvodních odstavců. Konzistentní umístění je důležité napříč knihovnou, protože stejný informační úkol by se neměl nepředvídatelně přesouvat ze stránky na stránku.

Strojová extrahovatelnost je schopnost softwaru izolovat obsahovou jednotku, aniž by ztratil její význam. Typovaná definice s nadpisem a tělem může být indexována, porovnávána, citována nebo samostatně transformována. Věta, která pouze náhodou definuje pojem uvnitř volného textu, se rozpouští v okolní próze: software musí hádat, kde definice začíná, kde končí a zda předchozí tvrzení je její součástí. Postupujte podle pravidel pro psaní prvků , aby sémantická identita přetrvala, i když se změní vizuální design.

Formulace musí fungovat i bez boxu. Stylování vytváří kontrast pro lidi; soběstačný podmět, sloveso a rozlišující význam vytváří extrahovatelnost pro stroje. „Je to metoda pro jejich zlepšení" selže, když je vytrženo z odstavce. „Prořezávání obsahu je proces odstraňování, konsolidace nebo aktualizace stránek, které již neslouží užitečnému vyhledávacímu nebo obchodnímu účelu" přežije.

Kdy jej použít

Použijte definition box, když je stránka organizována kolem jednoho pojmu a tento pojem lze přesně definovat v krátkém prohlášení. Je povinný pro formáty termínu v glosáři a co-je-X. Je také povinný pro obsah typu diagnóza nebo stav: čtenář musí vědět, co pojmenovaný stav je, než začne uvažovat o příčinách, testech nebo léčbě.

Stránky vedené příznaky a návody používají prvek zřídka. Přidejte jej pouze tehdy, když jedna krátká definice odstraňuje skutečnou nejednoznačnost potřebnou pro daný úkol. Například návod s názvem „Jak opravit kanibalizaci klíčových slov" může definovat kanibalizaci klíčových slov před samotnými kroky, protože diagnóza určuje, který postup se použije. Návod s názvem „Jak změnit titulek" nepotřebuje box definující titulek, pokud publikum a úvodní instrukce již činí objekt jednoznačným.

Nepoužívejte definition box pro:

• Široký úvod, historii, tvrzení o přínosech nebo vysvětlení, proč je téma důležité. Tyto pasáže rozvíjejí článek; nedefinují pojem.
• Shrnutí stránky. Shrnutí shromažďuje několik závěrů, zatímco definice uvádí význam jednoho pojmu.
• Produktový slib jako „AmICited je nejjednodušší způsob, jak zlepšit viditelnost." To je positioning, nikoli testovatelná definice.
• Varování, výhradu, předpoklad nebo tip. Jejich sdělovací úloha je jiná, i když by téma mohlo způsobit, že vypadají jako stejně barevný panel.
• Vedlejší pojem zavedený uprostřed článku. Definujte tento pojem ve větě, kde se poprvé objeví, nebo mu vytvořte vlastní stránku, pokud si zaslouží souvislé zpracování.
• Citaci, jejíž autorita nahrazuje srozumitelnost. Přiřaďte formální definici v okolní próze, pokud je uvedení zdroje nezbytné; udržujte box čitelný jako přímé prohlášení.

Častým téměř zásahem je „úvod k definici": „Ztráta zákazníků je jedním z nejdůležitějších konceptů pro předplatitelské firmy a její pochopení může transformovat růst." Toto říká, že koncept je důležitý, ale nikdy neříká, co to je. Box nemůže učinit prázdné uvádění do scény přesným.

Kam jej umístit

Umístění kóduje prioritu. Umístěte definition box bezprostředně za úvodní odstavec nebo krátký úvod jako první obsahový blok. Úvod stanoví, proč je čtenář na stránce; box pak upevní význam dříve, než na něm začnou záviset příčiny, příklady, výhody, kroky nebo srovnání.

Mezi úvod a definici neumísťujte navigaci, obsah, klíčové poznatky, galerii obrázků ani výzvu k akci. Tyto bloky nutí čtenáře procházet nesouvisející materiál, než obdrží význam pojmu. Drobečková navigace a hero sekce stránky jsou součástí šablonového chrome, nikoli autorského obsahu, a mohou tedy předcházet úvodu.

Použijte jeden definition box na stránku. Toto pravidlo existuje, protože komponenta identifikuje primární definiční objekt stránky. Dva boxy vytvářejí dva konkurenční hlavní pojmy a činí extrakci nejednoznačnou. Pokud jsou oba pojmy skutečně primární, rozdělte téma na dvě stránky a propojte je v textu. Pokud je druhý pojem podřazený, definujte jej v textu, místo abyste jej stylovali jako druhou kanonickou odpověď.

Blok přímé odpovědi může koexistovat s definicí pouze tehdy, když odpovídá na jinou hlavní otázku. Na stránce s diagnózou může definice uvádět, co daný stav je, zatímco blok přímé odpovědi uvádí doporučený první krok. Pokud je hlavní otázkou stránky „Co je X?", jsou přímá odpověď a definice stejnou odpovědí. Slučte je do jednoho definition boxu; sousedící verze pouze opakují formulaci a soutěží o extrakci.

Anatomie

Prvek má dvě autorské oblasti a jeden strukturální vztah. Screenshot musí ukazovat vykreslený prvek bez vložení vysvětlujícího textu do obrázku; legenda níže zůstává vybratelná, přístupná a udržovatelná při změně designu.

Vykreslená legenda

1. Volitelný nadpis: Obvykle „Co je X?" Identifikuje přesný pojem a nesmí přidávat druhé tvrzení.
2. Povinné tělo: Jedna soběstačná definice, která pojmenovává pojem, zařazuje jej do užitečné kategorie a uvádí, čím se odlišuje.
3. Úvodní pozice: Box následuje za úvodem a předchází první vysvětlující sekci. Tento vztah je součástí specifikace, i když se nejedná o pole.

Okraj, pozadí, odsazení, úprava ikon a typografie patří do renderovacího systému. Autoři dodávají význam, nikoli vizuální prvky. Prvek musí zůstat srozumitelný, pokud je odstraněn každý dekorativní styl.

Příklady designu

Galerie pokrývá podporované obsahové varianty, nikoli vytváří různé sémantické typy. Každý snímek by měl pokud možno používat stejnou definici, aby hodnotitelé mohli posuzovat zacházení s nadpisem, zalamování těla a chování na viewportu namísto porovnávání nesouvisejících textů.

S nadpisem: Preferovaná varianta, když je pojem neznámý, nejednoznačný, zkrácený nebo odlišný od přesného názvu stránky.

Bez nadpisu: Povoleno, když nadpis stránky a bezprostředně předcházející úvod činí předmět nezaměnitelným. Tělo musí stále pojmenovávat pojem; vynechání nadpisu nikdy neumožňuje nahradit podmět zájmeny jako „to."

Maximální délka: Renderovací systém zalomí celé tělo. Nesmí jej ořezávat, sbalovat, posouvat ani zmenšovat písmo, aby se vešel text na redakčním maximu.

Úzký viewport: Nadpis a tělo si zachovávají své pořadí, čitelnou délku řádku a viditelné ohraničení. Žádný význam nesmí záviset na ikoně, která se přesune vedle textu.

Parametry

Parametry oddělují obsah od prezentace. Jejich omezení udržují definice srovnatelné napříč stránkami a brání přeměně komponenty na univerzální callout.

Parametry definition boxu

Renderovací systém může odvodit pojem pro indexaci, ale autoři nikdy nesmí napsat tělo, které závisí na zobrazení tohoto odvozeného pole. Zkopírovaná definice musí svůj předmět explicitně pojmenovat.

Syntaxe a příklady kódu

Všechny tři formy nesou stejný nadpis a tělo. Přenosná Markdown direktiva je kanonická autorská forma; Hugo a WordPress jsou adaptéry. Příklady záměrně používají identickou formulaci, aby migrační test mohl porovnávat hodnoty, nikoli pouze vzhled.

Přenosná Markdown direktiva

:::definition
## Co je prořezávání obsahu?

Prořezávání obsahu je proces odstraňování, konsolidace nebo aktualizace stránek, které již neslouží užitečnému vyhledávacímu nebo obchodnímu účelu.
:::

První nadpis se mapuje na title; vše za ním se mapuje na body. Vynechejte nadpis pro variantu bez nadpisu, ale ponechte pojem v těle.

Hugo shortcode

{{< callout type="note" title="Co je prořezávání obsahu?" >}}Prořezávání obsahu je proces odstraňování, konsolidace nebo aktualizace stránek, které již neslouží užitečnému vyhledávacímu nebo obchodnímu účelu.{{< /callout >}}

Web znovu používá stávající renderovací systém calloutu pro viditelné Hugo zobrazení. Definiční specifikace stále vychází z typovaného přenosného zdroje: note je zde renderovací adaptér, nikoli povolení vkládat běžné poznámky do definition boxů.

WordPress blok nebo shortcode

[definition title="Co je prořezávání obsahu?"]Prořezávání obsahu je proces odstraňování, konsolidace nebo aktualizace stránek, které již neslouží užitečnému vyhledávacímu nebo obchodnímu účelu.[/definition]

WordPress implementace může vystavit stejná pole jako vlastní blok. Uložené hodnoty zůstávají title a body; editační ovládací prvky, barvy a mezery jsou nastavení prezentace a nesmí měnit význam definice.

Příklady

Toto je dobré, protože pojmenovává pojem, identifikuje podmínku a uvádí rozlišující důsledek. Netvrdí, že každá dvojice stránek sdílejících slovo soutěží; fráze „stejný vyhledávací záměr" poskytuje nezbytnou hranici. Tělo je užitečné i bez nadpisu a dost krátké na to, aby bylo citováno vcelku.

Toto je špatné, protože nikdy nedefinuje kanibalizaci klíčových slov. Nabízí důležitost, publikum, naléhavost a neurčitý účinek, ale žádnou kategorii nebo rozlišující podmínku. Nahrazení „jedním z nejdůležitějších" frází „situace, kdy více stránek soutěží o stejný vyhledávací záměr" mění propagaci ve význam.

Druhým špatným vzorem je přetížení boxu: definice následovaná příčinami, pěti příklady, varováním a doporučeným nástrojem. I když je první věta přesná, nadbytečný materiál ničí stabilní ohraničení. Ponechte definici; přesuňte příčiny a příklady do další sekce, varování do jeho správného prvku a doporučení na místo, kde na něj čtenář může reagovat.

Schema markup a přístupnost

Definition box nevytváří automaticky samostatnou entitu Schema.org. V běžném článku zůstává jeho text součástí obklopujícího Article nebo TechArticle. Na stránce glosáře může publikační implementace mapovat pojem a definici do vhodného slovníku pouze tehdy, pokud web přijal tuto politiku schema. Nevytvářejte typ DefinitionBox: v Schema.org neexistuje.

Stejně tak nezdvojujte tělo v JSON-LD jen proto, že box vypadá důležitě. Schema markup musí stránku popisovat pravdivě a zdvojování viditelné prózy do nesouvisející vlastnosti vytváří šum, nikoli silnější význam. Pokud je vlastnost schema naplněna, její hodnota se musí shodovat s viditelnou definicí v podstatě a aktualizovat se s ní.

Prvek nepotřebuje interaktivní ARIA roli. Vykreslujte jej v normálním pořadí dokumentu jako označenou oblast nebo sémantický kontejner s nadpisem před tělem. Nepoužívejte role="alert", protože statická definice není naléhavá nebo nově příchozí informace. Nepoužívejte barvu nebo ikonu jako jediný signál, že blok je definice. Pokud je nadpis implementován jako nadpisová úroveň, musí jeho úroveň následovat hierarchii stránky; zdrojový ## je konvence mapování polí, nikoli instrukce k vytvoření neplatného skoku v nadpisových úrovních.

Chování klávesnice je běžné chování při čtení: box sám o sobě není fokusovatelný. Jakýkoli odkaz uvnitř následuje běžnou sémantiku odkazů a potřebuje popisnou kotvu. Výstup pro čtečky obrazovky musí zachovávat stejné pořadí nadpis-před-tělem, které je viditelné na obrazovce.

Pravidla psaní

Napište definici dříve, než napíšete její přínosy. Začněte samotným pojmem, poté použijte spojovací sloveso jako „je," „znamená" nebo „nastává, když." Uveďte nejbližší užitečnou kategorii a charakteristiku, která odděluje pojem od sousedních konceptů. Toto pořadí existuje, protože kategorie bez rozlišení je široká, zatímco rozlišení bez kategorie nechává čtenáře na pochybách, o jaký druh věci se jedná.

Udržujte tělo na maximálně zhruba 300 znacích včetně mezer. Preferujte jednu větu. Druhá krátká věta je přijatelná pouze tehdy, když nelze nezbytnou hranici jasně vyjádřit v první větě. Omezení je redakční, nikoli pozvání ke komprimaci interpunkce, odstraňování členů nebo hromadění vedlejších vět. Pokud přesnost vyžaduje více prostoru, vložte přesné jádro do boxu a upřesněte jej bezprostředně poté.

Používejte neutrální, oznamovací tón. Vyhněte se „důležitý," „mocný," „převratný," „musíte vědět" a podobným soudům. Vyhněte se kruhovým definicím jako „optimalizace obsahu je činnost optimalizace obsahu." Rozepište zkratky při prvním použití, pokud zkratka sama není pojmem stránky. Používejte stejný kanonický název, který se objevuje v názvu stránky.

Nikdy neumísťujte do těla:

• Více než jeden primární pojem nebo seznam souvisejících pojmů.
• Výhody, historii, příčiny, příznaky, příklady, kroky, produktové nabídky nebo výzvy k akci.
• Tabulky, obrázky, videa, formuláře, tlačítka, poznámky pod čarou nebo vnořené callouty.
• Nepodložená superlativa, vymyšlené statistiky nebo tvrzení vyžadující odstavec důkazů.
• Druhý nadpis, odrážkový seznam nebo blokovou citaci.
• Zájmena, jejichž význam závisí na předcházejícím úvodu.

Jeden citační odkaz je výjimka, nikoli cíl. Použijte jej pouze tehdy, když právní, vědecká nebo standardizační definice závisí na jmenovaném zdroji. Rozsáhlé citace a neshody mezi zdroji umístěte do běžné prózy, kde čtenář vidí kvalifikaci, místo aby si jeden sporný wording spletl s univerzální definicí.

Typy příspěvků, které jej používají

Frontmatter postTypes zaznamenává registrované vazby. Tabulka překládá tyto vazby do redakčních pravidel. Formáty typu diagnóza/stav a vedené příznaky jsou zde popsány jako vzorce použití, ale nejsou propojeny jako samostatné typy příspěvků v playbooku, protože nejsou v aktuálním kanonickém registru.

Požadavky podle typu příspěvku

U stránek typu diagnóza nebo stav používejte box vždy a umístěte jej před příznaky, příčiny, závažnost nebo léčbu. U stránek vedených příznaky jej použijte pouze tehdy, má-li název příznaku skutečně krátkou, stabilní definici. Pokud by box pouze přeformuloval nadpis – „Pomalý web je web, který je pomalý" – vynechejte jej a začněte diagnostickým prahem nebo pozorovatelným problémem v próze.

Kontrolní seznam QA

Recenzent kontroluje význam dříve než vzhled. Vyleštěný box obsahující vágní úvod je stále neúspěšná definice.

• Jeden hlavní pojem: Stránka a box definují přesně jeden primární koncept.
• Správná pozice: Box je první autorský obsahový blok po úvodu, bez vloženého obsahu, klíčových poznatků, galerie nebo propagace před ním.
• Jeden výskyt: Žádný druhý definition box nesoutěží s kanonickou odpovědí.
• Skutečná definice: Tělo uvádí, co pojem je nebo kdy podmínka existuje; neříká pouze, proč je pojem důležitý.
• Soběstačná formulace: Tělo pojmenovává svůj předmět a dává smysl při zkopírování bez okolní prózy nebo stylování.
• Přesnost: Kategorie, rozlišující charakteristika a případné nezbytné hranice jsou přesné. Formulace nepříliš generalizuje.
• Délka: Tělo má nejvýše zhruba 300 znaků a zůstává čitelné, nikoli komprimované.
• Čistý obsah: Uvnitř se nenacházejí žádné výhody, historie, příklady, kroky, produktová tvrzení, média, tabulky nebo vnořené prvky.
• Rozhodnutí o přímé odpovědi: Pokud stránka klade otázku „Co je X?", je definition box jediným prvkem přímé odpovědi. Pokud jsou přítomny oba prvky, odpovídají na zřetelně odlišné otázky.
• Přístupná sémantika: Nadpis předchází tělu, úroveň nadpisů je platná, barva není jediným identifikátorem a není přítomna žádná role alert ani zbytečný cíl fokusu.
• Přenosná parita: Mapování v Markdown, Hugo a WordPress zachovává stejný nadpis a definici.
• Zdrženlivost strukturovaných dat: Jakákoli hodnota schema odpovídá viditelné kopii a není použit žádný vymyšlený typ Schema.org.
• Stav screenshotů: Komentáře zůstávají nevykreslujícími instrukcemi pro pořízení snímků, dokud pojmenované soubory neexistují; žádná neexistující cesta k obrázku není odkazována jako obrázek.

FAQ

Šablona academy vykresluje pět recenzovaných otázek uložených v [[faq]] frontmatter této stránky. Dohromady pokrývají nezbytnost, koexistenci s přímými odpověďmi, odkazy a citace, omezení délky a pravidlo jednoho boxu na stránku.