govuk_admin_template 3.4.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/app/assets/stylesheets/govuk_admin_template.scss +1 -0
- data/app/assets/stylesheets/govuk_admin_template/_govspeak_help.scss +9 -0
- data/app/assets/stylesheets/govuk_admin_template/_navbar.scss +3 -2
- data/app/views/govuk_admin_template/_govspeak_help.html.erb +215 -0
- data/lib/govuk_admin_template/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f20c5c335ad177c7e7d9a590c4776562d3a0599
|
|
4
|
+
data.tar.gz: 55511919e7f9a0f86aa37edc0a0d20ba548dfe83
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 33faa3809010f59386d3a4e472915328bb3c3076cda2faf33f22bbc01f6b98065c49436c24a4d7ca30f16e73117f1df196008635e15d916ff91e8b6266964b82
|
|
7
|
+
data.tar.gz: 0d492f87d6fef048f933df1a6216143d2adb9e550f3f24985848d05db13b2d471c3f0fe8a76a41021afb225d7b8a68fef984f63d3e8529e8179b52b65d99854a
|
data/CHANGELOG.md
CHANGED
|
@@ -77,7 +77,7 @@ header .navbar-header {
|
|
|
77
77
|
========================================================================== */
|
|
78
78
|
|
|
79
79
|
.environment-indicator {
|
|
80
|
-
border-bottom: 5px solid #
|
|
80
|
+
border-bottom: 5px solid #999;
|
|
81
81
|
}
|
|
82
82
|
|
|
83
83
|
.environment-production .environment-indicator {
|
|
@@ -93,7 +93,8 @@ header .navbar-header {
|
|
|
93
93
|
}
|
|
94
94
|
|
|
95
95
|
.environment-label {
|
|
96
|
-
background: #
|
|
96
|
+
background: #fff;
|
|
97
|
+
color: #333;
|
|
97
98
|
padding: 3px 5px;
|
|
98
99
|
border-radius: 3px;
|
|
99
100
|
font-weight: bold;
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
<div class="govspeak-help">
|
|
2
|
+
<h2>Writing style</h2>
|
|
3
|
+
<p>For style, see the <a href="https://www.gov.uk/designprinciples/styleguide">style guide</a></p>
|
|
4
|
+
|
|
5
|
+
<h2>Formatting help</h2>
|
|
6
|
+
<%= yield :format_specific_help %>
|
|
7
|
+
<h3>
|
|
8
|
+
<a data-toggle="collapse" data-target="#govspeak-headings">
|
|
9
|
+
Headings
|
|
10
|
+
</a>
|
|
11
|
+
</h3>
|
|
12
|
+
<div class="collapse" id="govspeak-headings">
|
|
13
|
+
<pre>## Top level heading - H2
|
|
14
|
+
### Second level heading - H3
|
|
15
|
+
#### Third level heading - H4
|
|
16
|
+
|
|
17
|
+
Don't use a single # - this is H1 and is for the title only</pre>
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
<h3>
|
|
21
|
+
<a data-toggle="collapse" data-target="#govspeak-links">
|
|
22
|
+
Links
|
|
23
|
+
</a>
|
|
24
|
+
</h3>
|
|
25
|
+
<div class="collapse" id="govspeak-links" style="height: auto;">
|
|
26
|
+
<p>
|
|
27
|
+
All documents created in the publisher - policies, publications, news, speeches, detailed guides etc -
|
|
28
|
+
should be linked to using absolute admin paths or full public URLs:
|
|
29
|
+
</p>
|
|
30
|
+
<pre>[an admin path](/government/admin/policies/12345)
|
|
31
|
+
[a public URL](https://www.gov.uk/government/policies/example-policy)</pre>
|
|
32
|
+
|
|
33
|
+
<p>All content created under an organisation tab - collection pages, topics, organisations, people, roles etc - should be linked to using the full, public URLs:</p>
|
|
34
|
+
<pre>[link text](https://www.gov.uk/government/topics/climate-change)</pre>
|
|
35
|
+
|
|
36
|
+
<p>For external websites, use the full URL including http://:</p>
|
|
37
|
+
<pre>[link text](http://www.example.com)</pre>
|
|
38
|
+
<p>The link will display with an external link symbol.</p>
|
|
39
|
+
|
|
40
|
+
<h4>Linking to paragraphs</h4>
|
|
41
|
+
<p>
|
|
42
|
+
If you want to link to specific paragraphs within a document, you need to mark the paragraph as linkable
|
|
43
|
+
by placing an anchor tag <strong>below</strong> the paragraph:
|
|
44
|
+
</p>
|
|
45
|
+
<pre>Stocks of some fish species are very low. For example, stocks of European Eel have declined by about 95% over the last 30 years.
|
|
46
|
+
{:#eel-decline}
|
|
47
|
+
</pre>
|
|
48
|
+
|
|
49
|
+
<p>The paragraph can then be linked to from the same document:</p>
|
|
50
|
+
<pre>[Sample link text](#eel-decline)</pre>
|
|
51
|
+
|
|
52
|
+
<p>or from another document:</p>
|
|
53
|
+
<pre>[Sample link text](https://www.gov.uk/government/policies/managing-freshwater-fisheries#eel-decline)</pre>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
<h3>
|
|
57
|
+
<a data-toggle="collapse" data-target="#govspeak-bullets">
|
|
58
|
+
Bullets
|
|
59
|
+
</a>
|
|
60
|
+
</h3>
|
|
61
|
+
<div class="collapse" id="govspeak-bullets" style="height: 0px;">
|
|
62
|
+
<pre>* item 1
|
|
63
|
+
* item 2
|
|
64
|
+
* sub-item
|
|
65
|
+
* another sub-item
|
|
66
|
+
(to indent, add 2 spaces)</pre>
|
|
67
|
+
</div>
|
|
68
|
+
|
|
69
|
+
<h3>
|
|
70
|
+
<a data-toggle="collapse" data-target="#govspeak-numbered-list">
|
|
71
|
+
Numbered list
|
|
72
|
+
</a>
|
|
73
|
+
</h3>
|
|
74
|
+
<div class="collapse" id="govspeak-numbered-list" style="height: 0px;">
|
|
75
|
+
<pre>1. item 1
|
|
76
|
+
2. item 2
|
|
77
|
+
3. item 3
|
|
78
|
+
* sub-item
|
|
79
|
+
* another sub-item
|
|
80
|
+
(to indent, add 2 spaces)</pre>
|
|
81
|
+
</div>
|
|
82
|
+
|
|
83
|
+
<h3>
|
|
84
|
+
<a data-toggle="collapse" data-target="#govspeak-priority-list">
|
|
85
|
+
Priority list
|
|
86
|
+
</a>
|
|
87
|
+
</h3>
|
|
88
|
+
<div class="collapse" id="govspeak-priority-list">
|
|
89
|
+
<p>
|
|
90
|
+
You can create a list which shows only the first n items (including attachments),
|
|
91
|
+
with a link to open the others, eg to show the first item:
|
|
92
|
+
</p>
|
|
93
|
+
|
|
94
|
+
<pre>$PriorityList:1
|
|
95
|
+
* item 1
|
|
96
|
+
* item 2
|
|
97
|
+
* item 3</pre>
|
|
98
|
+
</div>
|
|
99
|
+
|
|
100
|
+
<h3>
|
|
101
|
+
<a data-toggle="collapse" data-target="#govspeak-legislative-list">
|
|
102
|
+
Legislative list
|
|
103
|
+
</a>
|
|
104
|
+
</h3>
|
|
105
|
+
<div class="collapse" id="govspeak-legislative-list">
|
|
106
|
+
<p>
|
|
107
|
+
For lists where you want to specify the numbering and have multiple indent levels.
|
|
108
|
+
</p>
|
|
109
|
+
|
|
110
|
+
<pre>$LegislativeList
|
|
111
|
+
* 1. Item 1
|
|
112
|
+
* 2. Item 2
|
|
113
|
+
* a) Item 2a
|
|
114
|
+
* b) Item 2b
|
|
115
|
+
* i. Item 2 b i
|
|
116
|
+
* ii. Item 2 b ii
|
|
117
|
+
* 3. Item 3
|
|
118
|
+
$EndLegislativeList
|
|
119
|
+
(to indent, add 2 spaces)</pre>
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<h3>
|
|
123
|
+
<a data-toggle="collapse" data-target="#govspeak-tables">
|
|
124
|
+
Tables
|
|
125
|
+
</a>
|
|
126
|
+
</h3>
|
|
127
|
+
<div class="collapse" id="govspeak-tables">
|
|
128
|
+
<p>Tables can be inserted by splitting your content into cells:</p>
|
|
129
|
+
<pre>| name | colour |
|
|
130
|
+
|--------|-------|
|
|
131
|
+
| apple | green |
|
|
132
|
+
| banana | yellow |</pre>
|
|
133
|
+
|
|
134
|
+
<p>You can also use a shorthand version of the markdown, which will produce exactly the same output:</p>
|
|
135
|
+
<pre>name | colour
|
|
136
|
+
-|-
|
|
137
|
+
apple | green
|
|
138
|
+
banana | yellow</pre>
|
|
139
|
+
</div>
|
|
140
|
+
|
|
141
|
+
<h3>
|
|
142
|
+
<a data-toggle="collapse" data-target="#govspeak-cta">
|
|
143
|
+
Call to action
|
|
144
|
+
</a>
|
|
145
|
+
</h3>
|
|
146
|
+
<div class="collapse" id="govspeak-cta" style="height: 0px;">
|
|
147
|
+
<pre>$CTA
|
|
148
|
+
[Use the trade tariff tool to find commodity codes.](https://www.gov.uk/trade-tariff)
|
|
149
|
+
$CTA</pre>
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
<h3>
|
|
153
|
+
<a data-toggle="collapse" data-target="#govspeak-abbreviations-and-acronyms">
|
|
154
|
+
Abbreviations and acronyms
|
|
155
|
+
</a>
|
|
156
|
+
</h3>
|
|
157
|
+
<div class="collapse" id="govspeak-abbreviations-and-acronyms">
|
|
158
|
+
<pre>Example content containing DWP and EU acronyms.
|
|
159
|
+
|
|
160
|
+
*[EU]: European Union
|
|
161
|
+
*[DWP]: Department for Work and Pensions</pre>
|
|
162
|
+
<p>Text found in content which matches what’s in the brackets <code>[ ]</code> (eg DWP), will have the full text (Department for Work and Pensions) available to screenreaders and when hovering: <abbr title="Department for Work and Pensions">DWP</abbr>. The markdown code will not be displayed.</p>
|
|
163
|
+
<p>List abbreviation markdown at the end.</p>
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
<h3>
|
|
167
|
+
<a data-toggle="collapse" data-target="#govspeak-blockquotes">
|
|
168
|
+
Blockquotes
|
|
169
|
+
</a>
|
|
170
|
+
</h3>
|
|
171
|
+
<div class="collapse" id="govspeak-blockquotes" style="height: 0px;">
|
|
172
|
+
<pre>As the Prime Minister said:
|
|
173
|
+
|
|
174
|
+
> Rule, Britannia, rule the waves.
|
|
175
|
+
>
|
|
176
|
+
> Britons never shall be slaves.</pre>
|
|
177
|
+
<p>The > in the line space is important. If you leave it out you will get 2 separate quotes, not 1 running quote.</p>
|
|
178
|
+
</div>
|
|
179
|
+
|
|
180
|
+
<h3>
|
|
181
|
+
<a data-toggle="collapse" data-target="#govspeak-addresses">
|
|
182
|
+
Addresses
|
|
183
|
+
</a>
|
|
184
|
+
</h3>
|
|
185
|
+
<div class="collapse" id="govspeak-addresses" style="height: 0px;">
|
|
186
|
+
<pre>$A
|
|
187
|
+
Address
|
|
188
|
+
Only
|
|
189
|
+
Here
|
|
190
|
+
$A</pre>
|
|
191
|
+
|
|
192
|
+
</div>
|
|
193
|
+
|
|
194
|
+
<h3>
|
|
195
|
+
<a data-toggle="collapse" data-target="#govspeak-footnotes">
|
|
196
|
+
Footnotes
|
|
197
|
+
</a>
|
|
198
|
+
</h3>
|
|
199
|
+
<div class="collapse" id="govspeak-footnotes">
|
|
200
|
+
<pre>Footnotes can be added[^1].
|
|
201
|
+
|
|
202
|
+
[^1]: And then later defined.</pre>
|
|
203
|
+
<p>
|
|
204
|
+
You can add a footnote marker to a document using [^<em>i</em>] where <em>i</em> is the footnote number or label. Each of these tags should have corresponding footnote content, defined with [^<em>i</em>]: <em>The footnote content</em>. The footnote content will always appear at the end of the document regardless of where they are in the markdown.
|
|
205
|
+
</p>
|
|
206
|
+
<p>
|
|
207
|
+
Footnote content can hold more than one paragraph by indenting the content 4 spaces:
|
|
208
|
+
</p>
|
|
209
|
+
|
|
210
|
+
<pre>[^1]:
|
|
211
|
+
This is some footnote content and is indented 4 spaces.
|
|
212
|
+
|
|
213
|
+
This paragraph is also indented, so will be considered part of the footnote content.</pre>
|
|
214
|
+
</div>
|
|
215
|
+
</div>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: govuk_admin_template
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.5.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- GOV.UK Dev
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2015-
|
|
11
|
+
date: 2015-12-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rails
|
|
@@ -158,6 +158,7 @@ files:
|
|
|
158
158
|
- app/assets/stylesheets/govuk_admin_template/_bootstrap_colour_overrides.scss
|
|
159
159
|
- app/assets/stylesheets/govuk_admin_template/_bootstrap_overrides.scss
|
|
160
160
|
- app/assets/stylesheets/govuk_admin_template/_buttons.scss
|
|
161
|
+
- app/assets/stylesheets/govuk_admin_template/_govspeak_help.scss
|
|
161
162
|
- app/assets/stylesheets/govuk_admin_template/_input_helpers.scss
|
|
162
163
|
- app/assets/stylesheets/govuk_admin_template/_mixins.scss
|
|
163
164
|
- app/assets/stylesheets/govuk_admin_template/_nav_list.scss
|
|
@@ -169,6 +170,7 @@ files:
|
|
|
169
170
|
- app/assets/stylesheets/govuk_admin_template/bootstrap-ie7.scss
|
|
170
171
|
- app/controllers/govuk_admin_template/application_controller.rb
|
|
171
172
|
- app/controllers/govuk_admin_template/style_guide_controller.rb
|
|
173
|
+
- app/views/govuk_admin_template/_govspeak_help.html.erb
|
|
172
174
|
- app/views/govuk_admin_template/_table_filter.html.erb
|
|
173
175
|
- app/views/govuk_admin_template/style_guide/index.html.erb
|
|
174
176
|
- app/views/layouts/govuk_admin_template.html.erb
|