Bendrinti naudojant

Vieningosios sąsajos programai skirto žinyno-vedlio kūrimas

  • Straipsnis

Naudodami pasirinktinio žinyno sritis ir interaktyviąsias užduotis, prie organizacijos poreikių pritaikykite savo vieningosios sąsajos programoje naudojamą žinyno aplinką. Naudoti tinkintos pagalbos juostas siekiant pateikti lentelę, formą ir kalbos konkrečią pagalbą bei gaires, kurios apima praturtintą tekstą, turinio nuorodas, paveikslėlius ir vaizdo nuorodas.

Svarbu

  • Pasirinktinio žinyno sritys pakeičia ankstesnę mokomosios medžiagos interaktyviojo žinyno funkciją, naudotą senose žiniatinklio kliento programose.
  • Pasirinktinės pagalbos sritys neveikia su vieningoji sąsaja programomis, veikiančiomis mobiliajame įrenginyje, pvz Android ., planšetiniuose iOS kompiuteriuose ir išmaniuosiuose telefonuose.

Pasirinktinio žinyno sritys ir mokomoji medžiaga

Naujas pasirinktinio žinyno sričių žinyno-vedlio diegimas skiriasi nuo ankstesnio mokomosios medžiagos žinyno-vedlio funkcijos. Abi funkcijos leidžia kurti savo programos pasirinktinį žinyną. Vis dėlto pasirinktinio žinyno sritys optimizuotos dažniausiai naudojamiems žinyno-vedlio scenarijams.

Toliau nurodytos pagrindinės pasirinktinio žinyno sričių ypatybės, kurios nėra būdingos mokomajai medžiagai.

  • Laisvos formos raiškusis tekstas, įskaitant ženklelius ir numeravimą.
  • Vizualiai susietos mokomosios žymos ir žinyno debesėliai.
  • Daugiau vaizdo įrašų šaltinių, įskaitant privačius šaltinius, parinkčių.
  • Žinyno turinio saugojimas paslaugoje „Microsoft Dataverse“ kaip sprendimo dalis.

Toliau nurodytos pagrindinės mokomosios medžiagos ypatybės, kurios nėra būdingos pasirinktinio žinyno sritims.

  • Nuosekliai pateikiami žinyno debesėliai.
  • Žinyno puslapiai kiekvienam vaidmeniui.
  • Žinyno puslapiai kiekvienam įrenginio formos koeficientui, pvz., išmaniesiems telefonams.

Būtinosios sąlygos

Norėdami naudoti pasirinktinę žinyno sričių funkciją, jums reikia šios aplinkos:

Aplinkos pasirinktinio žinyno sričių įjungimas

  1. Atidarykite modeliu pagrįstą programą, o tada komandų juostoje pasirinkite Parametrai Parametrai. > Išplėstiniai parametrai.

  2. Eikite į Parametrai > Sistema > Administravimas.

  3. Puslapyje Administracija pasirinkite Sistemos parametrai.

  4. Skirtuko Bendra dalyje Nustatyti pasirinktinio žinyno URL pasirinkite Taip kaip elemento Įjungti pasirinktinio žinyno sritis ir interaktyviąsias užduotis parinktį, tada pasirinkite Gerai.

    Pasirinktinių žinyno sričių įjungimas.

Svarbu

  • Galite įjungti pasirinktinio žinyno sritis arba tinkinamą žinyną, bet ne abu vienu metu. Patvirtinkite, kadNaudoti tinkintą pagalbą tinkinamoms lentelėms ir Pridėti parametrus prie URL yra abi nustatytos į Ne.
  • Kai kurios aplinkos taip pat reikalauja Jūsų perjungti Įjungti mokymosi kelią į Taip.

Būtinos teisės

  • Norėdami kurti žinyno sritis, programų kūrėjams reikia visuotinio kūrimo, skaitymo, rašymo, naikinimo, pridėti ir pridėti prie teisių žinyno puslapio lentelėje. Pagal numatytuosius parametrus ši teisė suteikita saugos vaidmenims Sistemos administratorius ir Sistemos pritaikymo specialistas.
  • Kad galėtų peržiūrėti programos žinyno sritis, vartotojams reikia skaitymo teisės žinyno puslapio lentelėje. Pagal numatytuosius žinyno puslapio vartotojo saugos vaidmuo turi šias teises. Pagal numatytuosius nustatymus pagrindinis vartotojas saugos vaidmuo neturi jokių teisių žinyno puslapio lentelėje.

Daugiau informacijos: Saugos vaidmenys ir teisės

Kontekstinis pasirinktinis žinynas

Kiekviena žinyno sritis unikali toliau nurodytuose kontekstuose.

  • Programa
  • Lentelė
  • Forma
  • Kalba

Naršymas žinyno srityje

Pagal numatytuosius parametrus žinyno sritis lieka atidaryta, o žinyno turinys, kurį pirmą atidarėte, lieka atidarytas, net kai pereinate į kitą formą. Taip užtikrinama, kad žinyno turinys liks nepaliestas, jums nukreipiant vartotojus į skirtingas programos dalis.

Žinyno srities turinio kūrimas

  1. Norėdami peržiūrėti žinyno sritį, atidarykite modeliu pagrįstą programą, tada komandų juostoje pasirinkite Žinynas.

    Žinyną.

  2. Žinyno srityje pažymėkite vertikalią elipsę, tada pasirinkite Redaguoti.

    Žinyno redagavimas.

    Dabar žinyno sritis rodoma redagavimo režimu, o žymeklis yra žinyno srities pavadinime.

  3. Redagavimo srityje galite atlikti toliau nurodytas užduotis.

    • Įvesti tekstą tiesiogiai rašydami žinyno srityje.
    • Formatuokite tekstą naudodami raiškiojo teksto funkcijas ir įtraukite ženklelių / sunumeruotus sąrašus, skyrius, vaizdo įrašus, vaizdus, saitus, mokomuosius ženklus ir žinyno debesėlius.

  4. Pasirinkite Įrašyti, kad įrašytumėte keitimus.

Laisvos formos tekstas

Tekstas gali būti bet kurioje žinyno srities vietoje. Liasvos formos tekstą įterpkite prieš skyrių, jame arba po skyriaus. Tekstui tinka paryškintojo, pasvirojo ir perbraukto šriftų formatai. Galima naudoti iškirpimo, kopijavimo ir įklijavimo funkcijas, taip pat daugiapakopį anuliavimą.

Ženkleliai ir numeruotieji sąrašai

Pasirinkus ženklelio arba numerio piktogramą, įjungiama dabartinė eilutė, kad ją būtų galima pažymėti ženkleliu arba numeruoti. Jei pažymėjote kelias eilutes sąraše, kiekviena eilutė pažymima ženkleliu arba numeruojama. Tabuliacija ir įtraukiamų antrinių numerių sulygiavimas sąraše.

Sekcijos

Skyrius yra sutraukiamas teksto laukas. Į jį galite įdėti saitų arba laisvos formos tekstą. Skyrių naudokite panašiems elementams grupuoti. Pagal numatytuosius parametrus skyrius gali būti atidarytas arba sutrauktas.

Vaizdo įrašai ir statiniai vaizdai

Į žinyno sritį galite įterpti vaizdo įrašų ir statinių vaizdų. Vaizdo įrašai ir vaizdai yra internete pateikiamo turinio saitai. Pasirinktinio žinyno srityse neišsaugomi vaizdo įrašai ir vaizdų failai. Kai žinyno sritis atidaryta, pasirinktinio žinyno srityse rodomas saito turinys. Jei norite pateikti nuorodą į privatų įmonės turinį, galite naudoti „Microsoft Stream“ vaizdo įrašo nuorodą.

