|' $TMP_BODY
39 |
40 | # Append "rel" attribute for external links
41 | sed -i 's|
52 |
53 | $(cat partials/head.html)
54 |
57 |
58 |
59 | $(cat partials/header-nav.html)
60 | $(cat $TMP_BODY)
61 |
64 |
65 |
66 | EOF
67 |
68 | echo "Copying assets..."
69 | cp -r assets build/
70 | cp -r ../apps build/
71 | cp -r ../figures build/
72 | rm build/_tmp_*
73 |
74 | echo "Done!"
75 |
--------------------------------------------------------------------------------
/online/partials/head.html:
--------------------------------------------------------------------------------
1 |
2 | Ubuntu MATE Guide
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 |
--------------------------------------------------------------------------------
/online/assets/logo-white.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
87 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Ubuntu MATE Guide
2 |
3 | **A guide to Ubuntu MATE**
4 |
5 | Written in DocBook XML V4.5 format [DocBook](http://docbook.org/xml/4.5/docbookx.dtd) - a semantic markup language for technical documentation.
6 |
7 | ## History
8 |
9 | The version of this guide provided in Ubuntu MATE release 17.10 and earlier was written using the [Mallard](http://projectmallard.org/index.html) topic-oriented markup format. Mallard documentation consists of a set of text files for documentation presented to users with the **Yelp** help system pre-installed in Ubuntu MATE. Mallard formatting is used by several Linux applications packaged with Ubuntu MATE.
10 |
11 | With Ubuntu MATE release 18.10 the documentation has been expanded significantly and now uses the *DocBook* format. *DocBook* is also a markup format for creating documentation presented to users with the **Yelp** help system, however the entire documentation is contained in a single file named `index.docbook`. This format appears to be preferred in documentation produced for applications produced by the MATE project. Although the presentation in the help system is slightly different, both the *DocBook* format and the *Mallard* format for documentation can link to one-another and interact nicely in **Yelp**.
12 |
13 | The most recent update to the guide incorporates new applications and features of **Ubuntu MATE release 22.04**.
14 |
15 | ## Translations
16 |
17 | The documentation is only in English at the moment.
18 |
19 | ## Contributing
20 |
21 | ### Setting up the DocBook Writing Environment
22 |
23 | First, as long as you have a text editor, you have all the tools you need to create the documentation.
24 |
25 | Most text editors, like **Pluma**, have the ability to set the "Highlight Mode" to provide syntax highlighting for DocBook XML files. When using **Pluma**, you select *View > Highlight Mode > Markup > DocBook*.
26 |
27 | When you save the file with the `.docbook` extension, the next time you open the file in the text editor, it will be highlighted correctly so that you can continue editing.
28 |
29 | ### Clone the files
30 |
31 | ```shell
32 | git clone git@github.com:ubuntu-mate/ubuntu-mate-guide.git
33 | ```
34 |
35 | or if you prefer to use `gh`
36 |
37 | ```shell
38 | gh repo clone ubuntu-mate/ubuntu-mate-guide
39 | ```
40 |
41 | ### Reducing the size of graphics files
42 |
43 | Graphics files contained in the /apps and /figures folders. To reduce the size of png and jpg files, use these two commands:
44 |
45 | ```shell
46 | jpegoptim --strip-all -t *.jpg
47 | optipng -strip all -o7 *.png
48 | ```
49 |
50 | ### Testing the index.docbook file
51 |
52 | The entire ubuntu-mate-guide is contained in the file `index.docbook`, with graphics files contained in the /apps and /figures folders. To test the file, open it in **Yelp**:
53 |
54 | ```shell
55 | yelp index.docbook
56 | ```
57 |
58 | ### File location in Ubuntu MATE
59 |
60 | The `index.docbook` file is simply placed in this location:
61 |
62 | /usr/share/help/C/ubuntu-mate-guide/index.docbook
63 |
64 | Translations are placed in `/usr/share/help//ubuntu-mate-guide/index.docbook` (where `` is the standard two-letter language code).
65 |
66 | It is available to install via the [ubuntu-mate-guide package](https://packages.ubuntu.com/noble/ubuntu-mate-guide) in the Ubuntu repositories.
67 |
68 |
69 | ## Testing
70 |
71 | ### PDF Conversion
72 |
73 | Install these command-line utilities: `pandoc` `texlive-xetex` and `texlive-fonts-extra` (and dependencies) from the Ubuntu MATE repositories and use **pandoc** to convert the docbook file to markdown and then from markdown to pdf:
74 |
75 | ```shell
76 | pandoc -f docbook -t markdown -s index.docbook -o UMGuide.md
77 | pandoc UMGuide.md --pdf-engine=xelatex -o UMGuide.pdf
78 | ```
79 |
80 | ### HTML Conversion
81 |
82 | The `pandoc` application can also used to create a HTML version used as the basis for the online version at [http://guide.ubuntu-mate.org](http://guide.ubuntu-mate.org).
83 |
84 | An HTML file can be created from the markdown file with this command:
85 |
86 | ```
87 | pandoc -s UMGuide.md -o UMGuide.html
88 | ```
89 |
90 | ## guide.ubuntu-mate.org
91 |
92 | The code for generating the online version of the guide is stored in the `online` folder.
93 | Successful builds will be published at for immediate viewing.
94 |
95 | To build from the repository folder, run:
96 |
97 | ./online/build.sh
98 |
99 | Then, open the resulting `online/build/index.html` in your web browser.
100 |
101 | Changes merged into this repository (against the `master` branch) will be automatically published.
102 |
103 |
104 | ## License
105 |
106 | [Creative Commons Attribution 4.0 International (CC-BY-4.0)](LICENSE)
107 |
--------------------------------------------------------------------------------
/online/partials/guide.js:
--------------------------------------------------------------------------------
1 |
2 | const sidebar = document.getElementById("guide-sidebar");
3 | const sidebarContents = document.getElementById("sidebar-contents");
4 | const headings = document.querySelectorAll("h1");
5 | const btnPrev = document.getElementById("prev-section");
6 | const btnNext = document.getElementById("next-section");
7 |
8 | const sidebarMobileToggle = document.getElementById("mobile-nav-toggle");
9 | const sidebarMobileBtn = document.getElementById("sidebar-invisible");
10 | const btnPrevMobile = document.getElementById("prev-section-mobile");
11 | const btnNextMobile = document.getElementById("next-section-mobile");
12 |
13 | let scrollTimeout = null;
14 |
15 | // Track current position in sidebar
16 | function refreshSidebar(event) {
17 | clearTimeout(scrollTimeout);
18 | scrollTimeout = setTimeout(function() {
19 | const scrollPos = document.documentElement.scrollTop || document.body.scrollTop;
20 | let id = null;
21 |
22 | for (h = 1; h < headings.length; h++ ) {
23 | let header = headings[h];
24 |
25 | if (header.offsetTop <= scrollPos + 100) {
26 | id = header.id;
27 | }
28 | }
29 |
30 | const active = document.querySelector(".active") || sidebarContents.childNodes[1];
31 | const target = document.getElementById(`nav-${id}`) || sidebarContents.querySelector(".nav-item");
32 |
33 | active.classList.remove("active");
34 | target.classList.add("active");
35 | target.scrollIntoView({
36 | behavior: "smooth",
37 | block: "center"
38 | });
39 |
40 | // Keep the hash in the address bar up-to-date
41 | if (id)
42 | history.replaceState(null, null, `#${id}`);
43 |
44 | // Disable next/prev buttons accordingly
45 | _updateNextPrevButtons();
46 | }, 100);
47 | }
48 |
49 | window.addEventListener("DOMContentLoaded", function() {
50 | try {
51 | // Populate sidebar with topics
52 | const buffer = [];
53 | for (h = 1; h < headings.length; h++) {
54 | const heading = headings[h];
55 |
56 | if (heading.tagName.toLowerCase() == "h1") {
57 | const isNewChapter = heading.innerText.search('•') == 0;
58 | let text = heading.innerText;
59 |
60 | if (isNewChapter) {
61 | text = text.split('•').join("").toLowerCase().replace("mate", "MATE");
62 | buffer.push("");
63 | }
64 |
65 | buffer.push(`${text}`);
66 |
67 | if (isNewChapter === true)
68 | heading.innerText = heading.innerText.split('•').join("").toLowerCase().replace("mate", "MATE");
69 | }
70 | }
71 | sidebarContents.innerHTML = buffer.join("");
72 |
73 | // If returning to the page and a hash in the URL, jump!
74 | if (window.location.href.search("#") != -1) {
75 | const href = window.location.href.split("#")[1];
76 | const btn = document.getElementById(`nav-${href}`);
77 | if (btn)
78 | btn.click();
79 | }
80 |
81 | // Some headings are linked within articles. Make sure those links don't have a class.
82 | const chapterLinks = document.querySelectorAll(".nav-chapter");
83 | for (c = 0; c < chapterLinks.length; c++) {
84 | const link = chapterLinks[c];
85 | if (link.parentElement.tagName.toLowerCase() == "p")
86 | link.classList.remove("nav-chapter");
87 | }
88 |
89 | // On mobile, clicking a topic closes the menu.
90 | sidebarContents.addEventListener("click", function() {
91 | sidebarMobileToggle.checked = false;
92 | });
93 |
94 | // Set up triggers
95 | window.onscroll = refreshSidebar;
96 |
97 | // Ready!
98 | btnPrev.disabled = false;
99 | btnNext.disabled = false;
100 | btnPrevMobile.classList.add("disabled");
101 | btnNextMobile.classList.add("disabled");
102 | refreshSidebar();
103 |
104 | } catch(e) {
105 | console.error(e);
106 | window.alert("There was an error loading the page. The interactive sidebar may not work.\n\nDetails:\n " + e);
107 | }
108 | });
109 |
110 | // Set up mobile menu
111 | sidebarMobileBtn.addEventListener("click", function() {
112 | sidebarMobileToggle.checked = false;
113 | });
114 |
115 | // Buttons for jumping forward/backwards from sections
116 | function prevSection() {
117 | const active = document.querySelector(".active");
118 | let target = active.previousSibling;
119 |
120 | if (!target)
121 | return null;
122 |
123 | if (target.className == "nav-separator")
124 | target = target.previousSibling;
125 |
126 | if (!target)
127 | return null;
128 |
129 | target.click();
130 | }
131 |
132 | function nextSection() {
133 | const active = document.querySelector(".active");
134 | let target = active.nextSibling;
135 |
136 | if (!target)
137 | return null;
138 |
139 | if (target.className == "nav-separator")
140 | target = target.nextSibling;
141 |
142 | if (!target)
143 | return null;
144 |
145 | target.click();
146 | }
147 |
148 | function _updateNextPrevButtons() {
149 | const active = document.querySelector(".active");
150 | btnPrev.disabled = false;
151 | btnNext.disabled = false;
152 | btnPrevMobile.classList.remove("disabled");
153 | btnNextMobile.classList.remove("disabled");
154 |
155 | if (!active.previousSibling.previousSibling) {
156 | btnPrev.disabled = true;
157 | btnPrevMobile.classList.add("disabled");
158 | }
159 |
160 | if (!active.nextSibling) {
161 | btnNext.disabled = true;
162 | btnNextMobile.classList.add("disabled");
163 | }
164 | }
165 |
--------------------------------------------------------------------------------
/online/partials/header-nav.html:
--------------------------------------------------------------------------------
1 |
5 |
6 |
7 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
24 | Website
25 |
26 |
27 |
28 |
31 | Community
32 |
33 |
34 |
35 |
38 | Buy Books
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |
54 |
55 |
83 |
--------------------------------------------------------------------------------
/online/partials/guide.css:
--------------------------------------------------------------------------------
1 | body {
2 | background: var(--background);
3 | color: var(--text-color);
4 | display: flex;
5 | padding: 0;
6 | margin: 0;
7 | margin-left: var(--sidebar-width);
8 | line-height: 22px;
9 | overflow-x: hidden;
10 | }
11 |
12 | * {
13 | font-family: "Ubuntu", "Ubuntu-Embed", "Roboto", "Oxygen", "Cantarell", "Fira Sans", "Droid Sans", -apple-system, BlinkMacSystemFont, "Helvetica Neue", sans-serif;
14 | }
15 |
16 | /************************************
17 | Colours & Variables
18 | ************************************/
19 | :root {
20 | --sidebar-width: 300px;
21 | --page-width: 50em;
22 | --header-full-height: 60px; /* height + padding */
23 |
24 | --background: #f4f4f4;
25 | --text-color: black;
26 |
27 | --grey-border: #d5d5d5;
28 | --grey-color: #9b9b9b;
29 |
30 | --sidebar-bg: white;
31 | --item-border: #d7d7d7;
32 | --item-hover: #f4f4f4;
33 | --item-active: #abc087;
34 |
35 | --accent: #87a556;
36 | --accent-hover: #9fb876;
37 | --text-on-accent: white;
38 | --accent-link: #758a53;
39 |
40 | --quote-bg: #EDEDED;
41 | --quote-border: #eaeae9;
42 | --quote-text: black;
43 |
44 | --title-color: #4b4b49;
45 | --title-border: #c0bfbc;
46 |
47 | --table-border: #c9c6c3;
48 | --table-alt-row: #ececec;
49 | }
50 |
51 | @media (prefers-color-scheme: dark) {
52 | :root {
53 | --background: #222222;
54 | --text-color: white;
55 |
56 | --grey-color: #909090;
57 |
58 | --sidebar-bg: #363636;
59 | --item-border: #242424;
60 | --item-hover: #2e2e2e;
61 | --item-active: #abc087;
62 |
63 | --accent-link: #87a556;
64 |
65 | --quote-bg: #4e4c46;
66 | --quote-border: #403e39;
67 | --quote-text: white;
68 |
69 | --title-color: #9b9b9b;
70 | --table-border: #404040;
71 | --table-alt-row: #2f2f2f;
72 | }
73 |
74 | /* Docbook: Cheap way to invert light OS logo for the dark background */
75 | #page-overview + p > img,
76 | #page-faq + p > img {
77 | filter: invert(1) grayscale(1) brightness(3);
78 | }
79 | }
80 |
81 | /************************************
82 | Layout & Sidebar
83 | ************************************/
84 | #docbook {
85 | max-width: var(--page-width);
86 | margin: auto;
87 | margin-top: var(--header-full-height);
88 | padding: 16px;
89 | }
90 |
91 | #guide-sidebar {
92 | align-self: start;
93 | background: var(--sidebar-bg);
94 | position: fixed;
95 | top: var(--header-full-height);
96 | left: 0;
97 | bottom: 0;
98 | height: calc(100vh - var(--header-full-height));
99 | width: var(--sidebar-width);
100 | }
101 |
102 | #sidebar-contents {
103 | list-style: none;
104 | padding: 0;
105 | margin: 0;
106 | height: calc(100% - 40px);
107 | overflow-y: scroll;
108 | }
109 |
110 | #sidebar-contents .nav-separator:first-child {
111 | display: none;
112 | }
113 |
114 | .nav-item {
115 | cursor: pointer;
116 | display: block;
117 | padding: 5px 10px;
118 | border-bottom: 1px solid var(--item-border);
119 | font-size: 15px;
120 | text-decoration: none;
121 | transition: background-color 0.1s ease-in-out, color 0.1s ease-in-out;
122 | }
123 |
124 | .nav-chapter {
125 | border-color: var(--item-border);
126 | color: var(--text-color);
127 | text-transform: capitalize;
128 | }
129 |
130 | .nav-separator {
131 | height: 15px;
132 | }
133 |
134 | .nav-item:hover,
135 | .nav-item:focus {
136 | background: var(--item-hover);
137 | color: var(--text-color);
138 | text-decoration: none;
139 | }
140 |
141 | .nav-item:active {
142 | background: var(--item-active);
143 | color: var(--text-color);
144 | outline-color: var(--item-active);
145 | transition: none;
146 | }
147 |
148 | .nav-item.active {
149 | background-color: var(--accent);
150 | color: var(--text-on-accent);
151 | }
152 |
153 | .sidebar-info {
154 | padding: 15px;
155 | opacity: 0.5;
156 | }
157 |
158 | #nav-page-faq {
159 | text-transform: uppercase;
160 | }
161 |
162 | #sidebar-buttons {
163 | display: flex;
164 | margin: 6px;
165 | }
166 |
167 | #sidebar-buttons button {
168 | display: flex;
169 | flex: 1;
170 | margin: 1px 4px;
171 | }
172 |
173 | #sidebar-buttons svg {
174 | height: 20px;
175 | width: 20px;
176 | margin: auto;
177 | margin-right: 0;
178 | }
179 |
180 | #sidebar-buttons svg path {
181 | fill: var(--accent);
182 | }
183 |
184 | #sidebar-buttons span {
185 | display: inline-flex;
186 | margin: auto;
187 | margin-left: 4px;
188 | }
189 |
190 | /************************************
191 | Site Header
192 | ************************************/
193 | #site-header {
194 | background: var(--accent);
195 | position: fixed;
196 | top: 0;
197 | left: 0;
198 | right: 0;
199 | height: 48px;
200 | padding: 6px 12px;
201 | z-index: 10;
202 | display: flex;
203 | flex-direction: row;
204 | }
205 |
206 | #back-to-top {
207 | margin-right: auto;
208 | }
209 |
210 | #site-logo {
211 | height: 48px;
212 | width: 48px;
213 | }
214 |
215 | .site-nav {
216 | display: block;
217 | color: var(--text-on-accent);
218 | cursor: pointer;
219 | padding: 14px;
220 | font-size: 14px;
221 | text-decoration: none;
222 | }
223 |
224 | .site-nav:hover,
225 | .site-nav:focus {
226 | background: var(--accent-hover);
227 | color: var(--text-on-accent);
228 | text-decoration: none;
229 | }
230 |
231 | .site-nav:active {
232 | background: var(--item-active);
233 | outline-color: var(--item-active);
234 | }
235 |
236 | .site-nav.disabled {
237 | cursor: not-allowed;
238 | opacity: 0.25;
239 | pointer-events: none;
240 | }
241 |
242 | .site-nav svg {
243 | height: 16px;
244 | width: 16px;
245 | vertical-align: text-top;
246 | }
247 |
248 | .site-nav svg path {
249 | fill: white;
250 | }
251 |
252 | /************************************
253 | Guide Content
254 | ************************************/
255 | /* Docbook shows the OS logo twice, hide the first one */
256 | #docbook > header + p {
257 | display: none;
258 | }
259 |
260 | /* Style the title of the book */
261 | #title-block-header {
262 | padding: 10px;
263 | margin: 0;
264 | text-align: center;
265 | border-bottom: 1px solid var(--grey-border);
266 | }
267 |
268 | #title-block-header .author,
269 | #title-block-header .date {
270 | color: var(--grey-color);
271 | }
272 |
273 | /* Headings */
274 | h1, h2 {
275 | color: var(--title-color);
276 | line-height: 36px;
277 | text-transform: capitalize;
278 |
279 | /* Jump to (hash) */
280 | margin-top: -60px;
281 | padding-top: 80px;
282 | margin-bottom: 20px;
283 | }
284 |
285 | h2 {
286 | border-bottom: 1px solid var(--title-border);
287 | color: var(--title-color);
288 | font-size: 30px;
289 | font-weight: 400;
290 | padding-bottom: 10px;
291 | }
292 |
293 | /* Quotes, notes and code blocks */
294 | blockquote,
295 | .note {
296 | background: var(--quote-bg);
297 | border: 1px solid var(--quote-border);
298 | border-left: 5px solid var(--accent);
299 | margin: 12px auto;
300 | padding: 16px;
301 | clear: both;
302 | }
303 |
304 | .note .title {
305 | font-weight: bold;
306 | }
307 |
308 | pre {
309 | display: block;
310 | background-color: var(--quote-bg);
311 | border: 1px solid var(--quote-border);
312 | color: var(--text-color);
313 | padding: 16px;
314 | margin: 12px 0;
315 | white-space: pre-wrap;
316 | line-break: anywhere;
317 | }
318 |
319 | pre,
320 | pre code {
321 | font-family: "Ubuntu Mono", "Roboto Mono", monospace;
322 | }
323 |
324 | /* File -> Example -> Save As... */
325 | .menuchoice {
326 | color: var(--title-color);
327 | font-style: italic;
328 | }
329 |
330 | /* Images underneath headings are icons */
331 | .app-icon {
332 | float: left;
333 | margin: 12px;
334 | margin-left: 0;
335 | margin-top: 4px;
336 | }
337 |
338 | /* Figure images, usually screenshots */
339 | .figure {
340 | display: block;
341 | max-width: calc(var(--page-width) - 12em - 20px);
342 | margin: 10px auto;
343 | }
344 |
345 | /* Navigation links */
346 | a {
347 | color: var(--accent-link);
348 | }
349 |
350 | /* Tables */
351 | table {
352 | table-layout: fixed;
353 | margin: 0;
354 | margin-bottom: 0px;
355 | margin-bottom: 50px;
356 | }
357 |
358 | th, td {
359 | border-spacing: 0;
360 | border-collapse: collapse;
361 | padding: 8px;
362 | max-width: 400px;
363 | }
364 |
365 | /* Common keyboard shortcuts table onwards */
366 | #shortcuts-common ~ table thead {
367 | /* Hidden, content is lots of dots */
368 | display: none;
369 | }
370 |
371 | #shortcuts-common ~ table tr {
372 | border-bottom: 1px solid var(--table-border);
373 | }
374 |
375 | #shortcuts-common ~ table .even {
376 | background-color: var(--table-alt-row);
377 | }
378 |
379 | /************************************
380 | Docbook Tweaks
381 | ************************************/
382 | /* In the first section, center align the OS logo */
383 | /* Also, any image that's in a paragraph of its own */
384 | #page-overview + p > img,
385 | #page-faq + p > img {
386 | display: block;
387 | margin: 20px auto;
388 | height: 48px;
389 | max-width: unset;
390 | }
391 |
392 | /* "The MATE Desktop" has an icon and few words due to the blockquote */
393 | #page-mate-desktop + p {
394 | margin-bottom: 0;
395 | }
396 |
397 | #page-mate-desktop + p .app-icon {
398 | float: none;
399 | vertical-align: middle;
400 | }
401 |
402 | /************************************
403 | Fonts
404 | ************************************/
405 | /* Embed Ubuntu font if not present on system */
406 | @font-face {
407 | font-family: "Ubuntu-Embed";
408 | src: local('Ubuntu'), url("/assets/fonts/Ubuntu-Regular.ttf");
409 | }
410 |
411 | @font-face {
412 | font-family: "Ubuntu-Embed";
413 | src: local('Ubuntu Bold'), url("/assets/fonts/Ubuntu-Bold.ttf");
414 | font-weight: bold;
415 | font-style: normal;
416 | }
417 |
418 | /************************************
419 | Mobile View
420 | ************************************/
421 | /* Only visible on mobile */
422 | .mobile-only {
423 | display: none;
424 | }
425 |
426 | @media (max-width: 940px) {
427 | body {
428 | margin: 0;
429 | }
430 |
431 | p > img,
432 | p > embed {
433 | max-width: 100%;
434 | }
435 |
436 | #guide-sidebar {
437 | margin: 0;
438 | }
439 |
440 | a {
441 | line-break: anywhere;
442 | }
443 |
444 | .figure {
445 | max-width: 90%;
446 | }
447 |
448 | #sidebar-contents {
449 | height: 100%;
450 | max-width: 500px;
451 | }
452 |
453 | /* Hide header items */
454 | .site-nav {
455 | display: none;
456 | }
457 |
458 | /* Collapse sidebar into toggle button */
459 | #guide-sidebar {
460 | position: fixed;
461 | bottom: 0;
462 | left: 40vw;
463 | width: 60vw;
464 | z-index: 5;
465 | }
466 |
467 | #sidebar-invisible {
468 | background: rgba(255,255,255,0.8);
469 | cursor: pointer;
470 | position: fixed;
471 | left: 0;
472 | width: 40vw;
473 | top: var(--header-full-height);
474 | bottom: 0;
475 | }
476 |
477 | #guide-sidebar {
478 | display: none;
479 | }
480 |
481 | #mobile-nav-btn {
482 | cursor: pointer;
483 | display: flex;
484 | height: 50px;
485 | width: 50px;
486 | }
487 |
488 | #mobile-nav-btn svg {
489 | margin: auto;
490 | }
491 |
492 | #mobile-nav-btn path {
493 | fill: white;
494 | }
495 |
496 | #mobile-nav-toggle:checked ~ #guide-sidebar {
497 | display: block;
498 | }
499 |
500 | #mobile-nav-toggle:checked ~ #site-header #mobile-nav-btn {
501 | background: white;
502 | }
503 |
504 | #mobile-nav-toggle:checked ~ #site-header #mobile-nav-btn path {
505 | fill: black;
506 | }
507 |
508 | #sidebar-buttons {
509 | display: none;
510 | }
511 |
512 | .site-nav svg {
513 | height: 24px;
514 | width: 24px;
515 | vertical-align: top;
516 | }
517 |
518 | .mobile-only {
519 | display: block;
520 | }
521 | }
522 |
523 | @media (max-width: 940px) and (prefers-color-scheme: dark) {
524 | #sidebar-invisible {
525 | background: rgba(0,0,0,0.9);
526 | }
527 |
528 | #mobile-nav-toggle:checked ~ #site-header #mobile-nav-btn {
529 | background: black;
530 | }
531 |
532 | #mobile-nav-toggle:checked ~ #site-header #mobile-nav-btn path,
533 | #sidebar-close path {
534 | fill: white;
535 | }
536 | }
537 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Attribution 4.0 International
2 |
3 | =======================================================================
4 |
5 | Creative Commons Corporation ("Creative Commons") is not a law firm and
6 | does not provide legal services or legal advice. Distribution of
7 | Creative Commons public licenses does not create a lawyer-client or
8 | other relationship. Creative Commons makes its licenses and related
9 | information available on an "as-is" basis. Creative Commons gives no
10 | warranties regarding its licenses, any material licensed under their
11 | terms and conditions, or any related information. Creative Commons
12 | disclaims all liability for damages resulting from their use to the
13 | fullest extent possible.
14 |
15 | Using Creative Commons Public Licenses
16 |
17 | Creative Commons public licenses provide a standard set of terms and
18 | conditions that creators and other rights holders may use to share
19 | original works of authorship and other material subject to copyright
20 | and certain other rights specified in the public license below. The
21 | following considerations are for informational purposes only, are not
22 | exhaustive, and do not form part of our licenses.
23 |
24 | Considerations for licensors: Our public licenses are
25 | intended for use by those authorized to give the public
26 | permission to use material in ways otherwise restricted by
27 | copyright and certain other rights. Our licenses are
28 | irrevocable. Licensors should read and understand the terms
29 | and conditions of the license they choose before applying it.
30 | Licensors should also secure all rights necessary before
31 | applying our licenses so that the public can reuse the
32 | material as expected. Licensors should clearly mark any
33 | material not subject to the license. This includes other CC-
34 | licensed material, or material used under an exception or
35 | limitation to copyright. More considerations for licensors:
36 | wiki.creativecommons.org/Considerations_for_licensors
37 |
38 | Considerations for the public: By using one of our public
39 | licenses, a licensor grants the public permission to use the
40 | licensed material under specified terms and conditions. If
41 | the licensor's permission is not necessary for any reason--for
42 | example, because of any applicable exception or limitation to
43 | copyright--then that use is not regulated by the license. Our
44 | licenses grant only permissions under copyright and certain
45 | other rights that a licensor has authority to grant. Use of
46 | the licensed material may still be restricted for other
47 | reasons, including because others have copyright or other
48 | rights in the material. A licensor may make special requests,
49 | such as asking that all changes be marked or described.
50 | Although not required by our licenses, you are encouraged to
51 | respect those requests where reasonable. More considerations
52 | for the public:
53 | wiki.creativecommons.org/Considerations_for_licensees
54 |
55 | =======================================================================
56 |
57 | Creative Commons Attribution 4.0 International Public License
58 |
59 | By exercising the Licensed Rights (defined below), You accept and agree
60 | to be bound by the terms and conditions of this Creative Commons
61 | Attribution 4.0 International Public License ("Public License"). To the
62 | extent this Public License may be interpreted as a contract, You are
63 | granted the Licensed Rights in consideration of Your acceptance of
64 | these terms and conditions, and the Licensor grants You such rights in
65 | consideration of benefits the Licensor receives from making the
66 | Licensed Material available under these terms and conditions.
67 |
68 |
69 | Section 1 -- Definitions.
70 |
71 | a. Adapted Material means material subject to Copyright and Similar
72 | Rights that is derived from or based upon the Licensed Material
73 | and in which the Licensed Material is translated, altered,
74 | arranged, transformed, or otherwise modified in a manner requiring
75 | permission under the Copyright and Similar Rights held by the
76 | Licensor. For purposes of this Public License, where the Licensed
77 | Material is a musical work, performance, or sound recording,
78 | Adapted Material is always produced where the Licensed Material is
79 | synched in timed relation with a moving image.
80 |
81 | b. Adapter's License means the license You apply to Your Copyright
82 | and Similar Rights in Your contributions to Adapted Material in
83 | accordance with the terms and conditions of this Public License.
84 |
85 | c. Copyright and Similar Rights means copyright and/or similar rights
86 | closely related to copyright including, without limitation,
87 | performance, broadcast, sound recording, and Sui Generis Database
88 | Rights, without regard to how the rights are labeled or
89 | categorized. For purposes of this Public License, the rights
90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar
91 | Rights.
92 |
93 | d. Effective Technological Measures means those measures that, in the
94 | absence of proper authority, may not be circumvented under laws
95 | fulfilling obligations under Article 11 of the WIPO Copyright
96 | Treaty adopted on December 20, 1996, and/or similar international
97 | agreements.
98 |
99 | e. Exceptions and Limitations means fair use, fair dealing, and/or
100 | any other exception or limitation to Copyright and Similar Rights
101 | that applies to Your use of the Licensed Material.
102 |
103 | f. Licensed Material means the artistic or literary work, database,
104 | or other material to which the Licensor applied this Public
105 | License.
106 |
107 | g. Licensed Rights means the rights granted to You subject to the
108 | terms and conditions of this Public License, which are limited to
109 | all Copyright and Similar Rights that apply to Your use of the
110 | Licensed Material and that the Licensor has authority to license.
111 |
112 | h. Licensor means the individual(s) or entity(ies) granting rights
113 | under this Public License.
114 |
115 | i. Share means to provide material to the public by any means or
116 | process that requires permission under the Licensed Rights, such
117 | as reproduction, public display, public performance, distribution,
118 | dissemination, communication, or importation, and to make material
119 | available to the public including in ways that members of the
120 | public may access the material from a place and at a time
121 | individually chosen by them.
122 |
123 | j. Sui Generis Database Rights means rights other than copyright
124 | resulting from Directive 96/9/EC of the European Parliament and of
125 | the Council of 11 March 1996 on the legal protection of databases,
126 | as amended and/or succeeded, as well as other essentially
127 | equivalent rights anywhere in the world.
128 |
129 | k. You means the individual or entity exercising the Licensed Rights
130 | under this Public License. Your has a corresponding meaning.
131 |
132 |
133 | Section 2 -- Scope.
134 |
135 | a. License grant.
136 |
137 | 1. Subject to the terms and conditions of this Public License,
138 | the Licensor hereby grants You a worldwide, royalty-free,
139 | non-sublicensable, non-exclusive, irrevocable license to
140 | exercise the Licensed Rights in the Licensed Material to:
141 |
142 | a. reproduce and Share the Licensed Material, in whole or
143 | in part; and
144 |
145 | b. produce, reproduce, and Share Adapted Material.
146 |
147 | 2. Exceptions and Limitations. For the avoidance of doubt, where
148 | Exceptions and Limitations apply to Your use, this Public
149 | License does not apply, and You do not need to comply with
150 | its terms and conditions.
151 |
152 | 3. Term. The term of this Public License is specified in Section
153 | 6(a).
154 |
155 | 4. Media and formats; technical modifications allowed. The
156 | Licensor authorizes You to exercise the Licensed Rights in
157 | all media and formats whether now known or hereafter created,
158 | and to make technical modifications necessary to do so. The
159 | Licensor waives and/or agrees not to assert any right or
160 | authority to forbid You from making technical modifications
161 | necessary to exercise the Licensed Rights, including
162 | technical modifications necessary to circumvent Effective
163 | Technological Measures. For purposes of this Public License,
164 | simply making modifications authorized by this Section 2(a)
165 | (4) never produces Adapted Material.
166 |
167 | 5. Downstream recipients.
168 |
169 | a. Offer from the Licensor -- Licensed Material. Every
170 | recipient of the Licensed Material automatically
171 | receives an offer from the Licensor to exercise the
172 | Licensed Rights under the terms and conditions of this
173 | Public License.
174 |
175 | b. No downstream restrictions. You may not offer or impose
176 | any additional or different terms or conditions on, or
177 | apply any Effective Technological Measures to, the
178 | Licensed Material if doing so restricts exercise of the
179 | Licensed Rights by any recipient of the Licensed
180 | Material.
181 |
182 | 6. No endorsement. Nothing in this Public License constitutes or
183 | may be construed as permission to assert or imply that You
184 | are, or that Your use of the Licensed Material is, connected
185 | with, or sponsored, endorsed, or granted official status by,
186 | the Licensor or others designated to receive attribution as
187 | provided in Section 3(a)(1)(A)(i).
188 |
189 | b. Other rights.
190 |
191 | 1. Moral rights, such as the right of integrity, are not
192 | licensed under this Public License, nor are publicity,
193 | privacy, and/or other similar personality rights; however, to
194 | the extent possible, the Licensor waives and/or agrees not to
195 | assert any such rights held by the Licensor to the limited
196 | extent necessary to allow You to exercise the Licensed
197 | Rights, but not otherwise.
198 |
199 | 2. Patent and trademark rights are not licensed under this
200 | Public License.
201 |
202 | 3. To the extent possible, the Licensor waives any right to
203 | collect royalties from You for the exercise of the Licensed
204 | Rights, whether directly or through a collecting society
205 | under any voluntary or waivable statutory or compulsory
206 | licensing scheme. In all other cases the Licensor expressly
207 | reserves any right to collect such royalties.
208 |
209 |
210 | Section 3 -- License Conditions.
211 |
212 | Your exercise of the Licensed Rights is expressly made subject to the
213 | following conditions.
214 |
215 | a. Attribution.
216 |
217 | 1. If You Share the Licensed Material (including in modified
218 | form), You must:
219 |
220 | a. retain the following if it is supplied by the Licensor
221 | with the Licensed Material:
222 |
223 | i. identification of the creator(s) of the Licensed
224 | Material and any others designated to receive
225 | attribution, in any reasonable manner requested by
226 | the Licensor (including by pseudonym if
227 | designated);
228 |
229 | ii. a copyright notice;
230 |
231 | iii. a notice that refers to this Public License;
232 |
233 | iv. a notice that refers to the disclaimer of
234 | warranties;
235 |
236 | v. a URI or hyperlink to the Licensed Material to the
237 | extent reasonably practicable;
238 |
239 | b. indicate if You modified the Licensed Material and
240 | retain an indication of any previous modifications; and
241 |
242 | c. indicate the Licensed Material is licensed under this
243 | Public License, and include the text of, or the URI or
244 | hyperlink to, this Public License.
245 |
246 | 2. You may satisfy the conditions in Section 3(a)(1) in any
247 | reasonable manner based on the medium, means, and context in
248 | which You Share the Licensed Material. For example, it may be
249 | reasonable to satisfy the conditions by providing a URI or
250 | hyperlink to a resource that includes the required
251 | information.
252 |
253 | 3. If requested by the Licensor, You must remove any of the
254 | information required by Section 3(a)(1)(A) to the extent
255 | reasonably practicable.
256 |
257 | 4. If You Share Adapted Material You produce, the Adapter's
258 | License You apply must not prevent recipients of the Adapted
259 | Material from complying with this Public License.
260 |
261 |
262 | Section 4 -- Sui Generis Database Rights.
263 |
264 | Where the Licensed Rights include Sui Generis Database Rights that
265 | apply to Your use of the Licensed Material:
266 |
267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right
268 | to extract, reuse, reproduce, and Share all or a substantial
269 | portion of the contents of the database;
270 |
271 | b. if You include all or a substantial portion of the database
272 | contents in a database in which You have Sui Generis Database
273 | Rights, then the database in which You have Sui Generis Database
274 | Rights (but not its individual contents) is Adapted Material; and
275 |
276 | c. You must comply with the conditions in Section 3(a) if You Share
277 | all or a substantial portion of the contents of the database.
278 |
279 | For the avoidance of doubt, this Section 4 supplements and does not
280 | replace Your obligations under this Public License where the Licensed
281 | Rights include other Copyright and Similar Rights.
282 |
283 |
284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability.
285 |
286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
296 |
297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
306 |
307 | c. The disclaimer of warranties and limitation of liability provided
308 | above shall be interpreted in a manner that, to the extent
309 | possible, most closely approximates an absolute disclaimer and
310 | waiver of all liability.
311 |
312 |
313 | Section 6 -- Term and Termination.
314 |
315 | a. This Public License applies for the term of the Copyright and
316 | Similar Rights licensed here. However, if You fail to comply with
317 | this Public License, then Your rights under this Public License
318 | terminate automatically.
319 |
320 | b. Where Your right to use the Licensed Material has terminated under
321 | Section 6(a), it reinstates:
322 |
323 | 1. automatically as of the date the violation is cured, provided
324 | it is cured within 30 days of Your discovery of the
325 | violation; or
326 |
327 | 2. upon express reinstatement by the Licensor.
328 |
329 | For the avoidance of doubt, this Section 6(b) does not affect any
330 | right the Licensor may have to seek remedies for Your violations
331 | of this Public License.
332 |
333 | c. For the avoidance of doubt, the Licensor may also offer the
334 | Licensed Material under separate terms or conditions or stop
335 | distributing the Licensed Material at any time; however, doing so
336 | will not terminate this Public License.
337 |
338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
339 | License.
340 |
341 |
342 | Section 7 -- Other Terms and Conditions.
343 |
344 | a. The Licensor shall not be bound by any additional or different
345 | terms or conditions communicated by You unless expressly agreed.
346 |
347 | b. Any arrangements, understandings, or agreements regarding the
348 | Licensed Material not stated herein are separate from and
349 | independent of the terms and conditions of this Public License.
350 |
351 |
352 | Section 8 -- Interpretation.
353 |
354 | a. For the avoidance of doubt, this Public License does not, and
355 | shall not be interpreted to, reduce, limit, restrict, or impose
356 | conditions on any use of the Licensed Material that could lawfully
357 | be made without permission under this Public License.
358 |
359 | b. To the extent possible, if any provision of this Public License is
360 | deemed unenforceable, it shall be automatically reformed to the
361 | minimum extent necessary to make it enforceable. If the provision
362 | cannot be reformed, it shall be severed from this Public License
363 | without affecting the enforceability of the remaining terms and
364 | conditions.
365 |
366 | c. No term or condition of this Public License will be waived and no
367 | failure to comply consented to unless expressly agreed to by the
368 | Licensor.
369 |
370 | d. Nothing in this Public License constitutes or may be interpreted
371 | as a limitation upon, or waiver of, any privileges and immunities
372 | that apply to the Licensor or You, including from the legal
373 | processes of any jurisdiction or authority.
374 |
375 |
376 | =======================================================================
377 |
378 | Creative Commons is not a party to its public
379 | licenses. Notwithstanding, Creative Commons may elect to apply one of
380 | its public licenses to material it publishes and in those instances
381 | will be considered the “Licensor.” The text of the Creative Commons
382 | public licenses is dedicated to the public domain under the CC0 Public
383 | Domain Dedication. Except for the limited purpose of indicating that
384 | material is shared under a Creative Commons public license or as
385 | otherwise permitted by the Creative Commons policies published at
386 | creativecommons.org/policies, Creative Commons does not authorize the
387 | use of the trademark "Creative Commons" or any other trademark or logo
388 | of Creative Commons without its prior written consent including,
389 | without limitation, in connection with any unauthorized modifications
390 | to any of its public licenses or any other arrangements,
391 | understandings, or agreements concerning use of licensed material. For
392 | the avoidance of doubt, this paragraph does not form part of the
393 | public licenses.
394 |
395 | Creative Commons may be contacted at creativecommons.org.
396 |
397 |
--------------------------------------------------------------------------------
18 |
19 |
20 |
21 |
24 | Website
25 |
26 |
27 |
28 |
31 | Community
32 |
33 |
34 |
35 |
38 | Buy Books
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |