Repository navigation
Document dynamic ALDocumentBundle elements - #642
Draft
nonprofittechy wants to merge 4 commits into
Draft
nonprofittechy wants to merge 4 commits into
nonprofittechy wants to merge 4 commits into
Conversation
- Distinguish between fixed bundles with conditional on/off inclusion via 'enabled' vs. dynamic bundles whose document membership is contingent on runtime lists. - Document Option 1: building the bundle dynamically in a code block with list comprehensions. - Document Option 2: declaring the bundle in an objects block and populating elements at runtime using reset_gathered() following PR #1015 in docassemble-AssemblyLine. - Add guidance on refreshing bundle contents on review screens. - Add Weaver documentation tip linking to the dynamic bundle guide. Fixes #349
nonprofittechy
marked this pull request as draft
October 13, 2026 16:47
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #349.
Cross-references AssemblyLine PR SuffolkLITLab/docassemble-AssemblyLine#1120.
Summary
Documents how to handle dynamic document bundles (where the list of documents is determined dynamically at runtime, e.g. per-child or per-job), distinguishing between the finite toggleable list (using
enabled) and dynamic runtime lists.Provides two clean options for dynamic bundles, both of which support lazy gathering without requiring imperative assignment in the mandatory interview order block:
codeblock.objectsblock withgathered=Noneand definingelementsandgathered = Truein a companioncodeblock.Also documents handling changes on review screens via
reconsider: True(Option 1) oral_court_bundle.reset_gathered()(Option 2), and adds a cross-reference tip in the Weaver document bundles authoring page.Verification
npm run buildsucceeds cleanly with 0 broken links.