Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 2.49 KB

EDITORS.md

File metadata and controls

39 lines (23 loc) · 2.49 KB

GoutHelper Editorial Tips

Introduction

  • We use Markdown for most of our text. It's nice because it's semantic and easy to edit (like this document).
  • We do use a small amount of HTML to assign attributes to text. This is because Markdown doesn't have a way to do this.

HTML

We prefer to use the most minimal amount of HTML possible to preserve readability and semantic meaning. Also, lots of HTML is difficult for non-programmers to understand. We use HTML for the following:

  1. Adding a css id: <span id="myid">text</span>
  2. Adding a css class: <span class="myclass">text</span>
  3. Superscripting text (like this1): <sup>1</sup>

Internal Links

Same Page Links

To link to a section on the same page, like this, use the following syntax: [link-text](#id-of-section)

Different Page Links

To link to a different page on GoutHelper, like this, use the following syntax: [link-text](/path/to/page/)

Different Page Link IDs

To link to a specific css id on a different page, like this, use the following syntax: [link-text](/path/to/page/#id)

References

References should be recorded in numerical order and indicated in the text by a superscript number (xxx) linked to the full reference id (#ref-xxx) at the bottom of the page: [<sup>xxx</sup>](#ref-xxx)xxx. The reference list should be at the end of the document. There should be a span element without any text inside at the beginning of the reference to mark the id, i.e. <span id="ref-xxx"></span>reference.

Weasley, Potter, Mugglefood. Fake Reference. Journal of Enchanted Jellies. 2020. PMID: 12345678

If you add or remove a reference, you need to check all the others to preserve the correct order in the text. References should be formatted however is easiest to grab the citation, but should include at least the first author, title, journal, year, and PMID as possible. The PMID should be a link to the article on PubMed, such as [23179866](https://link.springer.com/article/10.1007/s11882-012-0322-z). Make sure the link works before you commit your changes.