Udostępnij za pośrednictwem

Utwórz zawartość pomocy z przewodnikiem dla aplikacji Ujednolicony interfejs

  • Artykuł

Korzystaj z niestandardowych okienek pomocy i zadań nadzorowanych w celu nadania aplikacji Ujednolicony interfejs niestandardowej pomocy w produkcie, która jest dostosowana do potrzeb organizacji użytkownika. Użyj niestandardowych okienek pomocy, aby zapewnić pomoc dotyczącą tabel, formularzy i języków oraz wskazówki dotyczące tekstu sformatowanego, linków do zawartości, obrazów i linków do wideo.

Ważne

  • Niestandardowe okienka pomocy zastępują poprzednią funkcję pomocy z przewodnikiem po ścieżce szkoleniowej używaną ze starszymi aplikacjami klienckimi sieci Web.
  • Niestandardowe okienka pomocy nie działają z aplikacjami z ujednoliconym interfejsem działającymi na urządzeniu mobilnym, takim jak tablety i smartfony z systemem Android i iOS.

Niestandardowe okienka pomocy i ścieżka szkoleniowa

Nowa implementacja pomocy nadzorowanej niestandardowych okienek pomocy jest inna niż poprzednia funkcja pomocy z przewodnikiem poprzedniej ścieżki szkoleniowej. Obie funkcje umożliwiają tworzenie niestandardowej pomocy dla aplikacji. Niestandardowe okienka pomocy można jednak zoptymalizować dla najpopularniejszych scenariuszy pomocy z przewodnikiem.

Niestandardowe okienka pomocy umożliwiają uzyskanie następujących podstawowych funkcji, które nie są dostępne z użyciem ścieżki szkoleniowej:

  • Swobodny tekst sformatowany, w tym punktory i numeracja.
  • W widoczny sposób połączone wskazówki i dymki pomocy.
  • Więcej opcji dotyczących źródeł wideo, w tym prywatnych źródeł.
  • Przechowywanie treści pomocy w Microsoft Dataverse w ramach rozwiązania.

Niestandardowe okienka pomocy nie zapewniają następujących podstawowych funkcji, które są dostępne z użyciem ścieżki szkoleniowej:

  • Dymki pomocy sekwencyjnej
  • Strony pomocy dla poszczególnych ról.
  • Strony pomocy dla kształtu poszczególnych urządzeń, na przykład smartfonów.

Wymagania wstępne

Aby można było korzystać z funkcji niestandardowych okienek pomocy, środowisko potrzebuje następujących czynności:

Włącz niestandardowe okienka pomocy dla środowiska

  1. Otwórz aplikację oparte na modelu, a następnie na pasku poleceń wybierz pozycję Ustawienia Ustawienia. > Ustawienia zaawansowane.

  2. Przejdź do Ustawienia > System > Administracja.

  3. Na stronie Administracja wybierz Ustawienia systemu.

  4. Na karcie Ogólne w obszarze Ustaw adres URL pomocy niestandardowej wybierz Tak dla Włącz niestandardowe okienka pomocy i zadania nadzorowane, a następnie wybierz OK.

    Włącz niestandardowe okienka pomocy.

Ważne

  • Można włączyć niestandardowe okienka pomocy lub konfigurowalną pomoc, ale nie obie te funkcje jednocześnie. Upewnij się, że opcje Użyj niestandardowej pomocy dla tabeli, które można dostosować i Dołącz parametry do adresu URL są ustawione na Nie.
  • W niektórych środowiskach może być konieczne ustawienie opcji Włącz ścieżkę szkoleniową na Tak.

Wymagane uprawnienia

  • Aby móc tworzyć panele pomocy, twórcy aplikacji potrzebują globalnych uprawnień do tworzenia, odczytu, zapisu, usuwania, dołączania i dołączania do tabeli Strona pomocy. Domyślnie role zabezpieczeń Administrator systemu i Konfigurator systemu zawierają to uprawnienie.
  • Aby wyświetlić okienka Pomocy w aplikacji, użytkownicy muszą mieć uprawnienie do odczytu w tabeli strony pomocy. Domyślnie, rola zabezpieczeń Konsument strony pomocy ma to uprawnienie. Domyślnie rola zabezpieczenia Użytkownik podstawowy nie ma żadnych uprawnień w tabeli Strona pomocy.

