Dave Jarvis' Repositories
git clone https://repo.autonoma.ca/repo/keenwrite.git
Adds example batch file
| Author | DaveJarvis <email> |
|---|---|
| Date | 2025-09-06 15:01:46 GMT-0700 |
| Commit | 7565cce310592f0137b260d5ce5a72f2fdf93219 |
| Parent | b4f067d |
| Delta | 64 lines added, 24 lines removed, 40-line increase |
keenwrite.bat
| +@echo off | ||
| + | ||
| +set SCRIPT_DIR=%~dp0 | ||
| +java ^ | ||
| + -Dprism.order=sw ^ | ||
| + --enable-native-access=javafx.graphics ^ | ||
| + --add-opens=javafx.controls/javafx.scene.control=ALL-UNNAMED ^ | ||
| + --add-opens=javafx.controls/javafx.scene.control.skin=ALL-UNNAMED ^ | ||
| + --add-opens=javafx.graphics/javafx.scene.text=ALL-UNNAMED ^ | ||
| + --add-opens=javafx.graphics/com.sun.javafx.css=ALL-UNNAMED ^ | ||
| + --add-opens=javafx.graphics/com.sun.javafx.text=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.base/com.sun.javafx.event=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.application=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.geom=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.text=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.scene=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.scene.text=ALL-UNNAMED ^ | ||
| + --add-exports=javafx.graphics/com.sun.javafx.scene.traversal=ALL-UNNAMED ^ | ||
| + -jar "%SCRIPT_DIR%\keenwrite.jar" %* | ||
| + | ||
docs/02-installation.md
| This chapter covers installing the application and its dependencies, including | ||
| -the typesetting software required for PDF generation. Installation can be done | ||
| -using a guided wizard or manually by following platform-specific steps. | ||
| +the typesetting software required for PDF generation. Generating PDF files | ||
| +requires the following components: | ||
| -## Java archive | ||
| +* {{app.title}} binaries | ||
| +* {{app.title}} themes | ||
| +* ConTeXt typesetting software | ||
| -For users who opt to use the Java archive directly, the application must be run | ||
| -using a version of Java Runtime Environment (JRE) **{{version.java}}** that | ||
| -bundles JavaFX. For example, use **Liberica Full JRE** from BellSoft as | ||
| -follows: | ||
| +The easiest way to get started is by downloading a suitable {{app.title}} | ||
| +binary for your operating system, running it, and then launching the guided | ||
| +wizard as per [@sec:wizard]. The wizard will download and install all | ||
| +typesetting components. | ||
| + | ||
| +{{app.title}} binaries are self-installing, except for the Java archive | ||
| +(`.jar`) version. Installing the Java archive version is described in | ||
| +[@sec:java-runtime-environment]. | ||
| + | ||
| +## Wizard | ||
| + | ||
| +Launch the wizard as follows: | ||
| + | ||
| +1. Start {{app.title}}. | ||
| +1. Click **File → Export As → PDF**. | ||
| + | ||
| +The installation wizard downloads a container manager, various themes, and | ||
| +numerous fonts to produce high-quality PDF files. Using a container reduces | ||
| +the number of manual installation steps. | ||
| + | ||
| +## Java Runtime Environment | ||
| + | ||
| +For users who opt to use the Java archive instead of a native binary, you | ||
| +will need the following: | ||
| + | ||
| +* Java Runtime Environment **{{version.java}}**. | ||
| +* {{app.title}} launch script. | ||
| + | ||
| +Software developers may choose to use the Java Development Kit | ||
| +**{{version.java}}**. | ||
| + | ||
| +### JRE with JavaFX | ||
| + | ||
| +Install a Java Runtime Environment (JRE) **{{version.java}}** version that | ||
| +bundles JavaFX, such as BellSoft's **Liberica Full JRE**. | ||
| 1. Visit the Liberica JDK [download page](https://bell-sw.com/pages/downloads/#jdk-24). | ||
| 1. Select the JDK corresponding to **{{version.java}}**. | ||
| 1. Scroll down to the desired operating system. | ||
| 1. Change the target CPU architecture, if needed. | ||
| 1. Set **Package** to: `Full JRE`. | ||
| 1. Download the `.zip` or `.tar.gz` file. | ||
| -After downloading the JRE, install it and make sure Java can be found when | ||
| -run. On Unix systems, my preferred installation method follows: | ||
| +After downloading the *full* JRE, install it and make sure Java can be found | ||
| +when run. On Unix systems, my preferred installation method follows: | ||
| 1. Edit `$HOME/.bashrc`. | ||
 | ||
| enables upgrading the JRE without having to update the `.bashrc` for each | ||
| new version. | ||
| - | ||
| -## Automatic | ||
| - | ||
| -The application uses the ConTeXt typesetting system, the podman container | ||
| -manager, various themes, and numerous fonts to produce high-quality PDF files. | ||
| -Using a container reduces the number of manual installation steps. | ||
| - | ||
| -When exporting a document to a PDF file for the first time, a wizard will guide | ||
| -you through the installation process. The steps will vary based on the | ||
| -operating system. | ||
| -Launch the installation wizard to install the typesetter and themes: | ||
| -1. Start {{app.title}}. | ||
| -1. Click **File → Export As → PDF**. | ||
| -## Manual | ||
| +## ConTeXt LMTX | ||
| For users who prefer more control over, and a deeper understanding of, the | ||
| ||
| 1. Run `localpath.bat` (to set and save the `PATH` environment variable). | ||
| -## Verification | ||
| +### Verification | ||
| After completing the installation process, verify that the typesetting software | ||
docs/user-manual.pdf
Binary files differ