initial

Gemfile

@@ -4,6 +4,8 @@ source "https://rubygems.org"
 
 gem "jekyll-theme-chirpy", "~> 6.1"
 
+gem 'jekyll-github-metadata', '~> 2.13.0'
+
 group :test do
   gem "html-proofer", "~> 3.18"
 end

_config.yml

@@ -13,39 +13,35 @@ baseurl: ""
 lang: en
 
 # Change to your timezone › http://www.timezoneconverter.com/cgi-bin/findzone/findzone
-timezone:
+timezone: America/New_York
 
 # jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
 # ↓ --------------------------
 
-title: Chirpy # the main title
+title: Trucaption # the main title
 
-tagline: A text-focused Jekyll theme # it will display as the sub-title
+tagline: Real-time captioning # it will display as the sub-title
 
 description: >- # used by seo meta and the atom feed
-  A minimal, responsive and feature-rich Jekyll theme for technical writing.
+  A real-time captioning system with support for large and small screen display. 
 
 # fill in the protocol & hostname for your site, e.g., 'https://username.github.io'
-url: ""
+url: "https://www.trucaption.com/"
 
 github:
-  username: github_username # change to your github username
-
-twitter:
-  username: twitter_username # change to your twitter username
+  username: dkaser # change to your github username
 
 social:
   # Change to your full name.
   # It will be displayed as the default author of the posts and the copyright owner in the Footer
-  name: your_full_name
-  email: example@domain.com # change to your email address
+  name: Derek Kaser
+  email: derek@trucaption.com # change to your email address
   links:
     # The first element serves as the copyright owner's link
-    - https://twitter.com/username # change to your twitter homepage
-    - https://github.com/username # change to your github homepage
+    - https://github.com/dkaser # change to your github homepage
     # Uncomment below to add more social links
     # - https://www.facebook.com/username
-    # - https://www.linkedin.com/in/username
+    - https://www.linkedin.com/in/dkaser
 
 google_site_verification: # fill in to your verification string
 
@@ -66,7 +62,7 @@ google_analytics:
 #     light  - Use the light color scheme
 #     dark   - Use the dark color scheme
 #
-theme_mode: # [light|dark]
+theme_mode: dark
 
 # The CDN endpoint for images.
 # Notice that once it is assigned, the CDN url
@@ -76,7 +72,7 @@ theme_mode: # [light|dark]
 img_cdn:
 
 # the avatar on sidebar, support local or CORS resources
-avatar:
+avatar: "/assets/img/trucaption_logo.png"
 
 # boolean type, the global switch for TOC in posts.
 toc: true
@@ -114,6 +110,11 @@ pwa:
 
 paginate: 10
 
+plugins:
+  - jekyll-github-metadata
+
+repository: dkaser/trucaption
+
 # ------------ The following options are not recommended to be modified ------------------
 
 kramdown:

_data/contact.yml

@@ -3,16 +3,10 @@
 - type: github
   icon: "fab fa-github"
 
-- type: twitter
-  icon: "fab fa-twitter"
-
 - type: email
   icon: "fas fa-envelope"
   noblank: true # open link in current tab
 
-- type: rss
-  icon: "fas fa-rss"
-  noblank: true
 # Uncomment and complete the url below to enable more contact options
 #
 # - type: mastodon

_posts/2023-08-21-azure.md

