Wiki-ohje - LibreOfficen verkko-ohjeet

From The Document Foundation Wiki
Jump to: navigation, search

Lyhyesti: http://help.libreoffice.org -Wiki-ohjeiden toteuttamisen perustelut ja työjärjestys.

Perustelut

Miksi Wiki-ohje? Nykyiset .xhp-muotoiset ohjetiedostot ovat kehittäjille ja dokumentoijille työläitä ylläpitää. He tarvitsevat helpompaa yhdessä muokkaamiseen sopivaa työkalua, joka sopii myös lokalisoijille. Wiki on toistaiseksi paras vapaa työkalu yhteistoiminnalliseen muokkaamiseen. Se antaa periaatteellisen mahdollisuuden kenelle tahansa ohjelmiston käyttäjälle täydentävän ohjeen kirjoittamiseen. Hyvän järjestyksen säilyttämiseksi näillä sivuilla vaaditaan kuitenkin muokkaajien kirjautuminen.

Suunnitelma

  • Vain englanninkieliset ohjesivut ovat muokattavia
  • Englanninkielisten ohjesivujen merkkijonot ladataan Pootle-järjestelmään
    • Ohjeiden ylläpitotyötä voi tehdä tavanomaiseen tapaan Pootle-järjestelmässä
    • Sopivaa Translate Toolkit -työkalua käytetään merkkijonojen siirtoon wiki-muoto - txt2po. Tarvittaessa työkalua on laajennettava kattamaan kaikki wiki-ohjeiden tarpeemme
  • Olemassa olevat käännökset muunnetaan
    • Tehtyä työtä ei hukata vaan kaikki jo käännetty on käännettynä wiki-ohjeissakin
  • Pootle-käännökset saavat etusijan englanninkielisiin merkkijonoihin nähden
    • Jos jonkin kielen käännösryhmä päättääkin kääntää suoraan wiki-ohjeisiin, tämän kielen muokkain avautuu suoraan wiki-ohjeisiin

Työjärjestys

  • Parhaillaan .xhp-tiedostoja muunnetaan wiki-muotoon
    • Työ on nähtävissä osoitteessa http://help.libreoffice.org
    • Vaatii viimeistelyä [esim. ei ole vielä selvää, käsitelläänkö jaettu (upotettu) sisältö erikoistapauksena]
    • Virheraportointia kaivataan! File to Bugzilla, and assign to kendy@suse.cz, with wikihelp: <description of the problem> in the subject
    • LibreOffice 3.3 ohjautuu verkko-ohjeisiin, jos ohjelman mukana olevaa ohjetta ei ole asennettu
  • Wiki-ohjeiden sisältö on vietävä .pot-tiedostoihin
    • Voi vaatia txt2po-suodattimen muutostyötä
  • Käännökset .sdf- tai .po-tiedostoista on muunnettava wiki-muotoon
    • Vaatii perusteellista tarkastamista, ettei tietoja häviä
    • On tarkistettava myös se, että kuin käännöstekstiä käytetään englanninkielisen tekstin korvaajana, kaikki näyttää edelleen hyvältä eikä muotoiluja ole hävinnyt

Tulevaksi suunniteltua (3.4)

  • Myöhemmin tarvitaan työkaluja verkko-ohjeiden muuntamiseen ohjelman mukana olevaksi ohjeeksi
    • alustan mukaiseen ohjejärjestelmään
    • Windows/Linux/MacOSX
    • ohjelmointinäkökulmasta emme kaipaa kotikutoista ohjejärjestelmää, joka nyt on käytössä
    • lisää tutkimusta tarvitaan selvittämään, ettemme menetä piirteitä jne.
  • Kun yllämainittu on valmiina, Wiki-ohjeesta tulee määräävä ohjeversio
    • voimme silti edelleen huomioida muutokset .xhp-tiedostoista päivittäessämme OOo:sta

Vielä avoinna

  • Laajennetut vihjeet
    • eivät voi olla wiki-ohjeen osana, todennäköisesti joudutaan käsittelemään erikseen, siis yhä lähdekoodin osana
  • Turvallisuus [Jean-Baptiste Fauren kysymys)
    • häiriöviestien torjunnasta mediawikissä: [1]
    • ja lisää häiriöviesteistä [2]
    • David Nelson ehdottaa ryhmien mukaisia muokkausoikeuksia jäsenille (dev, l10n, doc, ...)
  • Jonathan Aquilina ehdottaa: muokatusta sivusta lähtee viesti listalle, jolloin ryhmä tulee tietoiseksi ja voi tarkastella muutosta
  • Yhteydettömään muokkaamiseen Kendy ehdottaa Wiki -julkaisulisäosan ja mahdollisesti LibreOfficessa olevien versioiden tarkastusominaisuuksien käyttämistä.
  • Tällä hetkellä wiki-järjestelmässä ei voi käyttää sanastoa eikä TMX-käännösmuistia.
  • Entäs asennettujen lisäosien ohjeet? Nykyään lisäosa voi tarjota ohjelman mukana olevan ohjejärjestelmän avulla ohjeita sovelluksien tapaan.
  • Tehokkuusnäkökulmasta voisi olla kiinnostavaa, jos käytössä olisi jonkinlainen käyttäjäkohtainen välimuisti luetuille verkko-ohjeille käyttäjäprofiilissa.