From c673daabb201013415d8fd946f4ec08a88029634 Mon Sep 17 00:00:00 2001 From: "Elizabeth (Liz) Dobbins" Date: Mon, 16 Sep 2024 15:22:50 -0800 Subject: [PATCH] Fixes to non-discrimination statement and update to technical details --- _quarto-html.yml | 3 +- _quarto-word.yml | 43 +++++++++++++++ about.qmd | 11 ++-- credits.qmd | 4 +- scripts/latex/before-body.tex | 31 ++++++----- website_backup.yml | 100 ---------------------------------- 6 files changed, 70 insertions(+), 122 deletions(-) create mode 100644 _quarto-word.yml delete mode 100644 website_backup.yml diff --git a/_quarto-html.yml b/_quarto-html.yml index ae52f1d9..1e9c5ef9 100644 --- a/_quarto-html.yml +++ b/_quarto-html.yml @@ -38,7 +38,8 @@ book: page-footer: right: "This page is built with [Quarto](https://quarto.org/)." - center: "© [CC BY-SA 4.0](https://github.com/acep-uaf/aetr-web-book-2024/blob/main/LICENSE.md), 2024
[Alaska Center for Energy and Power](https://www.uaf.edu/acep/)" + left: "© [CC BY-SA 4.0](https://github.com/acep-uaf/aetr-web-book-2024/blob/main/LICENSE.md), 2024
[Alaska Center for Energy and Power](https://www.uaf.edu/acep/)" + center: "UA is an affirmative action/equal opportunity employer, educational institution and provider and prohibits illegal discrimination against any individual: www.alaska.edu/nondiscrimination." # These change page titles https://quarto.org/docs/books/book-structure.html#parts-appendices # but not in the sidebar navigation or in cross-references diff --git a/_quarto-word.yml b/_quarto-word.yml new file mode 100644 index 00000000..dd9b3354 --- /dev/null +++ b/_quarto-word.yml @@ -0,0 +1,43 @@ +book: + chapters: + - index.qmd + - methods.qmd + - capacity.qmd + - generation.qmd + - consumption.qmd + - prices.qmd + - conclusions.qmd + - data.qmd + appendices: + - about.qmd + - historic_reports.qmd + - acronyms.qmd + - credits.qmd + +crossref: + appendix-title: "Appendix" + appendix-delim: ":" + +format: + docx: + #pdfengine: xelatex + #documentclass: scrreprt + papersize: letter + + fig-width: 6 + fig-height: 3.25 + + fontsize: 11pt + mainfont: Barlow + toccolor: blue + + toc: true + toc-depth: 3 + toc-title: "Table of contents" + lof: true + lot: true + number-sections: true + number-depth: 2 + + include-in-header: + - scripts/latex/preamble.tex \ No newline at end of file diff --git a/about.qmd b/about.qmd index 2a66c7c9..3ae7cd79 100644 --- a/about.qmd +++ b/about.qmd @@ -43,14 +43,17 @@ The @tbl-report-eras provides a summary of this timeline. This report serves to For a table of links to these historic reports, please refer to @tbl-historic-reports. -::: {.content-visible when-format="html"} ## Technical Details -The book is formatted using [Quarto](https://quarto.org), an open-source scientific and technical publishing system. The template was developed by the Openscapes project, as part of their [Quarto Website Tutorial](https://github.com/Openscapes/quarto-website-tutorial). +This report has been formatted and rendered using [Quarto](https://quarto.org), an open-source scientific and technical publishing system. The initial inspiration for this workflow was provided by the Openscapes project and their [Quarto Website Tutorial](https://github.com/Openscapes/quarto-website-tutorial). This publishing method experimentally models a new (to ACEP) method of automatically generating reports that include data. + +The markdown files that create the report reside in the [aetr-web-book-2024](https://github.com/acep-uaf/aetr-web-book-2024) GitHub repository. The original format of the report was an HTML-based web book, and an option for rendering it in PDF format was added months later. The generation material and process is publicly accessible and transparent. Errors in the document are flagged using GitHub issues where they can be tracked and addressed by the DCM team. The report also integrates R code for data processing and figure generation. -The markdown files that make up the book reside in the [aetr-web-book](https://github.com/acep-uaf/aetr-web-book) GitHub repository. The generation process is publicly accessible. Errors in the document can be flagged using GitHub issues where they can be tracked and addressed by the DCM team. +Early versions of this report contained errors in the data. These were flagged with GitHub issues and corrected in subsequent tagged versions. When data files were updated, the Quarto render updated the figures automatically, reducing the labor required to maintain an up-to-date report. -The book also integrates R code for data processing and figure generation. When data files are updated, manually triggering the Quarto render will update the figures automatically. +The web-first workflow of PDF report generation resulted in some formatting issues that are difficult to correct using this system. These issues include pagination that sometimes separates figures from contextual information. While this is not ideal, we hope to refine our techniques in future reports and to eventually produce a publication quality report. + +::: {.content-visible when-format="html"} ## Notice of Nondiscrimination diff --git a/credits.qmd b/credits.qmd index d9ea9c4d..773ceac8 100644 --- a/credits.qmd +++ b/credits.qmd @@ -65,10 +65,10 @@ The Alaska Electrical Trends report has been produced by the Alaska Center for E ### Acknowledgements * [Dayne Broderson](https://www.uaf.edu/acep/about/our-team/dayne-broderson.php)`r "^1^"` - * Roles: conceptualization, funding acquisition, visualization + * Roles: conceptualization, funding acquisition, visualization, writing – original draft * [Gwen Holdmann](https://www.uaf.edu/acep/about/our-team/gwen-holdmann.php)`r "^1^"` - * Roles: conceptualization, funding acquisition + * Roles: conceptualization, funding acquisition, writing – original draft * [Emily Richmond](https://www.uaf.edu/acep/about/our-team/emily-richmond.php)`r "^1^"` * Roles: software, visualization diff --git a/scripts/latex/before-body.tex b/scripts/latex/before-body.tex index f3669edb..ca20994a 100644 --- a/scripts/latex/before-body.tex +++ b/scripts/latex/before-body.tex @@ -53,25 +53,26 @@ \newpage -% \thispagestyle{empty} + \noindent -{\normalsize\bfseries Technical Report} \\ -UAF/ACEP/number \\ -\vspace{3ex} -August 2024 \\ -Suggested Citation: \\ -Kaczmarski, J., I. Yeager, S. Colt, E. L. Dobbins, N. McMahon, S. Fisher-Goad, and B. Smart. “2024 Alaska Energy Trends Report,” Alaska Center for Energy and Power, University of Alaska, Fairbanks, 2024. UAF/ACEP/number. DOI:number. +{\centering +\bfseries\normalsize Suggested Citation +\par +} -\newpage -% \thispagestyle{empty} -\vspace{30ex} +Kaczmarski, J., I. Yeager, S. Colt, E. L. Dobbins, N. McMahon, S. Fisher-Goad, and B. Smart. “2024 Alaska Energy Trends Report,” Alaska Center for Energy and Power, University of Alaska, Fairbanks, 2024. DOI:number. + +The code that generated this report is available at https://github.com/acep-uaf/aetr-web-book-2024. + +Cover photo is the Salmon Creek Dam in Juneau, courtesy of Sarah Traiger. + +\vfill \noindent {\centering \bfseries\normalsize Notice \par } -\small The University of Alaska Fairbanks is an affirmative action/equal opportunity employer and educational institution. UAF does not discriminate on the basis of race, religion, color, national origin, citizenship, age, sex, physical or mental disability, status as a protected veteran, marital status, changes in marital status, pregnancy, childbirth or related medical conditions, parenthood, sexual orientation, gender identity, political affiliation or belief, genetic information, or other legally protected status. The University's commitment to nondiscrimination, including against sex discrimination, applies to students, employees, and applicants for admission and employment. Contact information, applicable laws, and complaint procedures are included on UA's statement of nondiscrimination available at www.alaska.edu/nondiscrimination/. \\ -\\ -\small This report is available at no cost from the Alaska Center for Energy and Power (ACEP) at the University of Alaska, Fairbanks (UAF) at www.uaf.edu/acep/our-resources/index.php. \\ -\\ -\small Cover photo is the Salmon Creek Dam in Juneau, courtesy of Sarah Traiger. \ No newline at end of file +The University of Alaska is an affirmative action/equal opportunity employer, educational institution and provider. The University of Alaska does not discriminate on the basis of race, religion, color, national origin, citizenship, age, sex, physical or mental disability, status as a protected veteran, marital status, changes in marital status, pregnancy, childbirth or related medical conditions, parenthood, sexual orientation, gender identity, political affiliation or belief, genetic information, or other legally protected status. The University's commitment to nondiscrimination, including against sex discrimination, applies to students, employees, and applicants for admission and employment. Contact information, applicable laws, and complaint procedures are included on UA's statement of nondiscrimination available at https://www.alaska.edu/nondiscrimination. + +% \small This report is available at no cost from the Alaska Center for Energy and Power (ACEP) at the University of Alaska, Fairbanks (UAF) at www.uaf.edu/acep/our-resources/index.php. \\ + diff --git a/website_backup.yml b/website_backup.yml deleted file mode 100644 index 435c5386..00000000 --- a/website_backup.yml +++ /dev/null @@ -1,100 +0,0 @@ -this was _quarto.yml when AETR was a website - -project: - type: website - -website: - page-navigation: true - back-to-top-navigation: true - title: AETR Web Book - site-url: "https://acep-uaf.github.io/aetr-web-book/" - repo-url: https://github.com/acep-uaf/aetr-web-book - other-links: - - href: mailto:uaf-acep-dcm-support@alaska.edu - text: Report an issue via email - icon: envelope-exclamation - repo-actions: [issue] - - page-footer: - right: "This page is based on Openscape's [Quarto Site Template](https://github.com/Openscapes/quarto-website-tutorial) and built with [Quarto](https://quarto.org/) ." - left: "© CC-By , 2023" - - sidebar: - logo: "images/ACEP_gear.png" - pinned: true - align: center - title: "2024 Alaska Electricity Trends Report
(Data Years 2011-2021)
" - tools: - - icon: globe - href: https://www.uaf.edu/acep/ - text: "Alaska Center for Energy and Power" - - icon: github - href: https://github.com/acep-uaf/aetr-web-book - text: "Project GitHub" - - style: "docked" - search: true - collapse-level: 3 - contents: - - href: index.qmd - text: Summary - icon: dot - - href: about.qmd - text: About this Report - icon: dot - - href: methods.qmd - text: Methods - icon: dot - - section: "Discussion" - icon: dot - contents: - - href: capacity.qmd - text: Capacity - icon: dot - - href: generation.qmd - text: Net Generation - icon: dot - - href: consumption.qmd - text: Consumption - icon: dot - - href: prices.qmd - text: Price of Electricity - icon: dot - - href: conclusions.qmd - text: Conclusions - icon: dot - - section: "Appendices" - icon: dot - contents: - - href: historic_reports.qmd - text: Historical Reports - icon: dot - - href: data.qmd - text: Data Portal - icon: dot - - href: acronyms.qmd - text: Definitions of Acronyms - icon: dot - - href: credits.qmd - text: About the Team - icon: dot - - -format: - html: - anchor-sections: true - code-copy: true - code-overflow: wrap - css: styles.css - theme: - light: [cosmo, theme.scss] # from https://github.com/sta210-s22/website/blob/main/_quarto.yml - #dark: [cosmo, theme-dark.scss] - toc: true - -date: last-modified -date-format: "MMM D, YYYY [at] HH:mm z" - -filters: - - quarto - -