Difference between revisions of "XML Publishing Roadmap"

From PKP Wiki
Jump to: navigation, search
Line 1: Line 1:
 
= XML Publishing Roadmap =
 
= XML Publishing Roadmap =
  
The PKP, in conjunction with RIT, University of Monash, and UNB ETC, will be extending our publishing support to include XML workflows. The goal is to have our software ingest XML (primarily NLM and Docbook DTDs/schema, with TEI and Erudit to follow) and render/display HTML and PDF.  
+
The PKP, in conjunction with RIT, and UNB ETC, will be extending our publishing support to include XML workflows. The goal is to have our software ingest XML (initially [http://dtd.nlm.nih.gov/publishing/2.3/ NLM Journal Publishing Tag Set Version 2.3] with Docbook, TEI and Erudit to follow) and render/display HTML and PDF.  
  
 
== Goals ==
 
== Goals ==
Line 10: Line 10:
  
 
== Roadmap ==
 
== Roadmap ==
 
* Diagram reasonable XML rendering workflow. ('''TODO: MJ''')
 
  
 
===Phase 1===
 
===Phase 1===
 
* Bring XML galleys plugin up to date wrt. localization changes in OJS 2.x
 
* Bring XML galleys plugin up to date wrt. localization changes in OJS 2.x
 +
* Modify plugin to generate galleys from an uploaded "layout" file rather than "galley" file
 
* Move XSL code from the plugin into the PKP WAL
 
* Move XSL code from the plugin into the PKP WAL
 +
* Determine work required to refactor Molecular Vision XSL2.0 to XSL1.0
 
* Examine and refactor/merge XSL files for HTML generation from Monash, Open Medicine, Molecular Vision
 
* Examine and refactor/merge XSL files for HTML generation from Monash, Open Medicine, Molecular Vision
* Determine work required to refactor XSL2.0 code to XSL1.0
 
  
 
===Phase 2===
 
===Phase 2===
 
* Examine and refactor XSL files for PDF generation from Molecular Vision
 
* Examine and refactor XSL files for PDF generation from Molecular Vision
* consider improvements to plugin/XSL classes for supporting XSL2.0 via Saxon
+
* Improvements to plugin/XSL classes for supporting XSL2.0 via Saxon
  
 
===Phase 3===
 
===Phase 3===
 
* Extend the current xmlGalleys plugin (which already supports NLM) to support Docbook and TEI based on XSL from Monash, UNB, UVic
 
* Extend the current xmlGalleys plugin (which already supports NLM) to support Docbook and TEI based on XSL from Monash, UNB, UVic
 +
 +
===Phase 4===
 +
* Extend/parameterize XSLs for HTML and PDF to produce customizable/SSH layout in addition to STM layout
  
 
== Documentation ==
 
== Documentation ==
  
[[Monash]]
+
* Notes on [[Monash]] contribution
 +
* Proposed XML rendering workflow: ('''TODO Image Upload''')
  
 
== Feature List ==  
 
== Feature List ==  
Line 62: Line 65:
 
<th rowspan="2" valign="top">2. NLM to HTML/PDF galleys</th>
 
<th rowspan="2" valign="top">2. NLM to HTML/PDF galleys</th>
 
<td>NLM->HTML transformation</td>
 
<td>NLM->HTML transformation</td>
<td>Requires proper XSLT 1.0 files or CSS<br />
+
<td>Requires proper XSLT 1.0 files<br />
- XSLT 1.0 files provided by Monash
+
- Monash has provided XSLT 1.0 files
- other XSLT 1.0 files (rudimentary) already in use by us</td>
+
- Current plugin already using XSLT 1.0 files based on [http://dtd.nlm.nih.gov/tools/tools.html NLM's tools]</td>
 
<td>XSLT 2.0 transformation
 
<td>XSLT 2.0 transformation
 
- UVic would prefer to work with XSLT 2.0
 
- UVic would prefer to work with XSLT 2.0
- Emory has provided us with XSLT 2.0 files
+
- Molecular Vision has provided XSLT 2.0 files
- XSLT 2.0 would require using Java to use a 2.0-compatible XSLT engine</td>
+
- XSLT 2.0 would require using Java to use a 2.0-compatible XSLT engine (ie. [http://saxon.sourceforge.net/ Saxon])</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td>XML->XSL:FO->PDF</td>
 
<td>XML->XSL:FO->PDF</td>
<td>not possible</td>
+
<td>Not possible</td>
<td>Requires Java</td>
+
<td>Requires Java<br />
 +
- Sample XSLT 1.0 in current plugin</td>
 
</tr>
 
</tr>
  
 
</table>
 
</table>

Revision as of 05:55, 6 March 2009

XML Publishing Roadmap

The PKP, in conjunction with RIT, and UNB ETC, will be extending our publishing support to include XML workflows. The goal is to have our software ingest XML (initially NLM Journal Publishing Tag Set Version 2.3 with Docbook, TEI and Erudit to follow) and render/display HTML and PDF.

Goals

  • Support Science (NLM) and SSH (Erudit, Docbook, TEI) publishing formats
  • Produce both HTML and PDF rendering
  • Integrate, where appropriate, with: L8X (preview), OJS, and OMP

Roadmap

Phase 1

  • Bring XML galleys plugin up to date wrt. localization changes in OJS 2.x
  • Modify plugin to generate galleys from an uploaded "layout" file rather than "galley" file
  • Move XSL code from the plugin into the PKP WAL
  • Determine work required to refactor Molecular Vision XSL2.0 to XSL1.0
  • Examine and refactor/merge XSL files for HTML generation from Monash, Open Medicine, Molecular Vision

Phase 2

  • Examine and refactor XSL files for PDF generation from Molecular Vision
  • Improvements to plugin/XSL classes for supporting XSL2.0 via Saxon

Phase 3

  • Extend the current xmlGalleys plugin (which already supports NLM) to support Docbook and TEI based on XSL from Monash, UNB, UVic

Phase 4

  • Extend/parameterize XSLs for HTML and PDF to produce customizable/SSH layout in addition to STM layout

Documentation

  • Notes on Monash contribution
  • Proposed XML rendering workflow: (TODO Image Upload)

Feature List

Feature list broken down by level of difficulty

Procedural StepFeatureSimpleDifficult
1. Various XML to NLM Docbook->NLM transformation Requires proper XSL files

- have been provided by Monash

- can't handle Docbook 5
To support Docbook 5 we would have to substantially rework (or recreate) the files provided by Monash
TEI->NLM transformation Requires proper XSL files
- will be provided by UVic (will presumably handle Martin's TEIJournal modification; be back-portable to TEI P5)
 
Erudit->NLM transformation Requires proper XSL files
- possibly provided by UNB?
 
2. NLM to HTML/PDF galleys NLM->HTML transformation Requires proper XSLT 1.0 files

- Monash has provided XSLT 1.0 files

- Current plugin already using XSLT 1.0 files based on NLM's tools
XSLT 2.0 transformation

- UVic would prefer to work with XSLT 2.0 - Molecular Vision has provided XSLT 2.0 files

- XSLT 2.0 would require using Java to use a 2.0-compatible XSLT engine (ie. Saxon)
XML->XSL:FO->PDF Not possible Requires Java
- Sample XSLT 1.0 in current plugin