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

Difference between revisions of "Desktop Publication Documentation"

From HL7Wiki
Jump to navigation Jump to search
(New page: =Desktop Publication= Desktop Publication is a capability whereby '''''Publishing Facilitators''''' for particular domains or projects can manage their content, validate the completeness o...)
 
(Replacing page with '__NOTOC__ Category:HowTo =Desktop Publication= The entire previous content of this page has been removed, as the tools it documented have been withdrawn in favor of a new V...')
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
[[Category:HowTo]]
 
=Desktop Publication=
 
=Desktop Publication=
Desktop Publication is a capability whereby '''''Publishing Facilitators''''' for particular domains or projects can manage their content, validate the completeness of that content, evaluate it for quality assurance issues, package it for submission as ballot content, and '''most importantly''' create a local replica of what their content will look like when included in a ballot.
+
The entire previous content of this page has been removed, as the tools it documented have been withdrawn in favor of a new V3 Publishing Tool Suite that can be [http://gforge.hl7.org/gf/project/xmlpublishing/frs/ downloaded from Gforge]  The new suite is documented under[[V3_Publishing_Process_Steps]], whose is also included below.
  
This capability reflects a combination of processes from various tools operating in a controlled file environment, and using ANT driven scripts to invoke sub-processes supported by those tools.  The tools involved include:
+
{{:V3_Publishing_Process_Steps}}
#'''''Publishing Processes''''' - the set of ANT scripts and transforms used at HL7 Head Quarters (HQ) to produce and test each V3 ballot site.
 
#'''''V3 Generator''''' - the set of ANT scripts and transforms used by HL7 HQ and others to convert the output files from the PubDb and Static Model Designer (see below) into MIF2 representation files; complete message and interaction schemas; html "table views" of each static model; and an Excel view of each static model.
 
#'''''PubDb''''' The Set of VBA code, table and form definitions that allows use of an Access data base to define and manage individual domains according to the constraints expressed in the HL7 methodology.
 
#'''''HL7 RMIM Designer (in Visio)''''' a combination of Visio stencils and detailed VBA code that supports "drag-and-drop" static model design while simultaneously invoking the constraints and content rules expressed in both the Hl7 Methodology, and the RIM and Vocabulary specifications.
 
#'''''RoseTree''''' - which supports the RMIM Designer (in Visio), HL7 PubDb, and vocabulary MIF assembly by providing automated access to the HL7 design repository (holds RIM and Vocabulary content) and command line processes that allow ANT scripts to invoke processes in the RMIM Designer and PubDB.
 
#Additional ANT scripts and transforms to support the integration of these tools, and the definition and execution of manifest generation, submission packaging, and quality assurance testing.
 

Latest revision as of 15:04, 29 September 2010

Desktop Publication

The entire previous content of this page has been removed, as the tools it documented have been withdrawn in favor of a new V3 Publishing Tool Suite that can be downloaded from Gforge The new suite is documented underV3_Publishing_Process_Steps, whose is also included below. 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)