[[preface-conventions]]

=== A könyvben használt formázásról

[role="summary"]
A Kézikönyvben leírtak jobb megértésének érdekében egységes formázással igyekszünk elkülöníteni az információkat.

==== Előfeltevések és követelmények

A Kézikönyv szerkesztése során a következő feltételezésekre építettünk:

* A teljes tartalmát témakörökre osztottuk fel, melynek részletei az <<preface-organization>> oldalon olvashatóak. Sok ilyen témakör elején szerepel egy _Szükséges előismeretek_ című szakasz: itt soroljuk fel azon korábbi témaköröket, melyek előzetes elolvasása hasznos az adott témakör megértéséhez. Minden szükséges tudást azonban mi sem írhattunk le a Kézikönyvben, ezért feltételezzük, hogy az Olvasónak már vannak alapvető ismeretei az <<preface-audience>> témakörben leírtakról.

* Ezenkívül azoknál a témaköröknél, melyek egy lépéssor elvégzéséhez szolgálnak útmutatóul, egy _Webhely előfeltételei_ című szakaszban felsoroljuk azt is, hogy az ismertetett művelet elvégzéséhez a példawebhelyünknek milyen korábbi, előző témakörök során végzett módosításokat kell tükröznie.

* A példaként használt webhely ugyanis a teljes Kézikönyv során ugyanaz. Egy valós élethelyzetben, egy kisvárosi termelői piac weboldalán keresztül mutatjuk be példáinkat, ennek részletei az <<preface-scenario>> témakörben olvashatóak. Természetesen nem kötelező mindenkinek ugyanilyen célú webhelyet építenie, sőt, az Olvasó szabadon alkalmazhatja a leírtakat a saját webhelyére. Ekkor azonban gondolnia kell majd arra is, hogy a későbbi fejezetekben ismertetett lépéssoroknak megfelel-e a saját Drupal-példánya?

* A <<install-run>> témakör után következő részek egy további feltételt is támasztanak: onnantól értelemszerűen elvárt, hogy fel legyen telepítve a Drupal 8 legfrissebb stabil verziója a tárhelyen és az Olvasó be legyen rajta jelentkezve egy kellő jogosultságokkal bíró felhasználói fiókkal. +
 +
Ha a Kézikönyv fejezetein sorban haladunk végig, akkor ez nem igényel semmilyen további előkészületet: a telepítés során automatikusan létrejön az Egyes számú fiók, amelyben a telepítés végeztével bejelentkezve maradunk, így a lehető legmagasabb szintű hozzáféréssel rendelkezünk.

* Bár ahogy fentebb írtuk, az útmutató leírások elvégzéséhez leggyakrabban a Drupal adminisztrációs felületét fogjuk használni, de ahol csak lehetséges, bemutatjuk az adott művelet parancssori megfelelőjét is a _Drush_ eszköz legfrissebb stabil verziójával (ehhez lásd: <<install-tools>>). Természetesen ettől eltérő parancssoros eszköz (mint például a _Drupal Console_) is használható, de a leírt parancs abban használatos megfelelőjének ismeretét az Olvasóra bízzuk.

==== Szövegbeli egységes jelölések

A Kézikönyv során a következő fogalmazási és szerkesztési gyakorlatot követtük a könnyebb érthetőség kedvéért:

* A _pelda.hu_ doménnév alatt mindig a webhelyünk alapwebcímét értjük. A webhelyünkön belül használatos további webcímekről lentebb, a Navigáció szakaszban írunk.

* _Dőlt betűvel_ a képernyőn megjelenő kifejezéseket jelöltük, mint például: „Kattintsunk a _Beállítások mentése_ gombra”. Ez azonban csak a szoftver kezelőfelületének részét képező kifejezésekre vonatkozik, nem pedig a korábbi témakörök során begépelt szövegekre. Például amikor egy tartalomszerkesztésről szóló leírásban egy ehhez hasonló utasítást olvashatunk: „Kattintsunk a _Szerkesztés_ gombra a Rólunk oldal sorában”, akkor a _Szerkesztés_ dőlt betűs, mert a gomb felirata, de a Rólunk nem az, mivel az egy általunk feltöltött tartalomnak a címe.

* Az előbb említett UI-feliratokon kívül a _dőlttel_ való formázást használjuk még modulok és sminkek, valamint fájlok neveinek és az újonnan ismertetett szakkifejezéseknek a kiemelésére is.

* Minden olyan szöveget, amelyet egy parancssori ablakba kell begépelnünk, +egyenszélességű+ betűvel jelöltünk:
+
----
$ drush cr
----

* Bár egyesek ritkán mappáknak szeretik hívni a fájlok tárolóit, a Kézikönyvben azonban az elterjedt szóhasználatnak megfelelően könyvtáraknak nevezzük őket.