Więcej informacji: Role zabezpieczeń i uprawnienia

Pomoc niestandardowa z uwzględnieniem kontekstu

Każde okienko pomocy jest unikatowe w następujących kontekstach:

  • Aplikacja
  • Tabela
  • Formularz
  • Język

Nawigacja po okienku pomocy

Domyślnie okienko pomocy pozostaje otwarte i znajduje się w zawartości pomocy, która została wcześniej otwarta, nawet po przejściu do innego formularza. Dzięki temu zawartość pomocy może pozostawać nienaruszona podczas kierowania użytkowników do różnych obszarów aplikacji.

Aby utworzyć zawartość okienka pomocy

  1. Aby wyświetlić okienko pomocy, otwórz aplikację oparta na modelu, a następnie na pasku poleceń wybierz Pomoc.

    Menu Pomoc.

  2. W okienku pomocy wybierz pionowy wielokropek, a następnie wybierz Edytuj.

    Edytowanie pomocy.

    Okienko pomocy jest teraz w trybie edycji a kursor jest umieszczony na tytule okienka pomocy.

  3. Z okienka pomocy można wykonać następujące zadania:

    • Wprowadź tekst, wpisując go bezpośrednio w obszarze okienka pomocy.
    • Formatowanie tekstu przy użyciu funkcji tekstu sformatowanego i dodanie punktowanych/numerowanych list, sekcji, filmów wideo, obrazów, łączy, znaków tekstowych i pomocy w dymkach.

  4. Aby zapisać zmiany, wybierz Zapisz.

Tekst w dowolnej postaci

Tekst może być umieszczany w dowolnym miejscu w okienku pomocy. Wprowadź tekst w dowolnej postaci przed, w lub za sekcją. W tekście są obsługiwane formaty czcionek pogrubionych, kursywy, podkreślania i przekreślenia. Można używać wycinania, kopiowania i wklejania oraz wielopoziomowych cofnięć.

Punktory i listy numerowane

Wybranie ikony z punktorem lub numerem powoduje przełączenie bieżącego wiersza na punktory lub numerację. W przypadku wybrania wielu wierszy na liście każdy wiersz zostanie wypunktowany lub oznaczony numerem. Liczby podrzędne wcinania i wcinania są wyrównane na liście.

Sekcje

Sekcja jest zwijanym polem tekstowym. W tym celu można umieścić w nim łącza lub tekst o dowolnej postaci. Użyj sekcji w celu zgrupowania podobnych elementów. Domyślnie sekcja może być otwierana lub zwijana.

Obrazy wideo i statyczne

Filmy wideo i statyczne obrazy można wstawiać do okienka pomocy. Filmy wideo i obrazy są łączami do treści w Internecie. Niestandardowe okienka pomocy nie przechowują plików wideo i obrazów w okienku pomocy. Po otwarciu okienka pomocy niestandardowe okienka pomocy umożliwiają wyświetlenie zawartości z poziomu łącza w celu jej wyświetlenia. Można użyć łącza do filmu wideo Microsoft Stream, aby sie odwołać do firmowej zawartości prywatnej.

Porada

Należy pamiętać o skopiowaniu adresu URL łącza filmu lub obrazu, aby można go było wkleić do okienka pomocy.

Niestandardowe okienka pomocy obsługują następujące źródła wideo:

  • Microsoft Stream (wersja klasyczna) (używanie na potrzeby zawartości prywatnej)
  • YouTube
  • Facebook
  • Vimeo

Łącza mogą być witrynami sieci Web i otwierają sie w tym samym oknie (domyślnie) lub otwierają się w oddzielnym oknie. Nie jest jeszcze dostępna możliwość łączenia z istniejącą stroną pomocy.

Dymki i wskazówki

Dymki i wskazówki mogą być używane do wskazywania poszczególnych elementów interfejsu użytkownika. W dymku może się znajdować tekst.

Wstaw dymek

Znak formatki po prostu podkreśla element za pomocą wskaźnika formatki, aby zwrócić uwagę użytkownika na ten element interfejsu użytkownika.

