Using Variants

Create localized or adapted versions of curricula while maintaining connections to the parent.

Variants let you create adapted versions of a curriculumโ€”for different regions, languages, or audiencesโ€”while keeping a connection to the original. Changes in the parent can automatically flow to variants, making it easy to maintain multiple related curricula.

Before You Begin

You need:

  • Author or Admin role in your account
  • An existing base curriculum to create a variant from
  • Understanding of your customization needs (What will be different in the variant?)

What Are Variants?

A variant is a child curriculum based on a parent curriculum. It inherits all content from the parent but can be customized for specific needs.

Common use cases:
- Regional Editions: "California Edition" adds state-specific standards
- Language Versions: "Spanish Version" translates content
- Specialized Tracks: "Accelerated Track" modifies pacing and difficulty
- Pilot Programs: "District Pilot" tests modifications before rolling out to the base

Key benefits:
- Start with all parent content instantly (no copying)
- Receive parent updates automatically (for content you haven't customized)
- Maintain clear relationships between related curricula
- Make targeted changes without affecting the parent

Creating a Variant

Step 1: Navigate to the Parent Curriculum

  1. Go to Content โ†’ Curricula
  2. Click on the curriculum you want to create a variant from
  3. Ensure it's the curriculum you want as the parent (you cannot change this later)

Step 2: Start Variant Creation

  1. Click the Create Variant button in the curriculum header
  2. You'll see the "Create Curriculum Variant" form

Note: The Create Variant button only appears if:
- You have Author or Admin role
- The curriculum is not at maximum nesting depth (5 levels deep)

Step 3: Fill Out the Form

The variant creation form has four sections:

Parent Curriculum (Read-Only)

Shows which curriculum will be the parent. This cannot be changed.

Name (Required)

Enter a descriptive name that clearly indicates how this variant differs from the parent.

Best practices:
- Include the differentiator: "California Edition", "Spanish Version"
- Keep the base name for continuity: "Grade 5 Math - California Edition"
- Make it clear this is a variant

Examples:
- โœ… "Grade 5 Math - Texas Edition"
- โœ… "AP Biology - Spanish Language"
- โœ… "Algebra 1 - Accelerated Track"
- โŒ "Grade 5 Math Copy" (doesn't explain the difference)
- โŒ "Variant 2" (not descriptive)

Description (Optional)

Explain what's different about this variant and why it exists.

What to include:
- Purpose of the variant
- Key differences from the parent
- Intended audience
- Maintenance notes

Example:

Texas Edition aligned to TEKS standards. Includes state-specific
examples and assessment formats required for Texas adoption.
Maintained by Regional Content Team.

Structure Variant (Optional)

If your administrator has created structure variants, you can select one to use different node types or attributes while maintaining content compatibility.

Default: "Use same structure as parent"

When to use a structure variant:
- The parent uses a generic structure, but you need specialized node types
- Regional requirements demand different attributes
- Your administrator has created a compatible structure variant for your use case

Leave default if:
- You don't need different node types or attributes
- You're unsureโ€”you can always work with your base structure

Note: Structure variants must be compatible with the parent's structure. Only compatible options appear in the dropdown.

Standards Framework (Required)

Select the standards framework for this variant.

Default: Parent's framework (most common)

Options shown:
- Parent's framework
- Frameworks that can be crosswalked to the parent's framework

When to use a different framework:
- Regional variant needs state-specific standards (e.g., CA variant uses California standards)
- Your organization has crosswalk mappings between frameworks
- Standards alignment will differ by region

Important:
- โš ๏ธ This cannot be changed after creation
- Not all frameworks can be crosswalkedโ€”only compatible options appear
- If you need a framework not listed, it may not have crosswalk data configured

Step 4: Create the Variant

  1. Review your entries
  2. Click Create Variant
  3. On success, you're redirected to the new variant curriculum
  4. The variant starts with all content inherited from the parent

What happens:
- A new curriculum is created linked to the parent
- No content is copied (content is inherited virtually)
- All parent content appears in the variant tree
- All nodes start as "Inherited" (more on this below)

Understanding Inheritance

Every content node in a variant has an inheritance status that determines its relationship to the parent.

The Three Inheritance States

Status Badge Color What It Means Can Edit?
Inherited ๐Ÿ”— Blue Content comes from the parent, updates automatically No (must override first)
Overridden โœ๏ธ Amber/Orange You've customized this content, no longer updates from parent Yes
Added โž• Green Created directly in this variant, doesn't exist in parent Yes

Inherited Content

Default state for all content when you create a variant.

Characteristics:
- Displays content from the parent curriculum
- Updates automatically when the parent changes
- Read-only (cannot be edited directly)
- Shows blue "Inherited" badge in tree and content panel
- Tooltip shows "From: [Parent Curriculum Name]"

What you can do:
- View the content
- Navigate through the tree
- Click "View in [Parent]" to see the parent's version
- Create an override to customize it

What you cannot do:
- Edit attributes directly
- Delete the node
- Change its position (reorder/move)
- Submit it for review independently

Overridden Content

Created when you edit inherited content.

Characteristics:
- Stores your custom values separate from the parent
- No longer updates when the parent changes
- Fully editable like any other content
- Shows amber "Overridden" badge in tree and content panel
- Edit form shows parent curriculum name as reference

What you can do:
- Edit all attributes
- Save changes (affects only this variant)
- Submit for review and publish
- Revert to inherited at any time (discards your changes)

What you cannot do:
- Delete the source node in the parent (it still exists there)
- Change the node type
- Move it to a different parent (structure is inherited)

Added Content

Created when you add new nodes directly to the variant.

Characteristics:
- Only exists in this variant
- No connection to parent content
- Fully editable and deletable
- Shows green "Added" badge in tree and content panel

What you can do:
- Edit, delete, move, reorder
- Everything you can do with regular content
- This content won't appear in the parent or other variants

What you cannot do:
- Make it inherited (it was never in the parent)
- Share it with other variants automatically

Working with Inherited Content

Viewing Inherited Content

  1. Open your variant curriculum
  2. The content tree shows all nodes from the parent and this variant
  3. Each node shows its inheritance status with a colored badge
  4. Click any inherited node to view its content

Visual indicators:
- Blue badge = Inherited
- Amber badge = Overridden
- Green badge = Added
- No badge = Base curriculum (not a variant)

Creating an Override

To customize inherited content:

  1. Navigate to the inherited node in the tree
  2. Click the node to view it in the detail panel
  3. Click the Edit button
  4. A confirmation dialog appears

Confirmation dialog shows:
- Parent curriculum name
- Current inherited values
- Warning that overriding stops automatic updates
- Options: "Create Override and Edit" or "Cancel"

  1. Click Create Override and Edit
  2. The override is created
  3. You're taken to the edit form
  4. The badge changes from Blue (Inherited) to Amber (Overridden)

After override creation:
- Edit attributes normally
- Save changes
- Changes apply only to this variant
- Parent changes no longer affect this node

When to override:
- You need to customize content for your audience
- Regional requirements differ from the parent
- Translation or localization is needed
- You're confident you won't want future parent updates for this specific content

When NOT to override:
- Making temporary notes (use comments instead)
- Testing changes (test in the parent first)
- You want to keep receiving parent updates

Reverting an Override

To restore the parent's version and discard your customizations:

  1. Navigate to the overridden node
  2. Click the node to view it
  3. Click the Revert to Inherited button
  4. A confirmation dialog appears

Confirmation dialog shows:
- Parent curriculum name
- Your current override values (what you'll lose)
- Warning that this action discards your changes
- Options: "Revert to Inherited" or "Cancel"

  1. Click Revert to Inherited
  2. The override is deleted
  3. The node returns to inherited state
  4. The badge changes from Amber (Overridden) to Blue (Inherited)
  5. Edit button is disabled again

โš ๏ธ Important:
- This action cannot be undone
- All your customizations for this node are permanently lost
- The node will start receiving parent updates again

When to revert:
- You no longer need the customizations
- Parent updates are more important than your changes
- You made a mistake and want to start over
- The parent's content has improved and you want to use it

Adding New Content to a Variant

You can create content that only exists in the variant:

  1. Navigate to a parent node in the tree
  2. Click Add Child (or Add [Node Type] if only one type allowed)
  3. Fill in the attributes
  4. Click Save
  5. The new node shows a green "Added" badge

Added content:
- Only appears in this variant
- Does not affect the parent or sibling variants
- Can be edited, deleted, moved freely
- Cannot be "inherited" by other variants

Use cases:
- Region-specific supplemental lessons
- Pilot content not yet ready for the parent
- Temporary modifications for testing

Parent Change Notifications

When the parent curriculum is updated, you may see a notification banner at the top of your variant.

Understanding the Notification

Banner message:
"Parent curriculum updated. X inherited nodes may have changed."

What this means:
- The parent has new or updated content
- Inherited nodes in your variant automatically have the new content
- Overridden nodes are NOT affected (your customizations are preserved)
- You should review the changes to ensure your variant still makes sense

Reviewing Changes

  1. Click View Changes in the notification banner
  2. A list of affected inherited nodes appears
  3. Review each node to see what changed
  4. Decide if any overrides need updating

Your options:
- Do nothing: Inherited nodes already have the new content
- Update overrides: If your customizations conflict with parent changes, edit your overrides
- Revert overrides: If parent changes make your customizations obsolete, revert to inherited

Dismissing the Notification

  1. After reviewing changes, click the X or Dismiss button
  2. The notification is hidden
  3. It won't appear again until the parent changes again

Note: The notification persists across sessions until you dismiss it. This ensures you don't miss important parent updates.

Multi-Level Variants

Variants can have their own variants, creating a hierarchy up to 5 levels deep.

Variant Hierarchy Example

Base Curriculum
โ”œโ”€โ”€ California Edition (variant of Base)
โ”‚   โ”œโ”€โ”€ Los Angeles Pilot (variant of California)
โ”‚   โ”œโ”€โ”€ San Diego District (variant of California)
โ”‚   โ””โ”€โ”€ Sacramento Schools (variant of California)
โ”œโ”€โ”€ Texas Edition (variant of Base)
โ”‚   โ””โ”€โ”€ Houston ISD (variant of Texas)
โ””โ”€โ”€ Spanish Version (variant of Base)

How Inheritance Flows

In multi-level hierarchies, inheritance flows through the chain:

Example: Los Angeles Pilot
- Inherits from: California Edition
- California Edition inherits from: Base Curriculum
- Changes to Base โ†’ flow to California โ†’ flow to Los Angeles
- Unless overridden at any level

Override precedence:
1. If Los Angeles overrides content โ†’ Los Angeles version used
2. Else if California overrides content โ†’ California version used
3. Else Base Curriculum version used

Creating a Variant of a Variant

Process is the same as creating any variant:

  1. Open the variant you want to use as the parent
  2. Click Create Variant
  3. Fill out the form
  4. The new variant inherits from the selected parent

Important considerations:
- Maximum depth is 5 levels
- Each level adds complexityโ€”keep hierarchies shallow when possible
- Deep overrides (3+ levels) can be hard to track
- Consider if you really need multi-level or if side-by-side variants would be simpler

When to use multi-level variants:
- Regional โ†’ District โ†’ School customizations
- Language โ†’ Dialect variations
- Base โ†’ Advanced โ†’ Honors progressions

When NOT to use:
- Independent regional variants (make them siblings, not children)
- Temporary experiments (use Added content instead)

Structure Variants

Advanced feature that allows variants to use different node types or attributes while maintaining content compatibility.

What Are Structure Variants?

A structure variant is an alternative structure that inherits from a base structure but adds or modifies node types and attributes.

Example:
- Base Structure: Course โ†’ Unit โ†’ Lesson
- Structure Variant: Course โ†’ Unit โ†’ Lesson โ†’ Lab Activity (adds Lab Activity type)

When to Use Structure Variants

Use a structure variant when:
- Regional requirements need additional node types
- You need extra attributes not in the base structure
- Different assessment formats required
- Your administrator has created a compatible structure variant for your needs

Don't use when:
- Content differences only (use overrides instead)
- You're unsure (stick with base structure)
- No structure variant exists (ask admin to create one)

Selecting a Structure Variant

During variant creation:

  1. Look at the "Structure Variant" dropdown
  2. See options: "Use same structure as parent" + compatible structure variants
  3. Select a structure variant if needed
  4. Create the variant

After creation:
- Content nodes use the structure variant's node types and attributes
- Inheritance still works (content flows from parent)
- You can use new node types not in the parent

Note: Only compatible structure variants appear in the dropdown. Compatibility is determined by your administrator.

Standards Framework Considerations

Variants can use different standards frameworks through crosswalking.

Understanding Framework Compatibility

When creating a variant:
- Default: Same framework as parent
- Options: Frameworks that have crosswalk data to the parent's framework

Example:
- Parent uses "CCSS" (Common Core)
- Variant can use "CA" (California) if crosswalk exists
- System maps standards between frameworks automatically

When to Use a Different Framework

Use a different framework when:
- Regional variant needs state-specific standards
- District requirements differ from parent
- Your organization maintains crosswalk mappings

Stick with parent framework when:
- No crosswalk exists to your target framework
- Standards alignment is identical
- You're unsure about compatibility

Crosswalking Limitations

  • Only pre-configured crosswalks are available
  • Manual standard alignment may be needed for gaps
  • Contact your administrator to add crosswalk data

Best Practices

Keep Variants Focused

Each variant should have a clear, singular purpose:
- โœ… "California Edition" (regional)
- โœ… "Spanish Version" (language)
- โœ… "Accelerated Track" (pacing)
- โŒ "California Spanish Accelerated Edition" (too many purposes)

Why: Multiple purposes make maintenance difficult and compound inheritance complexity.

Document Differences

Use the description field to explain:
- What's different from the parent
- Why the variant exists
- Who maintains it
- Any special considerations

Example:

Texas Edition aligned to TEKS standards. Maintained by Southwest
Regional Team. Key differences: state-specific examples, assessment
formats, and supplemental TEKS-only lessons in Unit 4.

Override Sparingly

Before overriding, ask:
- Will I want future parent updates for this content?
- Is this change permanent or temporary?
- Could this be added content instead?

If yes to wanting updates: Consider adding supplemental content instead of overriding.

If permanent: Override is appropriate.

Review Parent Changes Regularly

Best practice:
- Check parent change notifications weekly
- Review affected nodes before dismissing
- Update overrides that conflict with parent changes
- Consider reverting overrides that are no longer needed

Why: Parent improvements can benefit your variant if you stay in sync.

Avoid Deep Hierarchies

Recommendation: Keep variant depth to 2-3 levels maximum.

Why:
- Inheritance chains become hard to track
- Override precedence gets confusing
- Maintenance complexity increases exponentially

Better approach:
- Use sibling variants instead of nested where possible
- Flatten hierarchies when you can

Use Meaningful Names

Variant names should indicate:
- The parent curriculum
- The key differentiator
- Version if applicable

Examples:
- โœ… "Grade 5 Math - CA Edition 2024"
- โœ… "AP Bio - Spanish (MX)"
- โœ… "Algebra 1 - Honors Track"
- โŒ "Copy of Grade 5 Math"
- โŒ "Test Variant"

Plan Inheritance Strategy

Before creating variants:
1. Identify what will definitely be customized (override candidates)
2. Identify what should always match parent (keep inherited)
3. Identify variant-specific content (added content)
4. Document the strategy in the variant description

Why: Clear strategy prevents unnecessary overrides and keeps variants manageable.

Common Questions

Can I change the parent after creation?

No. The parent relationship is permanent. If you need a different parent, create a new variant and manually recreate any customizations.

Can I convert a base curriculum to a variant?

No. A curriculum is either a base or variant from creation. To make it a variant, create a new variant and migrate content manually.

What happens if I delete the parent curriculum?

You cannot delete a curriculum that has variants. Delete all variants first, then delete the parent.

Can I merge changes from a variant back into the parent?

Not automatically. You must manually copy content from the variant to the parent if you want to incorporate variant changes.

How do I see all variants of a curriculum?

On the Curricula list page:
- Expand a curriculum row (click the โ–ธ icon)
- All direct child variants appear indented below
- Grandchild variants appear further indented

Can I create a variant of a published curriculum?

Yes. Publishing status doesn't affect variant creation. The variant inherits publish states for each node.

What happens to overrides when I delete a variant?

All overrides are deleted with the variant. Content in the parent curriculum is unaffected.

Can I move a node between parent and variant?

No. Nodes belong to one curriculum. Use override/revert or add new content instead.

How do I know which nodes are overridden?

Look for amber "Overridden" badges in the content tree and content panel. You can also filter by inheritance status (feature coming soon).

Can I override just one attribute?

Yes. Overrides are per-node, but you only need to change the attributes you want. Other attributes can match the parent.

What if my variant and parent have different structures?

If you used a structure variant, the variant may have different node types. Content inheritance still works, but new node types won't appear in the parent.

Troubleshooting

"Cannot create variant: maximum nesting depth reached"

The parent curriculum is already at depth 4 (maximum is 5 levels). You cannot create variants of depth-4 curricula. Consider creating a sibling variant instead of a child variant.

"You are not authorized to create variants"

You need Author or Admin role. Contact your account administrator for proper permissions.

Parent change notification won't dismiss

  • Ensure you clicked the Dismiss button
  • Check your internet connection
  • Try refreshing the page
  • If it persists, contact support

Overridden node still shows parent content

  • Ensure the override was created (check for amber badge)
  • Refresh the page
  • Verify you saved your changes
  • If it persists, the override may not have been created properly

"Create Override" button doesn't appear

  • Ensure the node is inherited (blue badge)
  • Check that you have edit permissions
  • Verify you're in a variant curriculum
  • Overridden and added nodes don't show this button

Can't find the "Create Variant" button

  • Ensure you have Author or Admin role
  • Check that the parent curriculum isn't at maximum depth (5 levels)
  • Verify you're viewing a curriculum, not a structure
  • The button is in the curriculum header, not the list page

Changes not appearing in child variants

  • Ensure the child variant hasn't overridden those specific nodes
  • Check that you're looking at inherited nodes (blue badge)
  • Refresh the child variant page
  • Parent changes only flow to inherited nodes, not overridden ones

Next Steps

Now that you understand variants:

  1. Standards Alignment - Learn how to align content to standards frameworks
  2. Working with Content - Master content creation and editing
  3. Creating Curricula - Understand the full curriculum creation process

Related Documentation:
- Creating Curricula - Start a new curriculum
- Working with Content - Add and edit content nodes
- Author Overview - Your role and capabilities
- Standards Alignment - Align to standards frameworks

Was this page helpful? |