commit 9ed52a9130468b3e96c137cc458fa90403f4857c
parent b0409f429449a747103318ff212a7ce77848b23a
Author: Antoine Amarilli <a3nm@a3nm.net>
Date: Thu, 31 Dec 2020 20:12:41 +0100
+readme
Diffstat:
| .gitignore | | | 16 | ++++++++++++++++ |
| LICENSE | | | 19 | +++++++++++++++++++ |
| README | | | 92 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
3 files changed, 127 insertions(+), 0 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,19 @@ publist_fr.log
publist_fr.pdf
publist_en.log
publist_en.pdf
+texput.log
+main.bib
+publis_all.html.en
+publis_all.html.fr
+publis_en.txt
+publis_fr.txt
+publis_main.html.en
+publis_main.html.fr
+reviews.tex
+reviews_en.html
+reviews_fr.html
+selectpubli_en.tex
+talks_all.html.en
+talks_all.html.fr
+talks_last.html.en
+talks_last.html.fr
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,19 @@
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/README b/README
@@ -0,0 +1,92 @@
+# Publist -- managing my list of publications, talks, reviews
+
+This is what I use as an academic to maintain my list of publications, talks,
+reviews.
+
+This is (C) Antoine Amarilli and BSD-licensed, see LICENSE
+
+Warning: This is extremely dirty code written for my personal use and only
+shared in case it's useful to someone, please do not judge me too harshly for
+it.
+
+Warning: This documentation was written to give a minimal idea of what the
+system does, but will probably not be kept up-to-date.
+
+Warning: The idea of maintaining publication lists, etc., is a conservative idea
+that means you are playing by the rules of the academic system. While I need to
+do it professionally, I don't mean to imply that this is a good idea. It is
+probably a better idea to write a high-level understandable summary of your
+research. For more about what I think of the academic system, see:
+https://a3nm.net/work/research/wrong/
+
+## Input files
+
+The system generates French and English output.
+
+The following files are the input to the system. As a general principle, they
+consist of a list of records (each of which is a paragraph), and every record
+consist of key-value pairs separated by ':'. For many keys, a localized version
+exists to give the same info in French, e.g., "Location" contains the English
+name of a location, and "LocationFr" contains the French name.
+
+- authors: list of authors, with an id, name, website URL (using academic
+ websites if they exist, otherwise some choice of a DBLP page or a Wayback
+ machine copy of a former academic website)
+
+- venues: list of conferences and journals, with an id (the name is inferred
+ automatically from the id), optional name, type (conference, journal,
+ workshop, school), publisher, open-access or not, location, URL, audience
+ (national or international)
+
+- reviews: list of places I reviewed, with the role (pc, spc for senior pc,
+ pc_demos for being a PC member for demos, misc for having done misc reviews)
+
+- talks: ordered list of talks I gave (latest first), with a title, date, venue
+ (can be a conference ID or seminar name), optional link to a poster, optional
+ location, optional place, URLs of the venue, place, misc to add some
+ annotation, and a dirty system with the "$TEAM" placeholder to indicate a team
+ and URL for a team, etc.
+
+- publis: ordered list of my publications (latest first), with an id (bibtex
+ key), oldid (used for a space-separated list of former ids of the paper, to
+ avoid breaking anchors), a title, a space-separated list of authors, an
+ optional venue, an indication of if the paper was reviewed or not, is a "main"
+ paper or not (controls whether it goes, e.g., in the résumé), should be hidden
+ from the résumé or not (key "hidecv"), a type (demo, shortpaper, etc.),
+ possible links to slides, posters, videos, code, possible information about
+ the authors of this extra material, option to indicate the existence of errata
+ (will generate special links to the errata)
+
+My own files are versioned together with the code, of course if you adapt it you
+will want to run the code on your own files.
+
+## Invocation
+
+Run: ./make.sh
+
+This will run the various python scripts, and run a LaTeX compilation for the
+PDF publication lists
+
+## Generated files
+
+- main.bib: bibtex file containing all publications, featuring keywords used for
+ filtering in the publication lists, and featuring hyperlinks to papers,
+ authors, venues
+
+- publis_fr.txt and publis_en.txt: plain text publication listing
+
+- publist_en.pdf and publist_fr.pdf: CNRS-style publication lists, with papers
+ ordered by types, then by date, with global numbering
+
+- publis_all.html.en and publis_all.html.fr: HTML+Markdown snippets with
+ publications listed chronologically and grouped by year
+
+- publis_main.html.en and publis_main.html.fr: the same but only for the main
+ publications and without the year headings
+
+- reviews.tex: a LaTeX snippet for a CV indicating the reviews (only listing
+ open-access venues)
+
+- reviews_en.html and reviews_fr.html: an HTML snippet for the same purpose
+
+- selectpubli_en.tex: a LaTeX snippet for a CV indicating the main publications
