WPML addon

De WPML addon werkt met al onze Makelaar plugins én de Autobedrijf Voertuigen plugin. Deze addon zorgt er voor dat de data die binnenkomt vanuit jouw CRM vertaalt kan worden naar de door jou ingestelde talen.

Introductie

Welkom bij de documentatie voor onze WPML addon. De WPML addon zorgt er voor dat data uit jouw CRM vertaald kan worden middels WPML. De addon is van zichzelf Plug & Play echter vergt het in ieder geval nog wel wat aandacht bij het instellen van WPML zelf, maar mogelijk ook aanpassingen aan je actieve child-thema.


Features


Installatie

Installeer de plugin door de ontvangen plugin naar /wp-content/plugins/ te uploaden. Activeer de plugin vervolgens vanuit de WordPress admin.

Plugin updates worden beschikbaar gesteld via de WordPress plugin pagina.

Vereisten

Licentie

Bij de aanschaf van de plugin heb je een licentiecode gekregen. Het is van belang dat deze wordt ingevoerd om de plugin zonder restricties te laten werken en om plugin updates te kunnen ontvangen.

Instellingen

Alle instellingen van de plugin worden opgeslagen in de WordPress opties tabel.


Tussendoor B.V.
Sixmastraat 66-B
8932 PA Leeuwarden

e. info@tussendoor.nl
w. http://www.tussendoor.nl

Addon Instellingen

Deze sectie van de documentatie is bedoeld voor het gebruik van de plugin vanuit de WordPress omgeving met de focus op ons eigen dashboard.

Dashboard

Het dashboard dient als centrale beginpunt van de plugin. Binnen het dashboard heb je een beknopt overzicht van je installatie:

Standaard taal

In plaats van er vanuit te gaan dat de taal van de waardes die we ontvangen van het CRM altijd Nederlands is hebben we een dropdown geïntroduceerd waarmee je zelf kan bepalen wat de standaard taal van de objecten is.

We selecteren standaard de taal waarin het laatst bijgewerkte object is opgeslagen binnen WPML.

Modules

In het dashboard van de addon heb je de mogelijkheid om tussen verschillende tabbladen te navigeren. "Dashboard" is daar één van, maar daarnaast maken we ook tabbladen voor alle modules die actief zijn binnen de hoofd plugin. Wanneer de hoofdplugin een Makelaars plugin is kunnen dit bijvoorbeeld "Wonen", "Bedrijven" of "Nieuwbouw" zijn. Wanneer de hoofdplugin de Autobedrijf Voertuigen plugin is dan heb je toegang tot het tabblad "Voertuigen".

Module instellingen

Binnen de instellingen van een module vind je een lijst aan velden. Met een checkbox zorg je er voor dat zodra dit veld verwerkt wordt door de hoofdplugin dat deze vertaalbaar / beschikbaar wordt binnen WPML.

Verwerking houdt in dat de waarde nieuw binnen moet komen via het bijwerkproces óf op de frontend uitgelezen wordt. Het kan dus helpen om de frontend van de website eens te bezoeken zodat zoveel mogelijk velden uitgelezen worden.

WPML instellingen

Na de installatie van de plugin zijn een aantal instellingen van de WPML addon belangrijk om te controleren. We leggen ze hier uit.

We gaan er in de documentatie vanuit dat het bekend is hoe WordPress vertaald moet worden met WPML. Hieronder staan enkel belangrijke instellingen om onze hoofdplugin vertaalbaar op te zetten na het installeren van onze addon.

Vertaling berichttypes

WordPress -> Wpml -> Instellingen > Scroll naar "Vertaling berichttypes".

Ga op zoek naar de berichttypes van de hoofdplugin. Voor de "Makelaars plugin geschikt voor Realworks" zijn dit bijvoorbeeld "realworks_wonen" en "realworks_bog. Voor de "Autobedrijf Voertuigen plugin" is dit "autobedrijf_voertuig".

Het is belangrijk dat de berichttypes voor de hoofdplugin staan ingesteld op de middelste optie die WPML beschikbaar stelt: "Vertaalbaar - gebruik vertaling indien beschikbaar of herstel de standaard taal"

Talen van domeinen

WordPress -> Wpml -> Stringvertaling.

Het kan zijn dat WPML de brontaal van het domein dat onze addon beschikbaar maakt niet gelijk heeft staan aan de standaard taal die je hebt ingesteld in de instellingen van onze addon. Dit kan je binnen de instellingen van "Stringvertaling" aanpassen. Wanneer je bij deze instellingen bovenaan op de link "Talen van domeinen" klikt opent er een popup.

In deze popup kan je WPML "vertellen" wat de brontaal van onze addon is. Het komt vaak voor dat WPML denkt dat dit "Engels" is terwijl het eigenlijk "Nederlands" moet zijn. Selecteer ons domein "tussendoor_multilingual" achter de setting "Selecteer voor welke domein u de taal wilt instellen".

Wanneer er al strings beschikbaar zijn in ons domein dan wil je de brontaal van die strings ook aanpassen. Selecteer daarom de checkbox naast de huidige brontaal. Vervolgens kan je achter de instelling " Zet de brontaal van deze strings op:" de juiste taal selecteren. Vink ook de checkbox "Gebruik deze taal als standaard taal voor nieuwe strings in dit domein" aan.

Klik op "Toepassen" om de instellingen op te slaan.

Lokalisatie van thema en plug-ins

WordPress -> Wpml -> Lokalisatie van thema en plug-ins > Scroll naar "Strings in de thema's".

De addon verwerkt de waardes die via de hoofdplugin binnen komen vanuit het CRM en maakt hier een vertaalbare string van. De opslag van de hoofdplugin wordt gebruikt voor het opslaan van de vertaalbare strings in de file "translationstrings.php". De opslag is standaard in het actieve thema en onder het domeinnaam van de hoofdplugin. Voor de "Makelaars plugin geschikt voor Realworks" is dit: actieve-thema/realworks en voor de Autobedrijf Voertuigen plugin is dit: actieve-thema/autobedrijfvoertuigen.

Dit betekent dus dat je de vertalingen van het thema moet lokaliseren. Doe dit door de checkbox voor jouw thema bij de instellingen "Strings in de thema's" te selecteren en vervolgens op de knop "Scan geselecteerde thema's op strings" te klikken. Alle vertaalbare strings die onze addon beschikbaar heeft gesteld worden dan door WPML gelezen en beschikbaar gesteld in het vertaalbeheer.

Wanneer je jouw child-thema al vertaalbaar hebt opgezet (documentatie) vind je hier ook het tekstdomein dat je gebruikt hebt voor het vertaalbaar opzetten van de hardcoded strings.

Child-theme ontwikkeling

Bij de installatie van de hoofdplugin wordt in het child-theme een integratie gedaan zodat er (in ieder geval) een aanbod pagina en een detail pagina van de objecten beschikbaar wordt. Wij leveren hiervoor ook altijd een voorbeeld thema aan, echter bevat deze ook strings die niet vertaalbaar zijn opgezet. Zo kúnnen er nog meer strings bijkomen tijdens de integratie die niet standaard vertaalbaar zijn.

Internationalisatie

WordPress heeft uitgebreide documentatie voor het vertaalbaar opzetten van je thema. Wij verwijzen dus voor alle details graag door naar de WordPress Theme Handbook.

In het kort

WordPress maakt globale functies beschikbaar die gebruikt kunnen worden in thema ontwikkeling om eigen strings vertaalbaar op te zetten. Zonder het gebruik van deze functies kan WPML deze strings niet herkennen en dus niet vertaalbaar opzetten. Het is daarom voor het volledig vertaalbaar maken van de integratie van onze hoofdplugin van belang dat de thema integratie nagelopen wordt.

Wij raden aan om de integratie in een child-thema te doen. Deze standaard werkwijze houden we ook aan in deze documentatie.


Hardcoded strings

Een hardcoded string is een stuk tekst die niet binnen een globale functie voor internationalisatie van WordPress staat. Bijvoorbeeld voor een titel binnen de archive.php:

<div class="makelaar-container">
    <h1 class="entry-title">Complete aanbod</h1>
    <div id="entity-search">
        <?php echo Wonen::template('search'); ?>
    </div>
</div>

De titel "Complete aanbod" is hardcoded en kan niet gewijzigd worden. Er dient dus een globale functie van WordPress gebruikt te worden zodat de string dynamisch wordt. De dynamische waarde wordt dan door WPML bepaalt en zal resulteren in de vertaalde tekst voor de taal waarop de bezoeker de pagina bekijkt. De string kan dan dus veranderen afhankelijk van de ingestelde taal.


Vertaalbare string

Wanneer we de bovenstaande hardcoded string "Complete aanbod" vertaalbaar willen maken vergt dat een kleine aanpassing. Hieronder een voorbeeld:

<div class="makelaar-container">
    <h1 class="entry-title"><?php esc_html_e('Complete aanbod', 'my-theme'); ?></h1>
    <div id="entity-search">
        <?php echo Wonen::template('search'); ?>
    </div>
</div>

Wanneer het thema nu gelokaliseerd wordt door WPML (documentatie) wordt ook deze string gevonden onder het domein "my-theme". Je hebt volledige vrijheid over het domein dat je gebruikt voor je eigen thema. Let er op dat de vertalingen dan beschikbaar worden onder dit domein en niet onder het domein van onze addon: "tussendoor_multilingual".

In het voorbeeld wordt gebruik gemaakt van een helper functie die escaping en lokalisatie combineert. Documentatie van WordPress vind je hier.

Vertalen stappenplan

Hier vind je een beknopte stappen plan die je kunt volgen om de website, inclusief de waardes die onze hoofdplugin verwerkt, te gaan vertalen.

De stappen

  1. Child-theme hardcoded strings vertaalbaar maken in eigen tekst domein -> documentatie
  2. WPML plugin installeren.
  3. WPML standaard installatie zodat de website naar wens vertaald kan worden.
  4. WPML addon installeren
  5. WPML addon dashboard + standaard taal instellen. -> documentatie
  6. WPML "Vertaling berichttypes" instellen -> documentatie
  7. WPML "Talen van domeinen" instellen -> documentatie
  8. WPML addon module instellingen, vink de velden aan die je wil vertalen -> documentatie
  9. Bijwerken objecten OF voorkant website bezoeken zodat de velden verwerkt moeten worden -> documentatie
  10. WPML "Lokalisatie van thema en plug-ins" instellen -> documentatie 
  11. Start vertalen.