pressbooks / excalibur Goto Github PK

Description

SWORD V1 uses METS as metadata. We test our plugin against the mets XML Schema Definition.

• https://github.com/pressbooks/excalibur/blob/dev/tests/data/mets.xsd
• https://github.com/pressbooks/excalibur/blob/dev/tests/test-swordv1-packager-metsswap.php

In theory, anything that passes our automated test is supported. Here's an example of someone adding http://purl.org/dc/elements/1.1/relation to their implementation (SWORD V2). We could make similar tweaks to our plugin:

• 4Science/swordappv2-php-library@4da1326

That being said, our experience is that DSPACE is sometimes lacking in what it supports. So trial & error and looking at the DSPACE source code to see what actually works is par for the course.

Prerequisites

Check the boxes below by changing them from [ ] to [x].

• Can you reproduce the behavior you wish to address with all plugins except Pressbooks and this plugin deactivated?
• Are you running the latest version of Pressbooks, the latest version of this plugin and the latest version of WordPress?
• Are you experiencing the issue while using this book theme?
• Did you perform a cursory search to see if your bug or enhancement is already listed?

Description

License data is not submitted into Dspace metadata when the book is exported

Steps to Reproduce

1. Set the license of your book under the Copyright heading in the "Book Info" tab
2. Submit the book to DSpace

Expected behavior: License data is included in the metadata

Actual behavior: License data is missing from the metadata

Prerequisites

Check the boxes below by changing them from [ ] to [x].

• Can you reproduce the behavior you wish to address with all plugins except Pressbooks and this plugin deactivated?
• Are you running the latest version of Pressbooks, the latest version of this plugin and the latest version of WordPress?
• Are you experiencing the issue while using this book theme?
• Did you perform a cursory search to see if your bug or enhancement is already listed?

Description

Make compatible with PB5 Contributors model.

More info: https://pressbooks.org/blog/2018/01/17/pressbooks-5-developer-guide/

Old Asana ticket:

To keep with our "not our license and not managed by composer" convention, we should move https://github.com/pressbooks/excalibur/tree/dev/inc/protocol/swordv1 into: https://github.com/pressbooks/excalibur/tree/dev/symbionts/swordv1

I was looking at this code the other day and this is the unfortunate result of trying to fork a PHP library as a composer depedency, failing, and for some reason (probably because I wanted to use the autoloader, time constraints,) the code ended up here. There's probably a way to use the autoloader even after the code is moved?

Description

This plugin uses SWORD V1 because we had issues with SWORD V2.

• swordapp/swordappv2-php-library#12
• http://www.mail-archive.com/[email protected]/msg00327.html

Investigate the feasibility of SWORD V2 when multipart deposit is fixed (or removed.)

Optionally, investigate doing a POST of an Atom Entry and a PUT of the Media Resource in two distinct HTTP requests over SWORD V2.

The Gruntfile generates README.md from a WordPress standard readme.txt

We should be updating readme.txt then running: yarn run readme to generate an updated README.md

(that way the updater will have access to the changelog etc. as per WP conventions)

Description

See:

• greatislander/travis-releases-test@0.29...master
• https://developer.wordpress.org/cli/commands/dist-archive/

Add the release asset build script to Travis.

Then whenever we tag a version there’s a downloadable release which includes all the Composer dependencies.

Need help from @greatislander

Prerequisites

Check the boxes below by changing them from [ ] to [x].

• Can you reproduce the behavior you wish to address with all plugins except Pressbooks and this plugin deactivated?
• [x ] Are you running the latest version of Pressbooks, the latest version of this plugin and the latest version of WordPress?
• Are you experiencing the issue while using this book theme?
• [x ] Did you perform a cursory search to see if your bug or enhancement is already listed?

Description

When submitting to DSpace unsuccessfully (bad username etc), the escape characters are inserted into the fields, and re-escaped at submission.

For example, if the title is "Bob's Handywork", an unsuccessful submission will change the title to Bob\'s Handywork", and subsequent unsuccessful submissions escape the escape characters which can lead to "Bob\\\'s Handywork", "Bob\\\\\\'s Handywork", and so on

Steps to Reproduce

1. Have an item to submit which contains special characters (single quotes etc) in some of the fields such as the "Title"
2. Unsuccessfully submit to DSpace (bad url, bad credentials)

Expected behavior: Expected that the fields are not modified

Actual behavior: Escape characters are inserted into content which requires a manual correction

Prerequisites

• Can you reproduce the behavior you wish to address with all plugins except Pressbooks and this plugin deactivated?
• Are you running the latest version of Pressbooks, the latest version of this plugin and the latest version of WordPress?
• Are you experiencing the issue while using this book theme?
• Did you perform a cursory search to see if your bug or enhancement is already listed?

Description

DSPACE submission via SWORD. Detailed specifications to follow; should adopt SELF-e submission UX as a basis.

Steps to Reproduce

1. User (with admin credentials for current book) navigates to Publish → Submit to Repository
2. User fills in required information (e.g. authentication), clicks Submit

Expected behavior: Profit!

System Information

Pressbooks: 4.0.0-RC1
WordPress: 4.8
PHP: 7.1

If there is an (ebook) cover in Book Info, include that in the SWORD package.

The image should be called cover.png. It will be loaded as one of the Bitstream files for each item.

Prerequisites

Check the boxes below by changing them from [ ] to [x].

• Can you reproduce the behavior you wish to address with all plugins except Pressbooks and this plugin deactivated?
• Are you running the latest version of Pressbooks, the latest version of this plugin and the latest version of WordPress?
• Are you experiencing the issue while using this book theme?
• Did you perform a cursory search to see if your bug or enhancement is already listed?

Description

Upon successful submission of an item to DSpace, not all of the file formats created in Pressbooks are submitted to DSpace.

Notably absent are formats such as "Pressbooks XML" and "Wordpress XML" (which are labeled as WXR files in the list of exported files in Pressbooks)

Sidenote: This request is from Ryerson University

Steps to Reproduce

1. In Pressbooks, export a Book into desired formats, being sure to check Pressbooks XML and/or WordPress XML
2. Submit the item to DSpace

Expected behavior: All formats are exported to DSpace

Actual behavior: WXR formats are not submitted to DSpace

Description

Per an email from Peggy French on November 26, eCampus Ontario is interested in the following metadata mapping between Pressbooks Book Info & DSpace metadata fields:

Field in Pressbooks	Field in DSpace
Contributing author(s)	dc.contributor.author
Short description	dc.description
Identifier	dc.identifier
Citation	dc.identifier.citation
Editor	dc.contributor.editor
Translator	dc.contributor.translator
Reviewer	dc.contributor.reviewer
Illustrator	dc.contributor.illustrator
Primary subject (THEMA drop down)	dc.subject.classification
Copyright license (from drop down)	dc.rights.license
Keywords	dc.subject.other

Steel & Hugh are meeting with eCampus Ontario on December 18 and can advise on how to proceed with this and other outstanding requests (like #14) at that time. For now, just wanted to capture this message publicly for future reference.