Revision as of 22:55, 17 June 2008

Development Roadmap

Milestone 1 - Private Alpha Release (Q3/Q4 2007)

Release Objectives: Establish a stable initial preview release.

Citation Parser

• Major XML refactor
• Remove NLM-specific generation
• Citation lookup based on UI metadata, not parsed text (eg. PMID)
• Add ParaCite parsing
• Handle embedded URLs and access-dates
• Use author list as (additional?) Pubmed lookup method

Framework

• Integrate Docvert
• More informative upload/parsing messages

Milestone 2 - Public Beta Release (Current - Q2 2008)

Release Objectives: Remove legacy code and provide a stable foundation for beta testing.

Document Parser

• Major XML refactor
• Remove NLM-specific metadata parsing
• Extract section hierarchy

Section Editor

• Enable reordering sections
• Enable delete section
• Change section heading level
• Add/upload new figure

Citation Editor

• Enable delete/reorder citations
• Add new citation

Framework

• Upgrade to CakePHP 1.2 beta
• Per-user accounts and self-signup with captcha (eg. reCaptcha ?)
• Refactor document controller using unbinding
• Basic installer script

Support/Development

• Add source code to PKP CVS system
• Open Bugzilla tracker for issues

XML Export

• Move xref detection into generateOutputXML() & remove NLM schema
• Superscript citation detection and compare to list of references

Milestone 3 - 1.0 Proposed (Q3 2008)

Personalization

• Allow upload of custom XSL/CSS for preview/export
• Set default metadata values (eg. copyright statement)

Document Parser

• UI to present user with content that is left unparsed

XML Export

• XML pre-validation
• Add Docbook DTD export schema
• NLM: metadata generation w/full aff linking
• NLM: Improve figure/abstract/list transformation
• NLM: Add figures/tables to xref detection
• NLM: Integrate feedback from Open Medicine

Framework

• Convert incoming HTML entities in content into UTF-8
• Refactor to add plugin classes: lookup, export, import, metadata schema

Reported Bugs

• References with ndash don't get parsed: e.g., [1–6] will not get parsed, but [1-6] will.
• A large amount of text gets missed in some documents (Peter Sefton)
• Conflict of interest does not get sent to <back> matter
• Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
• Does not gracefully deal with "et al"
• Adding author or affiliation goes to error screen
• Extraneous "Aff1" with nothing attached to it - on first author.
• Affiliations are numbered by their metadatas ID, not by their sequence.
• Occasionally random "<name name-style="western">" appear when an article has many, many authors
• Does not properly output "et al" for citations with more than X authors (6?) (in HTML)
• Does not at all output <publisher-loc> or <publisher-name>

Proposed for Future Release

Metadata Editor

• Enable multiple article ID
• Add primary author selector / role-aff association
• Add acknowledgements, reviewers, review dates, etc.
• Create markup for abstract sections in XHTML
• Enable collapsable sections (authors, affiliations, etc)

Section Editor

• Enable collapsable sections
• Add/paste/edit XHTML tables and sections (TinyMCE)

Citation Editor

• Lookup/parse UI consistency
• Citation types and elements mapped to NLM?
• Refactor UI using AJAX and JSON-type methods

HTML/PDF Preview

• Investigate move to DOMPDF from FOP
• Improve PDF XSL (as per OJS development)
• Tweak XHTML stylesheets for tables/figures

XML Export

• Integrate Pubmed Central Style Checker / Article Previewer
• Add Erudit DTD export schema
• Add initial Scribus 1.5 DTD export schema

Framework

• Add form data validation
• Better error/warning messages (eg. citations, required fields, etc.)
• Full I18n and L10n to French, Spanish

Tutorials

Five steps to an XML document