,
Nocterra biedt een application programming interface (API) die op elke pagina kan worden gebruikt. De Nocterra API bevat functies om de gegenereerde webpagina's eenvoudig te verrijken en aan te passen op een per-pagina basis. Deze documentatie is zowel een gebruikershandleiding voor content schrijvers als ontwikkelaars die de gegenereerde content willen verrijken en taken zoals SEO willen uitvoeren.
De API-referentie is niet compleet; het is een voortdurende inspanning om de API te documenteren en voorbeelden te geven om het gebruik van de functies te documenteren. Zie ook de Nocterra Handleiding voor een beschrijving van de functionele principes en uitgebreidere voorbeelden.
addKeywords(array|string $newKeywords): void
addKeywords(array|string $keywords, array|string $newKeywords): void
Stel (overschrijf) de keywords van de hudige pagina in.
This function has no parameters.
No value is returned.
addMenuItem(
string $menuItem,
string $language,
string $link,
string $name
): void
Voeg een item toe aan het menu in de opgegeven taal. Menu-items worden opgegeven door hun structuur in het menu. foo
zou het foo
-menu op het hoogste niveau zijn. foo/bat
zou het bar
-submenu zijn als een kind van het foo
-menu.
Voor meertalige websites kan een menu worden toegevoegd voor elke taal. Wanneer een taal geen menu-item heeft toegevoegd voor de $menuItem
tijdens het genereren van de URL, wordt er een URL gegenereerd naar het diepste menu-item dat aanwezig is in die taal, hetzij door het te definiëren in de configuratie of door deze functie toe te voegen.
Als er eerder een menu-item is toegevoegd voor $menuItem
, worden de link
en name
overschreven, andere ingestelde waarden blijven behouden.
No value is returned.
setDescription(string $description): void
Stelt de metabeschrijving in voor de huidige pagina. Deze beschrijving wordt gebruikt voor SEO, als tekst wanneer mensen naar de pagina linken in Facebook en voor Twitter-kaarten.
No value is returned.
setEpilogue(string $epilogue): void
setEpilogue(string $epilogue, string $location): void
Stelt de epiloog in voor de huidige pagina.
Een epiloog is een door de gebruiker gedefinieerd stuk HTML dat aan het einde van een pagina-element wordt ingevoegd. Het wordt ingevoegd na de inhoud die door Nocterra wordt gegenereerd.
De locatieparameter specificeert na welk element op de pagina de epiloog wordt ingevoegd. Als deze niet wordt gespecificeerd, staat deze aan het einde van de paginabody.
No value is returned.
setKeywords(string $keywords): void
Stelt (overschrijft) de keywords van de huidige pagina.
No value is returned.
setPrologue(string $prologue): void
setPrologue(string $prologue, string $location): void
Stelt de proloog in voor de huidige pagina.
Een proloog is een door de gebruiker gedefinieerd stukje HTML dat aan het begin van een pagina-element wordt ingevoegd. Het wordt ingevoegd vóór de inhoud die door Nocterra wordt gegenereerd.
De locatieparameter specificeert vóór welk element op de pagina de proloog wordt ingevoegd. Als deze niet wordt gespecificeerd, staat deze aan het begin van de paginabody.
No value is returned.
setSubtitle(string $subtitle): void
Stel de subtitle van de hudige pagina in.
No value is returned.
setTitle(string $title): void
Stel de titel van de hudige pagina in.
No value is returned.