This information discusses the raw JSON files, but most of this can now be done in the template editor. Nevertheless, most of this information still remains relevant, as it is the same information that you enter, whether you’re entering it in the editor or directly into the JSON file. You just no longer need to remember the exact syntax and names for every key in a widget.
Key Components
Heading Data
- Sheet Headers - All the stuff at the top of the sheet that defines the template name, etc. (Documentation coming soon)
Upgrade Mapping
- Upgrade Mappings - Equations for converting old widgets and sharedTables into the current version, when a user upgrades their template
Presets
- Module Presets - A set of defaultValues which a user can select for a given template
Widgets
- Section Widget - The boxes with blue heading text
- Input Widget - Any plain text box you type into
- Equation Widget - Any plain calculated number
- Special “Members” Equation Widget - For exporting data to Member Schedule (Documentation coming soon)
- Lookup Widget - Drop-down menus with data set in the widget
- Lookup Shared Table - Drop-down menus referencing pre-written sharedTables
- Member Selector - Finding the best section with the member selector
- Table Widget - The big tables on sheets
- Remote Widget - Invisible to users, but essential widget for using a finite element analysis solver
- Diagram Widget - Creates various types of pretty diagrams
- Image Widget - Shows an image, possibly based on conditions
- Map Widget - Shows a Google Map at a given lat/lon
- Framing Widget - When data is imported via the framing tool, this shows a diagram of the current member within the building frame
In this section
Process
Template Development Workflow
Guidelines and best practices for efficient template development at Calcs.com
Pre-Template Development Work
Initial planning and setup tasks before diving into template development
Common Workflows
‘Typical use cases and examples for Calcs Builder templates’
Editor Sectional Work
Technical implementation of template sections requiring code knowledge and research
General Final Template Work
Final tasks to make templates functional, accurate, and ready for users
Publish Templates
How to publish templates to production after merging to master
Unbeta Workflow
Process for releasing beta templates to production through external review
Upgrade Mappings
How to handle template upgrades and data migration between versions
Test Linking When Developing a Calculator
How to create fake presets to test linking features in calculators without uploading to testing environment
Standards and Rules
Template Conventions
Standards and conventions for creating consistent Calcs.com templates
Template Features
Advanced features for Calcs.com templates including material changes, load combinations, and data linking
Template UX Rules and Functionality
Guidelines for template user experience, load combinations, material changes, and unit handling
Widget References & Standards API Routing
Structured references format and standards API integration for linking to relevant standards and codes
Maths and Special Templates
Background & Maths Processing
Understanding the mathematical engines and processing methods in Calcs.com
Toolbox for Hard Maths
A guide to solving complex mathematical problems in Calcs.com templates
Truss Wizard / Portal Frame Wizard
Advanced wizard templates for structural frame generation and common troubleshooting
Notable Specific Templates
Information about challenging templates that require special understanding
Sample Projects
How sample projects work in Calcs.com and how to manage them
Tools and Setup
Set Up Eng Software
Setup instructions for engineering development environment
VS Code: A Practical Guide
A comprehensive guide to installing and using VS Code for developing Calcs.com templates
VS Code Workflow & Applications
Common VS Code workflows for Calcs.com development
Git Introduction
Understanding Git version control for Calcs.com development
Work with Git
Practical Git workflows for Calcs.com development
GitHub to Calcs Builder Workflow for Diagrams
Step-by-step guide for developing, building, and deploying custom diagrams from GitHub repositories