Mirror/xournalpp-relative-background
1
0
Fork 0
mirror of https://codeberg.org/privacy1st/xournalpp-relative-background synced 2024-12-03 22:15:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Daniel Langbein 2021-09-25 19:53:14 +02:00
parent 3e5bff3d78
commit 8bbd1579bc
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -8,3 +8,39 @@ Place [relative-xopp-background](relative-xopp-background) in `~/.local/share/na
If missing, install [notify2](https://pypi.org/project/notify2/) and (optionally)
[dbus-python](https://pypi.org/project/dbus-python/) with your package manager or with pip.
## Details
Here is an excerpt of a Xournal++ document `/home/user/notes/note1/paper.pdf.xopp`:
```xml
<?xml version="1.0" standalone="no"?>
<xournal creator="Xournal++ 1.1.0" fileversion="4">
<title>Xournal++ document - see https://github.com/xournalpp/xournalpp</title>
<!-- ... -->
<page width="595.27600000" height="841.89000000">
<background type="pdf" domain="absolute"
filename="/home/user/Documents/paper.pdf" pageno="1ll"/>
<!-- ... -->
</page>
<!-- ... -->
</xournal>
```
If the background PDF file `/home/user/Documents/paper.pdf` does not exist
but `/home/user/notes/note1/paper.pdf` is accessible (which is in the same folder as the Xournal++ file),
then the absolute path will be replaced with a path relative one:
```xml
<?xml version="1.0" standalone="no"?>
<xournal creator="Xournal++ 1.1.0" fileversion="4">
<title>Xournal++ document - see https://github.com/xournalpp/xournalpp</title>
<!-- ... -->
<page width="595.27600000" height="841.89000000">
<background type="pdf" domain="absolute"
filename="paper.pdf" pageno="1ll"/>
<!-- ... -->
</page>
<!-- ... -->
</xournal>
```