CMS i API

Vodič za widget web stranice.

Upotrijebite widget kada je brza implementacija bitna i stranica može pružiti trajne identifikatore izvora i pristupačnu jezičnu navigaciju.

Pojasnite zadatak i odluku

Ovaj vodič pretvara vodič za widgete web stranice u operativni radni tijek koji se može pregledati. Povezuje odluke o domeni, vlasništvo, dokaze i prihvaćanje tako da rezultat nastavlja raditi u proizvodnji.

Upotrijebite widget kada je brza implementacija bitna i stranica može pružiti trajne identifikatore izvora i pristupačnu jezičnu navigaciju.

Praktični postupak

  1. 1

    Vrste izvora inventara, identifikatori, polja, lokalizacije, vlasnici i stanja publikacije.

  2. 2

    Odaberite uzorak isporuke između volumena, latencije, uredničke kontrole i tolerancije kvarova.

  3. 3

    Mapirajte izvorni zapis u zasebni zapis jezične verzije s trajnom vezom.

  4. 4

    Dodajte autentifikaciju, idempotenciju, ponovni pokušaj, poništavanje predmemorije, bilježenje i kontrole pristupa.

  5. 5

    Probno objavljivanje, promjene izvora, nedostupni rezultati, vraćanje, rad tipkovnice i praćenje prije izdavanja.

Primjer ili alat

Uzorak implementacije pokriva učitavanje, nedostupne verzije, upravljanje fokusom, analitiku i ponašanje bez skripte. U alat također zabilježite početnu vrijednost, vlasnika, odluku, dokaze, otvoreni problem i datum odobrenja. Koristite pravu stranicu ili transakciju kako bi tim vidio ovisnosti, iznimke i rad na održavanju koji slijedi nakon izdavanja.

Točka odlukeSnimitiKriterij prihvatljivosti
Osnovna linijaPromatrano trenutno stanjeIzvor i datum snimanja
OdlukaOdabrana opcija i obrazloženjeRizik i publika uzeti u obzir
DokazTestirajte, dokumentirajte ili izmjeriteMože se pregledati i ovisi o verziji
OdobrenjeIme, uloga i datumZadovoljeni svi obvezni kriteriji

Potvrdite da je widget pravi uzorak isporuke

Widget je prikladan kada glavno mjesto može pružiti stabilne identifikatore izvora, stranice dijele predvidljivu strukturu sadržaja, važna je brza implementacija i prihvatljivo je poboljšanje na strani klijenta. Manje je prikladan kada zamjenske verzije moraju biti potpuno indeksirane, moraju raditi pod strogim ograničenjima skripte ili pripadaju složenom autentificiranom putovanju. U tim slučajevima, stranice prikazane na poslužitelju ili integracija CMS pružaju jaču kontrolu.

Ispunite kratku evidenciju odluka o arhitekturi koja pokriva vlasništvo nad sadržajem, podatke poslane usluzi, hosting skripti, implikacije pristanka, Pravila sigurnosti sadržaja, proračun izvedbe, podršku preglednika, pristupačnost, ponašanje pretraživanja, analitiku, stanje kvara i odgovornost za održavanje. Widget mora poboljšati stranicu, a ne postati jedini put do bitnih informacija. Izvorna usluga ostaje upotrebljiva kada je skripta blokirana, spora ili nedostupna.

KriterijDobro pristajanje widgetaRadije isporuku na strani poslužitelja
PokreniKontrolirano mjesto treba brzo dodatiPotrebna je duboka CMS kontrola tijeka rada i otpuštanja
OtkrićeIzvor jasno povezuje s poboljšanom verzijomZamjenska stranica zahtijeva neovisno indeksiranje pretraživanja
ElastičnostIzvor ostaje potpuna zamjenaZa dovršetak zadatka neophodna je alternativna verzija
SigurnostOdobrena skripta i politika prikladnosti toka podataka za web mjestoOgraničenja striktne skripte ili autentificiranog konteksta

Učitavajte progresivno i zaštitite rad stranice

Poslužite učitavač s malom verzijom iz odobrenog izvora s Integritetom podresursa tamo gdje to podržava model postavljanja. Učitajte ga s odgodom, inicijalizirajte tek nakon što relevantni spremnik postoji i izbjegavajte blokiranje primarnog sadržaja. Domaćin pruža stabilan ID stranice, reviziju izvora, lokalizaciju i dopuštene jezične načine putem provjerene konfiguracije. Nikada ne stavljajte API vjerodajnice, osobne podatke ili neograničeni HTML u atribute podataka.

Rezervirajte prostor izgleda za kontrole ili ih umetnite bez pomicanja glavnog naslova i sadržaja zadatka. Postavite proračune izvedbe za veličinu skripte, broj zahtjeva i kašnjenje interakcije. Prekini nakon definiranog vremenskog ograničenja i ukloni indikatore učitavanja. Predmemorirajte samo odobrene javne rezultate, označavajući ih prema izvornoj reviziji i načinu. Zakašnjeli ili neuspjeli widget ne skriva, duplicira ili zamjenjuje izvornu stranicu.

  1. 1

    Dodajte semantičku poveznicu koju je prikazao poslužitelj ili kontrolni rezervirano mjesto blizu zaglavlja stranice.

  2. 2

    Učitajte verzioniranu skriptu bez blokiranja izvornog sadržaja.

  3. 3

    Provjerite konfiguraciju hosta i zahtijevajte samo odobrenu javnu verziju.

  4. 4

    Renderirajte kontrole i sadržaj izvornom semantikom i predvidljivim fokusom.

  5. 5

    Izvijestite o operativnom statusu bez slanja nepotrebnog sadržaja stranice ili korisničkih podataka.

Dizajn navigacije i svako stanje kvara

Koristite običnu vezu kada jezična verzija ima vlastitu adresu. Ako se sadržaj promijeni na mjestu, upotrijebite gumb koji imenuje ciljni način, ažurira naslov dokumenta i glavni naslov prema potrebi, pomiče fokus samo kada je korisnik pokrenuo promjenu i najavljuje završetak kroz sažetu statusnu poruku. Sačuvajte povijest preglednika i omogućite jasan put natrag do izvornika. Testirajte zumiranje, reflow, tipkovnicu, čitač zaslona, ​​visoki kontrast, smanjeno kretanje i prevedene oznake.

Definirajte stanja za nedostupnu verziju, vremensko ograničenje zahtjeva, nevažeću konfiguraciju, blokiranu skriptu, nepodržani preglednik i servisno održavanje. Svako stanje čuva izvor i nudi sigurnu sljedeću akciju. Ne prikazuj stalni pokretač, praznu ploču, neobrađeni kod pogreške ili kontrolu za koju se čini da radi, ali ostavlja sadržaj nepromijenjen. Kad je JavaScript onemogućen, izvorni izvor koji je prikazao poslužitelj i sve poznate veze na zamjensku stranicu ostaju dostupni.

  • Izvorno putovanje ostaje dovršeno kada se widget nikada ne učita.

  • Kontrole koriste izvorne veze ili gumbe s odobrenim nazivima jezičnog načina rada.

  • Poruke o fokusu i statusu su predvidljive i nisu nametljive.

  • Svako stanje čekanja i nedostupnosti ima sigurnu sljedeću radnju.

  • Nijedan analitički ili dijagnostički događaj nepotrebno sadrži tekst stranice ili osobne podatke.

Testirajte okruženje domaćina i pratite stvarnu isporuku

Testirajte na reprezentativnim predlošcima, prijelomnim točkama, preglednicima, stanjima pristanka, mrežnim brzinama, sigurnosnim pravilima sadržaja, upraviteljima oznaka i pomoćnim tehnologijama. Uključite ponovljenu inicijalizaciju, navigaciju na strani klijenta, dinamički umetnuti sadržaj, ispis, naljepnice prijevoda, istek predmemorije, nedostupan rezultat, vremensko ograničenje i blokirani zahtjev treće strane. Potvrdite da widget ne stvara dvostruke ID-ove, nevažeći redoslijed naslova, zamke fokusa, pomicanje izgleda ili sukobljene globalne stilove.

Pratite uspješnost učitavanja, dostupnost verzije, vrijeme odziva, iznimke pri prikazivanju, stare revizije izvora i odabir načina rada koji pokreće korisnik. Uzorak prema predlošku hosta i verziji skripte, a ne prema osobnom identitetu. Definirajte vlasnika, prag upozorenja, verziju povrata i komunikacijski proces glavnog računala. Izdanje je prihvaćeno kada izvor ostaje upotrebljiv za svaki simulirani kvar, kritični zadaci rade pomoću tipkovnice i čitača zaslona, ​​a prethodna verzija skripte može se vratiti bez promjena stranice glavnog računala.

Uloge, dokazi i odobrenje

Generiranje odvojite od objavljivanja. Uspješan odgovor je nacrt, a ne odobrenje. Pohranite izvorni identifikator i verziju, postavke transformacije, identifikator rezultata, stanje pregleda, odobravatelja i vrijeme objave. Kada se izvor promijeni, označite jezičnu verziju za pregled umjesto tihe zamjene odobrenog sadržaja. To omogućuje vraćanje i reviziju na više platformi.

Operacije i održavanje

Rad ne završava objavljivanjem. Povežite jezičnu verziju ili konfiguraciju s izvorom, nadzirite mjere kvalitete i usluge i definirajte konkretne okidače pregleda. Okidači uključuju promjene izvora, pravne promjene, nove potrebe publike, pitanja podrške koja se ponavljaju, tehničke promjene i incidente. Imenovani vlasnik procjenjuje okidač, otvara novu reviziju po potrebi i bilježi obnovljeno odobrenje.

Kontrolni popis za objavu

  • Integracija koristi trajne identifikatore izvora.

  • Vjerodajnice se pohranjuju na strani poslužitelja i rotiraju.

  • Definirano je vremensko ograničenje, ponovni pokušaj i ponašanje ograničenja brzine.

  • Ponovljeni zahtjevi su idempotentni.

  • Generirani sadržaj ulazi u stanje pregleda.

  • Promjene izvora poništavaju ili ponovno otvaraju verziju.

  • Jezična navigacija radi pomoću tipkovnice i pomoćne tehnologije.

  • Praćenje pokriva kvarove, redove čekanja, latenciju i zastarjeli sadržaj.

Mjerodavni izvori

  1. Simple8 API dokumentacija
  2. Simple8 uzorci isporuke
  3. Smjernice za pristupačnost web sadržaja (WCAG) 2.2

Provedite vodič u praksi

Testirajte Simple8 s reprezentativnim sadržajem i koristite kontrolni popis za planiranje kontroliranog proizvodnog tijeka rada.

Testirajte vlastiti tekst