forked from TIBHannover/report-style
-
Notifications
You must be signed in to change notification settings - Fork 0
/
style-guide.qmd
81 lines (59 loc) · 5.55 KB
/
style-guide.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Style Guide
\[[Edit on GDocs](https://drive.google.com/drive/folders/1LxoxOoPWMtRPa0S2PDPyUqAyVPfbPJyM)\]
1. Prepare the text in English. The Chicago Manual of Style 17th Edition (CMOS) is being used as the overall publication style. We will stay close to (CMOS) but not 100% compliant as we have many non/English native writers and styles vary. Points to note will be:
1. We will use International English as the primary audience is English as a second language in Europe as the expectation of the reader leans towards UK English. For example end wods is ise and ize, but use US License as Creative Commons use the US form of license. This also applies to en and em dashes, use spaces unlike the US with no space. Refer to The Economist style guide as that caters to a US EN audience.
2. Use the [Oxford Comma](https://cmosshoptalk.com/2020/02/11/oxford-chicago-and-the-serial-comma/). Which means the presence of a comma before and or or in a list of three or more items.
3. En and em dash policy. For em dash use we'll keep with CMOS guidelines on em dash used for punctuation em dash with space before and after (USA and CMOS have no space but in Europe it is more common to have space either side. Make sure en dashes are used where needed and not hyphens.
2. Typesetting punctuation:
1. Use no breaking hyphens in phrases like Co‑creation – Word instructions [https://word.tips.net/T001116\_Inserting\_a\_Non-Breaking\_Hyphen.html](https://word.tips.net/T001116_Inserting_a_Non-Breaking_Hyphen.html) – HTML [https://www.toptal.com/designers/htmlarrows/punctuation/non-breaking-hyphen/](https://www.toptal.com/designers/htmlarrows/punctuation/non-breaking-hyphen/)
3. Capitalisation:
1. For terms like open science, open access, open data, or FAIR data, etc. Generally we will aim for lowercase words to keep the reading flow easy, follow this rule for movements, schools. [https://7sage.com/admissions/lesson/capitalization/](https://7sage.com/admissions/lesson/capitalization/) Capitalize the names of movements and schools derived from proper nouns; lowercase those that are not. Unfortunately, there are some exceptions: “Cynic,” “Scholasticism” and “New Criticism,” for example, are capitalized when used as movements. Look a term up in Merriam-Webster if you're not sure. romanticism; Keynesian economics; cubism; Cynicism. The rule of thumb can also be applied that capitalisation is to get rid of ambiguity. So in our example
2. FAIR data would have acronym capitalised
3. Open science, open data, and open access – would all be lowercase
4. Open source software – here we run into the 'rival camps' problem. There is the Free Software Foundation (Richard Stallman) and the Open Source (Eric Raymond) movement who disagree on ideologies. Properly the full term should be use Free and Open Source Software (FOSS) but its a mouthful. And there is more to the story. Our get out is to use the precompound adjective open-source.
5. I will list more examples as they come up.
6. Article titles capitalised as 'title capitalisation', running headers only first word and after :
7. Job or role title removed.
### **Article Template Guides**
#### **Section introduction \- to be written by section editor**
* The text is a maximum of 400 words, 2800 characters including spaces (including Tables, Figures, Photos)
Title and headline.
* One image
* Add three or more learning outputs in an info box style. What you will learn in this section. An additional 300 words can be give to the 'learning outputs\#.
Total for the section into 700 words.
#### **Quick start guide \- [p5 example from SciStarter guide](http://media.scistarter.org/curated/The+Library+and+Community+Guide+to+Citizen+Science.pdf)**
This could be to introduce a topic, or a service someone could use, like FloraIncognita.
* Main title, subtitle
* Definition box: 6 bullet points
* Video online tutorial: Title; image; description 255 characters; URL
* Learn more: List of supporting resources \- 1060 characters, 135 words
#### **Overview / Essay / Expository text \- p6 SciStarter (3 page example, can also be longer with 4 page example and more text 9000 characters)**
##### **3 page version**
* Total character length 5600 characters, 830 words
* Title, subtitle
* Two images in main text
* Main text: Use bullet points and sub-headers; 5000 characters of total
* Summarise main points in infobox. No more than four points. 600 characters of total
* End section to show how library can make use of idea, with examples for resources. Title; 1000 characters of total.
##### **4 page version**
* Total character length 9000 characters, 1320 words
* Title, subtitle
* Main text: Use bullet points and sub-headers; 7800 characters of total
* Use a series of small images \- 7 max. If images described in the text then no picture caption needed.
* Use two info boxes to highlight important issues with bullet points and use an image here if preferred. 600 characters each of total char. length.
#### **Project highlight or example, this could also count for a video piece \- one pager p20 SciStarter**
* Title
* Headline description 90 \- 140 char.
* One or two images
* Text: 1200 \-1500 characters
#### **Step-by-step guide**
##### **Short \- p28 SciStarter**
* Title, headline 95 characters
* 5000 characters; Use bullet points and sub-headers
* 2-4 images
##### **Long \- p30 SciStarter**
* Title, headline 95 characters
* 14,000 characters total
* 10 pictures max
* Break process into no more than 7 steps of 500 characters each
* Then following text