forked from CenterForOpenScience/osf-style
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlanguage.html
181 lines (157 loc) · 9.41 KB
/
language.html
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="author" content="">
<title>OSF Style & UI Guidelines</title>
<!-- Bootstrap core CSS -->
<link href="bower_components/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,600,300,700' rel='stylesheet' type='text/css'>
<link href="vendor/prism/prism.css" rel="stylesheet" />
<!-- OSF style -->
<link href="css/base.css" rel="stylesheet">
<!-- Guidelines style -->
<link href="page.css" rel="stylesheet">
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body role="document">
<nav class="navbar navbar-inverse osf-navbar navbar-fixed-top">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<a href="#layout">Layout</a>
<span class="fa fa-bars fa-lg fa-inverse"></span>
</button>
<a class="navbar-brand" href="index.html">OSF Style Guide </span></a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li><a href="index.html">Home<span class="sr-only">(current)</span></a></li>
<li><a href="style.html">Style Guide</a></li>
<li><a href="ui.html">UI Guide </a></li>
<li class="active"><a href="language.html">Language</a></li>
</ul>
<div class="navbar-form navbar-right">
<button id="openGithub" role="button" class="btn btn-info"><i class="fa fa-github"></i> Open in Github</button>
</div>
</div><!-- /.navbar-collapse -->
</div><!-- /.container-fluid -->
</nav>
<div class="container-full style-header">
<div id="top" class="container theme-showcase" >
<div class="jumbotron">
<h1>Language</h1>
</div>
</div>
</div>
<div class="nav-rows container">
<div class="row">
<div class="col-sm-9">
<!--LAYOUT PAGE-->
<div id="layout" >
<div id="clear">
<h3><a></a>Clear language</h3>
<p>Where long form text is used it is best to use descriptive language.</p>
<p>Include a period at the end of all full sentences in body text (including instructional and warning text). Headings should not include puncuation.</p>
<div class="osf-box-lt p-lg">
<h4>Good examples</h4>
<div class="text-success">"Please follow the link to view this file."</div>
<div class="text-success">"The project you selected is not available at this time."</div>
<div class="text-success">"You have entered an incorrect name, please try again."</div>
<h4>Bad examples</h4>
<div class="text-danger">"That's not right. Try again!"<span class="text-muted">//Too colloquial: </span> </div>
<div class="text-danger">"Go here." <span class="text-muted">// Too curt </span></div>
<div class="text-danger">"Error: undefined" <span class="text-muted">// Not human enough</span></div>
<div class="text-danger">"Yay, your form is submitted, awesome!"<span class="text-muted">// Unnecessarily emotional</span></div>
</div>
<p class="m-t-lg"><strong>Short form text</strong> is supposed to be much more direct and refer to as specifically as possible the action of the item, for instance in buttons, labels.</p>
<div class="osf-box-lt p-lg">
<h4>Good examples</h4>
<span class="text-success">"Open"</span>
<span class="text-success">"Delete Multiple"</span>
<span class="text-success">"Keep Both"</span>
<h4>Bad examples</h4>
<div class="text-danger">"Open this file" <span class="text-muted">// No need to define what element the action is on </span></div>
<div class="text-danger">"Delete everything" <span class="text-muted">// Too general</span></div>
<div class="text-danger">"Name:"<span class="text-muted">// Not descriptive enough, full name, first name? </span></div>
<div class="text-danger">"Cancel, Dismiss, Close" <span class="text-muted">// Should use uniform name for same action</span></div>
</div>
<p class="m-t-lg"><strong>Don't use jargon</strong> that our users will be unfamiliar with. Language that is used around the office is not necessarily the language that is most descriptive to our users. Use words and phrases that they will be most familiar with, in the context of the OSF.</p>
<div class="osf-box-lt p-lg">
<h4>Words to avoid</h4>
<div class="text-danger">Node</div>
<div class="text-danger">Child/parent</div>
<div class="text-danger">Pointers</div>
</div>
</div>
<hr>
<h3 id="capitalization">Capitalization</h3>
<div class="row">
<div class="col-sm-12">
<p>The OSF website uses two main capitalization styles.</p>
<p><b>Title case</b>: The first word is always capitalized. All other words are capitalized except articles and short conjunctions and prepositions (fewer than 5 letters). </p>
<div class="osf-box-lt p-lg">
<h4>When to use title case</h4>
<ul>
<li>All text in the top navigation bar (including dropdown text)</li>
<li>Top level page titles (usually the heading with a h1 tag)</li>
</ul>
</div>
<p><b>Sentence case</b>: The first word is always capitalized. All other words are lowercase unless they are proper nouns or quoted titles.</p>
<div class="osf-box-lt p-lg">
<h4>When to use sentence case</h4>
<ul>
<li>Panel headings</li>
<li>Modal titles</li>
<li>Button text</li>
<li>Form labels</li>
<li>Input text</li>
<li>Links</li>
<li>All other elements</li>
</ul>
<p class="text-warning text-center"><b>When in doubt, use sentence case.</b></p>
</div>
<p><b>Note</b>: No element's text on the OSF should be completely lowercase. The first word in any element should always be capitalized.</p>
</div>
</div>
<hr>
<h3 id="style">Language style</h3>
<div class="row">
<div class="col-sm-12">
<p> Follow the <i>Elements of Style</i> in writing in English across the OSF products. <a href="http://www.crockford.com/wrrrld/style.html"> Access Full Text</a>. The following points are especially important: </p>
<ul>
<li>Use the Oxford Comma. <a href="http://thewritepractice.com/why-you-need-to-be-using-oxford-commas/"> Learn more here. </a> </li>
</ul>
</div>
</div>
</div>
</div>
<div id="side-menu" class="col-sm-3 hidden-xs">
<ul class="nav nav-pills nav-stacked m-t-xl" data-spy="affix" data-offset-top="350" data-offset-bottom="200">
<li><a href="#clear">Clear language</a></li>
<li><a href="#capitalization">Capitalization</a></li>
<li><a href="#style">Language style</a></li>
</ul>
</div>
</div>
</div>
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
<script src="vendor/prism/prism.js"></script>
<script src="script.js"></script>
</body>
</html>