Disclaimer: Dit artikel is gegenereerd door automatische vertaling.

Variabelen

Prev Next

Plannen die ondersteuning bieden voor het toevoegen van variabelen

Professional
Business
Enterprise






U kunt variabelen hergebruiken wanneer u dezelfde op tekst gebaseerde inhoud gebruikt op meerdere plaatsen die in de loop van de tijd kunnen veranderen (zoals veldnamen, contactnummers, adressen, disclaimers, enzovoort). Een variabele in Document360 is een herbruikbaar element dat helpt bij het behouden van consistentie en efficiëntie in verschillende documentatiesecties. Door gebruik te maken van variabelen kunnen bijdragers aan uw artikelen eenvoudig informatie op één plek bijwerken, en dit wordt automatisch weerspiegeld in de hele documentatie, waardoor nauwkeurigheid wordt gegarandeerd en overbodige inspanningen worden verminderd.

U wilt bijvoorbeeld uw contactgegevens in meerdere instanties toevoegen, die in de loop van de tijd kunnen veranderen. In dit geval kunt u een variabele voor contactgegevens toevoegen. Als er een wijziging nodig is, kunt u de variabele alleen bijwerken in plaats van deze in alle gevallen bij te werken.
(Contactpersoon: +1 897564231/support@serverless.com)


Een variabele maken

Om een variabele te maken,

  1. Navigeer naar Documentation () > Content tools > Content reuse > Variables in de kennisbank.

    De pagina Variabelen wordt weergegeven. Als u eerder variabelen heeft toegevoegd, kunt u deze hier bekijken.

  2. Klik bovenaan op Variabele maken om taalspecifieke variabelen (Global, Engels, Frans, enz.) te selecteren die aan uw project zijn toegevoegd.

  3. Voer de naam voor uw variabele in.

NOTITIE

De naam van de variabele kan letters, cijfers, koppeltekens en onderstrepingstekens bevatten, met een maximale lengte van 30 tekens.

  1. De waarde voor de samenvoegcode is de naam van de variabele die wordt weergegeven met de variabele-tag in uw editor.

    Als de naam van uw variabele bijvoorbeeld Disclaimer is, is de waarde van uw samenvoegcode {{variable. Vrijwaring}}.

  2. In de vervolgkeuzelijst voor taalselectie is de standaardselectie Algemeen (beschikbaar in alle talen). Indien nodig kunt u echter een gewenste beschikbare taal kiezen om een taalspecifieke variabele te maken.

  3. Voer in het veld Inhoud de inhoud van de variabele in.

NOTITIE

De tekenlimiet van de variabele inhoud is 100 tekens met spaties. Als u langere teksten, uitdrukkingen, media, tabellen of codeblokken wilt toevoegen, gebruikt u fragmenten. Lees voor meer informatie het artikel op Snippet.

Opmaakopties

Gebruik de volgende tekstopmaakopties om de variabele inhoud op te maken

een. Basis tekstopmaak:
• Gedurfd
• Cursief
• Doorhalen
• Onderstrepen
• Lettergrootte (8 tot 36)

b. Aanvullende opmaak:

Klik op het pictogram Meer tekst om toegang te krijgen tot:
• Lettertypefamilie (kies uit de lijst met lettertypen)
• Tekstkleur (kleurkiezer of HEX-code)
• Achtergrondkleur (Kleurkiezer of HEX-code)
• Subscript
• Superscript
• Duidelijke opmaak

c. Link invoegen - Om een hyperlink toe te voegen.

  • Klik op het pictogram Link invoegen .

  • Typ de URL en voeg tekst toe aan de link.

  • Selecteer indien nodig Openen in nieuw tabblad.

  • Klik op Invoegen.

  1. Klik op de knop Variabele maken .

De nieuw gemaakte variabele verschijnt op de pagina Variabelen , waar deze naar behoefte kan worden bewerkt of verwijderd.

To create new variables


Variabele gebruiken in een artikel-/categoriepagina

