Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ci/asciidoc-converter/build_document.bat
Original file line number Diff line number Diff line change
@@ -1 +1 @@
gradlew.bat run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-supplement --backend html"
gradlew.bat run --args="--input-file ../../asciidoc/sdpi-standard.adoc --output-folder ../../sdpi-standard --backend html"
2 changes: 1 addition & 1 deletion .ci/asciidoc-converter/build_document_pdf.bat
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
gradlew.bat run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-supplement --backend pdf"
gradlew.bat run --args="--input-file ../../asciidoc/sdpi-standard.adoc --output-folder ../../sdpi-standard --backend pdf"


10 changes: 5 additions & 5 deletions .ci/asciidoc-converter/publish_assets.bat
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
xcopy ..\..\asciidoc\css\*.* ..\..\sdpi-supplement\css /I /R /Y
xcopy ..\..\asciidoc\fonts\*.* ..\..\sdpi-supplement\fonts /I /R /Y
xcopy ..\..\asciidoc\images\*.* ..\..\sdpi-supplement\images /I /R /Y
xcopy ..\..\asciidoc\js\*.* ..\..\sdpi-supplement\js /I /R /Y
xcopy images\*.* ..\..\sdpi-supplement\images /I /R /Y
xcopy ..\..\asciidoc\css\*.* ..\..\sdpi-standard\css /I /R /Y
xcopy ..\..\asciidoc\fonts\*.* ..\..\sdpi-standard\fonts /I /R /Y
xcopy ..\..\asciidoc\images\*.* ..\..\sdpi-standard\images /I /R /Y
xcopy ..\..\asciidoc\js\*.* ..\..\sdpi-standard\js /I /R /Y
xcopy images\*.* ..\..\sdpi-standard\images /I /R /Y
31 changes: 22 additions & 9 deletions .github/prepare_artifacts.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,28 @@ gem install asciidoctor-diagram
gem install asciidoctor-diagram-plantuml
asciidoctor -V
cd asciidoc || exit
asciidoctor -r asciidoctor-diagram -D ../ sdpi-supplement.adoc

mkdir sdpi-documents

asciidoctor -r asciidoctor-diagram -D ../sdpi-documents sdpi-standard.adoc
asciidoctor -r asciidoctor-diagram -D ../sdpi-documents sdpi-supplement.adoc
cd ..
mkdir sdpi-supplement
cp -R asciidoc/images sdpi-supplement/images
cp -R asciidoc/js sdpi-supplement/js
cp -R asciidoc/css sdpi-supplement/css
cp -R asciidoc/fonts sdpi-supplement/fonts
rm -rf sdpi-supplement/.asciidoctor
rm -rf sdpi-supplement/readme.md

mkdir sdpi-documents/sdpi-standard
cp -R asciidoc/images sdpi-documents/sdpi-standard/images
cp -R asciidoc/js sdpi-documents/sdpi-standard/js
cp -R asciidoc/css sdpi-documents/sdpi-standard/css
cp -R asciidoc/fonts sdpi-documents/sdpi-standard/fonts
rm -rf sdpi-documents/sdpi-standard/.asciidoctor
rm -rf sdpi-documents/sdpi-standard/readme.md

mkdir sdpi-documents/sdpi-supplement
cp -R asciidoc/images sdpi-documents/sdpi-supplement/images
cp -R asciidoc/js sdpi-documents/sdpi-supplement/js
cp -R asciidoc/css sdpi-documents/sdpi-supplement/css
cp -R asciidoc/fonts sdpi-documents/sdpi-supplement/fonts
rm -rf sdpi-documents/sdpi-supplement/.asciidoctor
rm -rf sdpi-documents/sdpi-supplement/readme.md

sudo apt-get install zip gzip tar
zip -r "sdpi-supplement-$1.zip" sdpi-supplement
zip -r "sdpi-documents-$1.zip" sdpi-documents
29 changes: 19 additions & 10 deletions .github/workflows/feature-review-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on: [push, pull_request]

env:
CI: true

jobs:
build:

Expand All @@ -16,7 +16,7 @@ jobs:
steps:
- name: Checkout branch
uses: actions/checkout@v4

