Silverstripe CMS:n lisäosat

Tiivistelmä

Silverstripe CMS:n lisäosilla voidaan laajentaa verkkosivuston toimintoja. Sivustolle voidaan tuoda esimerkiksi lomakkeita, sisältölohkoja tai muita ylläpitoa helpottavia ominaisuuksia. Silverstripen yhteydessä…

Aloittelijalle tärkein lähtökohta on ymmärtää, että moduulin asentaminen ja sen käyttäminen ovat eri tehtäviä. Sisällöntuottaja voi rakentaa lomakkeita hallintapaneelissa, mutta lomaketoiminnon tekninen käyttöönotto kuuluu yleensä sivuston kehittäjälle tai tekniselle ylläpitäjälle.

Hyvin valittu lisäosa ratkaisee selkeän tarpeen ja sopii sivuston muuhun toteutukseen. Ennen asentamista kannattaa selvittää, mitä ominaisuuksia sivustolla jo on, mitä uutta tarvitaan ja kuka huolehtii ratkaisusta myöhemmin.

Mitä lisäosa tarkoittaa Silverstripessä?

Moduuli on ohjelmistopaketti, joka tuo Silverstripeen toimintoja tai muuttaa olemassa olevaa toimintaa. Myös Silverstripen oma kokonaisuus rakentuu moduuleista, joten ne ovat olennainen osa järjestelmän rakennetta. Silverstripen moduulien esittely

Lisäosa voi näkyä käyttäjälle uutena sivutyyppinä, hallintapaneelin osiona tai muokkauskenttänä. Kaikki moduulit eivät kuitenkaan lisää näkyvää painiketta. Osa hoitaa taustalla esimerkiksi integraatioita tai teknisiä tehtäviä.

Tämä selittää, miksi kahden Silverstripe-sivuston hallintapaneelit voivat näyttää erilaisilta. Niihin on voitu asentaa eri moduuleja ja toteuttaa erilaisia mukautuksia.

Älä siis oleta, että verkossa näkemäsi ominaisuus löytyy automaattisesti omasta asennuksestasi. Tarkista ensin sivuston dokumentaatio tai kysy toteuttajalta, mitä toimintoja ympäristöön kuuluu.

Aloita tarpeesta, älä lisäosaluettelosta

Lisäosan etsiminen on helpompaa, kun osaat kuvata ratkaistavan ongelman. Pelkkä toive monipuolisemmasta sivustosta ei vielä kerro, millaista työkalua tarvitaan.

Esimerkiksi yhteydenottolomakkeen kohdalla kannattaa miettiä:

Mitä tietoja kävijältä pyydetään?
Kenelle viesti toimitetaan?
Tarvitaanko tiedostoliitteitä?
Pitääkö lähetykset nähdä hallintapaneelissa?
Kuka käsittelee saapuneet yhteydenotot?

Näistä muodostuu konkreettinen vaatimuslista. Sen avulla voidaan arvioida, riittääkö nykyinen toteutus vai tarvitaanko uusi moduuli.

Joskus puuttuva ominaisuus on jo asennettu mutta ei käytössä kyseisellä sivulla. Toisinaan pieni muutos olemassa olevaan sivutyyppiin ratkaisee tarpeen ilman uutta riippuvuutta. Selvitä nykyiset mahdollisuudet ennen laajentamista.

Lomakkeet ovat tavallinen lisäosien käyttökohde

UserForms on Silverstripen moduuli, jonka avulla sisällöntuottajat voivat rakentaa lomakkeita hallintapaneelissa. Se täytyy olla asennettuna, jotta kyseinen toiminto on käytettävissä. Moduuli tallentaa lähetyksiä oletusarvoisesti myös tietokantaan. Silverstripen UserForms-ohje

Lomakkeen rakentaminen ei pääty kenttien lisäämiseen. Käytännössä on päätettävä myös vastaanottajat, pakolliset tiedot ja onnistuneen lähetyksen jälkeen näytettävä viesti.

Kokeile lomaketta itse ennen julkaisua. Lähetä testiviesti, tarkista sen saapuminen ja varmista, että käyttäjä ymmärtää lähetyksen onnistuneen.

