mkdocs.yml

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/"
docs_dir: /home/tim/mywork/glam-workbench/glam-workbench-docs/site/docs
# Copyright
copyright: 'Copyright &copy; 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
    - content.tabs.link
    - content.code.copy
    - 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@hcommons.social on Mastodon'
      icon: 'fontawesome/brands/mastodon'
      link: 'https://hcommons.social/@wragge'
    - icon: 'fontawesome/brands/facebook'
      link: 'https://www.facebook.com/glamworkbench/'
      name: 'GLAM Workbench on Facebook'
    - icon: 'fontawesome/solid/rss'
      link: 'https://updates.timsherratt.org/categories/glamworkbench/'
      name: 'Latest GLAMWorkbench news!'
    - icon: 'fontawesome/brands/linkedin'
      link: 'https://www.linkedin.com/company/glam-workbench/'
      name: 'GLAM Workbench on Linked In'

extra_css:
  - 'stylesheets/extra.css'

# extra_javascript:
#  - "https://code.jquery.com/jquery-3.7.1.min.js"
#  - "scripts/script.js"
#  - '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
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc_ext:
      permalink: true
      patch_mkdocs: false
  - meta
  - def_list
  - tables
  - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
    - macros:
        on_undefined: keep
        include_dir: /home/tim/mywork/glam-workbench/glam-workbench-docs/site/includes
    - 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'
            'slv.md': 'state-library-victoria/index.md'
            'trove-journals/harvest-parliament-press-releases.md': 'trove-government/harvest-parliament-press-releases.md'
            'trove-journals/csv-journals-with-ocr.md': 'trove-journals/periodicals-data-api.md'
            'trove-journals/journals-with-ocr.md': 'trove-journals/periodicals-data-api.md'
            'trove-journals/politicans-press-releases-covid.md': 'trove-government/trove-parliament-press-releases-covid.md'
            'trove-journals/politicans-press-releases-refugees.md': 'trove-government/trove-parliament-press-releases-refugees.md'
            'trove-newspaper-harvester.md': 'trove-harvester/index.md'
            'trove-newspapers/csv-issues-per-year.md': 'trove-newspapers/data-newspaper-issues.md'
            'trove-newspapers/csv-complete-list-issues.md': 'trove-newspapers/data-newspaper-issues.md'
            'trove-newspapers/csv-aww-issues.md': 'trove-newspapers/dataset-aww-covers.md'
            'trove-newspapers/csv-newspaper-titles-from-web-archives-first-appearance.md': 'trove-newspapers/csv-newspaper-titles-from-web-archives.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-ardc-binder.md
            - using-reclaim-cloud.md
            - using-nectar.md
            - using-containers.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
            - Government data portals:
                - glam-data-portals/index.md
                - Data:
                    - Datasets in government portals: glam-data-portals/gov-portals-data.md
                    - List of GLAM datasets: 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 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:
                - Newspaper issues datas: trove-newspapers/data-newspaper-issues.md
                - trove-newspapers/csv-newspaper-titles-from-web-archives.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-newspapers/csv-newspapers-corrections.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 government:
            - trove-government/index.md
            - Notebooks:
                - Harvest Parliamentary Papers: trove-government/harvest-parliamentary-papers.md
                - Harvest press releases: trove-government/harvest-parliament-press-releases.md
            - Data:
                - trove-government/trove-parliamentary-papers-data.md
                - trove-government/trove-parliament-press-releases-refugees.md
                - trove-government/trove-parliament-press-releases-covid.md
        - Trove periodicals:
            - trove-journals/index.md
            - Notebooks:
                - Get details of periodicals & issues using the API: trove-journals/periodicals-from-api.md
                - Improve API data describing periodicals: trove-journals/periodicals-enrich-for-datasette.md
                - Create a list of digitised periodicals using search: trove-journals/create-list-digitised-journals.md
                - Get OCRd text from a periodical: trove-journals/get-ocrd-text-from-digitised-journal.md
                - Get OCRd text from all periodicals: trove-journals/get-ocrd-text-from-all-journals.md
                - Create database of text indexed by line: trove-journals/create-text-db-indexed-by-line.md
                - Get cover images from a periodical: trove-journals/get-covers-from-digitised-journal.md
                - Finding cartoons in the Bulletin: trove-journals/finding-editorial-cartoons-in-bulletin.md
                - Harvest illustrations: trove-journals/harvest-illustrations-from-periodicals.md
                - Download issues as PDFs: trove-journals/save-issues-as-pdfs.md
            - Data:
                - Details of periodicals from the API: trove-journals/periodicals-data-api.md
                - List of digitised periodicals from search: trove-journals/csv-digital-journals.md
                - Details of NED periodicals: trove-journals/trove-ned-periodicals-data.md
                - OCRd text from all journals: trove-journals/ocrd-text-all-journals.md
                - trove-journals/bulletin-cartoons-collection.md
            - Links:
                - NSW Post Office Directories: trove-journals/nsw-post-office-directories.md
                - Sydney Telephone Directories: trove-journals/sydney-telephone-directories.md
        - Trove NED:
            - trove-ned/index.md
            - Notebooks:
                - Harvest details of all NED periodicals: trove-ned/harvest-ned-periodicals.md
                - Create a searchable database from a NED periodical: trove-ned/create-searchable-database.md
            - Datasets:
                - Details of NED periodicals: trove-ned/trove-ned-periodicals-data.md
                - Searchable database of content from The Triangle: trove-ned/the-triangle.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
                - Create a subset of digitised maps: trove-maps/create-map-subsets.md
            - Data:
                - trove-maps/single-maps-data.md
                - trove-maps/single-maps-coordinates-data.md
            - Links:
                - trove-maps/explore-maps.md
        - Trove music, sound, & oral histories: 
            - trove-music/index.md
            - Notebooks:
                - Harvest oral histories: trove-music/harvest-oral-histories.md
                - Save oral history collections: trove-music/save-series.md
                - Download oral history transcripts: trove-music/download-transcripts.md
                - Harvest ABC RN records: trove-music/harvest-abcrn.md
                - Explore ABC RN metadata: trove-music/explore-abcrn-data.md
            - Data:
                - Oral histories metadata: trove-music/trove-oral-histories.md
                - Oral history collections: trove-music/trove-oral-history-series.md
                - 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
                - Download a collection of digitised images: trove-images/download-image-collection.md
                - Save a collection of digitised images as an IIIF manifest: trove-images/save-image-collection-iiif.md
            - Data:
                - Rights applied to images by Trove contributors: trove-images/trove-images-rights-data.md
        - Trove web archive collections (Pandora):
            - trove-web-archives/index.md
            - Notebooks: 
                - trove-web-archives/harvest-pandora-subject-collections.md
                - trove-web-archives/harvest-pandora-titles.md
                - trove-web-archives/create-datasets.md
            - Data:
                - trove-web-archives/pandora-collections-data.md
                - trove-web-archives/pandora-titles-data.md
                - trove-web-archives/pandora-subject-hierarchy.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
        - Public Record Office Victoria:
            - prov/index.md
            - Notebooks:
                - prov/getting-started.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
        - State Library of Victoria:
            - state-library-victoria/index.md
            - Notebooks:
                - Download and image using Handle and IIIF: state-library-victoria/download_image_from_iiif.md
                - state-library-victoria/more_fun_with_iiif.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/