Dave Jarvis' Repositories

# Introduction

This document describes how to build the application and platform binaries.

# Build

Build the application überjar as follows:

# Installers

This section describes how to set up the development environment and

build native executables for supported operating systems.

## Setup

Follow these one-time setup instructions to begin:

1. Ensure `$HOME/bin` is set in the `PATH` environment variable.

1. Move `build-template` into `$HOME/bin`.

Setup is complete.

## Binaries

Run the `installer` script to build platform-specific binaries, such as:

    ./installer -V -o linux

The `installer` script:

* downloads a JDK;

* generates a run script;

* bundles the JDK, run script, and JAR file; and

* creates a standalone binary, so no installation required.

Run `./installer -h` to see all command-line options.

# Versioning

Version numbers are read directly from Git using a plugin. The version

number is written to `app.properties`, a properties file in the `resources`

directory that can be read from within the application.

See the [detailed documentation](docs/README.md) for information about

using the application.

## Documents

See the following documents for more information:

* [definitions.md](definitions.md) -- Definitions and interpolation

* [r.md](r.md) -- Call R functions within R Markdown documents

* [svg.md](svg.md) -- Fix known issues with displaying SVG files

* [credits.md](credits.md) -- Thanks to authors of contributing projects

# Credits

* Karl Tauber: [Markdown Writer FX](https://github.com/JFormDesigner/markdown-writer-fx)

* Tomas Mikula: [RichTextFX](https://github.com/TomasMikula/RichTextFX), [ReactFX](https://github.com/TomasMikula/ReactFX), [WellBehavedFX](https://github.com/TomasMikula/WellBehavedFX), [Flowless](https://github.com/TomasMikula/Flowless), and [UndoFX](https://github.com/TomasMikula/UndoFX)

* Mikael Grev: [MigLayout](http://www.miglayout.com/)

* Tom Eugelink: [MigPane](https://github.com/mikaelgrev/miglayout/blob/master/javafx/src/main/java/org/tbee/javafx/scene/layout/fxml/MigPane.java)

* Jens Deters: [FontAwesomeFX](https://bitbucket.org/Jerady/fontawesomefx)

* Dieter Holz, [PreferencesFX](https://github.com/dlsc-software-consulting-gmbh/PreferencesFX)

* David Croft, [File Preferences](http://www.davidc.net/programming/java/java-preferences-using-file-backing-store)

* Alex Bertram, [Renjin](https://www.renjin.org/)

* Vladimir Schneider: [flexmark](https://github.com/vsch/flexmark-java)

* Michael Kay, [XSLT Processor](http://www.saxonica.com/)

* Shy Shalom, Kohei Taketa: [juniversalchardet](https://github.com/takscape/juniversalchardet)

# Introduction

This document describes how to use the application.

# Variable definitions

Variable definitions provide a way to insert key names having associated values into a document. The variable names and values are declared inside an external file using the [YAML](http://www.yaml.org/) file format. Simply put, variables are written in the file as follows:

```

key: value

```

Any number of variables can be defined, in any order:

```

key_1: Value 1

key_2: Value 2

```

Variables can reference other variables by enclosing the key name within dollar symbols:

```

key: Value

key_1: $key$ 1

key_2: $key$ 2

```

Variables can use a nested structure to help group related information:

```

novel:

  title: Book Title

  author: Author Name

  isbn: 978-3-16-148410-0

```

Use a period to reference nested keys, such as:

```

novel:

  author: Author Name

copyright:

  owner: $novel.author$

```

Save the variable definitions in a file having an extension of `.yaml` or `.yml`.

# Document editing

The application's purpose is to completely separate the document's content from its presentation. To achieve this, documents are composed using a [plain text](http://spec.commonmark.org/0.28/) format.

## Create document

Start a new document as follows:

1. Start the application.

1. Click **File → New** to create an empty document to edit.

1. Click **File → Open** to open a variable definition file.

1. Change **Source Files** to **Definition Files** to list definition files.

1. Browse to and select a file saved with a `.yaml` or `.yml` extension.

1. Click **Open**.

The variable definitions appear in the variable definition pane under the heading of **Definitions**.

## Edit document

Edit the document as normal. Notice how the preview pane updates as new content is added. The toolbar shows various icons that perform different formatting operations. Try them to see how they appear in the preview pane. Other operations not shown on the toolbar include:

* Struck text (enclose the words within `~~` and `~~`)

* Horizontal rule (use `---` on an otherwise empty line).

The preview pane shows one way to interpret and format the document, but many other presentations are possible.

## Insert variable

Let's assume that the variable definitions loaded into the application include:

```

novel:

  title: Diary of $novel.author$

  author: Anne Frank

```

To reference a variable, type in the key name enclosed within dollar symbols, such as:

```

The novel "$novel.title$" is one of the most widely read books in the world.

```

The preview pane shows:

> The novel "Diary of Anne Frank" is one of the most widely read books in the world.

As it is laborious to type in variable names, it is possible to inject the variable name using autocomplete. Accomplish this as follows:

1. Create a new file.

1. Type in a partial variable value, such as **Dia**.

1. Press `Ctrl+Space` (hold down the `Control` key and tap the spacebar).

The editor shows:

```

$novel.title$

```

The preview pane shows:

```

Diary of Anne Frank

```

The variable name is inserted into the document and the preview pane shows the variable's value.

# Introduction

This document describes how to use the [R](https://www.r-project.org/)

programming language from within the application. The application uses an

interpreter known as [Renjin](https://www.renjin.org/) to integrate with R.

# Hello world

Complete the following steps to see R in action:

1. Start the application.

1. Click **File → New** to create a new file.

1. Click **File → Save As**.

1. Set **Name** to: `addition.Rmd`

1. Click **Save**.

Setting the file name extension tells the application what processor to

use when transforming the contents for display in the preview pane. Continue

by typing in the following text, including the backticks:

```r

`r#1 + 1`

```

The preview pane shows the result of `1` plus `1`:

```

2.0

```

# Bootstrap script

Being able to run R code while editing an R Markdown document is convenient.

Having the ability to call functions is where the power of R can be

leveraged.

Complete the following steps to call an R function from your own library:

1. Click **File → New** to create a new file.

1. Click **File → Save As**.

1. Browse to your home directory.

1. Set **Name** to: `library.R`.

1. Click **Save**.

1. Set the contents to:

    ``` r

    sum <- function( a, b ) {

      a + b

    }

    ```

1. Click the **Save** icon.

1. Click **R → Script**.

1. Set the **R Startup Script** contents to:

    ``` r

    source( 'library.R' );

    ```

1. Click **OK**.

1. Create a new file.

1. Set the contents to:

    ``` r

    `r#sum( 5, 5 )`

    ```

1. Save the file as `sum.R`.

The preview panel shows the result of calling the `sum` function:

```

10.0

```

This shows how the bootstrap script can load `library.R`, which defines

a `sum` function that is called by name in the Markdown document.

# Working directory

R files may be sourced from any directory, not just the user's home

directory. Accomplish this as follows:

1. Click **R → Directory**.

1. Set **Directory** to a different directory.

1. Click **OK**.

1. Create the directory if it does not exist.

1. Move `library.R` into the directory.

1. Append a new function to `library.R` as follows:

    ``` r

    mul <- function( a, b ) {

      a * b

    }

    ```

1. Click **R → Script**.

1. Set the **R Startup Script** contents to:

    ``` r

    setwd( '$application.r.working.directory$' );

    source( 'library.R' );

    ```

1. Change `sum.Rmd` to:

    ``` r

    `r#mul( 5, 5 )`

    ```

1. Close the file `sum.Rmd`.

1. Confirm saving the file when prompted.

1. Re-open `sum.Rmd`.

The preview panel shows:

```

25.0

```

Calling `setwd` using `'$application.r.working.directory$'` changes the

working directory where the R engine searches for source files.

# YAML definitions

To see how variable definitions work in R, try the following:

1. Create a new file.

1. Change the contents to (use spaces not tabs):

    ``` yaml

    project:

      title: Project Title

      author: Author Name

    ```

1. Save the file as `definitions.yaml`.

1. Click **File → Open**.

1. Set **Source Files** to **Definition Files**.

1. Select `definitions.yaml`.

1. Click **Open**.

1. Open `sum.Rmd` if it is not already open.

1. Type: `je`

1. Press `Ctrl+Space`

The editor inserts the following text (matches `je` against Pro**je**ct):

``` r

`r#x( v$project$title )`

```

The preview panel shows:

```

r#x( 'Project Title' )

```

This is because the application inserts definition reference names based

on the type of file being edited. By default, the R engine does not have

a function named `x` defined.

Continue as follows:

1. Click **R → Script**.

1. Append the following:

    ``` r

    x <- function( s ) {

      tryCatch( {

        r = eval( parse( text = s ) )

        ifelse( is.atomic( r ), r, s );

      },

      warning = function( w ) { s },

      error = function( e ) { s } )

    }

    ```

1. Click **OK**.

1. Close and re-open `sum.Rmd`.

The preview panel shows:

```

25.0

Project Title

```

The `x` function attempts to evaluate the expression defined by the YAML

variable. This means that the YAML definitions can also include expressions

that R is capable of evaluating.

While the `x` function can be defined within the R Startup Script, it is

better practice to put it into its own library so that it can be reused

outside of the application.

# Introduction

The Scalable Vector Graphics (SVG) drawing software---[Batik](https://xmlgraphics.apache.org/batik/)---that's used by the application may be unable to read certain SVG files produced by [Inkscape](https://inkscape.org/). The result is that embedding the vector graphics files may trigger the following issues:

* Unable to create nested element

* Black blocks, no text displayed

* Black text instead of coloured

The remainder of this document explains these problems and how to fix them.

# Nested element

When referencing a vector graphic using Markdown, the status bar may show the following error:

> The current document is unable to create an element of the requested type (namespace: http://www.w3.org/2000/svg, name: flowRoot).

This error is due to a version mismatch of the `flowRoot` element that Inkscape creates.

## Fix

Resolve the issue by changing the SVG version number as follows:

1. Edit the vector graphics file using any text editor.

1. Find `version="1.1"` and change it to `version="1.2"`.

1. Save the file.

The SVG will now appear inside the application; however, the text may appear as black blocks.

# Black blocks

Depending on how text is added to a vector graphic in Inkscape, the text may be inserted within an element called a `flowRoot`. Although Batik recognizes `flowRoot` for SVG version 1.2, it cannot fully interpret the contents. Black blocks are drawn instead of the text, such as those depicted in the following figure:

![Missing text](images/blocked-text.png)

## Fix

Resolve the issue by "unflowing" all text elements as follows:

1. Start Inkscape.

1. Load the SVG file.

1. Select all the text elements.

1. Click **Text → Unflow**.

The text may change size and position; recreate the text without dragging using the text tool. After all the text areas have been recreated, continue as follows:

1. Click **Edit → XML Editor**.

1. Expand the **XML Editor** to see more elements.

1. Delete all elements named `svg:flowRoot`.

1. Save the file.

When the illustration is reloaded, the black blocks will have disappeared, but the text elements ignore any assigned colour.

# Black text

When an SVG `style` attribute contains a reference to `-inkscape-font-specification`, Batik ignores all values that follow said reference. This results in black text, such as:

![Black text](images/black-text.png)

## Fix

Resolve the issue of colourless text as follows:

1. Open the SVG file in a plain text editor.

1. Remove all references `-inkscape-font-specification:'<FONT>';`, including the trailing (or leading) semicolon.

1. Save the file.

When the illustration is reloaded, the colours will have reappeared, such as:

![Resolved text](images/resolved-text.png)

*.class

# -----------------------------------------------------------------------------

# Copyright 2020 White Magic Software, Ltd.

#

# Permission is hereby granted, free of charge, to any person obtaining a

# copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

#

# The above copyright notice and this permission notice shall be included

# in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# This script introduces the editor and its purpose.

# -----------------------------------------------------------------------------

import sys

if not "../editor.sikuli" in sys.path:

    sys.path.append( "../editor.sikuli" )

from editor import *

# ---------------------------------------------------------------

# Fresh start

# ---------------------------------------------------------------

rm( app_home + "/variables.yaml" )

rm( app_home + "/untitled.md" )

rm( home + "/.scrivenvar" )

# ---------------------------------------------------------------

# Wait for application to launch

# ---------------------------------------------------------------

openApp( "java -jar " + app_bin )

wait("1594187265140.png", 30)

# ---------------------------------------------------------------

# Introduction

# ---------------------------------------------------------------

set_typing_speed( 240 )

header( "What is this application?" )

typer( "Well, this application is a text editor that supports interpolated definitions, ")

typer( "a few different text formats, real-time preview, spell check ") 

typer( "as you tipe" ) 

wait( 0.5 )

recur( 3, backspace )

typer( "ype, and R statements." )

paragraph()

wait( 1 )

# ---------------------------------------------------------------

# Definition demo

# ---------------------------------------------------------------

header( "What are definitions?" )

typer( "Watch. " )

wait( .5 )

# Focus the definition editor.

click_create()

recur( 4, tab )

wait( .5 )

rename_definition( "application" )

insert()

rename_definition( "title" )

insert()

rename_definition( "Scrivenvar" )

# Set focus to the text editor.

tab()

typer( "The left-hand pane contains a nested, folder-like structure of names " )

typer( "and values that are called *definitions*. " )

wait( .5 )

typer( "Such definitions can simplify updating documents. " )

wait( 1 )

edit_find( "this application" )

typer( "$application.title$" )

edit_find_next()

typer( "$application.title$" )

type( Key.END, Key.CTRL )

typer( "The right-hand pane shows the result after having substituted definition " )

typer( "values into the document." )

wait( 2 )

paragraph()

header( "What is interpolation?" )

typer( "Definition values can reference definition names. " )

wait( .5 )

typer( "The definition names act as placeholders. Substituting placeholders with " )

typer( "their defined value is called *interpolation*. Let's see how it works." )

wait( 2 )

# -----------------------------------------------------------------------------

# Copyright 2020 White Magic Software, Ltd.

#

# Permission is hereby granted, free of charge, to any person obtaining a

# copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

#

# The above copyright notice and this permission notice shall be included

# in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# This script demonstrates how to use interpolated strings.

# -----------------------------------------------------------------------------

import sys

if not "../editor.sikuli" in sys.path:

    sys.path.append( "../editor.sikuli" )

from editor import *

# -----------------------------------------------------------------------------

# Open sample chapter.

# -----------------------------------------------------------------------------

file_open()

type( Key.UP, Key.ALT )

wait( 1 )

typer( Key.END )

wait( 1 )

enter()

wait( 0.5 )

enter()

wait( 1 )

# -----------------------------------------------------------------------------

# Open the corresponding definition file.

# -----------------------------------------------------------------------------

file_open()

recur( 2, down )

wait( 1 )

enter()

wait( 1 )

# -----------------------------------------------------------------------------

# Edit the sample document.

# -----------------------------------------------------------------------------

set_typing_speed( 80 )

type( Key.HOME, Key.CTRL )

recur( 2, down )

# Grey

recur( 3, skip_right )

autoinsert()

# 34

recur( 4, skip_right )

autoinsert()

# Central

recur( 10, skip_right )

autoinsert()

# London

skip_right()

autoinsert()

# Hatchery

skip_right()

autoinsert()

# and Conditioning

recur( 2, select_word_right )

delete()

# Centre

skip_right()

autoinsert()

set_typing_speed( 220 )

typer( " Let's interpolate those four definitions instead!" )

wait( 4 )

recur( 13, type, Key.BACKSPACE, Key.CTRL )

recur( 9, backspace )

set_typing_speed( 60 )

typer( "name$" )

wait( 2 )

# Collapse all definitions

tab()

recur( 8, typer, Key.LEFT )

# Expand to city

recur( 4, typer, Key.RIGHT )

# Jump to name

recur( 2, down )

recur( 2, typer, Key.RIGHT )

# Open the text field to show the full value

typer( Key.F2 )

# Traverse the text field

home()

recur( 16, type, Key.RIGHT, Key.CTRL )

esc()

restore_typing_speed()

tab()

type( Key.HOME, Key.CTRL )

edit_find( "Director" )

autoinsert()

edit_find_next()

autoinsert()

edit_find_next()

typer( Key.RIGHT )

recur( 2, delete )

autoinsert()

typer( "'s" )

edit_find( "Hatcheries" )

autoinsert()

# and Conditioning

recur( 2, select_word_right )

delete()

edit_find( "Central" )

autoinsert()

skip_right()

autoinsert()

typer( " How about a different city?" )

wait( 2 )

recur( 5, type, Key.BACKSPACE, Key.CTRL )

wait( 1 )

tab()

typer( Key.F2 )

typer( "Seattle" )

enter()

tab()

wait( 2 )

type( Key.END, Key.CTRL )

paragraph()

typer( "No?" )

paragraph()

tab()

typer( Key.F2 )

typer( "London" )

enter()

tab()

typer( "Organizing definitions is left to your ")

typer( "doub" )

wait( .25 )

autoinsert()

wait( 1 )

typer( " Good imagination." )

tab()

# Jump to "char" definition

home()

# Jump to "char.a.primary.name" definition

recur( 6, typer, Key.RIGHT )

# Jump to "char.a.primary.caste" definition

down()

typer( Key.RIGHT )

# Jump to root-level "caste" definition

recur( 7, down )

# Reselect "super"

recur( 5, typer, Key.RIGHT )

wait( 2 )

# Close the window, no save

type( "w", Key.CTRL )

wait( 0.5 )

tab()

wait( 0.5 )

typer( Key.SPACE )

wait( 1 )

# -----------------------------------------------------------------------------

# Copyright 2020 White Magic Software, Ltd.

#

# Permission is hereby granted, free of charge, to any person obtaining a

# copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

#

# The above copyright notice and this permission notice shall be included

# in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# This script introduces images and R.

# -----------------------------------------------------------------------------

import sys

if not "../editor.sikuli" in sys.path:

    sys.path.append( "../editor.sikuli" )

from editor import *

set_typing_speed( 80 )

file_open()

type( Key.UP, Key.ALT )

wait( 0.5 )

home()

wait( 0.25 )

enter()

wait( 1 )

end()

wait( 0.25 )

enter()

wait( 1 )

set_typing_speed( 200 )

paragraph()

header( "What text formats are supported?" )

typer( "Scr" )

autoinsert()

typer( " supports Markdown, R Markdown, XML, and R XML; however, the software " )

typer( "architecture enables it to easily add new formats. The following figure " )

typer( "depicts the overall architecture: " )

paragraph()

typer( "![](../writing/images/architecture)" )

paragraph()

typer( "Most text editors read a single format and convert it to one other format. " )

typer( "With a little more effort, text editors can support many input and output " )

typer( "formats. Scr" )

autoinsert()

typer( " goes one step further by introducing interpolated definitions." )

paragraph()

typer( "Kitten interlude:" )

paragraph()

typer( "![](https://i.imgur.com/jboueQH.jpg)" )

paragraph()

header( "What is R?" )

typer( "R is a programming language. You might have noticed a few potential grammar " )

typer( "problems with direct substitution. Rules for possessive forms, numbers, and " )

typer( "other linguistic exceptions can be addressed using R. Let's take a look!" )

# -----------------------------------------------------------------------------

# Copyright 2020 White Magic Software, Ltd.

#

# Permission is hereby granted, free of charge, to any person obtaining a

# copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

#

# The above copyright notice and this permission notice shall be included

# in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# This script demonstrates using R.

# -----------------------------------------------------------------------------

import sys

if not "../editor.sikuli" in sys.path:

    sys.path.append( "../editor.sikuli" )

from editor import *

# -----------------------------------------------------------------------------

# Open the demo text.

# -----------------------------------------------------------------------------

file_open()

type( Key.UP, Key.ALT )

wait( 0.5 )

end()

wait( 0.25 )

enter()

wait( 0.5 )

down()

wait( 0.25 )

enter()

wait( 1 )

# -----------------------------------------------------------------------------

# Demo bootstrapping

# -----------------------------------------------------------------------------

# Jump to the end.

type( Key.END, Key.CTRL )

paragraph()

type( "s", Key.CTRL + Key.ALT )

wait( 0.25 )

# -----------------------------------------------------------------------------

# Demo pluralization

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# Demo possessives (it, she, he, Ross)

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# Demo conversion, including ordinal numbers

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# Demo Chicago Manual of Style

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# Demo CSV file import

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# Copyright 2020 White Magic Software, Ltd.

#

# Permission is hereby granted, free of charge, to any person obtaining a

# copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

#

# The above copyright notice and this permission notice shall be included

# in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------

# This script contains helper functions used by the other scripts.

#

# Do not run this script.

# -----------------------------------------------------------------------------

from sikuli import *

import sys

import os

from os.path import expanduser

home = expanduser( "~" )

app_home = home + "/bin"

app_bin = app_home + "/scrivenvar.jar"

wpm_default_speed = 80

wpm_typing_speed = wpm_default_speed

# -----------------------------------------------------------------------------

# Try to delete the file pointed to by the path variable. If there is no such

# file, this will silently ignore the exception.

# -----------------------------------------------------------------------------

def rm( path ):

    try:

        os.remove( path )

    except:

        print "Ignored"

# -----------------------------------------------------------------------------

# Changes the current typing speed, where speed is given in words per minute.

# -----------------------------------------------------------------------------

def set_typing_speed( wpm ):

    global wpm_typing_speed

    wpm_typing_speed = wpm

def restore_typing_speed():

    set_typing_speed( wpm_default_speed )

# -----------------------------------------------------------------------------

# Creates a delay between keystrokes to emulate typing at a particular speed.

# -----------------------------------------------------------------------------

def random_wait():

    from time import sleep

    from random import uniform

    cpm = wpm_typing_speed * 5.1

    cps = cpm / 60.0

    ms_per_char = 1000.0 / cps

    ms_per_stroke = ms_per_char / 2.0

    noise = uniform( 0, ms_per_stroke / 2 )

    duration = (ms_per_stroke + noise ) / 1000

    sleep( duration )

# -----------------------------------------------------------------------------

# Repeats a function call, f, n times.

# -----------------------------------------------------------------------------

def recur( n, f, *args ):

    for i in range( n ):

        f(*args)

        random_wait()

# -----------------------------------------------------------------------------

# Emulate a typist who is typing in the given text.

# -----------------------------------------------------------------------------

def typer( text ):

    # ~25 is a reasonably realistic, fast typist.

    for c in text:

        type( c )

        random_wait()

# -----------------------------------------------------------------------------

# Injects a definition.

# -----------------------------------------------------------------------------

def autoinsert():

    type( Key.SPACE, Key.CTRL )

    random_wait()

# -----------------------------------------------------------------------------

# Types the TAB key.

# -----------------------------------------------------------------------------

def tab():

    typer( Key.TAB )

# -----------------------------------------------------------------------------

# Types the ENTER key.

# -----------------------------------------------------------------------------

def enter():

    typer( Key.ENTER )

# -----------------------------------------------------------------------------

# Types the ESC key.

# -----------------------------------------------------------------------------

def esc():

    typer( Key.ESC )

# -----------------------------------------------------------------------------

# Types the DOWN arrow key.

# -----------------------------------------------------------------------------

def down():

    typer( Key.DOWN )

# -----------------------------------------------------------------------------

# Types the HOME key.

# -----------------------------------------------------------------------------

def home():

    typer( Key.HOME )

# -----------------------------------------------------------------------------

# Types the END key.

# -----------------------------------------------------------------------------

def end():

    typer( Key.END )

# -----------------------------------------------------------------------------

# Types the BACKSPACE key.

# -----------------------------------------------------------------------------

def backspace():

    typer( Key.BACKSPACE )

# -----------------------------------------------------------------------------

# Types the INSERT key, often to insert a new definition.

# -----------------------------------------------------------------------------

def insert():

    typer( Key.INSERT )

# -----------------------------------------------------------------------------

# Types the DELETE key, often to remove selected text.

# -----------------------------------------------------------------------------

def delete():

    typer( Key.DELETE )

# -----------------------------------------------------------------------------

# Moves the cursor one word to the right.

# -----------------------------------------------------------------------------

def skip_right():

    type( Key.RIGHT, Key.CTRL )

    random_wait()

def select_word_right():

    type( Key.RIGHT, Key.CTRL + Key.SHIFT )

    random_wait()

# -----------------------------------------------------------------------------

# Types ENTER twice to begin a new paragraph.

# -----------------------------------------------------------------------------

def paragraph():

    recur( 2, enter )

    wait( 1.5 )

# -----------------------------------------------------------------------------

# Writes a heading to the document using the given text value as the content.

# -----------------------------------------------------------------------------

def header( text ):

    typer( "# " + text )

    paragraph()

# -----------------------------------------------------------------------------

# Clicks the "Create" button to add a new definition.

# -----------------------------------------------------------------------------

def click_create():

    click("1594187923258.png")

    wait( .5 )

# -----------------------------------------------------------------------------

# Changes the text for the actively selected definition.

# -----------------------------------------------------------------------------

def rename_definition( text ):

    typer( Key.F2 )

    typer( text )

    enter()

    wait( .5 )

# -----------------------------------------------------------------------------

# Searches for the given text within the document.

# -----------------------------------------------------------------------------

def edit_find( text ):

    type( "f", Key.CTRL )

    typer( text )

    enter()

    wait( .25 )

    esc()

    wait( .5 )

# -----------------------------------------------------------------------------

# Searches for the next occurrence of the previous search term.

# -----------------------------------------------------------------------------

def edit_find_next():

    typer( Key.F3 )

    wait( .5 )

# -----------------------------------------------------------------------------

# Opens a dialog for selecting a file.

# -----------------------------------------------------------------------------

def file_open():

    type( "o", Key.CTRL )

    wait( 1 )

    // Number of heading actions (H1 ... H3)

    final int HEADINGS = 3;

    final Action[] headings = new Action[ HEADINGS ];

    for( int i = 1; i <= HEADINGS; i++ ) {

      final String text = "Main.menu.insert.heading." + i;

      headings[ i - 1 ] = new ActionBuilder()