Giter VIP home page Giter VIP logo

flokli / xournalpp Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xournalpp/xournalpp

0.0 2.0 0.0 27.95 MB

Xournal++ is a handwriting Notetaking software with PDF annotation support. Written in C++ with plattform independent GTK, supporting Linux, e.g. Ubuntu, Debian, Arch, Suse, macOS and Windows 10. Supports Pen input like Wacom Tablets.

License: GNU General Public License v2.0

CMake 4.56% Shell 0.56% Lua 0.12% C++ 92.05% C 2.03% PHP 0.17% NSIS 0.51%

xournalpp's Introduction

Xournal++

Build Status Join the chat at https://gitter.im/xournalpp/xournalpp

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
  • Multi Language Support, Like English, German (Deutsch), Italian (Italiano)...
  • Plugins using LUA Scripting

Screenshot

Windows 10

Screenshot

macOS High Sierra

Screenshot

Toolbar / Page Background / Layer

Multiple page background, easy selectable on the toolbar Screenshot

Layer sidebar and advance Layer selection. Screenshot

Multiple predefined and fully customizeable Toolbar. Screenshot

How to use audio record and playback feature:

Instructions for releases > 1.0.7

  • Go to Edit > Preferences > Audio Recording and set the Audio Folder as well as the appropriate Input Device and Output Device.

If you need to edit the recording audio gain, take a look at the preferences tab mentioned above.

Please test this new feature in advance before relying on it to work. It could contain bugs specific to some hard-/software, which we have not yet found.

Instructions for releases <= 1.0.7

  • 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

If you need to, you can edit the recording audio gain in the script under /usr/local/bin/xopp-recording.sh

How to record

Just press the red button to start/stop recording and draw strokes using the Pen tool. The recording is associated with the drawn strokes and typed text while it is running.

Play the recorded audio

Use the Play Object tool to click on a stroke or text node and listen to the corresponding audio. You can pause and stop the playback of the audio with the buttons next to the recording button in the toolbar.

Installing

Ubuntu and derivates

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

OpenSuse

On openSUSE Tumbleweed, the released version of xournalpp is available from the main repository:

sudo zypper in xournalpp

For openSUSE Leap 15.0 and earlier, use the install link from X11:Utilities.

For all versions of openSUSE, bleeding edge packages synced to xournalpp git master on a weekly basis are available from home:badshah400:Staging.

Arch Linux

The AUR Package xournalpp provides an easy way to compile and install the latest state of the master branch.

Windows

The windows Version has a Bug: Please start Xournal++, touch with the Pen, Quit Xournal++ and start again. Then Pen input will be working, until you restart Windows. #659

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

Mac OS X

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

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

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 theoretically 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.

We are currently introducing a new file format that can efficiently store attached PDF files and other attachments internally. We will still allow for attachments that are linked to external files. Please refer to #937 for futher details.

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 the badge on top.

Also take a look at our Coding Conventions

FAQ

Q: Secondary stylus button only works when there is no contact

This is due to a driver setting, which you can configure with TPCButton or TabletPCButton directive if using Wacom driver (but other drivers might have this setting too).

Here's a /usr/share/X11/xorg.conf.d/30-wacom.conf example snippet:

Section "InputClass"
	Identifier "Wacom tablets class"
	MatchProduct "Wacom"
	MatchDevicePath "/dev/input/event*"
	MatchIsTablet "on"
	Driver "wacom"
	Option "TabletPCButton" "on"
	Option "TPCButton" "on"
EndSection

If you are using libinput as driver, take a look at #940 and the ticket over at libinput which adresses this issue (https://gitlab.freedesktop.org/libinput/libinput/issues/193)

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.

xournalpp's People

Contributors

andreasb242 avatar wbrenna avatar morrolinux avatar marekpikula avatar littlehuba avatar luco5826 avatar peetcreative avatar x2b avatar jjones780 avatar frohro avatar siliconninja avatar youduda avatar mputzi avatar thofrank avatar corna avatar andrewrembrandt avatar wpettersson avatar ruolipku avatar ezickler avatar cbm755 avatar pellelnitram avatar rmano avatar shuhaowu avatar taaem avatar xifi-kif avatar usrtrv avatar yurivict avatar piegamesde avatar shemgp avatar scottt avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.