(en) Draft a Document

Description of the feature

Drafting a project document involves adapting it to the client's or project's context by choosing alternatives, filling in fields, and adding or removing content. This view also allows the document to be exported in Word or PDF format once drafting is complete.

Access to feature

A project document is accessible from Project Management, by clicking on its tile.

Description of the feature

1. The features menu

2. Heading

3. Drafting options

4. Table of contents

5. Display filters

6. Edit content window

The features menu

The features menu allows you to perform the following actions:

1. View document properties

2. View the history of modifications made to the document;

3. Compare Document Versions

4. Add content (sections, clauses, schedules) to the document;

5. Update content;

6. Comment on clauses, sections, and schedules,

7. 
   

8. Export the document.

Heading

The project document heading contains the following:

1. The project title and numbers

   1. The project name

2. Information about last time it was saved

3. The avatars of the users who have the document open.

Drafting options

Drafting options are as follows:

1. The toggle to display only editable content. By default, the active mode is All Content. If you enable Editable Content mode, only content that meets one of these criteria will be displayed:

   1. That has fields to complete

   2. That has options to select

   3. The relevance of which is optional (can be removed)

2. The progress bar for completed fields

3. The navigation arrows for fields to complete

4. The document status
   It is possible to change the document status from here

Table of contents

The table of contents displays the titles of the sections, clauses, and schedules included in the document.

1. Clause with a removed title,

2. Removed clause whose title is removed,

3. Selected clause whose title is removed,

4. Section at the first indentation level,

5. Section at the second indentation level (included under the previous section (4)),

6. Third-level clause, indented under the Terminology section, itself indented under the Interpretation section,

7. Table of schedules.

Hide and display the table of contents

To hide the table of content, click the X in the panel.

To display the table of contents, click the table of contents button next to the features menu.

Collapse and expand the table of contents

To collapse all the accordions in the table of contents and display only the top-level sections, click the double-chevron icon on the panel.

When everything is collapsed, click this same icon to expand everything with a single click.

Move content

Use drag-and-drop to move content within the table of contents

Steps

1. Hover over a title in the table of contents.

2. When the hand-shaped cursor appears, click, hold down the mouse button, and drag the content above the location where it should be placed.

3. Drop it in the desired area by releasing the mouse button.

For more information on the rules for using drag-n-drop in the table of contents, read the following article: Use drag-and-drop to move content within the table of contents

Display filters

The display filters area allows you to configure the display of:

1. Removed content — If this filter is enabled, you can see content that has been removed, indicated by the trash icon.

2. Impact of changes — If this filter is enabled, when you change an alternative choice and it affects other content due to rules, a window detailing the impacts is displayed:

Edit content window

Types of content

The drafting window displays all the sections, clauses, and schedules that make up the document.

Sections are identified by the colour purple and the label SECTION.

Clauses are identified by the colour green and the label CLAUSE.

Schedules are identified by the colour orange and the label SCHEDULE.

Elements present in a content block

The clause and schedule block is composed of the following elements:

1. The content title,

2. The quick access toolbar for content management tools,

3. The options (alternatives) proposed for this content,

4. The button to See all options,

5. The content of the selected clause (the one found in the document).

The quick access toolbar for content management tools

1. View annotations

2. Comment or view comments

3. Create a variant

4. Remove content

5. View rules

6. Relevance of the content,

7. Clause management context menu.

Context menu

The context menu offers additional content editing tools and also includes the tools from the quick access bar.

The additional tools offered in the context menu are:

1. Open in a new tab: allows you to open the published version of the clause in another tab.

2. Remove title of the content: allows you to remove the title and numbering. Note: The title will remain displayed on screen, but will not be visible once the document is exported.

3. Remove numbering of the content: allows you to remove the numbering, but not the title.

Remove content

Remove content from the document by clicking Remove (trash icon) in the quick access bar or in the context menu.

When the Show removed content filter is disabled, removed content is hidden.

A removed content will not be present in the document exported in Word or PDF format.

Add back content

Restore content to the document by clicking Add back (green trash icon with arrow).

Select an option (alternative)

Some clauses or schedules have several alternatives. These choices represent different options for the same content item.

1. Selected alternative;

2. Unselected alternatives.

Fill in fields in the document

Fields that have not yet been filled in the document are highlighted in yellow (1). Filled fields appear in normal state (2).

Fields Form

It is possible to review the fields in the fields form (accessible from the features menu). Learn more by reading this article: Fields Form.

Export the document in Word or PDF format

To learn more about this feature, see the following article:

Export a Document.