Konwencje
Aby pomóc użytkownikom w przyswojeniu treści tego dokumentu, zastosowano w nim rozmaite konwencje. Wykorzystane konwencje formatowania wskazano poniżej.
Element | Zapis | Opis | Wylot |
---|---|---|---|
Ogólny nacisk | W przestrzeni roboczej programu . | Wyróżnienie lub zaznaczenie poszczególnych części tekstu. | Tekst pogrubioną czcionką |
Elementy Graficznego Interfejsu Użytkownika [Graphical User Interface - GUI] | Wybrać przycisk funkcyjny . | Wszelkie odniesienia do elementów znalezionych na ekranie w GUI (np. przycisków poleceń, nazw ikon i nazw pól). | Tekst pogrubioną czcionką |
Ścieżka Graficznego Interfejsu Użytkownika (GUI) > | Co do zasady, w górnej części GUI. | Pomoc nawigacyjna, która śledzi lokalizację w GUI. | Na przykład: Controller > Program > Edit [Sterownik > Program > Edycja] |
Dane wprowadzone przez użytkownika | Wprowadzić opis programu. | Każdy tekst wprowadzony przez użytkownika. | Tekst pogrubioną czcionką |
Nazwy plików | Wprowadzić nazwę pliku do wyeksportowania. | Pliki eksportowane z systemu lub importowane do systemu | Tekst pogrubioną kursywą |
Nazwy zmiennych i parametrów | Wprowadzić nazwę do wyeksportowania. | Nazwy (ale nie wartości) zmiennych i parametrów. | Tekst kursywą |
Wartości zmiennych i parametrów | Wprowadzić WARTOŚĆ do wyeksportowania. | Wartości zmiennych i parametrów. | Tekst POGRUBIONYM DRUKIEM |
Dane otrzymane z systemu | Client.Domain.Models.ExportImportConfiguration [Klient.Domena. Modele.Konfiguracjaeksportuimportu]. | Każdy tekst otrzymany z systemu. | Tekst pisany czcionką Monospace |
Łącza zewnętrzne | Linki do stron zewnętrznych, na których znajdują się informacje związane z treścią dokumentu lub tematem. Mogą one obejmować:
| Tekst, który można zaznaczyć i skopiować na strony zewnętrzne | |
Linki do dokumentacji wewnętrznej |
Linki te, o ile będą dostępne, zostaną przedstawione poniżej tekstu. | Tekst, który można zaznaczyć i skopiować do zawartości wewnętrznej |