RePEc step-by-step tutorial
The software component template
Software component templates are in simple text files, like all templates, that have a .rdf extension. The rest of the file name doesn't
matter. These files needs to be in the series' six letter directory. You can put all templates in one files, or one per file, or group them in files in various ways. Do whatever best suits your needs.
Let us have a look at a typical template:
Template-Type: ReDIF-Software 1.0
Title: MKSTRSN: Stata modules to format Social Security number variables
Author-Name: William Gould
Author-WorkPlace-Name: Stata Corporation
Abstract: mkstrsn and mkdashsn make string variables (without and with
dashes, respectively) from a nine-digit variable containing a Social
Security number. The commands have the syntax mkstrsn newvar oldvar
and mkdashsn newvar oldvar.
Series: Statistical Software Components
Length: 39 lines
File-Function: program code
File-Function: program code
Mandatory are: Template-Type:, Author-Name:, Title: and Handle:. More details:
There are additional fields you may consider using, if relevant:
- Author-*: cluster
- This cluster is repeatable, just make sure each cluster starts with Author-Name:, which is the only required field of this cluster. Put each author in a different cluster. Author-Name should contain only the name, either as Firstname Lastname or Lastname, Firstname. The Author-X-Name-*: fields are used by Econlit for the select working paper series also carried by this service.
- While not mandatory, it is highly beneficial to have an abstract. It makes it more likely for the software component to be found in a search. Note that it is possible to cut-and-paste from pdf files, so you do not need to type everything yourself...
- Creation-date:, Revision-date:
- It is strongly recommended to have at least a Creation-Date: field. This allows RePEc services to display items chronologically. Undated items are typically put at the bottom of the lists, or may be ignored entirely. The format of the date is: yyyy or yyyy-mm or yyyy-mm-dd or yyyymm or yyyymmdd
- File-*: cluster
- If the software component is not available online, ignore the cluster entirely. If you need to withdraw a software component from the database, do not delete the template, delete the File-*: cluster. Note that this cluster is repeatable.
- Use the Journal of Economic Literature codes from this list. It is highly recommended to use them for increased exposure of the software component. Avoid the top levels of the classification, try to be specific.
- This uniquely identifies your software component. The software component handle corresponds to the series handle, plus whatever identifier you wish to use, typically the number. Make sure it is unique...
- In the File-*: cluster, use this if the file cannot be freely downloaded, and this was not specified in the series template.
- Put anything you deem relevant that did not fit elsewhere here.
- Article-Handle:, Chapter-Handle:, Book-Handle:, Paper-Handle:
- If the software component pertains to an item already in RePEc, you can link the two here.
- This field has a controlled vocabulary. Values other than the following are ignored: stata, Mathematica, RATS, GAUSS, MATLAB, FORTRAN, C, Ox, perl, C++, python, Octave, Shazam, executable. Contact email@example.com if you have suggestions for updates to this list.
- This indicates that a certain package version, compiler, or operating environment is needed.
Note that if you already have your bibliographic metadata in some database, you may want to take advantage of some existing scripts that can help you convert the data. See this blog post.
You are now ready to open your RePEc archive.