acl-org/acl-anthology

Embed videos on paper page

Open

#1,003 opened on Sep 12, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (386 forks)github user discovery
good first projecthelp wantedvideos

Repository metrics

Stars
 (733 stars)
PR merge metrics
 (PR metrics pending)

Description

It would be nice to embed videos on the paper pages. This shouldn't be hard to implement. It would require:

  1. Modifying the paper page template, hugo/layouts/papers/single.html, to embed the video
  2. Maybe writing a custom field in the generated YAML that is used by Hugo to build the Anthology. This would be done by creating a field, say video_embed_link, in the from_xml() function in bin/anthology/papers.py. (This file is used to load papers from the XML file, and all of its attrib attributes are dumped to the YAML).

We link to videos on Vimeo and Slideslives, which likely have different embedding code blocks, which is the reason for point 2 above.

Contributor guide

Research direction
Inspect the paper page template at hugo/layouts/papers/single.html and add a conditional block to embed a video using a field like video embed link. Then update the bin/anthology/papers.py to parse a new attribute from the XML and include it in the YAML output as video embed link. Test by building the site locally.
Tech stack
pythonhtmlcss
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HugoPythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75