pfmc-assessments / sa4ss

Generate a stock assessment document from Stock Synthesis output
https://pfmc-assessments.github.io/sa4ss/
Other
12 stars 7 forks source link

Disclaimer Location #11

Closed chantelwetzel-noaa closed 1 year ago

chantelwetzel-noaa commented 3 years ago

For draft documents we need to add the disclaimer:

These materials do not constitute a formal publication and are for information only. They are in a pre-review, pre-decisional state and should not be formally cited {or reproduced}. They are to be considered provisional and do not represent any determination or policy of NOAA or the Department of Commerce.

I wanted to open an issue for us to discuss where to put the disclaimer. My initial thought would be to have the disclaimer in the middle of the second page where currently the copyright and citation is located. Thoughts?

kellijohnson-NOAA commented 3 years ago

I worry that people don't actually read the second page, and therefore, I think we should put it on the first page.

kellijohnson-NOAA commented 3 years ago

Do we want a draft watermark as well? I am not sure how "fancy" we want to go, but I figured it if is just a discussion here, then skies the limit.

iantaylor-NOAA commented 3 years ago

I think a draft watermark would be ambiguous and potentially distracting. I do think it would be useful to have options or user-defined text describing what version of the document it is, like "Pre-review draft", "Post-review draft" which could then be removed for the final submission. This could go on the first page above the data and the disclaimer (which I also support putting on page 1). But all that would be a low priority.

On Tue, Mar 2, 2021 at 2:33 PM Kelli Johnson notifications@github.com wrote:

Do we want a draft watermark as well? I am not sure how "fancy" we want to go, but I figured it if is just a discussion here, then skies the limit.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/nwfsc-assess/sa4ss/issues/11#issuecomment-789269133, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABGC7FSDGRQFNHV7AGJO5ELTBVRUFANCNFSM4YNS5BUQ .

mkapur commented 3 years ago

I struggled to include a disclaimer in a logical place (wasn't sure if in the .sty file or elsewhere to add) and ended up adding it as a PDF comment post-hoc. FWIW, Owen indicated that on the second page, immediately above or below the copyright, would be the best place.

chantelwetzel-noaa commented 3 years ago

I too had a similar struggle and ideally we will update the template to include this (with the ease of removal once the assessment is final). I ended up putting it in file 01a.Rmd so it would come up first in the document after the outline. I then added a section header to it as well so it would come up clearly in the outline as well:

Disclaimer{-}

These materials do not constitute a formal publication and are for information only. They are in a pre-review, pre-decisional state and should not be formally cited or reproduced. They are to be considered provisional and do not represent any determination or policy of NOAA or the Department of Commerce.

\pagebreak

Definitely not perfect but hopefully adequate for now.

mkapur commented 3 years ago

Thanks Chantel, that's a good workaround, and good point about "ease of removal" (less so if buried in the .sty). Ideally it could show up closer to the title page, but as long as it's somewhere.

chantelwetzel-noaa commented 3 years ago

@mkapur I should have also said congrats on fishing the update assessment!

kellijohnson-NOAA commented 1 year ago

532a96d implements a disclaimer by using

disclaimer: true

in the yaml header of 00a.Rmd. The default is to have the disclaimer turned on. You can set it to false or remove the line from 00a.Rmd if you want the citation instead of a disclaimer.

iantaylor-NOAA commented 1 year ago

Worked for me. Thanks @chantelwetzel-noaa and @kellijohnson-NOAA for making this happen, and also providing instructions on how to retroactively apply it to existing documents. image