Contents:
The default metadata schema for InvenioRDM records is defined in the invenio-rdm-records package and documented here. It also includes a number of optional metadata fields which have been enabled in KCWorks, documented here.
Beyond these InvenioRDM fields, KCWorks adds a number of custom metadata fields to the schema using InvenioRDM’s custom field mechanism. These are all located in the top-level custom_fields field of the record metadata. They are prefixed with two different namespaces:
kcr: custom fields that are used to store data from the KC system. These fields may be used for new data, but are not required.
hclegacy: custom fields that are used to store data from the legacy CORE repository. These fields must not be used for new data.
What follows is an example of a complete metadata record (JSON object) used to create a KCWorks record. The various fields and their possible values are described in the sections below.
Note that no single actual record would include all of these fields. The example is provided to illustrate the structure of the metadata record and the sort of values that are valid for each field.
{
@@ -497,29 +499,102 @@ Example JSON record
+JSON object retrieved from the record API¶
+The JSON object retrieved from the record API shares the same basic structure as the JSON object used to create the record, except that it includes a number of additional fields. Some properties are also filled out with additional details (e.g., readable titles for licenses, etc.)
+
+
Controlled Vocabularies¶
Subject headings¶
FAST¶
-The FAST controlled vocabulary (https://www.oclc.org/research/areas/data-science/fast.html) is used for the subjects field.
+The FAST controlled vocabulary (https://www.oclc.org/research/areas/data-science/fast.html) is used for the subjects field. See the metadata.subjects section for more information about how to include FAST subjects in a KCWorks record.
Homosaurus¶
-The FAST vocabulary is augmented in KCWorks by the Homosaurus vocabulary (https://homosaurus.org/) for subjects related to sexuality and gender identity.
+The FAST vocabulary is augmented in KCWorks by the Homosaurus vocabulary (https://homosaurus.org/) for subjects related to sexuality and gender identity. See the metadata.subjects section for information about how to include Homosaurus subjects in a KCWorks record.
+
+
+Resource types¶
+
+
+Creator/contributor roles¶
+
+
+
+
+Identifier Schemes¶
+
+Works¶
+
+DOI¶
+KCWorks (and InvenioRDM) supports the DOI identifier scheme to identify works in the repository. Note that two DOIs are minted for each KCWorks record: one for the current version of the record, and one for the work as a whole (including all versions). The version-specific DOI is stored in the pids property of the metadata record (pids.identifiers.doi). The work DOI is stored in the parent.pids.doi property of the parent object.
+These DOIs are minted by DataCite (https://datacite.org/) and the attached metadata is maintained automatically by KCWorks.
+Additional DOIs minted elsewhere can be attached to a KCWorks record. If provided at record creation such external DOIs can be used as the record’s primary identifier (in pids.doi). Otherwise, they can be added using the identifiers property of the metadata record using the scheme alternate-doi. In both cases, these externally minted DOIs are not maintained automatically by KCWorks.
+
+
+OAI¶
+KCWorks also supports the OAI identifier scheme. The OAI identifier for a KCWorks record is stored in the pids property of the metadata record (pids.identifiers.oai).
+
+
+ISSN¶
+
+
+ISBN¶
+
+
+
+People¶
+
+ORCID (recommended)¶
+KCWorks (and InvenioRDM) supports the ORCID identifier scheme. The ORCID of the submitter of the KCWorks record is stored in the person_or_org.identifiers property of the creators array (creators[0].person_or_org.identifiers.identifier). A KCWorks user’s ORCID id is also drawn from their KC profile (if they have provided one) and stored in their system user profile (as <user_object>.user_profile.identifier_orcid).
+For details on how to use ORCID identifiers in KCWorks, see the section on Metadata.creators below.
+
+
+KC Username (recommended)¶
+KCWorks also allows the use of Knowledge Commons usernames as identifiers. The KC username of the submitter of the KCWorks record is stored in the person_or_org.identifiers property of the creators array (creators[0].person_or_org.identifiers.identifier) using the scheme kc_username.
+For details on how to use KC usernames in KCWorks, see the section on Metadata.creators below.
+
+
+GND¶
+KCWorks also supports the Integrated Authority File (GND) identifier scheme (https://www.dnb.de/EN/Professionell/Standardisierung/GND/gnd_node.html). The GND identifier of the submitter of the KCWorks record is stored in the person_or_org.identifiers property of the creators array (creators[0].person_or_org.identifiers.identifier) using the scheme gnd.
+
+
+ISNI¶
+KCWorks also supports the ISNI identifier scheme (https://isni.org/). The ISNI of the submitter of the KCWorks record is stored in the person_or_org.identifiers property of the creators array (creators[0].person_or_org.identifiers.identifier) using the scheme isni.
Organizations¶
-
-ROR¶
-The Research Organization Registry (https://ror.org/) is used for the organizations field.
+
+ROR (recommended)¶
+Organization identifiers can appear in the creators and contributors arrays, either for organizational creators/contributors or in the affiliations array of a personal creator/contributor. These fields may identify an organization using its id in Research Organization Registry (https://ror.org/) using the scheme ror, although free text names are also supported.
+
+
+Grid (deprecated)¶
+KCWorks also supports the Grid identifier scheme (https://www.grid.ac/) for organizations using the scheme grid. This scheme is deprecated in favour of ROR, however, and should not be used for new identifiers.
+
+
+GND¶
+KCWorks also supports the Integrated Authority File (GND) identifier scheme (https://www.dnb.de/EN/Professionell/Standardisierung/GND/gnd_node.html) for organizations using the scheme gnd.
+
+
+Funders¶
+
+DOI¶
+Funders in the metadata.funding array can be identified using DOIs and the scheme doi.
+
+OFR¶
+Funders in the metadata.funding array can also be identified using the Open Funder Registry (https://openfunder.org/) identifiers and the scheme ofr.
-
-Notes about Implementation of Core InvenioRDM Fields¶
+
+
+
+KCWorks Implementation of Core InvenioRDM Fields¶
metadata.subjects¶
Note that KCWorks employs the FAST controlled vocabulary (https://www.oclc.org/research/areas/data-science/fast.html) for the subjects field, complemented by the Homosaurus vocabulary (https://homosaurus.org/).
@@ -581,10 +656,11 @@ metadata.creators/metadata.contributors
-KCWorks Custom Fields (kcworks/site/metadata_fields)¶
+KCWorks Custom Fields (kcworks/site/metadata_fields)¶
-kcr:ai_usage¶
+kcr:ai_usage¶
Type: Object[boolean, string]
This field stores data about any use of generative AI in the production of the record.
Example:
@@ -598,7 +674,7 @@ kcr:ai_usage
-kcr:media¶
+kcr:media¶
Type: Array[string]
This field stores a list of media or materials involved in the creation of the record. This field is used to store free-form user-defined descriptors of the media or materials and does not impose any controlled vocabulary.
Example:
@@ -609,7 +685,7 @@ kcr:media
-kcr:commons_domain¶
+kcr:commons_domain¶
Type: string
This field stores the KC organizational (Commons) domain associated with the KCWorks record, if any. The record should also be placed in the KCWorks collection associated with this organization.
Example:
@@ -620,7 +696,7 @@ kcr:commons_domain
-kcr:chapter_label¶
+kcr:chapter_label¶
Type: string
This field stores the label of the chapter associated with the KCWorks record, if any. This allows us to differentiate between a simple chapter label (e.g. “Chapter 1”) and a more substantive title for the same chapter (e.g., “The Role of AI in Modern Art”).
Example:
@@ -631,7 +707,7 @@ kcr:chapter_label
-kcr:content_warning¶
+kcr:content_warning¶
Type: string
This field stores an optional content warning for the KCWorks record. This is used to flag the record for KCWorks users so that they can be aware of potentially problematic content in the record. This field is not to be used for content moderation by KCWorks moderators or admins. It is only to be used voluntarily and as desired by the record submitter.
Example:
@@ -642,7 +718,7 @@ kcr:content_warning
-kcr:course_title¶
+kcr:course_title¶
Type: string
This field stores the title of the course associated with the KCWorks record. It is intended primarily for use with syllabi and instructional materials.
Example:
@@ -653,7 +729,7 @@ kcr:course_title
-kcr:degree¶
+kcr:degree¶
Type: string
This field stores the educational degree (e.g., PhD, DPhil, MA, etc.) associated with the KCWorks record. It is intended primarily for use with theses and dissertations.
Example:
@@ -664,7 +740,7 @@ kcr:degree
-kcr:discipline¶
+kcr:discipline¶
Type: string
This field stores the academic discipline associated with the KCWorks record. It is intended primarily for use with theses, dissertations, and other educational artifacts. It is not intended as a general-purpose field for describing the subject matter of the KCWorks record. For that, you should use the metadata.subjects and kcr:user_defined_tags fields.
This field is intended to complement the thesis:university and kcr:institution_department fields.
@@ -677,7 +753,7 @@ kcr:discipline
-kcr:edition¶
+kcr:edition¶
Type: string
This field stores a descriptor for the edition of the KCWorks record, if any.
Example:
@@ -688,7 +764,7 @@ kcr:edition
-kcr:meeting_organization¶
+kcr:meeting_organization¶
Type: string
This field stores the name of the organization associated with the meeting or conference associated with the KCWorks record. It is intended primarily for use with conference papers, presentations, proceedings, etc.
Example:
@@ -699,7 +775,7 @@ kcr:meeting_organization
-kcr:project_title¶
+kcr:project_title¶
Type: string
This field stores the title of a project for which the KCWorks record was created. It can be used flexibly for, e.g., grant-funded projects, research projects, artistic projects, etc.
Example:
@@ -710,7 +786,7 @@ kcr:project_title
-kcr:publication_url¶
+kcr:publication_url¶
Type: string (URL)
This field stores the URL of the publication associated with the KCWorks record. It is not the URL of the KCWorks record itself or of the work it contains. For example, if the KCWorks record contains a journal article, it would not hold the URL for the published journal article. It is intended to hold the URL of the publication as a whole that the KCWorks record is based on or is a part of. So it might hold the main URL for the journal in which the article was published, or the main URL for the book in which the chapter was published, etc.
This string must be a valid URL.
@@ -722,7 +798,7 @@ kcr:publication_url
-kcr:sponsoring_institution¶
+kcr:sponsoring_institution¶
Type: string
This field stores the name of the institution that sponsored the KCWorks record. One intended use is for unpublished materials such white papers that were sponsored or commissioned by an institution. The field may also be used for the institution hosting a conference or workshop associated with the KCWorks record (as distinct from the organization that sponsored the event).
Note that this field is not intended for the degree-granting institution associated with a thesis or dissertation. That institution’s title should be stored in the thesis:university field.
@@ -734,7 +810,7 @@ kcr:sponsoring_institution
-kcr:submitter_email¶
+kcr:submitter_email¶
Type: string (email address)
This field stores the email address of the submitter of the KCWorks record. It must be a valid email address.
Example:
@@ -745,7 +821,7 @@ kcr:submitter_email
-kcr:submitter_username¶
+kcr:submitter_username¶
Type: string
This field stores the KC username of the submitter of the KCWorks record. This should be used even if the submitter is also a contributor to the KCWorks record and has included the same username in the metadata.creators.person_or_org.identifiers array.
Example:
@@ -756,7 +832,7 @@ kcr:submitter_username
-kcr:institution_department¶
+kcr:institution_department¶
Type: string
This field stores the institutional department in which a thesis, dissertation, or other educational artifact was produced. It is intended to complement the thesis:university field, which stores the degree-granting institution.
Example:
@@ -767,7 +843,7 @@ kcr:institution_department
-kcr:book_series¶
+kcr:book_series¶
Type: Object[string, string]
This field stores the title of a series that contains the KCWorks record, along with the optional volume number of the work within the series.
Example:
@@ -781,7 +857,7 @@ kcr:book_series
-kcr:user_defined_tags¶
+kcr:user_defined_tags¶
Type: Array[string]
This field stores a list of user-defined tags for the KCWorks record. Unlike the metadata.subjects field, these tags are not constrained by any controlled vocabulary. Items should be free-form strings that describe the KCWorks record in a way that is not covered by the metadata.subjects field.
@@ -796,7 +872,7 @@ kcr:user_defined_tags
-kcr:commons_search_recid (system field)¶
+kcr:commons_search_recid (system field)¶
This field is used to store the persistent identifier for the KCWorks record in the KC central search index.
[!Warning]
@@ -804,7 +880,7 @@
kcr:commons_search_recid (system field)
-kcr:commons_search_updated (system field)¶
+kcr:commons_search_updated (system field)¶
Type: string (ISO 8601 datetime string)
This field stores the date and time when the KCWorks record was last updated in the KC central search index.
@@ -814,10 +890,10 @@ kcr:commons_search_updated (system field)
-HC Legacy Custom Fields¶
+HC Legacy Custom Fields¶
The hclegacy namespace is used for custom fields that are used to store data from the legacy CORE database. These fields should not be used for new data.
-custom_fields.hclegacy:groups_for_deposit¶
+custom_fields.hclegacy:groups_for_deposit¶
Type: Array[Object[string, string]]
This field is used to store the groups to which a legacy CORE record belonged before import into KCWorks. It was used to create corresponding KCWorks collections during migration.
Example:
@@ -833,7 +909,7 @@ custom_fields.hclegacy:groups_for_deposit
-custom_fields.hclegacy:collection¶
+custom_fields.hclegacy:collection¶
Type: string
This field is used to store the org collection to which a legacy CORE record belonged before import into KCWorks. It was used to create corresponding KCWorks org collections during migration.
Example:
@@ -844,7 +920,7 @@ custom_fields.hclegacy:collection
-custom_fields.hclegacy:committee_deposit¶
+custom_fields.hclegacy:committee_deposit¶
Type: integer
This field is used to store the committee deposit number for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -855,7 +931,7 @@ custom_fields.hclegacy:committee_deposit
-custom_fields.hclegacy:file_location¶
+custom_fields.hclegacy:file_location¶
Type: string
This field is used to store the relative path the the file for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -866,7 +942,7 @@ custom_fields.hclegacy:file_location
-custom_fields.hclegacy:file_pid¶
+custom_fields.hclegacy:file_pid¶
Type: string
This field is used to store the persistent identifier for the file for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -877,7 +953,7 @@ custom_fields.hclegacy:file_pid
-custom_fields.hclegacy:previously_published¶
+custom_fields.hclegacy:previously_published¶
Type: string
This field is used to store the previously published status for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -888,7 +964,7 @@ custom_fields.hclegacy:previously_published
-custom_fields.hclegacy:publication_type¶
+custom_fields.hclegacy:publication_type¶
Type: string
This field is used to store the publication type for a legacy CORE record. It was used during migration to help determine the KCWorks resource type of the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -899,7 +975,7 @@ custom_fields.hclegacy:publication_type
-custom_fields.hclegacy:record_change_date¶
+custom_fields.hclegacy:record_change_date¶
Type: string (ISO 8601 datetime string)
This field is used to store the date of the last change to a legacy CORE record. It was not used during migration to KCWorks and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -910,7 +986,7 @@ custom_fields.hclegacy:record_change_date
-custom_fields.hclegacy:record_creation_date¶
+custom_fields.hclegacy:record_creation_date¶
Type: string (ISO 8601 datetime string)
This field is used to store the date of the creation of a legacy CORE record. It was not used during migration because InvenioRDM does not allow overriding of the record creation date. It is only preserved for historical purposes and should not be used for new data.
Example:
@@ -921,7 +997,7 @@ custom_fields.hclegacy:record_creation_date
-custom_fields.hclegacy:record_identifier¶
+custom_fields.hclegacy:record_identifier¶
Type: string
This field is used to store the internal system identifier for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -932,7 +1008,7 @@ custom_fields.hclegacy:record_identifier
-custom_fields.hclegacy:submitter_org_memberships¶
+custom_fields.hclegacy:submitter_org_memberships¶
Type: array[string]
This field is used to store the organizations to which a legacy CORE record’s submitter belonged before import into KCWorks. It was used to create corresponding KCWorks org collections during migration and assign the work to those org collections.
Example:
@@ -943,7 +1019,7 @@ custom_fields.hclegacy:submitter_org_memberships
-custom_fields.hclegacy:submitter_affiliation¶
+custom_fields.hclegacy:submitter_affiliation¶
Type: string
This field is used to store the organizational affiliation of a legacy CORE record’s submitter at the time of import into KCWorks. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -954,7 +1030,7 @@ custom_fields.hclegacy:submitter_affiliation
-custom_fields.hclegacy:submitter_id¶
+custom_fields.hclegacy:submitter_id¶
Type: string
This field is used to store the internal KC system user id of a legacy CORE record’s submitter. It was used during migration to assign ownership of the newly created record, and is preserved for historical purposes. It should not be used for new data.
Example:
@@ -965,7 +1041,7 @@ custom_fields.hclegacy:submitter_id
-custom_fields.hclegacy:total_views¶
+custom_fields.hclegacy:total_views¶
Type: integer
This field is used to store the total number of views for a legacy CORE record prior to import into KCWorks. It was used during migration to create KCWorks usage stats aggregations for the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -976,7 +1052,7 @@ custom_fields.hclegacy:total_views
-custom_fields.hclegacy:total_downloads¶
+custom_fields.hclegacy:total_downloads¶
Type: integer
This field is used to store the total number of downloads for a legacy CORE record prior to import into KCWorks. It was used during migration to create KCWorks usage stats aggregations for the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
@@ -987,7 +1063,6 @@ custom_fields.hclegacy:total_downloads
-- Metadata Schema and Vocabularies
-- Example JSON record
+- Metadata Schema, Vocabularies, and Identifiers
+- Example metadata record
+
- Controlled Vocabularies
+
+- Identifier Schemes
+- Works
+
+- People
- Organizations
+
+- Funders
-- Notes about Implementation of Core InvenioRDM Fields
+- KCWorks Implementation of Core InvenioRDM Fields
+
- KCWorks Custom Fields (kcworks/site/metadata_fields)
- kcr:ai_usage
- kcr:media
@@ -1105,8 +1212,6 @@ custom_fields.hclegacy:total_downloadsAbout
- Changes
- Installation
-- Metadata Schema and Vocabularies
+- Metadata Schema, Vocabularies, and Identifiers
- Customizations to InvenioRDM
- Configuration of InvenioRDM
- CLI Commands
diff --git a/search.html b/search.html
index 6e168deb..bc1f9470 100644
--- a/search.html
+++ b/search.html
@@ -203,7 +203,7 @@
- About
- Changes
- Installation
-- Metadata Schema and Vocabularies
+- Metadata Schema, Vocabularies, and Identifiers
- Customizations to InvenioRDM
- Configuration of InvenioRDM
- CLI Commands
diff --git a/searchindex.js b/searchindex.js
index 363f2deb..35e5cdb5 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"0.3.0-beta3 (2024-11-30)": [[0, "beta3-2024-11-30"]], "0.3.1-beta4 (2024-12-10)": [[0, "beta4-2024-12-10"]], "0.3.2-beta5 (2024-12-11)": [[0, "beta5-2024-12-11"]], "0.3.3-beta6 (2024-12-18)": [[0, "beta6-2024-12-18"]], "1. Clone the git repository": [[9, "clone-the-git-repository"]], "2. Create your configuration files": [[9, "create-your-configuration-files"]], "3. Start the docker-compose project": [[9, "start-the-docker-compose-project"]], "4. Initialize the database and other services, and build asset files": [[9, "initialize-the-database-and-other-services-and-build-asset-files"]], "5. Create your own admin user": [[9, "create-your-own-admin-user"]], "6. View the application": [[9, "view-the-application"]], "About": [[1, null]], "Add and Configure an Environment File": [[6, "add-and-configure-an-environment-file"]], "Adding new entry points": [[5, "adding-new-entry-points"]], "Adding new node.js packages to be included": [[5, "adding-new-node-js-packages-to-be-included"]], "Additional environment variables with sensitive information": [[6, "additional-environment-variables-with-sensitive-information"]], "Additional required environment variables with paths on your local file system": [[6, "additional-required-environment-variables-with-paths-on-your-local-file-system"]], "Build and Configure the Containerized Services": [[6, "build-and-configure-the-containerized-services"]], "Build and start the containers": [[6, "build-and-start-the-containers"]], "Bulk Record Import (invenio-record-importer-kcworks)": [[4, "bulk-record-import-invenio-record-importer-kcworks"]], "CLI Commands": [[2, null]], "Changes": [[0, null]], "Changes to external python modules (including Invenio modules)": [[5, "changes-to-external-python-modules-including-invenio-modules"]], "Changes to html template files": [[5, "changes-to-html-template-files"]], "Changes to invenio.cfg": [[5, "changes-to-invenio-cfg"]], "Changes to python code in the site folder": [[5, "changes-to-python-code-in-the-site-folder"]], "Changes to static files": [[5, "changes-to-static-files"]], "Changes to theme (CSS) and javascript files": [[5, "changes-to-theme-css-and-javascript-files"]], "Clone the knowledge-commons-works Code": [[6, "clone-the-knowledge-commons-works-code"]], "Collections": [[4, "collections"]], "Collections for KC Groups (invenio-group-collections-kcworks)": [[4, "collections-for-kc-groups-invenio-group-collections-kcworks"]], "Commit strategy": [[5, "commit-strategy"]], "Configuration of InvenioRDM": [[3, null]], "Content moderation notifications": [[4, "content-moderation-notifications"]], "Contents:": [[7, null]], "Controlled Vocabularies": [[10, "controlled-vocabularies"]], "Controlling containerized nginx server": [[6, "controlling-containerized-nginx-server"]], "Controlling just the containerized services": [[6, "controlling-just-the-containerized-services"]], "Controlling the Application Services": [[6, "controlling-the-application-services"]], "Controlling the KCWorks (Flask) application": [[9, "controlling-the-kcworks-flask-application"]], "Copyright": [[1, "copyright"]], "Create an admin user": [[6, "create-an-admin-user"]], "Create and initialize the database, search indices, and task queue": [[6, "create-and-initialize-the-database-search-indices-and-task-queue"]], "Customizations to InvenioRDM": [[4, null]], "Deposit Form Customizations": [[4, "deposit-form-customizations"]], "Developing KCWorks": [[5, null]], "Digging deeper": [[5, "digging-deeper"]], "Docker log rotation": [[6, "docker-log-rotation"]], "Email templates": [[4, "email-templates"]], "Ensure some version of python is installed": [[6, "ensure-some-version-of-python-is-installed"]], "Example JSON record": [[10, "example-json-record"]], "FAST": [[10, "fast"]], "Fixing docker-compose \u201cnot found\u201d error": [[6, "fixing-docker-compose-not-found-error"]], "Forked Core Invenio Modules": [[4, "forked-core-invenio-modules"]], "Full local development setup": [[9, "full-local-development-setup"]], "Git Branching Strategy": [[5, "git-branching-strategy"]], "Git Submodules": [[5, "git-submodules"]], "HC Legacy Custom Fields": [[4, "hc-legacy-custom-fields"], [10, "hc-legacy-custom-fields"]], "Homosaurus": [[10, "homosaurus"]], "In-app notifications": [[4, "in-app-notifications"]], "In-depth Installation Instructions (NEEDS UPDATING)": [[6, null]], "Indices and tables": [[7, "indices-and-tables"]], "Install Docker 20.10.10+ and Docker-compose 1.17.0+": [[6, "install-docker-20-10-10-and-docker-compose-1-17-0"]], "Install Node.js and NVM": [[6, "install-node-js-and-nvm"]], "Install Python and Required Python Tools": [[6, "install-python-and-required-python-tools"]], "Install and enable Python 3.9.16": [[6, "install-and-enable-python-3-9-16"]], "Install pyenv and pipenv": [[6, "install-pyenv-and-pipenv"]], "Install the Invenio Python Modules": [[6, "install-the-invenio-python-modules"]], "Install the invenio-cli command line tool": [[6, "install-the-invenio-cli-command-line-tool"]], "Installation": [[9, null]], "Integrations with KC": [[4, "integrations-with-kc"]], "InvenioRDM Documentation": [[11, "inveniordm-documentation"]], "Javascript tests": [[5, "javascript-tests"]], "KC Search Provisioning (invenio-remote-api-provisioner)": [[4, "kc-search-provisioning-invenio-remote-api-provisioner"]], "KCWorks Custom CLI Commands": [[2, "kcworks-custom-cli-commands"]], "KCWorks Custom Fields (kcworks/site/metadata_fields)": [[4, "kcworks-custom-fields-kcworks-site-metadata-fields"], [10, "kcworks-custom-fields-kcworks-site-metadata-fields"]], "KCWorks Infrastructure": [[8, null]], "Linux": [[6, "linux"]], "MacOS": [[6, "macos"]], "Metadata Schema Customizations": [[4, "metadata-schema-customizations"]], "Metadata Schema and Vocabularies": [[10, null]], "Modular Framework (invenio-modular-deposit-form)": [[4, "modular-framework-invenio-modular-deposit-form"]], "Modular Framework (invenio-modular-detail-page)": [[4, "modular-framework-invenio-modular-detail-page"]], "Naming Commits": [[5, "naming-commits"]], "Note about docker contexts": [[6, "note-about-docker-contexts"]], "Notes about Implementation of Core InvenioRDM Fields": [[4, "notes-about-implementation-of-core-inveniordm-fields"], [10, "notes-about-implementation-of-core-inveniordm-fields"]], "Notifications": [[4, "notifications"]], "Organizations": [[10, "organizations"]], "Overrides in the KCWorks Package (kcworks/site)": [[4, "overrides-in-the-kcworks-package-kcworks-site"], [4, "id1"]], "Page templates": [[4, "page-templates"]], "Python tests": [[5, "python-tests"]], "Quickstart": [[9, "quickstart"]], "ROR": [[10, "ror"]], "Rebuilding changed files on the fly (fast but limited)": [[5, "rebuilding-changed-files-on-the-fly-fast-but-limited"]], "Record Detail Page Customizations": [[4, "record-detail-page-customizations"]], "Reference": [[11, null]], "Running CLI Commands in the KCWorks Container": [[2, "running-cli-commands-in-the-kcworks-container"]], "Running Invenio CLI Commands": [[2, "running-invenio-cli-commands"]], "Running automated tests (NEEDS UPDATING)": [[5, "running-automated-tests-needs-updating"]], "SAML Authentication": [[4, "saml-authentication"]], "Standardized environment variables": [[6, "standardized-environment-variables"]], "Start the uwsgi applications and celery worker": [[6, "start-the-uwsgi-applications-and-celery-worker"]], "Startup and shutdown scripts": [[6, "startup-and-shutdown-scripts"]], "Subject headings": [[10, "subject-headings"]], "Tagging Releases": [[5, "tagging-releases"]], "Template Customizations": [[4, "template-customizations"]], "The basic build process (slow)": [[5, "the-basic-build-process-slow"]], "Updating an Instance with Upstream Changes": [[5, "updating-an-instance-with-upstream-changes"]], "Updating the running KCWorks instance with development changes": [[5, "updating-the-running-kcworks-instance-with-development-changes"]], "Use the application!": [[6, "use-the-application"]], "User Data Sync (invenio-remote-user-data-kcworks)": [[4, "user-data-sync-invenio-remote-user-data-kcworks"]], "User-first-record notifications": [[4, "user-first-record-notifications"]], "Variables for local credentials": [[6, "variables-for-local-credentials"]], "Version Control": [[5, "version-control"]], "Version Numbering": [[5, "version-numbering"]], "View container logging output": [[6, "view-container-logging-output"]], "View logging output for uwsgi processes": [[6, "view-logging-output-for-uwsgi-processes"]], "Welcome to Knowledge Commons Works\u2019s documentation!": [[7, null]], "custom_fields.hclegacy:collection": [[4, "custom-fields-hclegacy-collection"], [10, "custom-fields-hclegacy-collection"]], "custom_fields.hclegacy:committee_deposit": [[4, "custom-fields-hclegacy-committee-deposit"], [10, "custom-fields-hclegacy-committee-deposit"]], "custom_fields.hclegacy:file_location": [[4, "custom-fields-hclegacy-file-location"], [10, "custom-fields-hclegacy-file-location"]], "custom_fields.hclegacy:file_pid": [[4, "custom-fields-hclegacy-file-pid"], [10, "custom-fields-hclegacy-file-pid"]], "custom_fields.hclegacy:groups_for_deposit": [[4, "custom-fields-hclegacy-groups-for-deposit"], [10, "custom-fields-hclegacy-groups-for-deposit"]], "custom_fields.hclegacy:previously_published": [[4, "custom-fields-hclegacy-previously-published"], [10, "custom-fields-hclegacy-previously-published"]], "custom_fields.hclegacy:publication_type": [[4, "custom-fields-hclegacy-publication-type"], [10, "custom-fields-hclegacy-publication-type"]], "custom_fields.hclegacy:record_change_date": [[4, "custom-fields-hclegacy-record-change-date"], [10, "custom-fields-hclegacy-record-change-date"]], "custom_fields.hclegacy:record_creation_date": [[4, "custom-fields-hclegacy-record-creation-date"], [10, "custom-fields-hclegacy-record-creation-date"]], "custom_fields.hclegacy:record_identifier": [[4, "custom-fields-hclegacy-record-identifier"], [10, "custom-fields-hclegacy-record-identifier"]], "custom_fields.hclegacy:submitter_affiliation": [[4, "custom-fields-hclegacy-submitter-affiliation"], [10, "custom-fields-hclegacy-submitter-affiliation"]], "custom_fields.hclegacy:submitter_id": [[4, "custom-fields-hclegacy-submitter-id"], [10, "custom-fields-hclegacy-submitter-id"]], "custom_fields.hclegacy:submitter_org_memberships": [[4, "custom-fields-hclegacy-submitter-org-memberships"], [10, "custom-fields-hclegacy-submitter-org-memberships"]], "custom_fields.hclegacy:total_downloads": [[4, "custom-fields-hclegacy-total-downloads"], [10, "custom-fields-hclegacy-total-downloads"]], "custom_fields.hclegacy:total_views": [[4, "custom-fields-hclegacy-total-views"], [10, "custom-fields-hclegacy-total-views"]], "invenio-communities": [[4, "invenio-communities"]], "invenio-rdm-records": [[4, "invenio-rdm-records"]], "invenio-records-resources": [[4, "invenio-records-resources"]], "invenio-vocabularies": [[4, "invenio-vocabularies"]], "kcr:ai_usage": [[4, "kcr-ai-usage"], [10, "kcr-ai-usage"]], "kcr:book_series": [[4, "kcr-book-series"], [10, "kcr-book-series"]], "kcr:chapter_label": [[4, "kcr-chapter-label"], [10, "kcr-chapter-label"]], "kcr:commons_domain": [[4, "kcr-commons-domain"], [10, "kcr-commons-domain"]], "kcr:commons_search_recid (system field)": [[4, "kcr-commons-search-recid-system-field"], [10, "kcr-commons-search-recid-system-field"]], "kcr:commons_search_updated (system field)": [[4, "kcr-commons-search-updated-system-field"], [10, "kcr-commons-search-updated-system-field"]], "kcr:content_warning": [[4, "kcr-content-warning"], [10, "kcr-content-warning"]], "kcr:course_title": [[4, "kcr-course-title"], [10, "kcr-course-title"]], "kcr:degree": [[4, "kcr-degree"], [10, "kcr-degree"]], "kcr:discipline": [[4, "kcr-discipline"], [10, "kcr-discipline"]], "kcr:edition": [[4, "kcr-edition"], [10, "kcr-edition"]], "kcr:institution_department": [[4, "kcr-institution-department"], [10, "kcr-institution-department"]], "kcr:media": [[4, "kcr-media"], [10, "kcr-media"]], "kcr:meeting_organization": [[4, "kcr-meeting-organization"], [10, "kcr-meeting-organization"]], "kcr:project_title": [[4, "kcr-project-title"], [10, "kcr-project-title"]], "kcr:publication_url": [[4, "kcr-publication-url"], [10, "kcr-publication-url"]], "kcr:sponsoring_institution": [[4, "kcr-sponsoring-institution"], [10, "kcr-sponsoring-institution"]], "kcr:submitter_email": [[4, "kcr-submitter-email"], [10, "kcr-submitter-email"]], "kcr:submitter_username": [[4, "kcr-submitter-username"], [10, "kcr-submitter-username"]], "kcr:user_defined_tags": [[4, "kcr-user-defined-tags"], [10, "kcr-user-defined-tags"]], "metadata.creators/metadata.contributors": [[4, "metadata-creators-metadata-contributors"], [10, "metadata-creators-metadata-contributors"]], "metadata.subjects": [[4, "metadata-subjects"], [10, "metadata-subjects"]]}, "docnames": ["CHANGES", "README", "cli_commands", "configuration", "customizations", "developing", "in_depth", "index", "infrastructure", "installation", "metadata", "reference"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["CHANGES.md", "README.md", "cli_commands.md", "configuration.md", "customizations.md", "developing.md", "in_depth.md", "index.rst", "infrastructure.md", "installation.md", "metadata.md", "reference.md"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 2, 4, 5, 6, 10], "0": [1, 5, 7, 9, 10], "00": [4, 10], "0000": [4, 10], "0001": 10, "00k4n6c32": 10, "00z": [4, 10], "01": [4, 10], "01t00": [4, 10], "0378": 10, "04": 6, "06": 10, "09": 10, "1": [4, 5, 7, 10], "10": [7, 9, 10], "1001634": [4, 10], "1086436": 10, "11": [6, 7, 10], "111023": 10, "12": [6, 7, 9], "123": 10, "1234": 10, "123456": [4, 10], "12345abcd": 10, "1263": [4, 10], "17": [7, 9], "18": 7, "19": 6, "2": [5, 6, 7, 10], "20": [7, 9], "2018": 10, "2020": 10, "2022": 10, "2023": 1, "2024": [4, 7, 10], "2025": 10, "2029": 10, "22": 6, "2345": 10, "24": [1, 10], "251587": 10, "2nd": 10, "3": [1, 5, 7], "30": 7, "32": 10, "4": 10, "456": 10, "458": 10, "5601": [6, 9], "5955": 10, "6": 6, "60": 10, "6379": 6, "63932": 10, "6780": 10, "6789": 10, "8": 10, "8601": [4, 10], "8gb": 6, "9200": 6, "94682": 10, "958235": 10, "966892": 10, "A": [0, 4, 10], "At": 6, "But": 9, "By": 5, "For": [2, 4, 5, 6, 10], "If": [4, 5, 6, 9, 10], "In": [5, 7], "It": [0, 1, 2, 4, 5, 6, 9, 10], "NOT": 9, "No": 5, "On": [2, 6], "One": [4, 6, 10], "Or": [5, 6], "TO": 9, "That": [4, 10], "The": [0, 4, 6, 9, 10, 11], "Then": [2, 5, 6], "There": [5, 6], "These": [0, 2, 4, 5, 6, 9, 10], "To": [2, 5, 6, 9], "With": [0, 6], "__init__": 5, "__name__": 5, "abl": 6, "about": [5, 7], "abov": 5, "abus": [4, 10], "academ": [1, 4, 10], "access": [0, 6, 9, 10], "account": [4, 10], "acronym": 10, "activ": [5, 6, 9, 10], "actual": [6, 10], "ad": [0, 4], "add": [0, 4, 5, 7, 9, 10], "addit": [4, 5, 9, 10], "addition": 6, "additional_descript": 10, "additional_titl": 10, "address": [4, 6, 10], "admin": [4, 10], "administr": [6, 9], "advis": 6, "affect": 0, "affili": [4, 10], "after": [5, 6, 9], "ag": 10, "again": [5, 6], "against": 6, "aggreg": [2, 4, 10], "ai": [4, 10], "ai_descript": [4, 10], "ai_us": [4, 10], "alia": 6, "alias": 5, "all": [0, 2, 4, 5, 6, 9, 10], "allow": [0, 4, 6, 9, 10], "alon": 5, "along": [4, 5, 10], "alongsid": 6, "alreadi": [5, 6], "also": [0, 2, 4, 5, 6, 10], "altern": 6, "alwai": [0, 6], "ambigu": [4, 10], "american": [4, 10], "among": 0, "an": [0, 1, 4, 7, 9, 10, 11], "anaconda": 6, "ani": [2, 4, 5, 6, 10], "anoth": 6, "api": [0, 2, 5, 6, 9, 10], "api_token": 6, "app": [6, 9], "appear": [0, 9], "append": 6, "applic": [5, 7, 10], "approach": 6, "appropri": [6, 10], "ar": [0, 2, 4, 5, 6, 9, 10], "area": [4, 10], "aren": 6, "argument": 2, "aria": 0, "arli": 0, "arlisna": [4, 10], "arrai": [4, 10], "art": [4, 10], "articl": [4, 10], "artifact": [4, 10], "artist": [4, 10], "ask": 6, "asset": 5, "assign": [4, 6, 10], "assignfast": [4, 10], "associ": [4, 10], "assum": 6, "audio": [4, 10], "augment": 10, "austen": [4, 10], "author": 10, "auto": 0, "autom": 7, "automat": [4, 5, 6, 10], "avail": [2, 5, 6, 10], "avoid": 5, "aw": 6, "awar": [4, 6, 10], "award": 10, "b": 5, "back": [0, 2, 5], "backend": 4, "background": 6, "bar": [6, 10], "base": [4, 10], "bash": [2, 5, 6, 9], "bashrc": 6, "beat": 6, "becaus": [0, 4, 5, 6, 10], "been": [0, 4, 5, 6, 10], "befor": [2, 4, 5, 6, 10], "begin": [5, 6], "being": [0, 6], "belong": [4, 10], "below": [6, 9, 10], "best": [0, 6], "beta": 5, "beta3": 7, "beta4": 7, "beta5": 7, "beta6": [1, 5, 7], "between": [4, 5, 10], "beyond": [4, 10], "big": 6, "bin": 6, "bind": [6, 9], "block": 6, "blueski": 0, "book": [4, 10], "boolean": [4, 10], "boot": 6, "both": [0, 4], "break": 6, "browser": [5, 9], "bug": [0, 5], "bugfix": 5, "build": [4, 7], "builder": 4, "built": [1, 6, 11], "bulk": [2, 7], "bundl": 5, "c": [5, 6], "cach": 6, "call": [4, 6, 10], "can": [0, 2, 4, 5, 6, 9, 10, 11], "cannot": 5, "case": [4, 5], "caution": [2, 5, 9], "cc": 10, "cd": [5, 6, 9], "central": [4, 5, 10], "cern": 11, "ch": 11, "chang": [4, 6, 7, 9, 10], "change_m": 6, "chapter": [4, 10], "chatgpt": 10, "check": [4, 6], "chmod": 6, "choos": 0, "chose": 6, "chrome": 5, "chronolog": [4, 10], "class": 4, "clean": 5, "clearer": 0, "cli": [0, 7, 9], "click": 6, "client": 5, "clone": [5, 7], "cm": 10, "co": 6, "code": [7, 9, 10], "codebas": 9, "coderepositori": 10, "cog": 6, "collabor": [1, 10], "collect": [0, 2, 5, 7, 9], "com": [4, 6, 9, 10], "command": [0, 5, 7, 9], "commerci": 10, "commiss": [4, 10], "committe": [4, 10], "common": [0, 1, 4, 5, 9, 10, 11], "commons_api_token": 6, "commons_search_api_token": 6, "commun": [0, 9], "comparison": 0, "compil": 6, "complement": [4, 10], "complet": [4, 5, 9, 10], "compon": [0, 4, 5], "compos": [5, 7], "comput": 6, "condit": 10, "conf": 5, "confer": [4, 10], "config": [4, 6], "configur": [5, 7], "confus": 0, "consid": 5, "constrain": [4, 10], "contain": [0, 4, 5, 7, 9, 10], "container": 7, "content": [9, 10], "continu": 5, "control": [4, 7], "conveni": 6, "convert": [4, 10], "coordin": 10, "copi": [5, 6, 9], "copyright": 7, "core": [2, 7, 9], "corpor": [4, 10], "correct": [2, 6, 9], "correctli": 0, "correspond": [2, 4, 10], "could": 0, "count": 2, "cours": [4, 6, 10], "cover": [4, 10], "cpython": 6, "creat": [0, 2, 4, 5, 10], "creatibutorsfield": 0, "creation": [0, 4, 10], "creativecommon": 10, "credit": 10, "ctrl": [5, 6], "curl": 6, "current": [0, 5, 6], "custom": [0, 5, 6, 7, 11], "custom_pdf_viewer_j": 5, "d": [5, 6, 9], "daemon": 6, "dashboard": [6, 9], "data": [0, 2, 5, 6, 9, 10], "databas": [2, 4, 10], "dataset": 10, "date": [0, 4, 6, 10], "datetim": [4, 10], "db": 6, "de": 10, "debug": [5, 9], "declar": 5, "deeper": 7, "default": [0, 4, 5, 6, 10], "defin": [4, 5, 6, 10], "delet": [2, 5], "demo": 6, "depart": [4, 10], "depend": [5, 6, 9], "deploi": [2, 5], "deploy": 5, "deposit": [7, 9, 10], "depth": 7, "describ": [4, 5, 9, 10], "descript": 10, "descriptor": [4, 10], "desir": [0, 4, 10], "desktop": 6, "despair": 9, "destroi": [2, 6, 9], "detail": [0, 7, 9, 10], "determin": [4, 10], "dev": [6, 9], "develop": [2, 6, 7, 11], "developmentstatu": 10, "dict": 5, "dictionari": 5, "differ": [4, 9, 10], "differenti": [4, 10], "dig": 7, "digit": 10, "direction": 4, "directli": [5, 6], "directori": 6, "discoveri": [4, 10], "displai": [0, 2], "dissert": [4, 10], "distinct": [4, 5, 10], "distress": [4, 10], "distribut": 10, "divid": [0, 2, 4, 10], "divis": 0, "do": [5, 6, 9], "doc": [5, 6, 11], "docker": [2, 5, 7], "dockerfil": 6, "document": [2, 4, 5, 6, 10], "doe": [0, 4, 5, 6, 10], "doi": [0, 10], "domain": [4, 10], "don": 9, "done": [5, 6], "down": [6, 9], "download": [4, 6, 10], "dphil": [4, 10], "draft": 4, "driver": 6, "dummi": 6, "dure": [0, 2, 4, 5, 6, 9, 10], "dynam": [2, 5], "e": [0, 2, 4, 5, 9, 10], "e2": 5, "each": [0, 4, 5, 6, 9, 10], "easi": 6, "edit": 0, "educ": [4, 10], "effect": [4, 5, 10], "effici": [4, 10], "either": [2, 6, 9], "els": 6, "email": [2, 6, 9, 10], "emailbackend": 4, "embargo": 10, "emit": 4, "emploi": [4, 5, 10], "empti": 0, "emul": 5, "en": 10, "enabl": [4, 10], "encourag": [4, 10], "end": [0, 5], "eng": 10, "engin": 6, "english": 10, "enough": 6, "ensur": [5, 9], "enter": [5, 6, 9], "entri": [4, 10], "env": [6, 9], "environ": [5, 7, 9], "error": [0, 5], "especi": [0, 5, 6], "etc": [2, 4, 5, 9, 10], "europ": [4, 10], "even": [0, 4, 10], "event": [0, 2, 4, 6, 10], "everi": 5, "exampl": [2, 4, 5, 6, 7], "except": 5, "exec": [2, 5, 6, 9], "exist": [0, 2, 5, 6], "explain": [6, 9], "export": 2, "extens": [4, 5, 6], "extra": 6, "extrem": 2, "f": 6, "facet": [4, 10], "fall": 10, "famili": 0, "family_nam": 10, "fast": 4, "featur": [5, 10], "feedback": 9, "field": [0, 7], "file": [1, 2, 4, 7, 10], "fill": 0, "final": 6, "find": [0, 2, 5, 6, 9], "first": [2, 5, 6, 9], "firstrecordcreatednotificationbuild": 4, "firstrecordcreatednotificationservic": 4, "firstrecordpublishednotificationbuild": 4, "fix": [0, 5], "fixtur": [5, 6, 9], "flag": [4, 6, 10], "flask": [2, 4, 5, 7], "flexibli": [4, 10], "flow": 5, "folder": [6, 9], "follow": [2, 4, 5, 6, 9, 10], "foo": 10, "forc": [5, 6], "fork": [6, 7], "form": [0, 7, 9, 10], "format": 10, "formgenr": [4, 10], "found": [2, 4, 10, 11], "four": 5, "free": [4, 6, 10], "freecodecamp": 6, "from": [0, 2, 4, 5, 6, 9, 10], "frontend": 6, "full": [0, 6, 7], "function": 0, "fund": [4, 10], "funder": 10, "further": [2, 6, 9], "futur": 0, "g": [0, 2, 4, 5, 9, 10], "gender": 10, "gener": [2, 4, 5, 6, 10], "geograph": [4, 10], "geometri": 10, "geonam": 10, "geopattern": 5, "get": [0, 6], "gh_page": 5, "git": 6, "github": [5, 6, 9, 10], "gitlab": 5, "given": 0, "given_nam": 10, "gninx": 6, "good": 6, "grant": [4, 10], "grep": 2, "group": [2, 5, 6, 9, 10], "group_identifi": [4, 10], "group_nam": [4, 10], "guarante": 6, "guid": 6, "h1": 10, "ha": [0, 4, 5, 6, 10], "handl": 0, "have": [0, 4, 5, 6, 9, 10], "hcommon": [4, 10], "head": 4, "header": 0, "help": [2, 4, 5, 6, 10], "here": [4, 6, 9, 10], "hidden": 0, "histor": [4, 10], "histori": [4, 5, 10], "historian": [4, 10], "hold": [4, 6, 10], "homoit0000669": [4, 10], "homosauru": 4, "host": [4, 10], "hour": 9, "how": 2, "how2shout": 6, "html": [4, 6, 10], "http": [4, 5, 6, 9, 10, 11], "human": [4, 10], "hyphen": [4, 6, 10], "i": [0, 1, 2, 4, 5, 9, 10, 11], "icon": 6, "id": [0, 4, 10], "idea": 6, "ident": 10, "identifi": [0, 4, 10], "illustr": 10, "imag": [0, 5, 6], "immedi": 5, "implement": 7, "import": [2, 5, 6, 7, 9, 10], "import_data": 6, "impos": [4, 10], "imprint": 10, "includ": [0, 1, 2, 4, 6, 9, 10, 11], "increment": 5, "index": [2, 4, 6, 7, 10], "indic": [2, 9], "individu": 6, "info": [4, 6, 10], "inform": [5, 11], "informationen": 10, "infrastructur": [0, 7], "ini": 6, "init": [5, 9], "initi": [0, 5], "insert": [6, 9], "insid": [2, 5, 6, 9], "instal": [5, 7], "instanc": [1, 2, 6, 7, 9, 11], "instance_path": [6, 9], "instead": [0, 5, 6], "institut": [4, 10], "instruct": [4, 5, 7, 9, 10], "instructionalresourc": 10, "integ": [4, 10], "integr": [5, 7], "intend": [4, 10], "inter": [5, 9], "interact": 5, "interfac": 6, "intern": [4, 10], "interpret": 6, "intersex": [4, 10], "introduc": 5, "introduct": [4, 10], "invenio": [7, 9, 10], "invenio_": 6, "invenio_app": 6, "invenio_csrf_secret_salt": 6, "invenio_custom_pdf_view": 5, "invenio_datacite_password": 6, "invenio_instance_path": 6, "invenio_notif": 4, "invenio_record_importer_data_dir": 6, "invenio_record_importer_local_data_dir": 6, "invenio_search_domain": 6, "invenio_secret_kei": 6, "invenio_security_login_salt": 6, "invenio_site_api_url": 6, "invenio_site_ui_url": 6, "invenio_sqlalchemy_database_uri": 6, "inveniordm": [1, 2, 5, 6, 7], "invert": 0, "invok": 2, "involv": [0, 4, 5, 9, 10], "isbn": 10, "iscitedbi": 10, "iso": [4, 10], "issn": 10, "issu": 10, "item": [4, 10], "its": [0, 5, 6, 9], "itself": [4, 10], "j": [0, 7], "jammi": 6, "jane": [4, 10], "janedo": 10, "javascript": 10, "jdoe": [4, 10], "jest": 5, "jinja": 4, "john": [4, 10], "journal": [4, 10], "json": [2, 5, 6, 7], "kc": [0, 2, 6, 7, 10], "kc_usernam": [4, 10], "kcr": 6, "kcr_api": 6, "kcr_ui": 6, "kcwork": [0, 6, 7], "keep": [5, 6], "keyboard": 0, "kingston": [4, 10], "knowldg": 9, "knowledg": [0, 1, 5, 9, 11], "label": [0, 4, 10], "lago": 10, "lambda": 6, "lang": 10, "languag": 10, "last": [2, 4, 5, 10], "latest": 5, "latin": [4, 10], "launch": 10, "layout": 0, "lcsh": [4, 10], "lcsh2fast": [4, 10], "lead": 0, "least": [0, 6], "leav": 5, "leftov": 5, "legaci": 2, "legalcod": 10, "less": [4, 5, 10], "level": [4, 10], "lib": 6, "licens": [1, 10], "like": [5, 6], "likewis": 5, "line": [0, 2, 9], "link": [0, 2, 4, 10], "linux": 5, "list": [2, 4, 5, 10], "literatur": [4, 10], "live": [6, 9], "load": 2, "local": [2, 5, 7], "localhost": [6, 9], "locat": [4, 5, 10], "lock": 6, "log": 4, "loglevel": 6, "logo": 0, "long": [0, 5, 6], "lost": 2, "lowercas": [4, 10], "lt": 6, "m": 5, "ma": [4, 10], "mac": 6, "machin": 6, "made": [0, 5, 10], "mai": [4, 5, 6, 9, 10], "mail": 4, "main": [0, 2, 4, 5, 9, 10], "make": [5, 6, 9], "manag": [0, 5, 6], "manual": 6, "markdown": 4, "match": [0, 6], "materi": [4, 10], "matter": [4, 10], "md": 5, "mean": [0, 4, 5, 6, 10], "meantim": 5, "mechan": [4, 10], "media": 0, "meet": [4, 10], "member": 0, "memori": 6, "menu": 0, "merg": 5, "mesh": [1, 9], "messag": 0, "met": 10, "metadata": [0, 2, 7], "method": 10, "michigan": 10, "middl": 2, "might": [0, 4, 6, 10], "migrant": [4, 10], "migrat": [4, 10], "minor": 5, "minut": 6, "miss": 0, "mit": 1, "mla": [4, 10], "modal": 0, "moder": 10, "moderatorrolerecipi": 4, "modern": [4, 10], "modifi": [0, 5], "modul": [0, 7, 9], "modular": 9, "monotask": 5, "more": [4, 5, 10], "most": [0, 5, 6], "mount": [6, 9], "mq": 6, "msu": 10, "much": [4, 10], "multipl": 0, "must": [4, 5, 6, 10], "my": 10, "myapitoken": 6, "mycours": 10, "myevent": 10, "myinveniodatacitepassword": 6, "mytoken": 6, "na": 0, "name": [0, 2, 4, 6, 9, 10], "name_parts_loc": 0, "namespac": [4, 10], "navig": [0, 5, 6, 9], "nc": 10, "necessari": [0, 6, 9], "need": [2, 7, 9], "new": [0, 4, 6, 10], "newer": 6, "newli": [4, 10], "newlin": 6, "next": [5, 6], "nginx": 9, "node": 7, "node_modul": 5, "normal": [5, 6, 9], "note": [2, 5, 7, 9], "notif": 7, "notificationop": 4, "notifications_moderator_rol": 4, "now": [0, 6, 9], "npm": 5, "number": [2, 4, 7, 10], "nvm": 7, "o": 6, "object": [4, 5, 10], "obtain": 6, "occupi": 5, "oclc": [4, 10], "octob": 10, "often": [5, 6], "old": 6, "onc": [5, 6], "one": [4, 6, 9, 10], "onli": [0, 2, 4, 5, 10], "onto": 9, "open": 6, "opengraph": 0, "opensearch": [2, 6, 9], "oper": [4, 6, 9], "opt": [5, 6, 9], "option": [0, 2, 4, 5, 9, 10], "orcid": [0, 4, 10], "order": [0, 5], "org": [4, 5, 6, 10], "organ": 4, "organiz": [4, 10], "origin": 5, "other": [0, 4, 5, 6, 10], "otherwis": 6, "out": 6, "output": 5, "over": 5, "overrid": [5, 10], "overridden": 5, "own": [5, 6], "ownership": [4, 10], "p": [2, 9, 10], "packag": [2, 6, 9, 10], "page": [0, 5, 7, 9, 10], "panel": 6, "paper": [4, 10], "parent": [6, 9], "part": [0, 1, 2, 4, 10], "particular": [6, 9], "particularli": 5, "password": [2, 6, 9], "patch": 5, "path": [4, 10], "patienc": 9, "pdf": [4, 10], "pdfj": 5, "pedagogi": 10, "pend": 0, "perform": 6, "permiss": 0, "persist": [4, 5, 6, 10], "person": [4, 10], "person_or_org": [4, 10], "pgadmin": [6, 9], "pgadmin_default_email": 6, "pgadmin_default_password": 6, "phd": [4, 10], "pick": 5, "pid": [5, 6, 9], "pidfil": 6, "pip": [5, 6], "pipenv": [5, 9], "pipfil": 5, "place": [4, 10], "plaintext": 4, "platform": 0, "poetri": [4, 10], "point": [0, 10], "possibl": [5, 10], "postgres_db": 6, "postgres_password": 6, "postgres_us": 6, "postgresql": 6, "potenti": [4, 10], "practic": 5, "prefix": [4, 10], "present": [0, 4, 10], "preserv": [4, 10], "press": 6, "previous": [0, 4, 10], "primari": [0, 4, 10], "primarili": [2, 4, 10], "print": [6, 10], "prior": [4, 6, 10], "privat": [6, 9], "problem": 5, "problemat": [4, 10], "proce": 6, "proceed": [4, 10], "process": [2, 10], "produc": [0, 2, 4, 10], "product": [2, 4, 5, 10], "profil": [0, 4], "program": 10, "programminglanguag": 10, "project": [4, 5, 6, 10], "proper": [0, 4, 10], "properti": 0, "provid": [2, 4, 5, 6, 9, 10], "provision": [9, 10], "prune": 5, "psychologi": 10, "psycopg2": 6, "public": [0, 4, 10], "publication_d": 10, "publish": [0, 4, 10], "pull": [5, 6], "purpos": [4, 10], "push": 5, "put": 6, "py": [2, 5], "pypi": 6, "pyproject": 5, "pytest": 5, "python": [7, 9, 10], "python3": 6, "python_local_git_packages_path": 6, "python_local_site_packages_path": 6, "queri": 0, "quick": 9, "quickli": 6, "quickstart": 7, "rabbitmq": 6, "race": 10, "random": [0, 6], "rather": 6, "rdm": [6, 9, 10], "rdmrecord": 4, "re": [5, 6, 10], "reach": 5, "react": 5, "read": 2, "readabl": [4, 5, 10], "reader": [4, 10], "readi": 5, "readm": 5, "real": 6, "reason": [6, 10], "rebuild": 6, "rebuilt": 5, "receiv": [4, 6], "recent": [0, 5], "recipi": 4, "recommend": 6, "record": [0, 2, 5, 7, 9], "recreat": [5, 6], "recurs": [5, 9], "redi": 6, "redis_domain": 6, "redund": [5, 9], "refactor": 0, "refer": [5, 6, 7, 9, 10], "reflect": [5, 9], "refresh": 5, "refuge": [4, 10], "regardless": 6, "registri": 10, "rel": [4, 10], "relat": [5, 10], "related_identifi": 10, "relation_typ": 10, "releas": [1, 6], "reliabl": 6, "reload": [5, 6, 9], "remot": [0, 2, 5, 6, 9, 10], "remov": 0, "replac": 6, "repo": 5, "repositori": [1, 5, 6, 10], "repres": 5, "request": [0, 5, 6], "requir": [4, 5, 7, 9, 10], "research": [1, 4, 9, 10], "resid": [4, 10], "resourc": [0, 6, 9, 10], "resource_typ": 10, "respect": 5, "respond": 5, "respons": 6, "rest": [6, 9], "restart": [5, 6, 9], "restrict": 10, "result": 0, "right": [0, 6, 10], "role": [4, 6, 10], "root": [5, 6], "rout": 0, "run": [4, 6, 7, 9], "runner": 5, "same": [4, 6, 10], "sandbox": 10, "save": 4, "schema": [0, 7], "scheme": [4, 10], "scienc": [4, 10], "script": [5, 9], "search": [0, 2, 7, 9, 10], "second": [4, 10], "secret": 6, "section": 10, "secur": 6, "see": [1, 5, 6, 9], "seen": 6, "select": 0, "selenium": 5, "self": 0, "semant": [4, 5], "semver": 5, "send": 4, "sent": 4, "separ": [5, 6, 9], "seri": [4, 10], "serial": 2, "series_titl": [4, 10], "series_volum": [4, 10], "serv": [6, 9], "server": [5, 9], "serverless": 6, "servic": [0, 2, 4, 7, 10], "services_setup": 9, "session": 6, "set": [4, 5, 6, 9, 10], "setup": [5, 6, 7], "sever": 6, "sexual": 10, "sh": [5, 6, 9], "share": [0, 1, 6], "shell": 6, "should": [0, 4, 5, 6, 9, 10], "sidebar": 0, "signal": 4, "similarli": [4, 9, 10], "simpl": [4, 10], "simpli": [5, 6], "sinc": [0, 2, 5, 6], "singl": [2, 5, 10], "site": [2, 6, 9], "size": [6, 10], "sl": 6, "slackbot": 6, "slider": 6, "so": [0, 2, 4, 5, 6, 9, 10], "social": 0, "softwar": [4, 10], "solut": 6, "solv": 0, "some": [0, 4, 5, 9, 10], "someth": 6, "sometim": [0, 5], "sort": [0, 10], "sourc": [5, 6, 9], "specif": [0, 4, 6], "specifi": 6, "sponsor": [4, 10], "squash": 5, "src": 5, "stage": [2, 5, 6], "stamp": 6, "stand": 5, "standalon": 6, "standard": [4, 10], "start": 5, "stat": [2, 4, 10], "state": 10, "statement": 9, "static": 9, "statu": [4, 10], "stdout": 6, "step": [5, 6, 9], "stop": [5, 6, 9], "store": [1, 2, 4, 5, 6, 10], "string": [0, 4, 10], "strongli": [4, 10], "structur": [6, 10], "style": 5, "sub": [2, 4, 6, 10], "submiss": 0, "submit": 0, "submitt": [4, 10], "submodul": 9, "substant": [4, 10], "subtitl": 10, "sudo": 6, "suffix": 5, "suggest": [4, 10], "suit": 5, "suitabl": 2, "superus": 6, "supplement": [4, 10], "suppli": 6, "support": [5, 6], "sur": 6, "sure": [5, 6], "syllabi": [4, 10], "syllabu": 10, "sync": 0, "syntax": 6, "synthet": 2, "system": [0, 1, 2, 5, 9], "systemd": 6, "t": [6, 9], "tab": 6, "tabl": 6, "tag": [4, 10], "tail": 6, "take": [5, 6, 9], "task": 5, "teach": 10, "technic": [0, 10], "technisch": 10, "tell": 6, "templat": 7, "temporari": 5, "termin": [5, 6], "test": [6, 7, 9, 10], "than": 6, "thei": [0, 4, 5, 10], "them": [0, 5, 6], "theses": [4, 10], "thesi": [4, 10], "thi": [0, 2, 4, 5, 6, 9, 10], "thing": 0, "those": [4, 5, 6, 9, 10], "though": 5, "three": 6, "through": 5, "time": [4, 5, 6, 9, 10], "titl": [0, 4, 10], "tmp": [5, 6, 9], "token": 6, "token_hex": 6, "toml": 5, "tool": [1, 4, 7, 10], "top": [4, 6, 10], "topic": [4, 10], "toronto": [4, 10], "total": [4, 10], "total_volum": 10, "track": 4, "true": [4, 9, 10], "try": 5, "tweak": 0, "two": [0, 4, 5, 6, 10], "txt": 1, "type": [0, 4, 10], "u": [4, 6, 10], "ubuntu": 6, "ui": [0, 2, 4, 5, 6, 9], "ukranian": [4, 10], "ultim": 5, "under": [1, 5, 6, 9], "underli": 2, "uni": 4, "unit": [4, 5], "univers": [4, 10], "unknown": 0, "unless": [5, 6, 9], "unlik": [4, 10], "unpublish": [4, 10], "unread": 4, "until": [5, 10], "up": [2, 5, 6, 9], "updat": [0, 2, 4, 7, 9, 10], "upload": [0, 5], "upstream": 7, "url": [4, 10], "us": [0, 2, 4, 5, 7, 9, 10], "usag": [2, 4, 10], "user": [0, 2, 5, 10], "usermod": 6, "usernam": [4, 10], "usr": 6, "usual": 5, "uwsgi": [5, 9], "uwsgi_api": 9, "uwsgi_rest": 6, "uwsgi_ui": [5, 6, 9], "v": [5, 6], "v1": 10, "v16": 6, "v2": 6, "v3": [4, 10], "valid": [4, 10], "valu": [0, 4, 6, 10], "var": [6, 9], "variabl": [4, 5], "variat": [4, 10], "varieti": 9, "variou": [6, 9, 10], "veri": 5, "version": [0, 1, 4, 7, 9, 10], "via": [4, 5, 6], "view": [0, 4, 5, 10], "virtual": 6, "virtualenv": 6, "visibl": [0, 5], "vocabulari": [7, 9], "volum": [4, 5, 6, 10], "voluntarili": [4, 10], "wa": [0, 4, 10], "wai": [4, 6, 10], "walk": 5, "want": [4, 5, 6, 9, 10], "warn": [2, 4, 5, 10], "watch": [5, 6], "watercolor": [4, 10], "we": 5, "web": [5, 6, 9], "webdriv": 5, "webhook": 4, "webpack": 5, "webpackthemebundl": 5, "well": [0, 4, 5, 6], "were": [0, 4, 6, 10], "what": [5, 10], "when": [0, 4, 5, 6, 9, 10], "whenev": [2, 5], "where": [0, 5, 6, 9], "wherev": 5, "whether": 4, "which": [0, 4, 5, 6, 9, 10], "whichev": 6, "while": [5, 9], "white": [4, 10], "whole": [0, 4, 10], "whose": 0, "widget": 0, "wikidata": 10, "window": [5, 6], "wip": 5, "within": [0, 4, 10], "without": [5, 6], "word": 0, "work": [0, 1, 4, 5, 9, 10, 11], "worker": [2, 5], "workshop": [4, 10], "worldcat": [4, 10], "would": [0, 2, 4, 5, 6, 10], "wrap": [0, 2], "written": 6, "wsl2": 5, "www": [4, 6, 10], "x": [6, 10], "x86_64": 6, "ye": 5, "yet": 6, "yml": [5, 6, 9], "you": [2, 4, 5, 6, 9, 10], "your": 5, "zenodo": 10, "zshrc": 6}, "titles": ["Changes", "About", "CLI Commands", "Configuration of InvenioRDM", "Customizations to InvenioRDM", "Developing KCWorks", "In-depth Installation Instructions (NEEDS UPDATING)", "Welcome to Knowledge Commons Works\u2019s documentation!", "KCWorks Infrastructure", "Installation", "Metadata Schema and Vocabularies", "Reference"], "titleterms": {"": 7, "0": [0, 6], "1": [0, 6, 9], "10": [0, 6], "11": 0, "12": 0, "16": 6, "17": 6, "18": 0, "2": [0, 9], "20": 6, "2024": 0, "3": [0, 6, 9], "30": 0, "4": 9, "5": 9, "6": 9, "9": 6, "In": [4, 6], "The": 5, "about": [1, 4, 6, 10], "ad": 5, "add": 6, "addit": 6, "admin": [6, 9], "ai_usag": [4, 10], "an": [5, 6], "api": 4, "app": 4, "applic": [6, 9], "asset": 9, "authent": 4, "autom": 5, "basic": 5, "beta3": 0, "beta4": 0, "beta5": 0, "beta6": 0, "book_seri": [4, 10], "branch": 5, "build": [5, 6, 9], "bulk": 4, "celeri": 6, "cfg": 5, "chang": [0, 5], "chapter_label": [4, 10], "cli": [2, 6], "clone": [6, 9], "code": [5, 6], "collect": [4, 10], "command": [2, 6], "commit": 5, "committee_deposit": [4, 10], "common": [6, 7], "commons_domain": [4, 10], "commons_search_recid": [4, 10], "commons_search_upd": [4, 10], "commun": 4, "compos": [6, 9], "configur": [3, 6, 9], "contain": [2, 6], "container": 6, "content": [4, 7], "content_warn": [4, 10], "context": 6, "contributor": [4, 10], "control": [5, 6, 9, 10], "copyright": 1, "core": [4, 10], "course_titl": [4, 10], "creat": [6, 9], "creator": [4, 10], "credenti": 6, "css": 5, "custom": [2, 4, 10], "custom_field": [4, 10], "data": 4, "databas": [6, 9], "deeper": 5, "degre": [4, 10], "deposit": 4, "depth": 6, "detail": 4, "develop": [5, 9], "dig": 5, "disciplin": [4, 10], "docker": [6, 9], "document": [7, 11], "edit": [4, 10], "email": 4, "enabl": 6, "ensur": 6, "entri": 5, "environ": 6, "error": 6, "exampl": 10, "extern": 5, "fast": [5, 10], "field": [4, 10], "file": [5, 6, 9], "file_loc": [4, 10], "file_pid": [4, 10], "first": 4, "fix": 6, "flask": 9, "fly": 5, "folder": 5, "fork": 4, "form": 4, "found": 6, "framework": 4, "full": 9, "git": [5, 9], "group": 4, "groups_for_deposit": [4, 10], "hc": [4, 10], "hclegaci": [4, 10], "head": 10, "homosauru": 10, "html": 5, "i": 6, "implement": [4, 10], "import": 4, "includ": 5, "indic": [6, 7], "inform": 6, "infrastructur": 8, "initi": [6, 9], "instal": [6, 9], "instanc": 5, "institution_depart": [4, 10], "instruct": 6, "integr": 4, "invenio": [2, 4, 5, 6], "inveniordm": [3, 4, 10, 11], "j": [5, 6], "javascript": 5, "json": 10, "just": 6, "kc": 4, "kcr": [4, 10], "kcwork": [2, 4, 5, 8, 9, 10], "knowledg": [6, 7], "legaci": [4, 10], "limit": 5, "line": 6, "linux": 6, "local": [6, 9], "log": 6, "maco": 6, "media": [4, 10], "meeting_organ": [4, 10], "metadata": [4, 10], "metadata_field": [4, 10], "moder": 4, "modul": [4, 5, 6], "modular": 4, "name": 5, "need": [5, 6], "new": 5, "nginx": 6, "node": [5, 6], "note": [4, 6, 10], "notif": 4, "number": 5, "nvm": 6, "organ": 10, "other": 9, "output": 6, "overrid": 4, "own": 9, "packag": [4, 5], "page": 4, "path": 6, "pipenv": 6, "point": 5, "previously_publish": [4, 10], "process": [5, 6], "project": 9, "project_titl": [4, 10], "provis": 4, "provision": 4, "publication_typ": [4, 10], "publication_url": [4, 10], "pyenv": 6, "python": [5, 6], "queue": 6, "quickstart": 9, "rdm": 4, "rebuild": 5, "record": [4, 10], "record_change_d": [4, 10], "record_creation_d": [4, 10], "record_identifi": [4, 10], "refer": 11, "releas": 5, "remot": 4, "repositori": 9, "requir": 6, "resourc": 4, "ror": 10, "rotat": 6, "run": [2, 5], "saml": 4, "schema": [4, 10], "script": 6, "search": [4, 6], "sensit": 6, "server": 6, "servic": [6, 9], "setup": 9, "shutdown": 6, "site": [4, 5, 10], "slow": 5, "some": 6, "sponsoring_institut": [4, 10], "standard": 6, "start": [6, 9], "startup": 6, "static": 5, "strategi": 5, "subject": [4, 10], "submitter_affili": [4, 10], "submitter_email": [4, 10], "submitter_id": [4, 10], "submitter_org_membership": [4, 10], "submitter_usernam": [4, 10], "submodul": 5, "sync": 4, "system": [4, 6, 10], "tabl": 7, "tag": 5, "task": 6, "templat": [4, 5], "test": 5, "theme": 5, "tool": 6, "total_download": [4, 10], "total_view": [4, 10], "updat": [5, 6], "upstream": 5, "us": 6, "user": [4, 6, 9], "user_defined_tag": [4, 10], "uwsgi": 6, "variabl": 6, "version": [5, 6], "view": [6, 9], "vocabulari": [4, 10], "welcom": 7, "work": [6, 7], "worker": 6, "your": [6, 9]}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"0.3.0-beta3 (2024-11-30)": [[0, "beta3-2024-11-30"]], "0.3.1-beta4 (2024-12-10)": [[0, "beta4-2024-12-10"]], "0.3.2-beta5 (2024-12-11)": [[0, "beta5-2024-12-11"]], "0.3.3-beta6 (2024-12-18)": [[0, "beta6-2024-12-18"]], "1. Clone the git repository": [[9, "clone-the-git-repository"]], "2. Create your configuration files": [[9, "create-your-configuration-files"]], "3. Start the docker-compose project": [[9, "start-the-docker-compose-project"]], "4. Initialize the database and other services, and build asset files": [[9, "initialize-the-database-and-other-services-and-build-asset-files"]], "5. Create your own admin user": [[9, "create-your-own-admin-user"]], "6. View the application": [[9, "view-the-application"]], "About": [[1, null]], "Add and Configure an Environment File": [[6, "add-and-configure-an-environment-file"]], "Adding new entry points": [[5, "adding-new-entry-points"]], "Adding new node.js packages to be included": [[5, "adding-new-node-js-packages-to-be-included"]], "Additional environment variables with sensitive information": [[6, "additional-environment-variables-with-sensitive-information"]], "Additional required environment variables with paths on your local file system": [[6, "additional-required-environment-variables-with-paths-on-your-local-file-system"]], "Build and Configure the Containerized Services": [[6, "build-and-configure-the-containerized-services"]], "Build and start the containers": [[6, "build-and-start-the-containers"]], "Bulk Record Import (invenio-record-importer-kcworks)": [[4, "bulk-record-import-invenio-record-importer-kcworks"]], "CLI Commands": [[2, null]], "Changes": [[0, null]], "Changes to external python modules (including Invenio modules)": [[5, "changes-to-external-python-modules-including-invenio-modules"]], "Changes to html template files": [[5, "changes-to-html-template-files"]], "Changes to invenio.cfg": [[5, "changes-to-invenio-cfg"]], "Changes to python code in the site folder": [[5, "changes-to-python-code-in-the-site-folder"]], "Changes to static files": [[5, "changes-to-static-files"]], "Changes to theme (CSS) and javascript files": [[5, "changes-to-theme-css-and-javascript-files"]], "Clone the knowledge-commons-works Code": [[6, "clone-the-knowledge-commons-works-code"]], "Collections": [[4, "collections"]], "Collections for KC Groups (invenio-group-collections-kcworks)": [[4, "collections-for-kc-groups-invenio-group-collections-kcworks"]], "Commit strategy": [[5, "commit-strategy"]], "Configuration of InvenioRDM": [[3, null]], "Content moderation notifications": [[4, "content-moderation-notifications"]], "Contents:": [[7, null]], "Controlled Vocabularies": [[10, "controlled-vocabularies"]], "Controlling containerized nginx server": [[6, "controlling-containerized-nginx-server"]], "Controlling just the containerized services": [[6, "controlling-just-the-containerized-services"]], "Controlling the Application Services": [[6, "controlling-the-application-services"]], "Controlling the KCWorks (Flask) application": [[9, "controlling-the-kcworks-flask-application"]], "Copyright": [[1, "copyright"]], "Create an admin user": [[6, "create-an-admin-user"]], "Create and initialize the database, search indices, and task queue": [[6, "create-and-initialize-the-database-search-indices-and-task-queue"]], "Creator/contributor roles": [[10, "creator-contributor-roles"]], "Customizations to InvenioRDM": [[4, null]], "DOI": [[10, "doi"], [10, "id2"]], "Deposit Form Customizations": [[4, "deposit-form-customizations"]], "Developing KCWorks": [[5, null]], "Digging deeper": [[5, "digging-deeper"]], "Docker log rotation": [[6, "docker-log-rotation"]], "Email templates": [[4, "email-templates"]], "Ensure some version of python is installed": [[6, "ensure-some-version-of-python-is-installed"]], "Example metadata record": [[10, "example-metadata-record"]], "FAST": [[10, "fast"]], "Fixing docker-compose \u201cnot found\u201d error": [[6, "fixing-docker-compose-not-found-error"]], "Forked Core Invenio Modules": [[4, "forked-core-invenio-modules"]], "Full local development setup": [[9, "full-local-development-setup"]], "Funders": [[10, "funders"]], "GND": [[10, "gnd"], [10, "id1"]], "Git Branching Strategy": [[5, "git-branching-strategy"]], "Git Submodules": [[5, "git-submodules"]], "Grid (deprecated)": [[10, "grid-deprecated"]], "HC Legacy Custom Fields": [[4, "hc-legacy-custom-fields"], [10, "hc-legacy-custom-fields"]], "Homosaurus": [[10, "homosaurus"]], "ISBN": [[10, "isbn"]], "ISNI": [[10, "isni"]], "ISSN": [[10, "issn"]], "Identifier Schemes": [[10, "identifier-schemes"]], "In-app notifications": [[4, "in-app-notifications"]], "In-depth Installation Instructions (NEEDS UPDATING)": [[6, null]], "Install Docker 20.10.10+ and Docker-compose 1.17.0+": [[6, "install-docker-20-10-10-and-docker-compose-1-17-0"]], "Install Node.js and NVM": [[6, "install-node-js-and-nvm"]], "Install Python and Required Python Tools": [[6, "install-python-and-required-python-tools"]], "Install and enable Python 3.9.16": [[6, "install-and-enable-python-3-9-16"]], "Install pyenv and pipenv": [[6, "install-pyenv-and-pipenv"]], "Install the Invenio Python Modules": [[6, "install-the-invenio-python-modules"]], "Install the invenio-cli command line tool": [[6, "install-the-invenio-cli-command-line-tool"]], "Installation": [[9, null]], "Integrations with KC": [[4, "integrations-with-kc"]], "InvenioRDM Documentation": [[11, "inveniordm-documentation"]], "JSON object for record creation": [[10, "json-object-for-record-creation"]], "JSON object retrieved from the record API": [[10, "json-object-retrieved-from-the-record-api"]], "Javascript tests": [[5, "javascript-tests"]], "KC Search Provisioning (invenio-remote-api-provisioner)": [[4, "kc-search-provisioning-invenio-remote-api-provisioner"]], "KC Username (recommended)": [[10, "kc-username-recommended"]], "KCWorks Custom CLI Commands": [[2, "kcworks-custom-cli-commands"]], "KCWorks Custom Fields (kcworks/site/metadata_fields)": [[4, "kcworks-custom-fields-kcworks-site-metadata-fields"], [10, "kcworks-custom-fields-kcworks-site-metadata-fields"]], "KCWorks Implementation of Core InvenioRDM Fields": [[10, "kcworks-implementation-of-core-inveniordm-fields"]], "KCWorks Infrastructure": [[8, null]], "Linux": [[6, "linux"]], "MacOS": [[6, "macos"]], "Metadata Schema Customizations": [[4, "metadata-schema-customizations"]], "Metadata Schema, Vocabularies, and Identifiers": [[10, null]], "Modular Framework (invenio-modular-deposit-form)": [[4, "modular-framework-invenio-modular-deposit-form"]], "Modular Framework (invenio-modular-detail-page)": [[4, "modular-framework-invenio-modular-detail-page"]], "Naming Commits": [[5, "naming-commits"]], "Note about docker contexts": [[6, "note-about-docker-contexts"]], "Notes about Implementation of Core InvenioRDM Fields": [[4, "notes-about-implementation-of-core-inveniordm-fields"]], "Notifications": [[4, "notifications"]], "OAI": [[10, "oai"]], "OFR": [[10, "ofr"]], "ORCID (recommended)": [[10, "orcid-recommended"]], "Organizations": [[10, "organizations"]], "Overrides in the KCWorks Package (kcworks/site)": [[4, "overrides-in-the-kcworks-package-kcworks-site"], [4, "id1"]], "Page templates": [[4, "page-templates"]], "People": [[10, "people"]], "Python tests": [[5, "python-tests"]], "Quickstart": [[9, "quickstart"]], "ROR (recommended)": [[10, "ror-recommended"]], "Rebuilding changed files on the fly (fast but limited)": [[5, "rebuilding-changed-files-on-the-fly-fast-but-limited"]], "Record Detail Page Customizations": [[4, "record-detail-page-customizations"]], "Reference": [[11, null]], "Resource types": [[10, "resource-types"]], "Running CLI Commands in the KCWorks Container": [[2, "running-cli-commands-in-the-kcworks-container"]], "Running Invenio CLI Commands": [[2, "running-invenio-cli-commands"]], "Running automated tests (NEEDS UPDATING)": [[5, "running-automated-tests-needs-updating"]], "SAML Authentication": [[4, "saml-authentication"]], "Standardized environment variables": [[6, "standardized-environment-variables"]], "Start the uwsgi applications and celery worker": [[6, "start-the-uwsgi-applications-and-celery-worker"]], "Startup and shutdown scripts": [[6, "startup-and-shutdown-scripts"]], "Subject headings": [[10, "subject-headings"]], "Tagging Releases": [[5, "tagging-releases"]], "Template Customizations": [[4, "template-customizations"]], "The basic build process (slow)": [[5, "the-basic-build-process-slow"]], "Updating an Instance with Upstream Changes": [[5, "updating-an-instance-with-upstream-changes"]], "Updating the running KCWorks instance with development changes": [[5, "updating-the-running-kcworks-instance-with-development-changes"]], "Use the application!": [[6, "use-the-application"]], "User Data Sync (invenio-remote-user-data-kcworks)": [[4, "user-data-sync-invenio-remote-user-data-kcworks"]], "User-first-record notifications": [[4, "user-first-record-notifications"]], "Variables for local credentials": [[6, "variables-for-local-credentials"]], "Version Control": [[5, "version-control"]], "Version Numbering": [[5, "version-numbering"]], "View container logging output": [[6, "view-container-logging-output"]], "View logging output for uwsgi processes": [[6, "view-logging-output-for-uwsgi-processes"]], "Welcome to the Knowledge Commons Works technical documentation!": [[7, null]], "Works": [[10, "works"]], "custom_fields.hclegacy:collection": [[4, "custom-fields-hclegacy-collection"], [10, "custom-fields-hclegacy-collection"]], "custom_fields.hclegacy:committee_deposit": [[4, "custom-fields-hclegacy-committee-deposit"], [10, "custom-fields-hclegacy-committee-deposit"]], "custom_fields.hclegacy:file_location": [[4, "custom-fields-hclegacy-file-location"], [10, "custom-fields-hclegacy-file-location"]], "custom_fields.hclegacy:file_pid": [[4, "custom-fields-hclegacy-file-pid"], [10, "custom-fields-hclegacy-file-pid"]], "custom_fields.hclegacy:groups_for_deposit": [[4, "custom-fields-hclegacy-groups-for-deposit"], [10, "custom-fields-hclegacy-groups-for-deposit"]], "custom_fields.hclegacy:previously_published": [[4, "custom-fields-hclegacy-previously-published"], [10, "custom-fields-hclegacy-previously-published"]], "custom_fields.hclegacy:publication_type": [[4, "custom-fields-hclegacy-publication-type"], [10, "custom-fields-hclegacy-publication-type"]], "custom_fields.hclegacy:record_change_date": [[4, "custom-fields-hclegacy-record-change-date"], [10, "custom-fields-hclegacy-record-change-date"]], "custom_fields.hclegacy:record_creation_date": [[4, "custom-fields-hclegacy-record-creation-date"], [10, "custom-fields-hclegacy-record-creation-date"]], "custom_fields.hclegacy:record_identifier": [[4, "custom-fields-hclegacy-record-identifier"], [10, "custom-fields-hclegacy-record-identifier"]], "custom_fields.hclegacy:submitter_affiliation": [[4, "custom-fields-hclegacy-submitter-affiliation"], [10, "custom-fields-hclegacy-submitter-affiliation"]], "custom_fields.hclegacy:submitter_id": [[4, "custom-fields-hclegacy-submitter-id"], [10, "custom-fields-hclegacy-submitter-id"]], "custom_fields.hclegacy:submitter_org_memberships": [[4, "custom-fields-hclegacy-submitter-org-memberships"], [10, "custom-fields-hclegacy-submitter-org-memberships"]], "custom_fields.hclegacy:total_downloads": [[4, "custom-fields-hclegacy-total-downloads"], [10, "custom-fields-hclegacy-total-downloads"]], "custom_fields.hclegacy:total_views": [[4, "custom-fields-hclegacy-total-views"], [10, "custom-fields-hclegacy-total-views"]], "invenio-communities": [[4, "invenio-communities"]], "invenio-rdm-records": [[4, "invenio-rdm-records"]], "invenio-records-resources": [[4, "invenio-records-resources"]], "invenio-vocabularies": [[4, "invenio-vocabularies"]], "kcr:ai_usage": [[4, "kcr-ai-usage"], [10, "kcr-ai-usage"]], "kcr:book_series": [[4, "kcr-book-series"], [10, "kcr-book-series"]], "kcr:chapter_label": [[4, "kcr-chapter-label"], [10, "kcr-chapter-label"]], "kcr:commons_domain": [[4, "kcr-commons-domain"], [10, "kcr-commons-domain"]], "kcr:commons_search_recid (system field)": [[4, "kcr-commons-search-recid-system-field"], [10, "kcr-commons-search-recid-system-field"]], "kcr:commons_search_updated (system field)": [[4, "kcr-commons-search-updated-system-field"], [10, "kcr-commons-search-updated-system-field"]], "kcr:content_warning": [[4, "kcr-content-warning"], [10, "kcr-content-warning"]], "kcr:course_title": [[4, "kcr-course-title"], [10, "kcr-course-title"]], "kcr:degree": [[4, "kcr-degree"], [10, "kcr-degree"]], "kcr:discipline": [[4, "kcr-discipline"], [10, "kcr-discipline"]], "kcr:edition": [[4, "kcr-edition"], [10, "kcr-edition"]], "kcr:institution_department": [[4, "kcr-institution-department"], [10, "kcr-institution-department"]], "kcr:media": [[4, "kcr-media"], [10, "kcr-media"]], "kcr:meeting_organization": [[4, "kcr-meeting-organization"], [10, "kcr-meeting-organization"]], "kcr:project_title": [[4, "kcr-project-title"], [10, "kcr-project-title"]], "kcr:publication_url": [[4, "kcr-publication-url"], [10, "kcr-publication-url"]], "kcr:sponsoring_institution": [[4, "kcr-sponsoring-institution"], [10, "kcr-sponsoring-institution"]], "kcr:submitter_email": [[4, "kcr-submitter-email"], [10, "kcr-submitter-email"]], "kcr:submitter_username": [[4, "kcr-submitter-username"], [10, "kcr-submitter-username"]], "kcr:user_defined_tags": [[4, "kcr-user-defined-tags"], [10, "kcr-user-defined-tags"]], "metadata.creators/metadata.contributors": [[4, "metadata-creators-metadata-contributors"], [10, "metadata-creators-metadata-contributors"]], "metadata.subjects": [[4, "metadata-subjects"], [10, "metadata-subjects"]]}, "docnames": ["CHANGES", "README", "cli_commands", "configuration", "customizations", "developing", "in_depth", "index", "infrastructure", "installation", "metadata", "reference"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["CHANGES.md", "README.md", "cli_commands.md", "configuration.md", "customizations.md", "developing.md", "in_depth.md", "index.rst", "infrastructure.md", "installation.md", "metadata.md", "reference.md"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 2, 4, 5, 6, 10], "0": [1, 5, 7, 9, 10], "00": [4, 10], "0000": [4, 10], "0001": 10, "00k4n6c32": 10, "00z": [4, 10], "01": [4, 10], "01t00": [4, 10], "0378": 10, "04": 6, "06": 10, "09": 10, "1": [4, 5, 7, 10], "10": [7, 9, 10], "1001634": [4, 10], "1086436": 10, "11": [6, 7, 10], "111023": 10, "12": [6, 7, 9], "123": 10, "1234": 10, "123456": [4, 10], "12345abcd": 10, "1263": [4, 10], "17": [7, 9], "18": 7, "19": 6, "2": [5, 6, 7, 10], "20": [7, 9], "2018": 10, "2020": 10, "2022": 10, "2023": 1, "2024": [4, 7, 10], "2025": 10, "2029": 10, "22": 6, "2345": 10, "24": [1, 10], "251587": 10, "2nd": 10, "3": [1, 5, 7], "30": 7, "32": 10, "4": 10, "456": 10, "458": 10, "5601": [6, 9], "5955": 10, "6": 6, "60": 10, "6379": 6, "63932": 10, "6780": 10, "6789": 10, "8": 10, "8601": [4, 10], "8gb": 6, "9200": 6, "94682": 10, "958235": 10, "966892": 10, "A": [0, 4, 10], "At": 6, "But": 9, "By": 5, "For": [2, 4, 5, 6, 10], "If": [4, 5, 6, 9, 10], "In": [5, 7, 10], "It": [0, 1, 2, 4, 5, 6, 9, 10], "NOT": 9, "No": 5, "On": [2, 6], "One": [4, 6, 10], "Or": [5, 6], "TO": 9, "That": [4, 10], "The": [0, 4, 6, 9, 10, 11], "Then": [2, 5, 6], "There": [5, 6], "These": [0, 2, 4, 5, 6, 9, 10], "To": [2, 5, 6, 9], "With": [0, 6], "__init__": 5, "__name__": 5, "abl": 6, "about": [5, 7, 10], "abov": 5, "abus": [4, 10], "ac": 10, "academ": [1, 4, 10], "access": [0, 6, 9, 10], "account": [4, 10], "acronym": 10, "activ": [5, 6, 9, 10], "actual": [6, 10], "ad": [0, 4, 10], "add": [0, 4, 5, 7, 9, 10], "addit": [4, 5, 9, 10], "addition": 6, "additional_descript": 10, "additional_titl": 10, "address": [4, 6, 10], "admin": [4, 10], "administr": [6, 9], "advis": 6, "affect": 0, "affili": [4, 10], "after": [5, 6, 9], "ag": 10, "again": [5, 6], "against": 6, "aggreg": [2, 4, 10], "ai": [4, 10], "ai_descript": [4, 10], "ai_us": [4, 10], "alia": 6, "alias": 5, "all": [0, 2, 4, 5, 6, 9, 10], "allow": [0, 4, 6, 9, 10], "alon": 5, "along": [4, 5, 10], "alongsid": 6, "alreadi": [5, 6], "also": [0, 2, 4, 5, 6, 10], "altern": [6, 10], "although": 10, "alwai": [0, 6], "ambigu": [4, 10], "american": [4, 10], "among": 0, "an": [0, 1, 4, 7, 9, 10, 11], "anaconda": 6, "ani": [2, 4, 5, 6, 10], "anoth": 6, "api": [0, 2, 5, 6, 9], "api_token": 6, "app": [6, 9], "appear": [0, 9, 10], "append": 6, "applic": [5, 7, 10], "approach": 6, "appropri": [6, 10], "ar": [0, 2, 4, 5, 6, 9, 10], "area": [4, 10], "aren": 6, "argument": 2, "aria": 0, "arli": 0, "arlisna": [4, 10], "arrai": [4, 10], "art": [4, 10], "articl": [4, 10], "artifact": [4, 10], "artist": [4, 10], "ask": 6, "asset": 5, "assign": [4, 6, 10], "assignfast": [4, 10], "associ": [4, 10], "assum": 6, "attach": 10, "audio": [4, 10], "augment": 10, "austen": [4, 10], "author": 10, "auto": 0, "autom": 7, "automat": [4, 5, 6, 10], "avail": [2, 5, 6, 10], "avoid": 5, "aw": 6, "awar": [4, 6, 10], "award": 10, "b": 5, "back": [0, 2, 5], "backend": 4, "background": 6, "bar": [6, 10], "base": [4, 10], "bash": [2, 5, 6, 9], "bashrc": 6, "basic": 10, "beat": 6, "becaus": [0, 4, 5, 6, 10], "been": [0, 4, 5, 6, 10], "befor": [2, 4, 5, 6, 10], "begin": [5, 6], "being": [0, 6], "belong": [4, 10], "below": [6, 9, 10], "best": [0, 6], "beta": 5, "beta3": 7, "beta4": 7, "beta5": 7, "beta6": [1, 5, 7], "between": [4, 5, 10], "beyond": [4, 10], "big": 6, "bin": 6, "bind": [6, 9], "block": 6, "blueski": 0, "book": [4, 10], "boolean": [4, 10], "boot": 6, "both": [0, 4, 10], "break": 6, "browser": [5, 9], "bug": [0, 5], "bugfix": 5, "build": [4, 7], "builder": 4, "built": [1, 6, 11], "bulk": [2, 7], "bundl": 5, "c": [5, 6], "cach": 6, "call": [4, 6, 10], "can": [0, 2, 4, 5, 6, 9, 10, 11], "cannot": 5, "case": [4, 5, 10], "caution": [2, 5, 9], "cc": 10, "cd": [5, 6, 9], "central": [4, 5, 10], "cern": 11, "ch": 11, "chang": [4, 6, 7, 9, 10], "change_m": 6, "chapter": [4, 10], "chatgpt": 10, "check": [4, 6], "chmod": 6, "choos": 0, "chose": 6, "chrome": 5, "chronolog": [4, 10], "class": 4, "clean": 5, "clearer": 0, "cli": [0, 7, 9], "click": 6, "client": 5, "clone": [5, 7], "cm": 10, "co": 6, "code": [7, 9, 10], "codebas": 9, "coderepositori": 10, "cog": 6, "collabor": [1, 10], "collect": [0, 2, 5, 7, 9], "com": [4, 6, 9, 10], "command": [0, 5, 7, 9], "commerci": 10, "commiss": [4, 10], "committe": [4, 10], "common": [0, 1, 4, 5, 9, 10, 11], "commons_api_token": 6, "commons_search_api_token": 6, "commun": [0, 9], "comparison": 0, "compil": 6, "complement": [4, 10], "complet": [4, 5, 9, 10], "compon": [0, 4, 5], "compos": [5, 7], "comput": 6, "condit": 10, "conf": 5, "confer": [4, 10], "config": [4, 6], "configur": [5, 7], "confus": 0, "consid": 5, "constrain": [4, 10], "contain": [0, 4, 5, 7, 9, 10], "container": 7, "content": [9, 10], "continu": 5, "control": [4, 7], "conveni": 6, "convert": [4, 10], "coordin": 10, "copi": [5, 6, 9], "copyright": 7, "core": [2, 7, 9], "corpor": [4, 10], "correct": [2, 6, 9], "correctli": 0, "correspond": [2, 4, 10], "could": 0, "count": 2, "cours": [4, 6, 10], "cover": [4, 10], "cpython": 6, "creat": [0, 2, 4, 5, 10], "creatibutorsfield": 0, "creation": [0, 4], "creativecommon": 10, "credit": 10, "ctrl": [5, 6], "curl": 6, "current": [0, 5, 6, 10], "custom": [0, 5, 6, 7, 11], "custom_pdf_viewer_j": 5, "d": [5, 6, 9], "daemon": 6, "dashboard": [6, 9], "data": [0, 2, 5, 6, 9, 10], "databas": [2, 4, 10], "datacit": 10, "dataset": 10, "date": [0, 4, 6, 10], "datetim": [4, 10], "db": 6, "de": 10, "debug": [5, 9], "declar": 5, "deeper": 7, "default": [0, 4, 5, 6, 10], "defin": [4, 5, 6, 10], "delet": [2, 5], "demo": 6, "depart": [4, 10], "depend": [5, 6, 9], "deploi": [2, 5], "deploy": 5, "deposit": [7, 9, 10], "depth": 7, "describ": [4, 5, 9, 10], "descript": 10, "descriptor": [4, 10], "desir": [0, 4, 10], "desktop": 6, "despair": 9, "destroi": [2, 6, 9], "detail": [0, 7, 9, 10], "determin": [4, 10], "dev": [6, 9], "develop": [2, 6, 7, 11], "developmentstatu": 10, "dict": 5, "dictionari": 5, "differ": [4, 9, 10], "differenti": [4, 10], "dig": 7, "digit": 10, "direction": 4, "directli": [5, 6], "directori": 6, "discoveri": [4, 10], "displai": [0, 2], "dissert": [4, 10], "distinct": [4, 5, 10], "distress": [4, 10], "distribut": 10, "divid": [0, 2, 4, 10], "divis": 0, "dnb": 10, "do": [5, 6, 9], "doc": [5, 6, 11], "docker": [2, 5, 7], "dockerfil": 6, "document": [2, 4, 5, 6, 10], "doe": [0, 4, 5, 6, 10], "doi": 0, "domain": [4, 10], "don": 9, "done": [5, 6], "down": [6, 9], "download": [4, 6, 10], "dphil": [4, 10], "draft": 4, "drawn": 10, "driver": 6, "dummi": 6, "dure": [0, 2, 4, 5, 6, 9, 10], "dynam": [2, 5], "e": [0, 2, 4, 5, 9, 10], "e2": 5, "each": [0, 4, 5, 6, 9, 10], "easi": 6, "edit": 0, "educ": [4, 10], "effect": [4, 5, 10], "effici": [4, 10], "either": [2, 6, 9, 10], "els": 6, "elsewher": 10, "email": [2, 6, 9, 10], "emailbackend": 4, "embargo": 10, "emit": 4, "emploi": [4, 5, 10], "empti": 0, "emul": 5, "en": 10, "enabl": [4, 10], "encourag": [4, 10], "end": [0, 5], "eng": 10, "engin": 6, "english": 10, "enough": 6, "ensur": [5, 9], "enter": [5, 6, 9], "entri": [4, 10], "env": [6, 9], "environ": [5, 7, 9], "error": [0, 5], "especi": [0, 5, 6], "etc": [2, 4, 5, 9, 10], "europ": [4, 10], "even": [0, 4, 10], "event": [0, 2, 4, 6, 10], "everi": 5, "exampl": [2, 4, 5, 6, 7], "except": [5, 10], "exec": [2, 5, 6, 9], "exist": [0, 2, 5, 6], "explain": [6, 9], "export": 2, "extens": [4, 5, 6], "extern": 10, "extra": 6, "extrem": 2, "f": 6, "facet": [4, 10], "fall": 10, "famili": 0, "family_nam": 10, "fast": 4, "favour": 10, "featur": [5, 10], "feedback": 9, "field": [0, 7], "file": [1, 2, 4, 7, 10], "fill": [0, 10], "final": 6, "find": [0, 2, 5, 6, 9], "first": [2, 5, 6, 9], "firstrecordcreatednotificationbuild": 4, "firstrecordcreatednotificationservic": 4, "firstrecordpublishednotificationbuild": 4, "fix": [0, 5], "fixtur": [5, 6, 9], "flag": [4, 6, 10], "flask": [2, 4, 5, 7], "flexibli": [4, 10], "flow": 5, "folder": [6, 9], "follow": [2, 4, 5, 6, 9, 10], "foo": 10, "forc": [5, 6], "fork": [6, 7], "form": [0, 7, 9, 10], "format": 10, "formgenr": [4, 10], "found": [2, 4, 10, 11], "four": 5, "free": [4, 6, 10], "freecodecamp": 6, "from": [0, 2, 4, 5, 6, 9], "frontend": 6, "full": [0, 6, 7], "function": 0, "fund": [4, 10], "further": [2, 6, 9], "futur": 0, "g": [0, 2, 4, 5, 9, 10], "gender": 10, "gener": [2, 4, 5, 6, 10], "geograph": [4, 10], "geometri": 10, "geonam": 10, "geopattern": 5, "get": [0, 6], "gh_page": 5, "git": 6, "github": [5, 6, 9, 10], "gitlab": 5, "given": 0, "given_nam": 10, "gnd_node": 10, "gninx": 6, "good": 6, "grant": [4, 10], "grep": 2, "group": [2, 5, 6, 9, 10], "group_identifi": [4, 10], "group_nam": [4, 10], "guarante": 6, "guid": 6, "h1": 10, "ha": [0, 4, 5, 6, 10], "handl": 0, "have": [0, 4, 5, 6, 9, 10], "hc": 7, "hcommon": [4, 10], "head": 4, "header": 0, "help": [2, 4, 5, 6, 10], "here": [4, 6, 9, 10], "hidden": 0, "histor": [4, 10], "histori": [4, 5, 10], "historian": [4, 10], "hold": [4, 6, 10], "homoit0000669": [4, 10], "homosauru": 4, "host": [4, 10], "hour": 9, "how": [2, 10], "how2shout": 6, "howev": 10, "html": [4, 6, 10], "http": [4, 5, 6, 9, 10, 11], "human": [4, 10], "hyphen": [4, 6, 10], "i": [0, 1, 2, 4, 5, 9, 10, 11], "icon": 6, "id": [0, 4, 10], "idea": 6, "ident": 10, "identifi": [0, 4, 7], "identifier_orcid": 10, "illustr": 10, "imag": [0, 5, 6], "immedi": 5, "implement": 7, "import": [2, 5, 6, 7, 9, 10], "import_data": 6, "impos": [4, 10], "imprint": 10, "includ": [0, 1, 2, 4, 6, 9, 10, 11], "increment": 5, "index": [2, 4, 6, 10], "indic": [2, 9], "individu": 6, "info": [4, 6, 10], "inform": [5, 10, 11], "informationen": 10, "infrastructur": [0, 7], "ini": 6, "init": [5, 9], "initi": [0, 5], "insert": [6, 9], "insid": [2, 5, 6, 9], "instal": [5, 7], "instanc": [1, 2, 6, 7, 9, 11], "instance_path": [6, 9], "instead": [0, 5, 6], "institut": [4, 10], "instruct": [4, 5, 7, 9, 10], "instructionalresourc": 10, "integ": [4, 10], "integr": [5, 7, 10], "intend": [4, 10], "inter": [5, 9], "interact": 5, "interfac": 6, "intern": [4, 10], "interpret": 6, "intersex": [4, 10], "introduc": 5, "introduct": [4, 10], "invenio": [7, 9, 10], "invenio_": 6, "invenio_app": 6, "invenio_csrf_secret_salt": 6, "invenio_custom_pdf_view": 5, "invenio_datacite_password": 6, "invenio_instance_path": 6, "invenio_notif": 4, "invenio_record_importer_data_dir": 6, "invenio_record_importer_local_data_dir": 6, "invenio_search_domain": 6, "invenio_secret_kei": 6, "invenio_security_login_salt": 6, "invenio_site_api_url": 6, "invenio_site_ui_url": 6, "invenio_sqlalchemy_database_uri": 6, "inveniordm": [1, 2, 5, 6, 7], "invert": 0, "invok": 2, "involv": [0, 4, 5, 9, 10], "iscitedbi": 10, "iso": [4, 10], "issu": 10, "item": [4, 10], "its": [0, 5, 6, 9, 10], "itself": [4, 10], "j": [0, 7], "jammi": 6, "jane": [4, 10], "janedo": 10, "javascript": 10, "jdoe": [4, 10], "jest": 5, "jinja": 4, "john": [4, 10], "journal": [4, 10], "json": [2, 5, 6], "kc": [0, 2, 6, 7], "kc_usernam": [4, 10], "kcr": 6, "kcr_api": 6, "kcr_ui": 6, "kcwork": [0, 6, 7], "keep": [5, 6], "keyboard": 0, "kingston": [4, 10], "knowldg": 9, "knowledg": [0, 1, 5, 9, 10, 11], "label": [0, 4, 10], "lago": 10, "lambda": 6, "lang": 10, "languag": 10, "last": [2, 4, 5, 10], "latest": 5, "latin": [4, 10], "launch": 10, "layout": 0, "lcsh": [4, 10], "lcsh2fast": [4, 10], "lead": 0, "least": [0, 6], "leav": 5, "leftov": 5, "legaci": [2, 7], "legalcod": 10, "less": [4, 5, 10], "level": [4, 10], "lib": 6, "licens": [1, 10], "like": [5, 6], "likewis": 5, "line": [0, 2, 9], "link": [0, 2, 4, 10], "linux": 5, "list": [2, 4, 5, 10], "literatur": [4, 10], "live": [6, 9], "load": 2, "local": [2, 5, 7], "localhost": [6, 9], "locat": [4, 5, 10], "lock": 6, "log": 4, "loglevel": 6, "logo": 0, "long": [0, 5, 6], "lost": 2, "lowercas": [4, 10], "lt": 6, "m": 5, "ma": [4, 10], "mac": 6, "machin": 6, "made": [0, 5, 10], "mai": [4, 5, 6, 9, 10], "mail": 4, "main": [0, 2, 4, 5, 9, 10], "maintain": 10, "make": [5, 6, 9], "manag": [0, 5, 6], "manual": 6, "markdown": 4, "match": [0, 6], "materi": [4, 10], "matter": [4, 10], "md": 5, "mean": [0, 4, 5, 6, 10], "meantim": 5, "mechan": [4, 10], "media": 0, "meet": [4, 10], "member": 0, "memori": 6, "menu": 0, "merg": 5, "mesh": [1, 9], "messag": 0, "met": 10, "metadata": [0, 2, 7], "metadata_field": 7, "method": 10, "michigan": 10, "middl": 2, "might": [0, 4, 6, 10], "migrant": [4, 10], "migrat": [4, 10], "minor": 5, "mint": 10, "minut": 6, "miss": 0, "mit": 1, "mla": [4, 10], "modal": 0, "moder": 10, "moderatorrolerecipi": 4, "modern": [4, 10], "modifi": [0, 5], "modul": [0, 7, 9], "modular": 9, "monotask": 5, "more": [4, 5, 10], "most": [0, 5, 6], "mount": [6, 9], "mq": 6, "msu": 10, "much": [4, 10], "multipl": 0, "must": [4, 5, 6, 10], "my": 10, "myapitoken": 6, "mycours": 10, "myevent": 10, "myinveniodatacitepassword": 6, "mytoken": 6, "na": 0, "name": [0, 2, 4, 6, 9, 10], "name_parts_loc": 0, "namespac": [4, 10], "navig": [0, 5, 6, 9], "nc": 10, "necessari": [0, 6, 9], "need": [2, 7, 9], "new": [0, 4, 6, 10], "newer": 6, "newli": [4, 10], "newlin": 6, "next": [5, 6], "nginx": 9, "node": 7, "node_modul": 5, "normal": [5, 6, 9], "note": [2, 5, 9, 10], "notif": 7, "notificationop": 4, "notifications_moderator_rol": 4, "now": [0, 6, 9], "npm": 5, "number": [2, 4, 7, 10], "nvm": 7, "o": 6, "object": [4, 5], "obtain": 6, "occupi": 5, "oclc": [4, 10], "octob": 10, "often": [5, 6], "old": 6, "onc": [5, 6], "one": [4, 6, 9, 10], "onli": [0, 2, 4, 5, 10], "onto": 9, "open": [6, 10], "openfund": 10, "opengraph": 0, "opensearch": [2, 6, 9], "oper": [4, 6, 9], "opt": [5, 6, 9], "option": [0, 2, 4, 5, 9, 10], "orcid": [0, 4], "order": [0, 5], "org": [4, 5, 6, 10], "organ": 4, "organiz": [4, 10], "origin": 5, "other": [0, 4, 5, 6, 10], "otherwis": [6, 10], "out": [6, 10], "output": 5, "over": 5, "overrid": [5, 10], "overridden": 5, "own": [5, 6], "ownership": [4, 10], "p": [2, 9, 10], "packag": [2, 6, 9, 10], "page": [0, 5, 7, 9, 10], "panel": 6, "paper": [4, 10], "parent": [6, 9, 10], "part": [0, 1, 2, 4, 10], "particular": [6, 9], "particularli": 5, "password": [2, 6, 9], "patch": 5, "path": [4, 10], "patienc": 9, "pdf": [4, 10], "pdfj": 5, "pedagogi": 10, "pend": 0, "perform": 6, "permiss": 0, "persist": [4, 5, 6, 10], "person": [4, 10], "person_or_org": [4, 10], "pgadmin": [6, 9], "pgadmin_default_email": 6, "pgadmin_default_password": 6, "phd": [4, 10], "pick": 5, "pid": [5, 6, 9, 10], "pidfil": 6, "pip": [5, 6], "pipenv": [5, 9], "pipfil": 5, "place": [4, 10], "plaintext": 4, "platform": 0, "poetri": [4, 10], "point": [0, 10], "possibl": [5, 10], "postgres_db": 6, "postgres_password": 6, "postgres_us": 6, "postgresql": 6, "potenti": [4, 10], "practic": 5, "prefix": [4, 10], "present": [0, 4, 10], "preserv": [4, 10], "press": 6, "previous": [0, 4, 10], "primari": [0, 4, 10], "primarili": [2, 4, 10], "print": [6, 10], "prior": [4, 6, 10], "privat": [6, 9], "problem": 5, "problemat": [4, 10], "proce": 6, "proceed": [4, 10], "process": [2, 10], "produc": [0, 2, 4, 10], "product": [2, 4, 5, 10], "professionel": 10, "profil": [0, 4, 10], "program": 10, "programminglanguag": 10, "project": [4, 5, 6, 10], "proper": [0, 4, 10], "properti": [0, 10], "provid": [2, 4, 5, 6, 9, 10], "provision": [9, 10], "prune": 5, "psychologi": 10, "psycopg2": 6, "public": [0, 4, 10], "publication_d": 10, "publish": [0, 4, 10], "pull": [5, 6], "purpos": [4, 10], "push": 5, "put": 6, "py": [2, 5], "pypi": 6, "pyproject": 5, "pytest": 5, "python": [7, 9, 10], "python3": 6, "python_local_git_packages_path": 6, "python_local_site_packages_path": 6, "queri": 0, "quick": 9, "quickli": 6, "quickstart": 7, "rabbitmq": 6, "race": 10, "random": [0, 6], "rather": 6, "rdm": [6, 9, 10], "rdmrecord": 4, "re": [5, 6, 10], "reach": 5, "react": 5, "read": 2, "readabl": [4, 5, 10], "reader": [4, 10], "readi": 5, "readm": 5, "real": 6, "reason": [6, 10], "rebuild": 6, "rebuilt": 5, "receiv": [4, 6], "recent": [0, 5], "recipi": 4, "recommend": 6, "record": [0, 2, 5, 7, 9], "recreat": [5, 6], "recurs": [5, 9], "redi": 6, "redis_domain": 6, "redund": [5, 9], "refactor": 0, "refer": [5, 6, 7, 9, 10], "reflect": [5, 9], "refresh": 5, "refuge": [4, 10], "regardless": 6, "registri": 10, "rel": [4, 10], "relat": [5, 10], "related_identifi": 10, "relation_typ": 10, "releas": [1, 6], "reliabl": 6, "reload": [5, 6, 9], "remot": [0, 2, 5, 6, 9, 10], "remov": 0, "replac": 6, "repo": 5, "repositori": [1, 5, 6, 10], "repres": 5, "request": [0, 5, 6], "requir": [4, 5, 7, 9, 10], "research": [1, 4, 9, 10], "resid": [4, 10], "resourc": [0, 6, 9], "resource_typ": 10, "respect": 5, "respond": 5, "respons": 6, "rest": [6, 9], "restart": [5, 6, 9], "restrict": 10, "result": 0, "right": [0, 6, 10], "role": [4, 6], "root": [5, 6], "rout": 0, "run": [4, 6, 7, 9], "runner": 5, "same": [4, 6, 10], "sandbox": 10, "save": 4, "schema": [0, 7], "scheme": [4, 7], "scienc": [4, 10], "script": [5, 9], "search": [0, 2, 9, 10], "second": [4, 10], "secret": 6, "section": 10, "secur": 6, "see": [1, 5, 6, 9, 10], "seen": 6, "select": 0, "selenium": 5, "self": 0, "semant": [4, 5], "semver": 5, "send": 4, "sent": 4, "separ": [5, 6, 9], "seri": [4, 10], "serial": 2, "series_titl": [4, 10], "series_volum": [4, 10], "serv": [6, 9], "server": [5, 9], "serverless": 6, "servic": [0, 2, 4, 7, 10], "services_setup": 9, "session": 6, "set": [4, 5, 6, 9, 10], "setup": [5, 6, 7], "sever": 6, "sexual": 10, "sh": [5, 6, 9], "share": [0, 1, 6, 10], "shell": 6, "should": [0, 4, 5, 6, 9, 10], "sidebar": 0, "signal": 4, "similarli": [4, 9, 10], "simpl": [4, 10], "simpli": [5, 6], "sinc": [0, 2, 5, 6], "singl": [2, 5, 10], "site": [2, 6, 7, 9], "size": [6, 10], "sl": 6, "slackbot": 6, "slider": 6, "so": [0, 2, 4, 5, 6, 9, 10], "social": 0, "softwar": [4, 10], "solut": 6, "solv": 0, "some": [0, 4, 5, 9, 10], "someth": 6, "sometim": [0, 5], "sort": [0, 10], "sourc": [5, 6, 9], "specif": [0, 4, 6, 10], "specifi": 6, "sponsor": [4, 10], "squash": 5, "src": 5, "stage": [2, 5, 6], "stamp": 6, "stand": 5, "standalon": 6, "standard": [4, 10], "standardisierung": 10, "start": 5, "stat": [2, 4, 10], "state": 10, "statement": 9, "static": 9, "statu": [4, 10], "stdout": 6, "step": [5, 6, 9], "stop": [5, 6, 9], "store": [1, 2, 4, 5, 6, 10], "string": [0, 4, 10], "strongli": [4, 10], "structur": [6, 10], "style": 5, "sub": [2, 4, 6, 10], "submiss": 0, "submit": 0, "submitt": [4, 10], "submodul": 9, "substant": [4, 10], "subtitl": 10, "sudo": 6, "suffix": 5, "suggest": [4, 10], "suit": 5, "suitabl": 2, "superus": 6, "supplement": [4, 10], "suppli": 6, "support": [5, 6, 10], "sur": 6, "sure": [5, 6], "syllabi": [4, 10], "syllabu": 10, "sync": 0, "syntax": 6, "synthet": 2, "system": [0, 1, 2, 5, 9], "systemd": 6, "t": [6, 9], "tab": 6, "tabl": 6, "tag": [4, 10], "tail": 6, "take": [5, 6, 9], "task": 5, "teach": 10, "technic": [0, 10], "technisch": 10, "tell": 6, "templat": 7, "temporari": 5, "termin": [5, 6], "test": [6, 7, 9, 10], "text": 10, "than": 6, "thei": [0, 4, 5, 10], "them": [0, 5, 6], "theses": [4, 10], "thesi": [4, 10], "thi": [0, 2, 4, 5, 6, 9, 10], "thing": 0, "those": [4, 5, 6, 9, 10], "though": 5, "three": 6, "through": 5, "time": [4, 5, 6, 9, 10], "titl": [0, 4, 10], "tmp": [5, 6, 9], "token": 6, "token_hex": 6, "toml": 5, "tool": [1, 4, 7, 10], "top": [4, 6, 10], "topic": [4, 10], "toronto": [4, 10], "total": [4, 10], "total_volum": 10, "track": 4, "true": [4, 9, 10], "try": 5, "tweak": 0, "two": [0, 4, 5, 6, 10], "txt": 1, "type": [0, 4], "u": [4, 6, 10], "ubuntu": 6, "ui": [0, 2, 4, 5, 6, 9], "ukranian": [4, 10], "ultim": 5, "under": [1, 5, 6, 9], "underli": 2, "uni": 4, "unit": [4, 5], "univers": [4, 10], "unknown": 0, "unless": [5, 6, 9], "unlik": [4, 10], "unpublish": [4, 10], "unread": 4, "until": [5, 10], "up": [2, 5, 6, 9], "updat": [0, 2, 4, 7, 9, 10], "upload": [0, 5], "upstream": 7, "url": [4, 10], "us": [0, 2, 4, 5, 7, 9, 10], "usag": [2, 4, 10], "user": [0, 2, 5, 10], "user_object": 10, "user_profil": 10, "usermod": 6, "usernam": 4, "usr": 6, "usual": 5, "uwsgi": [5, 9], "uwsgi_api": 9, "uwsgi_rest": 6, "uwsgi_ui": [5, 6, 9], "v": [5, 6], "v1": 10, "v16": 6, "v2": 6, "v3": [4, 10], "valid": [4, 10], "valu": [0, 4, 6, 10], "var": [6, 9], "variabl": [4, 5], "variat": [4, 10], "varieti": 9, "variou": [6, 9, 10], "veri": 5, "version": [0, 1, 4, 7, 9, 10], "via": [4, 5, 6], "view": [0, 4, 5, 10], "virtual": 6, "virtualenv": 6, "visibl": [0, 5], "vocabulari": [7, 9], "volum": [4, 5, 6, 10], "voluntarili": [4, 10], "wa": [0, 4, 10], "wai": [4, 6, 10], "walk": 5, "want": [4, 5, 6, 9, 10], "warn": [2, 4, 5, 10], "watch": [5, 6], "watercolor": [4, 10], "we": 5, "web": [5, 6, 9], "webdriv": 5, "webhook": 4, "webpack": 5, "webpackthemebundl": 5, "well": [0, 4, 5, 6], "were": [0, 4, 6, 10], "what": [5, 10], "when": [0, 4, 5, 6, 9, 10], "whenev": [2, 5], "where": [0, 5, 6, 9], "wherev": 5, "whether": 4, "which": [0, 4, 5, 6, 9, 10], "whichev": 6, "while": [5, 9], "white": [4, 10], "whole": [0, 4, 10], "whose": 0, "widget": 0, "wikidata": 10, "window": [5, 6], "wip": 5, "within": [0, 4, 10], "without": [5, 6], "word": 0, "work": [0, 1, 4, 5, 9, 11], "worker": [2, 5], "workshop": [4, 10], "worldcat": [4, 10], "would": [0, 2, 4, 5, 6, 10], "wrap": [0, 2], "written": 6, "wsl2": 5, "www": [4, 6, 10], "x": [6, 10], "x86_64": 6, "ye": 5, "yet": 6, "yml": [5, 6, 9], "you": [2, 4, 5, 6, 9, 10], "your": 5, "zenodo": 10, "zshrc": 6}, "titles": ["Changes", "About", "CLI Commands", "Configuration of InvenioRDM", "Customizations to InvenioRDM", "Developing KCWorks", "In-depth Installation Instructions (NEEDS UPDATING)", "Welcome to the Knowledge Commons Works technical documentation!", "KCWorks Infrastructure", "Installation", "Metadata Schema, Vocabularies, and Identifiers", "Reference"], "titleterms": {"0": [0, 6], "1": [0, 6, 9], "10": [0, 6], "11": 0, "12": 0, "16": 6, "17": 6, "18": 0, "2": [0, 9], "20": 6, "2024": 0, "3": [0, 6, 9], "30": 0, "4": 9, "5": 9, "6": 9, "9": 6, "In": [4, 6], "The": 5, "about": [1, 4, 6], "ad": 5, "add": 6, "addit": 6, "admin": [6, 9], "ai_usag": [4, 10], "an": [5, 6], "api": [4, 10], "app": 4, "applic": [6, 9], "asset": 9, "authent": 4, "autom": 5, "basic": 5, "beta3": 0, "beta4": 0, "beta5": 0, "beta6": 0, "book_seri": [4, 10], "branch": 5, "build": [5, 6, 9], "bulk": 4, "celeri": 6, "cfg": 5, "chang": [0, 5], "chapter_label": [4, 10], "cli": [2, 6], "clone": [6, 9], "code": [5, 6], "collect": [4, 10], "command": [2, 6], "commit": 5, "committee_deposit": [4, 10], "common": [6, 7], "commons_domain": [4, 10], "commons_search_recid": [4, 10], "commons_search_upd": [4, 10], "commun": 4, "compos": [6, 9], "configur": [3, 6, 9], "contain": [2, 6], "container": 6, "content": [4, 7], "content_warn": [4, 10], "context": 6, "contributor": [4, 10], "control": [5, 6, 9, 10], "copyright": 1, "core": [4, 10], "course_titl": [4, 10], "creat": [6, 9], "creation": 10, "creator": [4, 10], "credenti": 6, "css": 5, "custom": [2, 4, 10], "custom_field": [4, 10], "data": 4, "databas": [6, 9], "deeper": 5, "degre": [4, 10], "deposit": 4, "deprec": 10, "depth": 6, "detail": 4, "develop": [5, 9], "dig": 5, "disciplin": [4, 10], "docker": [6, 9], "document": [7, 11], "doi": 10, "edit": [4, 10], "email": 4, "enabl": 6, "ensur": 6, "entri": 5, "environ": 6, "error": 6, "exampl": 10, "extern": 5, "fast": [5, 10], "field": [4, 10], "file": [5, 6, 9], "file_loc": [4, 10], "file_pid": [4, 10], "first": 4, "fix": 6, "flask": 9, "fly": 5, "folder": 5, "fork": 4, "form": 4, "found": 6, "framework": 4, "from": 10, "full": 9, "funder": 10, "git": [5, 9], "gnd": 10, "grid": 10, "group": 4, "groups_for_deposit": [4, 10], "hc": [4, 10], "hclegaci": [4, 10], "head": 10, "homosauru": 10, "html": 5, "i": 6, "identifi": 10, "implement": [4, 10], "import": 4, "includ": 5, "indic": 6, "inform": 6, "infrastructur": 8, "initi": [6, 9], "instal": [6, 9], "instanc": 5, "institution_depart": [4, 10], "instruct": 6, "integr": 4, "invenio": [2, 4, 5, 6], "inveniordm": [3, 4, 10, 11], "isbn": 10, "isni": 10, "issn": 10, "j": [5, 6], "javascript": 5, "json": 10, "just": 6, "kc": [4, 10], "kcr": [4, 10], "kcwork": [2, 4, 5, 8, 9, 10], "knowledg": [6, 7], "legaci": [4, 10], "limit": 5, "line": 6, "linux": 6, "local": [6, 9], "log": 6, "maco": 6, "media": [4, 10], "meeting_organ": [4, 10], "metadata": [4, 10], "metadata_field": [4, 10], "moder": 4, "modul": [4, 5, 6], "modular": 4, "name": 5, "need": [5, 6], "new": 5, "nginx": 6, "node": [5, 6], "note": [4, 6], "notif": 4, "number": 5, "nvm": 6, "oai": 10, "object": 10, "ofr": 10, "orcid": 10, "organ": 10, "other": 9, "output": 6, "overrid": 4, "own": 9, "packag": [4, 5], "page": 4, "path": 6, "peopl": 10, "pipenv": 6, "point": 5, "previously_publish": [4, 10], "process": [5, 6], "project": 9, "project_titl": [4, 10], "provis": 4, "provision": 4, "publication_typ": [4, 10], "publication_url": [4, 10], "pyenv": 6, "python": [5, 6], "queue": 6, "quickstart": 9, "rdm": 4, "rebuild": 5, "recommend": 10, "record": [4, 10], "record_change_d": [4, 10], "record_creation_d": [4, 10], "record_identifi": [4, 10], "refer": 11, "releas": 5, "remot": 4, "repositori": 9, "requir": 6, "resourc": [4, 10], "retriev": 10, "role": 10, "ror": 10, "rotat": 6, "run": [2, 5], "saml": 4, "schema": [4, 10], "scheme": 10, "script": 6, "search": [4, 6], "sensit": 6, "server": 6, "servic": [6, 9], "setup": 9, "shutdown": 6, "site": [4, 5, 10], "slow": 5, "some": 6, "sponsoring_institut": [4, 10], "standard": 6, "start": [6, 9], "startup": 6, "static": 5, "strategi": 5, "subject": [4, 10], "submitter_affili": [4, 10], "submitter_email": [4, 10], "submitter_id": [4, 10], "submitter_org_membership": [4, 10], "submitter_usernam": [4, 10], "submodul": 5, "sync": 4, "system": [4, 6, 10], "tag": 5, "task": 6, "technic": 7, "templat": [4, 5], "test": 5, "theme": 5, "tool": 6, "total_download": [4, 10], "total_view": [4, 10], "type": 10, "updat": [5, 6], "upstream": 5, "us": 6, "user": [4, 6, 9], "user_defined_tag": [4, 10], "usernam": 10, "uwsgi": 6, "variabl": 6, "version": [5, 6], "view": [6, 9], "vocabulari": [4, 10], "welcom": 7, "work": [6, 7, 10], "worker": 6, "your": [6, 9]}})
\ No newline at end of file