CMS og API

WordPress implementeringsvejledning.

Vælg widget eller API levering bevidst, hold den originale side kanonisk, og udgiv sprogversioner gennem revisioner.

Afklar opgave og beslutning

Denne vejledning gør wordpress implementeringsvejledning til en arbejdsgang, der kan gennemgås. Det forbinder domænebeslutninger, ejerskab, beviser og accept, så resultatet fortsætter med at fungere i produktionen.

Vælg widget eller API levering bevidst, hold den originale side kanonisk, og udgiv sprogversioner gennem revisioner.

Praktisk arbejdsgang

  1. 1

    Beholdningskildetyper, identifikatorer, felter, lokaliteter, ejere og udgivelsestilstande.

  2. 2

    Vælg leveringsmønsteret fra volumen, latens, redaktionel kontrol og fejltolerance.

  3. 3

    Tilknyt kildeposten til en separat sprogversionspost med holdbar kobling.

  4. 4

    Tilføj godkendelse, idempotens, forsøg igen, cache-invalidering, logning og adgangskontrol.

  5. 5

    Testpublikation, kildeændringer, utilgængelige resultater, rollback, tastaturbetjening og overvågning før udgivelse.

Eksempel eller værktøj

En Gutenberg-arbejdsgang kortlægger kildesider, anmeldelsestilstande, cache-taster og sprognavigation. I værktøjet skal du også registrere basislinje, ejer, beslutning, bevis, åbent spørgsmål og godkendelsesdato. Brug en rigtig side eller transaktion, så teamet ser afhængigheder, undtagelser og vedligeholdelsesarbejdet, der følger efter udgivelsen.

BeslutningspunktOptagAcceptkriterium
BaselineObserveret nuværende tilstandKilde og dato registreret
BeslutningValgt mulighed og begrundelseRisiko og publikum taget i betragtning
BeviserTest, dokumenter eller målGennemgåbar og versionsspecifik
GodkendelseNavn, rolle og datoAlle obligatoriske kriterier opfyldt

Vælg widget-, plugin- eller API-levering på serversiden

Brug en widget, når implementeringshastigheden er vigtig, kildesiderne allerede har holdbare identifikatorer, og en afhængighed på klientsiden er acceptabel. Brug et WordPress-plugin, når redaktører har brug for generering og gennemgang i administrationsgrænsefladen. Brug API-levering på serversiden, når sprogversioner skal indekseres, cachelagres, inkluderes i feeds og gengives, selv når JavaScript ikke er tilgængeligt. Store udgivere kombinerer ofte et plugin til workflow med gengivelse på serversiden til levering.

Dokumentér valget mod redaktionel kontrol, ydeevne, tilgængelighed, søgning, fejladfærd, dataflow og vedligeholdelsesejerskab. Den originale side forbliver den autoritative kilde. En sprogversion får sit eget indlæg eller sin strukturerede post, stabil URL, anmeldelsesstatus og link til kilderevision. Undgå kun at gemme alternativt indhold i et uversioneret tilpasset felt eller browsercache, fordi korrekturlæsere ikke pålideligt kan godkende, gendanne eller revidere det.

MønsterBedste pasformPrimær kontrol
WidgetHurtig tilføjelse til et kontrolleret webstedTilgængelig fallback og fejltilstand
Plugin arbejdsgangRedaktører arbejder udelukkende i WordPressRoller, nonces, kapaciteter og revisioner
Server-side APIIndekserede, cachebare, modstandsdygtige siderKø, cache-invalidering og implementeringshandlinger

Model kildeforhold og redaktionelle tilstande

Opret en indlægstype i sprogversion, eller brug en flersproget struktur, der understøtter eksplicitte kilderelationer. Gem kildeindlægs-id, kilderevisions-id, mållokalitet, sprogtilstand, resultat-id, ordlisteversion, anmeldelsesstatus, godkendere, offentliggjort revision og gennemgangsudløser. Behold den transformerede blokstruktur, hvor det er muligt, så overskrifter, lister, links, tabeller og meddelelser forbliver semantiske i stedet for at blive fladt sammen til ét HTML-felt.

Definer statusser for anmodet, generering, kladde, emnegennemgang, sproggennemgang, godkendt, offentliggjort, forældet og mislykket. Kort hver overgang til en WordPress-funktion, ikke blot en synlig knap. En generator kan oprette et udkast, men kan ikke godkende det. Når kilden ændres, skal du sammenligne dens revision med den godkendte kilderevision og flytte sprogversionen til forældet eller krævet anmeldelse. Udgiv ikke et genskabt resultat i stilhed.

  1. 1

    Registrer sprogversionsposten og påkrævede metadata med sanering og REST-tilladelser.

  2. 2

    Kortlæg understøttede Gutenberg-blokke og definer adfærd for ikke-understøttede blokke.

  3. 3

    Konfigurer roller og tilladte statusovergange.

  4. 4

    Generer til en separat revision og fremlæg en kildesammenligning.

  5. 5

    Udgiv kun efter påkrævede godkendelser for indholdsrisikoniveauet.

