From 3040c92ab331f04533bab0bda637452047695113 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Thu, 19 Dec 2024 12:51:44 +0000 Subject: [PATCH 01/11] Add 'how to cite this page' section to page layout --- _includes/citation.html | 12 ++++++++++++ _layouts/page.html | 1 + 2 files changed, 13 insertions(+) create mode 100644 _includes/citation.html diff --git a/_includes/citation.html b/_includes/citation.html new file mode 100644 index 0000000..c95d1ba --- /dev/null +++ b/_includes/citation.html @@ -0,0 +1,12 @@ +{% if page.title %} +

How to cite this page

+
+ {% if page.contributors %} + {{ page.contributors | join: ", " }}. + {% endif %} + {{ page.title }} (Research Software Quality Kit (RSQKit) material). + {% assign page_url = page.url | absolute_url %} + Online: {{ page_url }}. + Accessed {{ site.time | date: "%d %B, %Y" }}. +
+{% endif %} \ No newline at end of file diff --git a/_layouts/page.html b/_layouts/page.html index c627a07..321af1f 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -34,6 +34,7 @@

{{ page.title }} {%- endif %} {% include affiliation-tiles-page.html %} {% include contributor-minitiles-page.html %} + {% include citation.html %} {%- if site.theme_variables.github_buttons.position == "bottom" %}
{% include github-buttons.html %} From dcc5982a48e01a02d6be1ae6939d68942a6f7963 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Thu, 19 Dec 2024 12:57:59 +0000 Subject: [PATCH 02/11] Use site.title instead of hardcoding --- _includes/citation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/citation.html b/_includes/citation.html index c95d1ba..19d1c3c 100644 --- a/_includes/citation.html +++ b/_includes/citation.html @@ -4,7 +4,7 @@

How to cite this page

{% if page.contributors %} {{ page.contributors | join: ", " }}. {% endif %} - {{ page.title }} (Research Software Quality Kit (RSQKit) material). + {{ page.title }} ({{ site.title }} material). {% assign page_url = page.url | absolute_url %} Online: {{ page_url }}. Accessed {{ site.time | date: "%d %B, %Y" }}. From 71455b26554ddc9092f2393d34f041842cd33183 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Fri, 20 Dec 2024 09:30:21 +0000 Subject: [PATCH 03/11] Add config parameter inlcude_citation --- _layouts/page.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_layouts/page.html b/_layouts/page.html index 321af1f..281806c 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -34,7 +34,9 @@

{{ page.title }} {%- endif %} {% include affiliation-tiles-page.html %} {% include contributor-minitiles-page.html %} + {% if page.include_citation %} {% include citation.html %} + {% endif %} {%- if site.theme_variables.github_buttons.position == "bottom" %}
{% include github-buttons.html %} From f55eaa966d5339470c0880719d4e29c8226c08a2 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Fri, 20 Dec 2024 10:01:01 +0000 Subject: [PATCH 04/11] Add metadata explanation for include_citation --- pages/documentation/page_mechanics.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/documentation/page_mechanics.md b/pages/documentation/page_mechanics.md index 73d709b..0dc29b5 100644 --- a/pages/documentation/page_mechanics.md +++ b/pages/documentation/page_mechanics.md @@ -45,7 +45,8 @@ It is important to know that you can also set the these key-value pairs on multi * `type`: The type of page, used for [website sections](website_sections). - +* `include_citation`: When set to true, it will cause the citation section for the page to be generated in the format: +`. ( material). Online: . Accessed: `. ### Related pages From b2882f7f6a56071ec2e1b7bf0ef56121c8c6fed4 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Thu, 9 Jan 2025 10:03:47 +0000 Subject: [PATCH 05/11] Change to IEEE Web resources citation format See https://libraryguides.vu.edu.au/ieeereferencing/webbaseddocument#:~:text=Basic%20format%20to%20reference%20a%20web%2Dbased%20document%20or%20source,Address%20(accessed%20date%20retrieved) --- _includes/citation.html | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/_includes/citation.html b/_includes/citation.html index 19d1c3c..400978d 100644 --- a/_includes/citation.html +++ b/_includes/citation.html @@ -2,11 +2,13 @@

How to cite this page

