Difference between revisions of "XML Publishing"

From PKP Wiki
Jump to: navigation, search
(XML Publishing Document Archive)
m (fixed italics)
 
(11 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
== Project Contacts ==
 
== Project Contacts ==
 
* [mailto:axfelix@gmail.com Alex Garnett]
 
* [mailto:axfelix@gmail.com Alex Garnett]
* [mailto:damion@learningpoint.ca Damion Dooley]
 
  
== DIGO (Draft In, Galley Out) OJS Plugin for XML HTML and PDF Output ==
+
== Demonstration ==
 +
* [http://pkp-udev.lib.sfu.ca/ | Demonstration Instance] (this is unlikely to produce publication-ready results currently, but can be useful for getting most of the way to good output, if you're already accustomed to getting your hands dirty with markup!)
  
This project implements an OJS plugin for producing NLM standard article XML, as well as pdf and HTML document versions for any article uploaded to an OJS journal.
+
* Note that we're still feeling out the capacity of the demonstration instance, so please get in touch if the server appears to be significantly slower on one day than it was previously -- it might be time to scale up.
  
This plugin will have an enabled/disabled state, and will have one settings field for selecting a csl style from a dynamic list that pertains to the OJS journal.
+
== PKP XML Conversion Service ==
  
When an author, copyeditor or editor uploads a new version (odt, docx, doc, or pdf format) of an article, this module (using a separate thread) submits it to the pdfx server specified in the configuration file.  The following files are returned in a gzip'ed archive file (X-Y-Z-AG.tar.gz) which is added (or replaces a pre-existing version in) the Supplementary files section.
+
PKP is developing a standalone service for converting unstructured documents in a Microsoft Word or LibreOffice compatible format to structured NLM JATS XML, and from there, creating attractive, usable HTML and PDF article views from the XML. This is intended to decrease the labour involved in the layout stage, and facilitate the creation of archive-friendly and web-native article formats (as well as facilitating indexing in PubMed Central). This work has been funded by Stanford University's MediaX incubator under the direction of John Willinsky since 2012.
  
* document.pdf (may be generated if input format is not pdf)
+
We are also providing an OJS plugin which integrates into the OJS workflow and treats this parsing service as an API, which will be available in OJS 2.4.5. In 2013, we released an early proof of concept of this functionality, which we are now redeveloping in combination with the Open Library of the Humanities.
* document.nlm.xml (NLM National Library of Medicine standard xml)
+
* document.html and related graphics
+
* document.bib (a bibtex text file of reference data)
+
* document.refs (a text file of the article's citations and their bibliographic references, formatted according to selected CSL style.  It provides an indication of which references were unused in body of article.)
+
  
If the article is being uploaded as a galley publish, this plugin will extract the xml and pdf versions when they are ready, and will place them in the supplementary file folder so that web options can be provided for viewing.
+
The code for the webservice, as well as documentation for querying the API, is available [https://github.com/pkp/xmlps | here]. The results are perpetually improving, but we have not yet decided when or if it will be officially declared to be out of (or in) beta.
  
We are doing this each time an article is submitted to enable the bibliographic reference work to be available at early stages of review and during copyedit.
+
The code for the OJS plugin is available [https://github.com/pkp/ojs-markup | here]. Currently, the only plugin settings that can be configured are the desired Citation Style for the Journal and the desired CSS for the HTML version of the parsed article, if you don't want to use our provided CSS. Currently, the plugin is designed to generate new XML/HTML/PDF galleys from the markup server, ''replacing'' existing galleys, ''every'' time a new review or layout version of a submission is uploaded. This will change in a future version, but for now, be careful not to overwrite existing files if you don't wish to use the markup plugin workflow exclusively.
  
 
== XML Publishing Document Archive ==
 
== XML Publishing Document Archive ==

Latest revision as of 11:34, 7 July 2014

PKP is currently working on an XML publishing workflow whereby article components (submission documents, citation lists, article metadata) are transformed into NLM XML for subsequent use in the publishing process. This meta-project consists of numerous sub-projects, and is itself directly inspired by PKP's Lemon8 project.

Previous iterations of this project include the OJS XML Galley Plugin (a standard component of OJS), the Citation Markup Assistant (also a standard component of OJS), and Lemon8 (an external application, since retired). The current focus of the project is on converting OJS submission drafts into NLM XML, which can in turn be converted to HTML and PDF galleys.

Project Contacts

Demonstration

  • | Demonstration Instance (this is unlikely to produce publication-ready results currently, but can be useful for getting most of the way to good output, if you're already accustomed to getting your hands dirty with markup!)
  • Note that we're still feeling out the capacity of the demonstration instance, so please get in touch if the server appears to be significantly slower on one day than it was previously -- it might be time to scale up.

PKP XML Conversion Service

PKP is developing a standalone service for converting unstructured documents in a Microsoft Word or LibreOffice compatible format to structured NLM JATS XML, and from there, creating attractive, usable HTML and PDF article views from the XML. This is intended to decrease the labour involved in the layout stage, and facilitate the creation of archive-friendly and web-native article formats (as well as facilitating indexing in PubMed Central). This work has been funded by Stanford University's MediaX incubator under the direction of John Willinsky since 2012.

We are also providing an OJS plugin which integrates into the OJS workflow and treats this parsing service as an API, which will be available in OJS 2.4.5. In 2013, we released an early proof of concept of this functionality, which we are now redeveloping in combination with the Open Library of the Humanities.

The code for the webservice, as well as documentation for querying the API, is available | here. The results are perpetually improving, but we have not yet decided when or if it will be officially declared to be out of (or in) beta.

The code for the OJS plugin is available | here. Currently, the only plugin settings that can be configured are the desired Citation Style for the Journal and the desired CSS for the HTML version of the parsed article, if you don't want to use our provided CSS. Currently, the plugin is designed to generate new XML/HTML/PDF galleys from the markup server, replacing existing galleys, every time a new review or layout version of a submission is uploaded. This will change in a future version, but for now, be careful not to overwrite existing files if you don't wish to use the markup plugin workflow exclusively.

XML Publishing Document Archive

The following information is provided for archival/informational purposes only.

Lemon8-XML Community Documentation
Citation Mark-Up Assistant Development Roadmap
XML Publishing Roadmap