i.5. A könyvben használt formázásról
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 i.3. szakasz - Tartalmi felépítés 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 i.2. szakasz - Közönség és célkitűzés 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 i.6. szakasz - A példaként használt webhelyünkről 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 3.7. szakasz - Az interaktív telepítő futtatása 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: 3.2. szakasz - Alapfogalom: további hasznos eszközök). 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.
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 cache:rebuild
- 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.
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.
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:
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.
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:
| 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 i.6. szakasz - A példaként használt webhelyünkről 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: Jennifer Hodgdon. Fordította: Balu Ertl (Brainsum).
Source file: preface-conventions.asciidoc
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion
