Skip to content

ToDoList

Wendell Piez edited this page Feb 29, 2016 · 28 revisions

The main branch of JATSKit is a stable copy of the oXygen framework as of late 2015.

In the develop branch, the framework is being updated to cover current versions of JATS and BITS (not quite yet released as of this writing) while extending its functionalities in e.g. authoring or preview/proof generation. For example, producing EPUB versions of BITS books or JATS articles.

This punchlist describes current work in the develop branch.

  • Prioritize among the following!

  • Update DTDs to current

    • Blue 1.1, Orange 1.1, Book 2.0
    • Extend catalog with docs on further extension (was able to use provided catalogs)
    • Migrate new file templates and samples to new FPIs
    • Update framework document type bindings (FPIs?)
    • Extension framework for BITS (over/above JATS)
    • Document how to make an extension framework for other species of NLM
    • confirm sample file validity to new DTDs
    • Update element content completion support for new DTDs (styleguide directory )
  • Document how to add your own DTDs, XSLTs, CSSs to (a copy of) the framework

  • Schematron to check for version and warn when (article|book)/@dtd-version is unexpected

    • Collect requirements for a "best practice" Schematron (e.g. migrating @pub-type etc.)?
  • Update / rename oXygenJATSframework.xml as jatskit.xml

  • Framework signature to avoid oXygen warning popup when installing?

  • Finish framing out ebook mockup / EPUB apparatus incl ToC, metadata, colophon

    • extend for JATS articles (singly or in groups?) - bind them to book-parts?
    • final testing / smoothing
  • Confirm the kit is ready for testing outside any oXygen project

    • Migrate project transformation scenarios to framework
    • Test
  • jatskit-html.xsl (or whatever it is) extending jats-preview.xsl to handle BITS (single page)

    • Wire project to use this stylesheet (JATS will fall through it).
    • Provide project with Transformation Scenarios to call it in both 'warning' and 'no warning' modes.
    • Test default scenarios for JATS and BITS samples valid to new DTDs
  • jatskit-split.xsl

    • Build and test multi-level book-part splitting
    • XSLT to produce links to nested book-parts? (Or silently drop, expecting navigation features to work.)
    • Test all navigation including in ebook mockup display
    • More testing of all these!
    • Also map in JATS documents to BITS (a book with one book-part)
  • Element coverage assessment (when DTDs are ready)

    • Insert XProc event log pipeline?
      • Normalize stylesheet will strip this stuff out, while it is siphoned elsewhere
    • Systematically test various element sets (metadata, inline, block level, figures / tables)
  • Update docs including XML samples

  • Assemble (and test) a broad representation of sample files?

  • CSS

    • One-page HTML using JATS-preview XSLT
    • Web site XHTML
    • Inside EPUB
    • Book apparatus as well as contents
  • EPUB XSLT

    • Extend to handle JATS not only BITS (map JATS into BITS with single book-part)
  • EPUB book cover? SVG?

  • XSL-FO for BITS

  • MathML3

    • XSL-FO via AH
    • MathJax call for browsers?
    • EPUB options?
    • MathML2 > MathML3 filter/stub? pass through either/both?
  • Further oXygen UI enhancements. Possibles:

    • Buttons to insert block-level elements of various kinds including lists
    • Same for (some) inline elements
    • Insert graphics and figures, with widgets for image selection
    • Support for editing tables -- JATS (HTML) tables and/or OASIS tables depending on ... DTD?
    • More Schematron / QuickFix
  • More templates / schematron? E.g., JATS4R?

  • Keep in mind that all this could amount to more than a single full-time job

What functionalities are available in other frameworks that would be good to have?

[ ] Towards release - merge develop branch into master; update wiki and docs

Clone this wiki locally