Skip to content

Commit 2b39fe4

Browse files
alaric-rdalaric-rd
authored
Docs: Various updates requested by Nisa (#125)
* Added a "realistic" (ish) spreadsheet for taking screenshots from * Ongoing work on extra pages, redesign homescreen * Ongoing docs tweaks from Nisa * Navigation and new pages
1 parent f47b6fc commit 2b39fe4

15 files changed

+919
-123
lines changed

‎doc/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,27 @@ selectable_table.css
22
sheet_selector.css
33
x-govuk-masthead.css
44
docs.css
5+
get-started-screenshots.png
56
class_list.js
67
keys.js
78
selectable_polyfills.js
89
selectable_table.js
910
sheet_selector.js
1011
logo.png
12+
mainpage-screenshots.png
1113
govuk-frontend.min.js
1214
init.js
1315
auto-store-data.js
1416
kit.js
1517
application.js
1618
application.css
19+
articles.html
1720
component-sheet-selector.html
1821
component-table-view.html
22+
how-it-works.html
1923
index.html
2024
pattern-tabular-data.html
2125
start.html
26+
what-it-is.html
2227
assets.mk
2328
assets.txt

‎doc/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ OBJECTS := $(subst ../lib/importer/assets/docs/,./,${SOURCES})
1818
assets.txt: ${SOURCES}
1919
(echo $^ | xargs -n1 | xargs -I INPUT ${HQ} -r '[data-plugin-only]' -f INPUT -a src 'script[src]'; \
2020
echo $^ | xargs -n1 | xargs -I INPUT ${HQ} -r '[data-plugin-only]' -f INPUT -a href 'link[rel=stylesheet]'; \
21-
echo ${IMAGES} | sed 's_\.\./lib/importer/assets/docs/_./_') | \
21+
echo ${IMAGES} | xargs -n1 | sed 's_\.\./lib/importer/assets/docs/_./_') | \
2222
sort -u | grep . > $@
2323

2424
# Now build a Makefile dependency include, specifying the correct download

‎fixtures/realistic.ods‎

12 KB
Binary file not shown.

