Difference between revisions of "Lemon8-XML Roadmap"

From PKP Wiki
Jump to: navigation, search
Line 21: Line 21:
  
  
==Milestone 2 - 1.0 Public Beta Release ('''Current - Q2 2008''')==
+
==Milestone 2 - Public Beta Release ('''Current - Q2 2008''')==
  
 
'''<big>Release Objectives:</big>''' Remove legacy code and provide a stable foundation for beta testing.
 
'''<big>Release Objectives:</big>''' Remove legacy code and provide a stable foundation for beta testing.
Line 44: Line 44:
  
 
* Per-user accounts and self-signup with [http://recaptcha.net/ reCaptcha]
 
* Per-user accounts and self-signup with [http://recaptcha.net/ reCaptcha]
* Upgrade to [http://www.cakephp.org/ CakePHP] 1.2  
+
* Upgrade to [http://www.cakephp.org/ CakePHP] 1.2 beta
 
* Convert incoming HTML entities in content into UTF-8
 
* Convert incoming HTML entities in content into UTF-8
 
* Basic installer script
 
* Basic installer script
Line 54: Line 54:
  
  
==Milestone 3 - 1.1 Proposed (Q3 2008)==
+
==Milestone 3 - 1.0 Proposed (Q3 2008)==
  
 
'''<big>Personalization</big>'''
 
'''<big>Personalization</big>'''
Line 67: Line 67:
 
* Add Docbook DTD export schema
 
* Add Docbook DTD export schema
 
* Add initial [http://www.scribus.net/ Scribus] 1.5 DTD export schema
 
* Add initial [http://www.scribus.net/ Scribus] 1.5 DTD export schema
 +
 +
'''<big>Reported Bugs</big>'''
 +
 +
* References with ndash don't get parsed: e.g., [1–6] will not get parsed, but [1-6] will.
 +
* Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
 +
* <s>A large amount of text gets missed in some documents (Peter Sefton)</s>
 +
* 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.
 +
* Conflict of interest does not get sent to <back> matter
 +
* 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>
  
  
Line 107: Line 121:
 
* Better error/warning messages (eg. citations, required fields, etc.)
 
* Better error/warning messages (eg. citations, required fields, etc.)
 
* Full I18n and L10n to French, Spanish ('''partially complete''')
 
* Full I18n and L10n to French, Spanish ('''partially complete''')
 
 
==Reported Bugs==
 
 
* References with ndash don't get parsed: e.g., [1–6] will not get parsed, but [1-6] will.
 
* Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
 
* A large amount of text gets missed in some documents (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.
 
* Conflict of interest does not get sent to <back> matter
 
* 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>
 
  
  
 
=Tutorials=
 
=Tutorials=
 
===[[Five steps to an XML document]]===
 
===[[Five steps to an XML document]]===

Revision as of 20:16, 28 April 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 generation and classes
  • Extract section hierarchy

Section Editor

  • Correct reordering and heading level
  • Enable delete section
  • Add/upload new figure

Citation Editor

  • Enable add/delete/reorder citations

Framework

  • Per-user accounts and self-signup with reCaptcha
  • Upgrade to CakePHP 1.2 beta
  • Convert incoming HTML entities in content into UTF-8
  • Basic installer script

Support/Development

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


Milestone 3 - 1.0 Proposed (Q3 2008)

Personalization

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

XML Export

  • Move xref detection into generateOutputXML() & remove NLM schema; add superscript detection and compare to list of references
  • XML pre-validation
  • Add Docbook DTD export schema
  • Add initial Scribus 1.5 DTD export schema

Reported Bugs

  • References with ndash don't get parsed: e.g., [1–6] will not get parsed, but [1-6] will.
  • Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
  • A large amount of text gets missed in some documents (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.
  • Conflict of interest does not get sent to <back> matter
  • 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

  • Add/paste/edit XHTML table

Citation Editor

  • Lookup/parse UI consistency
  • Citation types and elements mapped to NLM

HTML/PDF Preview

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

XML Export

  • NLM-XML metadata generation w/full aff linking
  • Integrate Pubmed Central Style Checker / Article Previewer and feedback
  • Improve figure/abstract/list transformation
  • Add figures/tables to xref detection
  • Add Erudit DTD export schema

Framework

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


Tutorials

Five steps to an XML document