Kérlek, kattints ide a segítségért David McMurrey fizess webtárhelyért: Adj adományt bármilyen összeget, amit tudsz!
Az online műszaki írás ingyenes marad.

A műszaki jelentések és útmutatók gyakran megkövetelik a hivatkozásokat—ezek a mutatók más helyekre a ugyanabban a dokumentumban vagy más információs forrásokra, ahol kapcsolódó információk találhatóak.

A keresztutalás többféleképpen segítheti az olvasókat:

  • Ha például egy dokumentumban túl mélyen merültek el, akkor alapvetőbb információkhoz irányíthatja őket.
  • Irányíthatja őket fejlettebb információkhoz, ha például már tudják azokat a dolgokat, amiket megpróbál mondani nekik.
  • Emellett útmutatást nyújthat nekik a kapcsolódó információkhoz.

A kapcsolódó információk a legnehezebben magyarázható terület, mert végső soron minden mindennel összefügg—nincs vége a keresztutalásoknak. De itt van egy példa a DOS-ból—arra a trollra, amely a PC-típusú számítógépekben bujkál és állítólag segít neked. Számos módja van a fájlok másolásának: a COPY parancs, a DISKCOPY parancs és az XCOPY parancs. Mindegyik módszer más előnyöket kínál. Ha a COPY parancsról írnál, keresztutalásokat szeretnél ezekre a másik kettőre, hogy az olvasók egy kicsit szétnézhessenek.

Természetesen a fenti beszélgetés azonos dokumentumon belüli keresztutalásokra vonatkozik. Ha túl sok háttérinformációt kellene feldolgozni a dokumentumban, keresztutalhat egy külső weboldalra, könyvre vagy cikkre, amely megadja ezt a háttéranyagot. Így mentesülsz a kötelezettség alól, hogy mindent magyarázz!

A kereszt-hivatkozások összetevői

Kereszt- hivatkozások lehetnek belső (ugyanabban a dokumentumban) vagy külső (a jelenlegi dokumentumon kívül). A legtöbb hivatkozási irányelv attól függ, hogy a hivatkozás belső vagy külső.. Külső forrásokkal nem tudod irányítani a könyvek, fejezetek, alcímek, oldalszámok címét. Valószínűleg változni fognak!

Külső dokumentumokra való hivatkozásokkal:

  • Ne idézd pontosan szó szerint a könyvek, fejezetek, fejléc címét. Inkább utalj a lefedett általános témára.
  • Ne hivatkozz pontos fejezet- vagy szakaszszámokra, illetve pontossággal oldalszámokra.

Most már egy megfelelő keresztreferencia több elemből áll:

  • A hivatkozott forrás neve—Ez lehet a cím vagy egy általános témára való hivatkozás. Ha fejezetcím vagy cím, tedd idézőjelek közé; ha könyv, magazin, jelentés vagy referenciamunka neve, dőlt betűvel írd. (Az egyes cikkcímek is idézőjelek közé kerülnek.)
  • Oldalszám—Kötelező, ha ugyanabban a dokumentumban van. Ha a keresztutalás egy fejezet elejére mutat, és a fejezet számát és címét idézik (akár belső, akár külső), nincs szükség az oldalszámra. Az olvasók használhatják a tartalomjegyzéket. Ha a keresztutalás egy számozott fejezet belső címére vonatkozik, tüntesse fel azt az oldalszámot, ahol ez a cím található.
  • A keresztutalás tárgya—Gyakran szükséges megmagyarázni, mi található a kereszthivatkozott anyagban, és jelezni, hogy miért érdemes a olvasónak megnéznie azt. Ez megkövetelheti, hogy jelezze a keresztreferált anyag tárgyát, vagy világosan kifejezze, hogyan kapcsolódik a jelenlegi diskurzushoz.

Ezeket az irányelveket a következő illusztráción mutatjuk be. Figyeld meg az illusztráción, mennyire eltérőek a szabályok, amikor a hivatkozás "internal" (azaz a dokumentum ugyanazon részére) vonatkozik, összehasonlítva azzal, amikor "external" (a dokumentumon kívüli információra) hivatkozik.

Keresztutalások példái

A belső hivatkozások a dokumentumod ugyanazon területeire vonatkoznak; a külsők pedig olyan információs forrásokra, amelyek a dokumentumodon kívül találhatóak.

