Muokkaa markup-merkkejä

From KDE TechBase
Revision as of 13:58, 2 September 2011 by Centerlink (talk | contribs) (Created page with "* Luetteloissa pitäisi olla etumerkkirivien välissä tyhjä rivi. Katso kappeleita luetteloissa Etumerkilliset luettelot.")

Käytettävissä olevat työkalut

  • 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 muokattavat 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.
  • Tables should be split in a similar manner, so that there is a blank line between each row. The first and last items will need to have curly braces balanced.

Stage 2 - Guide to new markup

Marking Links for Translation

  • A stand-alone link, such as the application-names in Applications/Internet, should use the form [[Special:myLanguage/Ark|<translate>Ark</translate>]]
  • Where the link is within a sentence the whole of the link should be kept within the translatable message.

Special Tags

  • Identify all keyboard key-names, and tag, e.g. <keycap>Enter</keycap>
  • Include concurrent keypresses in the <keycap> tag, e.g. Ctrl + Alt + F1. Note that the separator is (space)+(space)
  • Treat menu sequences in a similar manner, using the <menuchoice> tag, e.g.System Settings -> Account Details -> Social Desktop. Note that the separator is (space)->(space)
Warning
NEVER add translate section tags (the ones that look like < !--T:18-- >). The software will do any handling of tags that is required, and manually changing them will break the system.


Bold type

  • Identify program names and mark them as bold type, e.g. Klipper
  • Identify labels and names that cannot be changed by the user, and mark them as bold type.
  • Remove any bold type marking that were previously entered, but do not match this guideline. (See below for emphasizing a word or phrase.)
  • Window captions and Icon labels are also marked as bold type.

Italics

  • Italics can be used to give emphasis as you might in non-technical writing
  • Use italics on the first appearance of an unfamiliar word or phrase, and if possible link it to #Glossary or a dictionary entry.
  • When referencing other (external) works, titles are italicized.

Combined Bold and Italics

  • This should only be used in the context of an example where the user has to substitute text, e.g. "Your new addressbook records are in /home/user/share/contacts"
Tip
Simplified definitions - Programs are launched by users, components are used by programs


Issues that cause Translate problems

Several issues have been identified and discussed, and solutions proposed in the following sections:

These are usually noticed after the first markup, and it may be necessary to re-arrange spacing and/or structure to avoid the problems.

Almost finished

  • In the summary field at the bottom, enter that you are doing a markup edit.
  • Use Preview and read through the whole of your work. If you are satisfied, save the page.
  • Use the link in the sidebar to request release - it takes you to a page where you can add the URL of the page you have edited. Pasting your link there tells us that you believe the page to be ready for translators to work with. We will scan it, and if satisfied we will enable it for translation.