Help       Feedback       Q&A       Sign in with Facebook or Google or Microsoft
workbench for expert-guided collaborative authoring

TurboWriter Help System

Assignments, Documents, and Styles

You define TurboWriter playbooks and projects using the following concepts:

  • Assignments — Tasks to write and review content
  • Documents — Documents to be produced
  • Styles — Formatting information for documents
Each concept is described in more detail below.

Assignments

Assignments are the tasks to write and review content managed by TurboWriter's workflow engine.

When you define an assignment, you specify whether it is a single or repeating assignment:

  • Single assignment — Only one task is created for each single assignment. For example, a novel would typically have only one assignment named "Preface" and one assignment named "Epilogue".
  • Repeating assignment — You can create any number of instances of repeating assignments. For example, a novel might have a repeating assignment named "Chapter".
When you define an assignment, you provide the following information:

  • Name — A unique name for the assignment.
  • Description — A description of the assignment (can be blank).
  • Single or Repeating — Whether the assignment is single or repeating.
After you have created the assignment, you can define the assignment's structure by providing the following specifications:

  • Prerequisites — Assignments, if any, that must be completed before work is to begin on this assignment.
  • Content — Items of content to be written by this assignment.
  • Quality Checklist — Criteria that the quality of the assignment is to be judged by.
  • Guidance for Manager — Text that you want to appear on the page when the project manager is assigning this assignment to a team member.
  • Guidance for Writer — Text that you want to appear on the page when the assignment is being executed.

Documents

Documents are web pages to be produced by your project. The web pages can be viewed in your browser, saved to your computer, or printed. When printed, the document can be any number of printed pages.

A single project can be used to produce any number of documents, each containing different selections of the content created by your writers. You can include the same content in more than one document, and if you do so, you can use different styles (see below) for each occurrence of the content if you wish.

When you define a document, you provide the following information:

  • Name — A unique name for the document.
  • Description — A description of the document (can be blank).
  • Style — The name of the default style in which document text is to be produced (can be "none" to request TurboWriter's default style). You can override the document's default style for each item of content when you define the structure of the document.
After you have created the document, you can define the document's structure. For details, see Document Structure and Flow Control.
Styles

Styles are descriptions of how you want content to appear in a document. You give a name to each style, such as "Headers" or "Special Notes". Then you can use those names to specify a style for each document and for each item within a document.

When you define a style, you provide the following information:

  • Name — A unique name for the style.
  • Description — A description of the style (can be blank).
  • CSS — A definition of the style, expressed in Cascading Style Sheet (CSS) language.

Cascading Style Sheets (CSS) is the name of an extensive, industry-standard style sheet language used for defining web pages. You can learn about CSS and its many features by using online searches.

When you define a style for a playbook, you can specify any desired CSS properties. To do so, you can enter the CSS property manually, or you can click the shortcuts provided for common requirements.

You can select a style by name for an entire document when you define the document, and you can select a style by name for a particular content item when you define the document's structure. Some of the effects available in an editbox, such as color, are also accomplished with CSS.

When styles are defined at more than one level for the same content, the content is rendered using the most local definition. For example, content style defined using editbox controls takes precedence over content item style selected in document structure, and content item style selected in document structure takes precedence over selected document style.

Any style property you don't define uses a default setting, and any item with which you don't associate a style uses default settings for all its properties.