Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git
![Logo](images/logo64.png)

# $application.title$

A text editor that uses [interpolated strings](https://en.wikipedia.org/wiki/String_interpolation) to reference externally defined values.

## Requirements

Download and install the following software packages:

* [OpenJDK 14](https://openjdk.java.net)

## Quick Start

Complete the following steps to run the application:

1. [Download](https://github.com/DaveJarvis/scrivenvar/releases)
`scrivenvar.jar`.
1. Double-click `scrivenvar.jar` to start the application.

## Command Line Start

If the quick start fails, run the application as follows:

1. Open a command prompt.
1. Change to the download directory containing the archive file.
1. Run: `java -jar scrivenvar.jar`

## Features

* R integration
* User-defined variables, interpolated
* Real-time preview with variable substitution
* Auto-complete variable names based on variable values
* XML document transformation using XSLT3 or older
* Platform independent (Windows, Linux, MacOS)

## Usage

See the following documents for more information:

* [USAGE.md](USAGE.md) -- Variable definitions and string interpolation
* [USAGE-R.md](USAGE-R.md) -- Call R functions within R Markdown documents
* [USAGE-SVG.md](USAGE-SVG.md) -- Fix known issues with displaying SVG files

## Future Features

* Spell check
* Search and replace using variables
* Re-organize variable names

## Screenshot

![Screenshot](images/screenshot.png)

## License

This software is licensed under the [BSD 2-Clause License](LICENSE.md).