SavvySense™

Overview

SavvySense™ is a powerful calculation and design tool that combines a customized markdown code editor with a real-time, paginated document preview.

Prerequisites: You must be logged into your account to use SavvySense™.

Interface Layout

The layout primarily features a dual-pane view:

• Code Editor — A specialized text editor where you write your calculations and document structure.
• Live Preview — A real-time rendering of your document, paginated and formatted for print.

Getting Started

Step 1 — Initialize the Editor

When you first load the page, the editor automatically populates with an example snippet to help you get started.

Step 2 — Toggle Views

You can collapse or expand the live document preview at any time by clicking the Show Preview or Hide Preview button located on the far right of the top toolbar.

Using the Code Editor

The SavvySense™ code editor is built to help you write structured calculations quickly and cleanly.

Navigating the Toolbar

The top menu bar provides quick access to file management, editing tools, and content insertion:

File Menu

Edit Menu

Access standard editing functions like Undo, Redo, Cut Line, Copy Line, Paste Line, Find / Replace, and a Toggle Comment shortcut. Note that editor comments will appear italicized in the code view and can be quickly toggled on or off.

Insert Menu

Quickly insert pre-configured code right at your cursor:

• Symbol: Insert mathematical or engineering symbols.
• Diagram: Select from a library of diagram snippets.
• Snippet: Drop in standard formatting or calculation templates.

Live Preview and Formatting

The Live Preview pane interprets your code into a polished, print-ready document.

Document Pagination & Title Blocks

• Live Pagination: The tool continuously calculates the height of your content. Once a section exceeds the physical limits of a page, it automatically splits the content onto a new sheet.
• Title Blocks: Every generated page automatically features a standard title block displaying the Project name, Job Reference, Section, Sheet Number (e.g., "1 of 3"), "Calc By" author, "Checked By" author, and respective dates.

Styling & Results

• Standard Formatting: The preview transforms your markup into stylized headings (H1 through H6), standard lists (bulleted and numbered), and tables. Headings H1 through H5 are stylized in the brand's signature blue, while H6 acts as a muted, italicized sub-note.
• Calculation Inputs: Calculation inputs are dynamically styled in a blue color to stand out from standard text.
• Calculation Results: Calculation outputs are dynamically styled in a bold black color to stand out from standard text.

Understanding SavvySense™ Syntax

SavvySense™ utilizes an extended Markdown syntax that is specifically optimized for engineering calculation sheets and professional document formatting.

Calculation Blocks & Math Alignment

• Tabular Alignment: The Live Preview supports specialized CSS grid layouts for mathematics. Calculation lines can be formatted into two-column (tab-2) or three-column (tab-3) structures to neatly align variables, formulas, and answers.
• Results & Notes: Recognized calculation outputs render bolded, and the calc-note slot generates clean, right-aligned annotations alongside equations.

Advanced Image Handling

By applying specialized classes to your image links, you can control exactly how they behave on the page:

Code Snippet Examples

1. Calculation Layouts (Tab-2 and Tab-3)

To neatly align your variables, formulas, and annotations, wrap your text in a [style: ...] block. The engine automatically parses plain text lines formatted as Description: Equation = Result (Note) into the appropriate columns.

1## Beam Properties
2[style: input tab-3]
3Length:                     L = 4 ft                       (see elec. dwgs.)
4Manufacturer:               manf = Unistrut
5Max. Beam Loading:          P_1 = 850 lbs
6Self-Weight:                w_self = 1.91 plf
7[endstyle]

2. Highlighting Results

To make a final result stand out with the bold, brand-specific styling, apply the result class to your style block. For inline math evaluation and outputting variables, use curly braces like {?:0}. You can also use HTML comments to execute hidden math logic.

1### Check Threaded Rod in Tension
2[style: result tab-3]
3Demand / Capacity:          DC = T_u / T_n = ?
4<!-- check_1 = if(DC <= 1, 'OKAY', 'NO GOOD') -->
5Check:                      {check_1 = ?}
6[endstyle]

