| Issue Number | 5328 |
|---|---|
| Summary | Update samples for data partners |
| Created | 2024-06-25 14:09:41 |
| Issue Type | Improvement |
| Submitted By | Kline, Robert (NIH/NCI) [C] |
| Assigned To | Englisch, Volker (NIH/NCI) [C] |
| Status | Resolved |
| Resolved | 2025-02-26 17:10:14 |
| Resolution | Fixed |
| Path | /home/bkline/backups/jira/ocecdr/issue.449431 |
We provide example materials (with accompanying documentation) to the PDQ data partners illustrating the process of rendering the CDR XML documents as HTML web pages. Originally, these materials included resources for styling the resulting HTML output to resemble the appearance provided on the NCI web site for such documents, as well as client-side processing to make the pages responsive. However, it has been difficult to keep these materials up-to-date and reflecting changes on the web site, and the decision has been made to scale back the purpose of the materials so that we're just showing the partners how to transform the XML document into correctly marked-up HTML, but not aspire to illustrate custom formatting or client-side scripting. Please modify the documentation to make this goal explicit, and remove all styling and scripting (including any links to external CSS or JavaScript resources). These changes need to be made both to the files we provide to the data partners, as well as the script which generates the HTML file.
https://github.com/NCIOCPL/cdr-publishing/tree/riemann/pdqdocs
https://github.com/NCIOCPL/cdr-admin/blob/riemann/Inetpub/wwwroot/cgi-bin/cdr/show-PDQ-summary.py
I don't think that it's necessary to remove all styling if the documentation makes it clear that the styling isn't significant for the purpose of the transformation.
Considering that we haven't received any questions regarding these sample documents I'm hesitant to spend much time on making them perfect.
I will first make updates to the documentation.
~bkline , I've made the changes you requested to the sample documents - still working on the documentation. However, I'm not clear what the benefit is to make the changes also to the script that's only used internally: show-PDQ-summary.py.
~bkline , do you want these changes to be part of "stern" or go out independently?
No strong preference. Easiest to put them in Stern, I suppose.
The instructions to process and view our PDQ sample documents were a little outdated. Today's web browsers don't always allow what used to work in the past.
Bob found an easy way to replace the old approach and I've updated the documentation to include using Python to run a local web server for the transformation.
The following files have been updated:
PDQ-summary.xml
PDQ-summary.xsl
PDQ-summary.html
PDQ_XML_Package.doc
PDQ_XML_Package.pdf
~volker In the How To Turn XML Into HTML document (.docx and .pdf) we say:
The document PDQ-Data_high-level-process-flow.jpg gives an overview of the necessary steps if your goal is to present the PDQ XML data on your own website.
Where do the partners find this resource?
Elapsed: 0:00:00.001292