Skip to content

dmgerman/canadaCommonCV

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Avoid the pain of the Common CV

License

This software is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Introduction

If you are here, you are looking for a relief from the Common CCV user interface. How much do you think that interface has cost? Don’t even think of knowing the answer. It might sink you into depression.

These scripts will allow you to avoid the CCV user interface and instead, concentrate on just uploading XML files.

Restrictions

  • These scripts are specifically designed to target Computer Science.
  • It only handles conferences and journals
  • They run under Linux, but might work under OS X
  • They only handle cases I have seen (for example, it does not include all the countries in the world (why does the CCV care to verify them?)

Requirements

  • Linux or MacOS (untested)
  • pdftolatex (converts ccv in pdf to text, only needed if you want to create a bibtex bibliography that matches your ccv)
  • ruby
  • perl
  • latex
  • make

How to use

In the directory generate, create two files:

  • confs.txt
  • journals.txt

See the directory sample for examples of these files.

Each file is a list of publications, in text file. The referenceID must be unique (somebody willing to write a patch to not-require it?)

This is an example of a Journal:

recordId=5f84ac4e98bc482dba87b56f001ea640
Title=Management of community contributions
Journal=Empirical Software Engineering
Volume=20
Issue=1
PageRange=252-289
PublishingStatus=Published
Date=2015/2
Publisher=Springer
URL=http://link.springer.com/article/10.1007%2Fs10664-013-9284-6
Refereed=Yes
OpenAccess=No
Authors=Nicolas Bettenburg, Ahmed E. Hassan, Bram Adams, Daniel M. German
dmgKey=dmg2015nickESE

And this is an example of a conference:

recordId=5f84ac4e98bc48200087b56f001ea640
Type=Paper
Title=Open Source-Style Collaborative Development Practices in Commercial Projects Using GitHub
Conference=37th International Conference on Software Engineering (ICSE'15)
Country=Italy
City=Florence
Date=2015/5
DateConf=2015-05-16
PublishedIn=Proc. 37th International Conference on Software Engineering, ICSE '15
PublishingStatus=Published
Refereed=Yes
Authors=<b>E. Kalliamvakou*</b>, D. Damian, K. Blincoe, L. Singer, Daniel M. German
Publisher=Springer
Note=Acceptance rate 18% (84 out of 276 research papers).
DOI=http://dx.doi.org/10.1109/ICSE.2015.74
dmgKey=dmg2015icseGithub

One line per field, and separate records with an empty line. Some HTML is allowed in the CCV, but not everywhere.

Creating the XML and bibtex files

  • Once you have created your confs.txt and journals.txt, run make in that directory. Make sure there are no errors.
  • It should create four files:
    • journals.xml and confs.xml
    • journals.bib and confs.bib

Uploading the XML files

  • Login to the CCV
  • I strongly recommend you backup your current CCV by first downloading it in XML. See Warranty above.
  • Go to the import tab.
  • Specify that you want to import XML.
  • You will be asked for a file to upload.
  • Upload
  • At this point it will verify your XML. If it is all good, you will get no errors. If you get errors, well, they are very hard to debug (thank the ccv). I recommend you split your bibliography in smaller chunks and test each.
  • Now that it has verified it will ask you to indicate what section of the CCV you want to import it into.
    • Select journals or conferences appropriately
  • Verify the data was read by browsing the current ccv.

Create a bibliography for latex that can reference your CCV

In the directory latexCrossRef you will find a way to create an Latex input file that you can use to reference your CCV using standard bibtex citations.

For example, these are some of my publications in the ccv:

./j.png

./c.png

And this is how I refer to them in the proposal:

...
difficulties of tracing contributions in email and version control systems \cite{dmg2015contMining,dmg2014esemMailCommits}.
We have empirically observed how distributions perform integration~\cite{dmg2014eseDebianInt}, and how software
ecosystems manage their contributions and releases~\cite{dmg2015emseCommuContrib,dmg2013csmrR}
We identified code reviews as a crucial tool for quality control in FOSS projects, investigated the
manner in which they are performed via email, and found them to be as
effective as those in commercial software~\cite{dmg2014tosemReviews,dmg2012ieeeReviews}. We have also explored the
challenges of adopting and upgrading FOSS libraries~\cite{dmg2015icsmeEralib,dmg2014vissoftLib}.
...

and this is how it appears:

./la.png

How it works

  • The input file is your CCV (name it ccv-nserc.pdf) and the bibtex files created from your conference and journal sources (see above)
  • The important file to generate is contributionsInclude.tex
  • Simply follow the Makefile.
  • It requires the .bib files to be generated before (see symlinks for these)
  • Two files are created.
    • confsListBib.pdf
    • journalsListBib.pdf

Steps

  • make sure bib files you generate from your conf and journal files are up-to-date
  • download a recent version of the CCV (pdf) that matches those files
  • run make
  • if no errors, verify the files: confsListBib.pdf and journalsListBib.pdf
    • Verify the order of the entries.
    • Every row in the first section contains two numbers:
    • The left hand side is the order in the CCV, the right hand number should match (it used a bibtex entry).
    • If they don’t, something is wrong.
  • result: two files
    • confsListBib.bbl
    • journalsListBib.bbl

How to use

In your proposal use, instead of a bibliography, include contributionsInclude.tex. Use the field dmgKey in the txt entries of your papers to refer to them in your proposal. See below: If you don’t like the format, modify the files in includes. contributionsInclude.tex is created by concatenating the files in includes.

...

Recently, we empirically studied how GitHub is helping commercial software
development~\cite{dmg2015icseGithub}. 

...
\input{contributionsInclude}

About

scripts to generate XML to ease the pain of doing common CV

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published