xournalpp/README.md

Xournal++

(Currently run manually)

Features

Xournal++ is a hand note taking software written in C++ with the target of flexibility, functionality and speed. Stroke recognizer and other parts are based on Xournal Code, which you can find at sourceforge

Xournal++ features:

• Support for Pen preassure, e.g. Wacom Tablet
• Support for annotating PDFs
• Fill shape functionality
• PDF Export (with and without paper style)
• PNG Export (with and without transparent background)
• Allow to map different tools / colors etc. to stylus buttons / mouse buttons
• Sidebar with Page Previews with advanced page sorting, PDF Bookmarks and Layers (can be individually hidden, editing layer can be selected)
• enhanced support for image insertion
• Eraser with multiple configurations
• Significantly reduced memory usage and code to detect memory leaks compared to Xournal
• LaTeX support (requires a working LaTeX install)
• bug reporting, autosave, and auto backup tools
• Customizeable toolbar, with multiple configurations, e.g. to optimize toolbar for portrait / landscape
• Page Template definitions
• Shape drawing (line, arrow, circle, rect)
• Shape resizing and rotation
• Rotation snapping every 45 degrees
• Rect snapping to grid
• Audio recording and playback alongside with handwritten notes

Hopefully you'll enjoy it!

How to use audio record and playback feature:

• Install vlc and make sure curl and arecord are present on your system
• Under vlc settings:
• • enable http interface (see this ) with blank username and password "password"
• • tick Allow only one instance under Interface -> Instance
• set the folder where do you want to store audio recordings under settings -> audio recording

You're ready to go! Just press the red button to start/stop recording and use the Play Object tool to click on a stroke and listen to the corresponding audio.

If you need to, you can edit the recording audio gain in the script under /usr/local/bin/xopp-recording.sh (an option for this will be availabe through xournalpp's settings in the future)

Installing

Ubuntu and derivates

sudo add-apt-repository ppa:andreasbutti/xournalpp-master
sudo apt update
sudo apt install xournalpp

OpenSuse

https://build.opensuse.org/package/show/home:badshah400:Staging/xournalpp-gtk3

Build by https://github.com/badshah400

Windows

Windows is not fully tested. If you find errors, please let us know over the Issues page here on Github. If you are a developer, working with Windows and would like to help us, please contact also contact us over an Issue.

https://github.com/xournalpp/xournalpp/releases

Mac OS X

Pressure sensitivity is not working on Mac. (GTK-Issue)

No release yet.

Building

Linux Build

Mac Build

Windows Build

Fileformat

The fileformat *.xopp is an XML which is .gz compressed. PDFs are not embedded into the file, so if the PDF is deleted, the background is lost. *.xopp is basically the same fileformat as *.xoj, which is used by Xournal. Therefor Xournal++ reads *.xoj files, and can also export *.xoj. On exporting to *.xoj all Xournal++ specific Extension are lost, like addtional Background types. *.xopp can theretically be read by Xournal, as long as you do not use any new feature, Xournal does not open files at all if there are new attributes or unknown values, because of this Xournal++ will add the extension .xopp to all saved files. All new files will be saved as *.xopp, if an *.xoj file is opened which was created by Xournal, the Save-As dialog will be displayed on save. If the *.xoj file was by Xournal++ created, Xournal++ overwrite the file on save, and does not change the extension.

Development

For developping new features, write a Ticket, so others know what you are doing. For development create a fork, and use the master as base. Create a Pull request for each fix. Do not create big pull requests, as long as you don't break anything features also can be merged, even if they are not 100% finished.

See GitHub:xournalpp for current development. You can also join our Gitter channel via badge on top.

Code documentation

The code documentation is generated using Doxygen.

In order to generate the documentation yourself, first install Doxygen and graphviz, i.e.

sudo apt install doxygen
sudo apt install graphviz

on Debian or Ubuntu. Finally, type in doxygen in the root directory of the repository. The documentation can be found in doc/html and doc/latex. Conveniently display the documentation with python3 -m http.server 8000 and visit the shown URL to view the documentation.