FREYA-1549: Implement Data Highlights App #26

misterabdullahAziz · 2025-10-07T18:37:01Z

📋 Summary

This PR implements a comprehensive Data Highlights app, providing a complete content management system for showcasing research findings and scientific discoveries.

🛠️ Changes Made

New Django App: Created pages/highlights app with complete model, views, admin, and templates
DataHighlight Model: Comprehensive model with mandatory fields (title, summary, content, featured_image) and optional fields (announcement, tags, figure_caption, topics)
Direct Many-to-Many: Implemented direct relationship with topics app (no intermediate model)
Search Functionality: Real-time JavaScript search across title, summary, and tags
Related Content Algorithm: Jaccard similarity-based content discovery system
Admin Interface: Comprehensive admin with organised fieldsets, search, filtering, and bulk actions
Markdown Support: Full markdown rendering with syntax highlighting for content
Social Sharing: Built-in social media sharing buttons (Twitter, LinkedIn, Facebook)

🔍 Notes for Reviewers

Basic styling implemented.

✅ Checklist

PR title follows the pattern: FREYA-XXXX: Clear and short description
Jira / Github issue is linked in description
Assignee is selected
Code and content adhere to conventions
Automated checks pass
Reviewer is selected when the PR is marked as ready for review

🔗 Jira Issue

Closes: FREYA-1549

Ziip-dev · 2025-10-08T14:37:28Z

For future reference, so many changes in a single commit is too much, this doesn't facilitate the review process :)

senthil10

Requesting changes mostly for required discussions

senthil10 · 2025-10-13T05:48:49Z

core/static/css/base.css

    --color-pp-almost-black: #1a1c1a;
 }

+/* Custom components for data highlights */


We should discuss if we need all these component

We can discuss, maybe app-specific or maybe we can reduce these components once we will have all major apps created.

Yes, I mean among the components listed here, I think only topic badges will used in multiple pages/apps. Everything else is mostly specific to highlights (and maybe editorials). In that case I prefer to not have components and just use in-line styling using tailwind.

Agreed, I would keep everything inline for now, we are not in the stage where we can really think about how to factor the styles and optimise the utility classes, so let's not bother and keep this for later when things will be more stable :)
For reference: https://tailwindcss.com/docs/styling-with-utility-classes#managing-duplication

senthil10 · 2025-10-13T06:22:10Z

pages/highlights/templates/highlights/highlight_detail.html

+                        {{ topic.name }}
+                    </a>
+                </span>
+            {% empty %}


do we wanna do it this way or not have "topics" at all if no topics assigned ? I don't have a preference, just making this comment for a discussion.

I implemented it this way because i think it helps editors in content management.
Moreover, it will provide consistency for all highlights.
But if you guys prefer to remove this if no topic assigned, I am okay with that also.

I don’t have any preference, I am fine with either. Like I mentioned, made just so we discussed this with the whole team :)

senthil10 · 2025-10-13T06:30:38Z

pages/highlights/templates/highlights/highlight_detail.html

+                </span>
+            {% endfor %}
+        </div>
+


would it be useful to have the "share this" html code in core/templates/share_this.html and use {% include "share_this.html" %} in required pages ?

Just another comment for discussion, we of course have to tweak the code a little if we gonna implement it :)

I agree with your suggestion. I am just not sure where else we are using these sharing buttons? if we are only using in highlights then maybe keeping it here is more appropriate.

I totally agree, currently only highlights and editorial have this I guess. If its gonna be the case with the new portal then maybe it’s not worth abstracting it. We can confirm this with Liane in the discussion 👍

pages/highlights/templates/highlights/highlight_detail.html

pages/highlights/templates/highlights/index.html

senthil10 · 2025-10-13T07:02:08Z

pages/highlights/templates/highlights/index.html

+            {% for highlight in highlights %}
+                <div class="data-highlight" 
+                     data-search-text="{{ highlight.title|lower }} 
+                                      {{ highlight.summary|lower }} 


Not sure if we should include summary in the search. Since the search is meant for "keywords" search I think all relevant keywords would be covered in title and search tags.

We can discuss it :)

You're right that title and topics cover the main keywords.

However, I included summary because researchers often search by methodologies, concepts-focused (e.g., "sequencing", "viral evolution", "phylogenetic analysis") or technical terms that appear in summaries but not titles/topics.
As summary text is not that long, this comprehensive search helps users discover relevant content by research techniques.

Yes, but those words will not be in the title or added tags ? that's what I wanna know :)

No, these words are not in tags, topics, or title. These kinds of words usually goes into abstract or summary.

Tags are something added manually in our case and usually they are like what you have mentioned in the example. I am not an expert in this, but discus this with Laine. I am just concerned about random false hits from other regular words. Thats also true for the title, but given the size of the title (compared to summary) it is very minimal.

Might be I am just overthinking, just confirm it with Liane and I am fine with her decision.

pages/highlights/apps.py

senthil10 · 2025-10-13T07:48:38Z

pages/highlights/models.py

+        # Get active highlights created before this one, ordered by creation date
+        older_highlights = DataHighlight.objects.filter(
+            is_active=True,
+            created_at__lt=self.created_at


Any particular reason not to include newer data highlights than the current one ?

There is a debate either we chose Chronological or Similarity-Based approach.
Its a matter of choice.
I think for single detail highlight, researcher would like to know its progression and background which will be technically old highlights (i tried to looked into current highlights on the portal and realised that this is the same approach of Chronological order implemented).

As newer highlights will always be listed in order on the listing.

The current similarity/related is based on the mentioned keywords and not the content or the study itself. In that case I don't how chronological order helps.

For example, if I am an user and I am reading an article on some "X" technology or method, I would be interested on similar articles (i.e. same "X" tech or method) irrespective of whether it is older or newer than the current article I am reading. I would actually be interested in newer similar articles actually 😄

Maybe that's just me, we can discuss this with the team and see what other feel.

yes, we can discuss.
I am open for both approaches. I am having current approach as I think current Pathogen portal also showing older highlights only.

senthil10 · 2025-10-13T07:59:18Z

pages/highlights/models.py

+            return []
+        return [tag.strip().lower() for tag in self.tags.split(',') if tag.strip()]
+
+    def get_related_highlights(self, limit: int = 4, threshold: float = 0.1) -> List['DataHighlight']:


Point to discuss, could this be potential re-usable stuff ?

Not sure. Similar to share buttons only editorials might need similar functionality.
We can discuss.

senthil10 · 2025-10-15T15:00:36Z

pages/highlights/templates/highlights/highlight_detail.html

+    <!-- Main Content -->
+    {% if highlight.content %}
+        <div class="prose prose-lg max-w-none text-pp-dark-grey mb-8">
+            {% if highlight.rendered_content %}


I forgot to ask about this, why have thisif block ? Will there be a scenario where there is no rendered_content ? 🤔

senthil10 · 2025-10-15T15:01:23Z

pages/highlights/templates/highlights/highlight_detail.html

+    <!-- Announcement (if present) -->
+    {% if highlight.announcement %}
+        <div class="announcement">
+            {% if highlight.rendered_announcement %}


Same question here, will there be a scenario where there is no rendered_anouncement ?

feat(highlights): add highlights app with models, views, and templates

af01b6a

misterabdullahAziz self-assigned this Oct 7, 2025

misterabdullahAziz requested a review from a team as a code owner October 7, 2025 18:37

senthil10 requested changes Oct 13, 2025

View reviewed changes

misterabdullahAziz added 4 commits October 14, 2025 18:57

refactor(templates): remove unused title blocks from highlight templates

a93d7bd

fix(template): improve HTML structure in highlights index

338370b

fix(docs): add package documentation for highlights app

0da5436

fix(models): remove blank option from slug field in DataHighlight model

db00e0e

misterabdullahAziz force-pushed the FREYA-1549/Abdullah/highlights branch from ddc4ffb to db00e0e Compare October 14, 2025 17:09

senthil10 reviewed Oct 15, 2025

View reviewed changes

FREYA-1549: Implement Data Highlights App #26

Are you sure you want to change the base?

FREYA-1549: Implement Data Highlights App #26

Uh oh!

Conversation

misterabdullahAziz commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📋 Summary

🛠️ Changes Made

🔍 Notes for Reviewers

✅ Checklist

🔗 Jira Issue

Uh oh!

Ziip-dev commented Oct 8, 2025

Uh oh!

senthil10 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

misterabdullahAziz Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

misterabdullahAziz commented Oct 7, 2025 •

edited

Loading

misterabdullahAziz Oct 13, 2025 •

edited

Loading