Disclaimer: Dit artikel is gegenereerd door automatische vertaling.

URL-toewijzing

  • Bijgewerkt op Dec 6, 2024
  • Gepubliceerd op Nov 6, 2024
  • 5 Gelezen minuut(en)
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next

Plannen die de Knowledge Base-widget ondersteunen

Professional
Business
Enterprise



Met de functie voor URL-toewijzing in de kennisbankwidget kunt u de weergave van specifieke artikelen en categorieën aanpassen op basis van de pagina's die uw eindgebruikers bezoeken. Deze functionaliteit verbetert niet alleen de gebruikerservaring door gebruikers naar relevante inhoud te leiden, maar stelt u ook in staat om de kennisbankwidget op bepaalde URL's te verbergen of een zoekbalk te bieden met aangepaste tijdelijke aanduidingen, zodat gebruikers kunnen zien wat ze moeten zoeken.

URL-toewijzing gebruiken

Als u URL-toewijzing wilt configureren, voert u specifieke acties uit binnen de kennisbankwidget voor aangewezen URL's.

Acties

Er zijn vier acties die u kunt uitvoeren met URL-toewijzing:

  1. Toon artikel: Geeft één artikel weer op de opgegeven URL.

  2. Toon lijst van artikelen: Geeft een lijst van geselecteerde artikelen onder de sectie Aanbevolen in de Knowledge Base-widget op de opgegeven URL.

  3. Zoekresultaten weergeven: Hiermee kunt u een specifieke zoekterm instellen om uw kennisbank te doorzoeken, waarbij relevante zoekresultaten worden geretourneerd op de opgegeven URL.

  4. Widget verbergen: Hiermee voorkomt u dat het pictogram van de Knowledge Base-widget wordt weergegeven op de opgegeven URL.

U vindt deze acties onder het tabblad URL-toewijzing of wanneer u een bestaande toewijzing bewerkt.

NOTITIE

URL-toewijzing werkt alleen als de Knowledge Base-widget op uw site of in uw app is geïnstalleerd. Lees voor meer informatie het artikel op Installing the Knowledge base widget.

URL-parameters

Bij het configureren van de URL van de Knowledge Base-widget kunt u drie soorten parameters opnemen:

  1. Pad opnemen: /thisis/a/path

  2. Query opnemen: ?animal=bear

  3. Voeg hash toe: #inbox

U kunt ook de wisselknop Is Regex inschakelen om reguliere expressies op te nemen in uw URL-configuraties.

URL-toewijzing toevoegen aan uw widget

Volg deze stappen om de gewenste widget in uw kennisbanksite te integreren:

  1. Navigeer naar het tabblad URL-toewijzing in de widget () in de Knowledge base portal.

  2. Klik op Nieuwe URL-toewijzing en geef het volgende op:

    • Naam - De naam van de URL-toewijzing wordt alleen weergegeven op de URL-toewijzingsrecord in Document360

    • URL-structuur  - Selecteer het gewenste URL-parametertype (Pad opnemen/Query opnemen/Hash opnemen). U moet ten minste één URL-parameter inschakelen

    • Typ de URL waarop u het artikel/de categorie wilt weergeven of de actie wilt laten plaatsvinden.

      NOTITIE

      Uw domeinnaam is niet opgenomen in het URL-pad. Bijvoorbeeld, https://document360.com/ebook/rapid-guide-to-launch-your-knowledge-base/zou uw URL-pad zijn /ebook/rapid-guide-to-launch-your-knowledge-base/

    • Actie - Selecteer de gewenste actie.

    • Selecteer werkruimte - Selecteer de gewenste versie (als u meerdere versies heeft).

    • Taal naar - Selecteer de gewenste taal (als u meerdere talen heeft).

    • Artikel om te tonen - Selecteer in de zoekbalk de artikelen/categorieën die u wilt weergeven in uw kennisbankdocumentatie.

    NOTITIE

    Mapcategorieën kunnen niet worden geselecteerd. Alleen pagina - en indexcategorietypen zijn beschikbaar voor selectie.

  3. Klik op Maken.

1_URLmapping.gifZodra een eindgebruiker toegang heeft tot het door u opgegeven URL-pad en de Knowledge Base-widget opent, ziet hij of zij het toegewezen artikel/de toegewezen categorie. Deze informatie blijft consistent terwijl ze navigeren tussen de tabbladen van de Knowledge Base-widget binnen dezelfde versie en taal.

URL-toewijzing bewerken

Ga als volgt te werk om een bestaande URL-toewijzing te wijzigen:

  1. Navigeer naar Widget () in de Knowledge base portal.

  2. Plaats de muisaanwijzer op de gewenste Knowledge Base-widget en klik op het pictogram Bewerken ().

    Op het tabblad URL-toewijzing vindt u de lijst met beschikbare URL-toewijzingen.

  3. Plaats de muisaanwijzer op de gewenste URL-toewijzing en klik op het pictogram Bewerken ().

    De blade voor het bijwerken van URL-toewijzing wordt weergegeven.

  4. Werk de gewenste informatie bij en klik op Bijwerken.

2_urlmapping_edit.gif

URL-toewijzing verwijderen

U kunt een ingestelde URL-toewijzing verwijderen.

3_urlmapping_delete.png

  1. Navigeer naar Widget () in de Knowledge base portal.

  2. Plaats de muisaanwijzer op de gewenste Knowledge Base-widget en klik op het pictogram Bewerken ().

  3. Op het tabblad URL-toewijzing vindt u de lijst met beschikbare URL-toewijzingen.

  4. Plaats de muisaanwijzer op de gewenste URL-toewijzing en klik op het pictogram Verwijderen ().

  5. Klik op Ja in de bevestigingsprompt voor verwijderen .

