Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Watermarks are wonky #54

Open
jsf9k opened this issue Sep 3, 2021 · 6 comments
Open

Watermarks are wonky #54

jsf9k opened this issue Sep 3, 2021 · 6 comments
Assignees
@jsf9k @dav3r
Labels
bug This issue or pull request addresses broken functionality

Comments

@jsf9k
Copy link
Member

jsf9k commented Sep 3, 2021 •
edited
Loading

🐛 Summary

According to the way that the background LaTeX package is being called in #53, these statements concerning the DHS logo watermark should be true:

  1. The only page of the report that should have the watermark is the table of contents page.
  2. The watermark on the table of contents page should be quite faint, like it was in our reports up until September of this year (before ⚠️ CONFLICT! Lineage pull request for: skeleton #51 and Fix matplotlib bug and assorted warnings #53).

This is what is actually true:

  1. The title page does not have a watermark, which is what we expect and desire.
  2. The table of contents does have a watermark but, although it is rather transparent, it is not nearly as transparent as it was before Fix matplotlib bug and assorted warnings #53.
  3. All pages following the table of contents have a much more transparent watermark than the table of contents page, even though they should have no watermark at all.

Note that I was only able to get rid of an aggressively non-opaque watermark on the title page by moving the location of the background configuration in #53.

The only thing I can think of is that after the update to Bullseye in #51 we have a newer version of the background package, and all the LaTeX-fu in that report to make it look like a fancy Word document is now somehow colliding with it.

To reproduce

Use the code in this repo to create a Trustworthy Email report.

Expected behavior

Described above.
@jsf9k jsf9k added the bug This issue or pull request addresses broken functionality label Sep 3, 2021
@jsf9k jsf9k assigned jsf9k and dav3r Sep 3, 2021
jsf9k added a commit that referenced this issue Sep 3, 2021
@jsf9k
Move entire background LaTeX package config into \backgroundsetup
949bed5 
Previously the configuration was spread between \backgroundsetup and
the square braces of \usepackage[...]{background}.

Also move \backgroundsetup to just before we actually use
\BgThispage.  I think some of the LaTeX wizardry that comes after the
preamble but before the table of contents is messing up the way the
background LaTeX package works.

Whatever the reason, making the two changes described above the one
described above appears to fix a bug (described in #52) that has
popped up with our recent move to Debian Bullseye in #51 where the
opacity specified for the DHS logo on the table of contents page is
ignored.

When I tried only making the first change the DHS logo would show up
with full opacity on the title page and then appear correctly on the
table of contents, which is also undesirable.  It may be possible to
get the desired behavior with only the second change, but the first
change is good to make for consistency's sake.

The watermarks are known to me acting a little wonky.  I created
#54 to document this.
@mcdonnnj mcdonnnj moved this to To do in BOD 18-01 Jul 13, 2023
@KeithBonesJr
Copy link

@dav3r and @jsf9k is this something you'd like for us to take a stab at locally or is it something that's far outside our wheel house? It's ok, you all can be honest with us. 👍

@dav3r
Copy link
Member

dav3r commented Nov 7, 2023

@KeithBonesJr Has anyone on your team verified if @jsf9k's original comments from 2 years ago are still true now? It's possible that newer LaTeX packages have changed things since then.

Also, is this important enough for anyone to spend any time on?

@KeithBonesJr
Copy link

@dav3r looking into this now. In terms of importance, unfortunately our contractor management heard we can generate sample reports and wanted us to look into this since it's one of VS's lingering issue. If we can resolve it on our own, my plan is to let them know it'll continue to be an issue. Also thanks! @jsf9k

@KeithBonesJr
Copy link

Just had a glance and noticed the issue was fixed for the trustymail report, not the HTTPS report. My guess is a similar version bump may need to happen within the https://github.com/cisagov/pshtt repository? @dav3r @jsf9k

@jsf9k
Copy link
Member Author

jsf9k commented Nov 8, 2023

Just had a glance and noticed the issue was fixed for the trustymail report, not the HTTPS report. My guess is a similar version bump may need to happen within the https://github.com/cisagov/pshtt repository? @dav3r @jsf9k

What exactly do you mean by "a similar version bump"?

@KeithBonesJr
Copy link

Just had a glance and noticed the issue was fixed for the trustymail report, not the HTTPS report. My guess is a similar version bump may need to happen within the https://github.com/cisagov/pshtt repository? @dav3r @jsf9k

What exactly do you mean by "a similar version bump"?

I was thinking you did a version bump on bull-eye but it looks like you moved the version of the background configuration. Oversight on my end.

jeffkause added a commit to jeffkause/pshtt_reporter that referenced this issue Nov 17, 2023
@jeffkause
Reduce watermark opacity
4c40316 
Moving the watermark information from the file header to the Table of Contents, reduces the opacity of the watermark from 100% to 10%. Followed the changes from cisagov/trustymail_reporter#54.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jsf9k jsf9k

@dav3r dav3r

Labels
bug This issue or pull request addresses broken functionality
Projects
BOD 18-01
Status: To do
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jsf9k @dav3r @KeithBonesJr