@@ -0,0 +1,38 @@
+---
+title: Using Azure Speech Services
+author: derek
+date: 2023-08-21 08:55:00 -0400
+categories: [Advanced]
+tags: [advanced-configuration, azure]
+permalink: /azure/
+---
+
+## Configuration
+
+Trucaption can be configured to use Azure Speech Services instead of the built-in browser speech recognition. To use Azure Speech Services, you will need:
+
+- A [Microsoft Azure](https://azure.microsoft.com/en-us/products/ai-services/ai-speech) account
+- An Azure Speech Service
+
+Once you have created a Speech Service in the Azure portal, obtain the region and a subscription key from the Overview page of the service (there will be two subscription keys, it doesn't matter which one you choose). Then, configure Trucaption to use Azure for transcription:
+
+1. Within the editor window, click Configure.
+2. Set the transcription engine to "Azure".
+3. Enter the *Location/Region* from the Azure portal as **Azure Region**.
+4. Enter the subscription key from the Azure portal as **Azure Subscription Key**
+5. **Azure Endpoint ID** should be left blank unless you are using Custom Speech.
+
+## Custom Speech
+
+Once your Azure speech account is configured, you can also choose to set up custom speech. This allows the engine to be trained to provide more accurate captions.
+
+To set up custom speech:
+
+1. Log in to the Azure [Speech Studio](https://speech.microsoft.com/).
+2. Create a new project.
+3. Train your custom model. ([Azure Docs](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/how-to-custom-speech-train-model?pivots=speech-studio))
+4. Deploy a custom endpoint with your trained model. ([Azure Docs](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/how-to-custom-speech-deploy-model?pivots=speech-studio))
+5. Obtain the *Resource Key* and *Endpoint ID* for your endpoint from Speech Studio.
+6. Configure Trucaption to use your custom endpoint:
+   - Set **Azure Subscription Key** to the Resource Key for the endpoint.
+   - Set **Azure Endpoint ID** to the Endpoint ID. 

_posts/2023-08-21-final-vs-interim.md

@@ -0,0 +1,20 @@
+---
+title: Understanding Final vs. Interim Transcripts
+author: derek
+date: 2023-08-21 08:55:00 -0400
+categories: [Advanced]
+tags: [advanced-configuration]
+permalink: /final-vs-interim/
+---
+
+Real time transcription provides two different "qualities" of text which work together to provide the final text: interim and final transcripts.
+
+## Interim Transcriptions
+
+Interim transcripts are created rapidly, as the engine uses syllables, words, and small phrases to determine what was said. This allows transcripts to appear word-by-word as a speaker is speaking. However, this method is less accurate than the method used for final transcripts.
+
+In Trucaption, interim transcripts are displayed at the bottom of the transcript and cannot be edited. Interim transcripts are replaced with final transcripts as the final version becomes available.
+
+## Final Transcriptions
+
+Final transcripts are created when a speaker pauses. During final transcription, the engine uses the full phrases/sentences to generate a more accurate transcription than interim transcripts. Final transcripts alone are not generally suitable for real-time transcription since a significant delay occurs between when words are spoken and when the text becomes available.

_posts/2023-08-21-getting-started.md

@@ -0,0 +1,30 @@
+---
+title: Getting Started
+author: derek
+date: 2023-08-21 08:55:00 -0400
+categories: [Tutorial]
+tags: [getting started]
+pin: true
+permalink: /getting-started/
+---
+
+## Creating and Editing Captions
+
+Getting started with Trucaption is easy! Just download and run the application from the [Download](/download/) page on a computer connected to your audio source (microphone/sound board/etc.).
+
+Once Trucaption starts, your browser will open to the editor screen where you can start, stop, and edit the captions. If you are using a browser that supports built-in speech recognition, you don't need to do any configuration -- just click "Connect", then "Start Captions".
+
+Automatic captioning isn't perfect, and there will sometimes be errors in the generated text. In Trucaption, you can edit captions after they are generated to fix these errors. Just click the text you want to edit, make the desired changes, then press Enter or click elsewhere on the screen. The changes will be immediately sent to all viewers. If you want to cancel your changes, press Escape.
+
+## Viewing Captions
+
+If you click "Open Viewer" in the editor window, a dedicated viewing window will open. This is great for use on a large-screen display (e.g., using a projector or television connected to the computer running Trucaption).
+
+The viewer can also be opened across the network -- just go to http://your.trucaption.computer.address/ on another computer. If you want to make captions available via the internet, you'll probably need to set up either port forwarding or a reverse proxy like Cloudflare Tunnels.
+
+## Advanced Captioning
+
+By default, Trucaption uses the built-in speech recognition provided by your web browser to generate captions. If you would like to use an advanced transcription service, Trucaption can also be connected to either Azure Speech Services or Speechly:
+
+- [Azure Speech Services](/azure/)
+- [Speechly](/speechly/)

_posts/2023-08-21-speechly.md

@@ -0,0 +1,21 @@
+---
+title: Using Speechly
+author: derek
+date: 2023-08-21 08:55:00 -0400
+categories: [Advanced]
+tags: [advanced-configuration, speechly]
+permalink: /speechly/
+---
+
+## Configuration
+
+Trucaption can be configured to use Speechly instead of the built-in browser speech recognition. To use Speechly, you will need:
+
+- A [Speechly](https://www.speechly.com/) account
+- A Speechly application
+
+After creating your Speechly application, copy the *App ID* displayed in Speechly. Then, configure Trucaption to use Speechly for transcription:
+
+1. Within the editor window, click Configure.
+2. Set the transcription engine to "Speechly".
+3. Paste the Application ID in the "Speechly App" option.

_posts/2023-08-21-viewer.md

@@ -0,0 +1,27 @@
+---
+title: Customizing the Viewer
+author: derek
+date: 2023-08-21 08:55:00 -0400
+categories: [Advanced]
+tags: [advanced-configuration]
+permalink: /viewer/
+---
+
+The viewer display can be customized if desired. By default, the viewer display includes a menu with an option to change the font size. This can be changed by adding settings to the viewer address:
+
+ - **?fullscreen** will disable the menu
+ - **?size=NUM** will set the font size to NUM.
+
+Combining these options can be useful for large-screen displays.
+
+## Examples
+
+- http://*caption-host*/?fullscreen
+  - Disables the menu
+  - Uses default font size
+- http://*caption-host*/?fullscreen&size=40
+  - Disables the menu
+  - Sets font size to 40
+- http://*caption-host*/?size=40
+  - Sets starting font size to 40
+  - User can change font size using the menu

_tabs/configuration.md

@@ -0,0 +1,20 @@
+---
+# the default layout is 'page'
+icon: fas fa-gear
+order: 5
+---
+
+Trucaption settings can be modified via the "Configure" button in the editor window.
+
+## Transcription Settings
+
+- Transcription Engine
+  - Browser Native (free, uses built-in speech recognition, requries browser support)
+  - [Azure Speech Services](/azure/) (paid service)
+  - [Speechly](/speechly) (paid service)
+
+## App Settings
+
+- **Maximum Lines**: adjusts the number of lines that are displayed on the editor and viewer screens. This can be useful to improve performance when running Trucaption for a long time. Set to -1 to keep all lines in the window.
+- **Default Font Size**: changes the default font size selected when the editor or viewer windows are opened.
+- **Clear temporary transcript on stop**: When enabled, interim transcripts are erased when "Stop Listening" is pressed. When disabled, interim transcripts are converted to final transcripts and can then be edited. (For more information on final vs. interim transcripts, see [this article](/final-vs-interim/)).

_tabs/download.md

@@ -0,0 +1,17 @@
+---
+# the default layout is 'page'
+icon: fas fa-download
+order: 2
+---
+
+## Trucaption {{ site.github.latest_release.name }}
+
+### Changes in this release:
+{{ site.github.latest_release.body }}
+
+### Download links:
+{% for asset in site.github.latest_release.assets %}
+  * [{{ asset.name}}]({{ asset.browser_download_url }})
+{% endfor %}
+
+For older releases, visit [Releases](https://github.com/dkaser/trucaption/releases).

_tabs/features.md

@@ -0,0 +1,16 @@
+---
+# the default layout is 'page'
+icon: fas fa-star
+order: 3
+---
+
+Trucaption is a Computer-Aided Real Time Transcription (CART) system designed for events.
+
+- Free captioning using built-in functionality on supported browsers.
+- Advanced captioning via Azure Speech Services or Speechly.
+- Real-time editing: an operator can make corrections to the automatically generated captions.
+- Bad word filter
+- Multiple viewing options:
+  - Via a second browser window on the computer running Trucaption
+  - Via a local network connection
+  - Via the internet (requires port forwarding/tunneling/etc.)

_tabs/screenshots.md

@@ -0,0 +1,14 @@
+---
+# the default layout is 'page'
+icon: fas fa-desktop
+order: 4
+---
+
+![Editor Window](/assets/img/screenshots/editor.png){: .shadow; width="350" }
+_The editor window_
+
+![Viewer Window](/assets/img/screenshots/viewer.png){: .shadow; width="350" }
+_The viewer window_
+
+![Configuration Panel](/assets/img/screenshots/config.png){: .shadow; width="200" }
+_The configuration panel_