CTAN Comprehensive TeX Archive Network

Direc­tory support/pdbf-toolkit

README.md

PDBF - A Toolkit for Creat­ing Jan­i­form Data Doc­u­ments

Ver­sion 1.2.5

Bugs, Sugges­tions, Fea­ture re­quests

If you en­counter bugs, have sug­ges­tions or have a fea­ture re­quest, then please go to the is­sue page open a new is­sue if nec­es­sary and ex­plain your con­cern. You can also write us an email (ich­binkein­reh at t-on­line.de or jens.dit­trich at cs.uni-saar­land.de).

Pre­sen­ta­tion video

Ab­stract

PDBF doc­u­ments are a hy­brid for­mat. They are a valid PDF and a valid HTML page at the same time. You can now op­tion­ally add an Vir­tu­alBox OVA file with a com­plete op­er­at­ing sys­tem to the PDBF doc­u­ment. Yes, this means that the re­sult­ing file is a valid PDF, HTML, and OVA file at the same time. If you change the file ex­ten­sion to PDF and open it with an PDF viewer, you can see the static part of the doc­u­ment. If you change the file ex­ten­sion to HTML and open it with a Browser (cur­rently Chrome/Fire­fox/Sa­fari/IE 10 sup­ported), you can see the dy­namic part of the doc­u­ment. And if an ova file is at­tached you can also change the file ex­ten­sion to OVA and in­stall and run the at­tached op­er­at­ing sys­tem. The dif­fer­ence be­tween the PDF and the HTML ver­sion is that the PDF ver­sion con­tains static ver­sion of all PDBF el­e­ments, whereas the HTML ver­sion is dy­namic. For ex­am­ple you can zoom into graphs, tem­po­rarly re­move dataseries from the graph, in­spect and change the un­der­ling query of the PDBF el­e­ment and see the re­sult of the change di­rectly in the browser. This ap­proach works com­pletely of­fline. No in­ter­net con­nec­tion is re­quired, nei­ther at com­pile time, nor at view­ing time.

PDBF files are cre­ated from source code and a re­la­tional database. The raw data can ei­ther be a SQL state­ment string, a file with SQL state­ments, or con­tained in a database (cur­rently Post­greSQL/MySQL/Mari­aDB sup­ported). In the code you can then spec­ify how the PDBF el­e­ment (cur­rently charts/pivot ta­bles/mul­ti­plot charts/sql state­ments/dataTexts/dataTables are sup­ported) is cre­ated from the raw data with op­tions and an SQL query. Read more in the doc­u­men­ta­tion, which is it­self is a PDBF doc­u­ment.

PDBF toolkit is writ­ten in Java and and can be used to com­pile doc­u­ments on Win­dows, Mac, and Linux. PDBF doc­u­ments are also plat­form in­de­pen­dent and run on any desk­top OS (Win­dows, Linux, Mac) with a browser/PDF viewer.

A demo pa­per of our tool ap­peared at VLDB 2015. Note: The pa­per was build with an old ver­sion of PDBF. To see an up to date ex­am­ple of PDBF look at the doc­u­men­ta­tion.

Li­cense

This toolkit is li­censed unter the MIT Li­cense (see here)

Get­ting started

Nor­mal us­age
  • Make sure you have a Java Run­time (ver­sion >= 1.7) and a dis­tri­bu­tion in­stalled
  • Down­load the lat­est ver­sion
  • Ex­tract zip and change work­ingdir to ex­tracted folder
  • Ad­just con­fig.cfg
  • Try to com­pile min­i­mal.tex file with this com­mand: java -jar pdbf.jar min­i­mal.tex
  • Open min­i­mal.html, this is the fi­nal out­put of the com­pi­la­tion pro­cess, if you re­name it to ".pdf" it is also a valid pdf-doc­u­ment
At­tach a Vir­tu­alBox im­age
  • Op­tion­ally you can at­tach the in­cluded vldb-In­vaders.ova (Space in­vaders clone) or down­load the dsl.ova (Damn small linux) Vir­tu­alBox im­age and at­tach it to the com­piled PDBF file with this com­mand: java -jar pdbf.jar –vm min­i­mal.html vldb-In­vaders.ova
  • Open min­i­mal.ova (if you have Vir­tu­alBox in­stalled), this is the fi­nal out­put with the at­tached ova file. Its still a valid pdf and html file at the same time.
At­tach a tar archive
  • Op­tion­ally you can at­tach a tar archive file to the com­piled PDBF file with this com­mand: java -jar pdbf.jar –tar min­i­mal.html TARfile.tar
  • Open min­i­mal.tar, this is the fi­nal out­put with the at­tached tar file. Its still a valid pdf and html file at the same time.
Learn how to use the PDBF frame­work
  • You can play around with the min­i­mal.tex file. It con­tains a small ex­am­ple on how to spec­ify PDBF el­e­ments in
  • For fur­ther in­for­ma­tion take a look at the doc­u­men­ta­tion

Fea­tures

Au­to­matic gen­er­a­tion of Charts, Mul­ti­plot Charts, Pivot ta­bles

With PDBF you don't need to man­u­ally gen­er­ate these kinds of el­e­ments. The PDBF com­piler au­to­mat­i­cally gen­er­ates a static ver­sion for the pdf and the dy­namic ver­sion for the html part of the PDBF doc­u­ment. This also means that your doc­u­ment is al­ways up to date! If you change some­thing in the un­der­ly­ing data that gen­er­ate your PDBF doc­u­ment and then re­com­pile the doc­u­ment, then the data in the doc­u­ment is up to date. No need to man­u­ally up­date ex­ter­nally gen­er­ated charts or pivot ta­bles.

Gen­er­ate your doc­u­ment di­rectly from the re­sults of your ex­per­i­ment

The idea of PDBF is to store the re­sults of the ex­per­i­ment di­rectly in the doc­u­ment and to make it more trans­par­ent how this chart, pivot ta­ble, etc. was gen­er­ated from the re­sult data. There­fore we cur­rently sup­port CSV files, SQL files, and SQL servers as data sources and use SQL as de­scrip­tion lan­guage for the trans­for­ma­tion of the raw re­sult data to the fi­nal rep­re­sen­ta­tion in the doc­u­ment.

Com­pile to sin­gle HTML file

You can also use the PDBF com­piler to com­pile your files to a sin­gle HTML file. To do so just run the com­piler as on any other doc­u­ment (you dont need to in­clude the pdbf pack­age in your tex file):

java -jar pdbf.jar some­tex­file.tex

The re­sult­ing HTML file is saved in the same folder with the same name but html end­ing.

Build In­struc­tions

  • Run "mvn pack­age" if you only want to com­pile pdbf.jar
  • Run "mvn ver­ify" if you want to com­pile pdbf.jar and run in­te­gra­tion tests.

Note: The com­piled pdbf.jar is au­to­mat­i­cally copied from tar­get to the main folder.

Thanks to the au­thors of:

Down­load the con­tents of this pack­age in one zip archive (109.3M).

pdbf-toolkit – A Toolkit for Creat­ing Jan­i­form Data Doc­u­ments

PDBF doc­u­ments are a hy­brid for­mat. They are a valid PDF and a valid HTML page at the same time. You can now op­tion­ally add an Vir­tu­alBox OVA file with a com­plete op­er­at­ing sys­tem to the PDBF doc­u­ment. This means that the re­sult­ing file is a valid PDF, HTML, and OVA file at the same time.

If you change the file ex­ten­sion to PDF and open it with an PDF viewer, you can see the static part of the doc­u­ment. If you change the file ex­ten­sion to HTML and open it with a Browser (cur­rently Chrome, Fire­fox, Sa­fari, and IE 10 are sup­ported), you can see the dy­namic part of the doc­u­ment. And if an ova file is at­tached you can also change the file ex­ten­sion to OVA and in­stall and run the at­tached op­er­at­ing sys­tem.

The dif­fer­ence be­tween the PDF and the HTML ver­sion is that the PDF ver­sion con­tains a static ver­sion of all PDBF el­e­ments, whereas the HTML ver­sion is dy­namic. For ex­am­ple you can zoom into graphs, tem­porar­ily re­move dataseries from the graph, in­spect and change the un­der­ling query of the PDBF el­e­ment and see the re­sult of the change di­rectly in the browser. This ap­proach works com­pletely of­fline. No in­ter­net con­nec­tion is re­quired, nei­ther at com­pile time, nor at view­ing time.

The toolkit is li­censed un­der the MIT Li­cense.

Pack­agepdbf-toolkit
Re­pos­i­toryhttp://uds-data­lab.github.io/PDBF
Ver­sion1.2.5
Li­censesMIT Li­cense
Main­tainerPa­trick Ben­der
TopicsCon­vert other
Con­vert HTML
...
Guest Book Sitemap Contact Contact Author