- name: Set up JDK 17
uses: actions/setup-java@v4
with:
Expand All @@ -30,25 +30,34 @@ jobs:
with:
ruby-version: '3.0' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically

- name: Setup gradle
uses: gradle/actions/setup-gradle@v4

- name: Create HTML with Gradle
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-supplement --github-token '${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }}' --backend html"
- name: Create folders
run: |
mkdir -p sdpi-documents/sdpi-standard
mkdir -p sdpi-documents/sdpi-supplement

- name: Create SDPi Standard HTML with Gradle
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-standard.adoc --output-folder ../../sdpi-documents/sdpi-standard --github-token '${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }}' --backend html"
working-directory: .ci/asciidoc-converter

- name: Generate PlantUML diagrams and static files
- name: Create SDPi Supplement HTML with Gradle
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-documents/sdpi-supplement --github-token '${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }}' --backend html"
working-directory: .ci/asciidoc-converter

- name: Generate SDPi Standard and Supplement PlantUML diagrams and static files
run: .github/prepare_artifacts.sh "x.x.x"

- name: Extract branch name
shell: bash
run: echo "branch=$(echo ${GITHUB_REF#refs/heads/})" | tr '/' '-' >> $GITHUB_OUTPUT
id: extract_branch

- name: Upload artifact
# if: success() && github.ref == 'refs/heads/master'
uses: actions/upload-artifact@v4
with:
name: sdpi-supplement-${{ steps.extract_branch.outputs.branch }}
path: sdpi-supplement
name: sdpi-documents-${{ steps.extract_branch.outputs.branch }}
path: sdpi-documents
6 changes: 3 additions & 3 deletions .github/workflows/latest-master-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
uses: gradle/actions/setup-gradle@v4

- name: Create HTML with Gradle
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-supplement --github-token ${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }} --backend html"
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-standard.adoc --output-folder ../../sdpi-standard --github-token ${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }} --backend html"
working-directory: .ci/asciidoc-converter

- name: Generate PlantUML diagrams and copy static files
Expand All @@ -48,5 +48,5 @@ jobs:
# if: success() && github.ref == 'refs/heads/master'
uses: actions/upload-artifact@v4
with:
name: sdpi-supplement
path: sdpi-supplement
name: sdpi-standard
path: sdpi-standard
8 changes: 4 additions & 4 deletions .github/workflows/release-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
uses: gradle/actions/setup-gradle@v4

- name: Create HTML with Gradle
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-supplement.adoc --output-folder ../../sdpi-supplement --github-token ${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }} --backend html"
run: ./gradlew run --args="--input-file ../../asciidoc/sdpi-standard.adoc --output-folder ../../sdpi-standard --github-token ${{ secrets.SDPI_API_ACCESS_TOKEN_SECRET }} --backend html"
working-directory: .ci/asciidoc-converter

- name: Generate PlantUML diagrams and static files
Expand All @@ -48,14 +48,14 @@ jobs:
# if: success() && github.ref == 'refs/heads/master'
uses: actions/upload-artifact@v4
with:
name: sdpi-supplement
path: sdpi-supplement
name: sdpi-standard
path: sdpi-standard

- name: Create release page
uses: ncipollo/release-action@v1
with:
name: "Release of ${{ github.ref_name }} for TI"
makeLatest: true
body: "[📋Please click here for a detailed changelog](https://github.com/IHE/DEV.SDPi/blob/${{ github.ref_name }}/CHANGELOG.md)"
artifacts: "sdpi-supplement-${{ github.ref_name }}.zip"
artifacts: "sdpi-standard-${{ github.ref_name }}.zip"

