Difference between revisions of "Lemon8-XML Roadmap"
From PKP Wiki
| Line 34: | Line 34: | ||
* <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 | * Add/upload new figure | ||
'''<big>Citation Editor</big>''' | '''<big>Citation Editor</big>''' | ||
| − | * <s>Enable | + | * <s>Enable delete/reorder citations</s> |
| + | * Add new citation | ||
'''<big>Framework</big>''' | '''<big>Framework</big>''' | ||
| − | |||
* <s>Upgrade to [http://www.cakephp.org/ CakePHP] 1.2 beta</s> | * <s>Upgrade to [http://www.cakephp.org/ CakePHP] 1.2 beta</s> | ||
| + | * 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 document controller using unbinding | ||
* Basic installer script | * Basic installer script | ||
| Line 61: | Line 63: | ||
* Allow upload of custom XSL/CSS for preview/export | * Allow upload of custom XSL/CSS for preview/export | ||
* Set default metadata values (eg. copyright statement) | * Set default metadata values (eg. copyright statement) | ||
| + | |||
| + | '''<big>Document Parser</big>''' | ||
| + | |||
| + | * "Garbage collection" of content that is left unparsed | ||
'''<big>XML Export</big>''' | '''<big>XML Export</big>''' | ||
| Line 67: | Line 73: | ||
* XML pre-validation | * XML pre-validation | ||
* Add Docbook DTD export schema | * Add Docbook DTD export schema | ||
| − | * | + | |
| + | '''<big>Framework</big>''' | ||
| + | |||
| + | * Refactor to add plugin classes: lookup, export, import, metadata schema | ||
'''<big>Reported Bugs</big>''' | '''<big>Reported Bugs</big>''' | ||
| + | * <s>References with ndash don't get parsed: e.g., [1–6] will not get parsed, but [1-6] will.</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> | ||
* 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" | * Does not gracefully deal with "et al" | ||
| Line 76: | Line 88: | ||
* 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. | * 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) | ||
* Does not at all output <publisher-loc> or <publisher-name> | * Does not at all output <publisher-loc> or <publisher-name> | ||
| − | |||
| − | |||
| Line 92: | Line 101: | ||
* Add acknowledgements, reviewers, review dates, etc. | * Add acknowledgements, reviewers, review dates, etc. | ||
* Create markup for abstract sections in XHTML | * Create markup for abstract sections in XHTML | ||
| − | * | + | * Enable collapsable sections (authors, affiliations, etc) |
'''<big>Section Editor</big>''' | '''<big>Section Editor</big>''' | ||
| − | * Add/paste/edit XHTML | + | * Enable collapsable sections |
| + | * Add/paste/edit XHTML tables and sections (TinyMCE) | ||
'''<big>Citation Editor</big>''' | '''<big>Citation Editor</big>''' | ||
| Line 111: | Line 121: | ||
'''<big>XML Export</big>''' | '''<big>XML Export</big>''' | ||
| − | + | * Integrate Pubmed Central [http://www.pubmedcentral.nih.gov/about/PMC_Utilities.html Style Checker / Article Previewer] and feedback from Open Medicine | |
| − | * Integrate Pubmed Central [http://www.pubmedcentral.nih.gov/about/PMC_Utilities.html Style Checker / Article Previewer] and feedback | + | * NLM: metadata generation w/full aff linking |
| − | * Improve figure/abstract/list transformation | + | * NLM: Improve figure/abstract/list transformation |
| − | * Add figures/tables to xref detection | + | * NLM: Add figures/tables to xref detection |
* Add Erudit DTD export schema | * Add Erudit DTD export schema | ||
| + | * Add initial [http://www.scribus.net/ Scribus] 1.5 DTD export schema | ||
'''<big>Framework</big>''' | '''<big>Framework</big>''' | ||
| Line 121: | Line 132: | ||
* Add form data validation | * Add form data validation | ||
* 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 | + | * Full I18n and L10n to French, Spanish |
=Tutorials= | =Tutorials= | ||
===[[Five steps to an XML document]]=== | ===[[Five steps to an XML document]]=== | ||
Revision as of 16:30, 9 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 URLsand 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 ?)
- Convert incoming HTML entities in content into UTF-8
- 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
- "Garbage collection" of content that is left unparsed
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
Framework
- 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
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 and feedback from Open Medicine
- NLM: metadata generation w/full aff linking
- NLM: Improve figure/abstract/list transformation
- NLM: Add figures/tables to xref detection
- 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
