kingjon3377 / tartan Goto Github PK

A continuous integration service should be configured to test that the example document builds with the package as it stands and to upload various artifacts (documentation PDF (q.v. #4), sample PDF (q.v. #8), etc.) on tagged releases.

In my testing of an actual Ball program, rather than a MWE, I found that of the ten page-breaks in the "dance cribs" section of the program,

• Three were between dances, as is desirable
• Two were in the middle of dances, with at least a couple of bars/directions pairs on each side of the break, as is acceptable
• Two were between the dance title and the dance directions (actually, one was between the dance title and its source!), which is egregiously bad.
• Three had one set of bars "widowed" or "orphaned" on one side of the page break, which is better than having it fall before the first bar but still to be avoided if at all possible.

The class should suggest page breaks after a dance, forbid them after a dance's title and source, strongly discourage them after figures in a named figure, and discourage them after figures otherwise.

The class currently produces a PDF of 4.25 x 5.5 inch pages. But for printing, we really want four of those pages per page (except the first and last, of course), so that these larger pages can be cut, folded, nested, and bound (usually stapled) to produce the booklets dancers will need.

It would be nice to produce that form as an output "directly" if an option is specified, but if nothing else the documentation should explain what packages and command invocations are needed to produce it.

With "literate code" documentation in a format that can be processed to PDF. (DTX?)

The GUI's output calls it if there's a back cover image. It should act like \cleardoublepage, except aiming for a left (even) page, not a right (odd) page.

I found a StackExchange post explaining how, but don't have it immediately to hand.

I recently saw a ball program that was printed using the same paper size and shape as this package enforces, but which was printed so that the reader flipped the pages from left to right instead of from top to bottom. This package should offer that as option.

Once the GUI is more-or-less feature-complete, the README here should link to it. (But not until then.)

If a program won't come out evenly, it would be nice to warn the user so that adjustments can be made to shrink or expand it.

• Size
• Cover contents
• Title page, either on back of front cover or the following page
• Title page contents and order
• Program listing
• Dance cribs
• Optionally filler art
• Optionally the text of "Auld Lang Syne"
• Optionally back-cover image

Unless the chosen image is particularly wide compared to its height, the \tartanimagecover command frequently overflows the bottom-text to the next page. We should:

• Strongly suppress a page break after the image and suggest one after the bottom-text
• Account for the height of the bottom-text when calculating how tall the image is allowed to be.

Figures within a named figure are indented so that their bars field aligns with the figure-description field of normal figures; that is by design. However, as currently implemented, once a named figure is used, every subsequent figure (including in subsequent dances) is similarly indented.

It looks like the (etoolbox?) bool mechanism I'm using is "immutable once set." I spent several hours yesterday trying to fix this, but the most promising solution (starting with \newif) caused example documents to fail to compile.

(I may end up dropping the notion of complex "named figures" anyway, to simplify the implementation and use of both this documentclass and the GUI; the Ball program that prompted me to develop this package included such an explanation of the Targe for The Clansman, but plainly typeset it with the bars merely joining the description in the larger second column.)

As suggested by #2, but wait until #3 is fixed

The Argyle Weekend 2019 program includes some dances sponsored by various members of the community, called out as such in the program. We should support such a line being optionally placed below such dances. See kingjon3377/tartan-gui#14