platform-coop-toolkit / coop-library-framework Goto Github PK

Is your feature request related to a problem? Please describe.

Users should be able to submit resources.

Describe the solution you'd like

A public-facing user submission form should allow resources to be submitted as "Pending", and should notify site administrators.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

Is your feature request related to a problem? Please describe.

Some custom fields (metadata) need to be translated; some don't and should just be synchronized (see: https://polylang.pro/doc/synchronize-metadatas-between-translations/). Polylang allows developers to use a filter to control which post meta is copied and which isn't: https://polylang.pro/doc/filter-reference/#pll_copy_post_metas

Describe the solution you'd like

Metadata which do not require translation should be copied between translated resources; metadata which requires translation should be excluded.

Describe the bug
String location references in languages/learning-commons-framework.pot do not reference the correct locations in functions/metadata.php.

To Reproduce
Example languages/learning-commons-framework.pot:89:

#: includes/functions/core.php:161
msgid "Are you sure you want to remove this revision?"

Expected behavior
Example languages/learning-commons-framework.pot:89:

#: includes/functions/metadata.php:238
msgid "Are you sure you want to remove this revision?"

Changed core.php:161 to metadata.php:238.

Is your feature request related to a problem? Please describe.
Resource titles should not be an optional field.

Describe the solution you'd like
Titles should be validated as required fields.

Describe alternatives you've considered
Not applicable.

Additional context
Not applicable.

Is your feature request related to a problem? Please describe.

Required fields should be validated on form submission.

Describe the solution you'd like

When the user tries to save a resource with missing (required) information, they should be alerted as to what information is missing and the form submission should be halted.

Describe alternatives you've considered

Not applicable.

Additional context

See:

• https://www.tenon-ui.info/forms-full-demo
• https://github.com/CMB2/CMB2-Snippet-Library/blob/master/javascript/cmb2-js-validation-required.php

Describe the bug
When submitting a resource with an error (i.e. a missing publication year, or invalid URL for Publisher link), causes the Permanent Link field will become highlighted in red (as though it has an error) even though the value of the permanent link field may be valid.

To Reproduce
Steps to reproduce the behaviour:

1. Add a new resource
2. Fill in the Permanent Link field with a valid URL (i.e. google.com).
3. Leave Publication year blank, or fill in foo for Publisher Link.
4. Submit the form.
5. Notice an error message appears for the publication year, and the Permanent Link field is highlighted in red.

Expected behaviour
If there are errors on the form, and the Permanent Link field is valid, then the Permanent Link field should not appear with error highlighting.

Desktop (please complete the following information):

• OS: Windows 10
• Browser Firefox
• Version 69.0.3

Is your feature request related to a problem? Please describe.

Currently, required fields are validated on form submission but they should be labelled as such prior to form validation.

Describe the solution you'd like

Add (Required) after the label of each required field.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

Is your feature request related to a problem? Please describe.

It would be great to rewrite search URLs.

Describe the solution you'd like

https://wordpress.org/plugins/nice-search/

Describe alternatives you've considered

Custom thing?

Additional context

Not applicable

Is your feature request related to a problem? Please describe.

Not all resources have a publication date with day and month. Some just have a publication year. Currently, publication date is a required field, so this doesn't work.

Describe the solution you'd like

The publication year field should be required and the publication date field should be replace with optional publication month and day fields.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

Is your feature request related to a problem? Please describe.

With expanded resource metadata, the resource editing view can be a bit overwhelming.

Describe the solution you'd like

We should review the resource metadata and regroup them to facilitate easier data entry.

Describe alternatives you've considered

Not applicable.

Additional context

Is your feature request related to a problem? Please describe.

No

Describe the solution you'd like

the Goals section is the only one that does not have the ability to have a Parent Goal and a Sub Goal, which is now needed - Thanks!

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

With the ACF URL field, it requires http:// or 'https://`, otherwise the form will not validate and an error is shown. This can be confusing as the URLs may be "valid" and the instructions do not indicate the necessary formatting.

Describe the solution you'd like

Preferred solution is to add http:// or https:// if it is missing from the input upon form submission.

Easy solution, but more of a burden for the user, is to update the description string to indicate that https:// or http:// prefix is required. The resulting error message should also display a helpful instruction as well.

Is your feature request related to a problem? Please describe.

Many current resources include DOI, ISBN, or ISSN identifiers. These need to be preserved when importing the resources.

Describe the solution you'd like

We need fields for these identifiers, ideally with format validation.

Describe alternatives you've considered

Fields could be added at a later date as long as the identifiers are added to the resource metadata.

Additional context

• https://www.doi.org/
• https://en.wikipedia.org/wiki/International_Standard_Book_Number
• https://en.wikipedia.org/wiki/International_Standard_Serial_Number

Describe the bug
Text fields with URL validation does not catch improperly formed URLs.

To Reproduce
Steps to reproduce the behavior:

1. Add a new resource and enter the required info (so you can submit the form in step 3).
2. Add "http://foo" or "http://foo-" as a Publisher Link
3. Submit the resource.
4. Notice that the invalid URL is saved.

Expected behavior
Expect an error message to be presented upon submission of the form, and on blur of the URL input field.

Desktop (please complete the following information):

• OS: Windows 10
• Browser Firefox
• Version 69.0.1

72 characters, please!

Describe the bug
When adding or editing a Resource, form validation does not catch invalid date input. Two digit year values has '20' prepended, and invalid month and day values are accepted.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'Resources > Add new'
2. Enter a valid URL into the Permanent Link field.
3. In the Publication Date field, enter 22-22-33.
4. Then save the form.

Expected behavior
An error message should be displayed for a date that does not follow the YYYY-MM-DD format, and the submission rejected.

