Editor Interface, Right Side

Edit and Test Panes

The right side of the editor has two panes, one for text editing and another for test output. Only one is displayed at a time. Switching between the two is done with tabs at the top. The picture below shows a section of the right side. The text editing pane is displayed, and its tab is highlighted in blue. The tab to its right can be clicked to switch the display to the test pane.

Right side of spintax editor

The text editing pane’s tab indicates when a document has unsaved changes by placing an asterisk next to the document name. The example above has an unmodified document, so there is no asterisk.

The Editing Pane

Documents are displayed in the editing pane with a format matching the document structure. Paragraph groups are shown containing paragraphs that contain line groups that contain lines. Lines are made up of plain text and spintax segments. Usually spintax segments are shown underlined in blue. When a segment is clicked, its phrase set is loaded into the left side’s spintax panel where it can be edited. Left clicking marks in red all spintax segments that share the same phrase set. Right clicking marks only the spintax segment clicked. The above picture of the editor’s right side demonstrates marking with the "hill" spintax segments marked.

A full explanation of the whirlDOC document structure is given in the document chapter of the manual but the structure is simple and intuitive. The next diagram portrays the structure of a small document.

Document structure

The diagram depicts a paragraph group with two paragraphs, the first with two line groups and the second with one. All line groups have two lines. The image below shows how a document with the same structure is displayed in the text editing pane. The paragraph group, paragraphs, line groups, lines, and number of spintax segments match the diagram.

Document structure example

Child elements are indented below their parent, making it easier to see they belong to their parent. Brackets are also used on the left to enclose an element’s children. Lines have a small black square on their left, which makes wrapped lines easy to tell apart.

Document Elements

Document elements are indicated with the icons above. These icons are used throughout the whirlDOC application. For example, the buttons that create new elements, like the "New Line" button, use the same icons.

Element Icons and Select Mode

A document element’s select mode is indicated by the arrow used with its icon in the editing pane. This gives a visual cue for an element’s select mode so the element does not have to be clicked to examine the attribute panels. The arrows used are demonstrated below.

Icons change with select modes

Hiding Text by Folding

The editor allows document elements, like paragraphs and line groups, to be collapsed to a single line. This is often called folding and is done by clicking the icon at the upper left of an element. The mouse pointer will change to a hand when hovering over an an element’s icon. Clicking an unfolded element folds it and clicking a folded element unfolds it.

The picture below shows how folding works. A small document is shown completely unfolded at the upper left. A folded line group is shown at the upper right. The lower left shows a folded paragraph, and the lower right shows a folded paragraph group. Folded elements are shown in light yellow and are reduced to a single line. A folded element is represented by the text of its the first line. For example, a folded paragraph is represented by its first line group’s first line.

Folding document text

Folding is often useful for working with complex documents. With lots of variant sentences and paragraphs, documents may be large, unwieldy, and hard to read. Folding turns line groups into single lines, making them more readable. By folding paragraphs or paragraph groups that are not being worked on, most of a document can be reduced to single line representations of the hidden content.

Folding also protects sections of a document from being affected by many editor operations. For example, deleting spintax will normally convert all of a document’s spintax that uses the same phrase set to plain text. Spintax within folded elements is not converted. So folding offers a way to work with a small section of a document while protecting the rest of it from changes.

The Test Pane

The test pane is used to display example document variations so grammar can be checked and changes to attributes can be tested to see that they work as intended. Document testing is explained later. The test pane can also be used to copy a test variation to the system clipboard so it can be pasted into another application.