3. Advanced Image Anchoring

Instead of HTML image tags, wrap the standard Markdown image syntax (![alt](url)) inside a [style: ...] block containing your anchoring classes. You can also specify the exact width and height using a pipe (|) inside the alt-text brackets.

For example, to float a diagram to the right side of the page:

1[style: anchor-floating align-right]
2![Point Load Simple Beam Diagram|width=357|height=207](/beam-diagrams/simple-beam-point-load-light.svg)
3[endstyle]

4. Title Blocks and Page Breaks

To populate the document's standard title block, use a standard YAML frontmatter block at the top of your document (or anywhere you want to update it) surrounded by ---. To manually split your document onto a new sheet, simply type [pagebreak] or insert another YAML block.

1---
2project:        Office Building
3job_ref:        123456
4section:        Cable Tray Support Design
5sheet:          1
6calc_author:    XYZ
7---
8
9Content for page one goes here...
10
11[pagebreak]
12
13Content for page two goes here...
14
15---
16sheet:          3
17---
18
19Content for page three goes here...

Here are some typical math utility snippets you can add to your guide, showcasing the built-in Math.js capabilities and custom logic functions available in SavvySense.

5. Using Math Functions and Logic

SavvySense™ natively supports a wide array of mathematical functions, statistical tools, and logical operators behind the scenes. You can use these functions anywhere within your calculation blocks or hidden comments.

Basic Arithmetic & Statistical Functions You can easily find the maximum, minimum, or average of a set of variables, or apply standard geometry functions like square roots and powers.

1### Geometry & Statistics
2[style: tab-3]
3Width:                  b = 10 in
4Depth:                  d = 12 in
5Area:                   A = b * d = ? in^2
6Section Modulus:        S = (b * d^2) / 6 = ? in^3
7
8Radius:                 r = 5 in
9Area of Circle:         A_circle = pi * r^2 = {?:2} in^2
10
11Max Dimension:          max_dim = max(b, d, r) = ? in
12Average Dimension:      avg_dim = mean(b, d, r) = {?:1} in
13[endstyle]

Trigonometry The engine supports standard trigonometric functions (like sin, cos, tan, asin, etc.). Note: Math.js evaluates trigonometric functions in radians by default, so be sure to declare your units!

1### Trigonometry
2[style: tab-3]
3Roof Angle:             theta = 30 deg
4Slope Length:           L_slope = 15 ft
5Horizontal Run:         L_run = L_slope * cos(theta) = {?:2} ft
6Vertical Rise:          L_rise = L_slope * sin(theta) = {?:2} ft
7[endstyle]

Conditional Logic (The if statement) SavvySense™ includes a custom if(condition, trueVal, falseVal) function. This is incredibly useful for generating dynamic "OK / NO GOOD" text checks or applying conditional formulas based on previous results.

1### Dynamic Checks and Logic
2[style: tab-3]
3Applied Load:           P_u = 12 kips
4Capacity:               P_n = 15 kips
5Demand/Capacity Ratio:  DC = P_u / P_n = {?:3}
6
7<!-- 
8  Use a hidden comment to run logic without displaying the formula 
9  status = if(DC <= 1.0, 'Pass', 'Fail')
10  load_factor = if(P_u > 10 kips, 1.6, 1.4)
11-->
12
13Check Status:           {status = ?}
14Required Factor:        {load_factor = ?}
15[endstyle]

Forced Unit Conversions SavvySense™ automatically tracks dimensions (like length or force). If you want an answer displayed in a specific unit rather than the base unit, just type your desired unit at the end of the line.

1### Unit Conversions
2[style: tab-3]
3Span in feet:           L_ft = 12 ft
4Convert to inches:      L_in = L_ft = ? in
5Convert to meters:      L_m = L_ft = {?:3} m
6
7Total Force:            F_total = 5000 lbs
8Force in Kips:          F_kips = F_total = {?:1} kip
9[endstyle]

For additional support, please contact us.