Patarimas

Nepamirškite nukopijuoti vaizdo įrašo arba vaizdo saito URL, kad galėtumėte jį įklijuoti žinyno srityje.

Pasirinktinio žinyno sritims tinka toliau nurodyti vaizdo įrašų šaltiniai.

  • Microsoft Stream (Klasikinis) (naudojimas privačiam turiniui)
  • YouTube
  • Facebook
  • Vimeo

Saitai gali nukreipti į svetaines, jie gali būti atidaromi tame pačiame lange (numatytasis parametras) arba atskirame lange. Kol kas negalima susieti su esamu žinyno puslapiu.

Debesėliai ir mokomieji ženklai

Debesėliai ir mokomieji ženklai gali nurodyti konkrečius vartotojo sąsajos elementus. Debesėlyje gali būti teksto.

Įterpti debesėlį

Mokomasis ženklas paprasčiausiai paryškina elementą mokomąja rodykle, kad atkreiptų vartotojo dėmesį į tą UI elementą.

Įterpti mokomąjį ženklą

Autoriui reikia apibrėžti tikslą naudojant nuvilkimo galimybę debesėlių ir mokomųjų ženklų ypatybėse. Autorius gali įvesti mokomųjų ženklų pavadinimą ir aprašą.

Nuvilkti

Pastaba

  • Debesėliai ir mokomieji ženklai neveikia gerai su pasirinktiniais komponentais. Ši funkcija taikoma tik numatytiesiems vieningosios sąsajos UI komponentams.
  • Nuoseklūs žinyno debesėliai ir mokomieji ženklai kol kas nepalaikomi.

Sprendimų ir pasirinktinio žinyno srities turinys

Visas žinyno turinys saugomas žinyno puslapio komponente, esančiame „Dataverse“, kaip jūsų sprendimo dalis. Jums patraukus jūsų sprendimą iš vienos aplinkos į kitą, tokios kaip iš testo į gamybos, galite nustatyti, kad jūsų pagalbos eilutės būtų eksportuotos taip, kad būtų įtrauktos į sprendimą. Taip galite sinchronizuoti žinyno turinį su savo sprendimo funkcijomis, perkeldami jį į kitą aplinką. Kaip sprendimo dalis, pasirinktinio žinyno sritys palaiko visus standartinių sprendimo taikomųjų programų ciklo valdymo (ALM) funkcijas.

Turinio perkėlimas naudojant sprendimus

Pagal numatytuosius parametrus visi nauji žinyno puslapiai rodomi numatytajame sprendime. Jei norite turinį perkelti į kitą aplinką, prieš eksportuodami pirmiausia įtraukite esamus žinyno puslapius į nevaldomąjį sprendimą. Norėdami žinyno puslapį įtraukti į nevaldomąjį sprendimą, atlikite toliau nurodytus veiksmus.

  1. Prisijunkite prie „Power Apps“.
  2. Kairiojoje naršymo srityje pasirinkite Sprendimai. Jei elemento šoninio skydelio srityje nėra, pasirinkite …Daugiau ir pasirinkite norimą elementą.
  3. Atidarykite norimą nevaldomąjį sprendimą.
  4. Pasirinkite Įtraukti esamą komandų juostoje ir tuomet pasirinkitePagalbos puslapis.
  5. Pasirinkite pagalbos puslapius, kuriuos norite įtraukti ir tuomet pasirinkite Įtraukti. Daugiau informacijos: Sprendimų eksportavimas

Žinyno puslapio dokumentacijos automatizavimas

Galite sukurti atsarginę turinio kopiją šaltinio kodo valdymo sistemoje arba joje saugoti turinį. Taip pat žinyno srities turinyje galite naudoti dokumentacijos automatizavimo įrankius, pvz., vertimo įrankius ar tikrintuvus. Pasirinktinio žinyno srities duomenys saugomi tiesiogiai paslaugoje „Dataverse“, juos galima eksportuoti bei importuoti šiuo tikslu.

