Some test text!
Welcome to PDFTron. Ruby for the PDFTron SDK is supported on Linux and macOS. To get started, choose your preferred platform from the tabs below.
This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run PDFTron samples and integrate the PDFTron SDK into Ruby applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.
Ruby version 2.x
CMake version ≥ 2.8
SWIG 2.0.4 - 2.0.12 or SWIG 3.x
PDFTron's Ruby PDF library for macOS:
Make a directory to store the wrappers and navigate into that directory.
Clone the uncompiled PDFNet wrappers by executing
git clone https://github.com/PDFTron/PDFNetWrappers
PDFNetWrappers/PDFNetC and move the downloaded [PDFNet C/C++ SDK] for macOS(#prerequisites) into that directory and unzip it. Ensure you obtain the right architecture for your Ruby interpreter. This can be done with these two commands:
curl -L -O http://www.pdftron.com/downloads/PDFNetCMac.zip unzip PDFNetCMac.zip
Now to move the headers in place, make sure you are in the
PDFNetWrappers/PDFNetC directory and execute
mv PDFNetCMac/Headers/ .
mv PDFNetCMac/Lib/ .
to move the PDFNet libraries in place.
You can delete
PDFNetCMac.zip to free up space.
/PDFNetC folder should be laid out like this like this:
PDFNetC ├── Headers ├── Lib ├── PDFNetCMac └── README.txt
Make a build directory inside
/PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.
cmake -D BUILD_PDFNetRuby=ON ..
If all goes well, you should get a message which reads:
Build files have been written to ~/PDFNetWrappers/Build
make followed by
sudo make install.
Next we need to fix the
rpaths issue on Mac. While still in the same
Build directory, execute these lines:
cp ../fix_rpaths.sh ../PDFNetC/Lib/ cd ../PDFNetC/Lib/ sudo sh ./fix_rpaths.sh
Run a specific sample
RUBYfolder in the sample, for example
Run all samples
/Samples and execute:
The tests will run one by one.
This section will show you how to use our SDK to create a simple PDFTron "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.
Navigate to your
/Samples directory and make a new directory called
myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside
Navigate inside that
RUBY folder and create a new Ruby file called
myApp.rb. Open it with your favorite text editor and paste this into it:
require '../../../PDFNetC/Lib/PDFNetRuby' include PDFNetRuby $stdout.sync = true PDFNet.Initialize() # PDFNet must be initialized before accessing any PDFTron API doc = PDFDoc.new() page = doc.PageCreate() # Start a new page doc.PagePushBack(page) # Add the page to the document doc.Save("output.pdf", SDFDoc::E_linearized); # Save the document as a linearized PDF puts "Hello World!"
Run your application by executing
ruby myApp.rb. If all goes well, your console should output:
PDFNet is running in demo mode. Permission: write Hello World!
output.pdf that the program output in the same directory. It should be a PDF with one blank page.
Check the troubleshooting page if you run into any issues going through this document.
Get the answers you need: Support