Lezen in het Engels

Delen via


Bijdragen aan de HoloLens-documentatie

Welkom bij de HoloLens-documentatie! Alle artikelen die u in deze opslagplaats maakt of bewerkt zijn zichtbaar voor het publiek.

HoloLens-documentatie wordt gepubliceerd naar Microsoft Learn, dat gebruikmaakt van Markdown met Markdig-functies die zijn gesmaakd van GitHub. De inhoud die u in deze opslagplaats bewerkt, wordt opgemaakt in gestileerde pagina's die worden weergegeven op /hololens.

Deze pagina bevat de basisstappen en richtlijnen voor bijdragen en koppelingen naar de basisprincipes van Markdown. Bedankt voor uw bijdrage!

Beschikbare opslagplaatsen

Naam van opslagplaats URL
HoloLens MicrosoftDocs/HoloLens-
Mixed Reality MicrosoftDocs/mixed reality-
VR-liefhebbershandleiding MicrosoftDocs/mixed-reality/enthusiast-guide

Voordat u begint

Als u er nog geen hebt, moet u een GitHub-account maken.

Notitie

Als u een Microsoft-werknemer bent, koppelt u uw GitHub-account aan uw Microsoft-alias in de Microsoft Open Source-portal. Neem deel aan de 'Microsoft' en 'MicrosoftDocs' organisaties.

Bij het instellen van uw GitHub-account raden we u ook de volgende beveiligingsmaatregel aan:

Het publicatiesysteem is gekoppeld aan GitHub, dus deze stappen zijn belangrijk. U wordt vermeld als auteur of inzender voor elk artikel met behulp van uw GitHub-alias.

Een bestaand artikel bewerken

Gebruik de volgende werkstroom om updates uit te voeren voor een bestaand artikel via GitHub in een webbrowser:

  1. Navigeer naar het artikel dat u wilt bewerken in de map hololens.

  2. Selecteer de knop Bewerken (potloodpictogram) in de rechterbovenhoek.

    Een artikel bewerken.

    Hiermee wordt automatisch een wegwerpbranch van de standaardbranch gesplitst, hoofd-.

  3. Bewerk de inhoud van het artikel volgens de basisbeginselen van Markdown.

  4. Metagegevens bijwerken boven aan elk artikel:

    • titel: paginatitel die wordt weergegeven op het browsertabblad wanneer het artikel wordt weergegeven. Paginatitels worden gebruikt voor SEO en indexering, dus wijzig de titel alleen als dat nodig is (hoewel dit minder kritiek is voordat documentatie openbaar wordt).
    • beschrijving: Schrijf een korte beschrijving van de inhoud van het artikel, wat SEO en ontdekking stimuleert.
    • auteur: als u de primaire eigenaar van de pagina bent, voegt u hier uw GitHub-alias toe.
    • ms.author: als u de primaire eigenaar van de pagina bent, voegt u hier uw Microsoft-alias toe (u hebt @microsoft.comniet nodig, alleen de alias).
    • ms.date: Werk de datum bij als u belangrijke inhoud toevoegt aan de pagina, maar niet voor oplossingen zoals verduidelijking, opmaak, grammatica of spelling.
    • trefwoorden: Trefwoordenhulp bij SEO (zoekmachineoptimalisatie). Voeg trefwoorden toe, gescheiden door een komma en een spatie die specifiek zijn voor uw artikel, maar geen interpunctie na het laatste trefwoord in uw lijst. U hoeft geen globale trefwoorden toe te voegen die van toepassing zijn op alle artikelen, omdat deze elders worden beheerd.
  5. Wanneer u klaar bent met het bewerken van uw artikel, schuift u omlaag en selecteert u Bestandswijziging voorstellen.

  6. Selecteer op de volgende pagina Pull-aanvraag maken om de automatisch gemaakte vertakking samen te voegen in de standaardbranch, hoofd-.

  7. Herhaal de bovenstaande stappen voor het volgende artikel dat u wilt bewerken.