Wstaw znaki szkoleniowe

Autor musi zdefiniować cel za pomocą przeciągania i upuszczania we właściwościach dymków i znaków szkoleniowych. Autor może wprowadzić tekst dla tytułu i opisu znaków szkoleniowych.

Przeciągnij i upuść

Uwaga

  • Dymki i znaki szkoleniowe nie działają dobrze z składnikami niestandardowymi. Ta funkcja ma zastosowanie tylko w przypadku domyślnych ujednoliconych interfejsów interfejsu użytkownika.
  • Nie są jeszcze obsługiwane kolejne dymki pomocy i znaki szkoleniowe.

Rozwiązania i Niestandardowa zawartość okienka pomocy

Cała zawartość pomocy jest przechowywana w składniku strony pomocy w Dataverse w ramach rozwiązania. W przypadku przeniesienia rozwiązania z jednego środowiska do innego, na przykład z testowania do produkcji, można zdefiniować wiersze pomocy do eksportowania tak, aby zostały uwzględnione w rozwiązaniu. Dzięki temu użytkownik może utrzymywać zawartość pomocy zsynchronizowaną z funkcjami rozwiązania podczas jego przemieszczania do różnych środowisk. W ramach rozwiązania niestandardowe okienka pomocy obsługują wszystkie standardowe funkcje zarządzania zasadami cyklu aplikacji (ALM) dotyczące rozwiązania.

Przenoszenie zawartości za pomocą rozwiązań

Domyślnie wszystkie nowe strony pomocy będą wyświetlane w rozwiązaniu domyślnym. Aby przenieść zawartość do innego środowiska, należy najpierw dodać istniejące strony pomocy do rozwiązania niezarządzanego przed wyeksportowaniem ich. Aby dodać stronę pomocy do rozwiązania niezarządzanego, wykonaj następujące kroki:

  1. Zaloguj się w Power Apps.
  2. W lewym okienku nawigacji, wybierz Rozwiązania. Jeśli elementu nie ma w okienku panelu bocznego, wybierz …Więcej, a następnie wybierz żądany element.
  3. Otwórz wybrane rozwiązanie niezarządzane.
  4. Wybierz opcję Dodaj istniejące na pasku poleceń, a następnie wybierz Stronę pomocy.
  5. Wybierz stronę pomocy, który chcesz dodać, a następnie wybierz Dodaj. Więcej informacji: Eksportowanie rozwiązań.

Automatyzacja dokumentacji strony pomocy

Użytkownik może chcieć utworzyć kopię zapasową lub przechowywać zawartość w systemie kontroli kodu źródłowego. W tym celu można także użyć narzędzi do automatyzacji dokumentacji, takich jak narzędzia do tłumaczenia lub kontrolery, w okienku pomocy. Niestandardowe okienka pomocy są przechowywane bezpośrednio w Dataverse i mogą być eksportowane i importowane w tym celu.

Niestandardowe okienka pomocy obsługują niestandardowy format XML. Ten format jest udokumentowany poniżej. Więcej informacji: Niestandardowa definicja kodu XML pomocy

Podczas eksportowaniu każda strona pomocy jest eksportowana jako oddzielny plik.

O rozwiązaniu zarządzanym Pomoc kontekstowa

Funkcja niestandardowych paneli pomocy i zadań kierowanych składa się z komponentów rozwiązania zarządzanego Pomoc kontekstowa. Dostosowywanie lub tworzenie rekordów przy użyciu tabel poza niestandardowymi panelami pomocy i funkcjami zadań kierowanych nie jest obsługiwane.

Zauważ, że niektóre aplikacje, takie jak Dynamics 365 Sales i Dynamics 365 Service, zawierają doświadczenia pierwszego uruchomienia, które są budowane przy użyciu tabel zawartych w rozwiązaniu zarządzanym Pomoc kontekstowa. Na przykład zarówno tabela Strona pomocy (msdyn_helppage), jak i Podróż (msdyn_tour) są używane podczas tworzenia tych doświadczeń pierwszego przejazdu. Obecnie funkcja niestandardowych paneli pomocy i zadań z przewodnikiem nie obsługuje tworzenia takich doświadczeń pierwszego uruchomienia.

