vsimko / figconv Goto Github PK

Currently, the tool only runs on Linux.
I hope that it should be possible to support Mac as well (but I don't have a Mac)

Instead of:

Loading /usr/local/bin/../share/figconv-plugins/argparser.sh

The output should be:

Loading /usr/local/share/figconv-plugins/argparser.sh

Users expect that make install actually replaces the old version with the new version (reinstall).

Travis uses Ubuntu 12.04.5 LTS (precise).
This is a known bug, see also:
http://stackoverflow.com/questions/13064600/unoconv-not-working-on-ubuntu-12-04-server

Error is: UnoException during conversion ... Unsupported URL <file:///...>

Rename the project to figconv because multiple output formats will be supported.
See also issue #12

For example using Travis-CI

The soffice --headless /dev/null is called multiple times, which slows down the initialization

if pgrep soffice find a PID, then the unoconv fails

I already tried to use kcov, but didn't have time to finish the implementation:

• https://github.com/SimonKagstrom/kcov
• Makefile

Add some section, probably to README.md about other approaches to keep images in sync with the latex code. For example, knitr and sweave.

• describe the architecture of this app (core concepts)
• how to add plugins
• how to test the app

There is gs mentioned as dependency, but it has been commented out from code.
Is it still needed ?

If I run the tool in some random directory it tries to recursively find images in all subdirectories.

The script now generates PDFs, but it should be possible to generate PNGs as well, e.g. in presentations generated in RStudio (*.Rpres files)
These are markdown files that use PNG images, not PDFs

The current PNG export looks worse than converting the same pdf into png using gimp.

Any artists out there who could make a nice vector-based logo + icon ?

Wrong:

exit CHECK_FAILED

Should be:

exit $CHECK_FAILED

Describe in more details, how to use R to generate images.
There are some assumptions that need to be considered.

Might be interesting

Given filenames with spaces, generating the PDF works, but cropping the PDF breaks:

checking svg ... ok
checking pdf ... ok
checking png ... ok
Selected output format is: pdf
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
This PDF contains only a single page - splitting not needed
Cropping PDF: ./Architektur ... mv: Aufruf von stat für '.pdfcrop' nicht möglich: Datei oder Verzeichnis nicht gefunden
done
Cropping PDF: LoRa.pdf ... mv: Aufruf von stat für '.pdfcrop' nicht möglich: Datei oder Verzeichnis nicht gefunden
done

Rationale

People won't always use all tools for creating their images. For example, someone might install just Dia and not LibreOffice nor Inkscape.

see stty: /dev/stdin: Inappropriate ioctl for device in:

cd images; figconv
Loading /usr/local/bin/../share/figconv-plugins/argparser.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/common-functions.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/dia-input.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/ooo-input.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/pdf-output.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/png-output.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/R-input.sh ... stty: /dev/stdin: Inappropriate ioctl for device
ok
Loading /usr/local/bin/../share/figconv-plugins/svg-input.sh ... ok
Loading /usr/local/bin/../share/figconv-plugins/system-checks.sh ... ok
All plugins loaded.

Testing in a virtual machine

Using vagrant + virtualbox

# we need some virtualization backend, here we use virtualbox
sudo apt-get install virtualbox

# install latest vagrant (1.8+ older versions may not work properly)
https://releases.hashicorp.com/vagrant/1.8.1/vagrant_1.8.1_x86_64.deb
dpkg -i vagrant_1.8.1_x86_64.deb

# the VM will live in this directory
mkdir figconv-vm
cd figconv-vm

# now initialize Ubuntu 12.04 LTS (precise)
# same as Travis-CI uses for automated builds
vagrant init hashicorp/precise64
vagrant up
vagrant ssh

Now, you should be logged into the VM running Ubuntu.

# install git and make first
sudo apt-get install git
sudo apt-get install make

# install mandatory dependencies for figconv
sudo apt-get install poppler-utils
sudo apt-get install texlive-extra-utils

# install optional dependencies for figconv
sudo apt-get install dia                  # diagrams made in dia
sudo apt-get install inkscape             # SVG
sudo apt-get install unoconv libreoffice  # Open/LibreOffice formats
sudo apt-get install r-base-core          # when using R

# now install figconv
git clone --depth 1 https://github.com/vsimko/figconv.git
cd figconv
sudo make install

Sample files in tests/ can now be converted.

figconv

# this lists all generated PDF files
ls tests/*.pdf

# copy the generated files from guest vm to host system
cp -r tests /vagrant
exit # now exit the guest vm

ls -l # list the files in your host system

In the current build https://api.travis-ci.org/jobs/288262764/log.txt?deansi=true

/usr/lib/python2.7/dist-packages/gtk-2.0/gtk/__init__.py:57: GtkWarning: could not open display
  warnings.warn(str(e), _gtk.Warning)

Previously, there were even more warnings:

• see https://s3.amazonaws.com/archive.travis-ci.org/jobs/207718383/log.txt

When missing the file ~/.config/libreoffice is missing (e.g just after installing libreoffice), The following error occures:

Error: Unable to connect or start own listener. Aborting.
I/O Error: Couldn't open file './xyz.pdf': No such file or directory.
/usr/local/bin/../share/figconv-plugins/pdf-output.sh: line 46: [: : integer expression expected

The second time it works because ~/.confg/libreoffice has already been created.
This can be fixed by calling: soffice --headless /dev/null

Anyone interested ?

It could be a small technical report or even a paper.
We could compare multiple approaches, e.g. figconv vs knitr

• readthedocs can build and host documentation
• sphinx is a great tool for writing documentation in RST format
• mkdocs would be even better because it uses Markdown, has a built-in server which refreshes on every change, but it cannot generate PDF and the HTML is not searchable on readthedocs

The script should generate some useful help message when running with -h or --help parameter.

A Debian/Ubuntu/Mint package would be nice

When an instance of Open/LibreOffice is running, the unoconv does not generate any PDF.
Closing the Open/LibreOffice window solves the situation, but a reasonable message should be printed to the user as well.