Rokasgrāmatas, Subversion, UDO

Šajā lappusē aprakstīts darbs ar rokasgrāmatas avotiem, izmantojot Subversion un UDO.

Nekas nav vecāks kā rokasgrāmatas vakardienas izdruka.

okasgrāmatām vienmēr jāseko programmu attīstībai, tāpēc ieteicams turēt rokasgrāmatas avotus uz koplietojama servera, lai visiem autoriem un lokalizētājiem būtu tieša pieeja datiem. Mēs ticam, ka Subversion ir ideāls rīks šim darbam.

Subversion pārvalda datus paralēlai rediģēšanai

Pateicoties Subversion (turpmāk tekstā SVN), mēs varam nodrošināt mūsu rokasgrāmatu autoriem un lokalizētājiem tiešu pieeju šo materiālu avotiem un garantēt, ka neviens tos nesabojā, vairāki autori var darboties ar failiem vienlaikus un visiem failiem vienmēr ir unikāls statuss.

ā rokasgrāmatas autoram Jums nav jāsaprot SVN pilnībā, tikai būtiskākais:

1. Repozitorijs
   Rokasgrāmatas dati tiek glabāti 'repozitorijā' uz mūsu SVN servera. Repozitorijs vienmēr ataino šo datu pašreizējo statusu visiem autoriem.
2. Paņemšana
   Ja Jūs lejupielādējat datus no SVN servera uz Jūsu datoru (checkout), Jūs izveidojat 'darba kopiju' uz cietā diska, ko varat rediģēt pēc savām vēlmēm.
3. Nodošana
   Kad Jūs nosūtīsiet veiktās izmaiņas atpakaļ uz SVN serveri (commit), tās tiks pieņemtas un no tā brīža kļūs pieejamas pārējiem autoriem.

Slēgta sabiedrība!

Tikai mūsu izstrādātājiem, rokasgrāmatas autoriem un lokalizētājiem ir pieeja SVN serverim. SVN serveris apkalpo un pārvalda vairākus repozitorijus, bet katram no tiem ir savi pieejas noteikumi. Mēs uzskatām, ka pārāk daudz brīvības var radīt grūtības. Ja Jūs vēlaties iegūt pieeju noteiktam repozitorijam uz mūsu SVN servera, Jums nepieciešams SVN konts un SVN parole. Abi ir pieejami pēc pieprasījuma.

Kā lai iegūstu datus?

OS X

Ja strādājat ar Apple izstrādātāja rīku Xcode, Jums nav jāinstalē citi rīki, jo Xcode atbalsta SVN automātiski. Jums tas tikai jāaktivē. Skatiet Xcode rokasgrāmatu, lai uzzinātu kā.

Citādi nepieciešams Subversion un grafiskā lietotāja saskarne (GUI), lai Checkout un Commit operācijas būtu patīkamākas nekā parastā komandu rinda.

• Subversion
• SVN GUI: SmartSVN
• opcionāls SVN GUI: svnX

Windows

Nepieciešams Subversion un grafiskā lietotāja (GUI), lai Checkout un Commit operācijas būtu patīkamākas nekā parastā komandu rinda. Mēs iesakām TortoiseSVN.

• Subversion
• SVN GUI: TortoiseSVN

Kā izskatās rokasgrāmatas avoti?

Mēs rakstām rokasgrāmatas UDO formātā, kas ir universāls dokumentu formāts ar vienkāršu pieeju. Repozitoriji pamatā ir organizēti pēc zemāk dotā parauga (attiecas uz OS X programmām):

/cs.lproj/
/cs.lproj/<Help Book name>/
/da.lproj/
/da.lproj/<Help Book name>/
/de.lproj/
/de.lproj/<Help Book name>/
/en.lproj/
/en.lproj/<Help Book name>/
/fr.lproj/
/fr.lproj/<Help Book name>/
/it.lproj/
/it.lproj/<Help Book name>/
/nl.lproj/
/nl.lproj/<Help Book name>/
/UDoSource/
/UDoSource/_INCLUDE/
/UDoSource/<various folders>
/UDoSource/<ProjectName>_main_cs.u
/UDoSource/<ProjectName>_main_da.u
/UDoSource/<ProjectName>_main_de.u
/UDoSource/<ProjectName>_main_en.u
/UDoSource/<ProjectName>_main_fr.u
/UDoSource/<ProjectName>_main_it.u
/UDoSource/<ProjectName>_main_nl.u

Augstāk parādītā *.lproj mapju struktūra ir kopija no noteiktu valodu projektu mapēm. Tās satur Apple Help Book mapes, kas tieši pārkopējamas uz programmas avotiem.

Mape UDoSource satur visus lokalizējamos datus. Mēs esam noteikuši savu failu paplašinājumu nomenklatūru:

• .cs = čehu teksta faili
• .da = dāņu teksta faili
• .de = vācu teksta faili
• .en = angļu teksta faili
• .fr = franču teksta faili
• .it = itāļu teksta faili
• .lv = latviešu teksta faili
• .nl = nīderlandiešu teksta faili

• .u = UDO komandfaili
• .ui = UDO ietvertie faili
• .uli = UDO bibliotēkas ietvertie faili

Protams, repozitorijiem nav jāsatur tieši šīs nosauktās mapes un valodas.

Kas ir UDO formāts?

UDO izmanto ļoti vienkāršu sintaksi teksta strukturēšanai, teksta atribūtu pievienošanai, attēlu un saišu ietveršanai utt. UDO galvenā iezīme ir vienkāršā pieeja, kaut tiek piedāvāts ļoti daudz komandu. Mēs cenšamies izvairīties no 'iespēju pārbagātības' mūsu rokasgrāmatās un izmantojam tikai dažus UDO sintakses elementus. Šeit ir daži piemēri:

Teksta strukturēšana

!begin_node sāk jaunu nodaļu.
!end_node beidz nodaļu.
# rindas sākumā dod norādi UDO ignorēt visu rindu (komentāru rinda).
!hline parāda horizontālu līniju.
(!nl) līnijas pārtaukums. (Pamatā UDO aizver teksta rindkopu, kad atpazīst divas rindu beigas.)

Teksta atribūti

(!B) un (!b) ieslēdz/izslēdz treknrakstu.
(!I) un (!i) ieslēdz/izslēdz slīprakstu.
(!U) un (!u) ieslēdz/izslēdz pasvītrojumu.

(Ir daudz citu atribūtu komandu; lielāko daļu mēs ignorējam.)

Saraksti

!begin_itemize un !end_itemize aptver nešķirota saraksta laukumu.
!begin_enumerate un !end_enumerate aptver numurēta saraksta laukumu.
!begin_description un !end_description aptver aprakstoša saraksta laukumu.
!item sāk saraksta vienumu.

(Ir daudz citu izkārtojuma komandu; lielāko daļu mēs ignorējam.)