Często zadawane pytania

W tej sekcji opisano często zadawane pytania na temat niestandardowych stron pomocy.

Czy niestandardowe strony pomocy są takie same, jak pomoc, którą można dostosować?

Niestandardowe okienka pomocy i zadania nadzorowane są opcją w sekcji Ustaw adres URL w ustawieniach systemu. Niestandardowe okienka pomocy i zadania nadzorowane zapewniają dostosowywany panel pomocy, który jest wyświetlany obok formularza użytkownika. Pozostałe opcje dostępne w obszarze Ustawienia systemu są ustawiane w sekcji niestandardowej pomocy, które składają się z dostosowywalnych funkcji pomocy. Pozwalają zastąpić domyślną Pomoc aplikacji i skierować użytkowników w organizacji do innego adresu URL, aby tam uzyskali oni pomoc. Alternatywnie można zastąpić pomoc dla wysoce spersonalizowanej tabeli, aby można było lepiej opisywać przepływ pracy.

Aby uzyskać więcej informacji na temat konfigurowalnej pomocy, zobacz Włącz pomoc, którą można dostosowywać, i korzystaj z niej.

Jak migrować dane z ścieżki szkoleniowej do niestandardowych stron pomocy?

Ścieżka szkoleniowa zawiera dwa typy pomocy: okienka pomocy i dymki pomocy sekwencyjnej. Lokalizacje w dymkach pomocy są głęboko zintegrowane z interfejsem użytkownika starszych klientów sieci Web i nie przekładają się na nowe niestandardowe okienka pomocy.

W zależności od ilości tekstu w pomocy nadzorowanej najłatwiejszym sposobem może być skopiowanie informacji bezpośrednio z interfejsu użytkownika ścieżki szkoleniowej do nowego interfejsu użytkownika niestandardowego okienka pomocy. Użytkownik może jednak wyeksportować zawartość pomocy ścieżki szkoleniowej. Najprostszym sposobem jest wyeksportowanie zawartości przy użyciu Ścieżka szkoleniowa > Biblioteka zawartości > Lokalizuj > Eksportuj. Wybierz żądane wiersze i wyeksportuj je. Spowoduje to utworzenie pliku XLIFF dla każdego okienka pomocy i zadania nadzorowanego. Następnie należy użyć dostępnego publicznie edytora XLIFF lub konwertera XLIFF do HTML, aby pobrać zawartość programu.

Niestandardowa definicja kodu XML pomocy

W tej sekcji opisano niestandardową definicję kodu XML pomocy.

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>

Definicja i użycie

Element <pphml> informuje przeglądarkę pomocy o tym, że jest dokumentem PPHML.

Element <pphml> reprezentuje katalog główny dokumentu programu PPHML.

Element <pphml> jest kontenerem dla wszystkich innych elementów PPHML.

Tytuł

Wyświetla tytuł na stronie pomocy.

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

Definicja i użycie

Element <h1> definiuje tytuł strony pomocy.

<h1> To musi być pierwszy element w <pphml>.

Obraz

Wyświetla obraz na stronie pomocy.

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

Definicja i użycie

Element <img> osadza obraz na stronie pomocy.

Atrybuty

  • src: Określa adres URL obrazu. Ten atrybut jest wymagany.

  • title: Określa tytuł, który ma być wyświetlany wraz z obrazem, zazwyczaj jako etykietka narzędzia aktywowanego.

  • alt: Określa alternatywny tekst dotyczący danego obrazu. Ten tekst jest używany przez czytniki ekranu.

Wideo

Wyświetla wideo na stronie pomocy.

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

Definicja i użycie

Element <video> powoduje osadzenie filmu wideo, takiego jak samouczek lub Film szkoleniowy, na stronie pomocy.

Obsługiwane źródła
  • Microsoft Stream
  • YouTube
  • Facebook
  • Vimeo