Je kunt op twee manieren een variabele toevoegen aan je artikel-/categoriepagina.

Methode 1: De syntaxis gebruiken (Markdown-editor)

Typ een variabele in de Markdown-editor . MergeCodeValue tussen gesloten dubbele accolades.

Voorbeeld: {{variabele. Vrijwaring}}

U moet de exacte waarde van de samenvoegcode kennen om de gewenste variabele toe te voegen. De variabele werkt niet, zelfs niet als er een enkele letter verandert.

NOTITIE

Variabel intypen . Merge_Code_Value werkt alleen in de Markdown-editor. Als u Advanced WYSIWYG editorgebruikt, kunt u een variabele invoegen met behulp van de werkbalk.

Methode 2: Vanaf de werkbalk (Markdown, WYSIWYG en Advanced WYSIWYG)

  1. Klik op het pictogram voor hergebruik van inhoud () voor Markdown en WYSIWYG-editor.
    (ofwel)
    Gebruik vanuit de geavanceerde WYSIWYG-editor de opdracht /variables slash om toegang te krijgen tot variabelen.

  2. Selecteer de variabele of gebruik de balk Variabelen zoeken om de naam van de variabele te verfijnen.

In de geavanceerde WYSIWYG-editor wordt het deelvenster Variabelen weergegeven voor het selecteren van variabelen. Beweeg de muisaanwijzer over de gewenste variabelenaam om een voorbeeld van de inhoud te bekijken.

  1. Selecteer de gewenste variabele om in te voegen.

NOTITIE

In Markdown en WYSIWYG editor kunt u meerdere variabelen in één keer selecteren.

Inserting variables from the article editor.


Pagina met variabelen

U kunt een variabele weergeven, bewerken of verwijderen op de pagina Variabelen .

  1. Navigeer naar Documentatie () > Inhoudshulpprogramma's > Hergebruik van inhoud > Variabelen in de Knowledge Base-portal.

    De pagina Variabelen verschijnt waar u de lijst met variabelen kunt vinden die u al hebt toegevoegd.

Overview page of variables

  1. Talen: om de variabelen in globaal of een specifieke taal te filteren.

  2. Zoekvariabele: Zoek in de lijst met variabelen op basis van de naam.

  3. Gebruikt in: Als een variabele niet wordt toegevoegd aan een artikel-/categoriepagina, is -de status . Als een variabele is toegevoegd aan een artikel-/categoriepagina, kunt u op de knop Weergave klikken om de lijst met artikelen/categoriepagina's te zien die de variabele bevatten.

  4. Taal: De gewenste taal van elke variabele.

  5. Laatst gewijzigd: de laatste keer dat de inhoud van de variabele is bijgewerkt.

  6. Voorbeeld: Klik op de naam van de variabele en u kunt de inhoud van de variabele bekijken.

  7. Voortgang: Klik op het wereldbolpictogram om de voortgang van de variabele in meerdere talen te bekijken.

  8. Pictogram Bewerken (): Om de inhoud van de variabele te bewerken. Nadat u de wijzigingen heeft aangebracht, klikt u op Bijwerken.

  9. Pictogram Verwijderen (): Om de variabele te verwijderen.


Afhankelijkheid van artikelen/categoriepagina's bekijken

Op de pagina Variabelen vindt u de kolom Gebruikt in .

  1. Klik in de kolom Gebruikt in op de knop Weergave .

    Het paneel Referenties weergeven verschijnt, waar u de lijst met artikelen/categoriepagina's kunt bekijken waaraan de variabele is toegevoegd.

  2. Klik op het artikel om de sectie uit te vouwen.

  3. U kunt de volgende informatie vinden:

    • De versie van het artikel.

    • De werkruimte en taal van het project.

    • De naam van het teamaccount en de profielfoto aan wie de variabele is toegevoegd.

    • In het artikel staat (Gepubliceerd, Concept, Nieuw artikel).

    • De tijd/datum-informatie wanneer de variabele is ingevoegd in de artikel-/categoriepagina.

    Image showing dependencies of a variable


