Muokkaa markup-merkkejä

From KDE TechBase
Revision as of 17:08, 23 December 2012 by Centerlink (talk | contribs)

Käytettävissä olevat työkalut

  • Special:MyLanguage/Typographical_Guidelines standardisoi kotoistamisessa käytettävät markup-merkinnät, joko virallisia käsikirjoja varten (DocBook) tai muille kielille. Viittaa tähän taajaan, koska markup-merkkejä määritellään uudelleen täsmäämään kotoistajien tarpeita.

Työnkulku vaihe 1

Vanhan markup-merkinnän korjaaminen

  • Tarkista, että jokaista lohkon tai alilohkon otsaketta seuraa tyhjä rivi.
  • Monille sivuille on asetettu useita sisennyksiä. Tämä sisällytettiin aikaisempaan mediawiki-dokumentaatioon, mutta ei ole enää hyväksyttävää, koska se aiheuttaa pulmia muiden muotojen viennissä, joten järjestele uudelleen käyttäen vain yksittäisiä sisennyksiä. Etumerkki-luettelot voivat edelleen olla sisäkkäisiä.
  • ASCII-hymiöt aiheuttavat pulmia ja ne on poistettava. Ne voidaan korvata pienikokoisilla (11px?) oxygen-kuvakkeilla. Monia muita on saatavilla Wikimedia Commons -sivustolta - lisätiedot lisätään tänne.
  • Muotoa [[Kotoistamistyökulku]] olevat sisäiset linkit olisi muokattava täydelliseen muotoon, jotka näyttävät linkin, sitten näkyvän tekstin, kuten [[Special:myLanguage/Translation_Workflow|Kotoistamistyökulku]]
  • Syöttötekstin näyttämiseen on käytetty monia tyylejä, mukaan lukien <code>, <pre> ja taulukot ja laatikot. Käyttäjän syötteeksi tarkoitetun tekstin tulisi käyttää Input-mallinnetta, {{Input|1=syöteteksti (voi olla useita rivejä tai yksi rivi)}}. Voit yhä käyttää <code> hyvin lyhyelle syötteelle, jos et halua tekstin esiintyvän usealla rivillä.
  • Pääteikkunatulosteet ja virheilmoitusviestit on samalla tavalla merkitty vaihtelevasti. Nämä tulisi korvata Output-mallinteella, {{Output|1=pääteikkunatuloste}}
  • Jokaisen sivun tulisi päättyä Category-luokkalauseeseen. Näiden on oltava standardisoituja luokkia. Luokkien nykyinen luettelo löydetään miltä tahansa kotoistajan sivulta linkitettynä tämä kielisivu
  • Varmista, että missään kappaleessa ei ole parittomia sulkeita. Jos löydät parittomia sulkeita, lisää puuttuvat sulkeet — mahdollisesti kommenteissa kuten tämä:
    <!--(--> a)
  • Luetteloissa pitäisi olla etumerkkirivien välissä tyhjä rivi. Katso kappeleita luetteloissa Etumerkilliset luettelot.
  • Taulukot pitäisi jakaa samalla tavalla niin että jokaisen rivin välissä on tyhjä rivi. Ensimmäisellä ja viimeisellä rivillä on oltava parilliset aaltosulkeet.

Vaihe 2 - Opas uuteen markup-merkintään

Merkitään linkit kotoistamiseen

  • Yksittäisen linkin, sellaisen kuin sovelluksen nimi kohteessa Applications/Internet, pitäisi käyttää muotoa [[Special:myLanguage/Ark|<translate>Ark</translate>]]
  • Siellä missä linkki on lauseen sisällä, koko linkki pitäisi pitää kotoistettavan viestin sisällä.

Erityistunnisteet

  • Tunnista kaikki näppäimistön näppäinnimet, ja tagitunnisteet, esim.: <keycap>Enter</keycap>
  • Sisällytä samanaikaisen näppäinten painallukset <keycap> -tagitunniste, esim.: Ctrl + Alt + F1. Huomaa, että erotin on (välilyönti)+(välilyönti)
  • Kohtele valikkosarjoja samalla tavalla käyttäen <menuchoice> -tagitunnistetta, esim.: System Settings -> Account Details -> Social Desktop. Huomaa, että erotin on (välilyönti)->(välilyönti)
Varoitus
ÄLÄ KOSKAAN lisää translate-lohkotagitunnisteita (niitä, jotka näyttävät seuraavilta < !--T:18-- >). Ohjelmisto tekee kaikkien vaadittujen tagitunnisteiden käsittelyn, ja manuaaliset muutokset rikkovat järjestelmän.


Lihavoidut

  • Tunnista ohjelmanimet ja merkitse ne lihavoituna, esim.: Klipper
  • Tunnista nimiöt ja nimet, joita käyttäjä ei voi muuttaa, ja merkitse ne lihavoiduiksi.
  • Poista kaikki aikaisemmat lihavoinnit, jotka on kirjoitettu aiemmin, mutta jotka eivät täsmää tähän ohjeeseen. (Katso alle sanan tai fraasin painottamisesta.)
  • Ikkunan otsikkotekstit ja kuvakkeiden nimiöt merkitään myös lihavoiduiksi.

Kursiivit

  • Kursivointia käytetään painottamiseen kuten tehdään ei-teknisessä kirjoittamisessa
  • Käytä kursiivia epätavallisen sanan tai fraasin ensimmäisessä esiintymisessä, ja jos mahdollista, linkitä se kohteeseen #Glossary tai sanakirjasanaan.
  • Kun viitataan muihin (ulkoisiin) teoksiin, otsikot kursivoidaan.

Yhdistetty lihavointi ja kursivointi

  • Tätä pitäisi käyttää ainoastaan asiayhteydessä, jossa käyttäjä on korvannut tekstiä, esim.: "Uudet osoitekirjatietueesi ovat kohteessa /home/user/share/contacts"
Vihje
Yksinkertaistettuja määrittelyjä - käyttäjät käynnistävät Ohjelmia, ohjelmat käyttävät komponentteja


Kohteet, jotka aiheuttavat kotoistamispulmia

Useat kohteet on tunnistettu ja niistä on keskusteltu, ja ehdotetut ratkaisut ovat seuraavassa kappaleessa:

Nämä havaitaan tavallisesti ensimmäisen markup-merkinnän jälkeen ja saattaa olla välttämätöntä järjestää uudelleen välit ja/tai rakenne pulmien välttämiseksi.

Lähes valmis

  • Kirjoita lopussa olevaan yhteenvetokenttään, mitä olet tehnyt markup-muokkauksessa.
  • Käytä Esikatselu ja lue koko työsi lävitse. Jos olet tyytyväinen, tallenna sivu.
  • Käytä sivupalkin linkkiä julkaisun pyytämiseen - se ottaa sivusi, kun lisäät muokkaamasi sivun verkko-osoitteen. Linkkisi liittäminen sinne kertoo meille, että uskot sivun olevan valmis kotoistajien työskentelyä varten. Tutkimme sitä, ja jos olemme tyytyväisiä, otamme sen mukaan kotoistamiseen.