V2.0.0

.github/workflows/generate-docs-pdf.yml

@@ -0,0 +1,133 @@
+name: Generate Documentation PDFs
+
+on:
+  push:
+    branches: ["main", "v2.0.0"]
+    paths:
+      - 'gh_pages/_docs/**'
+      - 'gh_pages/assets/pdf-template/**'
+      - '.github/workflows/generate-docs-pdf.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  generate-pdfs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Pandoc and LaTeX
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
+
+      - name: Create PDF output directory
+        run: |
+          mkdir -p gh_pages/assets/pdf
+
+      - name: Generate Getting Started PDF
+        run: |
+          pandoc gh_pages/_docs/getting-started.md \
+            -o gh_pages/assets/pdf/getting-started.pdf \
+            --from markdown \
+            --template gh_pages/assets/pdf-template/template.tex \
+            --variable documentclass=article \
+            --variable geometry:margin=1in \
+            --variable fontsize=11pt \
+            --variable colorlinks=true \
+            --variable linkcolor=red \
+            --variable urlcolor=red \
+            --toc \
+            --toc-depth=2 \
+            --pdf-engine=pdflatex \
+            --metadata title="Event Video Playback - Getting Started" \
+            --metadata author="Beckhoff USA Community"
+
+      - name: Generate PLC Library Usage PDF
+        run: |
+          pandoc gh_pages/_docs/plc-usage.md \
+            -o gh_pages/assets/pdf/plc-usage.pdf \
+            --from markdown \
+            --template gh_pages/assets/pdf-template/template.tex \
+            --variable documentclass=article \
+            --variable geometry:margin=1in \
+            --variable fontsize=11pt \
+            --variable colorlinks=true \
+            --variable linkcolor=red \
+            --variable urlcolor=red \
+            --toc \
+            --toc-depth=2 \
+            --pdf-engine=pdflatex \
+            --metadata title="Event Video Playback - PLC Library Usage" \
+            --metadata author="Beckhoff USA Community"
+
+      - name: Generate Service Configuration PDF
+        run: |
+          pandoc gh_pages/_docs/service-config.md \
+            -o gh_pages/assets/pdf/service-config.pdf \
+            --from markdown \
+            --template gh_pages/assets/pdf-template/template.tex \
+            --variable documentclass=article \
+            --variable geometry:margin=1in \
+            --variable fontsize=11pt \
+            --variable colorlinks=true \
+            --variable linkcolor=red \
+            --variable urlcolor=red \
+            --toc \
+            --toc-depth=2 \
+            --pdf-engine=pdflatex \
+            --metadata title="Event Video Playback - Service Configuration" \
+            --metadata author="Beckhoff USA Community"
+
+      - name: Generate HMI Usage PDF
+        run: |
+          pandoc gh_pages/_docs/hmi-usage.md \
+            -o gh_pages/assets/pdf/hmi-usage.pdf \
+            --from markdown \
+            --template gh_pages/assets/pdf-template/template.tex \
+            --variable documentclass=article \
+            --variable geometry:margin=1in \
+            --variable fontsize=11pt \
+            --variable colorlinks=true \
+            --variable linkcolor=red \
+            --variable urlcolor=red \
+            --toc \
+            --toc-depth=2 \
+            --pdf-engine=pdflatex \
+            --metadata title="Event Video Playback - HMI NuGet Package Usage" \
+            --metadata author="Beckhoff USA Community"
+
+      - name: Generate Complete Documentation PDF
+        run: |
+          pandoc gh_pages/_docs/getting-started.md \
+                 gh_pages/_docs/plc-usage.md \
+                 gh_pages/_docs/service-config.md \
+                 gh_pages/_docs/hmi-usage.md \
+            -o gh_pages/assets/pdf/complete-documentation.pdf \
+            --from markdown \
+            --template gh_pages/assets/pdf-template/template.tex \
+            --variable documentclass=report \
+            --variable geometry:margin=1in \
+            --variable fontsize=11pt \
+            --variable colorlinks=true \
+            --variable linkcolor=red \
+            --variable urlcolor=red \
+            --toc \
+            --toc-depth=2 \
+            --pdf-engine=pdflatex \
+            --metadata title="Event Video Playback - Complete Documentation" \
+            --metadata author="Beckhoff USA Community" \
+            --metadata date="$(date +'%B %Y')"
+
+      - name: Commit PDFs to repository
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add gh_pages/assets/pdf/*.pdf
+          git diff --staged --quiet || git commit -m "Generate documentation PDFs [skip ci]"
+          git push

.github/workflows/pages.yml

@@ -0,0 +1,58 @@
+name: Deploy Jekyll site to GitHub Pages
+
+on:
+  push:
+    branches: ["main", "v2.0.0"]
+    paths:
+      - 'gh_pages/**'
+      - '.github/workflows/pages.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+          working-directory: ./gh_pages
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with Jekyll
+        working-directory: ./gh_pages
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./gh_pages/_site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -2,13 +2,11 @@
 
 This repository includes both the source files and the release package for the TwinCAT Event Video Playback package. The package provides an easy to use PLC interface for assembling images captured with TwinCAT Vision into a single video file. When the video file is created, a corresponding alarm event is logged into the TwinCAT Event Logger for later viewing. In addition, an HMI Control component is supplied for easy viewing and playback of logged video events on TwinCAT HMI.
 
+**WARNING: Remove any installs from the legacy TC_EventVideoPlayback before using the new 4026 version**
+
 ## Quick Start
 
-**For end users**: Instead of building from source, download the installer from the [Releases section](https://github.com/Beckhoff-USA-Community/EventVideoPlayback/releases). The release package includes:
-- Sample PLC project
-- Sample HMI project
-- PLC library
-- Windows service installer
+**For end users**: Instead of building from source, connect to the [Beckhoff USA Communtiy package](https://packages.beckhoff-usa-community.com/) feed like you would normally with Beckhoff Official Packages.
 
 **For developers**: See [Building from Source](#building-from-source) below.