Cache sikkert og give holdbar sprognavigation

Byg cache-nøgler fra webstedet, kildepost-id, kilderevision, lokalitet, sprogtilstand og gengivelsesversion. Ugyldiggør den relaterede sprogside, når dens godkendte revision ændres, dens kilde ændres, en delt blok ændres eller en relevant terminologiregel genudgives. Hvis behandlingen kører asynkront, server den sidst godkendte version, mens det nye udkast gennemgås. Udskift aldrig godkendt indhold med en tom tilstand, fordi generering ikke er tilgængelig.

Tilføj sproglinks som almindelige server-renderede ankre med klare navne såsom 'klarsprog' og 'letlæst sprog'. Inkluder gensidige links til kildesiden og korrekt metadata på alternativt sprog. Bevar tastaturfokus efter et skift på siden, og annoncer kun en ruteændring gennem den normale sidetitel og overskrift. En manglende version bør forklare, at den er utilgængelig, og linke tilbage til kilden, ikke skjule kontrollen eller sløjfe tilbage lydløst.

  • Cache-nøgler inkluderer kilde- og rendererversioner.

  • Den sidst godkendte side overlever API og køudfald.

  • Sproglinks fungerer uden JavaScript og bruger godkendt terminologi.

  • Kanoniske og alternative metadata afspejler det faktiske forhold.

  • Ændringer i delt blok og ordliste udløser berørte gennemgangsopgaver.

Test den fulde udgivelses- og tilbagerulningssti

Brug en iscenesættelse med repræsentative Gutenberg-blokke, tilpassede felter, indlejrede formularer, genanvendelige blokke og begrænsede indlæg. Testgenerering, rollehåndhævelse, anmeldelseskommentarer, planlagt udgivelse, forhåndsvisning, cache-invalidering, kildeopdatering, gammel mærkning, sletning, gendannelse og rollback. Bekræft, at REST-slutpunkter afviser uautoriserede læsninger og skrivninger, og at baggrundsjob ikke kan udløses på tværs af websteder uden gyldig nonce eller serverlegitimationsoplysninger.

Før produktion skal du definere køovervågning, fejlejerskab, legitimationsrotation, plugin-opdateringstest, databasesikkerhedskopiering og en sikker deaktiveringsprocedure. Accept kræver korrekt gengivelse ved almindelige pausepunkter, tastatur- og skærmlæsernavigation, ingen layoutskift fra sent indhold, gyldige strukturerede overskrifter, sporbar godkendelse og gendannelse af den sidst godkendte revision. Optag de understøttede WordPress, PHP, editor, flersprogede plugin og caching konfigurationer.

Roller, beviser og godkendelse

Hold generation adskilt fra udgivelse. Et vellykket svar er et udkast, ikke en godkendelse. Gem kilde-id'et og -versionen, transformationsindstillinger, resultat-id'er, gennemgangstilstand, godkender og udgivelsestid. Når kilden ændres, skal du markere sprogversionen til gennemgang i stedet for lydløst at erstatte godkendt indhold. Dette gør rollback og revision mulig på tværs af platforme.

Drift og vedligeholdelse

Værket slutter ikke ved udgivelsen. Knyt sprogversionen eller konfigurationen til dens kilde, overvåg kvalitets- og servicemål, og definer konkrete gennemgangsudløsere. Triggere omfatter kildeændringer, juridiske ændringer, nye publikumsbehov, tilbagevendende supportspørgsmål, tekniske ændringer og hændelser. En navngivet ejer evaluerer udløseren, åbner en ny revision, når det er nødvendigt, og registrerer fornyet godkendelse.

Tjekliste før udgivelse

  • Integrationen bruger holdbare kildeidentifikatorer.

  • Legitimationsoplysninger gemmes på serversiden og roteres.

  • Timeout, genforsøg og hastighedsbegrænsningsadfærd er defineret.

  • Gentagne anmodninger er idempotente.

  • Genereret indhold går ind i en anmeldelsestilstand.

  • Kildeændringer ugyldiggør eller genåbner versionen.

  • Sprognavigation fungerer ved hjælp af tastatur og hjælpeteknologi.

  • Overvågning dækker fejl, køer, latens og forældet indhold.

Autoritative kilder

  1. Simple8 API dokumentation
  2. Simple8 leveringsmønstre
  3. Retningslinjer for tilgængelighed til webindhold (WCAG) 2.2

Udfør guiden i praksis

Test Simple8 med repræsentativt indhold, og brug tjeklisten til at planlægge en kontrolleret produktionsarbejdsgang.

Test din egen tekst