Közreműködés a HoloLens dokumentációjában
Üdvözöljük a HoloLens dokumentációjában! Az adattárban létrehozott vagy szerkesztett cikkek a nyilvánosság számára is láthatók lesznek.
A HoloLens dokumentációja közzé van téve a Microsoft Learnben, amely a GitHub-stílusú Markdownt használja Markdig-funkciókkal. Az adattárban szerkesztett tartalom stilizált oldalakká lesz formázva, amelyek megjelennek /hololens
.
Ez az oldal a Markdown alapszintű lépéseit és útmutatóit, valamint a Markdown alapjaira mutató hivatkozásokat ismerteti. Köszönjük a közreműködését!
Adattár neve | URL-cím |
---|---|
HoloLens | MicrosoftDocs/HoloLens |
Vegyes valóság | MicrosoftDocs/mixed-reality |
VR-rajongók útmutatója | MicrosoftDocs/mixed-reality/fan-guide |
Ha még nem rendelkezik ilyen fiókkal, kell létrehoznia egy GitHub-fiókot.
Megjegyzés
Ha Ön Microsoft-alkalmazott, csatolja GitHub-fiókját a Microsoft-aliasához a Microsoft Nyílt forráskódú portál. Csatlakozzon a "Microsoft" és "MicrosoftDocs" szervezetekhez.
A GitHub-fiók beállításakor az alábbi biztonsági óvintézkedéseket is javasoljuk:
- Hozzon létre egy erős jelszót a GitHub-fiókhoz.
- Engedélyezze kéttényezős hitelesítést.
- Mentse a helyreállítási kódokat biztonságos helyre.
- Frissítse a nyilvános profil beállításait.
- Adja meg a nevét, és fontolja meg a nyilvános e-mail- beállítását Ne jelenjen meg az e-mail-címem.
- Javasoljuk, hogy töltsön fel egy profilképet, mert egy miniatűr jelenik meg a Microsoft Learn-cikkekben, amelyekben ön közreműködik.
- Ha a parancssort szeretné használni, fontolja meg Git Credential Manager windowsosbeállítását. Így nem kell minden alkalommal megadnia a jelszavát, amikor hozzájárul.
A közzétételi rendszer a GitHubhoz van kötve, ezért ezek a lépések fontosak. A GitHub-alias használatával minden cikk szerzőjeként vagy közreműködőjeként fog szerepelni.
Az alábbi munkafolyamat segítségével frissíthet egy meglévő cikk , a GitHubon keresztül egy webböngészőben:
Lépjen a szerkeszteni kívánt cikkre a "hololens" mappában.
Válassza a szerkesztés gombot (ceruza ikon) a jobb felső sarokban.
Ez automatikusan elágaztat egy eldobható ágat az alapértelmezett ágról, fő.
Szerkessze a cikk tartalmát a Markdown alapjaiszerint.
Frissítse a metaadatokat az egyes cikkek tetején:
- cím: A cikk megtekintésekor a böngészőlapon megjelenő lap címe. Az oldalcímek a keresőoptimalizáláshoz és az indexeléshez használatosak, ezért csak akkor módosítsa a címet, ha szükséges (bár ez kevésbé kritikus fontosságú, mielőtt a dokumentáció nyilvánosságra kerül).
- leírás: Írjon rövid leírást a cikk tartalmáról, amely fokozza a keresőoptimalizálást és a felderítést.
- szerző: Ha Ön az oldal elsődleges tulajdonosa, itt adja hozzá a GitHub-aliast.
- ms.author: Ha Ön az oldal elsődleges tulajdonosa, itt adja hozzá a Microsoft-aliast (nincs szüksége @microsoft.com, csak az aliasra).
- ms.date: Frissítse a dátumot, ha jelentős tartalmat ad hozzá a laphoz, de nem a javításokhoz, például a pontosításhoz, a formázáshoz, a nyelvhelyességhez vagy a helyesíráshoz.
- kulcsszavak: Kulcsszavak támogatás SEO (keresőmotor-optimalizálás). Adjon hozzá a cikkre jellemző kulcsszavakat vesszővel és szóközzel elválasztva, de írásjelek nélkül a lista utolsó kulcsszója után. Nem kell olyan globális kulcsszavakat hozzáadnia, amelyek az összes cikkre vonatkoznak, mivel azokat máshol kezelik.
Ha befejezte a cikk szerkesztését, görgessen le, és válassza Fájlmódosítási javaslatlehetőséget.
A következő lapon válassza a Lekéréses kérelem létrehozása lehetőséget az automatikusan létrehozott ág alapértelmezett ágba való egyesítéséhez, fő.
Ismételje meg a fenti lépéseket a szerkeszteni kívánt következő cikkhez.
Ha a módosítás átnevez vagy töröl egy meglévő cikket, mindenképpen adjon hozzá átirányítást. Így a meglévő cikkre mutató hivatkozásokkal rendelkezők továbbra is a megfelelő helyen fognak végezni. Az átirányításokat az adattár gyökerében található .openpublishing.redirection.json fájl kezeli.
Ha átirányítást szeretne hozzáadni .openpublishing.redirection.json, adjon hozzá egy bejegyzést a redirections
tömbhöz:
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
A
source_path
az eltávolítandó régi cikk relatív adattárának elérési útja. Győződjön meg arról, hogy az elérési út a dokumentumkészlettel (ebben az esetbenhololens
) kezdődik, és tartalmazza a.md
fájlkiterjesztést.A
redirect_url
a régi cikk és az új cikk relatív nyilvános URL-címe. Győződjön meg arról, hogy ez az URL-nem tartalmaz.md
, és/
kezdődik, mivel a nyilvános URL-címre hivatkozik, nem pedig az adattár elérési útjának. Az új cikk egy szakaszára való hivatkozás#section
használatával engedélyezett. Szükség esetén egy másik webhely abszolút elérési útját is használhatja.redirect_document_id
jelzi, hogy meg szeretné-e tartani a dokumentumazonosítót az előző fájlból. Az alapértelmezett érték afalse
. Atrue
akkor használja, ha meg szeretné őrizni az átirányított cikkms.documentid
attribútumértékét. Ha megőrzi a dokumentumazonosítót, az adatok, például a lapmegtekintések és a rangsorolások átkerülnek a célcikkbe. Ezt akkor tegye, ha az átirányítás elsősorban átnevezés, és nem egy olyan cikkre mutató mutató, amely csak bizonyos tartalmakat fed le.
Ha átirányítást ad hozzá, mindenképpen törölje a régi fájlt is.
Az alábbi munkafolyamattal új cikkeket létrehozni a dokumentáció adattárában a GitHubon keresztül egy webböngészőben:
Hozzon létre egy elágaztatást a MicrosoftDocs/hololens alapértelmezett ágáról, főa jobb felső sarokban található Elágaztatás gombbal.
A "hololens" mappában válassza a jobb felső sarokban található Új fájl létrehozása lehetőséget.
Hozzon létre egy lapnevet a cikkhez (szóközök helyett használjon kötőjeleket, és ne használjon írásjeleket vagy aposztrófokat), és fűzze hozzá a ".md" szöveget
Fontos
Győződjön meg arról, hogy az új cikket a "hololens" mappában hozza létre. Ezt az új fájlnévsor "/hololens/" elemének bejelölésével ellenőrizheti.
Az új oldal tetején adja hozzá a következő metaadat-blokkot:
--- title: description: author: ms.author: ms.date: ms.topic: article keywords: ---
Töltse ki a megfelelő metaadatmezőket a Meglévő cikk szerkesztésecímű cikkben leírtak szerint.
Cikktartalom írása Markdown-alapismeretekhasználatával.
Adjon hozzá egy
## See also
szakaszt a cikk alján, amely más releváns cikkekre mutató hivatkozásokat tartalmaz.Ha végzett, válassza Új fájl véglegesítéselehetőséget.
Válassza az Új lekéréses kérelem lehetőséget, és egyesítse az elágaztatás fő ágát a MicrosoftDocs/hololens fő (győződjön meg arról, hogy a nyíl a megfelelő célhelyre mutat).
Az alábbi források segítségével megtudhatja, hogyan szerkesztheti a dokumentációt a Markdown nyelv használatával:
- Markdown alapjai
- [További források Markdown-írásához
A Microsoft Learnben a táblázatok stílusának köszönhetően nem lesznek szegélyek vagy egyéni stílusok, még akkor sem, ha beágyazott CSS-t próbál meg. Úgy tűnik, hogy rövid ideig működik, de végül a platform eltávolítja a stílust az asztalról. Tervezze meg előre, és tartsa egyszerűnek a táblázatokat. Az alábbi webhely megkönnyíti a Markdown-táblák használatát: [Tables Generator]](https://www.tablesgenerator.com/markdown_tables).
A Docs Markdown-bővítmény a Visual Studio Code-hoz megkönnyíti a táblakészítést is, ha Visual Studio Code-ot használ (lásd alább) a dokumentáció szerkesztéséhez.
A képeket fel kell töltenie az adattár "hololens/images" mappájába, majd a cikkben megfelelően hivatkoznia kell rájuk. A képek automatikusan teljes méretben jelennek meg, ami azt jelenti, hogy a nagyméretű képek kitöltik a cikk teljes szélességét. A képek feltöltése előtt javasoljuk a képek előzetes méretezését. Az ajánlott szélesség 600 és 700 képpont között van, de felfelé vagy lefelé kell méreteznie, ha sűrű képernyőképről van szó, vagy egy képernyőkép töredékéről van szó.
Fontos
Az egyesítés előtt csak képeket tölthet fel az elágaztatott adattárba. Ha tehát képeket szeretne hozzáadni egy cikkhez, a Visual Studio Code kell használnia a képek hozzáadásához az elágazás "képek" mappájába, vagy győződjön meg arról, hogy a következőket tette egy webböngészőben:
- Elágazott a MicrosoftDocs/hololens adattár.
- Szerkesztette a cikket az elágazásban.
- Feltöltötte a cikkben hivatkozott képeket a "hololens/images" mappába az elágaztatásban.
- Létrehozott egy lekéréses kérelmet, amely egyesíti az elágaztatást a MicrosoftDocs/hololens fő ágával.
Ha meg szeretné tudni, hogyan állíthatja be saját elágazott adattárát, kövesse új cikklétrehozásához szükséges utasításokat.
Amikor a GitHubon webböngészőn keresztül szerkeszt, a Lap tetején található Előnézet fület választva megtekintheti a munkáját a véglegesítés előtt.
Megjegyzés
A Microsoft Learn módosításainak előnézete csak a Microsoft alkalmazottai számára érhető el.
Microsoft-alkalmazottak: Ha a hozzájárulásokat az alapértelmezett ágba egyesítették, fő, a tartalmat a </hololens?branch=main>címen tekintheti át. Keresse meg a cikket a bal oldali oszlopban található tartalomjegyzék használatával.
A gyors módosítások legegyszerűbb módja a böngészőben történő szerkesztés, azonban van néhány hátránya:
- Nem kap helyesírás-ellenőrzést.
- Nem kap intelligens csatolást más cikkekhez (manuálisan kell beírnia a cikk fájlnevét).
- A képek feltöltése és hivatkozása nehézkes lehet.
Ha inkább nem szeretné kezelni ezeket a problémákat, használjon asztali ügyfelet, például Visual Studio Code néhány hasznos bővítményt közreműködéskor.
A fenti okból inkább asztali ügyféllel szerkesztheti a dokumentációt böngésző helyett. Javasoljuk Visual Studio Codehasználatát.
Az alábbi lépéseket követve konfigurálhatja a Visual Studio Code-ot az adattár használatához:
- Webböngészőben:
- Telepítse Gitet pc-.
- Telepítse Visual Studio Code.
- Fork MicrosoftDocs/hololens, ha még nem tette meg.
- Az elágazásban válassza Klónozás vagy letöltés és másolja az URL-címet.
- Hozzon létre egy helyi klónt az elágazásról a Visual Studio Code-ban:
- A Nézet menüben válassza Parancskatalóguslehetőséget.
- Írja be a "Git: Clone" kifejezést.
- Illessze be a másolt URL-címet.
- Adja meg, hogy hová szeretné menteni a klónt a pc-n.
- Válassza Az adattár megnyitása lehetőséget az előugró ablakban.
Az alábbi munkafolyamattal módosíthatja a dokumentációt a Visual Studio Code-ban:
Megjegyzés
A
Győződjön meg arról, hogy a klónozott elágazás naprakész a hivatalos adattárral.
Egy webböngészőben hozzon létre egy lekéréses kérelmet, amely szinkronizálja a MicrosoftDocs/hololens alapértelmezett ágában lévő többi közreműködő legutóbbi módosításait, főaz elágaztatásra (győződjön meg arról, hogy a nyíl a megfelelő célhelyre mutat).
A Visual Studio Code-ban válassza a szinkronizálás gombot a frissen frissített elágazás helyi klónra való szinkronizálásához.
Hozzon létre vagy szerkessze a cikkeket a klónozott adattárban a Visual Studio Code használatával.
Szerkeszthet egy vagy több cikket (szükség esetén képeket adhat hozzá a "képek" mappához).
Explorer módosításainak mentése.
Véglegesítse Forrásvezérlő módosításait (amikor a rendszer kéri, írjon véglegesítési üzenetet).
Válassza a szinkronizálási gombot a módosítások forrásra való szinkronizálásához (az elágaztatás a GitHubon).
Webböngészőben hozzon létre egy lekéréses kérelmet, amely az elágaztatás új módosításait szinkronizálja a MicrosoftDocs/hololens fő (győződjön meg arról, hogy a nyíl a megfelelő célhelyre mutat).
A dokumentáció szerkesztésekor a következő Visual Studio Code-bővítmények hasznosak:
Visual Studio Code-hoz készült Docs Markdown-bővítmény – Az Alt+M használatával a Microsoft Learn szerkesztési lehetőségeinek menüje a következőhöz hasonló:
- Keressen és hivatkozzon a feltöltött képekre.
- Olyan formázásokat adhat hozzá, mint a listák, táblák és kihívások, például
>[!NOTE]
. - Belső hivatkozások és könyvjelzők keresése és hivatkozása (az oldal adott szakaszaira mutató hivatkozások).
- A formázási hibák ki vannak emelve (további információért vigye az egérmutatót a hiba fölé).
Kód helyesírás-ellenőrző – a hibásan írt szavak alá lesznek húzva; Kattintson a jobb gombbal egy hibásan írt szóra a módosításhoz vagy a szótárba való mentéshez.