English, Nederlands
Doneer met PayPal

API Naslagwerk

Inleiding

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.

Inhoudsopgave

addKeywords

Description
addKeywords(array|string $newKeywords): void
addKeywords(array|string $keywords, array|string $newKeywords): void

Stel (overschrijf) de keywords van de hudige pagina in.

Parameters

This function has no parameters.

Return value

No value is returned.

See Also

addMenuItem

Description
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.

Parameters
menuItem
Het menu-item dat u wilt toevoegen als een door slashes gescheiden lijst.
language
De taal waarvoor een menu-item word toegevoegd.
link
De lokale of externe uRL waarnaar gelinkt word.
name
De naam die in de navigatie en het broodkruimelpad word weergegeven.
Return value

No value is returned.

See Also

setDescription

Description
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.

Parameters
description
De in te stellen omschrijving.
Return value

No value is returned.

See Also

setEpilogue

Description
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.

Parameters
epilogue
De in de pagina te zettem epiloog.
location
De locatie op de pagina waar de epiloog moet worden geplaatst.
Return value

No value is returned.

See Also

setKeywords

Description
setKeywords(string $keywords): void

Stelt (overschrijft) de keywords van de huidige pagina.

Parameters
keywords
De in te stellen keywords.
Return value

No value is returned.

See Also

setPrologue

Description
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.

Parameters
prologue
De in te pagina proloog.
location
De locatie op de pagina waar de proloog moet worden geplaatst.
Return value

No value is returned.

See Also

setSubtitle

Description
setSubtitle(string $subtitle): void

Stel de subtitle van de hudige pagina in.

Parameters
subtitle
De in te stellen subtitel.
Return value

No value is returned.

See Also

setTitle

Description
setTitle(string $title): void

Stel de titel van de hudige pagina in.

Parameters
title
De in te stellen titel.
Return value

No value is returned.

See Also