Een bestaande variabele bewerken

  1. Navigeer naar Documentatie () > Inhoudshulpprogramma's > Inhoudshergebruik > Variabelen in de Knowledge Base-portal.

    De pagina Variabelen wordt weergegeven. U kunt de lijst met variabelen vinden die u al hebt toegevoegd.

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

    U kunt de inhoud van de variabele bewerken. De waarde Naam en Samenvoegcode kan niet worden bewerkt.

NOTITIE

Een link bewerken die is toegevoegd in een variabele

Klik op de link en u kunt de volgende opties vinden:

  • Open link (): De link wordt geopend op het tabblad. Dit helpt bij het controleren van de link.

  • Stijl (): Stijl heeft twee opties.

    • Groen: Als u de kleur van de linktekst wilt wijzigen in groen.

    • Dik: om de dikte van de linktekst te vergroten.

  • Bewerken (): Als u de URL wilt bewerken, de linktekst wilt koppelen en wilt wijzigen, opent u deze in de optie voor het nieuwe tabblad.

  • Ontkoppelen (): Om de URL te ontkoppelen en te wijzigen in standaardtekst. De URL wordt ontkoppeld en alleen de URL-tekst wordt weergegeven.

  1. Nadat u de inhoudsbewerking hebt voltooid, klikt u op de knop Bijwerken .

NOTITIE

Wanneer u de inhoud van een bestaande variabele in de bibliotheek bewerkt, wordt de inhoudswijziging doorgevoerd in alle artikelen/categoriepagina's die de betreffende variabele bevatten.


Een variabele verwijderen

  1. Navigeer naar Documentatie () > Inhoudshulpprogramma's > Inhoudshergebruik > Variabelen in de Knowledge Base-portal.

    De pagina Variabelen wordt weergegeven. U kunt de lijst met variabelen vinden die u al hebt toegevoegd.

  2. Plaats de muisaanwijzer op de gewenste variabele en klik op het pictogram Verwijderen ().

  3. Klik op Ja in de bevestigingsprompt.

Meerdere variabelen bulksgewijs verwijderen

Selecteer meerdere beoogde variabelen op de pagina Variabelen en klik op de optie Verwijderen boven aan de lijst.

to perform deletion of variables


Variabelen vertalen

U kunt variabelen in meerdere talen maken en beheren. Dit zorgt ervoor dat wanneer uw artikelen worden vertaald, de variabelen overeenkomen met de taal van het artikel, wat een consistente en gelokaliseerde gebruikerservaring biedt.

Nieuwe variabelen vertalen

  1. Navigeer naar de Documentatie () > Inhoudshulpprogramma's > Hergebruik van inhoud > Variabelen in de Knowledge Base-portal.

  2. Klik op Variabele maken.

  3. Selecteer in de vervolgkeuzelijst Taal de beoogde taal (behalve globaal).

  4. Voer de naam van de variabele en de inhoud van de variabele in het Engels (of uw standaardtaal) in.

  5. Als u de inhoud in andere talen wilt vertalen, klikt u op het vervolgkeuzemenu Vertalen naar andere talen .

  6. Selecteer de gewenste taal of talen in het vervolgkeuzemenu en klik op Vertalen.

    NOTITIE

    • De standaardtaal wordt gemarkeerd als Main.

    • Vertaalde talen worden aangegeven met een groen vinkje om aan te geven dat de vertaling volledig is. Indien nodig kunt u naar onvertaalde talen navigeren en de vertaling ervan voltooien.

  7. Zodra de vertalingen zijn voltooid, klikt u op Variabele maken om de variabele samen met de bijbehorende vertalingen op te slaan.

    Als u bijvoorbeeld een variabele maakt voor een welkomstbericht in het Engels, kunt u de vertaalfunctie gebruiken om hetzelfde bericht toe te voegen in het Frans, Spaans, Duits, enzovoort.

Translating new variables

