Differences

This shows you the differences between two versions of the page.

--- projects:workgroups:notes_on_writing_text_for_the_book [2019/06/02 13:19]
schuemie [Markdown syntax]
+++ projects:workgroups:notes_on_writing_text_for_the_book [2019/06/26 09:08]
schuemie [Keep in mind]
@@ Line 1: / Line 1: @@
 ====== Notes on writing text for the Book of OHDSI ======
+Most of the information on this page can be found in [[https://raw.githubusercontent.com/OHDSI/TheBookOfOhdsi/master/extras/CheatSheet.pdf|The Book of OHDSI Cheat Sheet]].
 ===== General layout of a chapter =====
@@ Line 14: / Line 15: @@
 ===== Keep in mind =====
-  * Hyperlinks should show the actual URL, so that a printed copy would still have a readable link.
+  * Abbreviations should be re-defined in each chapter. So yes, the first time you mention CDM in your chapter it should be CDM (Common Data Model).
+  * Table names should be all-caps, so OBSERVATION_PERIOD. Field names should be lower case, so observation_period_id.
+  * When quoting, use "double quotes".
+  * Hyperlinks should show the actual URL, so that a printed copy would still have a readable link. To avoid formatting issues, it might be best to add the URL as a footnote. Use URLs sparingly.
   * Tables and figures should be designed with small screens in mind.
+  * The maximum section depth is 3, so for example section 2.3.4. You can finagle a 4th level by using bold headers (not numbered).
   * Keep filename extensions in lower case, so 'figure.png', not 'figure.PNG'.

Observational Health Data Sciences and Informatics