← Back to branch summary

~ubuntu-branches/ubuntu/natty/jabref/natty

« back to all changes in this revision

Viewing changes to src/help/XMPHelp.html

  • Committer: Bazaar Package Importer
  • Author(s): gregor herrmann
  • Date: 2007-11-16 18:38:18 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071116183818-20x934jdsju14618
Tags: 2.3-2
* Add /usr/lib/jvm/java-7-icedtea to wrapper script. Doesn't work on
  Debian yet but helps Ubuntu users (TODO: add dependency on
  icedtea-java7-jre (not yet in Debian)).
* Reformat wrapper script.
* debian/rules: re-arrange targets and their dependencies.

Show diffs side-by-side

added added

removed removed

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