Prilagoditve in konfiguracija
Kontekst
Tukaj boste našli poglobljeno dokumentacijo o vsaki funkciji in nastavitvi, ki jih podpira pripomoček za komentarje.
Ta dokumentacija bo zajela osnovne koncepte in poglobila vsako področje funkcionalnosti, vključno z navodili po korakih in pogostimi pastmi.
Na voljo bodo primeri kode z označenimi relevantnimi vrsticami. Posnetki zaslona strani s konfiguracijo bodo na voljo tam, kjer je to primerno.
Primeri kode bodo uporabljali našo vanilla JavaScript knjižnico, vendar možnosti konfiguracije uporabljajo natanko ista imena za vse različice pripomočka za komentarje (React, Vue itd.).
Večina konfiguracij in funkcij, opisanih v tem vodniku, ne zahteva pisanja kode.
Identifikacija vašega računa 
Opazili boste, da je mogoče pripomoček za komentarje uporabiti s Tenant ID-jem "demo", na primer:
Run 
To je namenjeno le preizkušanju in igranju s pripomočkom za komentarje. V produkciji boste posredovali svoj Tenant ID, na primer:
Run Svoj Tenant ID lahko najdete že uporabljen v izrezku kode za pripomoček za komentarje v vašem računu.
Prav tako lahko svoj Tenant ID najdete in upravljate svoje API ključe na strani z API poverilnicami.
Od tega trenutka naprej, če ste prijavljeni v FastComments, bodo primeri kode uporabljali vaš pravi Tenant ID (če ste prijavljeni na https://fastcomments.com).
Kako so komentarji povezani s stranmi in članki
Ko prikazujemo nit komentarjev ali oddajamo komentar, FastComments mora vedeti, na kateri strani, članku ali izdelku ti komentarji pripadajo.
Za to uporabljamo nekaj, čemur pravimo "URL ID". To je lahko identifikator, na primer niz ali število, ali URL.
Privzeto, če ne določite urlId, bo to postala URL strani. Vzamemo trenutni URL strani in ga očistimo, da odstranimo morebitne pogoste marketinške parametre ali identifikatorje za sledenje.
V primeru integracij tretjih oseb, kot je WordPress, bo naš vtičnik običajno uporabil identifikator, ki predstavlja trenutno ogledano vsebino kot URL ID, na primer ID članka/strani.
Run Ena od stvari, na katero se bomo pogosto sklicevali v tem dokumentu, je Vmesnik za prilagajanje pripomočka.
Ta vmesnik lahko uporabite za številne spremembe komentarnega pripomočka brez uporabe kode.
Pri ustvarjanju pravila za prilagajanje bomo pogosto želeli, da velja za vse strani na naši strani. Vendar pa v nekaterih primerih želimo prilagoditi komentarni pripomoček na določeni strani, bodisi za uporabo posebnega oblikovanja ali morda, da so komentarji za to stran anonimni. Na primer, lahko na nekaterih straneh prikažete komentarje v živo takoj, medtem ko jih na drugih skrijete za gumbi za obvestila.
Vse to je mogoče preko polja za vnos URL ID na tej strani, ki izgleda takole:
Vrednost v tem polju naj se ujema s parametrom urlId, ki ga posredujete komentarni pripomoček. Če želite, da je vaše pravilo za prilagajanje neodvisno od urlId, pustite to polje prazno ali vnesite *.
Od leta 2023 polje URL ID v prilagajanju pripomočka zdaj podpira tudi vzorce! Na primer, lahko imate */blog/* za dodajanje slogov, specifičnih za vaš blog, in */store/* za sloge specifične za vašo trgovino, vse to ob uporabi iste domene.
Pasti
- Če ima vaša stran hash parametre (na primer example.com#page-1) - to bo privzeto postalo del URL ID.
- Med migracijami, na primer iz WordPress v Gatsby, boste morda morali po začetni migraciji migrirati vrednosti komentarjev, povezanih z URL ID. Za to nas kontaktirajte.
Prikaz istih komentarjev na različnih straneh
Ker parameter urlId omogoča, da določimo, na katero stran ali id so komentarji vezani, lahko preprosto nastavimo urlId na isto vrednost na teh straneh.
Run Prilagojeno oblikovanje
FastComments je zasnovan za prilagajanje. Komentarni pripomoček sam teče znotraj iframe-a iz varnostnih razlogov, zato morate za uporabo lastnega oblikovanja slediti eni od dveh pristopov.
Prvi, najlažji pristop, in tisti, ki ga priporočamo, je uporaba widget customization page.
Na strani za prilagajanje widgeta si oglejte razdelek "Show Advanced Options", pod katerim je območje z oznako "Custom CSS":
Ta pristop ima nekatere prednosti:
- Vneseni CSS se zmanjša (minificira), preden ga pošljemo uporabniku, in oblikovanje ostane dosledno v urejevalnem vmesniku.
- Dobite vse prednosti uporabniškega vmesnika za prilagajanje widgeta, na primer enostavno različne prilagoditve komentarskega widgeta za različna spletna mesta.
- Ko naredimo spremembe v komentarni widget, bo vaše lastno oblikovanje testirano kot del našega procesa izdaje.
Drugi pristop je določitev parametra customCSS v konfiguraciji widgeta, kot sledi:
Run Vendar pa ima to omejitve:
- Obstaja omejitev, koliko lastnega CSS-a je mogoče poslati, preden naši strežniki zavrnejo zahtevo zaradi velikosti header-jev.
- Morate upravljati lastni CSS v svoji infrastrukturi in sistemu za gradnjo. To je lahko tudi prednost namesto slabosti.
- Pri tem primeru obstaja dodatna obremenitev pošiljanja lastnega CSS-a prek omrežja dvakrat, saj ga je treba poslati našim strežnikom in ga nato poslati nazaj v vsebini iframe-a. Vendar pri večini velikosti paketov to ni opazno.
- Pogosta optimizacija je minificiranje CSS-a za zmanjšanje njegove velikosti na omrežju, vendar boste to pri tem pristopu morali urejati sami.
- Vašega lastnega CSS-a ne bomo testirali, čeprav ga uporabljate na ta način.
Zunanje datoteke CSS
Lahko naročite widget, naj pridobi zunanjo datoteko z uporabo @import!
Priporočljivo je, da @import postavite v pravilo za prilagajanje. Tako, če bomo kdaj morali spremeniti komentarni widget, lahko uporabimo naše avtomatizirane
orodja za preverjanje vaše nastavitve. Torej na primer bi ustvarili pravilo za prilagajanje v vmesniku za prilagajanje widgeta, kliknili Advanced in vnesli v Custom CSS:
@import url(https://example.com/styles.css);V kodi - ni priporočljivo
Zunanjo datoteko CSS lahko naložite tudi preko lastnosti customCSS:
Run Vendar ne pozabite, da vašega CSS-a v tem primeru ne bomo mogli testirati.
Stiliranje pojavnega okna profila uporabnika
Pojavna okna profilov uporabnikov je mogoče prav tako stilirati z lastnim CSS-om. Vendar pa, da zagotovite, da se lastno oblikovanje uporabi za profile uporabnikov, morajo biti vsi CSS selektorji predponjeni z .user-profile. Brez te predpone bo lastno oblikovanje za pojavna okna profila uporabnika prezrto.
Na primer:
Run Združljivost z prejšnjimi različicami
V FastComments vemo, da naši kupci prilagajajo komentarni widget. To je načrtno - zadnje, kar želimo, je, da naš izdelek povzroča oblikovne neskladnosti v vašem izdelku.
Ker je to pomemben del našega izdelka, imamo proces gradnje, ki nam omogoča pregled sprememb komentarnega widgeta, za vsakega kupca, pri vsaki izdaji.
Če najdemo manjše težave, bomo posodobili vaš račun, da zagotovimo nemoteno izdajo. Če opazimo večje uničujoče spremembe, nam to omogoča zaustavitev izdaje.
Prilagojene pisave
FastComments je zasnovan tako, da je mogoče opraviti prilagoditve, in pisava, ki jo uporabljajo naši pripomočki, ni izjema.
Privzeto FastComments uporablja system font stack, da izgleda čim bolje na širokem naboru naprav.
Za določitev lastnih pisav glejte Dokumentacija za prilagojen CSS.
Tam boste našli način za definiranje prilagojenega CSS-a, kar vam bo omogočilo nastaviti želene pisave.
Kako določiti pisavo
Za preglasitev pisave priporočamo, da svoj CSS definirate z selektorjema .fast-comments, textarea. Na primer:
Run Odstranjevanje znamke
Strankam, ki imajo Pro ali Enterprise račun, je omogočena odstranitev ali zamenjava naše blagovne znamke. Preprosto se obrnite na nas in z veseljem vam pomagamo.
Če želite zgolj odstraniti naš logotip iz pripomočka za komentarje, je to samodejno omogočeno pri načrtih Flex in Pro.
Ti načrti prav tako nudijo enako funkcionalnost za e-pošto, poslano iz naše platforme.
Podpora temnim ozadjem (temni način)
Privzeto bo pripomoček za komentarje FastComments samodejno zaznal temni način na večini spletnih mest.
Ko je zaznan temni način, bo FastComments prešel iz črnega besedila na belem ozadju v belo besedilo na črnem ozadju. Spremembe bodo vidne tudi pri slikah.
Ob nalaganju strani bo pripomoček poskušal določiti, kako temno je ozadje strani za pripomočkom za komentarje. To pomeni, da lahko stran ima belo ozadje, vendar če pripomoček za komentarje postavite v vsebnik s črnim ozadjem, bi moral biti temni način še vedno samodejno omogočen, da bodo komentarji berljivi.
Vendar pa mehanizem zaznavanja, ki temelji na določanju "svetilnosti", morda ne bo omogočil temnega načina, ko ga želite. Če ga želite prisilno omogočiti, nastavite zastavico hasDarkBackground na true kot sledi:
Run Preklapljanje temnega načina
Za spletna mesta, ki dovolijo preklapljanje temnega načina po začetnem nalaganju strani, je to nekoliko bolj zapleteno.
Najprej imajo vse trenutne različice knjižnice pripomočka Comment (React, Vue) primere preklapljanja temnega načina v svojih ustreznih repozitorijih.
Za pripomoček VanillaJS bo potrebno narediti še nekaj dodatnega dela. Najprej FastCommentsUI vrne objekt s funkcijama "destroy" in "update".
Preprosto lahko vsakokrat pokličemo funkcijo update, kadar želimo posodobiti konfiguracijo pripomočka za komentarje, kot sledi. Tukaj je popoln delujoč primer preklapljanja temnega načina z uporabo pripomočka VanillaJS.
Run Prepisovanje besedila
S FastComments je vse besedilo v pripomočku za komentarje prilagodljivo.
Lahko preglasite en sam del besedila, na primer gumb za oddajo, ali pa vse besedilo v celotnem pripomočku za komentarje.
Privzeto se besedilo v pripomočku za komentarje prevaja glede na lokalizacijo uporabnika. Vendar lahko besedilo preglasimo, če smo prepričani, da večina naših uporabnikov uporablja isto lokalizacijo/jezik, na primer:
Run Vse prilagodljive prevode najdete tukaj pod zavihek "napredne možnosti".
Obstaja pa lažji način, prek uporabniškega vmesnika za prilagajanje pripomočka. Tam preprosto poiščemo besedilo, ki se prikazuje v pripomočku za komentiranje v lokalizaciji EN_US, in določimo nadomestilo.
Vse spremembe prevodov trenutno vplivajo na vse lokalizacije.
Sprememba privzetega avatarja
Ko uporabnik prvič komentira z FastComments, bomo poskušali pridobiti njihov avatar z http://gravatar.com/.
Če pa ne najdemo avatarja, ali uporabnik v svojem računu nikoli ne nastavi nobenega, prikažemo statično privzeto sliko avatarja.
Za določitev lastne statične slike avatarja lahko uporabimo nastavitev defaultAvatarSrc.
Run To je mogoče narediti tudi brez kode. Na strani za prilagoditev vtičnika si oglejte razdelek "Privzeti avatar".
Upoštevajte, da je določanje avatarja za posameznega uporabnika, na primer pri SSO, zajeto v svojem razdelku.
Onemogočanje avatarjev
Avatarje je mogoče popolnoma odstraniti iz widgeta za komentarje, tudi če so uporabniki določili svoj avatar.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje widgeta:
Onemogočanje vseh privzetih slogov
Pri večjih projektih prilagojenega oblikovanja je morda smiselno začeti na "čisti osnovi" in sploh ne uporabljati privzetih slogov.
Vse privzeto slogiranje lahko odstranite tako, da parameter noStyles nastavite na true, kot sledi:
Run To lahko prilagodite brez kode, na strani za prilagajanje widgeta, v razdelku Napredne možnosti:
Povezovanje komentarjev s stranmi
Ko pošiljate obvestilna e‑poštna sporočila ali prikazujete komentarje v uporabniških vmesnikih, kot je stran za moderacijo, je koristno, da lahko povežete iz komentarja na stran, na kateri se nahaja.
Če URL ID ni vedno dejanski ID, moramo URL shraniti nekje drugje. Za to je namenjena lastnost "url", definirana takole.
Run Pogosta uporaba je vezava nitke komentarjev na identifikator, kot je članek, in nato povezava nazaj na določeno stran, na primer:
Run URL ni očiščen običajnih marketinških parametrov. Privzeto se shrani URL, kakršen je trenutni URL strani.
Privzeto strni odgovore
Privzeto se odgovori na vrhnje komentarje prikažejo.
To lahko nastavite tako, da mora uporabnik klikniti "Prikaži odgovore" na vrhnjih komentarjih, da vidi podrejene komentarje.
Run To lahko prilagodite brez kode, na strani za prilagajanje pripomočka:
Ta nastavitev ne bo vplivala na število vrhnjih komentarjev, ki se naložijo na začetku. Če imate en vrhnji komentar in 29 podrejenih komentarjev, boste s to nastavitvijo vklopljeno:
- Videli boste vrhnji komentar.
- Pod tem komentarjem boste videli "Prikaži odgovore (29)".
Če želite prikazati vse vrhnje komentarje v kombinaciji s to možnostjo, nastavite začetno stran na -1.
Omogoči WYSIWYG
Privzeto se oblikovne funkcionalnosti v FastComments izvajajo z dodajanjem vidnih oznak, kot je <b></b>, okoli vašega besedila. Klikanje orodne vrstice
ali uporaba bližnjic to naredi za vas. Vendar pa se nekatere skupnosti morda želijo odločiti za uporabo oblikovanja brez vidnih oznak. To se imenuje vklop
WYSIWYG (kar vidiš, to dobiš) urejevalnika. Ta urejevalnik izgleda enako kot privzeti, razen da naloži nekaj
dodatne kode, ki uporabnikom omogoča krepko, podčrtano itd. oblikovanje besedila brez vidnih oznak.
Run To je mogoče storiti tudi brez kode. Na strani za prilagajanje widgeta poiščite možnost "Omogoči napredno oblikovanje".
Onemogočanje orodne vrstice
Privzeto bo FastComments prikazal orodno vrstico pri pisanju komentarja, da zagotovi bližnjice za oblikovanje besedila in nalaganje slik.
To orodno vrstico je mogoče onemogočiti v kodi ali prek uporabniškega vmesnika za prilagajanje.
Run To je mogoče narediti tudi brez kode. Na strani za prilagajanje pripomočka poiščite možnost "Onemogoči orodno vrstico za odgovore".
Onemogočanje blokiranja
Privzeto FastComments omogoča uporabnikom, da blokirajo druge uporabnike. Blokiranje uporabnika bo povzročilo, da bodo njegovi komentarji prikriti, preprečilo bo obvestila med uporabnikoma in podobno.
Morda boste želeli onemogočiti to funkcionalnost. To lahko storite tako:
Run To je mogoče narediti tudi brez kode, kar omogoča tudi pravilno validacijo na strežniku, prek Widget Customization UI:
Določanje, katero stran prikazati
Ko se komentarji pridobivajo in prikazujejo, mora pripomoček za komentarje vedeti, s katere strani naj začne. Privzeto začne na prvi strani in prikaže le to stran.
Če želite, lahko natančno stran, ki naj se prikaže, posredujete pripomočku za komentarje z nastavitvijo startingPage.
Run Upoštevajte, da se številčenje strani začne pri ničli, zato zgornji primer prikaže drugo stran.
Preklapljanje med nitmi komentarjev brez osvežitve strani
Opisali smo, kako je urlId identifikator strani ali članka, s katerim so komentarji povezani.
Poleg tega, če povzamemo: če ni določen, bo urlId privzeto URL trenutne strani.
Kaj pa SPAs oziroma Single-Page Applications, kjer se stran ali vsebina, s katero so povezani komentarji, spreminja dinamično brez ponovnega nalaganja strani?
Angular, React, Vue, etc
Z našimi knjižnicami, kot sta Angular in React, bo preprosta posodobitev lastnosti urlId, posredovane pripomočku, povzročila osvežitev komentarnega pripomočka. To si lahko ogledate v delovanju za aplikacijo React, na primer tukaj.
VanillaJS
Če uporabljate knjižnico VanillaJS, je nekoliko bolj zapleteno, saj ni ogrodja, kot sta Angular ali React, ki bi upravljalo vezanje podatkov ali propagacijo stanja.
Ko ustvarite instanco VanillaJS pripomočka, ta vrne nekaj funkcij, ki jih je mogoče poklicati za njegovo posodobitev.
Tukaj je funkcionalen primer, kjer spremenimo hash strani in posodobimo komentarni pripomoček:
Run Absolutni datumi (onemogoči berljive časovne žige)
Privzeto se uporabljajo lokalizirani relativni datumi. Na primer, ob nedavno oddanem komentarju boste morda videli "pred 11 minutami".
Včasih je potrebno ali zaželeno uporabljati absolutne datume; v tem primeru nastavite ta parameter na true.
Run To lahko prilagodite brez kode, na strani za prilagajanje widgeta, v razdelku Napredne možnosti:
Prikazovanje absolutnih in relativnih datumov
Privzeto se uporabljajo lokalizirani relativni datumi. Na primer, zraven nedavno oddanega komentarja boste morda videli "pred 11 minutami".
Morda je potrebno ali zaželeno ohraniti ta relativni format datuma, hkrati pa prikazati tudi polni datum; v tem primeru nastavite ta parameter na true.
Run To lahko prilagodite brez kode na strani za prilagajanje gradnika, pod Napredne možnosti. Najprej boste morali omogočiti Absolutne datume, da boste to možnost videli v uporabniškem vmesniku.
Dodajanje besedila v glavo
Nekaj besedila, na primer naslov ali sporočilo, se lahko prikaže pod številom komentarjev, vendar nad besedilom stanja prijave.
To imenujemo naslov, privzeto pa je skrit.
Run To lahko prilagodite brez kode, na strani za prilagajanje widgeta, v razdelku Napredne možnosti:
Prikaz povezav kot besedilo
Privzeto bo FastComments prikazal povezave tako: https://exmaple.com - kjer URL povezave postane klikljiva HTML sidrna oznaka.
Nekatera spletna mesta morda želijo to onemogočiti, na primer, da bi odvrnila prevarante. To omogočamo tako, da nastavite Comment HTML Rendering Option na Links as Text.
To je mogoče prilagoditi brez kode, na strani za prilagajanje pripomočka, za celotno domeno ali stran:
Preklapljanje komentarjev s gumbom
Privzeto bo FastComments prikazal polje za vnos komentarja in nit komentarjev hkrati. Da prihrani nekaj navpičnega prostora, bo skril tudi vsa druga obvezna polja, dokler z widgetom ne bo interakcije.
Vendar je mogoče widget za komentarje skriti za gumbom, na primer:
Gumb uporablja različne prevedene nize glede na to, ali so komentarji trenutno prikazani ali ne. Če so komentarji skriti, uporablja translations.SHOW_COMMENTS_BUTTON_TEXT. Če so komentarji prikazani, uporablja translations.HIDE_COMMENTS_BUTTON_TEXT. Prevodi lahko vsebujejo besedilo [count], ki bo zamenjano z lokaliziranim številom.
Run To je zasnovano za zamenjavo konfiguracije hideCommentsUnderCountTextFormat.
Štetje se posodablja v živo skupaj z nitjo komentarjev. Gumb se ne prikaže, če komentarjev ni.
To lahko omogočite brez kode z ustvarjanjem pravilnika za prilagoditev in omogočitvijo "Click to Show Comments":
Prilagajanje besedila števila komentarjev
Število komentarjev, prikazano na vrhu pripomočka za komentarje, je mogoče prilagoditi.
To lahko nadomestite z katerim koli nizom; vrednost [count] bo nadomeščena z ustrezno številčno vrednostjo, prilagojeno lokalizaciji uporabnika.
Run To lahko prilagodite brez pisanja kode, na strani za prilagajanje pripomočka:
Onemogoči preusmerjanje slik
Privzeto FastComments dovoljuje uporabnikom nalaganje slik. Ko uporabnik klikne to sliko, FastComments privzeto odpre nov zavihek, da prikaže sliko v celoti. Nastavitev te zastavice na true onemogoči to vedenje:
Run Če ne nameravate sami prestrezati klika na sliko (glejte onImageClicked), priporočamo, da to kombinirate z nekim stiliranjem da odstranite videz, da je slika klikljiva.
Onemogoči samodejno ustvarjanje hashtagov
Ko uporabniki vnesejo hashtage v obliki #someexampletag, bo FastComments samodejno ustvaril ta HashTag in
ga označil v njihovem komentarju.
V nekaterih primerih je zaželeno onemogočiti to funkcijo ali nadzorovati, kateri hashtagi so lahko uporabljeni preko API-ja.
To naredite tako, da preprosto omogočite Disable Automatic #hashtag Creation v uporabniškem vmesniku za prilagajanje pripomočka.
Onemogoči zvonec za obvestila
Privzeto bo FastComments prikazal zvonec za obvestila v zgornjem desnem kotu območja komentarjev.
Ta zvonec bo postal rdeč in prikazal število obvestil, ki jih ima uporabnik. Nekateri primeri obvestil so:
- Uporabnik vam je odgovoril.
- Uporabnik je odgovoril v niti, v kateri ste komentirali.
- Uporabnik je dal vašemu komentarju glas.
- Uporabnik je odgovoril na stran, na katero ste naročeni.
Zvonec za obvestila omogoča tudi mehanizem za naročanje na celotno stran.
Vendar lahko povsem onemogočimo zvonec za obvestila:
Run To je mogoče narediti tudi brez kode. Na strani za prilagajanje vtičnika si oglejte razdelek "Onemogoči zvonec za obvestila".
Onemogoči profile
Privzeto bo FastComments prikazal uporabnikov profil, ko kliknete na njihov avatar.
Vendar pa lahko to funkcionalnost onemogočite:
Run To je mogoče narediti tudi brez kode. Na strani za prilagajanje widgeta si oglejte razdelek "Disable Profiles".
Onemogoči sporočilo o uspehu
Privzeto bo FastComments po oddaji komentarja prikazal sporočilo o uspehu. To lahko onemogočite na naslednji način:
Run To lahko storite tudi brez kode. Na strani za prilagajanje widgeta:
Spremeni oceno vsebine GIF-ov
Privzeto bo pripomoček za komentarje FastComments nastavil gif rating na pg.
Na voljo so možnosti g, pg, pg-13 in r.
To lahko nastavite v kodi ali prek uporabniškega vmesnika (UI). V kodi to lahko naredimo tako:
Run V uporabniškem vmesniku boste to našli pod Gif Picker Rating, če možnost Disable Image Uploads? ni obkljukana.
Moderiranje vsebine slik
Privzeto je nadzor vsebine slik v pripomočku za komentarje FastComments nastavljen na off.
Na voljo so možnosti off, low, medium in high.
V uporabniškem vmesniku za prilagajanje widgeta boste to našli pod Image Content Moderation Level, če ni označeno Disable Image Uploads?.
Spremeni način glasovanja
Privzeto bo FastComments prikazal možnosti glasovanja kot puščice gor in dol, kar uporabnikom omogoča, da komentar označijo z glasom gor ali dol.
Vendar je mogoče spremeniti slog orodne vrstice za glasovanje. Trenutne možnosti so privzeti gumbi Gor/Dol ali mehanizem za glasovanje v obliki srca.
Uporabljamo zastavico voteStyle na naslednji način:
Run Močno priporočamo, da to storite brez kode, saj tako omogočite tudi preverjanja na strežniški strani. Na strani za prilagajanje widgeta si oglejte razdelek "Slog glasovanja".
Glasovanje je mogoče tudi onemogočiti, glejte Disable Voting zgoraj pri možnostih sloga.
Onemogoči brisanje
Privzeto FastComments dovoljuje uporabnikom, da izbrišejo svoje komentarje.
Vendar je mogoče to preprečiti.
Na strani za prilagajanje gradnika (widgeta) poiščite možnost "Onemogoči brisanje".
- To vpliva samo na običajne komentatorje in ne na moderatorje ali skrbnike, ki bodo še vedno lahko brisali.
- To vpliva tudi na integracije API, kadar je poslan
contextUserId.
Onemogoči urejanje
Privzeto bo FastComments omogočil uporabnikom urejanje njihovih komentarjev.
Vendar je mogoče to preprečiti.
Na strani za prilagajanje vtičnika si oglejte možnost "Onemogoči urejanje".
- To vpliva le na običajne komentatorje in ne na moderatorje ali skrbnike, ki bodo še vedno lahko urejali.
- To bo vplivalo tudi na API integracije, kadar je
contextUserIdposredovan.
Označevanje novih komentarjev
FastComments nudi več načinov za označevanje novih komentarjev.
Najprej in predvsem, privzeto bodo komentarji, ki so sprožili obvestilo v aplikaciji (odgovori, odgovori v isti niti ali komentarji na strani
na katero ste naročeni), samodejno označeni z rahlo svetlečim avatarjem uporabnika. Barvo lahko prilagodite s CSS
z uporabo razreda is-unread.
Komentarji, objavljeni v zadnjih 24 urah, imajo dodeljen razred 24hr, ki ga lahko uporabite za oblikovanje.
Nazadnje, vsi novi živi komentarji, ki se pojavijo v uporabnikovi seji, bodo za nekaj sekund poudarjeni z animacijo. To se izvede z
is-live CSS razredom in ga je mogoče tudi prilagoditi.
Velikosti strani
Privzeto je velikost strani FastComments 30. To vključuje odgovore v nitih.
Velikost strani lahko prilagodite v Vmesniku za konfiguracijo pripomočka v različnih velikostih od 10 do 200.
Upoštevajte, da sprememba velikosti strani zahteva ponovno izračunavanje vseh nitk komentarjev v vašem računu. To lahko traja nekaj minut.
To ni mogoče nastaviti v pripomočku na odjemalski strani, ker se strani izračunavajo na strežniku.
Primer konfiguracije je prikazan spodaj:
Velikosti strani lahko prilagodite globalno, za vsako domeno ali za vsako stran, z ustvarjanjem različnih pravil prilagoditve.
To bo vplivalo na vse odjemalce, integracije in ogrodja, ki jih uporabljate za prikaz komentarjev prek naše platforme.
Predloge e-pošte
E-poštna sporočila, poslana iz FastComments vašim strankam, je mogoče prilagoditi. Predloga, logika, in prevodi se lahko spremenijo. Besedilo je mogoče prilagoditi za posamezno lokalizacijo, oblikovanje lahko se spremeni tudi za posamezno domeno. Več o prilagojenih e-poštnih predlogah najdete tukaj.
Formati uporabniških imen
Privzeto bo FastComments prikazal uporabnikovo ime tako, kot ga je vnesel, ali tako, kot je bilo posredovano prek SSO.
Včasih pa je zaželeno zamaskirati ali prikazati uporabnikovo ime na drugačen način. Na primer, če je uporabnikovo ime Allen Rex, morda želite prikazati samo "Allen R.".
To je mogoče narediti brez kode v vmesniku za prilagajanje gradnika (Widget Customization UI), v nastavitvi z imenom Commenter Name Format:
Na voljo so naslednji formati:
- Velike začetnice (prikaže primer uporabnika kot Example User)
- Zadnja inicialka (prikaže Example User kot Example U.)
- Vse inicialke (prikaže Example User kot E. U.)
- Prikaži "Anonimen"
Učinek spremembe je takojšen. Uporabniki bodo še vedno sami videli svoje polno uporabniško ime na vrhu območja za komentarje, vendar bodo njihovi komentarji prikazovali spremenjeno uporabniško ime.
Uporabniška imena so zaradi zaščite uporabnikov zamaskirana na strežniški strani.
Onemogočanje nalaganja slik
Privzeto FastComments dovoljuje nalaganje slik. To lahko onemogočite z nastavitvijo zastavice noImageUploads na true.
Run To lahko prilagodite brez kode na strani za prilagajanje pripomočka:
Omogoči iskalno polje
Privzeto v pripomočku za komentarje ni prikazanega iskalnega polja.
Vendar lahko to omogočimo z nastavitvijo zastavice enableSearch na true:
Run To lahko storite tudi brez kode. Na strani za prilagajanje pripomočka poiščite možnost "Omogoči iskalno polje".
Omogoči spojlerje
Podporo za spojlerje lahko omogočite tako, da nastavite zastavico enableSpoilers na true:
Run To je mogoče narediti tudi brez kode. Na strani za prilagajanje pripomočka si oglejte možnost "Omogoči spojlerje".
Ko je besedilo označeno, in se klikne zdaj vidni gumb SPOILER, bo besedilo zatemnjeno, dokler uporabnik nanj ne premakne miške. Za temni način naredimo enako, z drugačnimi
barvami, ki se bolje ujemajo s temnim načinom.
To je tudi združljivo z urejevalnikom WYSIWYG.
Omogoči štetje ogledov komentarjev
Privzeto FastComments ne spremlja, kdo je ogledal posamezen komentar, niti ne nudi kakršnekoli statistike o tem.
Vendar lahko to funkcijo omogočimo, in sistem bo začel slediti, ko se vsak uporabnik pomakne do komentarja.
Ko se to zgodi, se bo ob ikoni očesa, prikazani pri vsakem komentarju, povečal števec. Števec se posodablja v živo in je skrajšan glede na lokalne nastavitve uporabnika.
To lahko omogočite z nastavitvijo zastavice enableViewCounts na true:
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje vtičnika:
Spremljamo id uporabnika*, ki je ogledal komentar, tako da se ob ponovnem ogledu komentarja števec ne poveča. Če komentar ponovno ogledate po dveh letih, se bo števec znova povečal.
- *Opomba: ali anon id seje, ali IP naslov uporabnika kot zgoščena vrednost.
Takoj prikaži komentarje v živo
Privzeto je omogočeno komentiranje v živo. To pomeni, da se, če so komentarji dodani, izbrisani, urejeni ali pripeti, te spremembe prikažejo vsem uporabnikom, ki hkrati gledajo nit komentarjev.
Vendar pa se bodo ti novi komentarji privzeto prikazali pod dinamično prikazanim gumbom z besedilom, podobnim "Prikaži 2 nova komentarja".
Če so novi komentarji odgovori neposredno na stran, se bo gumb prikazal na vrhu niti komentarjev. Če so odgovori na določen komentar, se bo gumb prikazal pod tem komentarjem.
To preprečuje, da bi se velikost strani nenehno spreminjala za uporabnika, kar bi lahko povzročilo frustracije pri poskusu prijema drsnika.
Za nekatere primere uporabe, kot so dražbe v živo ali spletni dogodki, to ni zaželeno vedenje — morda želite, da je pripomoček za komentarje bolj podoben klepetu, kjer se novi komentarji "prikažejo takoj".
Zato se zastavica, ki omogoča to funkcijo, imenuje: showLiveRightAway.
Vključimo jo lahko tako:
Run To je mogoče prilagoditi brez kode, na strani za prilagoditev gradnika:
Onemogočanje komentiranja v živo
Privzeto ima FastComments vklopljeno živo komentiranje.
To pomeni, da naj bi vsak gledalec niti komentarjev videl enako vsebino.
Na primer, če je komentar dodan, se mora ta komentar prikazati. Če je komentar urejen ali odstranjen, bodo ti komentarji za vse gledalce niti prav tako urejeni ali odstranjeni. Enako velja za glasove in vse ukrepe moderiranja.
Vendar pa lahko to onemogočimo:
Run To lahko storite tudi brez kode. Na strani za prilagajanje gradnika poglejte razdelek "Onemogoči živo komentiranje".
Novi komentarji v živo na dnu
Privzeto se novi komentarji v živo pojavijo na vrhu seznama komentarjev, ko so objavljeni v realnem času.
Ko je ta možnost omogočena, se novi komentarji v živo namesto tega dodajo na dno seznama. To vpliva na način prikaza komentarjev, ko so objavljeni v živo, medtem ko uporabniki gledajo nit komentarjev.
Run Ko je ta nastavitev omogočena:
- Novi komentarji v živo, ki jih objavijo drugi uporabniki, se bodo pojavili na dnu seznama komentarjev
- Uporabniki bodo v realnem času videli, kako se novi komentarji pojavljajo pod obstoječimi komentarji
- To vpliva samo na posodobitve komentarjev v živo - ne na začetno nalaganje strani
- To lahko pomaga ohranjati tok branja, ko uporabniki spremljajo razpravo
Upoštevajte, da ta nastavitev vpliva le na to, kje so novi komentarji v živo umeščeni, ko prispevajo v realnem času. Ne vpliva na začetni vrstni red razvrščanja ob nalaganju strani.
Omogočanje neskončnega drsenja
Privzeto se pripomoček FastComments navpično prilagodi, da ustreza vsem vidnim komentarjem. Paginacija je dosežena z gumbom "Prikaži naslednje" na koncu trenutne strani, saj ugotavljamo, da je to interakcija, ki je za večino uporabnikov najbolj prijetna.
Vendar obstajajo primeri, kjer je bolj zaželeno neskončno pomikanje. Na primer, to funkcijo uporabljamo v našem izdelku Stream Chat.
Gumbe "Prikaži naslednje" lahko skrijemo in preklopimo na neskončno pomikanje tako, da zastavico enableInfiniteScrolling nastavite na true:
Run To zahteva tudi dodajanje prilagojenega CSS-a. Dodajte prilagojen CSS za selektor .comments, da omogočite pomikanje, na primer:
Run Popoln delujoč primer bi bil:
Run V zgornjem primeru uporabljamo lastnost customCSS, vendar je zaradi razlogov zmogljivosti priporočljivo namesto tega uporabiti vmesnik za konfiguracijo pripomočka (Widget Configuration UI). Oglejte si dokumentacijo za Custom CSS.
Spreminjanje privzete smeri razvrščanja
Privzeto bo FastComments razvrščal komentarje po smeri razvrščanja "Most Relevant".
Razvrščanje "Most Relevant" upošteva čas, ko je bil komentar objavljen, in število glasov pri razvrščanju.
Uporabnik lahko nato v uporabniškem vmesniku pripomočka za komentarje spremeni smer razvrščanja na bodisi "Oldest" ali "Newest First".
Vendar lahko privzeto nastavitev spremenimo na katero koli od teh treh. Na primer, če želite najprej prikazati najstarejše komentarje:
Run Vrednost defaultSortDirection nastavimo na "OF", da nastavite smer na "OF".
Za smer razvrščanja "Newest First" bi naredili naslednje:
Run Veljavne vrednosti za defaultSortDirection so:
- MR: "Most Recent"
- NF: "Newest First"
- OF: "Oldest First"
To je mogoče narediti tudi brez kode. Na strani za prilagajanje pripomočka si oglejte razdelek "Default Sort Direction".
Upoštevajte, da so komentarji na vsaki strani za vsako smer razvrščanja vnaprej izračunani, zato vse smeri razvrščanja nudijo enako zmogljivost.
Prikaz vseh komentarjev naenkrat - onemogoči straničenje
Če želite onemogočiti straničenje in prikazati vse komentarje naenkrat, nastavite startingPage na -1.
Run Premik polja za odgovor pod komentarje
Privzeto je območje za vnos komentarja pred nitjo komentarjev. Vendar pa ga lahko z nastavitvijo tega konfiguracijskega parametra na true premaknemo za.
Run To lahko prilagodite brez kode, na strani za prilagajanje pripomočka:
Omejitev dolžine komentarjev
Največje število znakov, ki jih je dovoljeno vnesti v polje za vnos komentarja, je mogoče omejiti s parametrom maxCommentCharacterLength.
Privzeta vrednost je 2000.
Elementi, kot so URL-ji slik, niso vključeni pri določanju dolžine.
Run To lahko prilagodite brez uporabe kode na strani za prilagajanje widgeta:
Onemogoči večvrstično komentiranje
Privzeto FastComments uporabniku dovoli, da vnese komentar v poljubnem številu vrstic, do privzete omejitve znakov.
Vendar je morda zaželeno omejiti uporabnika na vnos le ene vrstice besedila. Nekateri primeri uporabe vključujejo spletno dražbo ali klepet v živo, za katerega se FastComments lahko uporablja.
Zastavico useSingleLineCommentInput omogočimo na naslednji način:
Run To je mogoče narediti tudi brez kode. Na strani za prilagoditev widgeta si oglejte razdelek "Omogoči enovrstični vnos komentarja".
Upoštevajte, da so komentarji na vsaki strani za vsako smer razvrščanja vnaprej izračunani, zato imajo vse smeri razvrščanja enako zmogljivost.
Omeji število komentarjev na uporabnika
Privzeto lahko vsak uporabnik odda do 5 comments v isti minuti.
To se spremlja po user id, anon user id in ip address (hashed).
To lahko prilagodite brez kode na strani za prilagajanje widgeta:
Upoštevajte, da če uporabljate comment creation API, boste morda želeli v zahtevi do našega strežnika posredovati izvorni ip naslov uporabnika, tako da bo omejevanje hitrosti uporabljeno na posameznega uporabnika in ne globalno za vaš račun.
Prepreči nove komentarje najvišje ravni
Če nastavite noNewRootComments na true, bo widget skril območje za odgovore korenskih komentarjev, vendar bo še vedno dovoljeval uporabnikom odgovarjati
na podkomentarje. Na primer, to lahko pogojno nastavite ob nalaganju strani, da boste dovolili le nekaterim uporabnikom pustiti komentarje na najvišji ravni.
Run Največja globina odgovorov
Privzeto FastComments dovoljuje neomejeno gnezdenje odgovorov, kar ustvarja strukturo pogovora, kjer lahko uporabniki neomejeno odgovarjajo na odgovore.
Možnost maxReplyDepth vam omogoča omejiti, kako globoko se lahko razvežejo nitke odgovorov. Ko je dosežena največja globina, uporabniki na komentarjih na tej ravni ne bodo več videli gumba za odgovor.
Run Ob nastavitvi maxReplyDepth na 2:
- Uporabniki lahko komentirajo na najvišji ravni (globina 0)
- Uporabniki lahko odgovarjajo na komentarje na najvišji ravni (globina 1)
- Uporabniki lahko odgovarjajo na te odgovore (globina 2)
- Nadaljnji odgovori onkraj globine 2 niso dovoljeni
Nastavitev na 1 bi dovolila le odgovore na komentarje na najvišji ravni, kar ustvari bolj plosko strukturo razprave.
Nastavitev maxReplyDepth na 0 bi onemogočila vse odgovore in dovolila le komentarje na najvišji ravni. Če ni določeno, so odgovori lahko gnezdeni brez omejitve.
[code-example-end]
Pregled enotne prijave (SSO)
SSO, oziroma single-sign-on, je niz konvencij, ki omogoča vam ali vašim uporabnikom uporabo FastComments brez potrebe po ustvarjanju dodatnega računa.
Če ne dovolite anonimnega komentiranja, je za komentiranje z FastComments potreben račun. Ta postopek prijave naredimo zelo enostaven – uporabnik ob komentiranju pusti samo svoj e-poštni naslov. Vendar razumemo, da je tudi to lahko dodatna ovira, ki jo nekatere strani želijo odpraviti.
To trenuten trenutek zmanjšamo tako, da za celotno spletno mesto uporabi samo en prijavni tok.
Kako ga dobim?
Vse vrste računov trenutno dobijo dostop do SSO. Vendar se največje število SSO uporabnikov razlikuje glede na vaš paket. Tako kot pri drugih funkcijah, tudi načrti Pro in višji nudijo neposredno razvojno podporo.
Primerjajmo možnosti in se nato podrobno lotimo vsake izmed njih.
Migracije uporabnikov in komentarjev
Pri migraciji z platforme, ki podpira SSO, kot je Disqus, boste že imeli uporabnike in njihove komentarje.
Komentarji so uvoženi kot del migracije, bodisi preko API-ja, našega uvoznega vmesnika (Import UI) ali s podporo strankam. Import UI je prednostna izbira, če podpira platformo, iz katere migrirate, saj vključuje obravnavo napak, izvoz in nalaganje avatarjev in medijskih vsebin ter sistem za spremljanje serijskih opravil.
Samo uporabniki se dodajo samodejno ob prvem ogledu nitk komentarjev. Alternativno jih je mogoče predhodno dodati preko API-ja, vendar to delo ne prinaša veliko prednosti.
Če so komentarji uvoženi in SSO uporabniki niso ročno dodani preko API-ja, bodo komentarji samodejno pripisani uporabnikovemu računu ob prvem ustvarjanju tega računa, ko si ogleda katerokoli nit komentarjev. Nato bodo lahko upravljali, urejali in brisali komentarje, ki so jih prvotno napisali.
Samodejna migracija poteka preko e-pošte ali uporabniškega imena. Nekatere platforme ob izvozu ne zagotavljajo e-poštnih naslovov, kot je Disqus, zato v tem primeru uporabimo uporabniško ime.
- Dokler posredujete ujemajoče se uporabniško ime in e-poštni naslov v SSO obremenitvi, bomo e-poštni naslov dodali posameznim objektom komentarjev, tako da bodo obvestila in omembe delovale.
Če želite uvoziti komentarje in uporabnike hkrati, sodelujte s podporo, da prebijejo komentarje na ustrezne račune uporabnikov potem, ko so uporabniki uvoženi preko API-ja.
Torej, da povzemo najlažjo pot za migracijo:
- Uvozite komentarje.
- Avatarji in druga medijska vsebina se samodejno uvozijo, če uporabljate Import UI v
Manage Data -> Imports.
- Avatarji in druga medijska vsebina se samodejno uvozijo, če uporabljate Import UI v
- Nastavite Secure ali Simple SSO.
- Naj se migracija izvede za vsakega uporabnika samodejno, ko se prvič prijavi.
- To običajno doda manj kot sekundo k času nalaganja strani, če ima uporabnik manj kot 50k komentarjev.
Uporabniki WordPressa
Če uporabljate naš WordPress vtičnik, potem ni treba pisati nobene kode! Preprosto pojdite na stran skrbnika vtičnika, kliknite SSO Settings in nato Enable.
To vas pripelje do čarovnika z enim klikom, ki bo ustvaril vaš API ključ, ga poslal na vašo WordPress namestitev in vklopil SSO. To smo za vas združili v en sam klik.
Upoštevajte, da če nameščate vtičnik prvič, boste morali dokončati postopek namestitve, preden boste videli stran skrbnika z gumbom SSO Settings.
WordPress SSO - Moderatorji
Upoštevajte, da se zaenkrat, da bi se znašla značka "Moderator" ob komentarjih vaših moderatorjev, ko komentirajo z FastComments WordPress vtičnikom, morajo biti ti tudi dodani kot Moderator v nadzorni plošči FastComments in imeti preverjen e-poštni naslov.
Prilagojene integracije
Za prilagojene integracije sta na voljo dve možnosti.
Možnost ena - Secure SSO
S Secure SSO FastComments ve, da je uporabnik, ki komentira, glasuje in bere komentarje, resničen uporabnik na vašem spletnem mestu.
Dokler ustvarite veljaven payload, bo uporabnik vedno imel nemoteno izkušnjo komentiranja.
Pri Secure SSO se SSO payload ustvari na strežniku z uporabo HMAC avtentikacije in se nato posreduje v pripomoček na odjemalcu.
Pri Secure SSO je uporabnikov račun popolnoma ločen od preostale baze uporabnikov FastComments. To pomeni, da če imamo dva partnerja Firma A in Firma B, lahko imata oba SSO uporabnika z uporabniškim imenom "Bob".
Zahteve
- Nekaj osnovnega znanja o strežniškem razvoju.
- Nekaj osnovnega znanja o ravnanju s skrivnimi API ključi.
- Nekaj osnovnega znanja o razvoju API-jev ali strežniškem upodabljanju.
Prednosti
- Varen.
- Nemotena izkušnja komentiranja.
Slabosti
- Zahteva razvoj na strežniku.
Posodabljanje podatkov uporabnika
Pri Secure SSO bomo ob vsakem posredovanju sso uporabniškega payloada posodobili njihov uporabniški račun z najnovejšimi informacijami. Na primer, če
ima uporabnik uporabniško ime X, in v SSO payloadu posredujete Y, bo njihovo uporabniško ime postalo Y.
Če s tem pristopom želite odstraniti vrednosti, jih nastavite na null (ne undefined).
Secure SSO API
Nudimo tudi API za interakcijo s SSO uporabniki. Oglejte si the docs.
Upoštevajte, da se pri uporabi Secure SSO uporabniki ob nalaganju strani samodejno ustvarijo v ozadju. Ni vam treba množično uvažati uporabnikov.
Možnost dve - Simple SSO
Alternativa Secure SSO je, da preprosto posredujete uporabniške informacije v pripomoček za komentiranje.
Posredovanje e-poštnega naslova pri Simple SSO ni obvezno, vendar bodo brez njega njihovi komentarji prikazani kot "Unverified".
Opomba! Od začetka leta 2022 uporabniška imena pri Simple SSO ne potrebujejo biti edinstvena po celotnem FastComments.com.
Idealno naj bi bil Simple SSO izbran le pri razvoju na platformi, ki ne omogoča dostopa do strežniškega dela.
Zahteve
- Nekaj osnovnega znanja o razvoju na strani odjemalca.
- Poznavanje vsaj e-poštnega naslova uporabnika.
Prednosti
- Preprosto.
- Vsa aktivnost se kljub temu preveri.
- Uporabnik nikoli ne vnese svojega uporabniškega imena ali e-poštnega naslova.
Slabosti
- Manj varno kot Secure SSO, saj bi lahko bilo podatkovno breme na strani odjemalca zlonamerno konstruirano tako, da postanete kateri koli uporabnik.
Simple SSO API
Uporabniki, samodejno ustvarjeni preko Simple SSO toka, so shranjeni kot SSOUser objekti. Dostopate in jih upravljate lahko preko SSOUser API-ja. Oglejte si the docs.
Prilagojene integracije - varna enotna prijava (SSO)
FastComments Secure SSO uporablja HMAC-SHA256 šifriranje kot mehanizem za implementacijo SSO. Najprej bomo predstavili splošno arhitekturo, dali primere in podrobna navodila.
Obstaja tudi nekaj dokumentacije glede migracije iz drugih ponudnikov s podobnimi SSO mehanizmi ter razlik.
Potek izgleda takole:
Ker Secure SSO vključuje razvoj polne skladovnice (full-stack), so popolni delujoči primeri kode v Java/Spring, NodeJS/Express in navadnem PHP trenutno na GitHubu.
Čeprav v primeru NodeJS uporabljamo ExpressJS in v primeru Java uporabljamo Spring, v teh izvajalnih okoljih za implementacijo FastComments SSO niso potrebne dodatne knjižnice ali ogrodja — zadostujejo vgrajeni kriptografski paketi.
Ni vam treba pisati nobenih novih API končnih točk z FastComments SSO. Preprosto šifrirajte uporabnikove podatke z vašim skrivnim ključem in posredujte vsebino (payload) komentarni komponenti.
Pridobite svoj API skrivni ključ
Vaš API skrivni ključ lahko pridobite na te strani. Do te strani lahko pridete tudi tako, da v meniju izberete My Account, kliknete ploščico API/SSO in nato kliknete "Pridobi API skrivni ključ".
Parametri komentarnega gradnika
Visokonivojska dokumentacija API za komentarni gradnik je na voljo tukaj.
Poglejmo podrobneje, kaj ti parametri pomenijo.
Komentarni gradnik prejme konfiguracijski objekt - tega že posredujete, če uporabljate FastComments za posredovanje vašega ID stranke (imenovan tenantId).
Za omogočanje SSO posredujte nov objekt "sso", ki mora vsebovati naslednje parametre. Vrednosti naj bodo generirane na strežniški strani.
- userDataJSONBase64: Podatki o uporabniku v formatu JSON, ki so nato Base64 kodirani.
- verificationHash: HMAC-SHA256 zgoščenka, ustvarjena iz UNIX_TIME_MILLIS + userDataJSONBase64.
- timestamp: Časovni žig (epoch), v milisekundah. Ne sme biti v prihodnosti ali starejši od dveh dni.
- loginURL: URL, ki ga lahko komentarni gradnik prikaže za prijavo uporabnika.
- logoutURL: URL, ki ga lahko komentarni gradnik prikaže za odjavo uporabnika.
- loginCallback: Če je zagotovljen namesto prijavnega URL-ja, funkcija, ki jo bo komentarni gradnik poklical ob kliku na gumb za prijavo.
- logoutCallback: Če je zagotovljen namesto odjave URL-ja, funkcija, ki jo bo komentarni gradnik poklical ob kliku na gumb za odjavo.
Objekt uporabnika
Uporabniški objekt vsebuje naslednjo shemo:
Moderatorji in administratorji
Za skrbnike in moderatorje posredujte ustrezne zastavice isAdmin ali isModerator v objektu SSOUser.
Obvestila
Za omogočanje ali onemogočanje obvestil nastavite vrednost optedInNotifications na true ali false. Ob prvem nalaganju strani s to vrednostjo v SSO vsebini bodo nastavitve obvestil uporabnika posodobljene.
Poleg tega, če želite, da uporabniki prejemajo e-poštna obvestila za dejavnosti na straneh, na katere so naročeni (namesto samo obvestil v aplikaciji), nastavite optedInSubscriptionNotifications na true.
VIP uporabniki in posebne oznake
Ob uporabnikovem imenu lahko prikažete posebno oznako z uporabo izbirnega polja "displayLabel".
Neavtorizirani uporabniki
Za predstavitev neavtoriziranega uporabnika preprosto ne izpolnite userDataJSONBase64, verificationHash ali timestamp. Zagotovite loginURL.
Ti uporabniki ne bodo mogli komentirati; namesto tega jim bo prikazano sporočilo za prijavo (sporočilo, povezava ali gumb, odvisno od konfiguracije).
Neposredni primeri za serializacijo in zgoščevanje uporabniških podatkov
Več podrobnosti in primerov je na voljo tukaj (js), tukaj (java) in tukaj (php).
Zavedamo se, da je vsaka integracija lahko zapleten in naporen proces. Ne oklevajte in se obrnite na svojega predstavnika ali uporabite stran za podporo.
Prilagojene integracije - preprosta enotna prijava (SSO)
Z Simple SSO lahko pripomočku za komentiranje zagotovimo informacije o uporabniku, tako da mu ni treba vnesti svojega uporabniškega imena ali e-pošte za komentiranje.
Simple SSO lahko konfiguriramo tako:
Run Uporabnik bo prijavljen in bo za kulisami ustvarjen SSO uporabnik. Lastnost createdFromSimpleSSO bo nastavljena na true, če je uporabnik pridobljen prek API-ja.
Opombe:
- E-pošta je edinstveni identifikator za Simple SSO.
- Podajanje e-pošte pri Simple SSO ni obvezno, vendar bodo njihovi komentarji privzeto prikazani kot "Neoverjeni". Če e-pošta ni podana, uporabnik ne more biti popolnoma overjen.
- NOVO Od januarja 2022: uporabniška imena niso več nujno edinstvena na celotnem fastcomments.com
- Simple SSO lahko samodejno ustvari in posodobi SSO uporabnike, če je podana e-pošta in če uporabnik ni bil prvotno ustvarjen prek Secure SSO.
- Za uporabnika lahko določite značke s lastnostjo
badgeConfig. PoljebadgeIdsvsebuje ID-je značk, ki jih je treba povezati z uporabnikom. Če jeoverridenastavljeno natrue, bo nadomestilo vse obstoječe značke, prikazane pri komentarjih; če jefalse, jih bo dodalo k obstoječim značkam.
Prilagojene integracije - migracija z Disqus SSO
Največja razlika med Disqus in FastComments Secure SSO je, da Disqus uporablja SHA1 za šifriranje, medtem ko mi uporabljamo SHA256. To pomeni, da je migracija iz Disqus enostavna - zamenjajte algoritem zgoščevanja iz SHA1 v SHA256 in posodobite imena lastnosti, posredovana v UI.
Prilagojene integracije - migracija z Commento SSO
Commento uporablja povsem drugačen pristop k SSO - zahtevajo, da imate endpoint, ki ga pokličejo za overitev uporabnika. FastComments pa deluje obratno - preprosto zakodirajte in zgoščite (hash) podatke o uporabniku z uporabo vašega secret key in jih posredujte naprej.
Zaščita nitk komentarjev z enotno prijavo
FastComments SSO (podrobnosti tukaj) omogoča vašim uporabnikom komentiranje, ne da bi se morali prijaviti v drugo platformo.
Vendar to samo po sebi ne zavaruje vaših nitk komentarjev, saj so privzeto podatki komentarjev javno dostopne informacije - kdorkoli, ki si lahko ogleda stran, lahko vidi tudi komentarje.
S spremembo nastavitve lahko omejimo pridobivanje komentarjev, razen če jih zahteva skrbnik ali veljaven SSO uporabnik.
No-Code Setup
Ko je SSO nastavljen, lahko ogledovanje in interakcijo z našimi nitkami komentarjev preprečimo z ustvarjanjem pravila prilagajanja.
Ko to naredite, poiščite SSO in našli boste to možnost:
Omogočite jo in shranite pravilo prilagajanja.
Only Protect a Certain Domain or Page
Če želite zaščititi samo določen Domain ali Page, preprosto konfiguriramo pravilo prilagajanja tako, da to stori.
Na vrhu uporabniškega vmesnika za prilagajanje bomo našli dve polji, Domain and URL ID.
Če želite zaščititi samo določen domeno, v polje "domain" vnesite ustrezno domeno.
Če želite zaščititi določeno stran, v polje "URL ID" vnesite URL strani. Če imate lastno integracijo s FastComments, lahko tukaj namesto URL vnesete tudi vrsto ID-ja.
Security Levels
Ko zahtevate SSO, se boste morali odločiti, ali zahtevate Simple SSO ali Secure SSO. Če zahtevate Simple SSO, sta obe vrsti dovoljeni, vendar če zahtevate Secure SSO, mora biti vsebina pridobljena s Secure SSO obremenitvijo (payload), zgoščeno z vašim API key, da bo lahko prikazana.
Možnost ravni varnosti se bo pojavila, ko izberete "Require SSO To View Comments".
Protection Beyond Reading
Omogočitev te možnosti bo zaščitila stran ali domeno pred komentiranjem, razen če je uporabnik prijavljen preko SSO.
Gotchas
Uporabniki, ki so ustvarili komentarje pred vašo SSO integracijo, jih ne bodo mogli videti, razen če se prijavijo preko vaše SSO integracije.
Dovoli anonimno komentiranje
Privzeto bo FastComments zahteval e-poštni naslov za komentiranje. Ni nujno, da gre za veljaven e-poštni naslov, vendar dokler uporabnik ne klikne povezave, poslane nanj, bo njihov komentar prikazan z oznako "Nepotrjen komentar".
Vendar lahko odstranimo zahtevo po e-pošti. Polje za vnos e-pošte bo še vedno prikazano, vendar ne bo več obvezno.
To lahko nastavite v uporabniškem vmesniku za prilagajanje vtičnika:
Preprečevanje poteka anonimnih komentarjev
FastComments je mogoče nastaviti tako, da po želenem številu dni odstrani nepotrjene komentarje. To pomaga pri boju proti neželeni pošti.
Privzeto tega ne počne.
To lahko nastavite ali onemogočite na strani Nastavitve moderiranja.
Onemogoči vnos e-pošte
Ko uporabniki komentirajo in niso prijavljeni, jih bomo prosili, naj navedo svoj e-poštni naslov.
To bo za tega uporabnika ustvarilo "nepreverjeno sejo", in jih bomo prosili, naj to sejo potrdijo preko e-pošte.
Za nekatere strani ali aplikacije je zaželeno, da uporabnika ne prosimo za e-poštni naslov med komentiranjem ali glasovanjem.
Omogočanje anonimnega komentiranja naredi polje za vnos e-pošte neobvezno. Vendar ga lahko popolnoma onemogočimo. Najprej omogočite anonimno komentiranje, nato se bo prikazala možnost za onemogočanje polj za vnos e-pošte.
Če je to omogočeno, polja za e-pošto se na vseh naših produktih za komentiranje sploh ne bodo prikazovala.
Upoštevajte, da bodo s to konfiguracijo vsi komentarji nepreverjeni, razen če uporabnik ustvari račun in se prijavi v https://fastcomments.com.
Morda boste želeli razmisliti o onemogočitvi oznake nepreverjeno.
Onemogoči oznako 'nepreverjeno'
Privzeto bo FastComments prikazal oznako "Nepreverjen komentar" za komentarje, ki so bili oddani za uporabnika, ki ima nepreverjeno brskalniško sejo. Preberite več o nepreverjenem komentiranju tukaj.
Run Poleg tega se ta funkcija lahko uporablja, brez pisanja kode, v uporabniškem vmesniku za prilagajanje:
Dovoli anonimno glasovanje
Ko uporabniki poskušajo glasovati za komentar in niso prijavljeni, bo od njih zahtevano, da navedejo svoje uporabniško ime in e-poštni naslov.
To zahtevo lahko odstranimo, kar omogoča vsakomur glasovanje za komentar brez posredovanja kakršnih koli informacij.
Nastavitev privzetega uporabniškega imena
Ko uporabniki komentirajo ali glasujejo in niso prijavljeni, bodo pozvani, naj vnesejo svoj e-poštni naslov in uporabniško ime.
V primeru anonimnega komentiranja je včasih zaželeno določiti privzeto uporabniško ime, da se zmanjša trenje pri komentiranju. To lahko nastavite v vmesniku za prilagajanje. Anonimno komentiranje mora biti najprej omogočeno.
Povratni klici
Vse knjižnice za pripomoček za komentarje (trenutno Angular, React, Vue) podpirajo povratne klice.
Povratne klice so določene v konfiguracijskem objektu in imajo za vsako knjižnico enak podpis.
Podprti povratni klici so:
- onInit
- onAuthenticationChange
- onRender
- commentCountUpdated
- onReplySuccess
- onVoteSuccess
- onImageClicked
- onOpenProfile
- onCommentSubmitStart
- onCommentsRendered
Natančni podpisi so na voljo v TypeScript definicijah.
Tukaj je primer z vsemi uporabljenimi povratnimi klici:
Run Ročno določanje lokalne nastavitve uporabnika
Privzeto bo FastComments upodobil pripomoček za komentarje v lokalni nastavitvi, določeni s sistemom in brskalnikom uporabnika.
Ko uporabnik komentira ali se prijavi, posodobimo njegovo zadnjo uporabljeno lokalno nastavitev in to uporabimo tudi pri pošiljanju e-pošte.
To vpliva na to, kako je pripomoček za komentarje preveden za uporabnika. Lokalna nastavitev (locale) vključuje jezik in regijo uporabnika, zato bo spreminjanje lokalne nastavitve običajno spremenilo jezik, v katerem se besedilo prikaže uporabniku.
Preko uporabniškega vmesnika
To lahko določite z uporabo vmesnika za prilagajanje pripomočka. Oglejte si možnost "Lokalna nastavitev / Jezik":
Preko kode
To lahko preglasite z želeno lokalno nastavitev.
Run Podprti jeziki in kodi lokalov
Celoten seznam podprtih jezikov in pripadajočih kod lokalov najdete tukaj.
Opomba za SSO
Če uporabljate SSO, boste morda želeli posredovati uporabnikovo lokalno nastavitev v objektu uporabnika, tako da bodo e-pošta in druge vsebine zanje pravilno lokalizirane.
Omejevanje dovoljenih jezikov
Privzeto FastComments ne omejuje jezikov, v katerih se lahko komentira.
Morda je zaželeno omejiti jezike, ki jih uporablja skupnost.
This can be configured without code, on the widget customization page:
Sistem bo razčlenil njihov komentar in določil njegov jezik, nato pa ga primerjal z dovoljenim seznamom.
Če je komentar napisan v jeziku, ki ni dovoljen, se prikaže lokalizirano sporočilo o napaki.
Naslovi strani
Trenutni naslov strani je povezan z določenim urlId in je shranjen za uporabo v orodjih za moderiranje.
Privzeto se pridobi iz document.title.
Če želite, lahko svoj naslov strani določite na naslednji način:
Run Prepreči nove odgovore in onemogoči glasove
Komentiranje je mogoče zakleniti, tako da z nastavitvijo zastavice readonly na true ni mogoče oddajati novih komentarjev ali glasov.
Komentarjev prav tako ne bo mogoče urejati ali brisati.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje widgeta, za celotno domeno ali stran:
Posodobitev!
Od novembra 2022 lahko administratorji in moderatorji teme zaklenejo ali odklenijo v živo preko menija s tremi pikami nad območjem za odgovor.
To bo preprečilo nove komentarje, hkrati pa bo še vedno omogočalo glasovanje in uporabnikom dovoljevalo brisanje njihovih komentarjev, če si to želijo, medtem ko readonly tega ne omogoča.
To ustreza polju isClosed v API-ju Page.
Omejevanje domen povezav
Privzeto FastComments dovoljuje vstavljanje povezav na katerokoli zunanjo spletno stran.
To je mogoče omejiti na želeni seznam spletnih strani ali domen. Poskus objave povezave na spletno stran ali domeno, ki ni na definiranem seznamu, bo povzročil prikaz napake uporabniku.
To preverjanje velja samo za pripomoček za komentarje (Comment Widget) in API. Uvozi niso prizadeti.
To se izvede brez kode, na strani za prilagajanje pripomočka:
Število komentarjev in štetje vseh gnezdenih odgovorov
Število komentarjev, prikazano na vrhu pripomočka za komentarje, lahko prikaže bodisi vse komentarje na najvišji ravni, to pomeni odgovore, ki so neposredni odgovori na stran ali članek, ali pa je lahko to število vseh gnezdenih komentarjev.
Privzeto je to true - to je števec slednjega - vseh komentarjev. V starejših različicah pripomočka za komentarje je bila privzeta vrednost false.
Obnašanje lahko spremenimo, tako da bo štel vse gnezdene komentarje, tako da zastavico countAll nastavite na true.
Run Če želimo, da števec odraža le komentarje na najvišji ravni, zastavico nastavimo na false.
Run To trenutno ni mogoče prilagoditi brez sprememb kode.
Omogočanje povezav komentatorjev
Privzeto bo FastComments od uporabnika zahteval le njihov komentar, uporabniško ime in e-poštni naslov.
Vendar pa boste v nekaterih primerih morda želeli, da uporabnik vnese povezavo do svojega bloga ali spletne strani.
Prikaz dodatnega polja za vnos URL-ja uporabnikove spletne strani lahko omogočimo z nastavitvijo zastavice enableCommenterLinks na true:
Run Ko je omenjeni URL vnesen, bo uporabniški račun posodobljen in njihovo uporabniško ime pri vseh preteklih in prihodnjih komentarjih bo povezano na ta URL.
To lahko prilagodite brez kode, na strani za prilagajanje pripomočka:
Skupine za moderiranje
Seznam ID-jev, ustvarjenih na strani Skupine za moderiranje.
Če je določeno, bodo komentarji, oddani z navedeno konfiguracijo, vsebovali isti nabor moderationGroupIds.
Če ima Moderator definirano eno ali več Skupine za moderiranje, bo
na strani Moderate Comments videl le komentarje, povezane z njegovo skupino ali skupinami.
Run Označevanje ID-jev skupin
Seznam ID-jev za uporabo pri samodokončanju @omemb. Uporabno, če želite preprečiti označevanje uporabnikov, kadar nimajo prekrivajočih se skupin.
Če je določeno, bodo v samodokončanju po vnosu znaka @ prikazani le uporabniki iz drugih skupin.
Run Obhod piškotkov tretjih oseb
Za overjanje FastComments potrebuje, da so v vašem brskalniku omogočeni piškotki tretjih oseb. Brez njih bodo uporabniki vedno morali pustiti svoj e-poštni naslov za komentiranje (razen če je polje za vnos e-pošte skrito), njihovi komentarji pa bodo privzeto vedno prikazani kot nepreverjeni.
Da se temu izognete, lahko omogočite obhod tretjih piškotkov.
Ko je ta nastavitev omogočena, se bo pojavilo majhno pojavno okno, ki prikazuje sporočilo, da poteka prijava uporabnika. To pojavno okno se prikaže vsakič, ko uporabnik komunicira z widgetom za komentarje; na primer, če odda komentar.
To lahko naredimo v kodi tako, da zastavico enableThirdPartyCookieBypass nastavimo na true:
Run To lahko tudi nastavite preko uporabniškega vmesnika za prilagajanje widgeta, pod Enable Third-Party Cookie Popup:
Brisanje komentarjev z odgovori
Privzeto lahko uporabniki izbrišejo svoje komentarje. Poleg tega brisanje njihovega komentarja samodejno izbriše vse podrejene in začasne komentarje v niti. To vedenje velja tudi v živo.
To lahko omejite na naslednje načine:
- Namesto tega anonimizirajte izbrisani komentar (nastavite name in text na
[deleted]ali drugo vrednost po meri). - Ne dovolite brisanja komentarjev, če so odgovori. Prikaže se prilagodljivo sporočilo o napaki.
- Omejite brisanje komentarjev z odgovori le na skrbnike in moderatorje.
To lahko konfigurirate v razdelku Comment Thread Deletion v uporabniškem vmesniku za prilagajanje gradnika.
Prikaz značk v zgornji vrstici
Privzeto bo FastComments prikazal značke uporabnikov le pri njihovih komentarjih v niti komentarjev.
Vendar pa lahko značke uporabnikov prikažemo poleg njihovega imena nad obrazcem za komentar z omogočitvijo te funkcije na strani za prilagajanje gradnika:
To bo prikazalo značke uporabnika poleg njegovega imena v zgornjem pasu, kar bo njihove dosežke in status bolj izpostavilo, ko sestavljajo komentar.
Upoštevajte, da mora biti ta funkcija omogočena v uporabniškem vmesniku za prilagajanje gradnika, da deluje. Po želji lahko v konfiguraciji kode zastavico showBadgesInTopBar nastavite na false, da jo selektivno onemogočite, tudi ko je omogočena na ravni strežnika:
Run