Seth/sethLabels
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Merge branch 'RefactorPrint'

Browse Source 
- Modifies printing model to be similar to glabels-3.x.
   - Allow simple projects to print by-the-page (#51)
   - Added collated vs uncollated document merges
- Added ability to separate merge groups by page
- Updated man pages
- Updated misc developer documentation
This commit is contained in:
Jim Evins
2020-01-01 14:19:11 -05:00
parent af607ca4af
commit aebcda43cb
23 changed files with 1184 additions and 380 deletions
Download Patch File Download Diff File Expand all files Collapse all files
user-docs/_build/man/glabels-batch-qt.1
+34 -12
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "GLABELS-BATCH-QT" "1" "Nov 27, 2019" "" "gLabels"
.TH "GLABELS-BATCH-QT" "1" "Jan 01, 2020" "" "gLabels"
.SH NAME
glabels-batch-qt \- batch creation of labels and business cards
.
@@ -35,9 +35,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBglabels\-batch\-qt\fP [\fIoptions\fP] [\fIfilename\fP]
.SH DESCRIPTION
.sp
\fBglabels\-batch\-qt\fP is a utility for printing files previously
prepared with \fBglabels\-qt\fP from the command line. It is suitable
for use with scripts.
\fBglabels\-batch\-qt\fP is a utility for printing a glabels project file
from the command line. It is suitable for use with scripts.
.SH OPTIONS
.INDENT 0.0
.TP
@@ -57,13 +56,15 @@ Send output to <printer>.
.INDENT 0.0
.TP
.B \-o [<filename>], \-\-output [<filename>]
Set output filename to <filename>. Set to "\-" for stdout.
(Default="output.pdf")
.TP
.B Set output filename to <filename>. If filename is "\-", write to standard output.
.TP
.B (Default="output.pdf")
.UNINDENT
.INDENT 0.0
.TP
.B \-s <n>, \-\-sheets <n>
Set number of sheets to <n>. (Default=1)
For simple projects, sets number of full sheets to <n>. (Default=1)
.UNINDENT
.INDENT 0.0
.TP
@@ -72,8 +73,18 @@ Set number of copies to <n>. (Default=1)
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-collate
Collate merge copies.
.UNINDENT
.INDENT 0.0
.TP
.B \-g, \-\-group
Start each merge group on a new page.
.UNINDENT
.INDENT 0.0
.TP
.B \-f <n>, \-\-first <n>
Set starting label on 1st page to <n>. (Default=1)
Set starting position to <n>. (Default=1)
.UNINDENT
.INDENT 0.0
.TP
@@ -113,7 +124,20 @@ templates here!\fP
.B ${HOME}/.glabels/
Directory for manually created product templates.
.UNINDENT
.SH BUGS
.SH KNOWN ISSUES
.sp
On GNU/Linux platforms, \fBglabels\-batch\-qt\fP must be run from within a windowing environment, such as X or Wayland. This is because Qt requires a suitable platform to obtain system font information. A work\-around is to run \fBglabels\-batch\-qt\fP using a virtual X server environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xvfb\-run glabels\-batch\-qt \-o output.pdf myProject.glabels
.ft P
.fi
.UNINDENT
.UNINDENT
.SH REPORTING BUGS
.sp
On GNU/Linux platforms, \fBglabels\-batch\-qt\fP must be run from within a windowing environment, such as X or Wayland. This is because Qt requires a suitable platform to obtain system font information. A work\-around is to run \fBglabels\-batch\-qt\fP using a virtual X server environment:
.INDENT 0.0
@@ -134,9 +158,7 @@ Bugs and feature requests can be reported via the gLabels issue tracking system
\fBglabels\-qt(1)\fP
.sp
The gLabels homepage at <\fI\%http://glabels.org/\fP>.
.SH AUTHOR
Jim Evins
.SH COPYRIGHT
2018, Jim Evins <evins@snaught.com>
2020, Jim Evins <evins@snaught.com>
.\" Generated by docutils manpage writer.
.
user-docs/_build/man/glabels-qt.1
+2 -4
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "GLABELS-QT" "1" "Nov 27, 2019" "" "gLabels"
.TH "GLABELS-QT" "1" "Jan 01, 2020" "" "gLabels"
.SH NAME
glabels-qt \- create labels and business cards
.
@@ -75,9 +75,7 @@ Bugs and feature requests can be reported via the gLabels issue tracking system
\fBglabels\-batch\-qt(1)\fP
.sp
The gLabels homepage at <\fI\%http://glabels.org/\fP>.
.SH AUTHOR
Jim Evins
.SH COPYRIGHT
2018, Jim Evins <evins@snaught.com>
2020, Jim Evins <evins@snaught.com>
.\" Generated by docutils manpage writer.
.
user-docs/conf.py
+3 -3
View File
@@ -47,7 +47,7 @@ master_doc = 'index'
# General information about the project.
project = 'gLabels'
copyright = '2018, Jim Evins <evins@snaught.com>'
copyright = '2020, Jim Evins <evins@snaught.com>'
author = 'Jim Evins'
# The version info for the project you're documenting, acts as replacement for
@@ -149,8 +149,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('man/glabels-qt', 'glabels-qt', 'create labels and business cards', [author], 1),
('man/glabels-batch-qt', 'glabels-batch-qt', 'batch creation of labels and business cards', [author], 1)
('man/glabels-qt', 'glabels-qt', 'create labels and business cards', [], 1),
('man/glabels-batch-qt', 'glabels-batch-qt', 'batch creation of labels and business cards', [], 1)
]
user-docs/man/glabels-batch-qt.rst
+48 -32
View File
@@ -9,55 +9,61 @@ SYNOPSIS
DESCRIPTION
-----------
:program:`glabels-batch-qt` is a utility for printing files previously
prepared with :program:`glabels-qt` from the command line. It is suitable
for use with scripts.
:program:`glabels-batch-qt` is a utility for printing a glabels project file
from the command line. It is suitable for use with scripts.
OPTIONS
-------
.. program:: glabels-batch-qt
.. option:: -h, --help
Displays usage information and exits.
.. option:: -v, --version
Displays version information and exits.
.. option:: -p <printer>, --printer <printer>
Send output to <printer>.
.. option:: -o [<filename>], --output [<filename>]
Set output filename to <filename>. Set to "-" for stdout.
Set output filename to <filename>. If filename is "-", write to standard output.
(Default="output.pdf")
.. option:: -s <n>, --sheets <n>
Set number of sheets to <n>. (Default=1)
For simple projects, sets number of full sheets to <n>. (Default=1)
.. option:: -c <n>, --copies <n>
Set number of copies to <n>. (Default=1)
.. option:: -a, --collate
Collate merge copies.
.. option:: -g, --group
Start each merge group on a new page.
.. option:: -f <n>, --first <n>
Set starting label on 1st page to <n>. (Default=1)
Set starting position to <n>. (Default=1)
.. option:: -l, --outlines
Print label outlines.
.. option:: -m, --crop-marks
Print crop marks.
.. option:: -r, --reverse
Print in reverse (mirror image).
.. option:: -D <var>=<value>, --define <var>=<value>
@@ -68,21 +74,31 @@ FILES
-----
.. describe:: ${prefix}/share/glabels-qt/templates/
Directory containing predefined product templates distributed with glabels.
.. describe:: ${XDG_CONFIG_HOME}/glabels.org/glabels-qt/
Directory containing user defined product templates created with the
gLabels Product Template Designer. **Do not place manually created
templates here!**
.. describe:: ${HOME}/.glabels/
Directory for manually created product templates.
BUGS
----
KNOWN ISSUES
------------
On GNU/Linux platforms, :program:`glabels-batch-qt` must be run from within a windowing environment, such as X or Wayland. This is because Qt requires a suitable platform to obtain system font information. A work-around is to run :program:`glabels-batch-qt` using a virtual X server environment:
.. code:: shell
xvfb-run glabels-batch-qt -o output.pdf myProject.glabels
REPORTING BUGS
--------------
On GNU/Linux platforms, :program:`glabels-batch-qt` must be run from within a windowing environment, such as X or Wayland. This is because Qt requires a suitable platform to obtain system font information. A work-around is to run :program:`glabels-batch-qt` using a virtual X server environment:
@@ -100,5 +116,5 @@ SEE ALSO
--------
:manpage:`glabels-qt(1)`
The gLabels homepage at <http://glabels.org/>.
user-docs/man/glabels-qt.rst
+10 -10
View File
@@ -17,30 +17,30 @@ OPTIONS
-------
.. program:: glabels-qt
.. option:: -h, --help
Displays usage information and exits.
.. option:: -v, --version
Displays version information and exits.
FILES
-----
.. describe:: ${prefix}/share/glabels-qt/templates/
Directory containing predefined product templates distributed with glabels.
.. describe:: ${XDG_CONFIG_HOME}/glabels.org/glabels-qt/
Directory containing user defined product templates created with the
gLabels Product Template Designer. **Do not place manually created
templates here!**
.. describe:: ${HOME}/.glabels/
Directory for manually created product templates.
REPORTING BUGS
@@ -53,5 +53,5 @@ SEE ALSO
--------
:manpage:`glabels-batch-qt(1)`
The gLabels homepage at <http://glabels.org/>.