-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathformat.html
More file actions
101 lines (86 loc) · 5.13 KB
/
Copy pathformat.html
File metadata and controls
101 lines (86 loc) · 5.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<!-- Copyright 2003-2025 Eitan Frachtenberg publist@frachtenberg.org -->
<html>
<head>
<title>Publist input format</title>
</head>
<body bgcolor="#FCFFD5">
<center><font size=+2><u>Input Format</u></font></center><p><p>
This page describes how to create a publications database file for use with
<a href="http://frachtenberg.org/eitan/publist">Publist</a>.
Publist supports two input formats: <b>XML</b> (the original format) and <b>JSON</b>.
The field names and values are the same in both formats; the differences are noted below.
If you prefer to forgo the instructions, or follow them with ease, I suggest
you download my own <a href="http://frachtenberg.org/eitan/pubs/pubs.xml">XML file</a>,
and have a look.<br>
You should start with an XML file that has only these two lines:<br>
<tt><pubDB><br>
</pubDB><br></tt>
Anything you add should be between these two lines. Do not add any lines
before or after this section.<br>
Now you can add all your publications one by one.
Let's start with an example, and then describe each field:<p>
<tt>
<publication><br>
<key>sc02</key><br>
<type>conference</type><br>
<authors><br>
Frachtenberg, Eitan and Petrini, Fabrizio and Fernandez, Juan and Pakin, Scott and Coll, Salvador<br>
</authors><br>
<title>STORM: Lightning-Fast Resource Management</title><br>
<booktitle><br>
IEEE/ACM Conference on Supercomputing [[a href="http://www.sc-2002.org/"]]SC'02[[/a]]<br>
</booktitle><br>
<pages>125--142</pages><br>
<address>Baltimore, MD</address><br>
<month>11</month><br>
<year>2002</year><br>
<team>true</year><br>
<area>Resource Management</area><br>
<subarea>STORM</subarea><br>
</publication>
</tt>
<p>
<u>Fields description</u><p>
<ul>
<li><tt>publication</tt>: Not a field, but an indication of where a new publication entry starts (and ends).</li>
<li><tt>key</tt>: A unique string that identifies the publication (do not use '/' in key).</li>
<li><tt>type</tt>: Type of publication: can be for example one of: book, bookchapter, journal, conference, workshop, poster, report, talk, or thesis. You can also use any custom type of your own--see publist.ini for details.</li>
<li><tt>authors</tt>: List of authors. In XML, separated by " and " (e.g. "Roosevelt, Franklin D. and Einstein, Albert"). In JSON, a native array of strings (e.g. <tt>["Roosevelt, Franklin D.", "Einstein, Albert"]</tt>). Names must start with the last name followed by a comma.</li>
<li><tt>editors</tt>: For types "book" and "bookchapter". Same format as authors (optional).</li>
<li><tt>title</tt>: The title of the paper/publication.</li>
<li><tt>booktitle</tt>: The conference, journal, or framework where the publication was published.</li>
<li><tt>pages</tt>: Page numbers in proceedings or journal (optional).</li>
<li><tt>address</tt>: Location of the conference (optional, not expected for journal papers).</li>
<li><tt>volume</tt>: Volume of journal (optional).</li>
<li><tt>number</tt>: Journal issue number (optional).</li>
<li><tt>month</tt>: Numeric month of publication (1-12).</li>
<li><tt>year</tt>: Year of publication (four digits).</li>
<li><tt>isbn</tt>: ISBN number of book (optional).</li>
<li><tt>team</tt>: Should publication appear when using <tt>print_team()</tt> (optional, true/false).</li>
<li><tt>area</tt>: Area/field of publication (optional).</li>
<li><tt>subarea</tt>: Subarea/field of publication (optional).</li>
</ul><p>
<u>Notes on syntax</u><p>
<ol>
<li>Line breaks and whitespace are allowed, and will not show on output page.
Use specific HTML/CSS commands (such as <br>) to force whitespace.</li>
<li>Some fields are optional, or interchangeable. For example, a journal
may not have an address and a conference may not have a volume. You can also add your own custom fields.
In particular area and subarea are only used for sorting and selection queries,
and are not shown with the publication.</li>
<li>Order of fields is not important, as long as all the required fields appear.</li>
<li>Fields and field headers are case sensitive</li>
<li>HTML code can be embedded in any of the fields' text, to create hyperlinks,
special formatting, etc. In XML, the "<" and ">" delimiters must be
replaced with "[[" and "]]" respectively, so as not to be considered part of the XML code.
In JSON, literal HTML can be used directly in string values.
An example is shown in the <tt>booktitle</tt> field above.</li>
<li>Comments can be added to the XML file in the usual syntax,
e.g. <tt><!-- This is a comment --></tt>
JSON does not support comments.</li>
<li>Macros (see <a href="usage.html#macros">macro file</a>) work identically in both XML and JSON files.</li>
<p>
<hr WIDTH="100%">
<a href="https://github.com/eitanf/publist" target=_top>Back to Publist's homepage</a>
</body>
</html>