Pasirinktinio žinyno sritys palaiko pasirinktinį XML formatą. Šis formatas aprašytas toliau. Daugiau informacijos: Pasirinktinio žinyno XML aprašas

Kiekvienas žinyno puslapis eksportuojamas kaip atskiras failas.

Apie kontekstinio žinyno valdomąjį sprendimą

Pasirinktines žinyno sritis ir interaktyviųjų užduočių funkciją sudaro sprendimo komponentai, sudarantys kontekstinio žinyno valdomąjį sprendimą. Įrašų tinkinimas ar kūrimas naudojant lenteles už pasirinktinių žinyno sričių ribų ir interaktyviųjų užduočių funkcijos nepalaikomas.

Atkreipkite dėmesį, kad į kai kurias programas, pvz., „Dynamics 365 Sales“ ir „Dynamics 365 Service“, įtrauktos pirmojo paleidimo funkcijos, kurios kuriamos naudojant kontekstinio žinyno valdomąjį sprendimą. Pavyzdžiui, žinyno srities (msdyn_tour) ir pristatymo (msdyn_tour) lentelės yra naudojamos kuriant šias pirmojo paleidimo funkcijas. Šiuo metu pasirinktinės žinyno sritys ir interaktyvių užduočių funkcija nepalaiko šių pirmojo paleidimo funkcijų kūrimo.

Dažnai užduodami klausimai

Šiame skyriuje aptariami dažnai užduodami klausimai apie pasirinktinio žinyno puslapius.

Ar pasirinktinio žinyno puslapiai tokie patys kaip tinkinamojo žinyno?

Pasirinktinio žinyno sritys ir interaktyviosios užduotys yra parinktis sistemos parametrų skyriuje Nustatyti pasirinktinio žinyno URL. Pasirinktinio žinyno sritys ir interaktyviosios užduotys įgalina tinkinamą žinyno sritį, rodomą šalia vartotojo formos. Kitos parinktys šioje sistemos parametrų rinkinio pasirinktinio žinyno skyriuje yra tinkinamos žinyno funkcijos. Jos suteikia galimybę perrašyti numatytąjį programų žinyną ir pagalbos ieškančius organizacijos vartotojus nukreipti į kitą URL. Kitu atveju, galite užrašyti pagalbą labai tinkintai lentelei taip, kad galėtumėte geriau aprašyti savo darbo eigą.

Jei reikia daugiau informacijos apie tinkinamą žinyną žr. Tinkinimo žinyno įgalinimas ir naudojimas.

Kaip perkelti savo duomenis iš mokomosios medžiagos į pasirinktinio žinyno puslapius?

Mokomosios medžiagos žinyną sudaro dviejų tipų elementai: žinyno sritys ir nuosekliai pateikiami žinyno debesėliai. Nuosekliai pateikiamų žinyno debesėlių vietos tvirtai integruotos naudojant seno žiniatinklio kliento vartotojo sąsają ir neperduodamos į naujas pasirinktinio žinyno sritis.

Atsižvelgiant į tai, kiek teksto yra jūsų žinyne-vedlyje, galbūt lengviausia tiesiog nukopijuoti informaciją tiesiogiai iš mokomosios medžiagos vartotojo sąsajos į naują pasirinktinio žinyno srities vartotojo sąsają. Vis dėlto taip pat galite eksportuoti savo mokomosios medžiagos žinyno turinį. Paprasčiausias būdas tai padaryti yra eksportuoti turinį nuėjus į Mokomoji medžiaga > Turinio biblioteka > Lokalizuoti > Eksportuoti. Pasirinkite eilutes, kurias norite ir tada eksportuokite jas. Sukuriama po XLIFF failą kiekvienai žinyno sričiai ir interaktyviajai užduočiai. Tada naudokite viešai prieinamą XLIFF rengyklę arba XLIFF į HTML keitiklį, kad gautumėte turinį.