3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Each section shall contain a list of action items of the following format: `<bri

### Added

- Clarifying note to R7000 ([#501](https://github.com/IHE/DEV.SDPi/issues/501)).
- Clarifying statements to DEV-23, DEV-24, DEV-46, and DEV-47 w.r.t to ad-hoc and managed mode discovery([#409](https://github.com/IHE/DEV.SDPi/issues/409)).
- OID Framework to TF-3Z ([#474](https://github.com/IHE/DEV.SDPi/issues/474))
- Standalone SDPi Refactoring ([#499](https://github.com/IHE/DEV.SDPi/issues/499))
- Clarifying note to R7000 ([#501](https://github.com/IHE/DEV.SDPi/issues/501)).

### Changes

Expand Down
12 changes: 6 additions & 6 deletions articles/sdpi-article-ihe-tf-asciidoc-cookbook.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are a few methods to review the HTML that will be rendered from the AsciiD
.. Note that it typically takes a minute or two to complete the workflow action -- status will be displayed on the right side of your push's row
.. Select your branches latest upload (push remote)
.. IF the action was successful, there will be listed in the "Artifacts" section; click on the artifact Name to download a ZIP of the rendered document.
.. Extract the ZIP, select the "singlepage" subfolder and open the sdpi-supplement.html document
.. Extract the ZIP, select the "singlepage" subfolder and open the sdpi-standard.html document

Enjoy AsciiDoc content creation!

Expand Down Expand Up @@ -341,7 +341,7 @@ For a bulleted list of items, the final "full stop" character of each non-final
== Semantic markup
https://docs.asciidoctor.org/asciidoctorj/latest/[Asciidoctor], which converts these files into other formats (e.g., html, pdf), has been https://docs.asciidoctor.org/asciidoctorj/latest/extensions/extensions-introduction/[extended] to process domain specific content for the supplement. These extensions provide semantic markup of content that is used to automatically generate, for example, implementation conformance statement tables and export requirements and use cases in JSON format for external tooling (see https://profiles.ihe.net/DEV/SDPi/index.html#vol1_appendix_a_requirements_management_for_p_n_t_interperability[requirements management for plug-and-trust interoperability]).

Content extracted, using markup in the source described below, and exported, to `sdpi-supplement/referenced-artifacts/` in JSON format includes:
Content extracted, using markup in the source described below, and exported, to `sdpi-standard/referenced-artifacts/` in JSON format includes:

* `sdpi-profiles.json`: all profiles (e.g., SDPi), including actors and options defined, and the transactions, content modules and use-cases supported,
* `sdpi-content-modules.json`: content modules (e.g., SDC/BICEPS, etc),
Expand Down Expand Up @@ -1122,12 +1122,12 @@ The AsciiDoc source is automatically processed using GitHub actions.

For testing, documents can be generated using Windows command line tools (probably for other operating systems too, but I don't know about that; please expand on this when you figure out how). To create output from the AsciiDoc source open a command prompt in the `.ci\asciidoc-converter` folder and use:

* `build_document.bat` to create an html document (`sdpi-supplement.html`),
* `build_document_pdf.bat` to create an Acrobat PDF document (`sdpi-supplement.pdf`).
* `build_document.bat` to create an html document (`sdpi-standard.html`),
* `build_document_pdf.bat` to create an Acrobat PDF document (`sdpi-standard.pdf`).

The output files are written to `sdpi-supplement` folder. Extracts (requirements and use-cases in JSON format) are written to the `sdpi-supplement\referenced-artifacts` folder. Extracts are generated along with the document output.
The output files are written to `sdpi-standard` folder. Extracts (requirements and use-cases in JSON format) are written to the `sdpi-standard\referenced-artifacts` folder. Extracts are generated along with the document output.

IMPORTANT: Don't commit files in the `sdpi-supplement` folder to the repository.
IMPORTANT: Don't commit files in the `sdpi-standard` folder to the repository.

== Topics Parking Lot

Expand Down
6 changes: 4 additions & 2 deletions asciidoc/document-declarations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@ NOTES:
////

[#supplement_clause_forward_declarations,sdpi_offset=clear]
== Supplement Forward Declarations
== Standard Forward Declarations

[%noheader]
[%autowidth]
[cols="1"]
|===
a| *{supplement_note}*:

The following table is included in this version of the supplement to capture *_"forward" declarations of acronyms and labels_* that are used in the text but are not intended to be part of the General Introduction Appendix D Glossary.
*Standalone SDPi:* _REWORK this section to make it a permanent Forward Declarations, perhaps refactoring it into something that is not labeled "Forward Declarations"!_

The following table is included in this version of the standard to capture *_"forward" declarations of acronyms and labels_* that are used in the text but are not intended to be part of the General Introduction Appendix D Glossary.
"Forward" means that they are used BEFORE the document section in which they are formally defined.
Since AsciiDoc is a one-pass processor, forward declarations are required.

Expand Down
Loading
Loading