Belső és Külső Hivatkozási Példák
Példa A grafikák létrehozásáról és dokumentumba való beillesztésükről a 16. oldalon található grafikus részben olvashat.
Magyarázat Ebben a belső hivatkozásban a szakasz általánosan van megemlítve. Szokásos, hogy a belső hivatkozásokban az oldalszámot is megadják.
Példa A grafikák létrehozásának és dokumentumba való beillesztésének részleteiért lásd az "Grafikák" részt az Online Műszaki Írási Útmutatóban.
Magyarázat A fejezet címe dupla idézőjelben van. A könyv címe, amelyben a fejezet szerepel, dőlt betűs.
Példa A grafikák készítéséről és azok dokumentumba való beillesztéséről a grafikákkal foglalkozó fejezetet lásd a Online Műszaki Írás Útmutató.
Magyarázat Ha nem akarod megadni a fejezet pontos címét, akkor csak kisbetűt használj.
Példa A grafikák készítésével és azok jelentésbe való beépítésével kapcsolatos részletekért lásd: "Fényesítsd fel azt a havi jelentést!" a Irodai Információs Hírek.
Magyarázat Ha egy folyóiratcikket idézel, tedd a cikket idézőjelek közé, és dőlt betűvel írd a folyóirat nevét.

Tisztázó kifejezések kereszthivatkozásokban

Hasznosatlan és bosszantó ilyen kereszthivatkozásokkal találkozni: (lásd 3. ábra)

Az olvasóknak tudniuk kell, miről szól a keresztutalásos anyag, miért érdemes megnézniük.

Szükségük van egy rövid ötletre arról, hogyan értsék meg a belső keresztreferenciás szöveget, képeket, táblázatokat, diagramokat vagy ábrákat—csak egy tipp. Itt egy példa (a keresztreferenciás szöveghez szürke háttér lett hozzáadva):

A lítium két fő módszerrel kerül kitermelésre: hagyományos felszíni bányászati technikák és sóoldat-kivonás [6]. Ahogy a 3. ábra is mutatja, a pegmatitek a világ lítiumkészleteinek 26%-át teszik ki, míg a sóoldatok 66%-át [6].

explanation of this image will be supplied 3. ábra. A globális lítiumkészletek típusa szerinti százalékos megoszlása [6].
Példa egy magyarázó hivatkozásra egy diagramra. Forrás: James Ball.

Miután a párologtató medencében lévő sós víz elérte az ideális lítium koncentrációt, a sós vizet egy lítium kinyerő létesítményhez pumpálják további feldolgozásra és kivonásra. A maradék sós oldatot visszaengedik a földalatti tározóba [9]. Az 5. ábrán egy tipikus lítium elpárologtató tó rendszer mérete látható. Vegye figyelembe az utak és közműoszlopok méretét a skála érdekében.

explanation of this image will be supplied
5. ábra. Lítium elpárologtató tavak [10].
Példa egy magyarázó keresztreferenciára. Forrás: James Ball.

Itt van egy másik példa; a szürke háttér nem az eredetiben van:

Nyílt égésű bányászat. A pegmatitot nyíltakból és hagyományos bányászati technikákkal nyerik ki. A kibányászott pegmatit darabokat ezután mechanikusan összezúzzák, hogy csökkentsék a méretüket. Az összezúzott ércet további őrlésnek vetik alá, hogy finomabb terméket állítsanak elő, amely jobban alkalmas a további szeparálásra. A feldolgozás koncentrátumot eredményez, amelyet kémiai úton feldolgoznak lítium-karbonát vagy lítium-hidroxid előállítására [3]. A 4. ábra egy nyitott pit lítiumbányát mutat be, amely a műveletek tipikus méretét illusztrálja.

explanation of this image will be supplied
4. ábra. Nyílt pit lítium bánya [7].
Példa egy magyarázó keresztutalásra. Please provide the text you would like to have translated. James Ball.

Kapcsolódó információk

Olvasási kvíz. Használja ezt a kvízt, hogy tesztelje a fejezet megértését.

Képzés elérhető. Szerezz egy kis gyakorlati írni McMurrey mint az oktatód.

  • Ha a keresztutalás a dokumentum ugyanazon fejezetére hivatkozik, tüntesse fel a fejezet számát és egy rövid tájékoztatást a fejezet tartalmáról, a cím idézése helyett.
  • Ha a keresztreferenciád egy másik dokumentumbeli fejezetre hivatkozik, ne írd bele a fejezet számát, de adj meg egy rövid tájékoztatást a fejezet tartalmáról a cím idézése helyett.
  • -->

    Értékelném a gondolataidat, reakcióidat, kritikádat ezzel a fejezettel kapcsolatban: a válaszod.