Algemeen
Variabelen
Variabelen per shopsysteem
Variabelen in variabelen

Opbouw handleiding

Op deze pagina wordt uitgelegd hoe de handleidingen van Webwinkelfacturen zijn opgebouwd.

De secties in een handleiding


Een handleiding bestaat uit secties. De secties kun je toevoegen aan de handleiding via de handleidingen tool. Een handleiding heeft drie type secties:

  1. Secties die alleen betrekking hebben op het shopsysteem - de webwinkel / kassa / psp.
    • Sectie met informatie die nodig is om de connectie met het shopsysteem te leggen. Deze sectie kan ontbreken. Bijvoorbeeld omdat de connectie via OAuth plaatsvindt.
    • Sectie die uitlegt hoe en hoevaak informatie wordt opgehaald uit de webwinkel / kassa / psp. De naam van deze sectie is Day-to-day: Vanuit
  2. Secties die alleen betrekking hebben op het boekhoudsysteem.
    • Sectie met informatie die nodig is om de connectie met het boekhoudsysteem te leggen. Deze sectie kan ontbreken. Bijvoorbeeld omdat de connectie via OAuth plaatsvindt.
    • Sectie die uitlegt hoe informatie wordt doorgestuurd naar het boekhoudsysteem. De naam van deze sectie is Day-to-day: Naar
  3. Secties die zowel betrekking hebben op de webwinkel / kassa / psp als op het boekhoudsysteem.
    • De inleiding
    • Uitleg hoe de koppeling werkt
    • De installatie van de koppeling
    • Support-sectie voor de koppeling
Opdracht: Bekijk drie handleidingen en controleer of je de verschillende type secties herkent.

Variabelen in een sectie


Een sectie bestaat uit tekst en variabelen. Variabelen hebben altijd de vorm xxx_varnaam_xxx. Variabelen komen voor in configuratie-bestanden van de handleiding. Per handleiding zijn er drie configuratie-bestanden:

  1. Het configuratiebestand voor het boekhoudsysteem. Alle handleidingen voor het boekhoudsysteem hebben dit configuratiebestand gemeenschappelijk.
  2. Het configuratiebestand voor het shopsysteem - de webwinkel / kassa / psp. Alle handleidingen voor het shopsysteem hebben dit configuratiebstand gemeenschappelijk.
  3. Een configuratiebestand specifiek voor het shopsysteem en het boekhoudsysteem. Omdat dit configuratiebestand uniek is staan hier zo min mogelijk variabelen in.

Variabelen binnen variabelen


Een variabele zelf kan een waarde zijn of een stuk tekst. Bijvoorbeeld xxx_WinkelNaam_xxx is de naam van het shopsysteem, bijv WooCommerce. De variabele xxx_KortWatDeKoppelingDoet_xxx bevat een hele tekst. Variabelen kunnen zelf ook weer variabelen bevatten. Soms zijn variabelen ingewikkeld en springen zij van het ene configuratiebestand naar het andere en weer terug. Hieronder een plaatje met de een aantal veel-voorkomende variabelen.