projects:workgroups:notes_on_writing_text_for_the_book
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Last revision Both sides next revision | ||
|
projects:workgroups:notes_on_writing_text_for_the_book [2019/06/24 07:15] schuemie |
projects:workgroups:notes_on_writing_text_for_the_book [2019/06/26 09:08] schuemie [Keep in mind] |
||
|---|---|---|---|
| Line 16: | Line 16: | ||
| * 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). | * 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. | * Table names should be all-caps, so OBSERVATION_PERIOD. Field names should be lower case, so observation_period_id. | ||
| + | |||
| * When quoting, use "double quotes". | * 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. | * 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. | * 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'. | * Keep filename extensions in lower case, so 'figure.png', not 'figure.PNG'. | ||
projects/workgroups/notes_on_writing_text_for_the_book.txt ยท Last modified: 2019/08/07 14:02 by schuemie
Page Tools
