Skip to content

Commit

Permalink
small corrections in man page and documentation concerning file format
Browse files Browse the repository at this point in the history
  • Loading branch information
stiglers-eponym committed Sep 5, 2022
1 parent 84f31cd commit f3fb6c9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
6 changes: 3 additions & 3 deletions man/beamerpresenter.1
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ The configuration consists of an ordinary config file (beamerpresenter.conf(5))
.
.SH FILE FORMAT
.
BeamerPresenter can save drawings along with notes (from notes widget) and other file-specific settings to a gzipped xml file (.bpr). The pdf file is not included in this file.
The file type aims for compatibility with Xournal++ in saving and loading drawings. BeamerPresenter can read Xournal(++) files and Xournal++ can open BeamerPresenter files. If this does not work, please open an issue on https://github.com/stiglers-eponym/BeamerPresenter. But BeamerPresenter can only handle a subset of the features provided by Xournal++ and also adds a few features which Xournal++ will ignore.
When opening a file, it does not need to be gzipped. However, when saving to a file, it will always be gzipped.
BeamerPresenter can save drawings along with notes (from notes widget) and other file-specific settings to a gzipped xml file (.bpr). The PDF file is not included in this file.
The file type aims for compatibility with Xournal++ in saving and loading drawings. BeamerPresenter can read Xournal(++) files, but will only consider pages with a PDF page as background. Xournal++ can open BeamerPresenter files, but transformations of text boxes will be ignored. BeamerPresenter can only handle a subset of the features provided by Xournal++ and also adds a few features which Xournal++ will ignore.
When opening a file it does not need to be gzipped. However, when saving to a file it will always be gzipped.
.
.
.SH BUGS
Expand Down
6 changes: 3 additions & 3 deletions share/doc/README.html.in
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@ Shortcuts can be configured in the settings widget. Buttons are defined in the u
Both shortcuts and buttons can either cause an action (e.g. going to the next page) or select a tool.</p>

<h3>Tools</h3>
<p>Tools (pen, highlighter, eraser, pointer, ...) allow the presenter to draw or highlight in the presentation. All drawings and highlighting features are synchronized between slide widgets which show the same slide of a presentation.</p>
<p>Tools (pen, highlighter, text, eraser, pointer, selection tools, ...) allow the presenter to draw or highlight in the presentation. All drawings and highlighting features are synchronized between slide widgets which show the same slide of a presentation.</p>

<p>Tools are connected to a specific input device (e.g. the left mouse button, a touch screen, or a pen input).
When selecting a tool by pushing a button, this tool is by default only connected to the tool with which the button was pressed. For example, you can select a tool only for the right mouse button or only for a touch screen. Other devices remain unchanged and keep their tools. Buttons can, however, be configured to change the tool for all devices or a selection of devices.
Also for keyboard shortcuts which select a tool it is possible to define a device (or selection of devices).</p>

<p>Important actions when using draw tools are the "undo" and "redo" action. Note that and "undo" history is kept <em>per slide</em>, i.e., "undo" will only undo the last drawing or erasing step on the currently visible slide.</p>

<p>For more details on tools and actions (e.g. how to use undo if a presentation combines presentation and notes for the speaker in a single file) see <code>man 5 beamerpresenter-ui</code>.</p>
<p>For more details on tools and actions see <code>man 5 beamerpresenter-ui</code>.</p>

<h3>Saving and Loading Drawings</h3>
<p>Use the "open" (default shortcut: Ctrl+O) and "save" (Ctrl+S) or "save as" (Ctrl+Shift+S) actions to load or save drawings. Note that it is not possible to switch to a different pdf file while BeamerPresenter is running. It is only possible to load drawings for the pdf file which is currently opened.</p>

<p>BeamerPresenter uses gzipped xml files (.bpr) aiming for compatibility with Xournal++ (.xopp files). These files do not include the pdf file. BeamerPresenter can read drawings and text annotations from .xoj or .xopp files (Xournal or Xournal++). But BeamerPresenter will always show the pages of the pdf, independent of pages added or removed in Xournal(++). Xournal++ can read files created by BeamerPresenter and convert them to Xournal's .xoj format if necessary.</p>
<p>BeamerPresenter uses gzipped xml files (.bpr) aiming for compatibility with Xournal++ (.xopp files). These files do not include the pdf file. BeamerPresenter can read drawings and text annotations in a PDF from .xoj or .xopp files (Xournal or Xournal++). But BeamerPresenter will always show the pages of the pdf, independent of pages added or removed in Xournal(++). Xournal++ can read files created by BeamerPresenter and convert them to Xournal's .xoj format if necessary.</p>

<p>BeamerPresenter files mainly include drawings and text added by the user, but they can also store the duration of the presentation, the overlay mode of the drawings, and times defined per slide. These times allow the speaker to easily check the time relative to a predefined schedule through the color of the timer widget. Additionally, it is possible to show rich text notes in BeamerPresenter. These notes are also included when saving or loading a file. Saving only these notes in an uncompressed xml format is also possible.</p>

Expand Down
2 changes: 2 additions & 0 deletions src/drawing/pathcontainer.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// SPDX-FileCopyrightText: 2022 Valentin Bruch <software@vbruch.eu>
// SPDX-License-Identifier: GPL-3.0-or-later OR AGPL-3.0-or-later

#include <QStringList>
#include <QTransform>
#include <QGraphicsScene>
#include <QGraphicsItem>
#include <QGraphicsItemGroup>
Expand Down
16 changes: 8 additions & 8 deletions translations/de.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,42 +94,42 @@
<translation>Dokumente (*.pdf);;BeamerPresenter/Xournal++-Dateien (*.bpr *.xoj *.xopp *.xml);;Alle Dateien (*)</translation>
</message>
<message>
<location filename="../src/master.cpp" line="603"/>
<location filename="../src/master.cpp" line="602"/>
<source>Error while reading GUI config</source>
<translation>Fehler beim Lesen der Konfiguration für die Benutzeroberfläche</translation>
</message>
<message>
<location filename="../src/master.cpp" line="604"/>
<location filename="../src/master.cpp" line="603"/>
<source>Ignoring entry in GUI config with invalid type </source>
<translation>Ignoriere Eintrag in der Konfiguration der Benutzeroberfläche mit ungültigem Typ </translation>
</message>
<message>
<location filename="../src/master.cpp" line="821"/>
<location filename="../src/master.cpp" line="830"/>
<source>Unsaved changes</source>
<translation>Nicht gespeicherte Anmerkungen</translation>
</message>
<message>
<location filename="../src/master.cpp" line="822"/>
<location filename="../src/master.cpp" line="831"/>
<source>The document may contain unsaved changes. Quit anyway?</source>
<translation>Das Dokument enthält eventuell nicht gespeicherte Anmerkungen. Trotzdem schließen?</translation>
</message>
<message>
<location filename="../src/master.cpp" line="1002"/>
<location filename="../src/master.cpp" line="1011"/>
<source>Load drawings</source>
<translation>Lade Anmerkungen</translation>
</message>
<message>
<location filename="../src/master.cpp" line="1004"/>
<location filename="../src/master.cpp" line="1013"/>
<source>BeamerPresenter/Xournal++ files (*.bpr *.xoj *.xopp *.xml);;All files (*)</source>
<translation>BeamerPresenter/Xournal++-Dateien (*.bpr *.xoj *.xopp *.xml);;Alle Dateien (*)</translation>
</message>
<message>
<location filename="../src/master.cpp" line="1012"/>
<location filename="../src/master.cpp" line="1021"/>
<source>Save drawings</source>
<translation>Speichere Anmerkungen</translation>
</message>
<message>
<location filename="../src/master.cpp" line="1014"/>
<location filename="../src/master.cpp" line="1023"/>
<source>BeamerPresenter/Xournal++ files (*.bpr *.xopp);;All files (*)</source>
<translation>BeamerPresenter/Xournal++-Dateien (*.bpr *.xopp);;Alle Dateien (*)</translation>
</message>
Expand Down

0 comments on commit f3fb6c9

Please sign in to comment.