‎lib/importer/assets/docs/articles.html‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<meta charset="utf-8">
6+
<title>Data Upload Design Kit: Articles</title>
7+
<link href="/public/stylesheets/application.css" rel="stylesheet" type="text/css" />
8+
<link href="../css/selectable_table.css" rel="stylesheet" type="text/css" />
9+
<link href="./docs.css" rel="stylesheet" type="text/css" />
10+
<link href="../css/x-govuk-masthead.css" rel="stylesheet" type="text/css" />
11+
<style type="text/css" data-plugin-only>
12+
[data-static-only] {
13+
display: none;
14+
}
15+
</style>
16+
<style type="text/css">
17+
ul#article-list {
18+
list-style-type: none;
19+
padding: 0;
20+
}
21+
ul#article-list li {
22+
display: flex;
23+
flex-direction: row;
24+
flex-wrap: nowrap;
25+
align-items: start;
26+
gap: 1em;
27+
}
28+
ul#article-list li a.image {
29+
width: 30%;
30+
}
31+
ul#article-list li a.image img {
32+
width: 100%;
33+
}
34+
ul#article-list li p {
35+
}
36+
</style>
37+
<link data-plugin-only rel="icon" sizes="48x48"
38+
href="/manage-prototype/dependencies/govuk-frontend/dist/govuk/assets/images/favicon.ico">
39+
<link data-plugin-only rel="icon" sizes="any"
40+
href="/manage-prototype/dependencies/govuk-frontend/dist/govuk/assets/images/favicon.svg" type="image/svg+xml">
41+
<link data-plugin-only rel="mask-icon"
42+
href="/manage-prototype/dependencies/govuk-frontend/dist/govuk/assets/images/govuk-icon-mask.svg"
43+
color="#0b0c0c">
44+
<link data-plugin-only rel="apple-touch-icon"
45+
href="/manage-prototype/dependencies/govuk-frontend/dist/govuk/assets/images/govuk-icon-180.png">
46+
</head>
47+
48+
<body class="govuk-template__body">
49+
<a href="#main-content" class="govuk-skip-link" data-module="govuk-skip-link">Skip to main content</a>
50+
<header class="govuk-header">
51+
<div class="govuk-header__container govuk-width-container">
52+
<div class="govuk-header__logo" data-plugin-only>
53+
<a href="/manage-prototype" class="govuk-header__link govuk-header__link--homepage">
54+
<svg focusable="false" role="img" class="govuk-header__logotype" xmlns="http://www.w3.org/2000/svg"
55+
viewBox="0 0 148 30" height="30" width="148" aria-label="GOV.UK">
56+
<title>GOV.UK</title>
57+
<path
58+
d="M22.6 10.4c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m-5.9 6.7c-.9.4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m10.8-3.7c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s0 2-1 2.4m3.3 4.8c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4M17 4.7l2.3 1.2V2.5l-2.3.7-.2-.2.9-3h-3.4l.9 3-.2.2c-.1.1-2.3-.7-2.3-.7v3.4L15 4.7c.1.1.1.2.2.2l-1.3 4c-.1.2-.1.4-.1.6 0 1.1.8 2 1.9 2.2h.7c1-.2 1.9-1.1 1.9-2.1 0-.2 0-.4-.1-.6l-1.3-4c-.1-.2 0-.2.1-.3m-7.6 5.7c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m-5 3c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s.1 2 1 2.4m-3.2 4.8c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m14.8 11c4.4 0 8.6.3 12.3.8 1.1-4.5 2.4-7 3.7-8.8l-2.5-.9c.2 1.3.3 1.9 0 2.7-.4-.4-.8-1.1-1.1-2.3l-1.2 4c.7-.5 1.3-.8 2-.9-1.1 2.5-2.6 3.1-3.5 3-1.1-.2-1.7-1.2-1.5-2.1.3-1.2 1.5-1.5 2.1-.1 1.1-2.3-.8-3-2-2.3 1.9-1.9 2.1-3.5.6-5.6-2.1 1.6-2.1 3.2-1.2 5.5-1.2-1.4-3.2-.6-2.5 1.6.9-1.4 2.1-.5 1.9.8-.2 1.1-1.7 2.1-3.5 1.9-2.7-.2-2.9-2.1-2.9-3.6.7-.1 1.9.5 2.9 1.9l.4-4.3c-1.1 1.1-2.1 1.4-3.2 1.4.4-1.2 2.1-3 2.1-3h-5.4s1.7 1.9 2.1 3c-1.1 0-2.1-.2-3.2-1.4l.4 4.3c1-1.4 2.2-2 2.9-1.9-.1 1.5-.2 3.4-2.9 3.6-1.9.2-3.4-.8-3.5-1.9-.2-1.3 1-2.2 1.9-.8.7-2.3-1.2-3-2.5-1.6.9-2.2.9-3.9-1.2-5.5-1.5 2-1.3 3.7.6 5.6-1.2-.7-3.1 0-2 2.3.6-1.4 1.8-1.1 2.1.1.2.9-.3 1.9-1.5 2.1-.9.2-2.4-.5-3.5-3 .6 0 1.2.3 2 .9l-1.2-4c-.3 1.1-.7 1.9-1.1 2.3-.3-.8-.2-1.4 0-2.7l-2.9.9C1.3 23 2.6 25.5 3.7 30c3.7-.5 7.9-.8 12.3-.8m28.3-11.6c0 .9.1 1.7.3 2.5.2.8.6 1.5 1 2.2.5.6 1 1.1 1.7 1.5.7.4 1.5.6 2.5.6.9 0 1.7-.1 2.3-.4s1.1-.7 1.5-1.1c.4-.4.6-.9.8-1.5.1-.5.2-1 .2-1.5v-.2h-5.3v-3.2h9.4V28H55v-2.5c-.3.4-.6.8-1 1.1-.4.3-.8.6-1.3.9-.5.2-1 .4-1.6.6s-1.2.2-1.8.2c-1.5 0-2.9-.3-4-.8-1.2-.6-2.2-1.3-3-2.3-.8-1-1.4-2.1-1.8-3.4-.3-1.4-.5-2.8-.5-4.3s.2-2.9.7-4.2c.5-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.6 2.6-.8 4.1-.8 1 0 1.9.1 2.8.3.9.2 1.7.6 2.4 1s1.4.9 1.9 1.5c.6.6 1 1.3 1.4 2l-3.7 2.1c-.2-.4-.5-.9-.8-1.2-.3-.4-.6-.7-1-1-.4-.3-.8-.5-1.3-.7-.5-.2-1.1-.2-1.7-.2-1 0-1.8.2-2.5.6-.7.4-1.3.9-1.7 1.5-.5.6-.8 1.4-1 2.2-.3.8-.4 1.9-.4 2.7zM71.5 6.8c1.5 0 2.9.3 4.2.8 1.2.6 2.3 1.3 3.1 2.3.9 1 1.5 2.1 2 3.4s.7 2.7.7 4.2-.2 2.9-.7 4.2c-.4 1.3-1.1 2.4-2 3.4-.9 1-1.9 1.7-3.1 2.3-1.2.6-2.6.8-4.2.8s-2.9-.3-4.2-.8c-1.2-.6-2.3-1.3-3.1-2.3-.9-1-1.5-2.1-2-3.4-.4-1.3-.7-2.7-.7-4.2s.2-2.9.7-4.2c.4-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.5 2.6-.8 4.2-.8zm0 17.6c.9 0 1.7-.2 2.4-.5s1.3-.8 1.7-1.4c.5-.6.8-1.3 1.1-2.2.2-.8.4-1.7.4-2.7v-.1c0-1-.1-1.9-.4-2.7-.2-.8-.6-1.6-1.1-2.2-.5-.6-1.1-1.1-1.7-1.4-.7-.3-1.5-.5-2.4-.5s-1.7.2-2.4.5-1.3.8-1.7 1.4c-.5.6-.8 1.3-1.1 2.2-.2.8-.4 1.7-.4 2.7v.1c0 1 .1 1.9.4 2.7.2.8.6 1.6 1.1 2.2.5.6 1.1 1.1 1.7 1.4.6.3 1.4.5 2.4.5zM88.9 28 83 7h4.7l4 15.7h.1l4-15.7h4.7l-5.9 21h-5.7zm28.8-3.6c.6 0 1.2-.1 1.7-.3.5-.2 1-.4 1.4-.8.4-.4.7-.8.9-1.4.2-.6.3-1.2.3-2v-13h4.1v13.6c0 1.2-.2 2.2-.6 3.1s-1 1.7-1.8 2.4c-.7.7-1.6 1.2-2.7 1.5-1 .4-2.2.5-3.4.5-1.2 0-2.4-.2-3.4-.5-1-.4-1.9-.9-2.7-1.5-.8-.7-1.3-1.5-1.8-2.4-.4-.9-.6-2-.6-3.1V6.9h4.2v13c0 .8.1 1.4.3 2 .2.6.5 1 .9 1.4.4.4.8.6 1.4.8.6.2 1.1.3 1.8.3zm13-17.4h4.2v9.1l7.4-9.1h5.2l-7.2 8.4L148 28h-4.9l-5.5-9.4-2.7 3V28h-4.2V7zm-27.6 16.1c-1.5 0-2.7 1.2-2.7 2.7s1.2 2.7 2.7 2.7 2.7-1.2 2.7-2.7-1.2-2.7-2.7-2.7z">
59+
</path>
60+
</svg>
61+
</a>
62+
</div>
63+
<div id="static-header" data-static-only>
64+
<a href="./index.html" class="govuk-header__link govuk-header__link--homepage">Data Upload Design Kit</a>
65+
</div>
66+
<div class="govuk-header__content">
67+
<a href="/manage-prototype" data-plugin-only class="govuk-header__link govuk-header__service-name">
68+
Prototype Kit
69+
</a>
70+
</div>
71+
</div>
72+
</header>
73+
74+
<div class="govuk-width-container">
75+
<div class="govuk-breadcrumbs">
76+
<ol class="govuk-breadcrumbs__list">
77+
<li class="govuk-breadcrumbs__list-item">
78+
<a class="govuk-breadcrumbs__link" href="./index.html">Home</a>
79+
</li>
80+
<li class="govuk-breadcrumbs__list-item">
81+
<a class="govuk-breadcrumbs__link" href="./articles.html">Articles</a>
82+
</li>
83+
</ol>
84+
</div>
85+
<main id="main-content" class="govuk-main-wrapper">
86+
<div class="govuk-grid-row">
87+
<div class="govuk-grid-column-one-quarter-from-desktop">
88+
<nav class="sub-navigation" aria-labelledby="sub-navigation-heading">
89+
<h2 id="sub-navigation-heading" class="govuk-visually-hidden">Pages in this section</h2>
90+
<h3 class="sub-navigation-heading">Introduction</h3>
91+
<ul class="sub-navigation-section">
92+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./what-it-is.html">What it is</a></li>
93+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./how-it-works.html">How it works</a></li>
94+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./start.html">Get started</a></li>
95+
<li class="sub-navigation-item sub-navigation-item-current"><a aria-current="true" class="sub-navigation-link" href="./articles.html">Articles</a></li>
96+
</ul>
97+
<h3 class="sub-navigation-heading">Patterns and Components</h3>
98+
<ul class="sub-navigation-section">
99+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./pattern-tabular-data.html">Tabular data</a></li>
100+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./component-table-view.html">Table view</a></li>
101+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./component-sheet-selector.html">Sheet selector</a></li>
102+
</ul>
103+
</nav>
104+
</div>
105+
<div class="govuk-grid-column-three-quarters-from-desktop">
106+
<article class="app-prose">
107+
<h1 class="govuk-heading-xl">Articles</h1>
108+
109+
<p>Here are some articles that offer more information about the <a href="index.html">Data Upload Design Kit</a>:</p>
110+
111+
<ul id="article-list">
112+
<li>
113+
<a href="https://www.register-dynamics.co.uk/blog/collect-data-for-your-govuk-service-in-minutes-using-our-data-upload-design-kit" class="image">
114+
<img src="logo.png" />
115+
</a>
116+
<p><a href="https://www.register-dynamics.co.uk/blog/collect-data-for-your-govuk-service-in-minutes-using-our-data-upload-design-kit">Collect data for your GOV.UK service in minutes using our Data Upload Design Kit</a></p>
117+
</li>
118+
</ul>
119+
</article>
120+
</div>
121+
</div>
122+
</main>
123+
</div>
124+
<footer class="govuk-footer">
125+
<div class="govuk-width-container">
126+
<div class="govuk-footer__meta">
127+
<div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
128+
<svg aria-hidden="true" focusable="false" class="govuk-footer__licence-logo"
129+
xmlns="http://www.w3.org/2000/svg" viewBox="0 0 483.2 195.7" height="17" width="41">
130+
<path fill="currentColor"
131+
d="M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145" />
132+
</svg>
133+
<span class="govuk-footer__licence-description">
134+
All content is available under the
135+
<a class="govuk-footer__link"
136+
href="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
137+
rel="license">Open Government Licence v3.0</a>, except where otherwise stated
138+
</span>
139+
</div>
140+
<div class="govuk-footer__meta-item">
141+
<a href="https://www.register-dynamics.co.uk"
142+
class="govuk-footer__link govuk-footer__copyright-logo rd-logo">
143+
&copy; Register Dynamics 2024
144+
</a>
145+
</div>
146+
</div>
147+
</div>
148+
</footer>
149+
</body>
150+
151+
</html>

