Udvikling

Lokale moduler til DPL-CMS udvikles på samme måde som almindelige Drupal moduler med følgende undtagelser

  • kan ikke installeres med Composer
  • da man ikke kan installere med Composer, skal evt. php pakker lægges i selve modulet
  • det er ikke muligt at slette filer, som man allerede har uploadet - kun overskrive dem
  • konfigurationsfiler skal indlæses med en service

Installation

Lokalt udviklede moduler installeres på samme måde som contrib-moduler. Læs mere om installation og opdatering af moduler.

Konfiguration

På grund af den måde DPL-CMS deployes på, skal konfigurationsfiler indlæses på en særlig måde.

Det er grundigt beskrevet på: https://danskernesdigitalebibliotek.github.io/dpl-docs/DPL-CMS/webmaster-modules/#initial-configuration

Udover det der står i dokumentationen, skal man lave en MODULNAVN.services.yml fil, som også kan ses i kdb_brugbyen eksemplet.

Den særlige måde at skrive konfiguration sikrer, at den både indlæses, når man indlæser modulet og stadig er på sitet efter det er opdateret.

Når man skal installere et module med konfiguration i det lokale udviklingsmiljø, skal man huske at slå config ignore til.

$config['config_ignore_auto.settings']['status'] = TRUE;

Og derefter teste om konfiguration stadig findes efter et deploy.

task dev:cli -- drush deploy

Eksempler fra Odense

Eksempler på forskellige typer af lokale moduler. Modulerne er fungerende og inkluderet for at illustrere forskellige udviklingsstrategier og muligheder.

1. Personaleoversigt: Modul med både konfiguration og CSS

Moduler der importerer konfigurationen for et view, en indholdstype, 3 taksonomier, et tekstformat, et billedformat og tilføjer noget CSS.

https://github.com/odensebibliotekerne/webmaster_local_staff

Der er ikke lavet demo indhold.

2. Snevejr: Asset Injector kode som modul

Eksemple på et modul, som indlæser JS/CSS i stedet for at gøre det i asset injector. Fordelen er at koden er versioneret og det gør det nemmere at udvikle.

Ulempen er, at når man har uploadet kan man kun overskrive, ikke slette filer igen.

https://github.com/odensebibliotekerne/webmaster_local_snow

3. Serie / univers: Javascript

Et eksempel på et modul, som danner en side på samme måde som DPL React, bare med Svelte istedet for.

https://github.com/odensebibliotekerne/webmaster_local_series

4. PDF generering: Modul med php pakker

Da man ikke kan installere moduler med composer, kan man ikke hente pakker til f.eks. PDF- eller CSV-generering. Det samme er tilfældet for contrib-moduler. Det er ikke best practice at inludere moduler på denne måde pga. opdatering af pakkerne.

Et eksempel på, hvordan man kan inkludere php pakker fra f.eks. Packagist direkte i lokale moduler kan hentes her: https://github.com/odensebibliotekerne/example_local_package

Modulet danner en PDF udfra en simpel HTML streng. En anden anvendelsesmulighed kunne være at danne en PDF udfra arrangementerne på DPL-CMS, som kan printes til/hentes af brugerne af biblioteket.