From 5ac3a827ed2dde5b785d3886b6a812e08039ae25 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Mon, 12 May 2025 16:29:50 -0700 Subject: [PATCH 1/7] fix minor formatting updates --- content/agenda-templates.md | 32 ++++++++++++++++---------------- content/create-event-website.md | 4 ++-- content/organizing-events-faq.md | 2 +- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/content/agenda-templates.md b/content/agenda-templates.md index 998aa93..c94fb33 100644 --- a/content/agenda-templates.md +++ b/content/agenda-templates.md @@ -11,13 +11,13 @@ This page provides example agenda templates for different types of NWB workshops ## NWB \+ DANDI Overview Workshop Template -**Learning objective:** Attendees will learn about the NWB and DANDI software ecosystem, from data conversion and data publication to data reuse. +- **Learning objective:** Attendees will learn about the NWB and DANDI software ecosystem, from data conversion and data publication to data reuse. -**Estimated duration:** 1 day. The talks can be covered in a half day, and the remaining time can be used for conversion projects, discussion, or 1:1 support. +- **Estimated duration:** 1 day. The talks can be covered in a half day, and the remaining time can be used for conversion projects, discussion, or 1:1 support. -**Prerequisites / requirements:** None, this workshop is intended for people new to the NWB ecosystem. +- **Prerequisites / requirements:** None, this workshop is intended for people new to the NWB ecosystem. -**Previous examples:** [NWB and DANDI Workshop at University of Washington](http://nwb.org/events/workshop-2025-uwashington/), [NWB and DANDI Workshop at CoSyNe 2025](http://nwb.org/events/cosyne-2025/), [NWB and DANDI Workshop at UNAM](http://nwb.org/events/workshop-2025-unam/) +- **Previous examples:** [NWB and DANDI Workshop at University of Washington](http://nwb.org/events/workshop-2025-uwashington/), [NWB and DANDI Workshop at CoSyNe 2025](http://nwb.org/events/cosyne-2025/), [NWB and DANDI Workshop at UNAM](http://nwb.org/events/workshop-2025-unam/) ### Example Agenda @@ -30,13 +30,13 @@ This page provides example agenda templates for different types of NWB workshops ## Community Hackathon Template -**Learning objective:** Attendees will conduct development projects to contribute to the NWB software ecosystem. +- **Learning objective:** Attendees will conduct development projects to contribute to the NWB software ecosystem. -**Estimated duration:** 3 days. Most of the time is spent on hacking. Depending on the group, it can be helpful to host breakout discussions for specific topics of interest. The hackathon concludes with final project presentations. +- **Estimated duration:** 3 days. Most of the time is spent on hacking. Depending on the group, it can be helpful to host breakout discussions for specific topics of interest. The hackathon concludes with final project presentations. -**Prerequisites / requirements:** This is not a training event, so some level of familiarity with NWB is helpful though not required. +- **Prerequisites / requirements:** This is not a training event, so some level of familiarity with NWB is helpful though not required. -**Previous examples:** [NWB Developer Hackathon 2024](http://nwb.org/events/hck18-2024-dev-hackathon-datajoint/), [Developer Days 2023](http://nwb.org/events/hck15-2023-janelia/), [Developer Days 2022](http://nwb.org/events/hck12-2022-remote/) +- **Previous examples:** [NWB Developer Hackathon 2024](http://nwb.org/events/hck18-2024-dev-hackathon-datajoint/), [Developer Days 2023](http://nwb.org/events/hck15-2023-janelia/), [Developer Days 2022](http://nwb.org/events/hck12-2022-remote/) ### Example Agenda @@ -81,13 +81,13 @@ The first day provides an overview of the hackathon and highlights planned break ## Data Reuse Workshop Template -**Learning objective:** Attendees will learn how to work with data on DANDI and will conduct a data reuse project to re-analyze existing data on NWB. +- **Learning objective:** Attendees will learn how to work with data on DANDI and will conduct a data reuse project to re-analyze existing data on NWB. -**Estimated duration:** 5 days. The first day covers the core material about working with data on DANDI. The second day can focus on additional guest lectures to introduce attendees to different tools and datasets on DANDI. The remaining time can be spent on project hacking / analysis, with the workshop concluding in project presentations. +- **Estimated duration:** 5 days. The first day covers the core material about working with data on DANDI. The second day can focus on additional guest lectures to introduce attendees to different tools and datasets on DANDI. The remaining time can be spent on project hacking / analysis, with the workshop concluding in project presentations. -**Prerequisites / requirements:** In previous workshops, we have required participants to propose a project with specific dandisets as part of their application. These projects can change throughout the course of the workshop. +- **Prerequisites / requirements:** In previous workshops, we have required participants to propose a project with specific dandisets as part of their application. These projects can change throughout the course of the workshop. -**Previous examples:** [NeuroDataReHack 2024](http://nwb.org/events/hck21-2024-janelia-ndrh/), [NeuroDataReHack 2023](http://nwb.org/events/hck16-2023-granada-rh/), [NeuroDataReHack 2022](http://nwb.org/events/hck14-2022-seattle-rh/) +- **Previous examples:** [NeuroDataReHack 2024](http://nwb.org/events/hck21-2024-janelia-ndrh/), [NeuroDataReHack 2023](http://nwb.org/events/hck16-2023-granada-rh/), [NeuroDataReHack 2022](http://nwb.org/events/hck14-2022-seattle-rh/) ### Example Agenda @@ -139,13 +139,13 @@ discussion and feedback on the workshop and next steps. ## Data Conversion Workshop Template -**Learning objective:** Attendees will learn how to convert their data to NWB and publish it on the DANDI Archive. +- **Learning objective:** Attendees will learn how to convert their data to NWB and publish it on the DANDI Archive. -**Estimated duration:** 2-3 days. The core material on data conversion can be covered on the first day. Depending on the interests of the audience, additional lectures can be given on domain specific topics or advanced data I/O. +- **Estimated duration:** 2-3 days. The core material on data conversion can be covered on the first day. Depending on the interests of the audience, additional lectures can be given on domain specific topics or advanced data I/O. -**Prerequisites / requirements:** Data for conversion. +- **Prerequisites / requirements:** Data for conversion. -**Previous examples:** [NWB Data Conversion Workshop 2025](http://www.nwb.org/events/hck22-2025-dataconversion-remote/), [NWB Data Conversion Workshop 2024](http://www.nwb.org/events/hck19-2024-remote/), [NWB User Days 2023](http://www.nwb.org/events/hck15-2023-janelia/) +- **Previous examples:** [NWB Data Conversion Workshop 2025](http://www.nwb.org/events/hck22-2025-dataconversion-remote/), [NWB Data Conversion Workshop 2024](http://www.nwb.org/events/hck19-2024-remote/), [NWB User Days 2023](http://www.nwb.org/events/hck15-2023-janelia/) ### Example Agenda diff --git a/content/create-event-website.md b/content/create-event-website.md index 4593302..bd677e0 100644 --- a/content/create-event-website.md +++ b/content/create-event-website.md @@ -12,12 +12,12 @@ Follow these steps to create a website for your NWB event: 1. Go to the NeurodataWithoutBorders website GitHub repo 2. Fork and clone the repo -![NWB Website GitHub Repository](/images/nwb_website_github_repo.png) +NWB Website GitHub Repository 3. Create a new branch 4. Create a new event markdown file in the `content/events` folder. See previous events for examples for different workshops. For self-organized workshops, please add "Self-organized" to the event type section (e.g. "Self-organized Showcase"). -![Previous Events Examples](/images/previous_events.png) +Previous Events Examples 5. Fill in the file with information about your event. 6. Submit a pull request to the GitHub repo to merge the branch with your changes into the main events list diff --git a/content/organizing-events-faq.md b/content/organizing-events-faq.md index dbcf3e0..e3440b1 100644 --- a/content/organizing-events-faq.md +++ b/content/organizing-events-faq.md @@ -23,4 +23,4 @@ Virtual workshops offer the advantage of being more broadly accessible to indivi # Does my workshop need to follow the timeline in the agenda template? -We encourage you to structure your workshop in whatever manner best suits your institution or audience's needs. We have run workshops ranging from a couple of hours (for an introduction to NW workshop) to up to 5 days long (for data reuse workshops and hackathons). The agenda templates provide a rough guideline to how our events have been structured historically, but feel free to experiment with timelines depending on the needs of your group. +We encourage you to structure your workshop in whatever manner best suits your institution or audience's needs. We have run workshops ranging from a couple of hours (for an introduction to NWB workshop) to up to 5 days long (for data reuse workshops and hackathons). The agenda templates provide a rough guideline to how our events have been structured historically, but feel free to experiment with timelines depending on the needs of your group. From f324b7b88ae5f87dcf7c9b79ed6717196947a734 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Mon, 12 May 2025 22:43:57 -0700 Subject: [PATCH 2/7] add sidebar with navigation --- .../training-and-event-resources/single.html | 62 +++++++++++++++++++ static/css/toc.css | 61 +++++++++++++++++- static/js/sidebar.js | 30 +++++++++ 3 files changed, 152 insertions(+), 1 deletion(-) create mode 100644 layouts/training-and-event-resources/single.html create mode 100644 static/js/sidebar.js diff --git a/layouts/training-and-event-resources/single.html b/layouts/training-and-event-resources/single.html new file mode 100644 index 0000000..4066985 --- /dev/null +++ b/layouts/training-and-event-resources/single.html @@ -0,0 +1,62 @@ +{{ define "main" }} + + +{{/* Hero Section */}} +
+
+