Bestaande variabelen vertalen

NOTITIE

Globale variabelen kunnen niet worden vertaald.

  1. Klik op de gewenste bestaande variabele die u wilt vertalen.

  2. Navigeer naar Vertalen naar andere talen en selecteer de gewenste taal die de variabele moet worden vertaald.

  3. Klik op Vertalen.

  4. Indien nodig kunt u naar andere talen navigeren en deze vertalen.

  5. Als u de inhoud opnieuw wilt vertalen, klikt u nogmaals op Vertalen, waardoor de bestaande vertaling wordt overschreven door de nieuwe.

  6. Als u de vertaalde variabele voor een specifieke taal wilt verwijderen, klikt u op Taal verwijderen.

    U kunt de inhoud op elk gewenst moment opnieuw vertalen als dat nodig is.

Translate existing variables


Veelgestelde vragen

Hoe werken variabelen?

Met variabelen kunt u specifieke inhoudselementen, zoals productnamen of versienummers, op één plek definiëren. Het bijwerken van de variabele weerspiegelt automatisch de wijziging in alle relevante secties wanneer deze inhoud verandert, waardoor uniformiteit wordt gegarandeerd.

Wat is het voordeel van het gebruik van variabelen in mijn documentatie?

Door variabelen te gebruiken, zorgt u voor consistentie in uw documentatie en minimaliseert u de noodzaak van handmatige updates. Dit bespaart tijd, vermindert fouten en behoudt de nauwkeurigheid, vooral bij het omgaan met vaak veranderende informatie.

Kan ik mijn variabelen aanmaken in Document360?

Document360 stelt u in staat om aangepaste variabelen te maken die zijn afgestemd op uw documentatiebehoeften. Dit stelt u in staat om de functie aan te passen aan de specifieke terminologie en elementen die relevant zijn voor uw inhoud.

Hoe gebruik ik variabelen in mijn artikelen?

Voeg de variabele in de inhoud van het artikel in met behulp van de werkbalk van de editor of de waarde van de samenvoegcode, en de informatie die u hebt gedefinieerd, wordt dynamisch opgehaald, waardoor uniformiteit in uw documentatie wordt gegarandeerd.

Kunnen variabelen in meerdere artikelen tegelijk worden bijgewerkt?

Wanneer u een variabele bijwerkt, wordt de wijziging automatisch doorgevoerd in alle instanties waarin die variabele wordt gebruikt, waardoor het eenvoudig is om consistente informatie bij te houden in uw hele kennisdatabase.

Zijn variabelen beperkt tot specifieke soorten inhoud?

Ja, variabelen kunnen worden gebruikt voor beperkte tekst, nummers of op links gebaseerde inhoud, van productnamen en versienummers tot URL's en contactgegevens.

Hoe verbeteren variabelen de samenwerking tussen teamleden?

Variabelen stroomlijnen het samenwerkingsproces door ervoor te zorgen dat iedereen dezelfde nauwkeurige informatie gebruikt. Wijzigingen in een variabele worden onmiddellijk bijgewerkt in alle artikelen, waardoor discrepanties worden voorkomen.

Is het gebruik van variabelen een best practice in technische documentatie?

Het gebruik van variabelen is een best practice die de efficiëntie, consistentie en nauwkeurigheid van technische documentatie verbetert. Het is vooral waardevol bij het werken met dynamische informatie die regelmatig moet worden bijgewerkt.

Kan ik variabelen in elke taal vertalen?

U kunt variabelen vertalen in elk van de talen van uw project.

Wordt de definitie van een variabele term die in de kennisbank wordt gemaakt, geïndexeerd in de zoekresultaten en door Google?

Ja, de definitie van een variabele term die in de Knowledge Base-site (KB) is gemaakt, wordt zowel in de zoekresultaten van de site als door Google geïndexeerd. Zodra de term is toegevoegd, wordt deze doorzoekbaar op de website en wordt deze ook gecrawld en geïndexeerd door Google.