Gentoon suomennosten tyyliopas
1.
XML-elementti- ja attribuuttikohtaiset käännökset
Pakolliset XML-kuviot
Koodilistaus 1.1: XML-dokumentin alkuosa |
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->
|
Tämä osa on kaikkien dokumenttien alussa, siihen ei kosketa!
Guide, book tai muu vastaava
Koodilistaus 1.2: Juurielementit |
<guide link="/doc/en/guide.xml" lang="en">
<guide link="/doc/en/guide.xml" lang="en">
|
Tässä osassa on jo kaksi käännöskohdetta, linkki pitää panna osoittamaan
/doc/fi/-osoitteeseen ja lang pitää olla fi. Jos ne puuttuvat, ne
lisätään!
Koodilistaus 1.3: Juurielementtien käännösesimerkit |
<guide link="/doc/fi/guide.xml" lang="fi">
<guide link="/doc/fi/guide.xml" lang="fi">
|
Title
Koodilistaus 1.4: Title-elementti |
<title>Gentoo Linux Documentation Guide</title>
|
Title-elementit vastaavat eri puolilla dokumentteja olevia otsikkoelementtejä,
ne pitää kaikki kääntää. Koska kyseessä on otsikot, jotka esiintyvät myös
sisällysluetteloissa, käännösten tulee olla napakoita ja selittäviä. Huomattavaa
myöskin on, että suomessa otsikoissa vain aivan ensimmäinen kirjain on
suuraakkonen, muiden sanojen ensimmäisten kirjaimet eivät ole, elleivät ne ole
erisnimiä. Tämä poikkeaa vanhasta englannin käytännöstä, jossa kaikkien sanojen
ensimmäiset kirjaimet ovat isoja.
Otsikoissa suositaan yleensä perusmuotoisia nomineja tai kuvauksia, ei
partitiiveja, elatiiveja tai verbejä. Esimerkiksi Kesäloma ja
Oluen kittaus ovat hyviä otsikkoja, kun taas Syysmasennuksesta
tai Syökää kanaa ovat huonoja.
Koodilistaus 1.5: title-elementin käännösesimerkki |
<title>Gentoon dokumentointiopas</title>
|
Author
Koodilistaus 1.6: Author ja sen sisällöt |
<author title="Author">
<mail link="yourname@gentoo.org">Your Name</mail>
</author>
|
Tässä on yksi tärkeä käännösetappi, titlet käännetään seuraavalla
tavalla:
- Author = Tekijä
- Contributor = Avustaja
- Editor = Toimittaja
- Translator = Kääntäjä
- …
Tämän lisäksi listan perään lisätään yksi author-elementti, jossa
title on joko Kääntäjä tai Vastuullinen kääntäjä, sen mukaan
aiotko ylläpitää dokumenttia vai et.
Ihmisten nimiä ei tietenkään yleensä käännetä, mutta jos jotain tarpeeksi
eksoottista tulee vastaan, sen voi osatessaan translitteroida tai muuntaa
suomeksi. Esimerkiksi jos venäläinen nimi on kirjoitettu kyrillisin kirjaimin
tai englantilaisen translitterointitavan mukaan, se on mahdollista kääntää
uudelleen suomeksi, tällöin on toki aiheellista lisätä myös kyrillisin kirjaimin
alkuperäismuoto.
Koodilistaus 1.7: Author ja sisällöt |
<author title="Tekijä">
<mail link="yourname@gentoo.org">Your Name</mail>
</author>
|
Abstract
Koodilistaus 1.8: abstract |
<abstract>
This guide shows you how to compose web documentation using
our new lightweight Gentoo GuideXML syntax. This syntax is the official
format for Gentoo Linux web documentation, and this document itself was created
using GuideXML.
</abstract>
|
Abstract on tiivistelmä, joka esiintyy sekä indeksisivuilla että jokaisen
dokumentin ohessa (nykyisessä 2006 tyylissä oikeassa violetissa palkissa).
Se suomennetaan normaalilla tavalla.
Koodilistaus 1.9: abstract |
<abstract>
Tässä oppaassa kerrotaan veppipohjaisten ohjeiden kirjoittamisesta uudella
kevyellä GuideXML-merkkauskielellä…
</abstract>
|
License
Koodilistaus 1.10: license |
<!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
|
Lisenssi on pakollinen osa virallisia dokumentteja, siihen ei saa koskea.
(Joissakin dokumenteissa on kommentoitu ilmoitus myös suomeksi, tämä ei ole
tarpeen, mutta sen saa lisätä halutessaan).
Version ja date
Koodilistaus 1.11: versio ja aika |
<version>1.0</version>
<date>2004-12-25</date>
|
Versiotieto on se josta tarkistetaan ajantasaisuus englanninkieliseen versioon,
se on siis hyvä pitää käännetyn version kanssa tasoissa, päiväys samoin.
Päivämäärätietoa ei suomenneta, sen on oltava YYYY-MM-DD-formaatissa, eli
eräässä ISO 8901 -formaatissa, ja se käsitellään ohjelmallisesti, siksi siis
pitää muistaa kaikki etunollat sun muut.
Chapter, section ja subsection
Koodilistaus 1.12: Kappaleita |
<chapter>
<title>This is my chapter</title>
<section>
<title>This is section one of my chapter</title>
<body>
|
Nämä ovat sitten eri kappaletasoja, joiden otsikot suomennetaan aiemmin kuvatulla
tavalla.
Koodilistaus 1.13: Kappaleiden käännösesimerkit |
<chapter>
<title>Tämä on kappale</title>
<section>
<title>Tämä on kappaleen ensimmäinen osa</title>
<body>
|
P
Koodilistaus 1.14: Paragraafi |
<p>
This is the actual text content of my section.
</p>
|
p-elementit on kappaleita tai paragraafeja, jotka pitää sisällään valtaosan
käännettävästä tekstisisällöstä. Ne suomennetaan normaalisti ja suoraviivaisesti
lukuunottamatta muutamia poikkeuksia, joita esitellään seuraavaksi.
Koodilistaus 1.15: Paragraafin käännösesimerkki |
<p>
Tämä on osion sisältötekstiä.
</p>
|
Pre
Koodilistaus 1.16: Koodilistaus |
<pre caption="creating an example">
# do --this
Program outputs this
|
Koodilistauksissa esitellään yleensä suoritettavia komentoja ja
asetustiedostojen sisältöjä. Niiden kääntämisessä pitää olla tarkkana.
Ensinnäkin caption pitää tietenkin suomentaa. Suositeltavaa on käyttää
suomennoksessa verbijohtoista kuvausta, joka kertoo lukijalle mitä siinä
tehdään. Toinen yleinen vaihtoehto on että koodilistauksessa on
esimerkkejä, jollain ne otsikoidaan esimerkeiksi. Hyviä
koodilistausten otsikoita ovat siis vaikkapa Asetusten muokkaus,
kaljanjuonti tai Varoittava.conf-esimerkki, huonoja ovat
Joku koodilistaus ja Windowsin asetukset. Otsikko aloitetaan
isolla kirjaimella, eikä sitä päätetä välimerkkiin, eikä se muodosta lausetta.
Jos koodilistauksessa käsitellään ohjelman käyttämistä, ohjelman tulosteista
esitetään suomenkieliset versiot, jos ne ovat saatavilla, muutoin esitetään
alkukieliset versiot sellaisena kuin ne ovat, omia suomennoksia ei saa
keksiä, jos ohjelmassa ei sellaisia ole. Jos koodilistauksessa
on asetuksia, ne lokalisoidaan suomeksi mahdollisuuksien mukaan (esim.
jos listaus käsittelee aikavyöhykkeen asettamista, suositellaan
Europe/Helsinkiä riippumatta siitä, mikä alkukielisessä on esimerkkinä).
Koodilistaus 1.17: Koodilistauksen käännösesimerkki |
<pre caption="Esimerkin teko">
# do --this
Ohjelma tulostaa niitänäitä
|
Path, uri ja c
Koodilistaus 1.18: Polkuja, verkko-osoitteita ja komentoja |
<p>
This is a paragraph. <path>/etc/passwd</path> is a file.
<uri>http://forums.gentoo.org</uri> is my favorite website.
Type <c>ls</c> if you feel like it.
|
Polkuihin, verkko-osoitteisiin ja komentoihin liittyy kaikkiin käyttännössä
samat käännösongelmat. Ne eivät taivu suomen kielen mukaisesti kovin nätisti.
Ongelma yleensä ratkeaa liittämällä itse asian eteen taivutettu attribuutti:
tiedosto tai hakemisto elementille path, verkkosivu tai
-sivusto elementille uri, ja komento tai ohjelma
elementille c. Myös jälkiliitettä voi käyttää, mutta tällöin tulee
muistaa noudattaa yhdyssanasääntöjä, eli yhdysmerkki ja mahdollinen välilyönti
tulee ennen taivutettua sanaa. Tapauksittain on myös mahdollista taivuttaa
sisältöä itseään, tällöin taivutuspääte merkitään elementin sisään, jos
kyse on urista, mutta elementin ulkopuolelle kun kyse on
c:stä tai pathista. Myös nimien ja lyhenteiden taivutussääntöjä
pitää muistaa noudattaa. Komennot kirjoitetaan lauseen alussa isolla
alkukirjaimella, mutta koska sekaannuksen vaara on yleinen, komentojen
kirjoittamista lauseiden alkuun vältetään. Esimerkkejä:
-
Kopioi tiedosto blah tiedostoon foo. Se sijaitsee
/etc-hakemistossa.
-
Kopioinnin voi suorittaa cp-komennolla tai sitten catilla.
-
Tiedostot pitää noutaa sivulta http://www.gentoo.org
Huomaa:
Kovalevyllä ei ole kansioita vaan hakemistoja!
|
Uri-elementit ovat usein myös muotoa <uri
link="http://www.gentoo.org">Gentoo Homepage</uri>, tällöin käännös
tehdään suoraviivaisesti tavalliseen tapaan. Osoitteet kannattaa lokalisoida:
link="http://www.gentoo.org/doc/en/" on suomeksi
link="http://www.gentoo.org/doc/fi/".
E ja i
Koodilistaus 1.19: Korostus |
I <e>really</e> want to go to sleep now.
</p>
<pre caption="Code Sample">
This is text output or code.
# <i>this is user input</i>
|
Korostuselementit käännetään yleensä suoraviivaisesti. Harkinnan mukaan niitä
voi myös lisätä tai jättää pois, sillä aina ne eivät käänny nätisti.
Korostuselementit i tulee kuitenkin säilyttää, sillä ne merkitsevät
aina syötettä pre-elementeissä. Niiden sisältöjä ei myöskään käännetä muuta
kuin poikkeuksissa.
Koodilistaus 1.20: Korostuksen käännösesimerkki |
Ajattelin <e>oikeasti</e> nukkua nyt.
<pre caption="Koodia">
Ohjelman tuloste.
# <i>Käyttäjän syöte</i>
|
Comment
Koodilistaus 1.21: Kommentit |
<pre caption="Examples">
<comment>(This is how to insert an inline note into the code
block)</comment>
<comment># This is how you insert inline note into the shell script
# code block</comment>
</pre>
|
Kommentit käännetään sellaisenaan. Kommenteissa pitää kuitenkin huomata, ettei
ylitetä 80 merkin rajaa per rivi, ja uudelleenrivitettäessä pitää muistaa
merkitä kommenttimerkit joka rivin alkuun, jos ne ovat tarpeen. Jos kommentit
ovat sulkujen tai vastaavien sisällä, ne voivat olla monirivisiäkin, mutta jos
kommenttirivi alkaa merkinnällä # tai vastaavalla, ne lisätään joka rivin
alkuun.
Koodilistaus 1.22: kommentit |
<pre caption="Esimerkkejä">
<comment>(Tämä on koodilistauksen sisäinen
kommenttilohko)</comment>
<comment># Tämä on kuoriskripteissä käytetty koodin sisäinen
# kommenttilohko</comment>
</pre>
|
Note, impo ja warn
Koodilistaus 1.23: vahvistetut laatikot |
<note>
This is a note.
</note>
<warn>
This is a warning.
</warn>
<impo>
This is important.
</impo>
|
Note, impo ja warn suomennetaan sellaisenaan.
Niiden eteen lisäytyy
HTML-versiossa automaattisesti sana Huomaa:, Tärkeää: ja
Varo: vastaavasti, joka kannattaa ottaa huomioon käännöksen sisällössä.
Koodilistaus 1.24: Vahvistusten käännösesimerkit |
<note>
Tällaista pitäisi huomioida.
</note>
<warn>
Tällaisia varotaan.
</warn>
<impo>
Tämä on tärkeää.
</impo>
|
Figure
Figuurit ovat tässä kuvia. Niitä ei usein dokumenteissa näe, valitettavasti.
Ne näyttävät tältä:
Koodilistaus 1.25: Kuva |
<figure link="mygfx.png" short="my picture"
caption="my favorite picture of all time"/>
|
Näistä käännetään short ja caption. Short on kuvan alt-teksti tai title, eli
lyhyt kuvaus kuvan sisällöstä tai lisätieto siitä. Otsikko on kuvan ohessa
esitetty selite. Sekin suomennetaan normaaliin tapaan. Kumpikaan näistä
teksteistä ei yleensä ole täyttä virkettä: ne alkavat pienellä alkukirjaimella
eivätkä pääty välimerkkiin.
Koodilistaus 1.26: Kuvan käännösesimerkki |
<figure link="mygfx.png" short="kuvani"
caption="suosikkikuvani"/>
|
Table
Koodilistaus 1.27: taulukko |
<table>
<tr>
<th>Arch</th>
<th>Subarch</th>
<th>CHOST</th>
</tr>
<tr>
<ti>x86</ti>
<ti>i386</ti>
<ti>i386-pc-linux-gnu</ti>
</tr>
<tr>
<ti>x86</ti>
<ti>i486</ti>
<ti>i486-pc-linux-gnu</ti>
</tr>
<tr>
<ti>x86</ti>
<ti>i586</ti>
<ti>i586-pc-linux-gnu</ti>
</tr>
<tr>
<ti>x86</ti>
<ti>i686 or newer (incl. athlon)</ti>
<ti>i686-pc-linux-gnu</ti>
</tr>
</table>
|
Taulukossa esiintyvät tekstit suomennetaan tavalliseen tapaan. Taulukon
lopulliseen leveyteen kannattaa kiinnittää jonkin verran huomiota. Taulukon
tekstit eivät yleensä sisällä kokonaisia lauseita, tällöin aloitetaan pienellä
alkukirjaimella eikä käytetä välimerkkiä lopussa.
Ul ja ol
Koodilistaus 1.28: Listat |
<ul>
<li>
The <c>xorg-x11</c> ebuild provides the X11
implementation</li>
<li>
For a 2.6.x kernel the DRI modules can be built with the kernel or be
provided by the <c>x11-drm</c> ebuild
</li>
<li>
For a 2.4.x kernel series you must use the <c>x11-drm</c>
ebuild
</li>
</ul>
|
Listat käännetään suhteellisen suoraan suomeksi. Kuitenkin englanninkielisestä
mallista poiketaan siinä, että jos listan kohdat eivät sisällä kokonaisia
lauseita, ja ne liittyvät toisiinsa ja niitä edeltävään lauseeseen,
ne aloitetaan pienellä alkukirjaimella, ja piste tulee vain viimeisen kohdan
jälkeen. Jos lista ei kuulu sitä edeltävään lauseeseen, ensimmäinen listan
kohta aloitetaan isolla. Jos listan kohdat ovat itsenäisiä lauseita, kuten yllä
esimerkissä, ne käännetään lauseiksi isoine alkukirjaimineen ja välimerkkeineen.
Koodilistaus 1.29: Listojen käännösesimerkit |
<ul>
<li>
Paketissa <c>xorg-x11</c> on X11-toteutus.</li>
<li>
2.6-version ytimissä DRI-ajurit voidaan kääntää ytimeen mukaan tai
käyttää erillistä <c>x11-drm</c>-pakettia.
</li>
<li>
2.4-version ytimissä pitää käyttää <c>x11-drm</c>-pakettia.
</li>
</ul>
|
Viittaukset ja id-attribuutit
Koodilistaus 1.30: Using the id attribute |
<chapter id="foo">
<title>This is foo!</title>
…
<p>
More information can be found in the <uri link="#foo">foo
chapter</uri>
</p>
|
Id-attribuutteja ei tarvitse kääntää, mutta halutessaan sen voi toki
tehdä. Tällöin myös vastaavat risuaitalinkit käännetään täsmälleen samoin.
Jos dokumentissa on risuaitalinkkejä muotoa <uri
link="#doc_chap1">Chapter One</uri>, <uri
link="#doc_chap1_sect2">section two of
Chapter One</uri>, <uri
link="#doc_chap1_fig3">figure 1.3</uri> tai <uri
link="#doc_chap2_pre2">code listing 2.2</uri>, niiden
doc_chap-osiot jätetään ennalleen, mutta sisältö suomennetaan vastaamaan
suurin piirtein sen kappaleen, osan tai kuvan otsikkoa, johon ne osoittavat.
2.
Suomen kielioppi
Perusteet
Lause alkaa suuraakkosella. Aina. Otsikko alkaa suuraakkosella. Otsikon muut
sanat eivät ala suuraakkosilla. Lauseita erotetaan toisistaan pilkuilla
pilkkusääntöjen mukaisesti. Yhdyssanat kirjoitetaan yhteen, ilman välilyöntejä
sanojen väleissä.
Unicode-merkit
UTF-8 on pakollinen merkistö Gentoon ohjeissa. Myös Unicode-merkkejä tulee
suosia vanhentuneiden ASCII-korvikkeiden sijaan.
- lainausmerkki on ” eikä "
- Puolilainausmerkki on ’ eikä '
-
ajatusviiva on — eikä - eikä --
(sitä ei useinkaan tarvita opasteksteissä)
-
ellipsinä eli pistekolmikkona kannattaa käyttää merkkiä …,
mahdollista on myös kolme pistettä ...
Oikeiden merkkien kirjoittamiseen vim on loistava editori. Lainausmerkit
kirjoitetaan CTRL-K " 9, puolilainausmerkit CTRL-K ' 9 ja
ajatusviiva CTRL-K M - (m isolla eli shiftin kanssa).
Myös kaikki riittävän tuoretta X:ää käyttävät voivat kirjoittaa merkit suoraan
näppäimistöltä: Shift-AltGr-2 on ”, AltGr-, on ’ ja
AltGr-- on –.
Sanasto
Tässä sanastossa on lähinnä Gentoo-keskeistä sanastoa, sekä niitä termejä,
joiden käännökset ATK-sanakirjoissa ja esimerkiksi avointen ohjelmien lokalisointiprojektin
sanakirjassa ovat Gentoon suomennoksiin huonompia. Muistettava on,
että Gentoo on kohdeyleisöltään vieläkin ensi sijassa
tehokäyttäjien ja harrastajien distro, yleiskieliset ilmaukset eivät aina ole
siis yhtä sopivia oppaissa kuin vastaavat ammattislangin ilmaukset. Jos
hankalaa termiä ei kuitenkaan löydy tästä luettelosta, on varmaankin
lokalisointi.orgin sanakirjan ratkaisu pätevä, tai viime kädessä voi turvautua
jopa tietotekniikan liiton ATK-sanakirjaan, jos siihen on varaa eikä
kaupallisen tuotteen tukeminen haittaa.
Aakkoslinkit
A
B
| Englanti |
Suomi |
Muuta |
| Block devices |
lohkolaitteet,
lohkolaitetiedostot |
Keksi parempi |
| Boot (to) |
käynnistää, buutata |
|
| Bootloader |
käynnistyslatain |
|
| Bootsequence |
käynnistyssekvenssi |
|
| Bootstrap(ping) |
bootstrappaus |
|
| Broadcast address |
broadcast(-osoite) |
Ei yhteislähetysosoite |
| Bug |
bugi |
Ei ohjelmistovika tai -virhe |
C
| Englanti |
Suomi |
Muuta |
| CD, CDROM |
CD, romppu |
|
D
| Englanti |
Suomi |
Muuta |
| Daemon |
palvelu, palvelin |
Ei demoni |
| Directory |
hakemisto |
Ei kansio |
E
| Englanti |
Suomi |
Muuta |
| Emerge (to) |
asentaa (emergellä), emergata |
|
F
| Englanti |
Suomi |
Muuta |
| Filesystem |
tiedostojärjestelmä |
|
| Flag |
flägi, asetus |
Yleensä kyseessä on siis tosi/epätosi-asetus |
| Framebuffer |
framebuffer|i |
|
G
| Englanti |
Suomi |
Muuta |
| Gateway |
gateway |
|
| GRP |
GRP |
|
H
I
| Englanti |
Suomi |
Muuta |
| Init script |
initskripti |
ei alkukäynnistyskomentojonotiedosto |
J
K
| Englanti |
Suomi |
Muuta |
| Kernel |
ydin, (kernel|i) |
|
| Keymap |
näppäinkartta |
|
L
| Englanti |
Suomi |
Muuta |
| Log |
loki |
|
M
N
| Englanti |
Suomi |
Muuta |
| Nameserver |
nimipalvelin |
|
| Netmask |
verkon peite, netmask |
ei verkkonaamari |
O
| Englanti |
Suomi |
Muuta |
| Overlay |
Ohjelmistohakemisto, overlay |
Ks.
myös Portagepuu
|
P
| Englanti |
Suomi |
Muuta |
| Package |
paketti |
|
| Patch |
pätsi, korjauspaikka, -päivitys
tms. |
|
| Platform |
alusta |
|
| Portage |
Portage |
|
| Portage tree |
Portagepuu |
mutta:
ohjelmistohakemisto jos kyseessä muu pakettipuu kuin
/usr/portage
|
Q
R
| Englanti |
Suomi |
Muuta |
| Runlevel |
Runlevel |
ei juoksutaso |
S
| Englanti |
Suomi |
Muuta |
| Snapshot |
Otos |
|
| Stages |
Staget |
|
| Swap (memory) |
Swap|pi |
ei
heittovaihtomuisti |
T
| Englanti |
Suomi |
Muuta |
| Tarball |
tar-paketti, tarrapallo |
|
U
V
| Englanti |
Suomi |
Muuta |
| Web |
Veppi |
|
| Web browser |
selain |
|
X
Y
Z
3.
Koodaustyyli
Resurssit
Sisennykset ja muut koodiin liittyvät seikat on kuvattuna dokumentissa
GuideXML
guide, mutta jos et muuta niitä niin yleensä lopputulos on ainakin yhtä
hyvä kuin englanninkielinen versionsa.
|