Instellingen voor URL-toewijzing

U kunt het gedrag van de Knowledge Base-widget definiëren voor URL's waarvoor geen geconfigureerde toewijzing is. Door dit gedrag te definiëren, kunt u de gebruikerservaring en de toegankelijkheid van de documentatie verbeteren.

4_urlmapping_settings.png

  1. Navigeer naar Widget () in de Knowledge base portal > Configureren en verbinden.

  2. Vouw onder de sectie Besturingselementen instellen de sectie Instellingen voor URL-toewijzing uit.

  3. Selecteer de gewenste optie:

    • Navigeer naar de Help-/kennisbank van de pagina: selecteer deze optie om het artikel/de categorie weer te geven in de Help voor pagina's of het tabblad Kennisbank in de widget.

    • Breng geen wijzigingen aan in de bestaande instellingen: Selecteer deze optie om het laatst geopende artikel/categorie in de widget weer te geven.

  4. Klik op Opslaan.

Basis URL-overeenkomsten

Inzicht in URL-matching is cruciaal voor effectieve URL-mapping. Een regex voor algemeen gebruik voor het overeenkomen van typische URL's ziet er als volgt uit:

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

Uitleg van de componenten

  • ^https?://?: Komt overeen met het protocol (bijv. http:// of https://). Het ? maakt het protocol optioneel.

    NOTITIE

    Zorg ervoor dat u een schuine streep achterwaarts (\) toevoegt voor elke schuine streep (/) tijdens het testen van uw URL op https://regex101.com.

  • [a-zA-Z0-9.-]+: Komt overeen met de domeinnaam, inclusief letters, cijfers, punten (.) en koppeltekens (-).

  • /[a-zA-Z0-9/._-]*?: Komt overeen met het pad na het domein, waardoor schuine strepen, alfanumerieke tekens, punten, onderstrepingstekens en koppeltekens zijn toegestaan.

  • ?[a-zA-Z0-9=&._-]*?: Komt overeen met optionele queryparameters (bijv. ?key=value), waardoor dit onderdeel optioneel is.

  • #[a-zA-Z0-9_-]*?: Komt overeen met het fragment (bijv. #section), wat ook optioneel is.

Voorbeelden van URL-toewijzing met Regex

URL's met specifieke paden toewijzen

Als u een URL-patroon zoals /users/{id}wilt toewijzen, gebruikt u:

^/users/[0-9]+$

Hiermee wordt een gebruikers-ID dynamisch vastgelegd.

Voorbeeld overeenkomsten

  • /users/123

  • /users/456

URL's toewijzen met queryparameters

Voor URL's zoals /search?q={query}, zou de regex zijn:

^/search?q=[a-zA-Z0-9]+$

Voorbeeld overeenkomsten

  • /search?q=apple

  • /search?q=123abc

URL's toewijzen met optionele parameters

Voor een URL-patroon zoals /products/{category}/{id}, waarbij de categorie optioneel is:

^/products/[a-zA-Z]+?/[0-9]+$

Voorbeeld overeenkomsten

  • /products/123

  • /products/electronics/123

URL's toewijzen met jokertekens of meerdere paden

Voor /blog/*:

^/blog/.*?$

Voorbeeld overeenkomsten

  • /blog

  • /blog/how-to-code

  • /blog/2021/10

URL's toewijzen aan subdomeinen
Voor subdomein-URL's:

^https?://?[a-zA-Z0-9-]+.example.com$

Voorbeeld overeenkomsten

  • http://blog.example.com

  • https://shop.example.com

Combineren van meerdere componenten

Om complexere URL-toewijzingen te verwerken, kunt u de verschillende componenten naar behoefte combineren. De uitgebreide regex die overeenkomt met een URL met een optioneel protocol, domein, pad, queryparameters en fragment ziet er als volgt uit:

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

VEELGESTELDE VRAGEN

Hoe kan ik de Help voor pagina's en de zoekbalk uit de widget verwijderen wanneer URL-toewijzing voor één artikel is geconfigureerd?

De Help voor pagina's en de zoekbalk uit de widget verwijderen wanneer URL-toewijzing voor één artikel is geconfigureerd:

  1. Navigeer naar Widget () in de Knowledge Base-portal.

  2. Plaats de muisaanwijzer op de gewenste widget en klik op het pictogram Bewerken ().

  3. Plak de verstrekte code op het tabblad Aangepaste CSS :

    li#page-help-tab {
    display: none;
}

.article-header .article-back-icon {
    display: none;
}

.search-container {
    display: none !Important;
}

  4. Plak de verstrekte code op het tabblad Aangepast JavaScript :

    setTimeout(function() { $('.search-container').hide();}, 2000);
setTimeout(function() { $("#knowledge-base-tab").click();}, 2000);

  5. Klik op Opslaan.

Hiermee worden het tabblad Help voor pagina's en de zoekbalk in de widget op de Knowledge Base-site verborgen wanneer URL-toewijzing voor één artikel is geconfigureerd.

Hoe kan ik de updates direct in de KB Widget zien na het toevoegen of bijwerken van een URL Map?

De updates worden om prestatieredenen in de cache van de server opgeslagen en worden elke 15 minuten automatisch vernieuwd. Als u de wijzigingen echter onmiddellijk wilt zien, kunt u de applicatiecache wissen.

gerelateerde artikelen