Smjernice za tekst korisničkog sučelja

Slijedite smjernice u ovom odjeljku kako biste osigurali da su vaši proširenja dosljedni korisničkom sučelju Qt Creator i da se mogu lako lokalizirati na različite jezike.

Kada pišete tekst korisničkog sučelja, pobrinite se da je:

• U skladu s postojećim pojmovima korisničkog sučelja Qt Creator
• Kratak i sažet
• neutralan, opisivan i činjenično točan
• Jednoznačan
• Podesan za prijevod na različite jezike

Gramatika i stil

Sav tekst korisničkog sučelja mora biti gramatički ispravan engleski i koristiti standardni oblik pisanog jezika. Nemojte koristiti dijalekte ili žargon. Koristite idiomatičan jezik, to jest izraze koji su karakteristični za engleski jezik. Ako je moguće, zatražite pregled od izvornog govornika engleskog jezika.

Tekst korisničkog sučelja treba biti sažet i ekonomično formuliran. Izbjegavajte nepotrebne riječi i izraze. Međutim, važnije je da tekst bude koristan i lako razumljiv.

Izbjegavajte obraćanje korisniku u drugom licu. Koristite neutralan ton ili pasiv, ali upotrijebite formalni oblik obraćanja kada je to potrebno. Izbjegavajte upotrebu riječi "molim" pri obraćanju korisniku. Izuzeci od toga su neki tekstovi s autorskim pravima i kratke imperativne rečenice koje bi inače mogle zvučati grubo. Na primjer, "Molimo pričekajte."

Izbjegavajte skraćenice u nazivima i stavkama izbornika. Ako nema mjesta za puni naziv ili razdvajanje riječi crticom, skratite tekst u skladu s engleskim pravilima za skraćenice.

Izbjegavajte skraćenice. Na primjer, napišite cannot umjesto can't.

Interpunkcija

Izbjegavajte upotrebu interpunkcijskih znakova ili posebnih znakova u nazivima i stavkama izbornika.

Koristite interpunkcijske znakove na sljedeći način:

• Koristite točke (.) u porukama.
• Nikada ne koristite točke (.) na kraju naziva stavki izbornika.
• Postavite tri točkice (...) na kraj naziva stavki izbornika koje otvaraju dijalog koji zahtijeva radnju korisnika.
• Koristite uzvičnike (!) samo u tekstu koji zahtijeva dodatnu pažnju korisnika ili ima poseban značaj.
• Koristite navodnike ("") za vrijednosti varijabli. Na primjer, Close Project "qtcreator". Radi dosljednosti, koristite dvostruke navodnike za naglašavanje ili izdvajanje naziva datoteka, naziva direktorija, URL-ova i slično u nizovima vidljivima korisniku.
• Ne koristite vodeće, završne ili višestruke razmake za poravnanje teksta u porukama, jer prijevodni alati možda neće ispravno obrađivati takve razmake.

Pisanje skočnih pomoći

Pomoćni natpisi sadrže korisne informacije o ikonama, stavkama izbornika ili drugim elementima korisničkog sučelja. Pojavljuju se kada korisnik postavi pokazivač miša iznad nekog elementa korisničkog sučelja. Također možete dodati opisni tekst u korisničko sučelje koji je uvijek vidljiv.

Razmislite o dodavanju pomoćnih natpisa za sve elemente korisničkog sučelja koji nisu očiti iz konteksta. Pomoćni natpisi trebaju pomoći korisnicima da razumiju što kontrolne komponente korisničkog sučelja rade, stoga ih pokušajte učiniti što jasnijima, čak i ako budu malo duži.

Pomoćni natpisi za ikone

Za ikonu možete koristiti naziv naredbe kao natpis alata. U tom slučaju koristite kapitalizaciju u stilu knjige i ne stavljajte točku nakon natpisa alata.

Ostale pomoćne poruke

Pomoćni natpisi također mogu sadržavati cijele rečenice.

Slijedite ove smjernice:

• Pišite korisne napomene, ali ih držite što kraćima i sažetijima.
• Kako biste pomogli ljudima koji lokaliziraju i onima kojima je engleski drugi jezik, učinite alatkopisne napomene gramatički što jasnijima. Koristite članke a, an i the, prijedloge, kao što je of, i pokazne zamjenice, kao što su this i that, gdje god je to moguće.
• Koristite velika slova i interpunkciju prema pravilima za pisanje rečenica, kao i za svaku drugu rečenicu.
• Za polja za unos opišite vrijednost polja. Recite korisnicima što mogu unijeti u polje, kao što je ime ili putanju, osim ako to nije očito iz konteksta. Koristite imeničku frazu, kao što je Ime korisničkog računa. Opišite ograničenja i posebne zahtjeve .
• Za radnje, kao što su većina potvrdnih okvira, radio gumba, tipki i stavki izbornika, opisujte što se događa kada ih korisnici odaberu. Koristite glagolsku frazu, kao što je " Brisanje viška praznih znakova pri spremanju".
• Za kombinirane okvire opišite kada odabrati svaku opciju.
• Opisujte što kontrolna komponenta korisničkog sučelja radi, a ne kako je koristiti. Ako komponenta ne radi onako kako bi korisnici očekivali, provjerite svoj dizajn jer ste najvjerojatnije odabrali pogrešnu vrstu komponente.
• Ne opisujte zadano vrijednost niti minimalne i maksimalne vrijednosti jer ih korisnici mogu vidjeti u polju.

Primjeri

Pisanje savjeta za pomoć u načinu dizajna

