LibreOffice API dokumentáció a weben

LibreOffice logó A LibreOffice – akárcsak őse az Openoffice.org – nyelvfüggetlen alkalmazásprogramozási interfésszel (API-val) rendelkezik, ami lehetővé teszi az irodai szoftver programozását különféle programozási nyelveken (pl. C++, Java, Python, CLI, StarBasic, JavaScript, OLE). A LibreOffice szolgáltatásokat nyújthat más alkalmazásoknak, új funkciókkal ruházható fel, vagy egyszerűen csak testre szabható vagy vezérelhető. A LibreOffice SDK az a csomag, amely az ilyen fejlesztésekhez szükséges eszközöket és dokumentációkat tartalmazza. A dokumentáció egy része a forráskódból generálódik, többek között az API dokumentációja is.

A müncheni HackFesten az egyik este Cédric Bosdonnat ült mellettem, és megkérdezte: András, akarsz valamit hackelni? Mivel a saját problémámmal épp nem álltam valami jól, gondoltam nem lesz rossz meghallgatni, hogy mire gondolt, hátha az jobban megy. Azt mondta, hogy szeretnék a weben látni a LibreOffice API dokumentációt, mert a régi OpenOffice.org-os weblapok mostanában gyakran elérhetetlenek, meg különben is, kell saját. Gyorsan létrehoztunk egy virtuális webszervert, és megnéztem, mi a teendő az SDK dokumentációjában levő HTML-ekkel. Elég ronda volt HTML-kód, az oldalak az egykor népszerű táblázatos elrendezéssel készültek, illetve a Java API dokumentáció frame-es. Úgy döntöttem, hogy ezen egyelőre nem változtatok, csak kicseréltem az OpenOffice.org logókat LibreOffice logókra, az oldal alján a jogi szöveget a hivatalos LibreOffice szövegre cseréltem, a CSS-ekben pedig a színeket átállítottam a LibreOffice színvilágára jellemző zöldekre az addigi kékek helyett. Később a főoldalt és a nem generált másik két oldalt a LibreOffice honlap stílusára alakítottam, végül a főoldalhoz adtam egy Google keresőmezőt. Az egész nem vett többet igénybe néhány óránál.

Az eredmény az api.libreoffice.org oldal lett. Meglepett az oldal kedvező fogadtatása. Már a helyszínen, Münchenben is nagy volt a lelkesedés, de később az IRC-n és e-mailben is többen gratuláltak. Azt gondoltam volna, hogy nem nagy dolog volt ez, de valamiért a fejlesztőknek tetszett. Talán ők nem álltak volna neki HTML-t és CSS-t faragni, és örültek, hogy valaki megcsinálta.

A munka folytatható. Először is van még az SDK dokumentációjában pár oldal, ami nincs fent most a weben, de átalakítandó a LibreOffice-os stílusra. Ezen kívül felvetődött, hogy a Java API dokumentációt olyan formátumra kellene hozni, hogy az Eclipse vagy a Netbeans maga alá tudja szedni. Egyesek még messzebb gondoltak, és a saját autodoc modult kidobnák, hogy ne kelljen karbantartani, és helyette valami szabványos kész megoldást (Doxygen?) látnának szívesen.

Vélemény, hozzászólás?

Az email címet nem tesszük közzé. A kötelező mezőket * karakterrel jelöljük.