diff --git a/doc/release-notes/5962-signposting.md b/doc/release-notes/5962-signposting.md new file mode 100644 index 00000000000..a08be844cc2 --- /dev/null +++ b/doc/release-notes/5962-signposting.md @@ -0,0 +1,43 @@ +# Signposting for DV 5.5 + +This branch adds [Signposting](https://signposting.org/) support to DV 5.5. + +There are 2 Signposting profile levels, level 1 and level 2. In this implementation, + * level 1 links are shown in +HTTP header, which can be fetched by `curl -I https://domain/link-to-article`. + * The level 2 linkset can be fetched by visiting the dedicated linkset page for + that artifact. The link can be seen in level 1 links with key name `rel="linkset"`. + +The configuration is stored as JSON string in the `Bundle.properties` file, key name is +`signposting.configuration.SignpostingConf`. Please see a sample configuration below with explaination for each of the +config items. + +```json +{ + "license": { + "CC0": "https://creativecommons.org/licenses/cc0/" + }, + "describedby": { + "doi": "https://doi.org/", + "type": "application/vnd.citationstyles.csl+json" + }, + "useDefaultFileType": true, + "defaultFileTypeValue": "https://schema.org/Dataset", + "maxItems": 5, + "maxAuthors": 5 +} +``` + + * The `license` is a `dict` contains the URI for `CC0`. Please be noted that this is a +temporary solution as all the licenses should be given by `multi-license` support once it's merged. + * `describedby` is required by [Signposting](https://signposting.org/). It shows the link to the metadata +which describes the resources that is the origin of the link. + * `useDefaultFileType` and `defaultFileTypeValue` are used in combination to provide extra `Dataset` type to DV + datasets. `AboutPage` is required by `Signposting`, hence always present in the datasets. Whilst a second type + could be configured to better reflect the actual scholarly type of the dataset. + * `maxItems` sets the max number of items/files which will be shown in `level 1` profile. Datasets with + too many files will not show any file link in `level 1` profile. They will be shown in `level 2` linkset only. + * `maxAuthors` Same with `maxItems`, `maxAuthors` sets the max number of authors to be shown in `level 1` profile. +If amount of authors exceeds this value, no link of authors will be shown in `level 1` profile. + +Note: Authors without author link will not be counted nor shown in any profile/linkset. \ No newline at end of file diff --git a/pom.xml b/pom.xml index ca2d3570956..a2e4e96313d 100644 --- a/pom.xml +++ b/pom.xml @@ -675,12 +675,12 @@ - - + + diff --git a/src/main/webapp/datasetFieldForEditFragment.xhtml b/src/main/webapp/datasetFieldForEditFragment.xhtml index 271904e6a31..0af08523d3f 100644 --- a/src/main/webapp/datasetFieldForEditFragment.xhtml +++ b/src/main/webapp/datasetFieldForEditFragment.xhtml @@ -1,17 +1,15 @@ - - - - - - + + + - + or dsfv.datasetField.datasetFieldType.fieldType == 'EMAIL' + )}"/> + + - - - + rendered="#{dsfv.datasetField.datasetFieldType.fieldType == 'TEXTBOX'}" /> + + +
#{dsfv.datasetField.validationMessage}
@@ -37,16 +38,15 @@ - - -
\ No newline at end of file +