Az AsciiDoc forrásfájlokról

Frissítés: a Kézikönyv fordítása elkészült. Az ezen az oldalon alább leírtak már csak történelmi, archiválási célokat szolgálnak.

Hogyan néz ki egy átlagos forrásfájl?

A könnyebb áttekintés kedvéért képzeletben tagoljuk 3 részre:

Fejléc

1. Fájlazonosító (ID), ami muszáj, hogy a legelső sora legyen a fájlnak, különben az összeszerelő szkript nem találja meg:
   [[pelda-fajlazonosito]]

2. Ezt követi a fájl címe, ami
   === Fogalom: Ennek a példafájlnak ez a címe

Fő tartalom

Lezárás

1. Közreműködő személyek felsorolása
   Először egy cím:
   *Közreműködők*

2. Majd pedig az adott témakör angol eredeti szerzői és szerkesztőinek neve a D.org profiljukra linkelve:
   Írta és szerkesztette: https://www.drupal.org/u/peldaszemely[Személy Neve]

További gyakran előforduló szerkezetek

Bár a fordítási memória használata sok terhet levesz a vállunkról és segít egységesebb külalakot biztosítani a száznál is több forrásfájl között, ám mindenre az sem képes. Ezért az alábbiakban gyűjtöttem össze olyan gyakran visszatérő szerkezeteket, amelyeket az angol eredeti változat szerzői is rendszeresen használtak, így nekünk is érdemes egységesen kezelnünk őket:

1. Hivatkozás közösségi dokumentációra

   A témakörök végefelé gyakran van utalás olyan szócikkekre, ahol az Olvasó bővebb, részletesebb, általánosabb ismereteket szerezhet az adott témáról.

   
   
   * https://www.drupal.org/documentation/backup[_Drupal.org_ community documentation page "Backing up a site"]
   
   

   Ezt mi leggyakrabban így szoktuk fordítani:

   
   
   * https://www.drupal.org/documentation/backup[Backing up a site] (azaz „Webhelyünk lementése”) című közösségi dokumentáció a Drupal.org-on angol nyelven.

    

2. Közösségi dokumentáció szerzői joga

   Azoknál a témaköröknél, ahol a szerzők a D.org leírásait emelték át a D8 kézikönyvbe, ott mindig kötelezően fel van tüntetve mindez. Így néz ki az eredeti például:

   
   
   Adapted by https://www.drupal.org/u/batigolix[Boris Doesborg] from https://www.drupal.org/node/1577752["View modes"], copyright 2000-2016 by the individual contributors to the https://www.drupal.org/documentation[Drupal Community Documentation].
   
   

   Ezt mi így tudnánk nagyjából lefordítani:

   E témakör szövegét https://www.drupal.org/u/diana.lakatos[Diána Lakatos] a Drupal közösségi https://www.drupal.org/documentation[dokumentációjának] https://www.drupal.org/getting-started/admin/reports[Reports] (azaz „Jelentések”) című szócikkéből vette át, melynek szerzői joga 2000-2016 között annak egyéni közreműködőié.
   
   

    

3. Fordító személy (és cégének) feltüntetése

   Végül pedig a témakör magyar fordítójának neve a D.org profiljára linkelve:

   
   
   Fordította: https://www.drupal.org/u/peldaszemely[Személy Neve]
   
   

   A projekt etikettje megengedi igény esetén a közreműködő személy szervezetének feltüntetését is, opcionálisan a cég D.org-os profiloldalára linkelve:

   Fordította: https://www.drupal.org/u/peldaszemely[Személy Neve]
(https://www.drupal.org/brainsum[Brainsum]).
   
   

    

4. Menüútvonalaknál használt szimbólum

   Sima kacsacsőrt („>”) használ az angol, de az megtévesztő lehet a kisebb-nagyobb jelentése miatt, ezért javasolt inkább a („»”).

   
   
   e