‎lib/importer/assets/docs/component-sheet-selector.html‎

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<head>
55
<meta charset="utf-8">
6-
<title>Sheet selector – Data Design Kit by Register Dynamics</title>
6+
<title>Sheet selector – Data Upload Design Kit by Register Dynamics</title>
77
<link href="/public/stylesheets/application.css" rel="stylesheet" type="text/css" />
88
<link href="../css/sheet_selector.css" rel="stylesheet" type="text/css" />
99
<link href="../css/selectable_table.css" rel="stylesheet" type="text/css" />
@@ -39,8 +39,8 @@
3939
<a href="#main-content" class="govuk-skip-link" data-module="govuk-skip-link">Skip to main content</a>
4040
<header class="govuk-header">
4141
<div class="govuk-header__container govuk-width-container">
42-
<div class="govuk-header__logo">
43-
<a href="/manage-prototype" data-plugin-only class="govuk-header__link govuk-header__link--homepage">
42+
<div class="govuk-header__logo" data-plugin-only>
43+
<a href="/manage-prototype" class="govuk-header__link govuk-header__link--homepage">
4444
<svg focusable="false" role="img" class="govuk-header__logotype" xmlns="http://www.w3.org/2000/svg"
4545
viewBox="0 0 148 30" height="30" width="148" aria-label="GOV.UK">
4646
<title>GOV.UK</title>
@@ -49,7 +49,9 @@
4949
</path>
5050
</svg>
5151
</a>
52-
<a href="/" data-static-only class="govuk-header__link govuk-header__link--homepage">Data Design Kit</a>
52+
</div>
53+
<div id="static-header" data-static-only>
54+
<a href="./index.html" class="govuk-header__link govuk-header__link--homepage">Data Upload Design Kit</a>
5355
</div>
5456
<div class="govuk-header__content">
5557
<a href="/manage-prototype" data-plugin-only class="govuk-header__link govuk-header__service-name">
@@ -75,6 +77,28 @@
7577
</nav>
7678

