RoboHelp: Automatizare prin batch (rhcl.exe)

Deși multă lume pare să nu știe de ea, versiunea command line a RoboHelp-ului poate fi extrem de utilă pentru automatizarea (parțială sau totală) a build-urilor de help.

Ce este rhcl.exe?

Numele utilitarului vine de la RoboHelp Command Line și îți permite să generezi un SSL fără să deschizi RoboHelp-ul în sine. Pentru sisteme mici de documentație, efortul de a da dublu-click pe un .xpj e neglijabil, dar dacă ai 20 de module, s-ar putea să aștepți mai mult să se deschidă modulul decât durează buildul propriu-zis… și aici intervine rhcl.

Cum se folosește?

Foarte simplu, pentru că are doar câțiva parametri (pe care nu o să îi enumăr aici, pentru că sunt disponibili în documentația de la Adobe).

O linie de comandă foarte simplă e de forma:

rhcl c:\sources\project1\project1.xpj -l WebHelp -o c:\builds\project1

În traducere, mai întâi e numele executabilului, apoi (fără nici un parametru) path-ul unde se află xpj-ul proiectului pe care vrei să îl generezi, apoi (cu parametrul -l) numele layout-ului care trebuie generat, iar la sfârșit (cu parametrul -o) locul unde se generează fișierele.

Pentru ce am eu nevoie la muncă, parametrii ăștia sunt suficienți. Dacă vrei, poți să folosești rhcl și ca să publici un layout (cu opțiunea -p) sau să generezi loguri (cu opțiunea -g), dar eu nu lucrat prea mult cu asta.

Batch-ul meu arată ceva de genul asta:

Alte idei

Nu le-am testat personal, dar în teorie rhcl ar putea fi folosit ca parte a unui sistem mai complex, de exemplu unul care să republice în fiecare zi documentația modificată în ziua anterioară, urmând pașii:

  1. Update automat al documentației din source control (folosind interfața command line a sistemului de source control).
  2. Generare batch pe hardul local (folosind rhcl).
  3. Publicare batch pe un server (folosind rhcl).

Tips & tricks/Troubleshooting

  • Dacă liniile tale de comandă încep cu rhcl, trebuie ca fișierul .bat să fie salvat în folderul în care se găsește și rhcl.exe. Dacă, în loc de rhcl simplu, folosești path-ul absolut către executabil (de exemplu C:\Program Files (x86)\Adobe\Adobe RoboHelp 2015\RoboHTML\rhcl.exe), poți să salvezi fișierul .bat oriunde pe hard.
  • Dacă orice path conține spații, trebuie să fie pus între ghilimele.
  • rhcl probabil că nu este prea sus pe lista de priorități a celor de la Adobe, deci nu e întotdeauna testat cum trebuie. În RoboHelp 2015, dacă încercai să generezi helpul folosind rhcl și aveai conditional build tags excluse din SSL, outputul nu era corect (tot conținutul care avea un tag era exclus, chiar dacă în SSL apărea ca inclus). Bugul a fost rezolvat în update-ul 2.
  • Unele module refuză să se genereze prin batch, fără un motiv evident. Nu am o soluție în afară de generat modulul respectiv de mână (din interfața RoboHelp).
  • În RoboHelp 2015, dacă nu poți genera nimic prin batch, instalează update-urile KB2758694 and KB954430 de la Microsoft.

Lasă un răspuns

Adresa ta de email nu va fi publicată. Câmpurile obligatorii sunt marcate cu *