Difference between revisions of "Lemon8-XML Roadmap"

From PKP Wiki
Jump to: navigation, search
Line 35: Line 35:
 
* <s>Enable reordering sections</s>
 
* <s>Enable reordering sections</s>
 
* <s>Enable delete section</s>
 
* <s>Enable delete section</s>
−
* Change section heading level
 
−
* Add/upload new figure
 
  
 
'''<big>Citation Editor</big>'''
 
'''<big>Citation Editor</big>'''
Line 42: Line 40:
 
* <s>Enable delete/reorder citations</s>
 
* <s>Enable delete/reorder citations</s>
 
* <s>Add new citation</s>
 
* <s>Add new citation</s>
 +
 +
'''<big>XML Export</big>'''
 +
 +
* <s>Move xref detection into generateOutputXML() & remove NLM schema</s>
 +
* <s>Superscript citation detection and compare to list of references</s>
  
 
'''<big>Framework</big>'''
 
'''<big>Framework</big>'''
Line 47: Line 50:
 
* <s>Upgrade to [http://www.cakephp.org/ CakePHP] 1.2 beta</s>
 
* <s>Upgrade to [http://www.cakephp.org/ CakePHP] 1.2 beta</s>
 
* <s>Refactor document controller using unbinding</s>
 
* <s>Refactor document controller using unbinding</s>
−
* Per-user accounts and self-signup with captcha (eg. [http://recaptcha.net/ reCaptcha] ?)
 
 
* Basic installer script
 
* Basic installer script
  
Line 54: Line 56:
 
* Add source code to PKP CVS system
 
* Add source code to PKP CVS system
 
* Open Bugzilla tracker for issues
 
* Open Bugzilla tracker for issues
−
 
−
'''<big>XML Export</big>'''
 
−
 
−
* <s>Move xref detection into generateOutputXML() & remove NLM schema</s>
 
−
* <s>Superscript citation detection and compare to list of references</s>
 
  
  
Line 71: Line 68:
  
 
* UI to present user with content that is left unparsed
 
* UI to present user with content that is left unparsed
 +
 +
'''<big>Section Editor</big>'''
 +
 +
* Change section heading level
 +
* Add/upload new figure
  
 
'''<big>XML Export</big>'''
 
'''<big>XML Export</big>'''
Line 83: Line 85:
 
'''<big>Framework</big>'''
 
'''<big>Framework</big>'''
  
 +
* Per-user accounts and self-signup with captcha (eg. [http://recaptcha.net/ reCaptcha] ?)
 
* Convert incoming HTML entities in content into UTF-8
 
* Convert incoming HTML entities in content into UTF-8
 
* Refactor to add plugin classes: lookup, export, import, metadata schema
 
* Refactor to add plugin classes: lookup, export, import, metadata schema
Line 91: Line 94:
 
* <s>A large amount of text gets missed in some documents (Peter Sefton)</s>
 
* <s>A large amount of text gets missed in some documents (Peter Sefton)</s>
 
* <s>Conflict of interest does not get sent to <back> matter</s>
 
* <s>Conflict of interest does not get sent to <back> matter</s>
 +
* <s>Adding author or affiliation goes to error screen</s>
 +
* <s>Affiliations are numbered by their metadatas ID, not by their sequence.</s>
 +
* <s>Does not gracefully deal with "et al" (more info needed)</s>
 
* Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
 
* 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.
 
* 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
 
* 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 properly output "et al" for citations with more than X authors (6?) (in HTML)

Revision as of 09:12, 18 June 2008

Contents

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

Citation Editor

  • Enable delete/reorder citations
  • Add new citation

XML Export

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

Framework

  • Upgrade to CakePHP 1.2 beta
  • Refactor document controller using unbinding
  • 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)

Document Parser

  • UI to present user with content that is left unparsed

Section Editor

  • Change section heading level
  • Add/upload new figure

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

  • Per-user accounts and self-signup with captcha (eg. reCaptcha ?)
  • 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
  • Adding author or affiliation goes to error screen
  • Affiliations are numbered by their metadatas ID, not by their sequence.
  • Does not gracefully deal with "et al" (more info needed)
  • Parser does not find a title in a .odt when it is in the document properties (Peter Sefton)
  • Extraneous "Aff1" with nothing attached to it - on first author.
  • 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

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

Retrieved from "http://pkp-www.lib.sfu.ca:8084/wiki/index.php?title=Lemon8-XML_Roadmap&oldid=328"
Personal tools