7779
<main class="govuk-main-wrapper" id="main-content">
80+
<div class="govuk-grid-row">
81+
<div class="govuk-grid-column-one-quarter-from-desktop">
82+
<nav class="sub-navigation" aria-labelledby="sub-navigation-heading">
83+
<h2 id="sub-navigation-heading" class="govuk-visually-hidden">Pages in this section</h2>
84+
<h3 class="sub-navigation-heading">Introduction</h3>
85+
<ul class="sub-navigation-section">
86+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./what-it-is.html">What it is</a></li>
87+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./how-it-works.html">How it works</a></li>
88+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./start.html">Get started</a></li>
89+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./articles.html">Articles</a></li>
90+
</ul>
91+
<h3 class="sub-navigation-heading">Patterns and Components</h3>
92+
<ul class="sub-navigation-section">
93+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./pattern-tabular-data.html">Tabular data</a></li>
94+
<li class="sub-navigation-item false"><a class="sub-navigation-link" href="./component-table-view.html">Table view</a></li>
95+
<li class="sub-navigation-item sub-navigation-item-current"><a aria-current="true" class="sub-navigation-link" href="./component-sheet-selector.html">Sheet selector</a></li>
96+
</ul>
97+
</nav>
98+
</div>
99+
<div class="govuk-grid-column-three-quarters-from-desktop">
100+
<article class="app-prose">
101+
78102
<span class="govuk-caption-xl">Components</span>
79103
<h1 class="govuk-heading-xl">Sheet selector</h1>
80104
<p>Ask the user to pick one from multiple worksheets in a spreadsheet they uploaded.</p>
@@ -473,6 +497,9 @@ <h2 class="govuk-heading-l">Accessibility</h2>
473497
<li>Sheet previews are shown using the accessible <a href="component-table-view.html">Table view
474498
component</a>.</li>
475499
</ul>
500+
</article>
501+
</div>
502+
</div>
476503
</main>
477504
</div>
478505
<footer class="govuk-footer">
@@ -502,4 +529,4 @@ <h2 class="govuk-heading-l">Accessibility</h2>
502529
</footer>
503530
</body>
504531

505-
</html>
532+
</html>

0 commit comments

Comments
 (0)