==== Navigáció

Az útmutató leírások elvégzéséhez leggyakrabban a Drupal adminisztrációs felületét fogjuk használni, ezért a lépéssorok gyakran tartalmaznak majd ehhez hasonló utasításokat:

=============
„Válasszuk ki a _Kezelés_ adminisztrátori menüben a _Felépítés_ > _Taxonómia_ menüpontot”. (Ez igazán majd az alaprendszer feltelepítését követően nyer majd értelmet.)
=============

Az ehhez hasonló navigációs útmutatások során feltételezzük, hogy a webhelyen a _Toolbar_ modul telepítve és engedélyezve van. Ha igen, akkor az oldal tetején megjelenő eszközsor _Kezelés_ menüpontjára kattintva kinyíló további lehetőségek közül nekünk a _Felépítés_, majd pedig a _Taxonómia_ nevű menüpontokra kell kattintanunk. Másik lehetőség, hogy böngészőnk címsorába beírjuk a _http://pelda.hu/admin/structure/taxonomy_ webcímet.

// Top navigation bar on any admin page, with Manage menu showing.
image:images/preface-conventions-top-menu.png["Az adminisztrációs menü",width="100%"]

Vagy nézzünk egy másik példát:

=============
„Válasszuk ki a _Kezelés_ adminisztrátori menüben a _Konfiguráció_ > _Rendszer_ > _Alapvető webhelybeállítások_ menüpontot (vagy a címsorban adjuk meg az _admin/config/system/site-information_ útvonalat).”
=============

Ebben az esetben a _Kezelés_, majd _Konfiguráció_ menüpontokra való kattintás után megnyíló oldalon meg kell keresnünk a _Rendszer_ című szakaszt, amelyben megtaláljuk az _Alapvető webhelybeállításokat_:

// System section of admin/config page.
image:images/preface-conventions-config-system.png["A _Rendszer_ feliratú doboz a Konfiguráció oldalon"]

Végezetül pedig még egy apró megjegyzés: ha az alapértelmezett adminisztrációs sminket, a _Sevent_ használjuk, akkor az új elemeket hozzáadó gombokon szerepelni fog egy plusz („\+”) jel. Például az admin/content oldalon ezen a gombon a „+ Tartalom hozzáadása” felirat olvasható. Ez azonban csupán a _Seven_ design egy funkciója, a plusz jel nem a gombfelirat része (például a képernyőfelolvasó szoftverek is figyelmen kívül hagyják), ezért mi is anélkül fogjuk említeni ezeket a gombokat a Kézikönyvben.

==== Űrlapok kitöltése, adatok bevitele

Könyvünk lépéssorainak majdnem minden feladata során szükségünk lesz különböző adatok webes űrlapokon keresztüli bevitelére. Ennek megkönnyítésére a legtöbb esetben egy képernyőképpel illusztráljuk majd őket, valamint egy táblázatban összefoglaljuk, hogy melyik mezőbe mit kell beírni. Például találkozni fogunk majd egy ehhez hasonló táblázattal, ami három oszlopban összefoglalja, hogyan töltsük ki a mezőket a _Konfiguráció_ > _Rendszer_ > _Alapvető webhelybeállítások_ (vagy a címsorban az  _admin/config/system/site-information_) oldalon:

[width="100%",frame="topbot",options="header"]
|================================
| Mező neve | Magyarázat | Javasolt kitöltés
| Webhely részletei > A webhely neve | A webhelyünkhöz kitalált tetszőleges elnevezés. | Bárkifalva Termelői Piac
|================================

A táblázat segítségével nincs más dolgunk, mint megkeresni az adott oldalon a _Webhely részletei_ mezőcsoportot (amit a legtöbb adminsmink valamilyen keretezéssel jelöl), azon belül _A webhely neve_ beviteli mezőt, és bemásolni a példaként megadott értéket vagy begépelni egy magunk választotta sajátot. Egyes oldalakon előfordulhat, hogy ezek a keretek alapértelmezetten összecsukva jelennek meg, ilyenkor a címükre kattintva nyithatóak ki. Egyébként az előbb példaértékként feltüntetett „Bárkifalva Termelői Piac” nem véletlen: az <<preface-scenario>> témakörnél ismertetjük, hogy milyen valódi példán keresztül építjük fel webhelyünket a Kézikönyv során.

*Közreműködők*

Írta és szerkesztette: https://www.drupal.org/u/jhodgdon[Jennifer Hodgdon]. Fordította: https://www.drupal.org/u/balu-ertl[Balu Ertl] (https://www.drupal.org/brainsum[Brainsum]).