{% if page.contributors %} - {{ page.contributors | join: ", " }}. + {{ page.contributors | join: ", " }}, + {% endif %} + "{{ page.title }}". + {% if site.url %} + {{ site.url }}. {% endif %} - {{ page.title }} ({{ site.title }} material). {% assign page_url = page.url | absolute_url %} - Online: {{ page_url }}. - Accessed {{ site.time | date: "%d %B, %Y" }}. + {{ page_url }} (accessed {{ site.time | date: "%d %B, %Y" }}).
-{% endif %} \ No newline at end of file +{% endif %} From ade7049dbb87b89ee13fb33af628360488518c5a Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Fri, 24 Jan 2025 12:43:36 +0000 Subject: [PATCH 06/11] Fix current date with java script in citation section --- _includes/citation.html | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/_includes/citation.html b/_includes/citation.html index 400978d..1e84356 100644 --- a/_includes/citation.html +++ b/_includes/citation.html @@ -2,13 +2,18 @@

How to cite this page

{% if page.contributors %} - {{ page.contributors | join: ", " }}, + {{ page.contributors | join: ", " }}, {% endif %} "{{ page.title }}". {% if site.url %} - {{ site.url }}. + {{ site.url }}. {% endif %} {% assign page_url = page.url | absolute_url %} - {{ page_url }} (accessed {{ site.time | date: "%d %B, %Y" }}). + {{ page_url }} .
{% endif %} + + From 8d4f31b31b68e7518705fa38e2bbdda474dd2915 Mon Sep 17 00:00:00 2001 From: bedroesb Date: Fri, 24 Jan 2025 16:31:23 +0100 Subject: [PATCH 07/11] page_citation --- _includes/{citation.html => citation-page.html} | 6 +++--- _layouts/page.html | 4 +--- pages/documentation/page_mechanics.md | 2 +- 3 files changed, 5 insertions(+), 7 deletions(-) rename _includes/{citation.html => citation-page.html} (91%) diff --git a/_includes/citation.html b/_includes/citation-page.html similarity index 91% rename from _includes/citation.html rename to _includes/citation-page.html index 1e84356..6055d4d 100644 --- a/_includes/citation.html +++ b/_includes/citation-page.html @@ -1,6 +1,6 @@ -{% if page.title %} +{% if page.page_citation and page.title %}

How to cite this page

-
+

{% if page.contributors %} {{ page.contributors | join: ", " }}, {% endif %} @@ -10,7 +10,7 @@

How to cite this page

{% endif %} {% assign page_url = page.url | absolute_url %} {{ page_url }} . -
+

{% endif %} +{% endif %} + From 298e4b37d4839b241428631a2f89637096fb5caf Mon Sep 17 00:00:00 2001 From: Bert Droesbeke Date: Fri, 7 Feb 2025 23:39:12 +0100 Subject: [PATCH 10/11] keep only (sub)domain --- _includes/citation-page.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/citation-page.html b/_includes/citation-page.html index 85f9a05..8cd87dc 100644 --- a/_includes/citation-page.html +++ b/_includes/citation-page.html @@ -6,7 +6,7 @@

How to cite this page

{% endif %} "{{ page.title }}". {% if site.url %} - {{ site.url }}. + {{ site.url | remove: "https://www." | remove: "http://www." | remove: "https://" | remove: "http://" }}. {% endif %} {% assign page_url = page.url | absolute_url %} {{ page_url }} . From 740dafeb2c81299e96f875734b22a55679ed7b13 Mon Sep 17 00:00:00 2001 From: Bert Droesbeke Date: Fri, 7 Feb 2025 23:44:08 +0100 Subject: [PATCH 11/11] update docs --- pages/documentation/page_mechanics.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/documentation/page_mechanics.md b/pages/documentation/page_mechanics.md index 5581762..2c2e473 100644 --- a/pages/documentation/page_mechanics.md +++ b/pages/documentation/page_mechanics.md @@ -45,8 +45,7 @@ It is important to know that you can also set the these key-value pairs on multi * `type`: The type of page, used for [website sections](website_sections). -* `page_citation`: When set to true, it will cause the citation section for the page to be generated in the format: -`. ( material). Online: . Accessed: `. +* `page_citation`: When set to true, it will cause the citation section for the page to be generated in the format: `. . . . .` ### Related pages