Prilagoditve in konfiguracija
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.
Prepoznavanje 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
Pri izrisu niza komentarjev ali pri pisanju komentarja FastComments mora vedeti, kateri strani, članek ali izdelek ti komentarji pripadajo.
Za to uporabljamo nekaj, kar imenujemo "URL ID". To je lahko identifikator, kot je niz ali številka, ali pa URL.
Privzeto, če ne določite urlId, bo to URL strani. Vzeli bomo trenutni URL strani in ga očistili, da odstranimo morebitne običajne marketinške parametre ali sledilne identifikatorje.
V primeru integracij tretjih strani, kot je WordPress, naš vtičnik običajno uporabi identifikator, ki predstavlja trenutno prikazano informacijo, kot URL ID, na primer ID članka/strani.
Run Ena stvar, na katero bomo v tem dokumentu pogosto sklicovali, je uporabniški vmesnik za prilagajanje gradnika.
Ta vmesnik se lahko uporabi za številne spremembe gradnika za komentarje brez uporabe kode.
Ko ustvarjamo pravilo za prilagajanje, ga pogosto želimo uporabiti za vse strani našega spletnega mesta. Vendar pa v nekaterih primerih želimo prilagoditi gradnik za komentarje na določeni strani, bodisi za uporabo po meri oblikovanja, bodisi za anonimnost komentarjev na tej strani. Lahko tudi, na primer, omogočite, da se živi komentarji takoj prikažejo na nekaterih straneh, medtem ko so na drugih skriti pod obvestilnimi gumbi.
Vse to je mogoče preko vnosnega polja URL ID na tej strani, ki izgleda takole:
Vrednost v tem polju mora ustrezati parametru urlId, ki se posreduje gradniku za komentarje. Če želite, da je vaše pravilo prilagajanja neodvisno od urlId, pustite to polje prazno ali vnesite *.
Od leta 2023 polje URL ID v prilagajanju gradnika zdaj sprejema tudi vzorce! Na primer, lahko imate */blog/* za dodajanje oblikovanja, specifičnega za vaš blog, in */store/* za oblikovanje, specifično za vašo trgovino, vse pri uporabi iste domene.
Pastrežki
- Če vaša stran vsebuje hash parametre (npr. example.com#page-1) – ti bodo privzeto postali del URL ID.
- Med migracijami, na primer iz WordPressa v Gatsby, boste morda morali po začetni migraciji prenesti vrednosti komentarjev 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 tako, da ga je mogoče prilagoditi. Sam pripomoček za komentiranje teče v iframeu iz varnostnih razlogov, zato morate za uporabo po meri oblikovanja slediti enemu od dveh pristopov.
Prvi, najlažji pristop, ki ga mi priporočamo, je uporaba strani za prilagajanje gradnika.
Na strani za prilagajanje gradnika poiščite razdelek "Prikaži napredne možnosti", pod katerim je območje označeno kot "Po meri CSS":
Ta pristop ima nekaj prednosti:
- Vneseni CSS je minificiran, preden je poslan uporabniku, oblikovanje pa ostane dosledno v uporabniškem vmesniku za urejanje.
- Dobite vse prednosti uporabniškega vmesnika za prilagajanje gradnika, na primer enostavno prilagajanje pripomočka za komentiranje za različna spletna mesta.
- Ko naredimo spremembe v pripomočku za komentiranje, bo vaše po meri oblikovanje preizkušeno kot del našega postopka izdajanja.
Drugi pristop je, da v konfiguraciji gradnika določite parameter customCSS, kot sledi:
Run Vendar ima to omejitve:
- Obstaja omejitev, koliko po meri CSS lahko pošljemo, preden naši strežniki zavrnejo zahtevo, zaradi velikosti glave.
- Morate upravljati po meri CSS v svoji infrastrukturi in sistemu gradnje. To je lahko tudi prednost, ne le slabost.
- V tem primeru je dodatna obremenitev pošiljanja po meri CSS po omrežju dvakrat, saj mora biti poslan na naše strežnike in nato nazaj v vsebino iframea. Vendar pa za večino velikosti paketov to ni opazno.
- Pogosta optimizacija je minifikacija CSS, da se zmanjša njegova velikost po omrežju, vendar boste pri tem pristopu to morali sami upravljati.
- Vaš po meri CSS ne bo preizkušen, ko bomo naredili spremembe.
External CSS Files
Gradniku lahko poveste, naj naloži zunanjo datoteko z uporabo @import!
Priporočamo, da @import postavite v pravilo prilagajanja. Na ta način, če bomo kdaj morali spremeniti pripomoček za komentiranje, lahko uporabimo naše avtomatizacijske orodje za preverjanje nastavitve. Na primer, ustvarite pravilo prilagajanja v uporabniškem vmesniku za prilagajanje gradnika, kliknete Advanced in vnesete v Custom CSS:
@import url(https://example.com/styles.css);In Code - Not Recommended
Zunanjo CSS datoteko lahko naložite tudi prek lastnosti customCSS:
Run Vendar pa se spomnite, da vaš CSS ne bo mogel biti preizkušen s strani nas, če to storite.
User Profile Modal Styling
Modalna okna uporabniškega profila je mogoče tudi stilizirati s po meri CSS. Vendar pa, da zagotovite, da se po meri oblikovanje uporabi na uporabniških profilih, morajo biti vsi CSS selektorji predpripeti z .user-profile. Brez tega predpone bo po meri oblikovanje prezrto za modalna okna uporabniškega profila.
Na primer:
Run Backwards Compatibility
Pri FastComments vemo, da naši uporabniki prilagajajo pripomoček za komentiranje. To je po zasnovi – zadnja stvar, ki jo želimo, je, da bi naš izdelek povzročil neskladnosti v oblikovanju vašega izdelka.
Ker je to pomemben del našega izdelka, imamo gradbeni proces, ki nam omogoča pregled sprememb pripomočka za komentiranje po strankah pri vsaki izdaji.
Če najdemo manjše težave, bomo posodobili vaš račun, da zagotovimo nemoteno izdajo. Če opazimo večje prelomne spremembe, nam to omogoča, da izdajo ustavimo.
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 blagovne 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 prepišete posamezen del besedila, kot je gumb za pošiljanje, ali vso besedilo v celotnem pripomočku za komentarje.
Privzeto je besedilo v pripomočku za komentarje prevedeno glede na uporabnikovo lokalno nastavitve. Vendar lahko besedilo prepišemo, če smo prepričani, da naša baza uporabnikov uporablja enako lokalno/jezikovno nastavitve, na primer:
Run Vse prilagodljive prevode lahko najdete tukaj pod zavihkom "napredne možnosti".
Vendar obstaja preprostejši način, prek uporabniškega vmesnika za prilagajanje pripomočka. Tam lahko preprosto najdemo besedilo, ki se prikaže v pripomočku za komentarje v lokalni nastavitvi EN_US, in določimo nadomestilo.
Vsi prepisani prevodi trenutno vplivajo na vse lokalne nastavitve.
Sprememba privzetega avatarja
Ko uporabnik prvič komentira z FastComments, poskušamo pridobiti njegov avatar iz https://gravatar.com/.
Vendar, če avatarja ne najdemo ali uporabnik nikoli ne nastavi avatarja v svoj račun, prikažemo statično privzeto sliko avatarja.
Za določitev lastne statične slike avatarja lahko uporabimo nastavitev defaultAvatarSrc.
Run To lahko storite tudi brez kode. Na strani za prilagajanje gradnika si oglejte razdelek "Privzeti avatar".
Upoštevajte, da je določanje avatarja za določenega uporabnika, na primer s SSO, obravnavano v svojem razdelku.
Onemogočanje avatarjev
Avatarje je mogoče v celoti odstraniti iz gradnika za komentarje, tudi če so uporabniki določili svoj avatar.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje gradnika:
Onemogočanje vseh privzetih slogov
Za večje projekte po meri po oblikovanju je morda zaželeno začeti s čisto ploščo in sploh ne uporabljati privzetega oblikovanja.
Vso privzeto oblikovanje je mogoče odstraniti tako, da nastavite parameter noStyles na true, kot sledi:
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika, pod naprednimi možnostmi:
Povezave iz komentarjev na strani
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 zlaganje odgovorov
Privzeto se odgovori na komentarje najvišje ravni prikažejo.
To je mogoče nastaviti tako, da mora uporabnik klikniti "Show Replies" na komentarjih najvišje ravni, da vidi podkomentarje.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika:
Ta nastavitev ne bo vplivala na število začetno naloženih komentarjev najvišje ravni. Če imate en komentar najvišje ravni in 29 podkomentarjev, boste z vklopljeno nastavitvijo:
- Videli boste komentar najvišje ravni.
- Videli boste Show Replies (29) pod tem komentarjem.
Če želite prikazati vse komentarje najvišje ravni v kombinaciji s to možnostjo, nastavite začetno stran na -1.
Omogoči WYSIWYG
Privzeto se funkcionalnosti oblikovanja v FastComments izvajajo z dodajanjem vidnih sidrnih oznak, kot je <b></b>, okoli vašega besedila. Klik na orodno vrstico ali uporaba bližnjic to naredi za vas. Vendar pa nekatere skupnosti morda želijo uporabljati oblikovanje brez sidrnih oznak. To se imenuje omogočanje urejevalnika WYSIWYG (what you see is what you get). Ta urejevalnik izgleda povsem enako kot privzeti, razen da naloži dodatno kodo, ki uporabnikom omogoča, da besedilo odebelijo, podčrtajo itd., brez vidnih sidrnih oznak.
Run To je mogoče storiti tudi brez kode. Na strani za prilagajanje gradnika si oglejte možnost "Enable Advanced Formatting".
Onemogočanje orodne vrstice
Privzeto bo FastComments prikazal orodno vrstico pri pisanju komentarja, da zagotavlja 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 storiti tudi brez kode. Na strani za prilagajanje gradnika si oglejte možnost "Onemogoči orodno vrstico za odgovor".
Onemogočanje blokiranja
Privzeto FastComments omogoča uporabnikom, da blokirajo druge uporabnike. Blokiranje uporabnika bo povzročilo, da se njihovi komentarji skrijejo, preprečuje obvestila med uporabniki in podobno.
Morda bo zaželeno onemogočiti to funkcionalnost. To lahko storite na naslednji način:
Run To je mogoče storiti tudi brez kode, kar omogoča tudi ustrezno strežniško validacijo, prek uporabniškega vmesnika za prilagajanje gradnika:
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 niti komentarjev brez ponovnega nalaganja 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 človeško prijazne časovne žige)
Privzeto se uporabljajo lokalizirani relativni datumi. Na primer, poleg nedavno objavljenega komentarja lahko vidite "11 minut nazaj".
Morda bo potrebno ali zaželeno uporabiti absolutne datume, v tem primeru nastavite ta parameter na true.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje gradnika, pod naprednimi možnostmi:
Prikazovanje tako absolutnih kot relativnih datumov
Privzeto se uporabljajo lokalizirani relativni datumi. Na primer, poleg nedavno objavljenega komentarja lahko vidite "11 minut nazaj".
Morda je potrebno ali zaželeno ohraniti ta relativni format datuma, hkrati pa prikazati tudi celoten datum poleg njega; v tem primeru nastavite ta parameter na true.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika, pod naprednimi možnostmi. Najprej boste morali omogočiti absolutne datume, da vidite to možnost v uporabniškem vmesniku.
Dodajanje besedila v glavo
Nekaj besedila, kot je glava ali sporočilo, se lahko prikaže pod številom komentarjev, a nad besedilom stanja prijave.
To imenujemo glava, privzeto pa je skrita.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika, pod naprednimi možnostmi:
Prikaži povezave kot besedilo
Privzeto bo FastComments prikazal povezave takole: https://exmaple.com – kjer URL povezave postane klikabilna HTML sidrična oznaka.
Nekatera spletna mesta morda želijo to onemogočiti, na primer za odvrnitev prevarantov. To omogočimo tako, da nastavimo Comment HTML Rendering Option na Links as Text.
To je mogoče prilagoditi brez kode, na strani za prilagajanje gradnika, za celotno domeno ali stran:
Preklapljanje komentarjev s gumbom
Privzeto bo FastComments izrisal vnosno polje za komentar in nit komentarjev hkrati. Za prihranek nekaj navpičnega prostora, bo tudi skril vsa druga zahtevana polja, dokler se z vtičnikom ne interagira.
Vendar pa je lahko pripomoček za komentarje skrit za gumbom, na primer:
Gumb uporablja različna prevedena besedila, odvisno od tega, 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. Prevajanja lahko vsebujejo besedilo [count], ki bo
zamenjano z lokaliziranim številom.
Run To je zasnovano za nadomestitev nastavitve hideCommentsUnderCountTextFormat.
Število se posodablja v živo skupaj z nitjo komentarjev. Gumb se ne prikaže, če ni komentarjev.
To je mogoče omogočiti brez kode tako, da ustvarite pravilo prilagoditve in omogočite "Click to Show Comments":
Prilagajanje besedila števila komentarjev
Število komentarjev, prikazano na vrhu gradnika za komentarje, je mogoče prilagoditi.
To lahko nadomestite s katerimkoli nizom, vrednost [count] pa bo zamenjana s številom komentarjev, lokaliziranim za uporabnika.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika:
![Polje besedila števila komentarjev na strani za prilagajanje gradnika, kjer je [count] nadomeščen s trenutnim skupnim številom](/images/fda404df4bf1a10da3b6952496647d6b.png)
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 vnašajo hashtag-e v obliki #someexampletag, FastComments bo samodejno ustvaril ta HashTag in
poudaril ga v njihovem komentarju.
V nekaterih primerih je zaželeno onemogočiti to funkcijo ali nadzorovati, kateri hashtag-i se lahko uporabljajo prek API-ja.
Za to preprosto omogočite Disable Automatic #hashtag Creation prek uporabniškega vmesnika za prilagajanje gradnikov.
Onemogoči zvonec za obvestila
Privzeto bo FastComments prikazal obvestilni zvonec v zgornjem desnem kotu območja komentarjev.
Zvonec bo postal rdeč in prikazal število obvestil, ki jih ima uporabnik. Nekateri primeri obvestil so:
- Uporabnik je odgovoril vam.
- Uporabnik je odgovoril v nitki, v kateri ste komentirali.
- Uporabnik je glasoval za vaš komentar.
- Uporabnik je odgovoril na stran, na katero ste se naročili.
Obvestilni zvonec prav tako omogoča naročanje na celotno stran.
Vendar pa lahko obvestilni zvonec popolnoma onemogočimo:
Run To je mogoče tudi brez kode. Na strani za prilagajanje gradnika si oglejte razdelek "Onemogoči obvestilno zvonec".
Onemogoči profile
Privzeto bo FastComments prikazal uporabnikov profil, ko kliknete na njihov avatar.
Vendar lahko to funkcionalnost onemogočimo:
Run To je mogoče storiti tudi brez kode. Na strani za prilagajanje gradnika si oglejte razdelek "Onemogoči profile".
Onemogoči komentarje na profilih
Privzeto bo FastComments prikazal zavihek "Komentarji profila" na uporabniških profilih, kar obiskovalcem omogoča, da pustijo komentarje na nečijem profilu.
Vendar lahko ta zavihek onemogočimo:
Run To je mogoče storiti tudi brez kode. Na strani za prilagajanje gradnika si oglejte razdelek "Onemogoči komentarje profila".
Onemogoči neposredna sporočila na profilih
Privzeto bo FastComments prikazal zavihek "Direktna sporočila" na uporabniških profilih, kar obiskovalcem omogoča pošiljanje neposrednih sporočil uporabniku.
Vendar lahko ta zavihek onemogočimo:
Run To lahko storimo tudi brez kode. Na strani za prilagajanje gradnika si oglejte odsek "Onemogoči neposredna sporočila".
Onemogoči sporočilo o uspehu
Privzeto FastComments prikaže sporočilo o uspehu po objavi komentarja. To lahko onemogočite na naslednji način:
Run To lahko storite tudi brez kode. Na strani za prilagajanje gradnika:
Spremeni oceno vsebine GIF-ov
Privzeto bo pripomoček za komentarje FastComments nastavil gif rating na pg.
Razpoložljive možnosti so g, pg, pg-13 in r.
To lahko nastavite v kodi ali prek uporabniškega vmesnika. V kodi to lahko storimo na naslednji način:
Run V uporabniškem vmesniku boste to našli pod Gif Picker Rating, dokler ni potrjeno Disable Image Uploads?.
Moderiranje vsebine slik
Privzeto ima pripomoček za komentarje FastComments moderiranje vsebine slik nastavljeno na off.
Razpoložljive možnosti so off, low, medium in high.
V uporabniškem vmesniku za prilagajanje pripomočka boste to našli pod Image Content Moderation Level, dokler ni označena možnost Disable Image Uploads?.
Spremeni način glasovanja
Privzeto bo FastComments prikazal možnosti glasovanja kot puščici za glasovanje gor in dol, kar uporabnikom omogoča, da komentar glasujejo gor ali dol.
Vendar je mogoče spremeniti stil orodne vrstice za glasovanje. Trenutne možnosti so privzeti gumbi Gor/Dol ali uporaba mehanizma glasovanja v slogu srca.
Za to uporabljamo zastavico voteStyle na naslednji način:
Run Močno priporočamo, da to storite brez kode, saj to omogoča tudi strežniške validacije. Na strani za prilagajanje gradnika si oglejte razdelek "Vote Style".
Glasovanje je mogoče tudi onemogočiti, glejte Disable Voting nad možnostmi sloga.
Onemogoči brisanje
Privzeto bo FastComments dovolil uporabnikom brisati svoje komentarje.
Vendar je mogoče to preprečiti.
Na strani za prilagajanje gradnika poiščite možnost "Onemogoči brisanje".
- To vpliva le na običajne komentatorje in ne na moderatorje ali skrbnike, ki bodo še vedno lahko brisali.
- To bo vplivalo tudi na API integracije, ko je poslan
contextUserId.
Onemogoči urejanje
Privzeto FastComments dovoljuje uporabnikom urejanje njihovih komentarjev.
Vendar je to mogoče preprečiti.
Na strani za prilagajanje gradnika 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, ko je poslan
contextUserId.
Poudarjanje 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 je mogoče prilagoditi v Widget Configuration UI v različnih velikostih, ki se gibljejo od 10 do 200.
Upoštevajte, da sprememba velikosti strani zahteva ponovno izračunavanje vseh nitkov komentarjev v vašem računu. To lahko traja nekaj minut.
Tega ni mogoče nastaviti v vtičniku na strani odjemalca, saj se strani izračunavajo na strežniku.
Primer konfiguracije je prikazan spodaj:
Velikosti strani je mogoče prilagoditi globalno, po domeni ali po strani, tako da ustvarite različna pravila prilagajanja.
To bo vplivalo na vse odjemalce, integracije in ogrodja, ki jih morda 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.
Oblike uporabniških imen
By default, FastComments will show the user's name as they entered it, or how it was passed to us via SSO.
However, it may be desirable to mask or show the user's name in a different way. For example, if the user's name is Allen Rex, maybe you want to only show "Allen R.".
This can be done without code in the Widget Customization UI, under the setting called Commenter Name Format:
The available formats are:
- Capitalize (display example user as Example User)
- Last Initial (display Example User as Example U.)
- All Initials (display Example User as E. U.)
- Show "Anonymous"
The effect of changing this is immediate. User's will still see their full username at the top of the comment area, for themselves, but their comments will show the modified username.
Usernames are masked server-side to protect users.
Onemogočanje nalaganja slik
Privzeto FastComments omogoča nalaganje slik. To lahko onemogočite tako, da nastavite zastavico noImageUploads na true.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika:
Dovoli vdelavo medijev
Privzeto FastComments ne dovoljuje iframe-ov v komentarjih. Ko omogočite vdelave medijev, lahko komentatorji prilepijo kodo vdelave (odsek <iframe>) od zaupanja vrednih ponudnikov, kot so YouTube, Vimeo, SoundCloud in Spotify, in ta se bo prikazala v vrstici v komentarju.
Zaradi varnosti to ni nastavitvena zastavica gradnika na strani odjemalca. Gre za nastavitev na strežniku, ki se preveri, ko se vsak komentar shrani, zato je ni mogoče vklopiti s strani. Dovoljeni so le iframe-ji, ki kažejo na vgrajen seznam zaupanja vrednih ponudnikov. Vsak drug iframe je odstranjen.
To je izvedeno brez kode, na strani za prilagajanje gradnika:
Dodajanje lastnih ponudnikov
Če želite dovoliti vdelave od ponudnika, ki ni na vgrajenem seznamu zaupanja vrednih, dodajte njegovo ime gostitelja v polje "Dodatna domena vdelav" na isti strani. Ta imena gostiteljev so dovoljena poleg vgrajenih ponudnikov. Ujemanje je natančno, zato vključite celotno ime gostitelja (na primer, player.example.com). Vse, kar ne navedete, ostane blokirano.
Tako običajno polje za komentar kot urejevalnik WYSIWYG podpirata lepljenje vdelave. V urejevalniku WYSIWYG je vdelava vstavljena kot odstranljiv blok.
Omogoči iskalno polje
Privzeto v pripomočku za komentarje ni prikazanega iskalnega polja.
Vendar ga lahko vklopimo tako, da nastavimo zastavico enableSearch na true:
Run To lahko storimo tudi brez kode. Na strani za prilagajanje pripomočka poiščite možnost "Enable Search Box".
Omogoči spoilerje
We can enable spoiler support by setting the enableSpoilers flag to true:
Run This can also be done without code. In the widget customization page, see the "Enable Spoilers" option.
When text is highlighted, and the now visible SPOILER button is clicked, text will be masked until the user mouses over it. For dark mode we do the same thing, with different
colors that better match dark mode.
This is also compatible with the WYSIWYG editor.
Omogoči prikaz števila ogledov komentarjev
Privzeto FastComments ne sledi, kdo je ogledal vsak komentar, niti ne ponuja statistike o tem.
Vendar pa lahko to funkcijo omogočimo, in sistem bo začel slediti, ko se uporabnik pomika do komentarja.
Ko se to zgodi, se poleg ikone očesa na vsakem komentarju poveča števec. Števec se posodablja v živo in je skrajšan glede na uporabnikovo lokalno nastavitev.
To lahko omogočimo tako, da nastavimo zastavico enableViewCounts na true:
Run To lahko prilagodite brez kode na strani za prilagajanje gradnika:
Sledimo ID-ju uporabnika*, ki je ogledal komentar, tako da se pri ponovnem ogledu komentarja števec ne poveča. Če komentar ponovno ogledate po dveh letih, se števec poveča.
- *Opomba: ali anonimni ID seje, ali uporabnikov IP kot zgoščena vrednost.
Prikaži komentarje v živo takoj
Privzeto je omogočeno živo komentiranje. To pomeni, da se bodo spremembe, kot so dodajanje, brisanje, urejanje ali pripenjanje komentarjev, prikazale vsem uporabnikom, ki si ogledajo nit komentarjev, hkrati.
Vendar se bodo ti novi komentarji privzeto pojavili pod dinamično prikazanim gumbom z besedilom, podobnim "Show 2 New Comments".
Če so novi komentarji odgovori neposredno na stran, se bo gumb prikazal na vrhu nite komentarjev. Če so odgovori na določen komentar, se bo gumb prikazal pod tem komentarjem.
To je zato, da se velikost strani ne spreminja nenehno za uporabnika, kar bi lahko povzročilo frustracije pri poskusu uporabe drsnika.
Za nekatere primere uporabe, kot so živa dražba ali spletni dogodki, to ni želeno vedenje – morda želite, da je pripomoček za komentiranje bolj podoben "chat" oknu, kjer se novi komentarji "prikažejo takoj".
Zato je ime zastavice, ki omogoča to funkcijo: showLiveRightAway.
To lahko vklopimo na naslednji način:
Run To je mogoče prilagoditi brez kode na strani za prilagajanje pripomočka:
Onemogočanje komentiranja v živo
Privzeto bo FastComments imel omogočeno živo komentiranje.
To pomeni, da naj bi vsak gledalec niti komentarjev videl enako vsebino.
Na primer, če je komentar dodan, se naj ta komentar prikaže. Če je komentar urejen ali odstranjen, potem bodo ti komentarji urejeni ali odstranjeni za vse gledalce niti. Enako velja za glasove in vse moderacijske akcije.
Vendar pa lahko to onemogočimo:
Run To je mogoče storiti tudi brez kode. Na strani za prilagajanje gradnika poiščite razdelek "Onemogoči živo komentiranje".
Postavljanje novih komentarjev v živo na dno
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 pomikanja
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 razvrstil komentarje po smeri razvrščanja "Najbolj relevantno".
Razvrščanje Najbolj relevantno upošteva čas, ko je bil komentar objavljen, in število glasov pri razvrščanju.
Uporabnik lahko nato spremeni smer razvrščanja na najstarejše ali najnovejše najprej v uporabniškem vmesniku pripomočka za komentarje.
Vendar lahko privzeto spremenimo v katerokoli od treh možnosti. Na primer, če želite prikazati najstarejše komentarje najprej:
Run Nastavimo vrednost defaultSortDirection na "OF", da nastavimo smer na "OF".
Za smer razvrščanja najnovejše najprej bi naredili naslednje:
Run Veljavne vrednosti za defaultSortDirection so:
- MR: "Najbolj nedavno"
- NF: "Najnovejše najprej"
- OF: "Najstarejše najprej"
To je mogoče storiti tudi brez kode. Na strani za prilagajanje pripomočka si oglejte razdelek "Privzeta smer razvrščanja".
Upoštevajte, da so komentarji na vsaki strani za vsako smer razvrščanja vnaprej izračunani, zato imajo vse smeri razvrščanja enako zmogljivost.
Prikaz vseh komentarjev naenkrat - onemogoči razdelitev na strani
Če želite onemogočiti straničenje in prikazati vse komentarje naenkrat, nastavite startingPage na -1.
Run Premik polja za odgovore pod komentarje
Privzeto je območje za vnos komentarja pred nitjo komentarjev. Vendar, z nastavitvijo tega konfiguracijskega parametra na true ga lahko premaknemo na za.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje gradnika:
Omejevanje 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.
Stvari, kot so URL-ji slik, niso vključeni v določanje dolžine.
Run To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika:
Onemogoči večvrstično komentiranje
Privzeto FastComments uporabniku omogoča vnos komentarja v poljubnem številu vrstic, do privzete omejitve znakov.
Vendar je včasih zaželeno omejiti uporabnika na vnos le ene vrstice besedila. Nekateri primeri uporabe vključujejo spletno dražbo ali klepet v živo, za kar se lahko uporabi FastComments.
Zastavico useSingleLineCommentInput omogočimo na naslednji način:
Run To je mogoče tudi brez kode. Na strani za prilagajanje gradnika poiščite odsek "Enable Single-Line Comment Input".
Upoštevajte, da so komentarji na vsaki strani za vsako smer sortiranja vnaprej izračunani, zato imajo vse smeri sortiranja enako zmogljivost.
Omeji število komentarjev na uporabnika
By default, each user can submit up to 5 comments in the same minute.
This is tracked by user id, anon user id, and ip address (hashed).
This can be customized without code, on the widget customization page:
Upoštevajte, da če uporabljate API za ustvarjanje komentarjev, boste morda želeli v zahtevo našemu strežniku poslati izvirni ip naslov uporabnika, da se omejitev hitrosti uporabi
po uporabniku in ne globalno za vaš račun.
Prepreči nove komentarje najvišjega nivoja
Č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]
Zahtevaj sprejem pogojev uporabe
FastComments vam omogoča, da od prvih komentatorjev zahtevate sprejem vaših pogojev uporabe, preden oddajo komentar.
Ko je omogočeno:
- Anonimni uporabniki bodo videli potrditveno polje TOS pri vsakem komentarju
- Avtenticirani uporabniki bodo videli potrditveno polje le pri njihovem prvem komentarju ali ko posodobite svoje TOS
Konfiguracija
Pojdite na stran za prilagajanje gradnika in omogočite potrditveno polje "Zahtevaj sprejem pogojev uporabe". Ko je omogočeno, boste videli naslednje možnosti:
- Način besedila TOS: Privzeto potrditveno polje prikazuje "Strinjam se s pogoji uporabe in pravilnikom o zasebnosti" z povezavami do obeh dokumentov. Izberite "Prilagodi besedilo po jezikih", da zagotovite svoje besedilo za vsak jezik.
- Datum zadnje posodobitve TOS: Ko posodobite svoje pogoje uporabe, nastavite ta datum. Uporabniki, ki so sprejeli pred tem datumom, bodo morali sprejeti ponovno.
Kako deluje
- Časovni žig sprejema TOS se shrani po uporabniku in po komentarju
- Ko uporabnik sprejme TOS, se datum zabeleži v njegovem uporabniškem profilu (po najemniku)
- Če nastavite datum "Zadnje posodobitve", ki je po datumu sprejema uporabnika, bo moral ponovno sprejeti
- Za anonimne uporabnike, ki jih ni mogoče slediti, se potrditveno polje pojavi pri vsaki oddaji komentarja
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 šifriranje HMAC-SHA256 kot mehanizem za izvedbo SSO. Najprej bomo pregledali splošno arhitekturo, dali primere in podrobne korake.
Obstaja tudi dokumentacija glede migracije iz drugih ponudnikov s podobnimi mehanizmi SSO in razlik.
Tok izgleda takole:
Ker Secure SSO vključuje razvoj polnega sklopa (full-stack), so delujoči primeri kode v Java/Spring, NodeJS/Express in navadnem PHP trenutno na GitHubu.
Čeprav v primeru NodeJS uporabljamo ExpressJS in v primeru Jave Spring, v teh okoljih za implementacijo FastComments SSO niso potrebne nobene posebne knjižnice — zadostujejo vgrajeni kriptografski paketi.
Ni vam treba pisati nobenih novih API endpointov za FastComments SSO. Preprosto šifrirajte uporabnikove podatke s svojim skrivnim ključem in pošljite uporabno obremenitev (payload) v komentarni vtičnik.
Pridobite svoj API skrivni ključ
Vaš API skrivni ključ lahko pridobite na tej strani. To stran lahko najdete tudi tako, da greste v Moj račun, kliknete ploščico API/SSO in nato kliknete "Get API Secret Key".
Parametri komentarnega vtičnika
Visokoravenjska API dokumentacija za komentarni vtičnik je na voljo tukaj.
Pojdimo bolj v podrobnosti, kaj ti parametri pomenijo.
Komentarni vtičnik sprejme 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 je treba generirati na strežniški strani.
- userDataJSONBase64: Podatki o uporabniku v formatu JSON, ki so nato Base64 kodirani.
- verificationHash: HMAC-SHA256 hash, ustvarjen iz UNIX_TIME_MILLIS + userDataJSONBase64.
- timestamp: Epohni čas v milisekundah. Ne sme biti v prihodnosti ali starejši od dveh dni.
- loginURL: URL, ki ga lahko komentarni vtičnik prikaže za prijavo uporabnika.
- logoutURL: URL, ki ga lahko komentarni vtičnik prikaže za odjavo uporabnika.
- loginCallback: Ko je zagotovljen namesto login URL, funkcija, ki jo bo komentarni vtičnik poklical ob kliku na gumb za prijavo.
- logoutCallback: Ko je zagotovljen namesto logout URL, funkcija, ki jo bo komentarni vtičnik poklical ob kliku na gumb za odjavo.
Objekt uporabnika
The User object contains the following schema:
Moderators and Administrators
Za skrbnike in moderatorje posredujte ustrezne zastavice isAdmin ali isModerator v objektu SSOUser.
Notifications
Če želite omogočiti ali onemogočiti obvestila, nastavite vrednost optedInNotifications na true ali false. Ob prvem nalaganju strani z to vrednostjo v SSO obremenitvi (payload) bodo njihove nastavitve obvestil posodobljene.
Poleg tega, če želite, da uporabniki prejemajo obvestilna e-sporočila za dejavnosti na straneh, na katere so naročeni (namesto le obvestil v aplikaciji), nastavite optedInSubscriptionNotifications na true.
VIP Users & Special Labels
Ob strani uporabnikovega imena lahko prikažete posebno oznako z uporabo izbirnega polja "displayLabel".
Unauthenticated users
Za predstavitev neavtoriziranega (neprijavljenega) uporabnika preprosto ne izpolnite userDataJSONBase64, verificationHash ali timestamp. Posredujte loginURL.
Ti uporabniki ne bodo mogli komentirati; namesto tega jim bo prikazano sporočilo za prijavo (sporočilo, povezava ali gumb, odvisno od konfiguracije).
Direct Examples for Serializing and Hashing User Data
Več podrobnosti in primerov je tukaj (js), tukaj (java) in tukaj (php).
Zavedamo se, da je kakršnakoli integracija lahko zapleten in naporen proces. Ne oklevajte in se obrnite na svojega predstavnika ali uporabite stran za podporo.
Prilagojene integracije - enostavna enotna prijava (SSO)
S Simple SSO lahko komentarni vtičnik oskrbimo z informacijami o uporabniku, tako da mu ni treba vnašati uporabniškega imena ali e-poštnega naslova za komentiranje.
Simple SSO lahko konfiguriramo takole:
Run Uporabnik bo prijavljen in bo v ozadju ustvarjen SSO uporabnik. Če je uporabnik pridobljen prek API-ja, bo imel createdFromSimpleSSO nastavljen na true.
Opombe:
- E-pošta je edinstveni identifikator za Simple SSO.
- Posredovanje e-poštnega naslova pri Simple SSO ni obvezno, vendar bodo njihovi komentarji privzeto prikazani kot "Nepreverjen". Če e-poštni naslov ni podan, uporabnika ni mogoče popolnoma overiti.
- NOVO Od januarja 2022: uporabniška imena ne morajo biti edinstvena na celotnem fastcomments.com
- Simple SSO lahko samodejno ustvari in posodobi SSO uporabnike, če je podan e-poštni naslov in če uporabnik ni bil prvotno ustvarjen z Secure SSO.
- Za uporabnika lahko določite značke z lastnostjo
badgeConfig. PoljebadgeIdsvsebuje ID-je globalnih značk, ki jih je treba povezati z uporabnikom. PoljepageBadgeIdsvsebuje ID-je značk omejene na trenutno stran (urlId) — te značke so prikazane samo na strani, kjer so bile dodeljene. Če jeoverridenastavljeno natrue, bo zamenjalo obstoječe prikazane značke (globalne in značke, omejene na stran, se prepišejo neodvisno); če jefalse, jih bo dodalo obstoječim značkam.
Prilagojene integracije - migracija iz 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 iz 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 niti komentarjev z enotno prijavo
FastComments SSO (podrobnosti tukaj) svojim uporabnikom omogoča način komentiranja, ne da bi se morali prijaviti v drugo platformo.
Vendar to samo ne zagotavlja varnosti vaših niti komentarjev, saj so podatki o komentarjih privzeto javno dostopni – kdorkoli, ki lahko vidi stran, lahko vidi tudi komentarje.
S spreminjanjem nastavitve lahko omejimo pridobivanje komentarjev, razen če to stori skrbnik ali veljaven SSO uporabnik.
Nastavitev brez kode
Ko je SSO nastavljen, lahko preprečimo ogled in interakcijo z našimi nitmi komentarjev, tako da ustvarimo pravilo prilagoditve.
Pri tem poiščite SSO in najdete to možnost:
Omogočite jo in shranite pravilo prilagoditve.
Zaščiti le določen domen ali stran
Če želite zaščititi le določen domen ali stran, preprosto nastavimo pravilo prilagoditve, da to omogoča.
Na vrhu uporabniškega vmesnika za prilagoditev bomo našli dva vnosa, Domen in URL ID.
Če želite zaščititi le določen domen, vnesite ta domen v polje "domain".
Če želite zaščititi določeno stran, vnesite URL strani v polje "URL ID". Če imate po meri integracijo s FastComments, lahko tukaj vnesete vrsto ID-ja namesto URL-ja.
Varnostne ravni
Ko zahtevate SSO, boste morali izbrati, ali potrebujete preprosto SSO ali varno SSO. Če izberete preprosto SSO, sta dovoljeni obe možnosti, vendar če izberete varno SSO, mora biti vsebina pridobljena z varnim SSO paketom, ki je zgoščen z vašim API ključem, da jo je mogoče ogledati.
Možnost varnostne ravni se bo pojavila, ko izberete "Zahtevaj SSO za ogled komentarjev".
Zaščita poleg branja
Omogočanje te možnosti bo zaščitilo stran ali domen pred komentiranjem, razen če je uporabnik prijavljen prek SSO.
Morebitne težave
Uporabniki, ki so ustvarili komentarje pred vašo SSO integracijo, jih ne bodo mogli videti, razen če se prijavijo prek vaše SSO integracije.
Dovoli anonimno komentiranje
By default, FastComments will require an email to comment. It does not have to be a valid email, however until the user clicks a link sent to them, their comment will display an "Unverified Comment" label.
Privzeto FastComments zahteva e‑naslov za komentiranje. Ni nujno, da je e‑naslov veljaven, vendar dokler uporabnik ne klikne povezave, ki mu je poslana, bo njegov komentar prikazan z oznako "Neoverjen komentar".
However, we can remove the email requirement. The email input field will still show, but it will no longer be required.
Vendar lahko odstranimo zahtevo po e‑naslovu. Vnosno polje za e‑naslov bo še vedno prikazano, vendar ne bo več obvezno.
This can be configured via the widget customization UI:
To lahko nastavite prek uporabniškega vmesnika za prilagajanje gradnika:
Preprečevanje poteka anonimnih komentarjev
FastComments je mogoče nastaviti, da odstrani nepreverjene komentarje po želenem številu dni. To pomaga v boju proti neželeni pošti.
Privzeto tega ne počne.
To je mogoče nastaviti ali onemogočiti prek strani Nastavitve moderiranja.
Onemogoči vnos e-pošte
Ko uporabniki komentirajo in niso prijavljeni, bodo pozvani, da vpišejo svoj e‑mail.
To bo ustvarilo “nepreverjeno sejo” za tega uporabnika, in jih bomo prosili, da to sejo preverijo prek e‑maila.
Za nekatere strani ali aplikacije je zaželeno, da uporabnika ne sprašujemo po e‑mailu pri komentiranju ali glasovanju.
Omogočanje anonimnih komentarjev naredi polje za vnos e‑maila neobvezno. Vendar ga lahko popolnoma onemogočimo. Najprej omogočite anonimne komentarje, nato se bo pojavila možnost onemogočanja polj za vnos e‑maila.
Ko je to omogočeno, polja za e‑mail ne bodo prikazana v nobenem od naših produktov za komentiranje.
Upoštevajte, da bodo pri tej nastavitvi vsi komentarji nepreverjeni, razen če uporabnik ustvari račun in se prijavi na https://fastcomments.com.
Morda boste želeli razmisliti o onemogočanju oznake nepreverjenega.
Onemogoči oznako 'nepreverjeno'
Privzeto bo FastComments prikazal oznako "Neoverjen komentar" za komentarje, ki so bili puščeni za uporabnika z neoverjeno sejo brskalnika. Preberite več o neoverjenih komentarjih here.
Run Ta funkcija se lahko uporablja tudi brez pisanja kode v uporabniškem vmesniku za prilagajanje:
Dovoli anonimno glasovanje
Ko uporabniki poskušajo glasovati o komentarju in niso prijavljeni, bodo pozvani, da vpišejo svoje uporabniško ime in e‑pošto.
To zahtevo lahko odstranimo, kar omogoča, da kdorkoli glasuje o komentarju, ne da bi pustil kakršnekoli podatke.
Nastavitev privzetega uporabniškega imena
Ko uporabniki komentirajo ali glasujejo, in niso prijavljeni, bodo pozvani, da vpišejo svoj e‑mail in uporabniško ime.
V primeru anonimnih komentarjev je včasih zaželeno določiti privzeto uporabniško ime, da se zmanjša trenje pri komentiranju. To je mogoče storiti prek vmesnika za prilagajanje. Anonimno komentiranje je najprej treba omogočiti.
Povratni klici
Vse knjižnice za komentarni vtičnik (trenutno Angular, React, Vue) podpirajo povratne klice.
Povratni klici so določeni v konfiguracijskem objektu, z istimi podpisi za vsako knjižnico.
Podprti povratni klici so:
- onInit
- onAuthenticationChange
- onRender
- commentCountUpdated
- onReplySuccess
- onVoteSuccess
- onImageClicked
- onOpenProfile
- onCommentSubmitStart
- onCommentsRendered
Natančne podpise najdete v TypeScript definicije.
Tukaj je primer z vsemi uporabljenimi povratnimi klici:
Run Ročno določanje jezika uporabnika
Privzeto bo FastComments prikazal pripomoček za komentarje v lokalizaciji, ki jo določi uporabnikov sistem in brskalnik.
Ko uporabnik komentira ali se prijavi, posodobimo njegovo zadnjo uporabljeno lokalizacijo in jo uporabimo tudi za pošiljanje e-pošte.
To vpliva na to, kako je pripomoček za komentarje preveden za uporabnika. Lokalizacija sestavlja uporabnikov jezik in regija, zato bo nastavitev lokalizacije običajno spremenila jezik, ki se uporablja za prikaz besedila uporabniku.
Preko uporabniškega vmesnika
To je mogoče določiti prek uporabniškega vmesnika za prilagajanje pripomočka. Oglejte si možnost "Lokalizacija / Jezik":
Preko kode
To je mogoče preglasiti z želeno lokalizacijo.
Run Podprti jeziki in kode lokalizacije
Tukaj lahko najdete popoln seznam podprtih jezikov in ustreznih kod lokalizacije.
Opomba o SSO
Če uporabljate SSO, boste morda želeli v uporabniškem objektu posredovati uporabnikovo lokalizacijo, da bodo e-poštna sporočila in druge stvari pravilno lokalizirane zanj.
Omejevanje dovoljenih jezikov
Privzeto FastComments ne omejuje jezikov, ki se uporabljajo za komentarje.
Morda je zaželeno omejiti jezike, ki jih skupnost uporablja.
To je mogoče nastaviti brez kode na strani za prilagajanje gradnika:
Sistem bo prebral njihov komentar, določil njegov jezik in ga nato 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 glasovanje
Komentiranje je mogoče zakleniti, tako da z nastavitvijo zastavice readonly na true ne morejo biti objavljeni novi komentarji ali glasovi.
Komentarji tudi ne bodo mogli biti urejani ali izbrisani.
Run To je mogoče prilagoditi brez kode, na strani za prilagajanje gradnika, za celotno domeno ali stran:
Posodobitev!
Od novembra 2022 je mogoče niti zakleniti ali odkleniti v živo s strani skrbnikov in moderatorjev prek menija s tremi pikami nad območjem odgovora.
To bo preprečilo nove komentarje, hkrati pa bo še vedno omogočalo glasovanje in omogočalo uporabnikom, da po želji izbrišejo svoje komentarje, medtem ko readonly teh stvari ne dovoljuje.
To ustreza polju isClosed v API-ju Page.
Omejevanje domen povezav
Privzeto FastComments omogoča povezovanje na katerokoli zunanjo stran.
To je mogoče omejiti na želeni seznam strani ali domen. Poskus objave povezave na stran ali domeno, ki ni v določenem seznamu, bo povzročil prikaz napake uporabniku.
Ta preverjanje velja le za pripomoček za komentarje in API. Uvozi niso prizadeti.
To je izvedeno brez kode, na strani za prilagajanje pripomočka:
Število komentarjev in štetje vseh vnorenih 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 FastComments zahteva od uporabnika le njihov komentar, uporabniško ime in e‑pošto.
Vendar pa v nekaterih situacijah morda želite, da uporabnik pusti povezavo do svojega bloga ali spletnega mesta.
Lahko omogočimo prikaz dodatnega vnosnega polja za vnos URL-ja spletnega mesta uporabnika, tako da nastavimo zastavico enableCommenterLinks na true:
Run Ko je URL naveden, se bo uporabniški račun posodobil in vse njihove uporabniške ime na vseh preteklih in prihodnjih komentarjih bo povezano s tem URL-jem.
To je mogoče prilagoditi brez kode na strani za prilagajanje gradnika:
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 ID-ji skupin za omembe
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 avtentikacijo FastComments zahteva, da so v vašem brskalniku omogočeni piškotki tretjih oseb. Brez njih bodo uporabniki vedno morali pustiti svoj e‑mail, da komentirajo (razen če je polje za e‑mail skrito), in njihovi komentarji bodo privzeto prikazani kot neverificirani.
Da to zaobidete, lahko omogočite zaobidenje piškotkov tretjih oseb.
Ko je ta nastavitev omogočena, bo povzročila majhno pojavno okno, ki prikaže sporočilo, da je uporabnik prijavljen. To pojavno okno se prikaže vsakič, ko uporabnik sodeluje z gradnikom za komentarje; na primer, če pusti komentar.
To lahko storimo v kodi tako, da nastavimo zastavico enableThirdPartyCookieBypass na true:
Run To lahko nastavite tudi prek uporabniškega vmesnika za prilagajanje gradnika, pod Enable Third-Party Cookie Popup:
Brisanje komentarjev z odgovori
Privzeto lahko uporabniki izbrišejo svoje komentarje. Prav tako brisanje njihovega komentarja samodejno izbriše vse podkomentare in prehodne komentarje v nitki. To vedenje je tudi aktivno.
To lahko omejite na naslednje načine:
- Namesto tega anonimizirajte izbrisan komentar (nastavite ime in besedilo na
[deleted]ali na poljubno vrednost). - Ne dovolite brisanja komentarjev, ko so odgovori. Prikaže se prilagodljivo sporočilo o napaki.
- Omejite brisanje, ko ima komentar odgovore, le na skrbnike in moderatorje.
To lahko konfigurirate prek razdelka Comment Thread Deletion v uporabniškem vmesniku prilagajanja gradnika.
Prikaži značke v zgornji vrstici
Privzeto bo FastComments prikazal uporabniške značke le na njihovih komentarjih znotraj niza komentarjev.
Vendar lahko uporabniške značke prikažemo poleg njihovega imena nad obrazcem za komentar tako, da omogočimo to funkcijo na strani za prilagajanje gradnika:
To bo prikazalo uporabniške značke poleg njihovega imena v območju zgornje vrstice, kar bo njihove dosežke in status naredilo bolj opazen, ko pišejo 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 nastavite zastavico showBadgesInTopBar na false, da jo izberete onemogočite, tudi če je na strežniku vklopljena:
Run Prikaži seznam prisotnih uporabnikov
Privzeto FastComments ne prikazuje seznama uporabnikov na strani.
Lahko prikažete seznam ljudi, ki trenutno gledajo stran, poleg pripomočka za komentarje. Seznam se v živo posodablja, ko se uporabniki pridružijo ali odidejo, in prikazuje njihovo ime, avatar ter indikator, da so online.
Obstajajo tri možnosti postavitve:
1- Zgoraj: vodoravna vrstica prekrivajočih se avatarjev, prikazana nad komentarji.2- Levo: stranska vrstica z imeni in točkami, ki označujejo online stanje, prikazana levo od pripomočka.3- Desno: ista stranska vrstica, prikazana desno od pripomočka.
Nastavite zastavico usersListLocation, da omogočite funkcijo:
Run Privzeto seznam prikazuje le uporabnike, ki so trenutno online. Če želite vključiti tudi ljudi, ki so v preteklosti komentirali stran (a je trenutno ne gledajo), nastavite usersListIncludeOffline na true:
Run Pretekli komentatorji so prikazani brez zelenega online pika, da je jasno, kdo je trenutno prisoten.
Uporabniki z zasebnimi profili so prikazani z generičnim avatarjem in oznako "Zasebni profil", tako da je število natančno, ne da bi razkrili identitete.
To lahko nastavite tudi brez kode. Na strani za prilagajanje pripomočka poiščite možnost "Lokacija seznama uporabnikov". Ko je lokacija nastavljena na karkoli drugega kot Izklopljeno, se pod njo prikaže potrditveno polje "Vključi pretekle komentatorje".
Pri več kot 500 živih uporabnikih je seznam lahko zakasnel do 30 sekund.