U Qt Widgets Designeru koristite običan tekst za skočne napomene. Za dodatno formatiranje napišite kratki, kanonički HTML na kartici Izvor u uređivaču obogaćenog teksta: <html><head/><body><b>Note:</b> text.

Qt Widgets Designer ima značajku koja pojednostavljuje obogaćeni tekst (uključeno prema zadanim postavkama), ali svejedno biste trebali provjeriti pregledavanjem kartice Source.

Pisanje poruka

Provjerite jesu li poruke sažete i ekonomično formulirane. Međutim, važnije je da poruke budu korisne i lako razumljive.

Svedite upotrebu mnogih novih i različitih struktura rečenica na minimum. Ponovno koristite strukture rečenica koje su se koristile u sličnim situacijama. Na primjer:

• Ne može se poslati zapisnik kao odabrana vrsta poruke. Tekst je predug.
• Ne može se primiti slika.
• Ne može se umetnuti slika. Maksimalna duljina teksta je 120 znakova.
• Naziv slike je već u upotrebi.
• Naziv mape je već u upotrebi.

Tekstualna kapitalizacija korisničkog sučelja

Koriste se dva stila, naslov knjige i rečenični stil:

• Primjer velikog početnog slova naslova knjige
• Primjer velikih slova prema rečenici

Korištenje velikog početnog slova po stilu naslova knjige

Kod primjene velikog početnog slova po knjižnom stilu, pišite velikim početnim slovom sve riječi, osim predloga kraćih od pet slova (npr. 'with', ali 'Without'), veznika (npr. 'and', 'or', 'but') i članova ('a', 'an', 'the'). Međutim, uvijek pišite velikim početnim slovom prvu i zadnju riječ.

Koristite velika slova prema knjižnom stilu za:

• Naslovi (prozor, dijalog, okvir grupe, kartica, stupci prikaza popisa i slično)
• Funkcije (meni stavke, gumbi)
• Odabirni elementi (elementi padajućeg popisa, elementi popisnog okvira, elementi stablo-popisa, itd.)

Provjera velikog slova u stilu knjige

Ako je potrebno, upotrijebite online Title Case Converter za provjeru kapitalizacije u stilu knjige za tekst korisničkog sučelja ili naslove u dokumentaciji.

Ili upotrijebite skriptu to-title-case.js u mapi \doc\titlecase:

1. Otvorite to-title-case.html u pregledniku.
2. Unesite UI tekst u polje.
3. Odaberite Convert.

UI tekst s predloženom kapitalizacijom u stilu knjige prikazuje se u polju s desne strane.

Korištenje velikog početnog slova prema stilu rečenice

Kada koristite kapitalizaciju prema stilu rečenice, veliko slovo pišite samo na početku, osim kod vlastitih imena.

Koristite veliko slovo na početku rečenice za:

• Oznake
• Savjeti alata
• Opisni tekst
• Ostali tekst koji nije naslov ili podnaslov

Priprema za lokalizaciju

Qt Creator je lokaliziran na nekoliko jezika. Dosljednost i sažetost čine tekst korisničkog sučelja lakšim za prevođenje.

Označavanje UI teksta za prijevod

Kontekst prijevoda

Izbjegavajte stvaranje mnogo različitih konteksta za prijevod. Po zadanome, tr() koristi kontekst klase, što znači da prijevodi prestaju funkcionirati kada se kod refaktorira i UI tekst premjesti u drugu klasu.

Umjesto toga, za svaki dodatak stvorite jedan prijevodni kontekst. Stvorite zaglavlje myplugintr.h

#pragma once

#include <QCoreApplication>

namespace MyPlugin {

struct Tr
{
    Q_DECLARE_TR_FUNCTIONS(QtC::MyPlugin)
};

} // namespace MyPlugin

i upotrijebite tu strukturu kao kontekst prijevoda za UI tekst pozivanjem Tr::tr(). Koristite nizove za razlikovanje u slučajevima kada je to potrebno.

Komentari prevoditelja

Nizovi teksta korisničkog sučelja zatvoreni su u pozive Tr::tr() i izvađeni iz izvorne koda tijekom procesa prevođenja. Stoga prevoditelj možda neće poznavati kontekst poruka u izvornoj kodi.

Možete dodati komentare vidljive u Qt Linguist ( //:) kako biste pojasnili kontekst. Na primjer:

//: Contact book "Add person" button label
return tr("Add");

Staze do datoteka

Koristite FilePath::toUserOutput() iz biblioteke Utils za nazive datoteka i direktorija koje prosljeđujete Tr::tr().arg().

Označavanje

Izbjegavajte uključivanje oznaka unutar samog prevedenog teksta jer to može zbuniti prevoditelje. Na primjer, umjesto:

Tr::tr("<html><head/><body><span>UI Text</span></body></html>")

koristite

"<html><head/><body><span>" + Tr::tr("UI Text") + "</span></body></html>"

Značajke jezika ili pisama

Kako biste omogućili lokalizaciju svojih ekstenzija, uzmite u obzir utjecaj jezika i pisama na implementaciju.

Qt Creator Uobičajeni pojmovi za sučelje

Ovaj odjeljak sažima terminologiju koja se koristi za uobičajene UI komponente sustava Qt Creator. Također opisuje konvencije za imenovanje različitih vrsta UI komponenti.

Uvijek provjerite znači li pojam koji namjeravate upotrijebiti nešto drugo u korisničkom sučelju. Ako već postoji odgovarajući pojam, upotrijebite ga. Na primjer, upotrijebite Pronađi za pretraživanje i Novo za čarobnjake koji stvaraju nove objekte.

Za više informacija o tome kako dodati UI komponente, pogledajte Uobičajeni zadaci proširenja.