Git Product home page Git Product logo

ddmal.github.io's Introduction

This is the repository for the new DDMAL website distributed via GitHub Pages. It is a static website that has been modified to run without a CMS. The entirety of the site is stored in this repository, blog contents included. The formatting was adapted from the Lanyon theme, developed by Mark Otto.

To view the old version using Forestry CMS, consult the 'old-forestry-website' branch.

Contents

Local Setup

macOS / Windows Install

Assuming you have Git installed, open a terminal and clone the repository into any known location on your computer. The documents folder is recommended, though it is up to you.

Configuration and building site locally

git clone https://github.com/DDMAL/ddmal.github.io.git

Enter the directory with cd ddmal.github.io, and pull from the repository to your local folder. Specifically, pull from the 'deforested' branch, the branch used by GitHub Pages to host the site.

git pull origin deforested

At this point, the site is able to be edited and run locally. Use the VSCode "Live Server" extension to view the static website in your browser and track changes automatically.

Creating your lab member page

Create a new folder following the firstname_lastname convention under the appropriate subfolder (undergraduate, masters, etc.) in lab_members. Copy the template file from TEMPLATES/lab_member_template into your newly created folder (do not rename the file). Follow the TODO comments and fill in the desired information.

When adding an image for a lab member page, place it in the assets/lab_members directory. Reference the exact filename in the profile photo's src attribute in your index.html file.

You will also need to add a link to your new page in lab_members/index.html. Copy and paste a <li> item from the appropriate subsection in the appropriate alphabetical position. Make sure to update your name in the content and the path to your page. Add a thumnbail to the assets/lab_members/thumbnail folder and link it in the image src, or use the placeholder image. It should resemble this format (undergraduate used as an example here):

  <li><a href="../lab_members/undergraduate/first_last/">First Last</a><a href="../lab_members/undergraduate/first_last/"><img class="member_photo_list" src="../assets/lab_members/thumbnail/placeholder.png" /></a></li>

Updating citations

There are two parts of this site updated from Zotero group libraries. (OMR Bibliography and DDMAL) https://www.zotero.org/groups/424851/omr_bibliography https://www.zotero.org/groups/2415821/ddmal

Inside the DDMAL folder, there are four subfolders for Media, Posters, Presentations and Publications respectively.

To create an export, right click on any desired subfolder and select the option Create Bibliography from Collection.... At this point, make sure you have installed the Chicago Manual of Style 17th edition inside the Manage Styles... popup. Then, set Output Mode to Bibliography and Output Method to Save as HTML. Select ok, and name the file one of

DDMAL_< [media, posters, presentations, publications, omr] >.html

depending on which folder you are exporting. Then, save it inside the zotero_export/ folder within this directory.

NOTE: make sure your generated HTML file contains all of the content you want displayed for the given page, old and new. Once the script is run, the existing page content will be replaced with the contents of your generated file, so include previous content you want to keep as well as any new modifications.

Next, run the html_parser.py script at the top level of this directory (works on Python 3.7, have not checked others). You will be prompted to input text based on which type of citations you would like to update, one of the three or all. The changes will be reflected in the content.json files in each of the specified folders, which are dynamically displayed in the static pages. Open any modified pages locally to ensure they display correctly before pushing to this repository.

There is another GitHub Actions script called github_html_parser.py that was used in an attempt to automatically update the citation markdown files when zotero_export/ files are updated and pushed to the repo. It is currently deprecated.

Troubleshooting

If you are having any difficulties with setup or local development, please use the issues tab found in this repository.

ddmal.github.io's People

Contributors

ahankinson avatar annamorphism avatar deepio avatar dependabot[bot] avatar emilyhopkins avatar emzedi avatar evansavage avatar finn42 avatar fujinaga avatar homework36 avatar jackyyzhang03 avatar jacobdgm avatar jiwoojeongjj avatar jregimbal avatar juyaolongpaul avatar kqct avatar lucasmarchd01 avatar malajvan avatar maregold avatar martha-thomae avatar mdo avatar napulen avatar p42ul avatar sabrina0822 avatar sevagh avatar softcat477 avatar timothydereuse avatar vigliensoni avatar yinanazhou avatar zhannaklimanova avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

ddmal.github.io's Issues

Update Zotero group library scripts

The scripts that update this site from Zotero group libraries have to be updated to work with the new static (deforested) version. This will require looking into documentation on how Zotero works since the previous CMS version also seemed to have issues.

Update list of publications.

Once the Zotero DDMAL account is updated by everyone. We talked about having a preliminary version by the beginning of January.

Update README

Update the README to account for the recent changes (removal of Forestry, including Ruby/Jekyll dependencies). This should include a static template for new lab members to copy and add their information.

"deforested" branch is missing?

As title says; "deforested" branch is missing (see local setup instructions in readme). Should/can edits be made directly on the master branch? Very possible I'm staring something obvious in the face; help/insight appreciated.

Generalize script for parsing markdown from Zotero HTML exports

Currently the SIMSSA and DDMAL sites parse HTML from Zotero to turn it into Markdown

There are three scripts, all based on the one Evan Savage wrote for the SIMSSA site

They work on the SIMSSA folders, the DDMAL folders, and the OMR Bibliography

Ideally it would all be one script, but I didn't get around to finishing it! Wanted to leave a note since the current situation, while functional, is a little confusing.

Update posters broken links

Observing the output of the broken link checker, the broken links are from missing posters. They need to be retrieved from the cloud website and updated for ddmal.github.io.

Make ddmal website independant of forestry

  • Use Jekyll to deploy website so an updated _site folder is generated
  • Remove all Jekyll .md files and replace with .html versions
  • Add broken link checker to Github actions
  • Fix all broken links between pages
  • Ensure that broken link checker is passing with most important links between pages
  • Manually double check that the main links are leading to expected locations
  • Prettify the .html files so they can be edited easily in the future
  • Remove any unnecessary/deprecated scripts/folders/files from deforested website
  • Push all changes to deforested branch
  • Change the Github settings to deploy from deforested branch for testing purposes
  • Update README instructions
  • Issue pull request for merge into master
  • Resolve any outstanding issues or requested changes from PR

Out of date links? (User Manual -vs- E2E)

In Rodan, navigating from "Help" > http://ddmal.github.io/rodan-client/ > lands you here.

Installation - Might be worth checking this is up to date.
Configuration - Up to date?
User Manual - empty (add E2E/updated Rodan documentation here?)
Development manual - links to download, and "API"

Directs to a page, at top is link back to "Rodan-client";
Do we want this to link to the Rodan-client github page (or the general github page?).

Contact - links to SIMSSA people page; update to point to DDMAL.music.mcgill.ca/lab_members/ ?

General note: it seems as though 'e2e-omr-documentation' was meant to replace 'User Manual' in github.io link. Some links point through here from random places and it doesn't forward to our github page or the DDMAL page.

OMR Bibliography update

The OMR Bibliography can now be generated from the Zotero group library

The old version is still in the repo if you need to reference it for some reason ("_research/OMR/resources/deprecated_OMR_Bibliography.md")

While updating I did notice some weird errors in terms of missing characters, missing capitalizations, etc. that were all in the original bibliography on the site. While I corrected a lot of them, it would benefit from another round of proof-reading, as well as some updates to the actual bibliography itself.

New citations can be added to the Zotero group library (https://www.zotero.org/groups/424851/omr_bibliography), then export as HTML, run the parser, and update the site!

Some lab member images getting squished

flex-shrink happens but not for everyone
e.g. Emily, Martha get squished
(NB: this error existed before the recent update to lab members done on 5 Nov so was not introduced with that change)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.