Skip to main content

"Invenio module for sharedRDM theme."

Project description

https://github.com/sharedRDM/invenio-override/workflows/CI/badge.svg https://img.shields.io/pypi/dm/invenio-override.svg https://img.shields.io/github/tag/sharedRDM/invenio-override.svg https://img.shields.io/github/license/sharedRDM/invenio-override.svg https://readthedocs.org/projects/invenio-override/badge/?version=latest https://img.shields.io/badge/code%20style-black-000000.svg

Override invenioRDM theme.

Features:

  • Custom header template.

  • Custom footer template.

  • Custom login/signup templates.

  • Custom frontpage template.

  • Custom contact template.

  • Overriden theme.

Configuration fields with the default values available to enable/disable these package’s feature on a custom instance:

  • Global search

# Publications - Enable or disable the publication global search feature.
OVERRIDE_SHOW_PUBLICATIONS_SEARCH = False

# OER - Enable or disable the educational resources global search feature.
OVERRIDE_SHOW_EDUCATIONAL_RESOURCES = False

Note: by default invenio-override does not requiere OER or Publications packages. To install one or both, specify them as extras:

pip install invenio-override[lom, marc21]

or just

pip install invenio-override[marc21]

Enabling the OVERRIDE configurations without their respective library might lead to unexpected errors. More details about working with global-search packages here: https://github.com/tu-graz-library/invenio-global-search

  • Frontpage and its right section

# Enable or disable a section on the frontpage that adds shortcuts to search and uploads
OVERRIDE_RESOURCE_OVERVIEW = False

# Enable or disable the right section of the frontpage (Contact us, Benefits)
OVERRIDE_FRONTPAGE_RIGHT = False

# If section Benefits is displayed, option to click on More and go to Statistics page for more info
OVERRIDE_RIGHT_SECTION_TITLE = True

# Contact Email for the Contact us feature in the right section
OVERRIDE_SHOW_RIGHT_CONTACT_EMAIL = True

# Contact email displayed in the right section
OVERRIDE_RIGHT_SECTION_CONTACT_EMAIL = "support@example.com"

# feedback form used in right section
OVERRIDE_CONTACT_FORM = False
  • Branding and UI

# Icon and Logo displayed on the webiste
# list of available options: ["icon_use.png", "TUG.png", "KFU.svg", "MUG.svg", "invenio-override-default.svg", "sharedRDM.png"]
OVERRIDE_ICON = "images/icon_use.png"

OVERRIDE_LOGO = "images/inveniordm-tail.svg"

# favicon for shortcuts
# list of available options: ["kfu.ico", "mug.ico", "tug.ico"]
OVERRIDE_FAVICON = "favicon.ico"

# Override the Uploads menu title
USER_DASHBOARD_MENU_OVERRIDES = {
  "uploads": {
    "text": _("Research Results"),
  },
}
  • Differentiate between production and testing instance

# Production environment. Can also be set in .env as 'INVENIO_OVERRIDE_PRODUCTION'
OVERRIDE_PRODUCTION = False

Further documentation is available on https://invenio-override.readthedocs.io/

Changes

Version v0.0.5 (release 2025-05-20)

  • ui: improvements and bug fixes

  • global: invenio-app-rdm v13

  • global: split and move invenio-global-search dependencies to extras

Version v0.0.4 (release 2024-11-25)

  • global: MUG requirements integrated

Version v0.0.3 (release 2024-02-02)

  • global: configs naming

Version v0.0.2 (release 2024-02-02)

  • global: remove scss

Version v0.0.1 (release 2024-02-01)

  • global: init repository

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

invenio_override-0.0.5.tar.gz (306.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

invenio_override-0.0.5-py2.py3-none-any.whl (318.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file invenio_override-0.0.5.tar.gz.

File metadata

  • Download URL: invenio_override-0.0.5.tar.gz
  • Upload date:
  • Size: 306.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for invenio_override-0.0.5.tar.gz
Algorithm Hash digest
SHA256 65d29ba77099213a040eec8de02fec1d6ac5186f07322a4ac1fe4970f9f366cd
MD5 24489fd3145e6bf035e369ce3905d9be
BLAKE2b-256 33eeffe92a667b8719036b3ef3fe8633d24c420d1c19b48bbdee9a14c4ff955e

See more details on using hashes here.

File details

Details for the file invenio_override-0.0.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for invenio_override-0.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b153e6fbc74d24e8001f790c9fccbeabc611bf764f3f462cf17f387e18ab373d
MD5 66dab6acc00227e7734602b61971f4c5
BLAKE2b-256 5cef975cef4f884bea2dea8c3dd8a0bae283b1c307dde1823e7436d8fd2a3774

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page