De naam van een bestaand artikel wijzigen of verwijderen

Als uw wijziging de naam van een bestaand artikel wijzigt of verwijdert, moet u een omleiding toevoegen. Op die manier komt iedereen met een koppeling naar het bestaande artikel nog steeds op de juiste plaats terecht. Omleidingen worden beheerd door het .openpublishing.redirection.json-bestand in de hoofdmap van de opslagplaats.

Als u een omleiding naar .openpublishing.redirection.jsonwilt toevoegen, voegt u een vermelding toe aan de redirections-matrix:

{
    "redirections": [
        {
            "source_path": "hololens/old-article",
            "redirect_url": "/base-url/new-article#section-about-old-topic",
            "redirect_document_id": false
        },
  • De source_path is het relatieve opslagplaatspad naar het oude artikel dat u verwijdert. Zorg ervoor dat het pad begint met de docset (in dit geval hololens) en de bestandsextensie .md bevat.

  • De redirect_url is de relatieve openbare URL van het oude artikel naar het nieuwe artikel. Zorg ervoor dat deze URL niet.md bevat en begint met /, zoals deze verwijst naar de openbare URL en niet het pad naar de opslagplaats. Koppelen aan een sectie in het nieuwe artikel met behulp van #section is toegestaan. U kunt hier ook een absoluut pad naar een andere site gebruiken, indien nodig.

  • redirect_document_id geeft aan of u de document-id uit het vorige bestand wilt behouden. De standaardwaarde is false. Gebruik true als u de waarde van het ms.documentid kenmerk uit het omgeleide artikel wilt behouden. Als u de document-id behoudt, worden gegevens, zoals paginaweergaven en classificaties, overgebracht naar het doelartikel. Doe dit als de omleiding voornamelijk een naamswijziging is en geen verwijzing naar een ander artikel dat alleen betrekking heeft op een deel van dezelfde inhoud.

Als u een omleiding toevoegt, moet u ook het oude bestand verwijderen.

Een nieuw artikel maken

Gebruik de volgende werkstroom om nieuwe artikelen te maken in de documentatieopslagplaats via GitHub in een webbrowser:

  1. Maak een fork uit de standaardbranch, hoofd-, van MicrosoftDocs/hololens met behulp van de knop Fork in de rechterbovenhoek.

    Fork de standaardbranch, momenteel 'main' genoemd.

  2. Selecteer in de map Hololens Nieuw bestand maken in de rechterbovenhoek.

  3. Maak een paginanaam voor het artikel (gebruik afbreekstreepjes in plaats van spaties en gebruik geen interpunctie of apostrofs) en voeg '.md' toe

    geef de nieuwe pagina een naam.

    Belangrijk

    Zorg ervoor dat u het nieuwe artikel maakt vanuit de map hololens. U kunt dit bevestigen door te controleren op /hololens/in de nieuwe bestandsnaamregel.

  4. Voeg boven aan de nieuwe pagina het volgende metagegevensblok toe:

    ---
    title:
    description:
    author:
    ms.author:
    ms.date:
    ms.topic: article
    keywords:
    ---
    
  5. Vul de relevante metagegevensvelden in zoals eerder beschreven in Een bestaand artikel bewerken.

  6. Schrijf artikelinhoud met behulp van Markdown-basisbeginselen.

  7. Voeg onderaan het artikel een ## See also sectie toe met koppelingen naar andere relevante artikelen.

  8. Wanneer u klaar bent, selecteert u Nieuw bestand doorvoeren.

  9. Selecteer Nieuwe pull-aanvraag en voeg de hoofdvertakking van uw fork samen in de hoofdvertakking van microsoftDocs/hololens hoofd- (zorg ervoor dat de pijl naar de juiste bestemming verwijst).

    pull-aanvraag maken van uw fork naar MicrosoftDocs/hololens.

Basisbeginselen van Markdown

De volgende bronnen helpen u bij het bewerken van documentatie met behulp van de Markdown-taal:

Tabellen toevoegen

Omdat tabellen worden gestijld in Microsoft Learn, hebben ze geen randen of aangepaste stijlen, zelfs niet als u inline CSS probeert. Het lijkt een korte periode te werken, maar uiteindelijk zal het platform de stijl uit de tabel verwijderen. Plan dus vooruit en houd uw tabellen eenvoudig. Hier volgt een site waarmee Markdown-tabellen eenvoudig zijn: [Tabellengenerator]] (https://www.tablesgenerator.com/markdown_tables).

De Docs Markdown-extensie voor Visual Studio Code maakt het genereren van tabellen ook eenvoudig als u Visual Studio Code (zie hieronder) gebruikt om de documentatie te bewerken.

Afbeeldingen toevoegen

U moet uw afbeeldingen uploaden naar de map hololens/images in de opslagplaats en vervolgens naar deze afbeeldingen verwijzen in het artikel. Afbeeldingen worden automatisch op volledige grootte weergegeven, wat betekent dat grote afbeeldingen de volledige breedte van het artikel vullen. U wordt aangeraden de grootte van uw afbeeldingen vooraf aan te passen voordat u ze uploadt. De aanbevolen breedte is tussen 600 en 700 pixels, maar u moet de grootte omhoog of omlaag aanpassen als het een compacte schermafbeelding of een fractie van een schermafbeelding is.

Belangrijk

U kunt afbeeldingen alleen uploaden naar uw geforkte opslagplaats voordat u ze samenvoegt. Als u dus van plan bent om afbeeldingen toe te voegen aan een artikel, moet u Visual Studio Code gebruiken om de afbeeldingen eerst toe te voegen aan de map 'afbeeldingen' van uw fork of om ervoor te zorgen dat u het volgende hebt gedaan in een webbrowser:

  1. Forked de MicrosoftDocs/hololens-opslagplaats.
  2. Het artikel in uw fork bewerkt.
  3. De afbeeldingen waarnaar u in uw artikel verwijst, zijn geüpload naar de map hololens/images in uw fork.
  4. Er is een pull-aanvraag gemaakt om uw fork samen te voegen in de Hoofd- branch van MicrosoftDocs/hololens .

Als u wilt weten hoe u uw eigen geforkte opslagplaats instelt, volgt u de instructies voor het maken van een nieuw artikel.

Een voorbeeld van uw werk bekijken

Tijdens het bewerken in GitHub via een webbrowser kunt u het tabblad Preview- boven aan de pagina selecteren om een voorbeeld van uw werk te bekijken voordat u het doorvoert.

Notitie

Een voorbeeld van uw wijzigingen in Microsoft Learn is alleen beschikbaar voor Microsoft-werknemers.

Microsoft-werknemers: Wanneer uw bijdragen zijn samengevoegd in de standaardbranch, hoofd-, kunt u de inhoud controleren voordat deze openbaar wordt gemaakt op </hololens?branch=main>. Zoek uw artikel met behulp van de inhoudsopgave in de linkerkolom.

Bewerken in de browser versus bewerken met een bureaubladclient

Bewerken in de browser is de eenvoudigste manier om snelle wijzigingen aan te brengen, maar er zijn enkele nadelen:

  • U krijgt geen spellingcontrole.
  • U krijgt geen slimme koppeling naar andere artikelen (u moet de bestandsnaam van het artikel handmatig typen).
  • Het kan lastig zijn om afbeeldingen te uploaden en ernaar te verwijzen.

Als u deze problemen liever niet wilt oplossen, gebruikt u een bureaubladclient zoals Visual Studio Code met een paar nuttige extensies bij het bijdragen.

Visual Studio Code gebruiken

Om de redenen die worden vermeld hierboven, kunt u liever een bureaubladclient gebruiken om documentatie te bewerken in plaats van een webbrowser. U wordt aangeraden Visual Studio Codete gebruiken.

Setup

Volg deze stappen om Visual Studio Code te configureren voor gebruik met deze opslagplaats:

  1. In een webbrowser:
    1. Installeer Git voor uw pc-.
    2. Installeer Visual Studio Code.
    3. Fork MicrosoftDocs/hololens als u dat nog niet hebt gedaan.
    4. Selecteer in uw fork Kloon of download en kopieer de URL.
  2. Maak een lokale kloon van uw fork in Visual Studio Code:
    1. Selecteer in het menu Weergaveopdrachtpalet.
    2. Typ 'Git: Klonen'.
    3. Plak de URL die u hebt gekopieerd.
    4. Kies waar u de kloon op uw pc wilt opslaan.
    5. Selecteer opslagplaats openen in het pop-upvenster.

Documentatie bewerken

Gebruik de volgende werkstroom om wijzigingen aan te brengen in de documentatie met Visual Studio Code:

Notitie

Alle richtlijnen voor bewerken van en het maken van artikelen, en de basisbeginselen van het bewerken van Markdown, zijn ook van toepassing bij het gebruik van Visual Studio Code.

  1. Zorg ervoor dat uw gekloonde fork up-to-date is met de officiële opslagplaats.

    1. Maak in een webbrowser een pull-aanvraag om recente wijzigingen van andere inzenders te synchroniseren in de standaardvertakking van MicrosoftDocs/hololens, hoofd-, naar uw fork (zorg ervoor dat de pijl naar de juiste bestemming verwijst).

      wijzigingen van MicrosoftDocs/hololens synchroniseren met uw fork.

    2. Selecteer in Visual Studio Code de synchronisatieknop om uw nieuw bijgewerkte fork te synchroniseren met de lokale kloon.

      Klik op de afbeelding van de synchronisatieknop.

  2. Artikelen in uw gekloonde opslagplaats maken of bewerken met Visual Studio Code.

    1. Bewerk een of meer artikelen (voeg indien nodig afbeeldingen toe aan de map 'images').

    2. wijzigingen opslaan in Explorer-.

      'Alles opslaan' kiezen in Verkenner

    3. alle wijzigingen doorvoeren in broncodebeheer (schrijf een doorvoerbericht wanneer hierom wordt gevraagd).

      Kies Alles doorvoeren in broncodebeheer

    4. Selecteer de knop synchroniseren om uw wijzigingen terug te synchroniseren naar oorsprong (uw fork op GitHub).

      Klik op de knop Synchroniseren.

  3. Maak in een webbrowser een pull-aanvraag om nieuwe wijzigingen in uw fork terug te synchroniseren naar MicrosoftDocs/hololens hoofd- (zorg ervoor dat de pijl naar de juiste bestemming verwijst).

    pull-aanvraag maken van uw fork naar MicrosoftDocs/hololens.

Nuttige extensies

De volgende Visual Studio Code-extensies zijn handig bij het bewerken van documentatie:

  • Docs Markdown-extensie voor Visual Studio Code - Gebruik Alt+M- om een menu weer te geven met ontwerpopties van Microsoft Learn, zoals:

    • Afbeeldingen zoeken en ernaar verwijzen die u hebt geüpload.
    • Voeg opmaak zoals lijsten, tabellen en bijschriften toe, zoals >[!NOTE].
    • Interne koppelingen en bladwijzers zoeken en ernaar verwijzen (koppelingen naar specifieke secties binnen een pagina).
    • Opmaakfouten zijn gemarkeerd (beweeg de muisaanwijzer over de fout voor meer informatie).
  • code spellingcontrole - verkeerd gespelde woorden worden onderstreept; Klik met de rechtermuisknop op een verkeerd gespeld woord om het te wijzigen of op te slaan in de woordenlijst.