Atrybuty

  • src: Określa adres URL wideo. Ten atrybut jest wymagany.

  • allowFullScreen: Określa, czy użytkownik może przełączyć film wideo do trybu pełnego ekranu. Możliwe wartości to "prawda" lub "fałsz". Ten atrybut nie jest obsługiwany we wszystkich źródłach wideo.

  • autoplay: Określa, że odtwarzanie filmu będzie rozpoczynać się zaraz po załadowaniu strony pomocy. Możliwe wartości to "prawda" lub "fałsz". Ten atrybut nie jest obsługiwany we wszystkich źródłach wideo.

  • startTime: Określa w sekundach, od którego punktu rozpocznie się odtwarzanie filmu wideo.

Akapit

Wyświetla akapit na stronie pomocy.

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

Definicja i użycie

Element <p> definiuje akapit.

Tekst w akapicie może mieć następujące formy:

  • Pogrubiony, z elementem <strong>
  • Kursywa, z elementem <em>
  • Przekreślenie, z elementem <del>
  • Podkreślenie, z elementem <u>

Te dekoracje można łączyć. Można na przykład utworzyć fragment tekstu pogrubiony i podkreślony.

Lista punktowana

Wyświetla listę punktowaną na stronie pomocy.

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

Definicja i użycie

Element <ul> definiuje listę punktowaną.

Użyj elementu <ul> z elementem <li>, aby utworzyć listy punktowane.

Lista numerowana

Wyświetla listę numerowaną na stronie pomocy.

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

Definicja i użycie

Element <ol> definiuje listę uporządkowaną (numerowaną). Użyj tagu <ol> z elementem <li>, aby utworzyć listy numerowane.

Zwijalne

Wyświetla sekcję zwijalną na stronie pomocy.

<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>

Definicja i użycie

Element <collapsible> definiuje sekcję zawartości, którą użytkownik może wyświetlić lub ukryć na żądanie.

Atrybuty

  • collapsed: Określa, czy sekcja ma być początkowo zwinięta, czy rozwinięta. Możliwe wartości to "prawda" (zwinięta) lub "fałsz" (rozwinięta).

Wyświetla łącze na stronie pomocy.

Łącze do witryny sieci Web, która jest otwierana w nowym oknie przeglądarki:

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

Łącze do innej strony pomocy:

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

Definicja i użycie

Tag <a> definiuje łącze, które umożliwia użytkownikowi nawigowanie ze strony pomocy do witryny sieci Web, a także na inną stronę pomocy.

Atrybuty

  • href: Określa adres URL witryny sieci Web lub strony pomocy, na którą należy przejść. Ten atrybut jest wymagany.
  • target: Określa, gdzie ma być otwierany połączony URL.
    • Jeśli nie jest obecny lub _self, łącze ma prowadzić do innej strony pomocy i otwiera się w przeglądarce pomocy.
    • Jeśli _blank, łącze otwiera się w nowym oknie przeglądarki.
    • Jeśli _top, łącze otwiera się w bieżącym oknie przeglądarki.
    • Jeśli wartością jest nazwa iframe, łącze jest otwierane w tym składniku iframe.

Wskazówka

Wyświetla wskazówkę na stronie pomocy.

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

Definicja i użycie

Wskazówka to interaktywny element, za pomocą którego można zwrócić uwagę użytkownika na konkretny punkt w interfejsie użytkownika aplikacji, która obsługuje przeglądarkę pomocy.

Atrybuty

  • target: Selektor CSS określający element HTML, w którym będzie widoczna wskazówka. Ten atrybut jest wymagany.

Dymek

Wyświetla dymek na stronie pomocy.

<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>

Definicja i użycie

Dymek to interaktywny element, za pomocą którego można pomóc użytkownikowi przeprowadzić akcję w interfejsie użytkownika aplikacji, która obsługuje przeglądarkę pomocy.

Atrybuty

  • target: Selektor CSS określający element HTML, w którym będzie widoczny dymek. Ten atrybut jest wymagany.
  • title: Określa tytuł dymku.
  • details: Określa zawartość, która ma być widoczna w dymku.

Uwaga

Czy możesz poinformować nas o preferencjach dotyczących języka dokumentacji? Wypełnij krótką ankietę. (zauważ, że ta ankieta jest po angielsku)

Ankieta zajmie około siedmiu minut. Nie są zbierane żadne dane osobowe (oświadczenie o ochronie prywatności).