├── .nojekyll ├── favicon.ico ├── .gitignore ├── theme.scss ├── content ├── acknowledgements.qmd ├── add-content.qmd ├── customizing.qmd ├── rmarkdown.Rmd ├── rendering.qmd ├── code.qmd └── publishing.qmd ├── theme-dark.scss ├── .github └── workflows │ └── render-and-publish.yml ├── _quarto.yml ├── index.qmd ├── include-files.lua ├── README.md └── LICENSE /.nojekyll: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nmfs-opensci/NOAA-quarto-simple/HEAD/favicon.ico -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | .Ruserdata 5 | *.Rproj 6 | 7 | .DS_Store 8 | /.quarto/ 9 | /_site/ 10 | -------------------------------------------------------------------------------- /theme.scss: -------------------------------------------------------------------------------- 1 | /*-- scss:defaults --*/ 2 | 3 | @import 'https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible&display=swap'; 4 | 5 | $font-family: "Atkinson Hyperlegible", sans-serif; 6 | 7 | -------------------------------------------------------------------------------- /content/acknowledgements.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Acknowledgments 3 | --- 4 | 5 | This repo and GitHub Action was based on the tutorial by Openscapes [quarto-website-tutorial](https://github.com/Openscapes/quarto-website-tutorial) by Julia Lowndes and Stefanie Butland. -------------------------------------------------------------------------------- /theme-dark.scss: -------------------------------------------------------------------------------- 1 | /*-- scss:defaults --*/ 2 | 3 | @import 'https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible&display=swap'; 4 | 5 | $font-family: "Atkinson Hyperlegible", sans-serif; 6 | 7 | // Base document colors 8 | $body-bg: #181818; 9 | $body-color: white; 10 | $link-color: #75AADB; 11 | 12 | $light: #525252; 13 | 14 | // Navigation element colors 15 | $footer-bg: #181818; 16 | $navbar-bg: #303030; 17 | $sidebar-bg: #303030; 18 | 19 | // Code blocks 20 | $code-block-bg-alpha: -.8; 21 | 22 | // Bootstrap popovers 23 | $popover-bg: #242424; 24 | 25 | // Bootstrap inputs 26 | $input-bg: #242424; 27 | -------------------------------------------------------------------------------- /content/add-content.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Customize 3 | --- 4 | 5 | ## Edit and add your pages 6 | 7 | Edit the qmd or md files in the `content` folder. qmd files can include code (R, Python, Julia) and lots of Quarto markdown bells and whistles (like call-outs, cross-references, auto-citations and much more). 8 | 9 | Each page should start with 10 | ``` 11 | --- 12 | title: your title 13 | --- 14 | ``` 15 | and the first header will be the 2nd level, so `## `. Note, there are situations where you leave off 16 | ``` 17 | --- 18 | title: your title 19 | --- 20 | ``` 21 | and start the qmd file with a level header `# `, but if using the default title yaml (in the `---` fence) is a good habit since it makes it easy for Quarto convert your qmd file to other formats (like into a presentation). 22 | 23 | ## Add your pages the project 24 | 25 | * Add the files to `_quarto.yml` 26 | -------------------------------------------------------------------------------- /content/customizing.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Customization 3 | --- 4 | 5 | ## Quarto documentation 6 | 7 | Quarto allow many bells and whistles to make nice output. Read the documentation here [Quarto documentation](https://quarto.org/docs/guide/). 8 | 9 | ## Examples 10 | 11 | Looking at other people's Quarto code is a great way to figure out how to do stuff. Most will have a link to a GitHub repo where you can see the raw code. Look for a link to edit page or see source code. This will usually be on the right. Or look for the GitHub icon somewhere. 12 | 13 | * [Quarto gallery](https://quarto.org/docs/gallery/) 14 | * [nmfs-openscapes](https://nmfs-openscapes.github.io/) 15 | * [Fay lab manual](https://thefaylab.github.io/lab-manual/) 16 | * [quarto-titlepages](https://nmfs-opensci.github.io/quarto_titlepages/) Note the link to edit is broken. Go to repo and look in `documentation` directory. 17 | 18 | -------------------------------------------------------------------------------- /content/rmarkdown.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "R Markdown" 3 | --- 4 | 5 | ```{r setup, include=FALSE} 6 | knitr::opts_chunk$set(echo = TRUE) 7 | ``` 8 | 9 | You can include R Markdown files in your project. 10 | 11 | ## R Markdown 12 | 13 | This is an R Markdown document. Markdown is a simple formatting syntax for authoring HTML, PDF, and MS Word documents. For more details on using R Markdown see . 14 | 15 | When you click the **Knit** button a document will be generated that includes both content as well as the output of any embedded R code chunks within the document. You can embed an R code chunk like this: 16 | 17 | ```{r cars} 18 | summary(cars) 19 | ``` 20 | 21 | ## Including Plots 22 | 23 | You can also embed plots, for example: 24 | 25 | ```{r pressure, echo=FALSE} 26 | plot(pressure) 27 | ``` 28 | 29 | Note that the `echo = FALSE` parameter was added to the code chunk to prevent printing of the R code that generated the plot. 30 | -------------------------------------------------------------------------------- /.github/workflows/render-and-publish.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches: main 4 | 5 | name: Render and Publish 6 | 7 | jobs: 8 | build-deploy: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Check out repository 12 | uses: actions/checkout@v2 13 | 14 | - name: Set up R (needed for Rmd) 15 | uses: r-lib/actions/setup-r@v2 16 | 17 | - name: Install packages (needed for Rmd) 18 | run: Rscript -e 'install.packages(c("rmarkdown", "knitr", "jsonlite"))' 19 | 20 | - name: Set up Quarto 21 | uses: quarto-dev/quarto-actions/setup@v2 22 | with: 23 | # To install LaTeX to build PDF book 24 | tinytex: false 25 | # uncomment below and fill to pin a version 26 | # version: 0.9.600 27 | 28 | # add software dependencies here 29 | 30 | - name: Publish to GitHub Pages (and render) 31 | uses: quarto-dev/quarto-actions/publish@v2 32 | with: 33 | target: gh-pages 34 | env: 35 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions 36 | -------------------------------------------------------------------------------- /content/rendering.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Rendering 3 | --- 4 | 5 | The repo includes a GitHub Action that will render (build) the website automatically when you make changes to the files. It will be pushed to the `gh-pages` branch. 6 | 7 | But when you are developing your content, you will want to render it locally. 8 | 9 | ## Step 1. Make sure you have a recent RStudio 10 | 11 | Have you updated RStudio since about August 2022? No? Then update to a newer version of RStudio. In general, you want to keep RStudio updated and it is required to have a recent version to use Quarto. 12 | 13 | ## Step 2. Clone and create RStudio project 14 | 15 | First, clone the repo onto your local computer. How? You can click File > New Project and then select "Version Control". Paste in the url of the repository. That will clone the repo on to your local computer. When you make changes, you will need to push those up. 16 | 17 | ## Step 3. Render within RStudio 18 | 19 | RStudio will recognize that this is a Quarto project by the presence of the `_quarto.yml` file and will see the "Build" tab. Click the "Render website" button to render to the `_site` folder. 20 | 21 | **Previewing:** You can either click `index.html` in the `_site` folder and specify "preview in browser" or set up RStudio to preview to the viewer panel. To do the latter, go to Tools > Global Options > R Markdown. Then select "Show output preview in: Viewer panel". 22 | -------------------------------------------------------------------------------- /content/code.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Rendering with Code 3 | --- 4 | 5 | You can have code (R, Python or Julia) in your qmd file. You will need to have these installed on your local computer, but presumably you do already if you are adding code to your qmd files. 6 | 7 | ```{r echo=TRUE} 8 | x <- c(5, 15, 25, 35, 45, 55) 9 | y <- c(5, 20, 14, 32, 22, 38) 10 | lm(x ~ y) 11 | ``` 12 | 13 | 14 | ## Modify the GitHub Action 15 | 16 | You will need to change the GitHub Action in `.github/workflows` to install these and any needed packages in order for GitHub to be able to render your webpage. The GitHub Action install R since I used that in `code.qmd`. If you use Python or Julia instead, then you will need to update the GitHub Action to install those. 17 | 18 | If getting the GitHub Action to work is too much hassle (and that definitely happens), you can alway render locally and publish to the `gh-pages` branch. If you do this, make sure to delete or rename the GitHub Action to something like 19 | ``` 20 | render-and-publish.old_yml 21 | ``` 22 | so GitHub does not keep trying to run it. Nothing bad will happen if you don't do this, but if you are not using the action (because it keeps failing), then you don't need GitHub to run it. 23 | 24 | ## Render locally and publish to gh-pages branch 25 | 26 | To render locally and push up to the `gh-pages` branch, open a terminal window and then `cd` to the directory with the Quarto project. Type this in the terminal: 27 | ``` 28 | quarto render gh-pages 29 | ``` 30 | -------------------------------------------------------------------------------- /_quarto.yml: -------------------------------------------------------------------------------- 1 | project: 2 | type: website 3 | 4 | website: 5 | page-navigation: true 6 | title: "NOAA quarto simple" 7 | site-url: "https://nmfs-opensci.github.io/NOAA-quarto-simple" 8 | repo-url: "https://github.com/nmfs-opensci/NOAA-quarto-simple" 9 | repo-actions: [edit, source, issue] 10 | favicon: images/favicon.ico 11 | 12 | page-footer: 13 | right: "This page is built with [Quarto](https://quarto.org/)." 14 | left: "© CC-1.0" 15 | 16 | sidebar: 17 | background: "#D9E3E4" 18 | logo: "https://raw.githubusercontent.com/nmfs-opensci/assets/main/logo/nmfs-opensci-logo3.png" 19 | favicon: images/favicon.ico 20 | pinned: true 21 | align: center 22 | tools: 23 | - icon: globe 24 | href: https://nmfs-opensci.github.io 25 | text: "NMFS Open Science" 26 | - icon: github 27 | href: https://github.com/nmfs-opensci 28 | text: "NMFS OpenSci" 29 | 30 | style: "docked" 31 | search: true 32 | collapse-level: 1 33 | contents: 34 | - href: index.qmd 35 | text: Home 36 | - href: content/add-content.qmd 37 | text: Add content 38 | - href: content/customizing.qmd 39 | text: Customizing 40 | - href: content/rendering.qmd 41 | text: Rendering 42 | - href: content/rmarkdown.Rmd 43 | text: R Markdown files 44 | - href: content/code.qmd 45 | text: Code in your files 46 | - href: content/acknowledgements.qmd 47 | text: Acknowledgements 48 | 49 | format: 50 | html: 51 | theme: 52 | light: [cosmo, theme.scss] 53 | dark: [cosmo, theme-dark.scss] 54 | code-copy: true 55 | code-overflow: wrap 56 | toc: true 57 | 58 | 59 | filters: 60 | - include-files.lua 61 | - quarto 62 | 63 | 64 | -------------------------------------------------------------------------------- /index.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "NOAA quarto simple with R" 3 | subtitle: "A simple Quarto webpage with a book layout" 4 | page-layout: full 5 | --- 6 | 7 | This is a template for a simple Quarto website that looks like a "book". This is a common format for documentation. It includes a GitHub Action that will build the website automatically when you make changes to the files. The NOAA palette and fonts has been added to `theme.scss`. The webpage will be on the `gh-pages` branch. Serving the website files from this branch is a common way to keep all the website files from cluttering your main branch. 8 | 9 | The GitHub Action installs R so you can have R code in your qmd or Rmd files. Note, you do not need to make changes to your Rmd files unless your need Quarto features like cross-references. 10 | 11 | ## GitHub Set-up 12 | 13 | * Click the green "use template" button to make a repository with this content. Make sure to make your repo public (since GitHub Pages doesn't work on private repos unless you have a paid account) and check box to include all the branches (so that you get the gh-pages branch). 14 | image 15 | 16 | * Turn on GitHub Pages under Settings > Pages . You will set pages to be made from the gh-pages branch and root directory. 17 | image 18 | 19 | * Turn on GitHub Actions under Settings > Actions > General 20 | image 21 | 22 | * Edit the repo description and Readme to add a link to the webpage. When you edit the description, you will see the link url in the url box or you can click on the Actions tab or the Settings > Pages page to find the url. 23 | -------------------------------------------------------------------------------- /content/publishing.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: Publishing 3 | --- 4 | 5 | To get your Quarto webpage to show up with the url 6 | ``` 7 | yourname.github.io/yourrepo 8 | ``` 9 | you have a few steps. 10 | 11 | ## Turn on GitHub Pages for your repo 12 | 13 | * Turn on GitHub Pages under Settings > Pages . You will set pages to be made from the gh-pages branch and the root directory. 14 | * Turn on GitHub Actions under Settings > Actions > General 15 | 16 | The GitHub Action will automatically recreate your website when you push to GitHub **after** you do the initial `gh-pages` set-up 17 | 18 | ## Do your first publish to `gh-pages` 19 | 20 | The first time you publish to `gh-pages`, you need to do so locally. 21 | 22 | * On your local computer, open a terminal window and `cd` to your repo directory. Here is what that `cd` command looks like for me. You command will look different because your local repo will be somewhere else on your computer. 23 | ``` 24 | cd ~/Documents/GitHub/NOAA-quarto-simple 25 | ``` 26 | * Publish to the `gh-pages`. In the terminal type 27 | ``` 28 | quarto publish gh-pages 29 | ``` 30 | This is going to render your webpage and then push the `_site` contents to the `gh-pages` branch. 31 | 32 | 33 | ## Don't like using `gh-pages`? 34 | 35 | In some cases, you don't want your website on the `gh-pages` branch. For example, if you are creating releases and you want the website pages archived in that release, then you won't want your website pages on the `gh-pages` branch. 36 | 37 | Here are the changes you need to make if you to avoid `gh-pages` branch. 38 | 39 | * At the top of `_quarto.yml` add the following: 40 | ``` 41 | project: 42 | type: website 43 | output-dir: docs 44 | ``` 45 | * On GitHub under Settings > Pages set pages to be made from the `main` branch and the docs directory. 46 | * Make sure `docs` is not listed in `.gitignore` 47 | * Publish the site the first time locally using `quarto publish` from the terminal 48 | * Change the GitHub Action because you can't use `quarto publish gh-pages`. You'll need to push to the main branch yourself (in the GitHub Action) 49 | ``` 50 | on: 51 | push: 52 | branches: main 53 | 54 | name: Render and Publish 55 | 56 | jobs: 57 | build-deploy: 58 | runs-on: ubuntu-latest 59 | env: 60 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 61 | 62 | steps: 63 | - name: Check out repository 64 | uses: actions/checkout@v2 65 | 66 | - name: Set up R (needed for Rmd) 67 | uses: r-lib/actions/setup-r@v2 68 | 69 | - name: Install packages (needed for Rmd) 70 | run: Rscript -e 'install.packages(c("rmarkdown", "knitr", "jsonlite"))' 71 | 72 | - name: Set up Quarto 73 | uses: quarto-dev/quarto-actions/setup@v2 74 | with: 75 | # To install LaTeX to build PDF book 76 | # tinytex: true 77 | # uncomment below and fill to pin a version 78 | # version: 0.9.600 79 | 80 | - name: Render Quarto Project 81 | uses: quarto-dev/quarto-actions/render@v2 82 | with: 83 | to: html 84 | 85 | - name: Set up Git 86 | run: | 87 | git config --local user.email "actions@github.com" 88 | git config --local user.name "GitHub Actions" 89 | 90 | - name: Commit all changes and push 91 | run: | 92 | git add -A && git commit -m 'Build site' || echo "No changes to commit" 93 | git push origin || echo "No changes to commit" 94 | ``` 95 | -------------------------------------------------------------------------------- /include-files.lua: -------------------------------------------------------------------------------- 1 | --- include-files.lua – filter to include Markdown files 2 | --- 3 | --- Copyright: © 2019–2021 Albert Krewinkel 4 | --- License: MIT – see LICENSE file for details 5 | 6 | -- Module pandoc.path is required and was added in version 2.12 7 | PANDOC_VERSION:must_be_at_least '2.12' 8 | 9 | local List = require 'pandoc.List' 10 | local path = require 'pandoc.path' 11 | local system = require 'pandoc.system' 12 | 13 | --- Get include auto mode 14 | local include_auto = false 15 | function get_vars (meta) 16 | if meta['include-auto'] then 17 | include_auto = true 18 | end 19 | end 20 | 21 | --- Keep last heading level found 22 | local last_heading_level = 0 23 | function update_last_level(header) 24 | last_heading_level = header.level 25 | end 26 | 27 | --- Update contents of included file 28 | local function update_contents(blocks, shift_by, include_path) 29 | local update_contents_filter = { 30 | -- Shift headings in block list by given number 31 | Header = function (header) 32 | if shift_by then 33 | header.level = header.level + shift_by 34 | end 35 | return header 36 | end, 37 | -- If image paths are relative then prepend include file path 38 | Image = function (image) 39 | if path.is_relative(image.src) then 40 | image.src = path.normalize(path.join({include_path, image.src})) 41 | end 42 | return image 43 | end, 44 | -- Update path for include-code-files.lua filter style CodeBlocks 45 | CodeBlock = function (cb) 46 | if cb.attributes.include and path.is_relative(cb.attributes.include) then 47 | cb.attributes.include = 48 | path.normalize(path.join({include_path, cb.attributes.include})) 49 | end 50 | return cb 51 | end 52 | } 53 | 54 | return pandoc.walk_block(pandoc.Div(blocks), update_contents_filter).content 55 | end 56 | 57 | --- Filter function for code blocks 58 | local transclude 59 | function transclude (cb) 60 | -- ignore code blocks which are not of class "include". 61 | if not cb.classes:includes 'include' then 62 | return 63 | end 64 | 65 | -- Markdown is used if this is nil. 66 | local format = cb.attributes['format'] 67 | 68 | -- Attributes shift headings 69 | local shift_heading_level_by = 0 70 | local shift_input = cb.attributes['shift-heading-level-by'] 71 | if shift_input then 72 | shift_heading_level_by = tonumber(shift_input) 73 | else 74 | if include_auto then 75 | -- Auto shift headings 76 | shift_heading_level_by = last_heading_level 77 | end 78 | end 79 | 80 | --- keep track of level before recusion 81 | local buffer_last_heading_level = last_heading_level 82 | 83 | local blocks = List:new() 84 | for line in cb.text:gmatch('[^\n]+') do 85 | if line:sub(1,2) ~= '//' then 86 | local fh = io.open(line) 87 | if not fh then 88 | io.stderr:write("Cannot open file " .. line .. " | Skipping includes\n") 89 | else 90 | local contents = pandoc.read(fh:read '*a', format).blocks 91 | last_heading_level = 0 92 | -- recursive transclusion 93 | contents = system.with_working_directory( 94 | path.directory(line), 95 | function () 96 | return pandoc.walk_block( 97 | pandoc.Div(contents), 98 | { Header = update_last_level, CodeBlock = transclude } 99 | ) 100 | end).content 101 | --- reset to level before recursion 102 | last_heading_level = buffer_last_heading_level 103 | blocks:extend(update_contents(contents, shift_heading_level_by, 104 | path.directory(line))) 105 | fh:close() 106 | end 107 | end 108 | end 109 | return blocks 110 | end 111 | 112 | return { 113 | { Meta = get_vars }, 114 | { Header = update_last_level, CodeBlock = transclude } 115 | } 116 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![](https://img.shields.io/badge/Open%20In-RStudio%20Cloud-green)](https://rstudio.cloud/content/4771757) *Try without installing anything. Make sure to click the Make a Copy button or you will lose all your changes.* 2 | 3 | # NOAA quarto simple website with R in qmd or Rmd files 4 | 5 | This is a template for [a simple Quarto website](https://nmfs-opensci.github.io/NOAA-quarto-simple/) (`type: website`). It looks like a html book (`type: book`) but unlike the book type it only has html format and you will not have the download options. `type: website` is a common format for documentation. 6 | 7 | The repo includes a GitHub Action that will build the website automatically when you make changes to the files. The webpage will use the `gh-pages` branch. Serving the website files from this branch is a common way to keep all the website files from cluttering your main branch. 8 | 9 | **Warning:** Check that the settings will allow the GitHub Action to run. See the instructions below under "GitHub Set-up". Scroll down to the troubleshooting section if the website is not built by the GitHub Action. 10 | 11 | **Note:** The GitHub Action installs R so you can render qmd files with R code. You will need to edit to install Python or Julia if your qmd uses those instead. If you have substantial computations, you don't want to be re-running all the computations for files that didn't change. Read about the [freeze option](https://quarto.org/docs/publishing/ci.html) for this situation. R users with complex reports with dependencies should be aware of the {targets} package which will help you keep track of files that need to be re-rendered due to changes in dependencies. 12 | 13 | ## GitHub Set-up 14 | 15 | * Click the green "Use This Template" button to make a repository with this content. Make sure to make your repo public (since GitHub Pages doesn't work on private repos unless you have a paid account) and check box to include all the branches (so that you get the gh-pages branch). 16 | image 17 | 18 | * Turn on GitHub Pages under Settings > Pages . You will set pages to be made from the gh-pages branch and root directory. 19 | image 20 | 21 | * Allow GitHub Actions under Settings > Actions > General 22 | image 23 | 24 | * Allow GitHub Actions to write to the gh-pages branch. Scroll to the bottom under Settings > Actions > General, and make sure "Read and Write" is selected. 25 | image 26 | 27 | * Edit the repo description and Readme to add a link to the webpage. When you edit the description, you will see the link url in the url box or you can click on the Actions tab or the Settings > Pages page to find the url to the Quarto website 28 | 29 | ## Customize 30 | 31 | * Edit the qmd or md files in the `content` folder. qmd files can include code (R, Python, Julia) and lots of Quarto markdown bells and whistles (like call-outs, cross-references, auto-citations and much more). 32 | * Add the files to `_quarto.yml` 33 | 34 | ## Troubleshooting builds 35 | 36 | The most common trouble users run into is that the book is not rendering. Check the following: 37 | 38 | * The `gh-pages` branch does not exist. If you forgot to check the check box to include all the branches when you created the repo from the template then it won't exist. The Action will fail if the gh-pages branch does not already exist. You can create the branch and then push a change to main to trigger the Action to run again. 39 | * The GitHub Pages has not been set. You need to go to Pages under settings, and set Pages to build from the `gh-pages` branch. 40 | * You did not allow GitHub Actions to run and/or did not give read/write permission. Go to Settings > Actions > General, and make sure Actions are allowed (top section) and they have read/write permission (bottom section). 41 | * You did not push a change to the main branch. The Action is triggered by a push to main, so try making an edit to README.md and pushing that change. 42 | 43 |
44 | 45 | ### Disclaimer 46 | 47 | This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project content is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government. 48 | 49 | ### License 50 | 51 | This content was created by U.S. Government employees as part of their official duties. This content is not subject to copyright in the United States (17 U.S.C. §105) and is in the public domain within the United States of America. Additionally, copyright is waived worldwide through the CC0 1.0 Universal public domain dedication. 52 | 53 |
54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | --------------------------------------------------------------------------------