Clean up reference links - Githubissues

GarrettS / parkinsons-guide

https://garretts.github.io/parkinsons-guide/

1 stars 0 forks source link

Clean up reference links #6

Open GarrettS opened 3 months ago

GarrettS commented 3 months ago

Summary:

Add functionality to link scientific references in the article to in-page reference sections for improved reader navigation.

The homepage reference links are not consistently formatted and do not follow standard scientific formatting.

When a scientific reference is mentioned, there should be [link to in page reference].

Proposed Fix:

Include a unique reference ID for each scientific reference in the HTML.
Link each reference in the text to its corresponding in-page reference using the reference ID.
Shorten link text to provide a concise description of the study or authors.
Clearly indicate the connection between the reference link and the target section using consistent formatting and visual cues.

<!-- In-page reference link -->
<p>
    In a recent study by <a href="#ref1" class="ref-link">Smith et al.</a>, the role of alpha-synuclein in Parkinson's disease was investigated.
</p>

<!-- Scientific reference -->
<li id="ref1">
    <a class="title" href="[URL]" target="_blank">[Author's Last Name or Paper Title]</a>
    <p>[Your summary of the relevant findings]</p>
</li>

GarrettS commented 3 months ago

                <ol class="reference-list">
                    <li>
                        <a href="url"
                        title="title"
                        target="_blank"
                        >title</a>
                        <p>
                        Description/summary/conclusion
                        </p>
                    </li>
                </ol>