-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
mkdocs.yml
412 lines (400 loc) · 20.2 KB
/
mkdocs.yml
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
site_name: GLAM Workbench
site_description: 'A collection of tools and examples to help you work with data from galleries, libraries, archives, and museums'
site_author: 'Tim Sherratt'
site_url: 'https://glam-workbench.net/'
# Repository
#repo_name: 'squidfunk/mkdocs-material'
repo_name: glam-workbench.github.io
repo_url: 'https://github.com/GLAM-Workbench/glam-workbench.github.io'
edit_uri: "edit/master/docs/"
# Copyright
copyright: 'Copyright © 2022 <a href="/contributors/">GLAM Workbench contributors</a>.<br/>Documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br/>Original code is licensed under an <a href="https://opensource.org/licenses/MIT">MIT Licence</a>.'
# Configuration
theme:
name: 'material'
custom_dir: 'overrides'
language: 'en'
features:
- content.code.annotate
# - content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.indexes
# - navigation.instant
# - navigation.sections
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- announce.dismiss
# - toc.integrate
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: 'Roboto'
code: 'Roboto Mono'
icon:
logo: material/hammer-wrench
admonition:
abstract: material/handshake
# Customization
extra:
manifest: 'manifest.webmanifest'
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/glam-workbench'
name: 'GLAM Workbench on GitHub'
- name: '@wragge on Twitter'
icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/wragge'
- icon: 'fontawesome/brands/facebook'
link: 'https://www.facebook.com/101dhhacks/'
name: '101 DH Hacks on Facebook'
- icon: 'fontawesome/solid/rss'
link: 'https://updates.timsherratt.org/categories/glamworkbench/'
name: 'Latest GLAMWorkbench news!'
extra_css:
- 'stylesheets/extra.css'
# extra_javascript:
# - 'https://hypothes.is/embed.js'
# Extensions
markdown_extensions:
- admonition
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.snippets:
base_path: ['includes', '../site/includes']
check_paths: True
- attr_list
- md_in_html
- toc_ext:
permalink: true
patch_mkdocs: false
- meta
- def_list
- tables
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
- macros:
on_undefined: keep
- redirects:
redirect_maps:
'trove_newspapers.md': 'trove-newspapers/index.md'
'name-search.md': 'https://glam-name-indexes-yajhxrvxsa-ts.a.run.app/'
'tasmanian-post-office-directories.md': 'libraries-tasmania/tasmanian-post-office-directories.md'
supporters.md: get-involved/supporters.md
nav:
- Home: index.md
- About:
- about.md
- Presentations: presentations.md
- awards.md
- Citations: citations.md
- Get involved!:
- get-involved/index.md
- get-involved/supporters.md
- Add a link: get-involved/add-links.md
- Improve the documentation: get-involved/editing-documentation.md
- Contribute code: get-involved/contribute-code.md
- Develop a new repository: get-involved/developing-repositories.md
- contributors.md
- Help:
- getting-started.md
- Running notebooks:
- using-binder.md
- using-reclaim-cloud.md
- using-nectar.md
- using-docker.md
- using-python.md
- Help videos: https://www.youtube.com/playlist?list=PLAclcciEeCD2z2BWQ2r3xD_Q8c05HppfP
- Suggest a topic: https://github.com/GLAM-Workbench/glam-workbench.github.io/issues
- Ask a question: https://ozglam.chat/c/glam-workbench/8
- Book a chat: https://calendly.com/timsherratt/30minchat
- GLAM data:
- Australia:
- glam-data-list.md
- Open data portals:
- glam-data-portals.md
- glam-datasets-from-gov-portals.md
- csv-explorer.md
- GLAM Name Index Search: name-search.md
- Trove:
- Trove API Introduction:
- trove/index.md
- Notebooks:
- trove/your-first-api-request.md
- trove/working-with-zones.md
- trove/exploring-facets.md
- Trove newspapers:
- trove-newspapers/index.md
- Notebooks:
- Visualise articles by state & year: trove-newspapers/visualise-total-newspaper-articles-by-state-year.md
- trove-newspapers/Analysing_OCR_corrections.md
- trove-newspapers/find-non-english-newspapers.md
- trove-newspapers/Beyond_the_copyright_cliff_of_death.md
- When newspapers were added to Trove: trove-newspapers/historical-data-newspaper-titles.md
- trove-newspapers/querypic.md
- trove-newspapers/QueryPic_deconstructed.md
- trove-newspapers/visualise-searches-over-time.md
- trove-newspapers/Map-newspaper-results-by-state.md
- Map results by place of publication: trove-newspapers/Map-newspaper-results-by-place-of-publication.md
- Map results by place over time: trove-newspapers/Map-newspaper-results-by-place-of-publication-over-time.md
- trove-newspapers/harvest_newspaper_issues.md
- Harvest issues as PDFs: trove-newspapers/harvest_newspaper_issues_as_pdfs.md
- Harvest AWW covers: trove-newspapers/harvest-aww-covers-and-newspaper-front-pages.md
- Save article as an image: trove-newspapers/Save-Trove-newspaper-article-as-image.md
- Save article as an image web app: trove-newspapers/Save-Trove-newspaper-article-as-image-app.md
- trove-newspapers/Save-page-image.md
- trove-newspapers/Get-article-thumbnail.md
- Upload articles to Omeka: trove-newspapers/Upload-Trove-newspapers-to-Omeka.md
- trove-newspapers/Todays-news-yesterday.md
- Corrections ticker: trove-newspapers/Create-a-Trove-corrections-ticker.md
- Get newspaper titles excluding gazettes: trove-newspapers/Get_newspaper_titles_not_including_gazettes.md
- Get article coordinates: trove-newspapers/trove-newspapers-get-coordinates-of-articles.md
- Make composite image from thumbnails: trove-newspapers/Composite-thumbnails.md
- Create scissors & paste messages: trove-newspapers/trove-newspapers-scissors-and-paste.md
- Create composite image from snipped words: trove-newspapers/trove-newspapers-create-composite-from-words.md
- Data:
- Number of issues per year for each newspaper: trove-newspapers/csv-issues-per-year.md
- Complete list of issues: trove-newspapers/csv-complete-list-issues.md
- trove-newspapers/csv-newspaper-titles-from-web-archives.md
- trove-newspapers/csv-newspaper-titles-from-web-archives-first-appearance.md
- trove-newspapers/csv-aww-issues.md
- trove-newspapers/dataset-aww-covers.md
- Newspapers with non-English content: trove-newspapers/list-non-english-newspapers.md
- Newspapers with post-1954 articles: trove-newspapers/csv-newspapers-post-54.md
- Trove newspaper & gazette harvester:
- trove-harvester/index.md
- Notebooks:
- trove-harvester/harvester-web-app.md
- Using the Trove Harvester: trove-harvester/using-troveharvester.md
- trove-harvester/harvest-specific-days.md
- Displaying results in Datasette: trove-harvester/display-harvest-results-in-datasette.md
- Exploring harvested data: trove-harvester/exploring-troveharvester-data.md
- Exploring harvested texts: trove-harvester/exploring-troveharvester-text.md
- Trove books:
- trove-books/index.md
- Notebooks:
- Harvesting text from digitised books: trove-books/harvesting-text-of-digitised-books.md
- Metadata for digital works: trove-books/metadata-for-digital-works.md
- Harvesting text from Internet Archive: trove-books/harvesting-text-from-books-in-ia.md
- trove-books/counting-words-and-phrases.md
- trove-books/recipe-generator.md
- Exploring Trove's digitised books: trove-books/exploring-digitised-books-adel-rahmani.md
- Data:
- OCRd text from Trove books: trove-books/ocrd-text-from-trove-books.md
- CSV of digital books in Trove: trove-books/csv-books-in-digital-form.md
- Government publications in digital form: trove-books/government-publications-in-digital-form.md
- OCRd text from Australian books in IA: trove-books/ocrd-text-from-ia.md
- CSV of Australian books in IA: trove-books/csv-australian-books-in-ia.md
- Trove contributors:
- trove-contributors/index.md
- Notebooks:
- Create a list of contributors: trove-contributors/get_contributors.md
- Get totals by contributor, zone & format: trove-contributors/get_contributors_totals_zone_format.md
- Data:
- Flat list of contributors: trove-contributors/trove-contributors-list.md
- Total records by contributor & zone: trove-contributors/trove-contributors-zones.md
- Total records by contributor, zone & format: trove-contributors/trove-contributors-formats.md
- Trove journals:
- trove-journals/index.md
- Notebooks:
- Create a list of digitised journals: trove-journals/create-list-digitised-journals.md
- Get OCRd text from a journal: trove-journals/get-ocrd-text-from-digitised-journal.md
- Get OCRd text from all journals: trove-journals/get-ocrd-text-from-all-journals.md
- Get cover images from a journal: trove-journals/get-covers-from-digitised-journal.md
- Finding cartoons in the Bulletin: trove-journals/finding-editorial-cartoons-in-bulletin.md
- Harvest Parliament press releases: trove-journals/harvest-parliament-press-releases.md
- Create database of text indexed by line: trove-journals/create-text-db-indexed-by-line.md
- Topic modelling Parliament press releases: trove-journals/topic-modelling-parliament-press-releases.md
- Data:
- CSV list of digital journals: trove-journals/csv-digital-journals.md
- CSV list of journals with OCR: trove-journals/csv-journals-with-ocr.md
- List of journals with OCR: trove-journals/journals-with-ocr.md
- OCRd text from all journals: trove-journals/ocrd-text-all-journals.md
- trove-journals/bulletin-cartoons-collection.md
- Politicians talking about 'refugees': trove-journals/politicans-press-releases-refugees.md
- Politicians talking about COVID: trove-journals/politicans-press-releases-covid.md
- Links:
- NSW Post Office Directories: trove-journals/nsw-post-office-directories.md
- Sydney Telephone Directories: trove-journals/sydney-telephone-directories.md
- Trove lists & tags:
- trove-lists/index.md
- Notebooks:
- Convert list to CSV: trove-lists/convert-a-trove-list-into-a-csv-file.md
- Convert list to CollectionBuilder: trove-lists/convert-list-to-cb-exhibition.md
- Harvest lists data: trove-lists/harvest-summary-data-from-lists.md
- Harvest tags data: trove-lists/harvest-tags.md
- Analyse tags data: trove-lists/analyse_tags.md
- Data:
- trove-lists/trove-lists-metadata.md
- trove-lists/trove-public-tags.md
- trove-lists/trove-tag-counts.md
- Trove maps:
- trove-maps/index.md
- Notebooks:
- trove-maps/exploring-digitised-maps.md
- trove-maps/parse-coordinates.md
- Data:
- trove-maps/single-maps-data.md
- trove-maps/single-maps-coordinates-data.md
- Trove music & sound:
- trove-music/index.md
- Notebooks:
- Harvest ABC RN records: trove-music/harvest-abcrn.md
- Explore ABC RN metadata: trove-music/explore-abcrn-data.md
- Data:
- ABC RN metadata: trove-music/abcrn-data.md
- Trove people & organisations:
- trove-people/index.md
- Notebooks:
- Harvest complete dataset: trove-people/complete_harvest.md
- Harvest complete dataset using OAI-PMH: trove-people/complete_harvest_oai.md
- Extract data from harvest: trove-people/extract_aggregated_data_from_harvest.md
- Get SRU results as JSON: trove-people/get_sru_results_as_json.md
- Visualise data sources: trove-people/intersections.md
- Get VIAF links: trove-people/viaf.md
- Data:
- Complete dataset: trove-people/complete_harvest_dataset.md
- Aggregated data from complete dataset: trove-people/aggregated_datasets.md
- Trove images:
- trove-images/index.md
- Notebooks:
- Rights statements applied to images: trove-images/use-of-rights-statements.md
- Data:
- CSV of rights applied to images: trove-images/csv-image-rights-by-institution.md
- CSV of rights applied to out-of-copyright photos: trove-images/csv-out-of-copyright-photos-rights-by-institution.md
- Trove unpublished:
- trove-unpublished/index.md
- Notebooks:
- Find works entering public domain: trove-unpublished/Finding-unpublished-works-entering-public-domain.md
- Explore works entering public domain: trove-unpublished/Exploring-unpublished-works-entering-public-domain.md
- Find digitised finding aids: trove-unpublished/find-finding-aids.md
- Collect information about finding aids: trove-unpublished/get-info-finding-aids.md
- Convert finding aid to JSON: trove-unpublished/convert-fa-to-json.md
- Data:
- Works entering public domain: trove-unpublished/unpublished-entering-pd.md
- Finding aid urls: trove-unpublished/finding-aids-urls.md
- Finding aid summaries: trove-unpublished/finding-aids-summary.md
- Random items from Trove:
- trove-random/index.md
- Notebooks:
- Random newspaper article: trove-random/random_newspaper_article.md
- Random work by id: trove-random/random_work_by_id.md
- Random work using facets: trove-random/random_work_by_facets.md
- Trove API v3:
- trove-api-v3/index.md
- digitalnz.md
- Archives:
- anu-archives.md
- NAA:
- recordsearch.md
- naa-wap.md
- naa-asio.md
- NSW State Archives:
- nsw-state-archives/index.md
- Notebooks:
- Get details of indexes: nsw-state-archives/index.md
- nsw-state-archives/get-list-of-indexes.md
- nsw-state-archives/harvest-indexes.md
- nsw-state-archives/summarise-index-details.md
- Index Explorer: nsw-state-archives/index-explorer.md
- Data:
- nsw-state-archives/index-list.md
- nsw-state-archives/index-repository.md
- National Archives of NZ:
- archway.md
- qsa.md
- Heritage:
- Heritage Council of Victoria:
- heritage-council-of-victoria/index.md
- Notebooks:
- heritage-council-of-victoria/introduction-victorian-heritage-api.md
- heritage-council-of-victoria/shipwrecks.md
- Libraries:
- Libraries Tasmania:
- libraries-tasmania/index.md
- Notebooks:
- Download Post Office Directory PDFs: libraries-tasmania/tas-pod-save-text-images.md
- Upload images to s3 for delivery via IIIF: libraries-tasmania/tas-pod-upload-images.md
- Extract text from PDF images with Tesseract: libraries-tasmania/tas-pod-ocr-with-tesseract.md
- Load Post Office Directory contents into a database: libraries-tasmania/tas-pod-add-to-datasette.md
- Links:
- Tasmanian Post Office Directories: libraries-tasmania/tasmanian-post-office-directories.md
- State Library of NSW:
- Tribune negatives:
- records-of-resistance.md
- facial-detection.md
- image-tagging.md
- slsa.md
- slv.md
- lac.md
- Web archives:
- web-archives/index.md
- Notebooks:
- web-archives/timegates-timemaps-mementos.md
- web-archives/exploring-ia-cdx-api.md
- web-archives/comparing-cdx-apis.md
- web-archives/timemaps-vs-cdx.md
- Get a Memento: web-archives/get-memento.md
- Find all versions of a web page: web-archives/get-all-versions.md
- Harvest text from web pages: web-archives/harvesting-text.md
- Harvest data about a domain: web-archives/harvesting-domain-data.md
- Explore Powerpoints from a domain: web-archives/exploring-powerpoints.md
- Explore all subdomains from gov.au: web-archives/exploring-govau-subdomains.md
- Compare versions of a page: web-archives/compare-page-versions.md
- Observe change in a page over time: web-archives/observing-change-over-time.md
- Create full-page screenshots: web-archives/create-screenshots.md
- Create a series of screenshots: web-archives/create-screenshots-over-time.md
- Display changes in page text: web-archives/display-changes-in-text.md
- Find when text appears: web-archives/find-when-text-appears.md
- Data:
- Harvest of subdomains under gov.au: web-archives/harvest-of-govau-subdomains.md
- Unique gov.au subdomains split into parts: web-archives/govau-subdomains-split.md
- List of unique gov.au subdomains: web-archives/govau-subdomains-surt.md
- Visualisations of gov.au subdomains: web-archives/govau-subdomains-visualisations.md
- Museums:
- nma.md
- tepapa.md
- museumsvictoria.md
- Government:
- Australia:
- hansard.md
- pm-transcripts.md
- Wikidata:
- wikidata/index.md
- Notebooks:
- Timeline of govt departments: wikidata/agencies-gannt-timeline.md
- Network graph of govt departments: wikidata/govt-agencies-network.md
- View connections of a single agency: wikidata/single-agency-network.md
- Useful tools:
- Useful tools: glam-tools/index.md
- Notebooks:
- CloudStor nested links: glam-tools/cloudstor-share-nested-links.md
- CloudStor using WebDAV: glam-tools/cloudstor-access-via-webdav.md
- More resources:
- more-glam-notebooks.md
- glam-tools-interfaces.md
- Browse by tag: tags.md
- Latest news!: https://updates.timsherratt.org/categories/glamworkbench/