Installera Wagtail-integrationen – Mediaflow Kunskapsbank

Konfigurera Wagtail och Mediaflow

Integrationen mellan Mediaflow och Wagtail möjliggör publicering av bilder och filmer som finns i Mediaflow direkt i Wagtails gränssnitt. Ett fantastiskt sätt för webbredaktörer att alltid ha tillgång till filer som är GDPR-säkra, har rätt alt-texter och filmer som är tillgänglighetsanpassade.

Inställningar i Mediaflow

Integrationen till Wagtail kan börja användas så snart den installerats. Men för att filerna ska vara tillgängliga och kunna användas optimalt behöver administratörerna ha förberett inställningarna för dem i Mediaflow först.

Att installera Wagtails plugin

För att få möjligheten att infoga bild och video från Mediaflow i Wagtail så behöver man installera två olika plugin; ett för bilder och ett för video. Vi rekommenderar att installera båda eftersom de är tänkta att samarbeta och om man inte har behov av att infoga video så kan man via rättigheter i Wagtail dölja möjligheten att infoga video.

De två pluginen finns att tillgå på följande adresser:

Bilder: https://pypi.org/project/mediaflowimage/
Video: https://pypi.org/project/mediaflowvideo/

Att installera Mediaflows plugin för bilder

Det är är lättast att använda pakethanteraren PIP för att göra installationen, och i ditt terminalprogram skriver du då

pip install mediaflowimage

Redigera webbplatsens inställningsfil

Lägg till "mediaflowimage" i arrayen INSTALLED_APPS
Tala om för Wagtail att använda ett anpassat bildformulär

WAGTAILIMAGES_IMAGE_FORM_BASE = 'mediaflowimage.forms.MediaflowImageForm'

Lägg till API-nycklar för pluginet (kontakta Mediaflows support för att få API-nycklar om du inte redan har fått dem)

MEDIAFLOW_CLIENT_ID = <CLIENT ID>
MEDIAFLOW_CLIENT_SECRET = <CLIENT SECRET>
MEDIAFLOW_SERVER_KEY = <REFRESH TOKEN / SERVERKEY>

Anpassade bildmodeller

Bildpluginet fungerar direkt med Wagtails standardbildmodell, men om du vill mappa Mediaflow-bildens metadataegenskaper till Wagtail-bilder behöver du använda en anpassad bildmodell. En anpassad bildmodell krävs också om du vill logga användning av filer i Mediaflow.

Fälten i din bildmodell kan mappas så att de automatiskt fylls i när du infogar (laddar upp) en bild från Mediaflow. Detta görs genom att definiera en mappning i din inställningsfil så här:

MEDIAFLOW_META_MAPPING  = {
    "photographer": "mf_photographer",
    "description": "mf_description",
    "id" : "mf_mediaflow_id"
}

Nycklarna i objektet i detta exempel refererar till Mediaflow-fälten och varje motsvarande värde refererar till ett fältnamn i din bildmodell. I exemplet ovan mappas Mediaflow-fältet photographer till fältet mf_photographer i din bildmodell.

Om du behöver rapportering av bildanvändning måste MEDIAFLOW_META_MAPPING ha en nyckel-id som är mappad till ett fält i din bildmodell ("mf_mediaflow_id" i exemplet). Dessutom måste din bildmodell ha en anpassad återgivningsmodell som lägger till attributet data-mf-image-id på alla återgivna bilder.

Ett exempel på en anpassad bildklass som har ett Mediaflow Id-fält och en anpassad återgivning visas nedan. Bildmodellens fältnamn motsvarar fältnamnen som anges i inställningen MEDIAFLOW_META_MAPPING ovan:

from django.conf import settings
from django.db import models
from django.utils.functional import cached_property
from wagtail.images.models import AbstractImage, AbstractRendition, Image

class MyImage(AbstractImage):

    # Lägg till extra fält till bilden här
    # För att lägga till ett bildtextfält:
    photographer = models.CharField(max_length=255, blank=True)
    description = models.CharField(max_length=255, blank=True)
    mediaflow_id = models.IntegerField(blank=True, default=0)
    admin_form_fields = Image.admin_form_fields + (

        # Lägg sedan till fältnamnen här för att få dem att visas i formuläret:
        "description",
        "photographer",
        "mediaflow_id",
    )

class CustomRendition(AbstractRendition):

    image = models.ForeignKey(
        MyImage, on_delete=models.CASCADE, related_name="renditions"
    )

    @cached_property
    def getIdField(self):

        meta_mapping = getattr(settings, "MEDIAFLOW_META_MAPPING", "")
        for key in meta_mapping:
            if key == "id":
                return getattr(self.image, meta_mapping[key])
        return 0

    @property

    def attrs_dict(self):
        attrs = super().attrs_dict
        idField = self.getIdField

        if idField > 0:
            attrs["data-mf-image-id"] = idField
        return attrs

    class Meta:
        unique_together = (("image", "filter_spec", "focal_point_key"),)

Att installera Mediaflows plugin för video

Det är är lättast att använda pakethanteraren PIP för att göra installationen, och i ditt terminalprogram skriver du då

pip install mediaflowvideo

Redigera webbplatsens inställningsfil

Redigera inställningsfilen ([mysite]/settings/base.py):

1. Lägg till “mediaflowvideo” i listan INSTALLED_APPS (nära början av filen).

2. Lägg till “mf-video” i funktionslistan för Draftail Rich Text Editor.

WAGTAILADMIN_RICH_TEXT_EDITORS = {
	'default': {
		'WIDGET': 'wagtail.admin.rich_text.DraftailRichTextArea',
		'OPTIONS': {
			'features': ['mf-video' .....]
		}
	}
}

Lägg till API-nycklar för pluginet (kontakta Mediaflows support för att få API-nycklar om du inte redan har fått dem)

MEDIAFLOW_CLIENT_ID = <CLIENT ID>
MEDIAFLOW_CLIENT_SECRET = <CLIENT SECRET>
MEDIAFLOW_SERVER_KEY = <REFRESH TOKEN / SERVERKEY>