Kerää vain käsittelyssä tarvittavat tiedot. Jos puhelinnumeroa ei käytetä, sen vaatiminen voi hankaloittaa yhteydenottoa turhaan. Sovi samalla, kuka seuraa tallennettuja lähetyksiä ja huolehtii niiden poistamisesta tarpeen päättyessä.

Sisältölohkot tuovat joustavuutta sivujen rakentamiseen

Elemental-moduuli mahdollistaa sivun sisällön jakamisen erillisiin lohkoihin. Tekstiä, kuvia ja muita sisältöosia voidaan hallita pienempinä kokonaisuuksina yhden pitkän tekstikentän sijasta. Silverstripen sisältölohkojen esittely

Lohkot voivat helpottaa esimerkiksi palvelusivujen rakentamista. Sivulle voidaan koota esittely, kuvaosio ja yhteydenottoon ohjaava sisältö sivustolle toteutetuista vaihtoehdoista.

Pelkkä moduulin asentaminen ei kuitenkaan tarkoita, että kaikki toivotut lohkot ja ulkoasut olisivat valmiina. Kehittäjän täytyy määrittää, missä lohkoja käytetään ja miten ne sopivat sivuston toteutukseen. Elementalin käyttöönotto-ohje

Sisällöntuottajan kannattaa pyytää esimerkkisivu, jossa sallitut lohkot on esitelty. Näin niiden käyttötarkoitus on helpompi ymmärtää kuin pelkän nimiluettelon perusteella.

Mistä Silverstripen lisäosia etsitään?

Silverstripen moduuleja löytyy esimerkiksi Packagist-pakettihakemistosta. Moduulien lähdekoodi, käyttöohjeet ja ilmoitetut ongelmat sijaitsevat usein GitHubissa. Silverstripen dokumentaatio ohjaa käyttämään Composeria pakettien hallintaan. Silverstripen Composer-ohje

Hakutulos on vasta lähtöpiste arvioinnille. Lue moduulin oma dokumentaatio ja varmista, että se käsittelee juuri tarvitsemaasi toimintoa.

Kiinnitä huomiota erityisesti seuraaviin asioihin:

tuetut Silverstripe- ja PHP-versiot
asennus- ja käyttöönotto-ohjeet
julkaistut versiot ja muutostiedot
tunnetut ongelmat
ylläpidon ja tuen saatavuus
lisenssi sekä mahdolliset ulkoiset palvelut.

Suuri latausmäärä ei yksin osoita sopivuutta. Vastaavasti harva julkaisutahti ei automaattisesti tarkoita hylättyä projektia. Arvioi dokumentaatiota, yhteensopivuutta ja ylläpidon tilannetta yhdessä.

Yhteensopivuus ratkaisee enemmän kuin lisäosan nimi

Saman moduulin eri versiot voivat olla tarkoitettuja eri Silverstripe-versioille. Myös PHP-versio ja muut asennetut paketit vaikuttavat siihen, mikä yhdistelmä voidaan ottaa käyttöön.

Composer käsittelee pakettien ilmoittamia riippuvuuksia ja versiorajoja. Se auttaa löytämään asennettavan yhdistelmän, mutta onnistunut asennus ei vielä todista sivuston kaikkien toimintojen toimivuutta. Moduulien asentaminen Composerilla

Esimerkiksi sivuston oma lomakemukautus saattaa tarvita muutoksia, vaikka moduulin riippuvuudet täyttyisivät.

Jos asentaminen pysähtyy yhteensopivuusvirheeseen, selvitä syy. Vaatimusten ohittaminen ei tee ohjelmistosta yhteensopivaa.

Aloittelijan kannattaa toimittaa ylläpitäjälle moduulin nimi ja käyttötarve. Tekninen arvio voidaan sen jälkeen tehdä oikean sivuston versiota ja toteutusta vasten.

Asennus on yleensä teknisen ylläpidon tehtävä

Silverstripen moduuleja asennetaan tavallisesti komentoriviltä Composerilla. Kyse ei yleensä ole hallintapaneelin lisäosakaupasta, jossa sisällöntuottaja painaa asennuspainiketta.

Pakettien lisäämisen jälkeen voidaan tarvita asetuksia, tietokantarakenteen päivitystä ja mallipohjien muokkaamista. Tarkat vaiheet riippuvat moduulista.

