Field Configuration Tips

Understanding when and how to use Static and Required properties is crucial for creating flexible, robust templates. These tips will help you make the right decisions.

1. Be Conservative with Required

Only mark fields as Required when the slide truly cannot function without that data. This gives API consumers flexibility and prevents unnecessary errors.

Good: product_name (Required) - Can't show a product without a name
Bad:  decorative_subtitle (Required) - Slide still works without it

Questions to Ask

Before marking a field as Required, ask:

• Would the slide be meaningless without this value?
• Is there a sensible default that could work instead?
• Will API consumers always have this data available?

If you answered "no" to any of these, consider making the field optional with a good default value.

2. Use Static for Consistency

Mark anything that represents your brand or should never vary as Static:

Good Static Fields:

• Company logo
• Copyright text
• Contact information that appears on all slides
• Fixed labels like "Contact Us", "Our Team"
• Decorative background shapes
• Chart configurations that don't need dynamic data

Bad Static Fields (these should be dynamic):

• Prices (these change with sales, regions, etc.)
• Dates (always dynamic)
• User-specific or customer-specific content
• Any content that varies between presentations

Static Protects Your Brand

Using Static for brand elements ensures:

• Consistent branding across all generated presentations
• API consumers can't accidentally override your logo
• Legal text remains intact

3. Document Your Choices

When designing templates, maintain a simple reference table for your team:

This documentation:

• Speeds up API integration
• Prevents misconfiguration
• Helps new team members understand the template