This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "V3 Publishing Process Steps"

From HL7Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
[[Category:HowTo]]
 
<big>V3 Publishing Steps</big>
 
<big>V3 Publishing Steps</big>
 +
 +
''The steps described below document the various components of the publishing process, the reader can go [[V3_Publishing_000_Process_Steps| here]] for simple run instructions''
 
==[[V3 PubProcess - Establish Environment|00...Establish Environment]]==
 
==[[V3 PubProcess - Establish Environment|00...Establish Environment]]==
 
This section deals with the process of completing the installation process in Eclipse (if that is the environment), setting various configuration properties that characterize your computing environment to the publishing scripts (written and executed in ANT), and selected processes that can be invoked to reset the environment.  
 
This section deals with the process of completing the installation process in Eclipse (if that is the environment), setting various configuration properties that characterize your computing environment to the publishing scripts (written and executed in ANT), and selected processes that can be invoked to reset the environment.  
 
==[[V3 PubProcess - Submit Content|01...Content Submission]]==
 
==[[V3 PubProcess - Submit Content|01...Content Submission]]==
This section encompasses those steps undertaken by a Publishing Facilitator (or other person preparing part or all of a publication package) in order to assemble and "submit to publishing" their specific portion of the content. Note that in this context, "submit to publishing" means either to submit to HQ for publishing or to "submit" to oneself for local publishing.  
+
It is hard to know whether this should be the first step or the last step in the process. When viewed from the perspective of publishing a complete ballot, it is the first step, as this is where content is sent to HQ.  However, from the facilitator's perspective it might be the final step, although in a procvess of iterative content refinement, it will probably be executed several times before final submission.
 +
 
 +
This section encompasses those steps undertaken by a Publishing Facilitator (or other person preparing part or all of a publication package) in order to assemble and "submit to publishing" their specific portion of the content. Note that in this context, "submit to publishing" means either to submit to HQ for publishing or to "submit" to oneself for local publishing.
 +
 
 
==[[V3 PubProcess - Prepare Source Files|02...Prepare Source Files For Publication]]==
 
==[[V3 PubProcess - Prepare Source Files|02...Prepare Source Files For Publication]]==
The various content files repaired by the Work Groups must be preprocessed in order to make them useful in the publication. For example, the domain content must be extracted( as an XML file) from the publication database; the Visio "BSD" files must be processed to create appropriately sized graphics, and a hyper-linked HTML "map" to drive graphic navigation; etc. This section documents the processes used in preprocessing these files.
+
The various content files repaired by the Work Groups must be preprocessed in order to make them useful in the publication. For example, the domain content must be extracted( as an XML file) from the publication database; the Visio "vsd" files from HL7's RMIM Designer must be processed to create appropriately sized graphics, and a hyper-linked HTML "map" to drive graphic navigation; etc. This section documents the processes used in preprocessing these files.
==[[V3 PubProcess - Align Content & Preview QA|03...Align Content Versions and Preview QA]]==
+
 
Version 3 involves the aggregation of the variety of content that has been developed "in parallel" by a variety of work groups. As such, publication must be an injury to the process in which the content from multiple workgroups is a line, and in which a series of quality assurance evaluations must be made. This section documents the use coordination and review processes.
+
==[[V3 PubProcess - Align, Check, Revise and Constrain Source Content|03...Align, Check, Revise and Constrain Source Content]]==
 +
Version 3 publishing involves the aggregation of the variety of content that has been developed "in parallel" by a variety of work groups. As such, publication must include a series of processes, invoked iteratively, in which the content from multiple work groups is reviewed, corrected, aligned and perhaps constrained. This section documents these coordination and review processes. The details of the underlying design principles are documented as [[Design Principles for Alignment, Review and Constraint of V3 Publishing Content]].
 +
 
 
==[[V3 PubProcess - Generate MIF and Related Content|04...Generate MIF and Related Content]]==
 
==[[V3 PubProcess - Generate MIF and Related Content|04...Generate MIF and Related Content]]==
 
The HL7 V3 Generator is a tool whose primary purpose is to convert a set of domain and design content (frequently expressed in idiosyncratic xml formats, into a set of files expressed in the HL7 Model Interchange Format (MIF); and then to process the MIF files to create a supporting set of artifacts, such as static model schemas, table- and Excel- views of the static models, etc. This section covers the execution of the Generator processes.
 
The HL7 V3 Generator is a tool whose primary purpose is to convert a set of domain and design content (frequently expressed in idiosyncratic xml formats, into a set of files expressed in the HL7 Model Interchange Format (MIF); and then to process the MIF files to create a supporting set of artifacts, such as static model schemas, table- and Excel- views of the static models, etc. This section covers the execution of the Generator processes.
Line 14: Line 22:
 
"Specific content" refers to material that is the publishing '''responsibility of a single facilitator or Work Group'''. It might be many things - a domain, a CDA Implementation Guide or an "infrastructure" specification. This section documents the processes needed to publish this material.
 
"Specific content" refers to material that is the publishing '''responsibility of a single facilitator or Work Group'''. It might be many things - a domain, a CDA Implementation Guide or an "infrastructure" specification. This section documents the processes needed to publish this material.
 
==[[V3 PubProcess - Publish Common Content and TOC|06...Publish Common Content and TOC]]==
 
==[[V3 PubProcess - Publish Common Content and TOC|06...Publish Common Content and TOC]]==
 +
"Common" content is all of the material that is part of a ballot or publication but is not the domains and specifications being voted upon. Examples include the Version 3 Guide, the Facilitator's Handbook, Introduction and Welcome sections,the table of contents used to navigate the ballot, etc.
 
==[[V3 PubProcess - Package Publication and Distribute|07...Package Publication and Distribute]]==
 
==[[V3 PubProcess - Package Publication and Distribute|07...Package Publication and Distribute]]==
 +
This final section covers those processes that assemble the material into a coat curherent website, or build packages for distribution in zip files and/or electronic media.
 
[[User:Gwbeeler|GWBeeler]] 17:51, 12 August 2010 (UTC)
 
[[User:Gwbeeler|GWBeeler]] 17:51, 12 August 2010 (UTC)

Latest revision as of 15:56, 17 August 2012

V3 Publishing Steps

The steps described below document the various components of the publishing process, the reader can go here for simple run instructions

00...Establish Environment

This section deals with the process of completing the installation process in Eclipse (if that is the environment), setting various configuration properties that characterize your computing environment to the publishing scripts (written and executed in ANT), and selected processes that can be invoked to reset the environment.

01...Content Submission

It is hard to know whether this should be the first step or the last step in the process. When viewed from the perspective of publishing a complete ballot, it is the first step, as this is where content is sent to HQ. However, from the facilitator's perspective it might be the final step, although in a procvess of iterative content refinement, it will probably be executed several times before final submission.

This section encompasses those steps undertaken by a Publishing Facilitator (or other person preparing part or all of a publication package) in order to assemble and "submit to publishing" their specific portion of the content. Note that in this context, "submit to publishing" means either to submit to HQ for publishing or to "submit" to oneself for local publishing.

02...Prepare Source Files For Publication

The various content files repaired by the Work Groups must be preprocessed in order to make them useful in the publication. For example, the domain content must be extracted( as an XML file) from the publication database; the Visio "vsd" files from HL7's RMIM Designer must be processed to create appropriately sized graphics, and a hyper-linked HTML "map" to drive graphic navigation; etc. This section documents the processes used in preprocessing these files.

03...Align, Check, Revise and Constrain Source Content

Version 3 publishing involves the aggregation of the variety of content that has been developed "in parallel" by a variety of work groups. As such, publication must include a series of processes, invoked iteratively, in which the content from multiple work groups is reviewed, corrected, aligned and perhaps constrained. This section documents these coordination and review processes. The details of the underlying design principles are documented as Design Principles for Alignment, Review and Constraint of V3 Publishing Content.

04...Generate MIF and Related Content

The HL7 V3 Generator is a tool whose primary purpose is to convert a set of domain and design content (frequently expressed in idiosyncratic xml formats, into a set of files expressed in the HL7 Model Interchange Format (MIF); and then to process the MIF files to create a supporting set of artifacts, such as static model schemas, table- and Excel- views of the static models, etc. This section covers the execution of the Generator processes.

05...Publish Specific Content

"Specific content" refers to material that is the publishing responsibility of a single facilitator or Work Group. It might be many things - a domain, a CDA Implementation Guide or an "infrastructure" specification. This section documents the processes needed to publish this material.

06...Publish Common Content and TOC

"Common" content is all of the material that is part of a ballot or publication but is not the domains and specifications being voted upon. Examples include the Version 3 Guide, the Facilitator's Handbook, Introduction and Welcome sections,the table of contents used to navigate the ballot, etc.

07...Package Publication and Distribute

This final section covers those processes that assemble the material into a coat curherent website, or build packages for distribution in zip files and/or electronic media. GWBeeler 17:51, 12 August 2010 (UTC)