{{ .Title | markdownify }}

+
+
+{{/* End Hero Section */}} + +{{/* Main Section with Side Navigation */}} +
+
+ + + +
+ + + + +
+
+ {{ .Content | markdownify }} +
+
+
+
+
+{{/* End Main Section */}} +{{ end }} diff --git a/static/css/toc.css b/static/css/toc.css index d14f95a..a8aac75 100644 --- a/static/css/toc.css +++ b/static/css/toc.css @@ -6,6 +6,55 @@ padding: 1.5rem !important; margin-bottom: 2rem !important; } + +/* Event Resources Navigation styling */ +.event-resources-nav { + position: -webkit-sticky !important; /* Safari */ + position: sticky !important; + top: 100px !important; /* Adjust based on header height */ + max-height: calc(100vh - 120px) !important; /* Ensure it fits in viewport */ + overflow-y: auto !important; /* Allow scrolling if nav is taller than viewport */ + z-index: 100 !important; /* Ensure it appears above other content */ +} + +/* Mobile sidebar styling */ +.sidebar-toggle { + box-shadow: 0 2px 5px rgba(0,0,0,0.2) !important; + border-radius: 4px !important; + padding: 8px 12px !important; + background-color: #114B7C !important; + border-color: #114B7C !important; +} + +.sidebar-toggle:hover { + background-color: #d17128 !important; + border-color: #d17128 !important; +} + +/* Mobile sidebar container */ +@media (max-width: 991.98px) { + .sidebar-container { + display: none !important; + position: fixed !important; + top: 0 !important; + left: 0 !important; + height: 100vh !important; + width: 280px !important; + z-index: 1050 !important; + background: white !important; + box-shadow: 0 0 15px rgba(0,0,0,0.2) !important; + overflow-y: auto !important; + padding: 20px !important; + transition: transform 0.3s ease !important; + } + + /* Visible state when toggled */ + .sidebar-container.show-sidebar { + display: block !important; + transform: translateX(0) !important; + } + +} .toc-container h2 { margin-top: 0 !important; margin-bottom: 1rem !important; @@ -28,9 +77,19 @@ .toc-list a { text-decoration: none !important; color: #007bff !important; + display: block !important; + padding: 0.5rem 0.75rem !important; + border-radius: 4px !important; + transition: background-color 0.2s ease !important; } .toc-list a:hover { - text-decoration: underline !important; + text-decoration: none !important; + background-color: #e9ecef !important; +} +.toc-list a.active { + background-color: #007bff !important; + color: white !important; + font-weight: 500 !important; } /* Styling for FAQ main page */ diff --git a/static/js/sidebar.js b/static/js/sidebar.js new file mode 100644 index 0000000..13efe62 --- /dev/null +++ b/static/js/sidebar.js @@ -0,0 +1,30 @@ +document.addEventListener('DOMContentLoaded', function() { + // Get the toggle button and sidebar + const toggleButton = document.querySelector('.sidebar-toggle'); + const sidebar = document.getElementById('eventResourcesSidebar'); + + // Function to toggle the sidebar + function toggleSidebar() { + if (sidebar) { + sidebar.classList.toggle('show-sidebar'); + } + } + + // Add click event to toggle button + if (toggleButton) { + toggleButton.addEventListener('click', toggleSidebar); + } + + // Close sidebar when clicking outside of it + document.addEventListener('click', function(event) { + // Check if sidebar is open and click is outside sidebar and not on toggle button + if ( + sidebar && + sidebar.classList.contains('show-sidebar') && + !sidebar.contains(event.target) && + event.target !== toggleButton + ) { + sidebar.classList.remove('show-sidebar'); + } + }); +}); From 8a64ce55c95987f7f6271c5a62a12943491fa692 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Mon, 12 May 2025 22:44:53 -0700 Subject: [PATCH 3/7] update page titles and formatting --- content/agenda-templates.md | 4 +++- content/create-event-website.md | 2 +- content/email-templates.md | 4 +++- content/organizing-events-faq.md | 10 +++++----- content/organizing-nwb-events.md | 4 +++- content/training-materials.md | 2 +- 6 files changed, 16 insertions(+), 10 deletions(-) diff --git a/content/agenda-templates.md b/content/agenda-templates.md index c94fb33..926cd19 100644 --- a/content/agenda-templates.md +++ b/content/agenda-templates.md @@ -4,9 +4,11 @@ bg_image: "/images/events/default-event-banner.png" image: "/images/events/default-event-banner.png" summary: "Example agenda templates for organizing Neurodata Without Borders (NWB) events." draft: false -type: "page" +type: "training-and-event-resources" --- +# Agenda Templates + This page provides example agenda templates for different types of NWB workshops. These templates can be customized to fit your specific event needs. ## NWB \+ DANDI Overview Workshop Template diff --git a/content/create-event-website.md b/content/create-event-website.md index bd677e0..7706fe4 100644 --- a/content/create-event-website.md +++ b/content/create-event-website.md @@ -2,7 +2,7 @@ title: "Creating an Event Website" summary: "Instructions for creating a website for your NWB event." draft: false -type: "page" +type: "training-and-event-resources" --- # Creating an Event Website diff --git a/content/email-templates.md b/content/email-templates.md index 8488dd6..5e24c43 100644 --- a/content/email-templates.md +++ b/content/email-templates.md @@ -4,7 +4,7 @@ bg_image: "/images/events/default-event-banner.png" image: "/images/events/default-event-banner.png" summary: "Email templates for organizing Neurodata Without Borders (NWB) events." draft: false -type: "page" +type: "training-and-event-resources" --- +# Email Templates + This page provides email templates that can be used when organizing NWB events. These templates can be customized to fit your specific event needs. Click the "Copy" button to copy the entire template to your clipboard. {{/* Hero Section */}}
@@ -12,11 +10,6 @@

{{ .Title | markdownify {{/* Main Section with Side Navigation */}}
- -
diff --git a/static/css/toc.css b/static/css/toc.css index a8aac75..c4e2c8d 100644 --- a/static/css/toc.css +++ b/static/css/toc.css @@ -17,44 +17,7 @@ z-index: 100 !important; /* Ensure it appears above other content */ } -/* Mobile sidebar styling */ -.sidebar-toggle { - box-shadow: 0 2px 5px rgba(0,0,0,0.2) !important; - border-radius: 4px !important; - padding: 8px 12px !important; - background-color: #114B7C !important; - border-color: #114B7C !important; -} -.sidebar-toggle:hover { - background-color: #d17128 !important; - border-color: #d17128 !important; -} - -/* Mobile sidebar container */ -@media (max-width: 991.98px) { - .sidebar-container { - display: none !important; - position: fixed !important; - top: 0 !important; - left: 0 !important; - height: 100vh !important; - width: 280px !important; - z-index: 1050 !important; - background: white !important; - box-shadow: 0 0 15px rgba(0,0,0,0.2) !important; - overflow-y: auto !important; - padding: 20px !important; - transition: transform 0.3s ease !important; - } - - /* Visible state when toggled */ - .sidebar-container.show-sidebar { - display: block !important; - transform: translateX(0) !important; - } - -} .toc-container h2 { margin-top: 0 !important; margin-bottom: 1rem !important; diff --git a/static/js/sidebar.js b/static/js/sidebar.js deleted file mode 100644 index 13efe62..0000000 --- a/static/js/sidebar.js +++ /dev/null @@ -1,30 +0,0 @@ -document.addEventListener('DOMContentLoaded', function() { - // Get the toggle button and sidebar - const toggleButton = document.querySelector('.sidebar-toggle'); - const sidebar = document.getElementById('eventResourcesSidebar'); - - // Function to toggle the sidebar - function toggleSidebar() { - if (sidebar) { - sidebar.classList.toggle('show-sidebar'); - } - } - - // Add click event to toggle button - if (toggleButton) { - toggleButton.addEventListener('click', toggleSidebar); - } - - // Close sidebar when clicking outside of it - document.addEventListener('click', function(event) { - // Check if sidebar is open and click is outside sidebar and not on toggle button - if ( - sidebar && - sidebar.classList.contains('show-sidebar') && - !sidebar.contains(event.target) && - event.target !== toggleButton - ) { - sidebar.classList.remove('show-sidebar'); - } - }); -});