Quick Tutorial, Part 1

Quick Start Tutorial, Part 1

This tutorial for beginning the use of whirlDOC demonstrates the capabilities of the application by creating a simple document. It serves as a quick explanation of how to use the basic features. Concepts are covered briefly as needed. More thorough but longer explanations are given in the introductory tutorial. The advanced techniques chapter demonstrates how to handle more complex situations, and the rest of the manual details all aspects of whirlDOC.

Document Variations

The purpose of whirlDOC is to create source documents from which many variations can be generated. This is usually called document spinning. Variations should convey the same information and be grammatically correct but appear very different from one another. Differences at the word and phrase level are done with spintax, which is a standard technique for replacing words with a set of synonyms, one of which is randomly chosen when generating a document variation. Differences at a structural level are accomplished with sets of sentence and paragraph variants. Just like spintax, variants are chosen at random for a document variation.

The whirlDOC Document Editor

Below is a reduced size screenshot of the whirlDOC editor. The right side of the editor displays the document being edited. The spintax panel is at the upper left. It is used to display, create, and edit spintax. The lower left panels show element attributes but those are not modified in this simple tutorial. The buttons and features used by the tutorial are labeled.

whirlDOC Editor

The Tutorial’s Document

The tutorial will create a simple document using the first four lines of the "Old King Cole" nursery rhyme, which will be combined into a single paragraph. The lines are shown below.

Old King Cole was a merry old soul.
And a merry old soul was he.
He called for his pipe, and he called for his bowl.
And he called for his fiddlers three.

A three step process will be used to create the document. The original text will be entered first. Next sentence variants will be created. Finally, words and phrases will be turned into spintax. This three step process is the recommended process for creating whirlDOC documents. The following image depicts the document at the end of each step.

Roadmap for quick tutorial

The document is shown as it is displayed in the editor. It matches the structure of a whirlDOC document. Paragraph groups contain paragraph variants, paragraphs contain line groups, and line groups contain sentence variants. Spintax is blue and underlined. The diagram below shows this

Display of document elements

Write Initial Text

The document’s initial four sentences are written first. This is often done by importing a text or HTML file, but here the text is simply typed. Each sentence will be put into its own line group. Variants for the sentences will be added later to the line groups. When the document is spun, one line from each line group will be randomly selected and the selected lines combined into a paragraph.

The step-by-step procedures shown in this tutorial display the spintax panel on the left and the document on the right. Red arrows point out buttons used and changes made.

Steps to write initial text

Creating new line groups with the enter key is demonstrated. Hitting the enter key at the end of a line will create a new line in a line group. Pressing it again on the empty line creates a new line group. This can be continued to create new paragraphs and paragraph groups.

Create Sentence Variants

Sentence variants are created next. The ones made here are simple grammatical rearrangements. With some creativity, more and better variants can be created, especially if there is information that can be optionally added or removed. The goal is to have several versions for most sentences with each version conveying approximately the same meaning. One version is chosen when spinning the document.

Steps to create variants

Aside from using the enter key to create new lines, the "New Line" button can also be used. The button makes a new line below the one the cursor is on unless the cursor is at the start of a line, in which case the new line is created above. There are similar buttons to create new line groups, paragraphs, and paragraph groups.