Sisällöntuottajan kannalta hyödyllinen työnjako on selkeä: hän määrittelee tarpeen ja kokeilee toiminnon käytettävyyttä, kun taas kehittäjä vastaa teknisestä käyttöönotosta.

Pyydä asennuksen yhteydessä lyhyt käyttöohje. Siinä pitäisi kertoa, mistä toiminto löytyy, mitä kenttiä täytetään ja miten valmis sisältö julkaistaan.

Sovi myös, kuuluuko ylläpito nykyiseen palveluun vai erilliseen työhön. Näin uuden ominaisuuden vastuut ovat tiedossa jo ennen käyttöönottoa.

Testaa toiminto osana omaa sivustoasi

Kokeile uutta moduulia ensin testiympäristössä, joka vastaa riittävän hyvin varsinaista sivustoa. Tarkoituksena on varmistaa sekä uusi toiminto että sen vaikutus nykyisiin ominaisuuksiin.

Lomakemoduulin kohdalla testiin kuuluvat esimerkiksi lähetys, virheilmoitukset ja viestin vastaanottaminen. Sisältölohkoissa tarkistetaan muokkaaminen, järjestys, julkaiseminen ja ulkoasu.

Käy läpi myös tavalliset ylläpitotehtävät:

Luo uusi sisältö.
Tallenna se luonnokseksi.
Muokkaa tallennettua sisältöä.
Esikatsele ja julkaise.
Tarkista sivu puhelimella.
Kokeile käyttöä tavallisen sisällöntuottajan oikeuksilla.

Kirjaa havaitut ongelmat täsmällisesti. Kuvaus siitä, mitä teit ja mitä tapahtui, auttaa korjaamisessa enemmän kuin yleinen ilmoitus toimimattomuudesta.

Huolehdi päivityksistä ja palautusmahdollisuudesta

Lisäosa tuo sivustolle myös ylläpitovastuun. Sen päivityksiä ja yhteensopivuutta täytyy seurata samalla tavalla kuin muuta ohjelmistoa.

Ennen muutoksia tarvitaan ajantasainen varmuuskopio sekä tieto siitä, miten aiempi toimiva kokonaisuus palautetaan. Tietokanta, tiedostot ja ohjelmistoversiot voivat kaikki olla olennaisia palautuksessa.

Tuotantoon kannattaa siirtää testattu pakettikokonaisuus. Silverstripen ohjeessa tähän käytetään Composerin lukitustiedostoa, joka määrittää asennettavat versiot. Silverstripen ohje Composer-julkaisuun

Päivityksen jälkeen tarkista tärkeimmät toiminnot uudelleen. Muuttunut hallintanäkymä tai lomakekenttä voi vaikuttaa päivittäiseen työhön, vaikka sivusto muuten avautuisi normaalisti.

Pidä myös käyttöohjeet ajan tasalla, jos toimintatapa muuttuu.

Poista tarpeettomat lisäosat suunnitellusti

Lisäosaa ei kannata poistaa pelkästään siksi, ettei sen nimeä tunnisteta. Se saattaa tukea käytössä olevaa sivutyyppiä tai toisen moduulin toimintaa.

Selvitä ensin, missä lisäosaa käytetään ja mitä tietoja siihen liittyy. Suunnittele tarvittavan sisällön siirtäminen ja varmista, etteivät lomakkeet, listaukset tai sivut jää toimimattomiksi.

Hyvä ylläpitokäytäntö on pitää lyhyt luettelo lisäosista, niiden tarkoituksesta ja vastuuhenkilöstä. Dokumentointi helpottaa sekä päivityksiä että tulevia muutoksia.

Valitse lisäosia todelliseen tarpeeseen ja arvioi niiden hyötyä käytössä. Sopiva moduuli tekee sisällöntuotannosta helpompaa, kun sen käyttötarkoitus, toimintatapa ja ylläpito ovat kaikille selvät.

Liittyvät kategoriat

Artikkeleita 2 007 artikkelia IT 1 930 artikkelia Kotisivut 1 184 artikkelia Nettisivut 1 185 artikkelia Silverstripe CMS 18 artikkelia Verkkokehitys 1 238 artikkelia Verkkosivut 1 384 artikkelia Verkkotyökalu 1 150 artikkelia