Takes a TSV of publications with metadata and converts them for use with academicpages.github.io. This is an interactive Jupyter notebook (see more info here). The core python code is also in publications.py. Run either from the markdown_generator folder after replacing publications.tsv with one containing your data.
TODO: Make this work with BibTex and other databases of citations, rather than Stuart's non-standard TSV format and citation style.
The TSV needs to have the following columns: pub_date, title, venue, excerpt, citation, site_url, and paper_url, with a header at the top.
excerpt and paper_url can be blank, but the others must have values. pub_date must be formatted as YYYY-MM-DD.url_slug will be the descriptive part of the .md file and the permalink URL for the page about the paper. The .md file will be YYYY-MM-DD-[url_slug].md and the permalink will be https://[yourdomain]/publications/YYYY-MM-DD-[url_slug]This is how the raw file looks (it doesn't look pretty, use a spreadsheet or other program to edit and create).
In [22]:
!cat publications.tsv
In [3]:
import pandas as pd
Pandas makes this easy with the read_csv function. We are using a TSV, so we specify the separator as a tab, or \t.
I found it important to put this data in a tab-separated values format, because there are a lot of commas in this kind of data and comma-separated values can get messed up. However, you can modify the import statement, as pandas also has read_excel(), read_json(), and others.
In [32]:
publications = pd.read_csv("publications.tsv", sep="\t", header=0)
publications
Out[32]:
In [34]:
publications.columns
Out[34]:
In [14]:
html_escape_table = {
"&": "&",
'"': """,
"'": "'"
}
def html_escape(text):
"""Produce entities within text."""
return "".join(html_escape_table.get(c,c) for c in text)
In [35]:
import os
for row, item in publications.iterrows():
paper_name = item.paper_url.rsplit('/', 1)[1].split('.')[0]
md_filename = str(item.pub_year) + "-" + paper_name + ".md"
html_filename = str(item.pub_year) + "-" + paper_name
## YAML variables
md = "---\ntitle: \"" + item.title + '"\n'
md += """collection: publications"""
md += """\npermalink: /publication/""" + html_filename
md += "\nyear: " + str(item.pub_year)
md += "\nconference: '" + html_escape(item.conference) + "'"
md += "\nauthors: " + "[" + ", ".join(["'" + a + "'" for a in item.authors.split(', ')]) + "]"
md += "\nlocation: '" + html_escape(item.location) + "'"
md += "\naccepted: '" + str(item.accepted) + "'"
md += "\nsubmitted: '" + str(item.submitted) + "'"
if len(str(item.paper_url)) > 5:
md += "\npaper_url: '" + item.paper_url + "'"
if item.video_url != '-':
md += "\nvideo_url: '" + item.video_url + "'"
md += "\n---"
## Markdown description for individual page
#if len(str(item.paper_url)) > 5:
# md += "\n[Download paper here](" + item.paper_url + ")\n"
md_filename = os.path.basename(md_filename)
with open("../_publications/" + md_filename, 'w') as f:
f.write(md)
These files are in the publications directory, one directory below where we're working from.
In [36]:
!ls ../_publications/
In [39]:
!cat ../_publications/2019-seacma.md
In [ ]: