d8d937f5ca2bda9869b1c76115ccee839de036cb
[debian/jabref.git] / src / help / XMPHelp.html
1 <HTML>
2
3 <BODY text="#275856">
4 <basefont size="4" color="#2F4958" face="arial">
5
6 <H1>XMP metadata support in JabRef</H1>
7 <p>
8 XMP is a standard created by Adobe Systems for storing metadata (data about data) in files.
9 An well known example for metadata are MP3 tags, which can be used to describe artist, album and song name
10 of a MP3 file. Adding metadata to MP3 helps other people to identify the songs correctly independent of file-name
11 and can provide means for software (MP3 players for instance) to sort and group songs.
12 </p>
13 <p>
14 With XMP-support the JabRef team tries to bring the advantages of metadata to the world of reference managers.
15 You can now choose to "Write XMP" metadata in the General Tab of JabRef, which will put all the Bibtex information
16 into the PDF. If you then email this PDF to a collegue she can just drag the file into JabRef and all information
17 that you entered will be available to her.
18 </p>
19
20 <H2>Usage</H2>
21
22 To use the XMP-feature in JabRef you can do the following:
23
24 <ul>
25   <li>To <b>import a single annotated PDF-file</b> that contains XMP you can select "File -> Import into... -> XMP-annotated PDF" or drag the file into the main view.</li>
26   <li>To <b>write the bibliographic information to the associated PDF</b> do the following: Double click the entry in the main view, go to the "General" tab and click on "Write XMP".</li>
27   <li>If you want <b>to annotate all the PDFs in a given database</b> you can select "Tools -> Write XMP for database"</li>
28   <li>To verify if it worked you can open the PDF in Adobe Acrobat and select
29   "File -> Document Properties -> Additional Metadata -> Advanced". In the tree to the right you should see an entry called "http://purl.org/net/bibteXMP"
30 <ul>
31
32 <h2>BibteXmp Fileformat</h2>
33
34 <p>
35 XMP uses a subset of the Resource Description Framework (RDF) to store data. For JabRef a new metadata
36 format is used which maps very closely to BibTeX. Basically all fields and values are turned into
37 nodes of an XML document. Only authors and editors are stored as rdf:Seq-structures, so users
38 of the data can skip the splitting on 'and's. All strings and crossrefs will be resolved in the data.
39 </p>
40 <p>
41 The following easy minimal schema is used:
42 </p>
43 <p>
44 <ul>
45   <li>The BibTeX-key is stored as <code>bibtexkey</code>.</li>
46   <li>The type of the BibTeX-entry is stored as <code>entrytype</code>.</li>
47   <li><code>author</code> and <code>editor</code> are encoding as <code>rdf:Seq</code>s where the
48   individual authors are represented as <code>rdf:li</code>s.</li>
49   <li>All other fields are saved using their field-name as is.</li>
50 </ul>
51 </p>
52 <p>
53 The following is an example of the mapping
54 </p>
55 <pre>
56 @INPROCEEDINGS{CroAnnHow05,
57   author = {Crowston, K. and Annabi, H. and Howison, J. and Masango, C.},
58   title = {Effective work practices for floss development: A model and propositions},
59   booktitle = {Hawaii International Conference On System Sciences (HICSS)},
60   year = {2005},
61   owner = {oezbek},
62   timestamp = {2006.05.29},
63   url = {http://james.howison.name/publications.html}
64 }
65 </pre>
66
67 will be transformed into
68
69 <pre>
70 &lt;rdf:Description xmlns:bibtex=&quot;http://jabref.sourceforge.net/bibteXMP/&quot;
71     bibtex:bibtexkey=&quot;CroAnnHow05&quot;
72     bibtex:year=&quot;2005&quot;
73     bibtex:title=&quot;Effective work practices for floss development: A model and propositions&quot;
74     bibtex:owner=&quot;oezbek&quot;
75     bibtex:url=&quot;http://james.howison.name/publications.html&quot;
76     bibtex:booktitle=&quot;Hawaii International Conference On System Sciences (HICSS)&quot;
77     bibtex:timestamp=&quot;2006.05.29&quot;&gt;
78         &lt;bibtex:author&gt;
79             &lt;rdf:Seq&gt;
80                 &lt;rdf:li&gt;K. Crowston&lt;/rdf:li&gt;
81                 &lt;rdf:li&gt;H. Annabi&lt;/rdf:li&gt;
82                 &lt;rdf:li&gt;J. Howison&lt;/rdf:li&gt;
83                 &lt;rdf:li&gt;C. Masango&lt;/rdf:li&gt;
84             &lt;/rdf:Seq&gt;
85         &lt;/bibtex:author&gt;
86     &lt;bibtex:entrytype&gt;Inproceedings&lt;/bibtex:entrytype&gt;
87 &lt;/rdf:Description&gt;
88 </pre></td></tr>
89 </table>
90
91 <p>
92 Beware of the following caveats if you trying to parse bibteXMP:
93 </p>
94 <p>
95 <ul>
96   <li>In RDF attribute-value pairs can also be expressed as nodes and vice versa.</li>
97 </ul>
98 </p>
99 <H2>Related Links:</H2>
100 <p>
101 Some links about XMP and annotating PDFs:
102 </p>
103 <p>
104 <ul>
105   <li><a href="http://freelancepropaganda.com/themp/">James Howison's blog "Themp---Managing Academic Papers like MP3s"</a></li>
106   <li><a href="http://www.xml.com/pub/a/2004/09/22/xmp.html">XML.com article about XMP</a></li>
107   <li><a href="http://jempbox.org">JempBox</a> and <a href="http://pdfbox.org">PDFBox</a> by Ben Litchfield are the Jaba libraries
108   used to access the PDFs and the metadata stream.</a></li>
109   <li><a href="http://episteme.arstechnica.com/eve/ubb.x/a/tpc/f/8300945231/m/377001889631">Good thread on ArsTechnica discussing the management of PDFs.</a></li>
110   <li><a href="http://partners.adobe.com/public/developer/en/xmp/sdk/xmpspecification.pdf">Adobe XMP Specification</a></li>
111 </ul>
112 </p>
113 </body>
114 </HTML>