PG 2.21 Release Candidate

.github/workflows/generate-and-publish-docs.yml

@@ -0,0 +1,76 @@
+name: Generate and Publish PG POD and Sample Problem Documentation
+
+on:
+  # Execute the workflow anytime something is merged into or pushed to main.
+  push:
+    branches:
+      - main
+
+  # This allows this workflow to be triggered manually from the actions tab.
+  workflow_dispatch:
+
+jobs:
+  generate-documentation:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends --no-install-suggests \
+            pandoc \
+            libmojolicious-perl \
+            libpandoc-wrapper-perl \
+            libpod-parser-perl
+
+      - name: Checkout pg code
+        uses: actions/checkout@v4
+        with:
+          path: pg
+
+      - name: Create output directory
+        run: mkdir /home/runner/work/pg/pg/documentation
+
+      - name: Generate sample problem documentation
+        run: |
+          perl pg/bin/parse-problem-doc.pl \
+            --problem-dir=/home/runner/work/pg/pg/pg/tutorial/sample-problems \
+            --out-dir=/home/runner/work/pg/pg/documentation/sampleproblems \
+            --pod-base-url=/pg/pod \
+            --sample-problem-base-url=/pg/sampleproblems
+
+      - name: Generate POD
+        run: perl pg/bin/generate-pg-pod.pl --output-dir=documentation/pod --base-url=/pg/pod/ --home-url=/pg
+
+      - name: Generate search data
+        run: perl pg/bin/generate-search-data.pl --out-file=documentation/sample-problem-search-data.json
+
+      - name: Copy assets
+        run: |
+          cp /home/runner/work/pg/pg/pg/tutorial/templates/index.html \
+            /home/runner/work/pg/pg/documentation/
+          cp /home/runner/work/pg/pg/pg/htdocs/js/SampleProblemViewer/documentation-search.js \
+            /home/runner/work/pg/pg/documentation/
+
+      - name: Upload documentation html
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: documentation
+
+  publish-documentation:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Set the permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
+    permissions:
+      pages: write
+      id-token: write
+
+    runs-on: ubuntu-24.04
+    needs: generate-documentation
+
+    steps:
+      - name: Publish to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

LICENSE

@@ -1,8 +1,8 @@
-                                     WeBWorK
-                         Online Homework Delivery System
+                                   WeBWorK PG
                                    Version 2.*
 
                     Copyright 2000-2025, The WeBWorK Project
+
                               All rights reserved.
 
     This program is free software; you can redistribute it and/or modify
@@ -12,19 +12,19 @@
         Software Foundation; either version 2, or (at your option)
         any later version, or
 
-        b) the "Artistic License" which comes with this package.
+        b) the "Artistic License" 1.0 which comes with this package.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
     the GNU General Public License or the Artistic License for more details.
 
-    You should have received a copy of the Artistic License with this
-    package, in the file named "Artistic".  If not, we'll be glad to provide
-    one.
+    You should have received a copy of the Artistic License 1.0 with this
+    package, in the file named "Artistic" inside the `doc` folder.  If not,
+    you can find a copy at https://github.com/openwebwork/pg/blob/main/doc/Artistic
+    or https://perlfoundation.org/artistic-license-10.html.
 
     You should also have received a copy of the GNU General Public License
-    along with this program in the file named "Copying". If not, write to the
-    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-    02111-1307, USA or visit their web page on the internet at
-    http://www.gnu.org/copyleft/gpl.html.
+    along with this program in the file named "Copying" inside the `doc` folder.
+    If not, you can find a copy at https://github.com/openwebwork/pg/blob/main/doc/Copying
+    or https://www.gnu.org/licenses/old-licenses/gpl-2.0.html.

README.md

@@ -1,25 +1,20 @@
 # Welcome to WeBWorK
 
-![main workflow](https://github.com/pstaabp/pg/actions/workflows/coverage.yml/badge.svg)
-[![codecov](https://codecov.io/gh/pstaabp/pg/branch/unit-test/graph/badge.svg?token=H7WYHBDB9S)](https://codecov.io/gh/pstaabp/pg)
-![GitHub last commit](https://img.shields.io/github/last-commit/pstaabp/pg/unit-test)
-
-WeBWorK is an open-source online homework system for math and sciences courses. WeBWorK is supported by the MAA and the NSF and comes with an Open Problem Library (OPL) of over 30,000 homework problems. Problems in the OPL target most lower division undergraduate math courses and some advanced courses. Supported courses include college algebra, discrete mathematics, probability and statistics, single and multivariable calculus, differential equations, linear algebra and complex analysis.  Find out more at the main WeBWorK [webpage](http://webwork.maa.org).
+WeBWorK is an open-source online homework system for math and sciences courses. WeBWorK is supported by the MAA and the NSF and comes with an Open Problem Library (OPL) of over 30,000 homework problems. Problems in the OPL target most lower division undergraduate math courses and some advanced courses. Supported courses include college algebra, discrete mathematics, probability and statistics, single and multivariable calculus, differential equations, linear algebra and complex analysis.  Find out more at the main WeBWorK [webpage](https://openwebwork.org).
 
 ## Information for Users
 
 New users interested in getting started with their own WeBWorK server, or instructors looking to learn more about how to use WeBWorK in their classes, should take a look at one of the following resources:
 
-* [WeBWorK wiki](http://webwork.maa.org/wiki/Main_Page) - The main WeBWorK wiki
-  * [Instructors](http://webwork.maa.org/wiki/Instructors) - Information for Instructors
-  * [Problem Authors](http://webwork.maa.org/wiki/Authors) - Information for Problem Authors
-* [WW_Install](http://github.com/aubreyja/ww_install) - Information for using the WW_install script
-* [Forum](http://webwork.maa.org/moodle/mod/forum/index.php?id=3) - The WeBWorK Forum
+* [WeBWorK wiki](https://wiki.openwebwork.org/wiki/WeBWorK_Main_Page) - The main WeBWorK wiki
+  * [Instructors](https://wiki.openwebwork.org/wiki/Instructors) - Information for Instructors
+  * [Problem Authors](https://wiki.openwebwork.org/wiki/Authors) - Information for Problem Authors
+* [Forum](https://forums.openwebwork.org/mod/forum/index.php?id=3) - The WeBWorK Forum
 * [Frequently Asked Questions](https://github.com/openwebwork/webwork2/wiki/Frequently-Asked-Questions) - A list of frequently asked questions.
 
 ## Information For Developers
 
-People interested in developing new features for WeBWorK should take a look at the following resources.  People interested in developing new problems for WeBWorK should visit [Problem Authors](http://webwork.maa.org/wiki/Authors).
+People interested in developing new features for WeBWorK should take a look at the following resources.  People interested in developing new problems for WeBWorK should visit [Problem Authors](https://wiki.openwebwork.org/wiki/Authors).
 
 * [First Time Setup](https://github.com/openwebwork/webwork2/wiki/First-Time-Setup) - Setting up your clone of this github repo for the first time.
 * [Coding and Workflow](https://github.com/openwebwork/webwork2/wiki/Coding-and-Workflow) -  Our suggested workflow processes.  Following this will make it much easier to get code accepted into the repo.

VERSION

@@ -1,4 +1,4 @@
-$PG_VERSION  ='2.20';
+$PG_VERSION  ='2.20+develop';
 $PG_COPYRIGHT_YEARS = '1996-2025';
 
 1;

assets/pod-templates/category-index.mt

@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+%
+<head>
+	<meta charset='UTF-8'>
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title><%= $title %></title>
+	<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/css/bootstrap.min.css" rel="stylesheet">
+	<link href="<%= $dest_url %>/assets/podviewer.css" rel="stylesheet">
+	<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.bundle.min.js" defer></script>
+	<script src="<%= $dest_url %>/assets/podviewer.js" defer></script>
+</head>
+%
+<body>
+	<div class="pod-header navbar navbar-dark bg-primary px-3 position-fixed border-bottom border-dark">
+		<div class="container-fluid d-flex flex-column d-md-block">
+			<h1 class="navbar-brand fw-bold fs-5 me-auto me-md-0 mb-2 mb-md-0"><%= $title %></h1>
+			<button class="navbar-toggler d-md-none me-auto" type="button" data-bs-toggle="offcanvas"
+				data-bs-target="#sidebar" aria-controls="sidebar" aria-label="Toggle Sidebar">
+				<span class="navbar-toggler-icon"></span>
+			</button>
+		</div>
+	</div>
+	%
+	% my ($index, $macro_index, $content, $macro_content) = ('', '', '', '');
+	% for my $macro (@$macros_order) {
+		% my $new_index = begin
+			<a href="#macro-<%= $macro %>" class="nav-link"><%= $macro_names->{$macro} // $macro %></a>
+		% end
+		% $macro_index .= $new_index->();
+		% my $new_content = begin
+			<h3><a href="#_podtop_" id="macro-<%= $macro %>"><%= $macro_names->{$macro} // $macro %></a></h3>
+			<div class="list-group mb-2">
+				% for my $file (sort { $a->[1] cmp $b->[1] } @{ $macros->{$macro} }) {
+					<a href="<%= $file->[0] %>" class="list-group-item list-group-item-action"><%= $file->[1] %></a>
+				% }
+			</div>
+		% end
+		% $macro_content .= $new_content->();
+	% }
+	% for my $section (@$section_order) {
+		% next unless defined $pod_index->{$section};
+		% my $new_index = begin
+			<a href="#<%= $section %>" class="nav-link"><%= $sections->{$section} %></a>
+			% if ($section eq 'macros') {
+				<div class="nav flex-column ms-3">
+					<%= $macro_index %>
+				</div>
+			% }
+		% end
+		% $index .= $new_index->();
+		% my $new_content = begin
+			<h2><a href="#_podtop_" id="<%= $section %>"><%= $sections->{$section} %></a></h2>
+			<div class="list-group mb-2">
+				% if ($section eq 'macros') {
+					<%= $macro_content =%>
+				% } else {
+					% for my $file (sort { $a->[1] cmp $b->[1] } @{ $pod_index->{$section} }) {
+						<a href="<%= $file->[0] %>" class="list-group-item list-group-item-action">
+							<%= $file->[1] %>
+						</a>
+					% }
+				% }
+			</div>
+		% end
+		% $content .= $new_content->();
+	% }
+	%
+	<aside class="offcanvas-md offcanvas-start border-end border-dark position-fixed" tabindex="-1"
+		id="sidebar" aria-labelledby="sidebar-label">
+		<div class="offcanvas-header">
+			<h2 class="offcanvas-title" id="sidebar-label">Index</h2>
+			<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#sidebar"
+				aria-label="Close">
+			</button>
+		</div>
+		<div class="offcanvas-body p-md-3 w-100">
+			<nav class="nav flex-column w-100">
+				<a href="<%= $home_url %>" class="nav-link"><%= $home_url_link_name %></a>
+				<a href="https://wiki.openwebwork.org/wiki/WeBWorK_Main_Page" class="nav-link">WeBWorK Wiki</a>
+				<hr>
+				<%= $index =%>
+			</nav>
+		</div>
+	</aside>
+	<div class="pod-page-container d-flex">
+		<div class="container-fluid p-3 h-100" id="_podtop_">
+			<%= $content =%>
+			<p class="mt-3">Generated <%= $date %></p>
+		</div>
+	</div>
+</body>
+%
+</html>

assets/pod-templates/pod.mt

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+%
+<head>
+	<meta charset='UTF-8'>
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title><%= $title %></title>
+	<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/css/bootstrap.min.css" rel="stylesheet">
+	<link href="<%= $dest_url %>/assets/podviewer.css" rel="stylesheet">
+	<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.bundle.min.js" defer></script>
+	<script src="<%= $dest_url %>/assets/podviewer.js" defer></script>
+</head>
+%
+<body>
+	<div class="pod-header navbar navbar-dark bg-primary px-3 position-fixed border-bottom border-dark">
+		<div class="container-fluid d-flex flex-column d-md-block">
+			<h1 class="navbar-brand fw-bold fs-5 me-auto me-md-0 mb-2 mb-md-0"><%= $title %></h1>
+			<button class="navbar-toggler d-md-none me-auto" type="button" data-bs-toggle="offcanvas"
+				data-bs-target="#sidebar" aria-controls="sidebar" aria-label="Toggle Sidebar">
+				<span class="navbar-toggler-icon"></span>
+			</button>
+		</div>
+	</div>
+	<aside class="offcanvas-md offcanvas-start border-end border-dark position-fixed" tabindex="-1"
+		id="sidebar" aria-labelledby="sidebar-label">
+		<div class="offcanvas-header">
+			<h2 class="offcanvas-title" id="sidebar-label">Index</h2>
+			<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#sidebar"
+				aria-label="Close">
+			</button>
+		</div>
+		<div class="offcanvas-body p-md-3 w-100">
+			<nav>
+				<ul class="nav flex-column w-100">
+					<li class="nav-item">
+						<a href="<%= $home_url %>" class="nav-link p-0"><%= $home_url_link_name %></a>
+					</li>
+					<li class="nav-item">
+						<a href="https://wiki.openwebwork.org/wiki/WeBWorK_Main_Page"
+							class="nav-link p-0">WeBWorK Wiki</a>
+					</li>
+					<li><hr></li>
+					<%= $index->join('') =%>
+				</ul>
+			</nav>
+		</div>
+	</aside>
+	<div class="pod-page-container d-flex">
+		<div class="container-fluid p-3 h-100" id="_podtop_">
+			<%= $content =%>
+		</div>
+	</div>
+</body>
+%
+</html>