Civiform: Replace Question Count With Repeated Set In Menu

In Civiform, a key update is being made to enhance the user experience within the Admin Program Block Edit page. This article delves into the specifics of this change, focusing on the replacement of the question count with more descriptive labels for enumerator blocks. This adjustment aims to provide a clearer understanding of the structure and organization of blocks, particularly those involving repeated sets and nested repeated sets.

Understanding the Issue: Question Count vs. Repeated Sets

Previously, the left menu in the Admin Program Block Edit page displayed a numerical question count for each block. While this provided a basic indication of the number of questions within a block, it lacked the specificity needed for enumerator blocks. Enumerator blocks, which deal with repeated sets of questions, require a more descriptive label to accurately reflect their function. Therefore, the decision was made to replace the question count with labels that directly indicate the presence of repeated sets or nested repeated sets. This change ensures that users can immediately identify and understand the nature of these blocks.

The Solution: "Repeated Set" and "Nested Repeated Set" Labels

The core of the solution involves replacing the numerical question count with the labels "Repeated set" or "Nested repeated set." This simple yet effective change significantly improves the clarity and usability of the Civiform interface. When an enumerator block is encountered, the menu will now display "Repeated set," indicating that the block contains a series of repeated questions. For more complex structures involving nested enumerators, the label "Nested repeated set" will be used. This distinction is crucial for differentiating between simple repeated sets and those that are part of a more intricate hierarchical structure. By providing these specific labels, users can quickly grasp the organization of the program and navigate to the relevant sections with ease.

Visualizing the Change: Figma Mockups

To better illustrate the impact of this change, Figma mockups have been created. These visual representations provide a clear picture of how the new labels will appear in the Civiform interface. The mockups highlight the improved clarity and organization, demonstrating how the "Repeated set" and "Nested repeated set" labels enhance the user experience. By referencing these mockups, developers and users alike can gain a concrete understanding of the intended design and functionality.

Figma Mockups provide a detailed visual representation of the change. The screenshot included in the issue description further exemplifies the updated interface, showcasing the replacement of the question count with the new labels.

Implementation Details and Additional Context

The implementation details for this change are outlined in a specific section of the Technical Design Document (TDD). This section provides a comprehensive guide for developers, detailing the steps required to implement the new labels. The TDD serves as a crucial resource, ensuring that the implementation aligns with the intended design and functionality. By following the guidelines in the TDD, developers can effectively update the Civiform interface to reflect the new labels for enumerator blocks.

TDD Implementation Details offer an in-depth look at the technical aspects of the update.

Ensuring Completion: Done Criteria

To ensure that this issue is fully resolved, specific criteria have been defined. The primary criterion is that enumerator blocks in the Admin Program Block Edit page must display "Repeated set" or "Nested repeated set" instead of the question count. This criterion serves as a clear and measurable goal, allowing developers to verify that the change has been implemented correctly. Once this criterion is met, the issue can be considered complete, and the updated interface will provide a more intuitive experience for Civiform users.

Done When:

• [x] Enumerator blocks show "Repeated set" or "Nested repeated set" rather than the question count.

Benefits of the Update

This seemingly small change carries significant benefits for Civiform users. By replacing the numerical question count with descriptive labels, the interface becomes more intuitive and user-friendly. Users can quickly identify and understand the structure of enumerator blocks, leading to a more efficient and less confusing experience. This is particularly beneficial for complex programs involving nested repeated sets, where the distinction between different types of blocks is crucial. The updated interface empowers users to navigate and manage their programs with greater ease and confidence.

Conclusion: Enhancing User Experience Through Clear Labeling

In conclusion, the replacement of the question count with "Repeated set" and "Nested repeated set" labels in the Civiform Admin Program Block Edit page represents a significant improvement in user experience. This change enhances clarity, reduces confusion, and empowers users to navigate complex programs with greater ease. By providing specific labels for enumerator blocks, Civiform ensures that users can quickly understand the structure of their programs and manage them effectively. This update underscores Civiform's commitment to providing a user-friendly and intuitive platform for program administration.

For more information on web accessibility best practices, visit the Web Accessibility Initiative (WAI) website.