Obecné zásady

Aby uživatel lépe porozuměl textu, v tomto dokumentu se pro formátování používají určitá pravidla. Seznam použitých pravidel pro formátování je uveden níže.

Pravidla pro uživatelskou příručku

Prvek

Zápis

Popis

Výstup

Obecné zdůraznění

Na pracovní ploše Program.

Pro zdůraznění určitých prvků textu nebo pro zvýraznění.

Tučný text

Položky v grafickém uživatelském rozhraní (GUI)

Zvolte tlačítko Funkce.

Jakékoli odkazy na položky na obrazovce uživatelského rozhraní, např. příkazová tlačítka, názvy ikon a názvy polí).

Tučný text

Cesta v grafickém uživatelském rozhraní (GUI) >

Obecně v horní části grafického uživatelského rozhraní.

Pomůcka pro navigaci, které sleduje umístění v grafickém uživatelském rozhraní.

Příklad: Controller > Program > Upravit

Vstup uživatele

Uveďte Popis programu.

Jakýkoli text zadaný uživatelem

Tučný text

Názvy souborů

Zadejte Název souboru pro export.

Soubory exportované do nebo importované ze systému.

Text v tučné kurzívě

Názvy proměnných a parametrů

Zadejte Název pro export.

Názvy proměnných a parametrů (nikoli hodnoty)

Text v kurzívě

Hodnoty proměnných a parametrů

Zadejte HODNOTU pro export.

Hodnoty proměnných a parametrů.

Text VELKÝMI PÍSMENY A TUČNĚ

Výstup systému

Client.Domain.Models.ExportImportConfiguration

Jakýkoli text výstupu systému

Text v Monospace

Externí odkazy

Odkazy a externí stránky s informacemi souvisejícími s obsahem nebo předmětem dokumentu. Mohou k nim patřit:

  • Technické údaje o produktech

  • Rozměrové výkresy

  • Příslušenství

  • Informace specifické pro produkt

Text z externích stránek s možností výběru

Vnitřní odkazy na dokumenty

  • Relevantní informace – odkazy na informace, které přímo souvisejí s aktuálním tématem a je potřeba je zvážit v případě provádění určitých konfigurací.

  • V tomto oddíle – odkazy na veškerá témata v tomto oddíle, které mohou být užitečné z hlediska porozumění funkci nebo konfiguraci.

Pokud jsou tyto odkazy k dispozici, budou uvedeny pod textem.

Text s možností výběru odkazující na vnitřní obsah