Skip to content

add <description> and <summary>#150

Merged
vagenas merged 1 commit into
mainfrom
add-description-and-summary
Jun 24, 2026
Merged

add <description> and <summary>#150
vagenas merged 1 commit into
mainfrom
add-description-and-summary

Conversation

@vagenas

@vagenas vagenas commented Jun 24, 2026

Copy link
Copy Markdown
Member
  • Added optional <description> and <summary> elements to the element head in the spec documentation.
  • Updated relevant sections in the XSD and Schematron to enforce the correct order of these elements.
  • Update test suite accordingly
  • Document diffences between <caption>, <description>, and <summary>
  • Fix minor typo in recommended token vocabulary

- Added optional `<description>` and `<summary>` elements to the element head in the spec documentation.
- Updated relevant sections in the XSD and Schematron to enforce the correct order of these elements.
- Update test suite accordingly
- Document diffences between `<caption>`, `<description>`, and `<summary>`
- Fix minor typo in recommended token vocabulary

Signed-off-by: Panos Vagenas <pva@zurich.ibm.com>
@vagenas

vagenas commented Jun 24, 2026

Copy link
Copy Markdown
Member Author

Mental model:

<caption> <description> <summary>
Provenance from the original document derived (VLM, human, pipeline) derived
Function labels the component accounts for the component distills the component
Question answered “What does the document call this?” “What is this / what does it show?” “What is the gist / takeaway?”
Typical source OCR / layout extraction VLM, annotator summarizer, indexer, RAG prep
Content raw text + semantic elements raw text only raw text only

Length can overlap across all three — the split is purpose, not brevity.

One-line definitions:

  • <caption> — document-emitted label associated with the component
  • <description> — derived literal account of the component’s content
  • <summary> — derived abstractive condensation of what the component conveys

@PeterStaar-IBM PeterStaar-IBM left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@dolfim-ibm dolfim-ibm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@vagenas vagenas merged commit d7bc0c7 into main Jun 24, 2026
10 checks passed
@vagenas vagenas deleted the add-description-and-summary branch June 24, 2026 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants