From 4059528dca5bd5ef4c2cf899bdc2dff165a4fa97 Mon Sep 17 00:00:00 2001 From: Eka Date: Fri, 22 Sep 2023 16:27:16 +0400 Subject: [PATCH] update docs scroll --- data/membership.yml | 56 ++++++++++---------- package-lock.json | 6 +-- package.json | 2 +- templates/membership-documentation/index.jsx | 20 ++++--- 4 files changed, 45 insertions(+), 39 deletions(-) diff --git a/data/membership.yml b/data/membership.yml index 18aa2890..c792db9d 100644 --- a/data/membership.yml +++ b/data/membership.yml @@ -27,7 +27,7 @@ content: id: 1 title: CORE Repository Dashboard descriptionCardCard: | - [Monitor, manage and access](~services/repository-dashboard) statistics about how your metadata are exposed across the open access research network. [read more](~membership-documentation/?r=dashboard) + [Monitor, manage and access](~services/repository-dashboard) statistics about how your metadata are exposed across the open access research network. [read more](~membership-documentation#dashboard) descriptionCardTable: | Monitor, manage and access statistics about how your metadata are exposed across the open access research network. plans: [Starting, Supporting, Sustaining] @@ -35,7 +35,7 @@ content: id: 2 title: CORE Discovery descriptionCardCard: | - Benefit from our [plugin](~services/discovery) which turns metadata only pages in repositories to pages with full text links, whenever an open access version of the document is available anywhere across the open research network. [read more](~membership-documentation/?r=discovery) + Benefit from our [plugin](~services/discovery) which turns metadata only pages in repositories to pages with full text links, whenever an open access version of the document is available anywhere across the open research network. [read more](~membership-documentation#discovery) descriptionCardTable: | Benefit from our plugin which turns metadata only pages in repositories to pages with full text links, whenever an open access version of the document is available anywhere across the open research network. plans: [Starting, Supporting, Sustaining] @@ -43,7 +43,7 @@ content: id: 3 title: CORE Search descriptionCardCard: | - Your organisation's research visible and discoverable by over 30 million monthly active users who rely on CORE. [read more](~membership-documentation/?r=search) + Your organisation's research visible and discoverable by over 30 million monthly active users who rely on CORE. [read more](~membership-documentation#search) descriptionCardTable: | Your organisation's research visible and discoverable by over 30 million monthly active users who rely on CORE. plans: [Starting, Supporting, Sustaining] @@ -51,7 +51,7 @@ content: id: 4 title: CORE Recommender descriptionCardCard: | - Install our [recommender plugin](~services/recommender) to help your users find related content within your own repository and from across the global open research network. [read more](~membership-documentation/?r=recommender) + Install our [recommender plugin](~services/recommender) to help your users find related content within your own repository and from across the global open research network. [read more](~membership-documentation#recommender) descriptionCardTable: | Install our recommender plugin to help your users find related content within your own repository and from across the global open research network. plans: [Starting, Supporting, Sustaining] @@ -59,7 +59,7 @@ content: id: 5 title: General support descriptionCardCard: | - Our enthusiastic open access team ready to answer general queries about CORE. [read more](~membership-documentation/?r=general-support) + Our enthusiastic open access team ready to answer general queries about CORE. [read more](~membership-documentation#general-support) descriptionCardTable: | Our enthusiastic open access team ready to answer general queries about CORE. plans: [Starting, Supporting, Sustaining] @@ -67,7 +67,7 @@ content: id: 6 title: Download statistics descriptionCardCard: | - Access statistics about how many times papers from your organisation were downloaded (from CORE and directly from your repository - IRUS tracker integration required for the latter). [read more](~membership-documentation/?r=download-statistics) + Access statistics about how many times papers from your organisation were downloaded (from CORE and directly from your repository - IRUS tracker integration required for the latter). [read more](~membership-documentation#download-statistics) descriptionCardTable: | Access statistics about how many times papers from your organisation were downloaded (from CORE and directly from your repository - IRUS tracker integration required for the latter). plans: [Starting, Supporting, Sustaining] @@ -81,7 +81,7 @@ content: – Recommended across the repositories network descriptionCardCard: |- - – Increases the discoverability of your content. Open access full texts from your repository promoted to PubMed Central via their Link Out service. [read more](~membership-documentation/?r=repository-discovery-boost) + – Increases the discoverability of your content. Open access full texts from your repository promoted to PubMed Central via their Link Out service. [read more](~membership-documentation#repository-discovery-boost) descriptionCardTable: |- – Increases the discoverability of your content. Open access full texts from your repository promoted to PubMed Central via their Link Out service. plans: [Starting, Supporting, Sustaining] @@ -89,7 +89,7 @@ content: title: Get your OAI identifiers resolved to your repository id: 8 descriptionCardCard: | - Make [OAI identifiers](https://oai.core.ac.uk) originating from your repository resolve directly to your repository in the OAI Resolver. [read more](~membership-documentation/?r=OAI-identifiers) + Make [OAI identifiers](https://oai.core.ac.uk) originating from your repository resolve directly to your repository in the OAI Resolver. [read more](~membership-documentation#OAI-identifiers) descriptionCardTable: | Make OAI identifiers originating from your repository resolve directly to your repository in the OAI Resolver. plans: [ Starting, Supporting, Sustaining ] @@ -97,7 +97,7 @@ content: id: 9 title: Logos for your papers descriptionCardCard: | - Associate your research papers in CORE with your official organisational logo. This will be visible in CORE Search, CORE Recommender, CORE Discovery and from across the CORE Portal. Your logo can be uploaded from the CORE Repository Dashboard. [read more](~membership-documentation/?r=logos-papers) + Associate your research papers in CORE with your official organisational logo. This will be visible in CORE Search, CORE Recommender, CORE Discovery and from across the CORE Portal. Your logo can be uploaded from the CORE Repository Dashboard. [read more](~membership-documentation#logos-papers) descriptionCardTable: | Associate your research papers in CORE with your official organisational logo. This will be visible in CORE Search, CORE Recommender, CORE Discovery and from across the CORE Portal. Your logo can be uploaded from the CORE Repository Dashboard. plans: [Supporting, Sustaining] @@ -105,7 +105,7 @@ content: id: 10 title: Logo banner descriptionCardCard: | - We highly value the generous support of our Supporting and Sustaining members. We proudly display banners acknowledging your sponsorship and support to the open access and open science mission. [read more](~membership-documentation/?r=logo-banner) + We highly value the generous support of our Supporting and Sustaining members. We proudly display banners acknowledging your sponsorship and support to the open access and open science mission. [read more](~membership-documentation#logo-banner) descriptionCardTable: | We highly value the generous support of our Supporting and Sustaining members. We proudly display banners acknowledging your sponsorship and support to the open access and open science mission. plans: [Supporting, Sustaining] @@ -113,7 +113,7 @@ content: id: 11 title: Personalised banner descriptionCardCard: | - Promote your research conferences, events, academic jobs and other mission-aligned communications on the CORE website. [read more](~membership-documentation/?r=personalised-banner) + Promote your research conferences, events, academic jobs and other mission-aligned communications on the CORE website. [read more](~membership-documentation#personalised-banner) descriptionCardTable: | Promote your research conferences, events, academic jobs and other mission-aligned communications on the CORE website. plans: [Sustaining] @@ -121,7 +121,7 @@ content: id: 12 title: Board of Supporters (1 vote) descriptionCardCard: | - Help shape our development roadmap by having a say on our [Board of Supporters](~governance/supporters). [read more](~membership-documentation/?r=board-supporters) + Help shape our development roadmap by having a say on our [Board of Supporters](~governance/supporters). [read more](~membership-documentation#board-supporters) descriptionCardTable: | Help shape our development roadmap by having a say on our Board of Supporters. plans: [Supporting, Sustaining] @@ -129,7 +129,7 @@ content: id: 13 title: Board of Supporters (2 votes) descriptionCardCard: | - Help shape our development roadmap by having a say on our Board of Supporters. [read more](~membership-documentation/?r=board-supporters) + Help shape our development roadmap by having a say on our Board of Supporters. [read more](~membership-documentation#board-supporters) descriptionCardTable: | Help shape our development roadmap by having a say on our Board of Supporters. plans: [Supporting, Sustaining] @@ -137,7 +137,7 @@ content: id: 14 title: Board of Supporters descriptionCardCard: | - Help shape our development roadmap by having a say on our [Board of Supporters](~governance/supporters). [read more](~membership-documentation/?r=board-supporters) + Help shape our development roadmap by having a say on our [Board of Supporters](~governance/supporters). [read more](~membership-documentation#board-supporters) descriptionCardTable: | Help shape our development roadmap by having a say on our Board of Supporters. plans: [Supporting, Sustaining] @@ -150,7 +150,7 @@ content: id: 15 title: Technical support (≤5) descriptionCardCard: | - Guaranteed technical support of up to 5 technical queries per year. [read more](~membership-documentation/?r=technical-support) + Guaranteed technical support of up to 5 technical queries per year. [read more](~membership-documentation#technical-support) descriptionCardTable: | Guaranteed technical support of up to 5 technical queries per year. plans: [Supporting, Sustaining] @@ -158,7 +158,7 @@ content: id: 16 title: Unlimited and prioritised support descriptionCardCard: | - Get unlimited technical support and your questions prioritised on top to get your answers sooner. [read more](~membership-documentation/?r=unlimited-support) + Get unlimited technical support and your questions prioritised on top to get your answers sooner. [read more](~membership-documentation#unlimited-support) descriptionCardTable: | Get unlimited technical support and your questions prioritised on top to get your answers sooner. plans: [Sustaining] @@ -166,7 +166,7 @@ content: id: 17 title: CORE OA Compliance dashboard descriptionCardCard: | - Tools for Open Access compliance monitoring and metadata enrichments. [read more](/membership-documentation/?r=compliance-dashboard) + Tools for Open Access compliance monitoring and metadata enrichments. [read more](/membership-documentation#compliance-dashboard) descriptionCardTable: | Tools for Open Access compliance monitoring and metadata enrichments. plans: [Sustaining] @@ -174,7 +174,7 @@ content: id: 18 title: АPI use for your university descriptionCardCard: | - Use of the [CORE API](~services/api) for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. [read more](~membership-documentation/?r=АPI-organisation) + Use of the [CORE API](~services/api) for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. [read more](~membership-documentation#АPI-organisation) descriptionCardTable: | Use of the CORE API for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. plans: [Supporting, Sustaining] @@ -182,7 +182,7 @@ content: id: 19 title: Dataset use for your university descriptionCardCard: | - Use of the [CORE Dataset](~services/dataset) for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. [read more](~membership-documentation/?r=dataset-university) + Use of the [CORE Dataset](~services/dataset) for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. [read more](~membership-documentation#dataset-university) descriptionCardTable: | Use of the CORE Dataset for your organisation, including for non-research purposes (except for commercial purposes), subject to our T&Cs. plans: [Sustaining] @@ -190,7 +190,7 @@ content: id: 20 title: Repository health check descriptionCardCard: | - Possibility of a data-driven metadata quality assessment consultation for your institution. We assess current level of metadata quality (including in relation to FAIRness) and provide guidance on how to improve it. (1 consultation per year included). [read more](~membership-documentation/?r=repository-health-check) + Possibility of a data-driven metadata quality assessment consultation for your institution. We assess current level of metadata quality (including in relation to FAIRness) and provide guidance on how to improve it. (1 consultation per year included). [read more](~membership-documentation#repository-health-check) descriptionCardTable: | Possibility of a data-driven metadata quality assessment consultation for your institution. We assess current level of metadata quality (including in relation to FAIRness) and provide guidance on how to improve it. (1 consultation per year included). plans: [Sustaining] @@ -198,7 +198,7 @@ content: id: 21 title: Promoted / spotlight / featured articles descriptionCardCard: | - When research papers from your organisation would appear on pages 2-4 of CORE Search results, your paper gets promoted to the front of the first page and is highlighted as a featured article. [read more](~membership-documentation/?r=promoted-articles) + When research papers from your organisation would appear on pages 2-4 of CORE Search results, your paper gets promoted to the front of the first page and is highlighted as a featured article. [read more](~membership-documentation#promoted-articles) descriptionCardTable: | When research papers from your organisation would appear on pages 2-4 of CORE Search results, your paper gets promoted to the front of the first page and is highlighted as a featured article. plans: [Sustaining] @@ -206,7 +206,7 @@ content: id: 22 title: Hosted or interview style blog post on mission-aligned activities descriptionCardCard: | - We are keen to provide a hosted or interview style blog post about open access, open science and other relevant mission-oriented activities your organisation is conducting on the CORE blog. (T&Cs apply) [read more](~membership-documentation/?r=hosted-activities) + We are keen to provide a hosted or interview style blog post about open access, open science and other relevant mission-oriented activities your organisation is conducting on the CORE blog. (T&Cs apply) [read more](~membership-documentation#hosted-activities) descriptionCardTable: | We are keen to provide a hosted or interview style blog post about open access, open science and other relevant mission-oriented activities your organisation is conducting on the CORE blog. (T&Cs apply) plans: [Sustaining] @@ -214,7 +214,7 @@ content: id: 23 title: RIOXX metadata validator descriptionCardCard: | - Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The RIOXX metadata validator is a tool that helps you validate compliance of individual metadata records with RIOXX, a widely used metadata standard for repositories. [read more](~membership-documentation/?r=rioxx-validator) + Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The RIOXX metadata validator is a tool that helps you validate compliance of individual metadata records with RIOXX, a widely used metadata standard for repositories. [read more](~membership-documentation#rioxx-validator) descriptionCardTable: | Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The RIOXX metadata validator is a tool that helps you validate compliance of individual metadata records with RIOXX , a widely used metadata standard for repositories. plans: [Starting, Supporting, Sustaining] @@ -222,7 +222,7 @@ content: id: 24 title: Versions and duplicates detection descriptionCardCard: | - Our technology searches your repository to identify different versions of your articles and potential duplicates within your repository. This can help you in managing and curating your repository content. We periodically detect near-duplicate records and versions and allow you to compare them side by side. This can help you improve your repository metadata and keep the repository clean. [read more](~membership-documentation/?r=versions-duplicates) + Our technology searches your repository to identify different versions of your articles and potential duplicates within your repository. This can help you in managing and curating your repository content. We periodically detect near-duplicate records and versions and allow you to compare them side by side. This can help you improve your repository metadata and keep the repository clean. [read more](~membership-documentation#versions-duplicates) descriptionCardTable: | Our technology searches your repository to identify different versions of your articles and potential duplicates within your repository. This can help you in managing and curating your repository content. We periodically detect near-duplicate records and versions and allow you to compare them side by side. This can help you improve your repository metadata and keep the repository clean. plans: [Supporting, Sustaining] @@ -230,7 +230,7 @@ content: id: 25 title: Monitor RIOXX compliance descriptionCardCard: | - Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The Monitor RIOXX Compliance feature constantly monitors metadata records in your repository, helping you to keep your repository FAIR. [read more](~membership-documentation/?r=rioxx-compliance) + Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The Monitor RIOXX Compliance feature constantly monitors metadata records in your repository, helping you to keep your repository FAIR. [read more](~membership-documentation#rioxx-compliance) descriptionCardTable: | Aligning with established metadata practices is key for the interoperability of your repository with external systems and for meeting FAIR principles. Funders increasingly mandate the use of established metadata profiles. The Monitor RIOXX Compliance feature constantly monitors metadata records in your repository, helping you to keep your repository FAIR. plans: [Supporting, Sustaining] @@ -594,7 +594,7 @@ navItems: - item: CORE Recommender href: "#recommender" - item: General support - href: "#general_support" + href: "#general-support" - item: Download statistics href: "#download-statistics" - item: Repository Discovery Boost @@ -608,9 +608,9 @@ navItems: - item: Monitor RIOXX compliance href: "#rioxx-compliance" - item: Logos for your papers - href: "#paper_logo" - - item: Logo banner href: "#logos-papers" + - item: Logo banner + href: "#logo-banner" - item: Personalised banner href: "#personalised-banner" - item: Board of Supporters diff --git a/package-lock.json b/package-lock.json index 0de2c654..52ede884 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1935,9 +1935,9 @@ "integrity": "sha512-qtBF56vPC6d6a8p7LYd0iRjW89fhY80kAIzmj+VonvIGjK/nymBjcFUhbKiMFqlhsarCksnhwX+Zmn95Dw9qvA==" }, "@oacore/design": { - "version": "4.9.46", - "resolved": "https://npm.pkg.github.com/download/@oacore/design/4.9.46/5a4ccd94186ce5d812a49c0b81e4ee7b8bf6b5b5", - "integrity": "sha512-i3QyeBX54hnseOHe6VFkXBYx/9odh3J+Xgje6sC+degMofTd510yXcfe09CGrWVRcLS5t7G8We18yXBrLRRY5g==", + "version": "4.9.49", + "resolved": "https://npm.pkg.github.com/download/@oacore/design/4.9.49/947d4c81ca79d2c2b1d7c05ad3be484d969a3b9c", + "integrity": "sha512-f9+yWOfYaL1838XmsYPKV42dQV80EPAivB7Z89ko9oxdqo6n5BHBVTKSxfewEcV2Dhlh//FHBxflbA0tCpQAGA==", "requires": { "@babel/runtime": "^7.12.1", "@mdi/svg": "^5.8.55", diff --git a/package.json b/package.json index 7904962b..69c632fd 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "prettier": "^2.1.2" }, "dependencies": { - "@oacore/design": "^4.9.46", + "@oacore/design": "^4.9.49", "@octokit/rest": "^18.5.0", "bootstrap": "^4.5.3", "camelize": "^1.0.0", diff --git a/templates/membership-documentation/index.jsx b/templates/membership-documentation/index.jsx index 300c0dc3..cd63d831 100644 --- a/templates/membership-documentation/index.jsx +++ b/templates/membership-documentation/index.jsx @@ -18,19 +18,25 @@ const DocumentationPageTemplate = ({ headerAbout, docs }) => { const [highlight, setHighlight] = useState() const [navActiveIndex, setNavActiveIndex] = useState(null) const route = useRouter() + const headerHeight = 56 + useEffect(() => { - const id = route.query?.r - if (id) { - setTimeout(() => { - document.getElementById(id).scrollIntoView({ + const { hash } = window.location + const id = hash.substring(1) + const element = document.getElementById(id) + setTimeout(() => { + if (element) { + const rect = element.getBoundingClientRect() + window.scrollTo({ + top: rect.top + window.scrollY - headerHeight, behavior: 'smooth', block: 'center', }) const n = docs.items.findIndex((item) => item.id === id) setHighlight(n) - }, 100) - } - }, [route.query.r]) + } + }, 100) + }, [route.asPath]) useEffect(() => { const id = route.query?.r