Description
Documents provide a professional word-processing environment for creating structured technical documentation, reports, and specifications within your model. They support rich text formatting, multiple block types, page layout controls, and automatic numbering—enabling everything from simple notes to complex multi-page reports with tables, figures, and cross-references. Documents use a paginated layout with configurable page dimensions, margins, headers, and footers. Content automatically flows across pages as you edit, and all formatting is preserved when exporting to PDF or DOCX formats.Documents are edited from the document view only
Block Types
Documents are composed of different block types, each serving a specific purpose in building structured content:Paragraph Blocks
Paragraph blocks contain standard body text and support all text formatting options including font styling (bold, italic, underline), color, size, and alignment. Paragraphs automatically wrap to fit the page width and split across pages when necessary.Heading Blocks
Heading blocks create document structure and hierarchy. Four heading levels are available (Heading 1 through Heading 4), each with configurable font sizes in the document styles. Headings can be automatically numbered based on the document’s numbering scheme and appear in the table of contents.List Blocks
Numbered Lists
Numbered lists create sequentially numbered items that automatically maintain their numbering as items are added or removed. Lists use the document’s numbering format (configurable as “1, 2, 3”, “I, II, III”, etc.) and support automatic continuation across pages.Bulleted Lists
Bulleted lists create items marked with bullet points. Like numbered lists, they automatically flow across pages and maintain consistent indentation.Table Blocks
Tables embedded in documents provide a simple grid structure for displaying data in rows and columns. Tables automatically split across pages when they exceed the available space, ensuring data remains visible across page boundaries.Table Cell Types
Document tables support two cell types: Text Cells: Contain plain or formatted text content. Text cells support standard formatting like bold, italic, and color. Reference Cells: Link to model objects using@ notation. Reference cells display key information about the linked object and open that object when clicked, useful for creating traceability matrices and navigable documentation.
Document tables are designed for data display, not calculation. For spreadsheet functionality with formulas and equations, use standalone Table objects.
Figure Blocks
Figure blocks contain images with optional captions. Figures are automatically numbered (Figure 1, Figure 2, etc.) and can be cross-referenced from text. When a figure with caption splits across pages, the system intelligently keeps the caption with the image.Image Blocks
Image blocks display images without the automatic numbering and caption functionality of figures. They’re useful for decorative images, logos, or illustrations that don’t need formal referencing.Caption Blocks
Caption blocks provide descriptive text for tables and figures. Captions support full text formatting and automatically display the appropriate “Table X:” or “Figure X:” prefix based on their association.Special Blocks
Table of Contents
The Table of Contents block automatically generates a navigable list of all headings in the document, complete with page numbers. The TOC updates automatically as content changes.Bibliography
Bibliography blocks collect and format all citations used throughout the document. Citations can be referenced from text using@ notation.
Math Blocks
Math blocks render mathematical equations using LaTeX notation. They support complex formulas, symbols, and expressions formatted for professional technical documentation.Page Break
Page break blocks force content following them to begin on a new page, useful for starting sections on fresh pages or controlling document flow.Model Object References
Documents support inline references to model objects using@ notation, enabling dynamic links between your documentation and the underlying model data. These references automatically update when the referenced objects change, ensuring your documents always reflect the current state of your model.
Creating References
To insert a reference to a model object:- Type
@in any text block (paragraph, heading, list item, etc.) - A dropdown appears showing available objects in your model
- Start typing to filter the list by object name
- Select the desired object from the dropdown
Reference Display Options
When you insert a reference, you can control what information is displayed by clicking the reference and selecting from the dropdown menu: Display Name: Shows the object’s name as a clickable link (default)mass, cost, status, or any custom attributes you’ve defined.
References appear with distinct styling to differentiate them from regular text. Clicking a reference opens the referenced object.
Dynamic Updates
References update automatically when the underlying model changes:- Name changes: If an object is renamed, all references to it update instantly throughout the document
- Value changes: When displaying attribute values, the document shows the current value. If the attribute is recalculated or edited, the document updates automatically
- Object deletion: If a referenced object is deleted, the reference converts to plain text to preserve document readability
Text Formatting
The document editor provides comprehensive text formatting controls similar to professional word processors.Font Styling
Bold, Italic, and Underline
Apply standard text decorations to emphasize content. These can be combined (e.g., bold italic text). Keyboard shortcuts:- Bold:
Ctrl/Cmd + B - Italic:
Ctrl/Cmd + I - Underline:
Ctrl/Cmd + U
Font Size
Adjust text size for selected content. While document styles define default sizes for each block type, you can override sizes for specific text selections.Font Color
Apply custom colors to text selections. The color picker provides access to the full color palette.Text formatting is applied to the current selection. If no text is selected, the formatting becomes active and applies to subsequently typed text.
Text Alignment
Four alignment options control how text aligns within its block:- Left Align: Text aligns to the left margin (default for most content)
- Center Align: Text centers between margins
- Right Align: Text aligns to the right margin
- Justify: Text stretches to align with both left and right margins
Block Transformations
You can convert blocks between different types using transformation buttons:- Transform to Paragraph: Convert headings or lists to standard paragraphs
- Transform to Heading: Convert paragraphs to heading blocks (prompts for level)
- Transform to Numbered List: Convert paragraphs or other lists to numbered items
- Transform to Bulleted List: Convert paragraphs or other lists to bulleted items
Transforming blocks preserves the text content and inline formatting while changing the block’s structural type.
Page Layout
Documents provide fine-grained control over page dimensions and layout.Page Dimensions
Configure page size through the Page Setup dialog:- Height: Page height in inches (default: 11 in)
- Width: Page width in inches (default: 8.5 in)
Page Margins
Control whitespace around page edges:- Top Margin: Space between page top and content
- Bottom Margin: Space between content and page bottom
- Side Margins: Space on left and right edges
Headers and Footers
Documents support headers and footers that repeat on each page. These regions can contain:- Static text and formatting
- Page numbers (current and total)
- Document title or section information
- Logos or other branding elements
Headers and footers are configured separately from the main body content and automatically appear on each page.
Document Styles
The Styles panel configures document-wide defaults for fonts, spacing, and numbering, ensuring consistent formatting throughout the document.Font Sizes
Set default font sizes for each block type:- Heading 1: Typically 18-24 pt
- Heading 2: Typically 16-20 pt
- Heading 3: Typically 14-18 pt
- Heading 4: Typically 12-16 pt
- Paragraph: Typically 10-12 pt
- Caption: Typically 9-11 pt
- Table: Font size for table cell content
Font Family
Choose between available font families:- Helvetica: Clean sans-serif font (default)
- Times New Roman: Traditional serif font for formal documents
Spacing Settings
Control vertical spacing and line height:Paragraph Spacing
- Paragraph Before: Space added before each paragraph (in points)
- Paragraph After: Space added after each paragraph (in points)
Line Height
Line height multiplier controls spacing between lines within paragraphs. Values typically range from 1.0 (single-spaced) to 2.0 (double-spaced).Indent Size
The indent size (in points) controls how far list items and nested content indent from the margin.Numbering Schemes
Select the numbering format for automatic heading numbering:- 1, 2, 3: Arabic numerals (default)
- I, II, III: Roman numerals
- A, B, C: Letters
- Other custom formats as configured
After changing document styles, click “Apply Changes” to update the document. This triggers a complete re-render with the new settings.
Document Information
Word Count
The document info button (ⓘ icon) displays the total word count across all body content, excluding headers and footers. Word counts update dynamically as you edit.Page Count
The page count indicator shows:- Current Page: The page currently visible in the viewport
- Total Pages: Total number of pages in the document
Zoom Control
Zoom in and out to adjust the document view:- Zoom Range: 10% to 300%
- Zoom Controls: Use + and - buttons or the percentage display
- Keyboard Shortcut:
Ctrl/Cmd + Mouse Wheel
Zoom level is preserved per document, so each document remembers its viewing preference.
Insert Options
The Insert menu provides access to all insertable block types:Content Blocks
- Table: Insert a new embedded spreadsheet table
- Table Caption: Add or update a table’s caption
- Image: Insert an image file
- Figure: Insert an image as a numbered figure
- Figure Caption: Add or update a figure’s caption
Structural Blocks
- Paragraph: Insert a new paragraph block
- Heading: Insert a new heading (prompts for level)
- Numbered List: Insert a numbered list item
- Bulleted List: Insert a bulleted list item
Special Blocks
- Bibliography: Insert a bibliography block that collects all citations
- Table of Contents: Insert an auto-generated table of contents
- Math: Insert a LaTeX math equation block
- Page Break: Force a page break at the current location
Dynamic References
When editing a paragraph block, two special insertion options become available:- Page Number: Inserts
@PAGE_NUMBER, which displays the current page number - Total Page Number: Inserts
@TOTAL_PAGE_NUMBER, which displays the total page count
Cross-References and Numbering
Documents automatically maintain numbering for figures, tables, equations, and headings. This enables professional technical documentation with accurate cross-references.Automatic Numbering
The following elements receive automatic sequential numbering:- Figures: Figure 1, Figure 2, Figure 3…
- Tables: Table 1, Table 2, Table 3…
- Equations: Equation 1, Equation 2, Equation 3…
- Headings: Hierarchical numbering based on document numbering scheme (1.1, 1.2, 1.2.1…)
Table of Contents
The Table of Contents automatically indexes all heading blocks in the document, displaying their text and page numbers. Readers can click TOC entries to jump directly to sections. The TOC updates automatically when:- Headings are added, removed, or modified
- Content reflows and changes page numbers
- Heading hierarchy changes
Citations and Bibliography
Reference external sources using@ notation in text (e.g., @SmithStudy2023). All cited references automatically appear in the Bibliography block, which formats them according to the configured citation style.
Exporting Documents
Documents can be exported to multiple formats for sharing and publication.Export to DOCX
Export to Microsoft Word format (.docx) preserves:- All text content and formatting (bold, italic, underline, color, size)
- Block structure (headings, paragraphs, lists)
- Tables with data and formulas converted to values
- Images and figures
- Page layout and margins
- Click the export button in the document toolbar
- Select “DOCX” from the format dropdown
- Click “Download” to generate and save the file
DOCX export converts dynamic elements like equations and formulas to their evaluated values, as Word doesn’t support the same formula syntax.
Export to PDF
Export to PDF format (.pdf) creates a pixel-perfect representation of the document as it appears on screen:- Page layout is preserved exactly
- All fonts, colors, and formatting are embedded
- Headers and footers appear on each page
- Page numbers, table of contents, and cross-references are functional
- Tables, figures, and images render at high quality
- Click the export button in the document toolbar
- Select “PDF” from the format dropdown
- Click “Download” to generate and save the file
Importing Content
Documents support importing content from external sources:From Word Documents
Drag and drop .docx files into your workspace to import them as Davinci documents. The import process converts:- Paragraphs and headings to corresponding Davinci blocks
- Bold, italic, and underline formatting
- Basic text colors
- Lists (numbered and bulleted)
- Embedded tables become Davinci table blocks
Complex Word formatting like styles, themes, and advanced layout features may not transfer perfectly. Review imported documents for formatting consistency.
From Plain Text
Plain text (.txt) files import as a series of paragraph blocks, with line breaks preserved as block boundaries.Navigation
The document navigator (left sidebar) provides a hierarchical view of the document structure based on headings. Click any heading in the navigator to jump directly to that section. The navigator:- Updates automatically as headings change
- Shows the heading hierarchy with visual indentation
- Highlights the current section based on scroll position
- Collapses and expands to show or hide subsections
Toggle the navigator visibility using the collapse/expand button if you need more horizontal space for editing.
View Types
| View | Description |
|---|---|
| Document | WYSIWYG editor for document content. |
| Properties | Edit the object’s properties, attributes, and metadata. |
| Relationships | Explore the network of connections to other objects. |
Properties Fields
Title of the document which also the displayed name of the object.
Short name of the object.
Description of the object.
A list of all Table objects owned by this document.Tables can be viewed and deleted.Read more about TablesA list of all Relationships this object has with other model objects.Read more about Relationships