Skip to content

528 standalone sdpi editorial content update - #542

Draft
ToddCooper wants to merge 22 commits into
masterfrom
528-standalone-sdpi---editorial-content-update
Draft

528 standalone sdpi editorial content update#542
ToddCooper wants to merge 22 commits into
masterfrom
528-standalone-sdpi---editorial-content-update

Conversation

@ToddCooper

@ToddCooper ToddCooper commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

📑 Description

This PR provides an initial content separation between the SDPi Standard (standalone) and Supplement (to be integrated into the IHE DEV TF at some point). Though the changes are all editorial in nature, given the extensive label changes, they touch nearly every file in the project!

☑ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update (necessity checked and entry added or not added respectively)
    • Pull Request Assignee
    • Reviewer

Updated sdpi-supplement files to include a single file (all were previously commented out), to help reestablish a baseline branch.
Incorrect directory for include file.
"<<...>>" was not commented out.
After updating branch from master (locally) updated the changelog.
@ToddCooper

ToddCooper commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

@JavierEspina & @d-gregorczyk -- Today I started working on this ... for real!

Looking at the use of "supplement" in the files (e.g., with [#supplement_ ...], it looks like the usage is limited to only six files. So hopefully when I do the separation tomorrow, it is limited to just that and I can do the updates without mucking with too many files. Hopefully ... I did pull in the latest Master to this branch. So at least we are starting at the same baseline.

@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.10 SDPi Friday - @JavierEspina @d-gregorczyk

FWIW - Post history service and other updates to Master, this branch was successfully rebased to Master with only one change in the gitignore file.

… Lists

Initial triage of replacing references to "supplement" in all the sdpi-standard related files.
This was a gross, brute force change, before going through the editorial content pass.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.15 Update Notes:

  • Updated IntelliJ to 2026 1.4 ... it was having issues since my last use a few days ago!
  • Rebased branch with Master
  • Added editorial punch lists to top of sdpi-supplement & sdpi-standard documents
  • Refactored (most) all uses of "supplement" in the sdpi-standard files
      • NOTE: For some blocks I added a "// Standalone TO DO" line where the whole section needs to be reworded.

First pass at moving structural content from the standard to the supplement/ space.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.16 Update Notes:

  • Updated editorial punch lists at top of supplement / standard
  • Verified that the current supplement front matter conforms to the latest release (2.4.1) which it does!
  • Initial moving of TF1 outline + declarations to the supplement

<will see if it worked ... Friday!>

Updated sdpi-supplement include files to fix undefined labels in the supplement ... fingers crossed
Numerous typo corrections (e.g., "ol1" => "vol1"
TEST:  Bringing in TF-0 content, do the files all need to be renamed and labels renamed IF it is only in the sdpi-supplement.adoc "tree" ???
Running a test on a single definition "term_conformity_assessment" to see if it can be scoped to the supplement folders and includes ... or not.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.20 Update Notes:

Resolved to resolve build issues from Thursday 16 July (see above) - VERY VERY FRUSTRATED!!!

@d-gregorczyk @PaulMartinsen --
Clearly my assumptions about straightforward editing task have run headlong into ... reality! (and complexity)

In unraveling this onion of reference hell, I did an experiment that I think might have worked (it seems to have worked in my Fix #3 run.

QUESTION: When we ended up building the sdpi-standard & sdpi-supplement outputs, IF I move all but the top-level sdpi-supplement.adoc files under the supplement/ folder AND if I simply copy a file like TF-0 Appendix D with definitions into that supplement/ folder tree - so that for the supplement, only stuff loaded from that top level document are processed ... none of the sdpi-standard tree files are included - is there any duplication of build content across the two document trees?

IOW - if the same label (e.g., "term_conformity_assessment") is defined w/o supplement_term_conformity_assessment change, will there be any duplication errors or other issues when processing the source and rendering the supplement document?

My initial experiment indicates that the answer is "you're OK doing that, Todd" and if so ... I've wasted a chunk of time BUT moving forward will be much faster!

@ToddCooper

Copy link
Copy Markdown
Contributor Author

@d-gregorczyk @PaulMartinsen ...

My "local" build, by running: .ci/asciidoc-converter/build_document.bat

Resulted in an error: e: file:///C:/Docs/macStuff/Trusted%20Solutions/SDC/SDPi-FHIR/Repositories/DEV.SDPi/.ci/asciidoc-converter/src/test/kotlin/org/sdpi/ConvertUseCasesTest.kt:55:28 Unresolved reference 'useCaseReferences'.

But since I wasn't doing it from a "green" set of code ... I assume that it will work better once I get my other push to build correctly.

Right?

ToddCooper and others added 3 commits July 21, 2026 08:54
Restarting the refactoring work with non-"supplement_" adaptations, but with scoping based on includes and the supplement/ folder tree
Sync'd -intro document with the standard version
Updated both the glossary and declarations to not YET have references to non-included content
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.20 Update Notes:

After discussions with @d-gregorczyk & @PaulMartinsen regarding scope of AsciiDoc processing for each of the documents (sdpi-standard & sdpi-supplement), where we DON'T need to update the labels in the supplement tree to ensure that they are unique from the standard tree - RESTARTING REFACTORING to simply move items into the supplement/ folders with minimum scaffolding to resolve references.

Notes:

  • Local Build still errors out when I run (.ci/asciidoc-converter/build_document.bat) from IntelliJ
    • e: file:///C:/Docs/macStuff/Trusted%20Solutions/SDC/SDPi-FHIR/Repositories/DEV.SDPi/.ci/asciidoc-converter/src/test/kotlin/org/sdpi/ConvertUseCasesTest.kt:55:28 Unresolved reference 'useCaseReferences'.
  • @PaulMartinsen rules!!!
    • Able to build locally from Windows CONSOLE, not IntelliJ

So at the end of today, back to a direct path for updating the two source trees + local build (so I don't have to push-wait-cry ...)

@ToddCooper

ToddCooper commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

2026.07.22-23 Update Notes:

  1. Build tools that worked Tuesday... still work today!!!
  2. Migrated all Volume 0 content to the supplement
  • Will refactor out of standard

PUSHED local build and ... it works!!!

All of the Volume 0 content was migrated from the standard to the supplement.
This content will get refactored (mostly removed) from the standard.
NOTE:  "standalone" is used to flag notes or TO DO's in the supplement content
@ToddCooper ToddCooper linked an issue Jul 24, 2026 that may be closed by this pull request
Primary update was to add more complete content to the supplement.
Updated the punch lists for both.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.24 Update Notes:

  1. Updated Supplement to include "declarations"
  2. Completed basic supplement structure and including all the TF-0 content
  3. Migrated complete content of some sections (like references, per the SDPi Friday call today)

NOTE: @PaulMartinsen @d-gregorczyk There was one issue that I couldn't figure out what the problem is:

  • File: asciidoc/supplement/volume0/tf0-ch-d-glossary.adoc
  • Line 51 "// <<vol3_clause_system_type_nomenclature_extensions>>"

IF I remove the "//" it breaks, but the build, but if I comment it out, everything works fine???, and I've verified that the label is defined.

Standard updates to note at top re. proposed outline structure
Supplement updates especially around additional "outline" structure + TF-1:2 migration & TF-3 content.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.28 Update Notes:

Updates for this Tuesday ....

  1. Objective: Get content structurally ready for review on the HL7 DEV WG Wednesday call (29 July)
  2. Resolved "Line 51" issue from last Friday ... was definitely time to TAKE A WEEKEND!
  3. Updated notes at top of each document, indicating the KIND of instructions that will be included in the 2.5 ballot package version of these documents
  4. Updated / extended supplement structure, especially in TF-3 + migration of TF-1:2
  5. Made some incidental corrections in the content along the way

See build: Supplement Updates - Primarily for Structure #1385

PaulMartinsen and others added 2 commits July 29, 2026 19:41
Reflects major changes relating to:
     (1) Changes in organization of content in the Standard ... especially ...
     (2) Removing TF-0 Actors and refactoring all those references throughout the rest of the document.
@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.30 Update Notes:

  1. Resolved the final issue in the previous comment
  2. Continued editing based on review comments from 29 July HL7 DEV WG meeting review ...
  3. Resolved major standard build issues resulting from reorganization of content
  4. Began moving sections of the "standard" document to more conventional locations (e.g, References section)

@ToddCooper

Copy link
Copy Markdown
Contributor Author

2026.07.31 SDPi Friday Notes:

Reviewed the current draft of this branch, discussing various refactoring options and issues.

Issue: Refactoring out TF-0b Transactions appendix is editorially challenging - is there a Plan B?

  • Add to Standard SDPi Overview, Summary of Actors & Transactions for this release, for informational review
  • Add note to consider AUTO GENERATING the actors & transactions summary list + to keep sync'd between the Standard and Supplement documents

It was decided to first merge #557 to master, updating this branch from that, and then merging this back to master.

IF the merge of this branch is too challenging, then it will be postponed until after the 2.5 release.

This push includes another major restructuring of the files in the standard tree, relocating and renaming many in a new "front-matter" directory, and greatly simplifying the root directory content.
@ToddCooper

ToddCooper commented Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

2026.07.31 Update Notes:

  1. Updated the Standard front matter organization to reflect the intended structure
  2. Moved general non-volume standard files to new folder: front-matter
  3. Removed volume0 folder from standard tree
  4. Added Actor and Transaction summaries to the standard SDPi Overview section
  5. Added a new Conformance clause at the end of the document
  6. ... (and much, much more)

@ToddCooper

Copy link
Copy Markdown
Contributor Author

@PaulMartinsen - Conformance Content Question:

f you look at the latest push for this PR, you will see significant restructuring (moving, deleting, renaming) of the standard tree content.

Basically:

  1. Volume 0 is relocated / renamed ...
  2. front-matter directory now holds all the files for ... wait for it:  Front Matter!
  3. This includes renaming since, for example, TF-0 no longer exists in the standard
  4. Moving the referenced standards content to a new References section (no longer an appendix, though I have some more refactoring work to do on the labels, for example + the Bibliography is in the wrong place ... puzzlingly so

Also added a Conformance clause at the END OF THE DOCUMENT but didn't move anything there yet. Too late in my day to do something that might REALLY break everything! But the intent is to move the ICS stuff from the References section to the Conformance section, leaving only the Referenced Standards + Bibliography in that section.

PLEASE GIVE IT A BIT OF THOUGHT and let me know what you would like to see. ALSO if you think any of the current TF-3Z stuff might be moved to this new Conformance section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Standalone SDPi - Editorial Content Update Consistent Formatting of Actor Links in Supplement

3 participants