Multiple checkbox-results for the same checklist-item

[buwisar]

Hi,

I have a checklist with items like

.. checklist-item:: QUE-SWAD_CHECKLIST_A_1 General project relevant information are defined?
.. checklist-item:: QUE-SWAD_CHECKLIST_A_2 Context of the System is defined?

I put my review record to a file like 001_review_record.rst with the checklist results like

.. checkbox-result:: QUE-SWAD_CHECKLIST_A_1 yes
.. checkbox-result:: QUE-SWAD_CHECKLIST_A_2 no

.. item-attributes-matrix:: Questions and answers Iteration 1
    :filter: QUE-SWAD_CHECKLIST_A_
    :attributes: checked

Then I create another review record in 002_review_record.rst with the same checklist results like

.. checkbox-result:: QUE-SWAD_CHECKLIST_A_1 yes
.. checkbox-result:: QUE-SWAD_CHECKLIST_A_2 yes

.. item-attributes-matrix:: Questions and answers Iteration 2
    :filter: QUE-SWAD_CHECKLIST_A_
    :attributes: checked

Then in the rendered document I go to the page of 001_review_record and I see both results as 'yes'. It means the plugin always takes the latest checkbox-result value that it sees and puts it into all item matrices.
I would like the checkbox results to be local to the file where they are set, so that the item matrix rendered in 001_review_record shows 'yes', 'no' and the item matrix rendered in 002_review_record shows 'yes', 'yes'. Is this possible?

[buwisar]

OK, I have it sorted out.
The solution is to add custom processing of checkbox-result directives, so that they show up in the rendered doc.

In conf.py:

from docutils import nodes
from mlx.traceability.directives.checkbox_result_directive import (
    CheckboxResultDirective as BaseCheckboxResultDirective,
)

#...

class VisibleCheckboxResultDirective(BaseCheckboxResultDirective):
    """Custom-render checkbox-result directives"""

    def run(self):
        env = getattr(self.state.document.settings, 'env', None)
        super().run()
        question = self._resolve_question(env, self.arguments[0])
        answer = self.arguments[1].strip()
        normalized_answer = answer.lower()

        literal_block = nodes.literal_block('', '')
        literal_block['classes'] = ['checkbox-result-line']
        literal_block += nodes.Text(f"{question}: ")

        answer_node = nodes.inline('', answer.upper())
        answer_node['classes'] = ['checkbox-answer', f'checkbox-answer-{normalized_answer}']
        literal_block += answer_node

        return [literal_block]

    @staticmethod
    def _resolve_question(env, target_id):
        if env is None:
            return target_id

        item = getattr(env, 'traceability_collection', None)
        if item is None:
            return target_id

        checklist_item = env.traceability_collection.get_item(target_id)
        if checklist_item is None:
            return target_id

        for candidate in (getattr(checklist_item, 'caption', ''), getattr(checklist_item, 'name', '')):
            if candidate:
                return candidate

        return target_id

def _strip_checkbox_highlighting(_app, doctree, _docname):
    """Force checkbox result literal blocks to skip syntax highlighting wrappers."""

    for node in doctree.traverse(nodes.literal_block):
        if 'checkbox-result-line' in node.get('classes', []):
            node.rawsource = ''
            node['language'] = None


def setup(app):
    app.add_directive('checkbox-result', VisibleCheckboxResultDirective, override=True)
    app.connect('doctree-resolved', _strip_checkbox_highlighting)

And some custom CSS styles too

.checkbox-result-line {
  background: #fff;
  border: none;
  color: #000;
  font-family: sans-serif;
  font-size: 1em;
  line-height: 1;
  margin: 6px 0;
  padding: 0 0 4px 0;
  white-space: pre;
  border-bottom: 1px solid #1f6ad1;
}

.checkbox-answer {
  font-weight: 600;
}

.checkbox-answer-yes {
  color: #0c8a00;
}

.checkbox-answer-no {
  color: #c81d1d;
}

I put only one instance of the .. item-attributes-matrix:: to shot the most update-to-date results.
Now it works good enough for my purpose.