Pasirinktinio žinyno XML aprašas

Šiame skyriuje pateikiamas pasirinktinio žinyno XML aprašas.

PPHML

<pphml>
    <h1>FAQ</h1>
    <collapsible title="What is PPHML?">
        <p>PPHML is a domain specific language for help content. It is used to create help content that includes elements such as images, videos, balloons, coach marks, etc.</p>
    </collapsible>
    <collapsible title="What does PPHML stand for?">
        <p>PPHML stands for Power Platform Help Markup Language</p>
    </collapsible>
</pphml>

Aprašas ir naudojimas

Elementas <pphml> nurodo žinyno naršyklei, kad tai yra PPHML dokumentas.

<pphml> yra PPHML dokumento šakninis elementas.

Elementas <pphml> yra visų kitų PPHML elementų konteineris.

Pavadinimas

Žinyno puslapio pavadinimas.

<h1>This will be displayed at the top of the help page</h1>

Aprašas ir naudojimas

Elementas <h1> apibrėžia žinyno puslapio pavadinimą.

<h1> Tai turi būti pirmas elementas <pphml> viduje.

Vaizdas

Žinyno puslapio paveikslėlis.

<img src="smiley.gif" alt="Smiley face" title="Smiley face"/>

Aprašas ir naudojimas

Elementas <img> įdeda vaizdą žinyno puslapyje.

Atributai

  • src: nurodo vaizdo URL. Tai yra būtinas atributas.

  • title: nurodo pavadinimą, kuris rodomas su vaizdu, paprastai kaip patarimas laikant virš elemento.

  • alt: nurodo alternatyvų vaizdo tekstą. Šį tekstą naudoja ekrano skaitytuvai.

Vaizdo įrašas

Vaizdo įrašas žinyno puslapyje.

<video src="https://www.youtube.com/watch?v=WSWmn7WM3i4" />

Aprašas ir naudojimas

Elementas <video> įdeda vaizdo įrašą, pvz., mokymo priemonę arba mokomąjį filmą, žinyno puslapyje.

Palaikomi šaltiniai
  • Microsoft Stream
  • YouTube
  • Facebook
  • Vimeo

Atributai

  • src: nurodo vaizdo įrašo URL. Tai yra būtinas atributas.

  • allowFullScreen: nurodo, ar vartotojas gali įjungti vaizdo įrašą per visą ekraną. Galimos reikšmės yra TRUE arba FALSE. Šis atributas nepalaiko visų vaizdo įrašų šaltinių.

  • autoplay: nurodo, kad vaizdo įrašas bus paleistas iš karto, kai tik bus įkeltas pagalbos puslapis. Galimos reikšmės yra TRUE arba FALSE. Šis atributas nepalaiko visų vaizdo įrašų šaltinių.

  • startTime: nurodo, nuo kurios sekundės bus paleistas vaizdo įrašas.

Pastraipa

Pastraipa žinyno puslapyje.

<p>This is some text in a paragraph.</p>

Aprašas ir naudojimas

Elementas <p> apibrėžia pastraipą.

Pastraipos tekstą galima papuošti toliau nurodytais būdais.

  • Paryškinti (su <strong> elementu)
  • Pasviruoju šriftu (su <em> elementu)
  • Perbraukti (su <del>elementu)
  • Pabraukti (su <u> elementu)

Šie papuošimai gali būti derinami. Pavyzdžiui, teksto fragmentas gali būti paryškintas ir pabrauktas.

Sąrašas su ženkleliais

Sąrašas su ženkleliais žinyno puslapyje.

<ul>
    <li>Coffee</li>
    <li>Tea</li>
    <li>Milk</li>
</ul>

Aprašas ir naudojimas

<ul> Elementas apibrėžia sąrašą su ženkleliais.

Norėdami kurti sąrašus su ženkleliais, elementą <ul> naudokite su elementu <li>.

