Skip to content

add edition and thesis fields #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Binary file modified docs/operate/customize/metadata/imgs/pub_info_deposit_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/operate/customize/metadata/imgs/pub_info_landing_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/operate/customize/metadata/optional_fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ MEETING_CUSTOM_FIELDS_UI["hide_from_landing_page"] = True

You'll need to initialize the field by typing `pipenv run invenio rdm-records custom-fields init`. Restart your instance, and you should see the fields appear in the deposit form like:

![Optional field result (deposit form)](../imgs/custom_fields_example_deposit_form.png)
![Optional field result (deposit form)](./imgs/pub_info_deposit_form.png)

and the landing page should look like:

![Optional field result (landing page)](../imgs/custom_fields_example_landing_page.png)
![Optional field result (landing page)](./imgs/pub_info_landing_page.png)
14 changes: 9 additions & 5 deletions docs/operate/customize/metadata/optional_metadata.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# List of optional metadata fields

_Introduced in InvenioRDM v12_

The following document is a reference guide for the instance-level optional metadata fields available in InvenioRDM.

!!!tip "How to add a field to an instance?"
Expand All @@ -19,7 +17,7 @@ This group of fields contains the metadata for "Journal", "Imprint" and "Thesis"

![Landing page](./imgs/pub_info_landing_page.png)

Publishing information is typically displayed in the section "Details", on the right side bar, under "Published in", "Imprint", or "Awarding university".
Publishing information is typically displayed in the section "Details", on the right side bar, under "Published in", "Imprint", or "Thesis".

### Journal

Expand All @@ -43,14 +41,20 @@ This nested field implements an imprint's metadata. It can be used to describe a
- **isbn** `ISBN`(defined by [idutils](https://github.com/inveniosoftware/idutils/blob/10b05b702b06e93f02774426df59a217035b1cee/idutils/__init__.py#L400)): The book's International Standard Book Number. Applies if the imprint is a book.
- **place** `String`: Location where the book (or report) was published.
- **pages** `String`: The pages within the book or report. It can be a number or a range in any format.
- **edition** `String`: The edition of a book or report. (added in v13)

### Thesis

This field implements thesis metadata, more specifically an awarding university. A thesis supervisor can be found in the list of contributors whose role is "Supervisor".
This field implements thesis metadata. A thesis supervisor can be found in the list of contributors whose role is "Supervisor".

**Metadata**

- **university**: Name of the awarding university.
- **university** `String`: Name of the awarding university.
- **department** `String`: Department which awarded the thesis. (added in v13)
- **type** `String`: The type of thesis (e.g. Masters, PhD, Engineers, Bachelors). (added in v13)
- **date_submitted** `Date`: Date when the thesis was submitted. (added in v13)
- **date_defended** `Date`: Date when the thesis was defended. (added in v13)


## Meeting

Expand Down
10 changes: 8 additions & 2 deletions docs/releases/v13/version-v13.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,15 @@ DOIs can now be configured as optional. Describe the feature.

Administrators can compare revisions from the administration panel.

### Thesis
### New Metadata Fields

Anything to mention?
These is a new field called copyright for copyright information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These is a new field called copyright for copyright information
There is a new field called copyright for copyright information


These are new thesis metadata fields including department, type,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These are new thesis metadata fields including department, type,
There are new thesis metadata fields including department, type,

date_submitted, date_defended. thesis:university had been moved to
university inside of the thesis:thesis section, alongside the other new fields.

There is a new edition field under imprint.

### Requests sharing

Expand Down