Dokumentācijas pārveidošana ar "aptconvert"

Formātā APT uzrakstītu dokumentāciju var konvertēt uz dažādiem formātiem. T.sk. uz HTML lapām, uz PDF dokumentiem, uz DocBook utml. Zemāk izklāstīsim dažus tipiskus dokumentācijas iegūšanas gadījumus.

Programmas "aptconvert" instalācija

Savākt programmu aptconvert mājaslapā. Atarhivēt to, teiksim, zem c:\tools\aptconvert-050713. Var pievienot direktoriju C:\tools\aptconvert-050713\distrib sistēmas vides mainīgajam "Path", lai gan "aptconvert" vēlamāk izsaukt ar Ant skripta palīdzību (sk. zemāk), nevis no komandrindas - programmai ir daudz parametru.

Mērķis: Iegūt HTML vietni ar dokumentāciju.

Izčeko projektu "java-eim-parent" un izpilda komandu:

mvn -N clean site 

Karodziņš "-N" ir nepieciešams, lai vietnes veidošana nenotiktu rekursīvi (projektam "java-eim-parent" ir daudzi apakšprojekti, kas atrodas blakus direktorijās, un kuru nosaukumi sākas ar "java-eim-"). Rekursīvas "site" izpildes gadījumā katram no apakšprojektiem arī tiktu veidota "noklusētā" dokumentācija - ikreiz rastos daudz nevajadzīgu failu.

Mērķis: Iegūt PDF dokumentāciju (ar LaTeX

Ir vairākas iespējas, kā iegūt PDF dokumentus. Viena ir APT failus pārveidot par LaTeX, tālāk par DVI, un visbeidzot par PDF. Vai arī APT pārveido par DocBook, pēc tam par FO (Formatted Objects) un visbeidzot par PDF. Aprakstām pieeju, ja lieto LaTeX/DVI starpformātus.

PNG pārveidošana par EPS (Encapsulated Postscript)

Šo risinājumu var izmantot tad, ja dokumentācijai izstrādātājs pievieno jaunus attēlus, un rodas nepieciešamība no jauna gjenerēt PDF.

  1. Instalē Dirka Krauzes bibliotēkas priekš Windows - sk. bmeps, un Windows instalāciju. Rakstīšanas brīdī jaunākā instalācija bija dklibs-win32-1.1.45-user-setup.exe.)
  2. Pievieno Windows sistēmas Path vides mainīgajam C:\Program Files\Krause\bin.
  3. Katrai PNG bildei apakšdirektorijā src/site/resources/images izpilda komandrindu ("kde_start_button" vietā var būt jebkurš cits fails):
    bmeps  kde_start_button.png  kde_start_button.eps
    

Atjaunot failu sarakstu Ant skriptā