Added metadata to the library item web page

[ResendeTech]

User description

continuation of the issue #489

---

PR Type

enhancement, documentation

---

Description

• Enhanced the library item web page with JSON-LD structured data to improve SEO.
• Added metadata fields including author, publication date, audience, genre, medium, and temporal coverage.
• Implemented conditional logic to handle the presence of metadata fields dynamically.
• Utilized schema.org's CreativeWork type to structure the metadata.

---

Changes walkthrough 📝

	Relevant files
Enhancement	library_item.html Add JSON-LD structured data for SEO enhancement                    library/templates/library/library_item.html Added structured data using JSON-LD for SEO. Included metadata such as author, publication date, and audience. Added conditional logic for various metadata fields. Implemented schema.org CreativeWork type. +58/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[qodo-code-review]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 Security concerns Data exposure: The JSON-LD script is including all available metadata fields without apparent filtering or sanitization. This could potentially expose sensitive information if any of these fields contain private or restricted data. It's important to ensure that only public, non-sensitive information is included in this structured data. Consider implementing a whitelist of allowed fields or a sanitization process to prevent unintended data exposure.

⚡ Key issues to review Syntax Error There's a syntax error in the template tag for the extra_js block. The opening and closing braces are doubled. Potential Data Exposure The JSON-LD script is exposing all available metadata without any apparent filtering or sanitization.

[qodo-code-review]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	✅ Remove extra curly braces from the block tags to ensure proper template rendering Suggestion Impact: The suggestion was implemented by removing the extra curly braces from the opening and closing tags of the extra_js block, ensuring proper template rendering. code diff: -{{% block extra_js %} +{% block extra_js %} <script type="application/ld+json"> { "@context": "https://schema.org", @@ -147,6 +147,6 @@ {% endif %} "url": "{{ page.full_url }}" } - </script> +</script> -{% endblock extra_js %}} +{% endblock extra_js %} The opening and closing tags for the extra_js block have an extra curly brace. Remove these extra braces to ensure proper template rendering. library/templates/library/library_item.html [96-152] -{{% block extra_js %} +{% block extra_js %} <script type="application/ld+json"> ... </script> -{% endblock extra_js %}} +{% endblock extra_js %} Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies and resolves a syntax error in the template tags, which is crucial for proper rendering. This fix is necessary to prevent potential rendering issues in the template.	9
Enhancement	Add a description property to the JSON-LD schema to improve SEO Consider adding the description property to the JSON-LD schema. This can significantly improve SEO by providing a summary of the content. You can use the page's description or excerpt if available. library/templates/library/library_item.html [98-149] { "@context": "https://schema.org", "@type": "CreativeWork", "name": "{{ page.title }}", + {% if page.specific.description %} + "description": "{{ page.specific.description|escapejs }}", + {% endif %} ... "url": "{{ page.full_url }}" } Suggestion importance[1-10]: 7 Why: Adding a description property can enhance SEO by providing more context to search engines. This is a valuable enhancement, although not critical, it improves the overall quality of the metadata.	7
Best practice	Add error handling for missing required properties to prevent invalid JSON-LD Consider adding error handling for cases where required properties might be missing. This can help prevent rendering incomplete or invalid JSON-LD. library/templates/library/library_item.html [98-149] +{% if page.title and page.full_url %} { "@context": "https://schema.org", "@type": "CreativeWork", "name": "{{ page.title }}", ... "url": "{{ page.full_url }}" } +{% endif %} Suggestion importance[1-10]: 5 Why: The suggestion to add error handling for missing properties is a good practice to ensure valid JSON-LD output. However, the implementation could be more comprehensive, as it only checks for two properties.	5
Security	Use a safe filter for JSON output to prevent potential XSS vulnerabilities Consider using the safe filter for the JSON output to prevent potential XSS vulnerabilities. This ensures that the JSON is properly escaped and safe to render in the HTML. library/templates/library/library_item.html [97-150] <script type="application/ld+json"> - { - "@context": "https://schema.org", - "@type": "CreativeWork", - "name": "{{ page.title }}", - ... - } + {{ schema_json|safe }} </script> Suggestion importance[1-10]: 3 Why: The suggestion is relevant for security, but the proposed change is not directly applicable as it suggests a different approach to rendering JSON-LD. The current implementation already uses template logic to ensure safety.	3

💡 Need additional feedback ? start a PR chat

[brylie]

Suggested change

	{{% block extra_js %}
	{% block extra_js %}

[brylie]

Can you upload a screenshot to show this code working? E.g., does it appear when viewing the source?

[ResendeTech]