Sunumeruotas sąrašas

Sunumeruotas sąrašas žinyno puslapyje.

<ol>
    <li>First step</li>
    <li>Second step</li>
    <li>Third step</li>
</ol>

Aprašas ir naudojimas

Elementas <ol> apibrėžia rūšiuotą (sunumeruotą) sąrašą. Norėdami kurti sunumeruotus sąrašus, žymę <ol> naudokite su elementu <li>.

Sutraukiamas

Sutraukiamas skyrius žinyno puslapyje.

<collapsible title="This is a Section">
    <p>This is a paragraph inside a section</p>
    <img src=smiley.gif" title="This is an image inside a section" />
</collapsible>

Aprašas ir naudojimas

Elementas <collapsible> apibrėžia turinio skyrių, kurį vartotojas gali peržiūrėti arba paslėpti pareikalavęs.

Atributai

  • collapsed: nurodo, ar skyrius iš pradžių yra sutrauktas, ar išplėstas. Galimos reikšmės yra TRUE (sutrauktas) arba FALSE (išplėstas).

Saitas žinyno puslapyje.

Susiekite su svetaine, atidaroma naujame naršyklės lange.

<a href="https://www.microsoft.com" target="_blank">Microsoft Home Page</a>

Saitas su kitu žinyno puslapiu

<a href="./LearnMore">Learn More</a>

Aprašas ir naudojimas

<a> žyma apibrėžia saitą, kuris leidžia vartotojui pereiti iš žinyno puslapio į svetainę arba į kitą žinyno puslapį.

Atributai

  • href: nurodo svetainės arba žinyno puslapio URL, į kurį bus pereinama. Tai yra būtinas atributas.
  • target: nurodo, kur atidaryti susietą URL.
    • Jei nėra arba naudojamas _self, manoma, kad tai yra kito žinyno puslapio saitas, ir jis bus atidarytas žinyno naršyklėje.
    • Jei naudojama _blank, saitas atidaromas naujame naršyklės lange.
    • Jei naudojama _top, saitas atidaromas dabartiniame naršyklės lange.
    • Jei reikšmė yra iframe pavadinimas, saitas atidaromas tame „iframe“.

Mokomasis ženklas

Mokomasis ženklas žinyno puslapyje.

<coachmark target="#my-html-button">Click to highlight the HTML element with id [my-html-button]</coachmark>

Aprašas ir naudojimas

Mokomasis ženklas – tai interaktyvusis elementas, kurį galima naudoti norint atkreipti vartotojo dėmesį į tam tikrą programos, kuri priglobia žinyno naršyklę, vartotojo sąsajos elementą.

Atributai

  • target: CSS parinkiklis, nurodantis HTML elementą, virš kurio bus rodomas mokomasis ženklas. Tai yra būtinas atributas.

Debesėlis

Debesėlis žinyno puslapyje.

<balloon target="#my-html-button" title="This button submits the form" details="Please click this button to continue and submit the form">Click to show a balloon over the HTML element with id [my-html-button]</balloon>

Aprašas ir naudojimas

Debesėlis – tai interaktyvusis elementas, kurį galima naudoti norint padėti vartotojui atlikti tam tikrą veiksmą programos, kuri priglobia žinyno naršyklę, vartotojo sąsajoje.

Atributai

  • target: CSS parinkiklis, nurodantis HTML elementą, virš kurio bus rodomas debesėlio saitas. Tai yra būtinas atributas.
  • title: nurodo debesėlio pavadinimą.
  • details: nurodo turinį, kuris bus rodomas debesėlio viduje.

Pastaba

Ar galite mums pranešti apie dokumentacijos kalbos nuostatas? Atlikite trumpą apklausą. (atkreipkite dėmesį, kad ši apklausa yra anglų kalba)

Apklausą atliksite per maždaug septynias minutes. Asmeniniai duomenys nėra renkami (privatumo nuostatos).