Gdje stvari postaju pomalo tehničke: Kako smo ostvarili našu verziju mapiranja kratkih kodova

Napisao/la

u

,

How-We-Made-Our-Version-Of-Shortcode-Mapping-Happen-2U prethodnom članku raspravljali smo o osnovama mapiranja kratkih kodova i kako možete dobiti pristup njegovim sjajnim pogodnostima. Odlučili smo podijeliti članak koji prikazuje verziju mapiranja kratkih kodova Page Builder Sandwicha, budući da bi sljedeći tekst mogao postati malo više tehnički.

U nastavku su detaljniji opisi unutarnjeg rada naše značajke mapiranja kratkih kodova i načina na koji smo je osposobili za rad.

Automatizirani proces

Kako bismo odlučili koje priključke uključiti u maper kratkih kodova, izradili smo automatiziranu skriptu koja će prikupiti najbolje priključke u WordPress direktoriju priključaka na temelju sljedećih kriterija:

  • Među 1000 popularnih, najbolje ocijenjenih i ažuriranih priključaka, s najmanje 4000 aktivnih instalacija,
  • S najmanje 4000 aktivnih instalacija,
  • S najmanje 20 ocjena, i;
  • S prosječnom ocjenom od najmanje 3 zvjezdice

Ovaj upit pokrećemo svakodnevno prema WordPress direktoriju priključaka. Ovi filtri osiguravaju da dobijemo popis kvalitetnih priključaka koje koristi mnogo ljudi. U vrijeme pisanja ovog teksta, ovi su kriteriji rezultirali s 800 priključaka. To je puno. Baš puno.

Neki od najpopularnijih priključaka prepoznatih za mapiranje kratkih kodova.
Neki od najpopularnijih priključaka prepoznatih za mapiranje kratkih kodova.

Zatim pokrećemo niz automatiziranih provjera izvornog koda svakog priključka kako bismo saznali sadrži li kratke kodove, a zatim pokušavamo pronaći sve te kratke kodove, uključujući sve njihove atribute. Obradom podataka to je rezultiralo s više od 2000 kratkih kodova. Dvostruki vau. Prepoznati kratki kodovi zatim se unose u bazu podataka za mapiranje kratkih kodova radi ručne provjere.

Na kraju ovog procesa dobili bismo ogroman popis priključaka i njihovih mogućih kratkih kodova. Sada je stvar u čišćenju ovih podataka kako bismo bili sigurni da je sve točno.

Ručni proces

Ovo je vjerojatno najteži dio cijelog sustava mapiranja. Kod priključaka dolazi u različitim oblicima i veličinama, stoga naše skripte ne prepoznaju automatski sve kratke kodove. Iako WordPress Codex navodi korištenje funkcije `shortcode_atts` za filtriranje atributa kratkog koda, to je samo preporuka i ne čine to svi. Također ne postoji siguran način za provjeru unutrašnjosti kratkog koda kada je priključak instaliran.

Kako bismo bili sigurni da smo točno obradili sve kratke kodove i njihove atribute, izradili smo korisničko sučelje posvećeno uređivanju kratkih kodova i atributa, koje je izgrađeno pomoću AngularJS-a i Bootstrapa.

Bootstrap & AngularJS sučelje za uređivanje svih mapiranih kratkih kodova.
Bootstrap & AngularJS sučelje za uređivanje svih mapiranih kratkih kodova.

Morat ćemo ručno proći kroz svaki pojedini priključak i provjeriti njihovu dokumentaciju za kratke kodove kako bismo se uvjerili da su svi podaci koje imamo točni.

Iako je ovo mukotrpno i naporno, postoje i svijetle strane automatiziranog procesa:

  • Prema našim ranim statistikama, samo otprilike 1 od svaka 2 priključka ima kratke kodove.
  • Polovica prepoznatih kratkih kodova nema atribute (ali dio toga mogu biti lažno pozitivni rezultati)
  • Dohvaćanjem samo kvalitetnih priključaka, velika je vjerojatnost da oni imaju dokumentaciju za kratke kodove

Kada se provjere svi kratki kodovi nekog priključka, tek tada će poslužitelj početi distribuirati mapiranja kratkih kodova tog priključka korisnicima.

Poziv REST API-ja

Posljednji dio slagalice je sam priključak. Koncept je ovdje jednostavan: saznati koji su priključci aktivni, koju temu web-mjesto koristi i koji su kratki kodovi dostupni, a zatim provjeriti u bazi podataka za mapiranje kratkih kodova ima li dostupna mapiranja. Za to smo stvorili prilagođenu krajnju točku WP REST API-ja koju svi klijenti kontaktiraju kako bi preuzeli svoja najnovija mapiranja kratkih kodova.

Budućnost: Crowdsourcing

Ručna provjera svakog priključka zahtijeva mnogo vremena i truda. Kada platforma za mapiranje kratkih kodova postane stabilna, planiramo otvoriti mapiranje kratkih kodova svima. To znači da svatko može pomoći u dodavanju kratkih kodova.

Možda se pitate: „Zašto bih pomagao u mapiranju kratkih kodova? Što ja imam od toga?” Pa, pada nam na pamet nekoliko razloga zašto bi ljudi željeli pomoći:

  1. Ako ste izradili priključak, a mi ga još nismo obuhvatili zbog gore navedenih kriterija (i nalazi se u WordPress direktoriju priključaka), mapiranja možete dodati sami. Vaš bi priključak postao u potpunosti podržan u PBS-u!
  2. Budući da ćemo se u automatiziranom procesu baviti samo onima u WordPress direktoriju priključaka, autori premium priključaka i tema neće biti uključeni. Dakle, ako imate takav, možete dodati svoja mapiranja kratkih kodova i za njih.
  3. A za one koji ne izrađuju priključke, možemo nagraditi one koji pomognu. Kako bi mapiranje kratkih kodova postalo primamljiv pothvat, rado ćemo pomagače nagraditi osobnom licencom ili nadogradnjom na premium licencu za PBS!

Prijavite se na naš bilten

Funkcionalnost mapiranja kratkih kodova okvirno će biti dostupna našim korisnicima 12. kolovoza  15. kolovoza  16. kolovoza 2016. Neće svi kratki kodovi biti mapirani do tog trenutka (naša procjena je možda 100 priključaka), ali mapiranje će se kontinuirano provoditi i korisnici će ih dobiti čim se pojave nova.

Prijavite se na naš bilten kako biste primali vijesti o mapiranju kratkih kodova, kada ćemo ga objaviti i kada ćemo otvoriti mapiranje kratkih kodova za javnost!