Desktop (please complete the following information):

• OS: Windows 10
• Browser: Firefox
• Version 68.0.2

Is your feature request related to a problem? Please describe.

As described in platform-coop-toolkit/coop-library#168, some tags (goals and topics) need to be put in a custom order.

Describe the solution you'd like

Allow users to manage the order of these tags using term meta.

Describe alternatives you've considered

Not applicable.

Additional context

• https://github.com/CMB2/CMB2/wiki/Box-Properties#object_types
• https://generatewp.com/bringing-quick-edit-support-taxonomies

Describe the bug

Searching for "Up&Go" does not return the relevant resource (titled "Case Study: Up&Go").

To Reproduce

Steps to reproduce the behavior:

1. Enter "Up&Go" as the search query.
2. Perform a search.
3. No results are returned.

Expected behavior

The resource with matching title should be shown.

Additional Context

This only appears to occur with this particular string which suggests that the issue is related to the ampersand in the text.

Is your feature request related to a problem? Please describe.
The Resource form should have an input field where Perma.cc or Archive.org resource links can be specified as a way of adding an archive version of the resource to combat 'link rot'.

Describe the solution you'd like
An input field where one or more Perma.cc or Archive.org links can be specified. Since Perma.cc and Archive.org saves only 1 page per URL (i.e. the services do not crawl pages), multiple Perma.cc and Archive.org links may be required to capture the content of the original source if the original source spans multiple pages / URLs.

URLs should be validated to make sure they are Archive.org or Perma.cc domains.

Should also be able to add, remove, edit URLs for the resource.

Additional context
See this wiki page for additional background information on Perma.cc and Archive.org usage / integration: https://wiki.fluidproject.org/display/fluid/Resource+preservation+research

Is your feature request related to a problem? Please describe.

Currently the readme is still just original content from 10up/plugin-scaffold.

Describe the solution you'd like

We should replace it with this plugin's readme, ideally using the same method found in platform-coop-toolkit/pcc-framework.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

• *Author(s): string, multiple, ordered
• Editor(s): string, multiple, ordered
• Translator(s): string, multiple, ordered; associated with translations
• *Publication Date: datetime
• Revision Date(s): datetime, multiple (with revision description: string)
• Publisher Name: string
• Publisher Link: url string
• Publisher Locality: string
• *Abstract: rich text string
• *Permanent Link: url string

*Required.

Is your feature request related to a problem? Please describe.

For resources with long titles, having a short title field would be helpful to allow a more concise display (e.g. on card views).

Describe the solution you'd like

A new (optional) field called Short Title.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

Uses: https://packagist.org/packages/umpirsky/country-list

Describe the bug
Blank repeater fields are not properly ignored if blank. Specifically:

• Authors, editors, or translators - any blank repeater field is submitted as an empty string and appears in the rendered output.
• Perma.cc and Archive.org links - blank repeater fields are validated and throw errors.

To Reproduce
Steps to reproduce the behavior:

1. Create a new resource.
2. Fill in the required fields (title etc.).
3. Add an author, and 2 blank authors.
4. Add 2 or 3 blank editors and translators.
5. Publish the resource.
6. Notice that the blank values for author, editor, and translator are preserved.
7. Notice that when viewing the resource empty authors appear in the byline.
8. Edit the same resource.
9. Add blank perma.cc and archive.org links.
10. Update the resource.
11. Notice that validation errors are produced for the fields.

Expected behavior
Any empty repeater field should be ignored (i.e. not validated) and not submitted as part of the Resource metadata.

Desktop (please complete the following information):

• OS: Windows 10
• Browser Firefox

Is your feature request related to a problem? Please describe.
Publications (e.g. a magazine or journal) are distinct from publishers (e.g. a media company or a university press). Many resources already reflect this.

Describe the solution you'd like
We need an optional field for the publication name as distinct from the publisher name.

Describe alternatives you've considered
Not applicable.

Additional context
Not applicable.

Is your feature request related to a problem? Please describe.

Translation files need to be updated automatically.

Describe the solution you'd like

Every time a commit is made to the dev branch, a GitHub Action should be run to regenerate translation files.

Describe alternatives you've considered

Not applicable.

Additional context

Based on https://github.com/varunsridharan/action-wp-pot-generator?

Is your feature request related to a problem? Please describe.

ACF Pro provides built-in validation and will be easier to maintain.

Describe the solution you'd like

Migrate existing custom fields from CMB2 to ACF Pro.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.

Is your feature request related to a problem? Please describe.
We can't assume that resources with no rights supplied are "All Rights Reserved".

Describe the solution you'd like
The default option for Rights should be "Unspecified".

Describe alternatives you've considered
We currently assume that resources with no rights supplied are "All Rights Reserved", which is a flawed assumption.

Additional context
Not applicable.

Is your feature request related to a problem? Please describe.
We need to establish server-side methods for handling faceted queries. These will be used for resource discovery via the front-end.

Describe the solution you'd like
Faceted queries need to accommodate:

• Goal
• Topic
• Sector
• Format

Furthermore, they need to prioritize by language as specified by the user.

Describe alternatives you've considered
Not applicable.

Additional context
See:

• https://facetwp.com/

Is your feature request related to a problem? Please describe.

The abstract (resource content) field allows all HTML tags supported by the WordPress classic editor. This causes weird formatting in some circumstances.

Describe the solution you'd like

We should filter the allowed tags, restricting them to:

• <p>
• <em>
• <strong>
• <a> (with href and rel attributes)
• <blockquote>
• <cite>
• <ul>, <ol>, and <li>

We should also modify the toolbar to remove all buttons for markup that we don't want added.

Describe alternatives you've considered

Not applicable.

Additional context

Not applicable.