Difference between revisions of "Sidecar File"

From Creative Commons
Jump to: navigation, search
(XMP Sample (DRAFT))
(Replacing page with '{{Filetype |license_url=yes |web_statement=yes |more_permissions=yes }} An ''XMP Sidecar File'' is a file containing serialized metadata related to a document. Sub-optimal...')
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Technology]]
+
{{Filetype
[[Category:Developer]]
+
|license_url=yes
[[Category:metadata]]
+
|web_statement=yes
[[Category:Developer Challenges]]
+
|more_permissions=yes
[[Category:Developer Challenges Completed]]
+
}}
[[Category:specification]]
+
An ''[[XMP]] Sidecar File'' is a file containing serialized metadata related to a document.  Sub-optimal for obvious reasons, these are used by tools, including [[liblicense]], when the file format does not support direct embedding.
[[Category:example]]
 
[[Category:XML]]
 
[[Category:SVG]]
 
[[Category:filetype]]
 
  
This is a specification for companion file metadata. This takes the form of an associated [[RDF]] or [[XMP]] file that has metadata and licensing that is included along with a work.
+
See also: [http://www.adobe.com/devnet/xmp/ XMP Specification], p 36
 
 
Thus if you had a file such as the one referenced, '''barcode_ean13.svg''', one would create a file '''barcode_ean13.rdf''' that would contain the following. The rdf:about reference in <Work /> tag is very important for linking both relative and absolute information to a file.
 
 
 
Similarly, if you want to use [[XMP]] for the companion file, this is acceptable as well. [[#XMP Sample|See the example]].
 
 
 
== RDF Sample ==
 
<pre>
 
  <rdf:RDF
 
      xmlns="http://web.resource.org/cc/"
 
      xmlns:dc="http://purl.org/dc/elements/1.1/"
 
      xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 
  >
 
      <Work rdf:about="http://www.openclipart.org/incoming/2004/04/contents/barcode_ean13.svg">
 
        <dc:title>EAN-13 Bar Code</dc:title>
 
        <dc:description>A Bar Code: EAN-13.</dc:description>
 
        <dc:subject>barcode, bar code, bar, code, UPC, EAN, EAN-13, universal product code, universal, product, code, product code</dc:subject>
 
        <dc:publisher><Agent rdf:about="http://www.openclipart.org/"><dc:title>Open Clip Art Project</dc:title></Agent></dc:publisher>
 
        <dc:creator><Agent rdf:about="http://www.theworths.org/richard/"><dc:title>Richard D. Worth</dc:title></Agent></dc:creator>
 
        <dc:rights><Agent rdf:about="http://web.resource.org/cc/PublicDomain"><dc:title>Public Domain</dc:title></Agent></dc:rights>
 
        <dc:date>2004-04-27</dc:date>
 
        <dc:format>image/svg+xml</dc:format>
 
        <dc:type>http://purl.org/dc/dcmitype/StillImage</dc:type>
 
        <license rdf:resource="http://web.resource.org/cc/PublicDomain" />
 
      </Work>
 
      <License rdf:about="http://web.resource.org/cc/PublicDomain">
 
        <permits rdf:resource="http://web.resource.org/cc/Reproduction" />
 
        <permits rdf:resource="http://web.resource.org/cc/Distribution" />
 
        <permits rdf:resource="http://web.resource.org/cc/DerivativeWorks" />
 
      </License>
 
  </rdf:RDF>
 
</pre>
 
 
 
'''NOTE:''' The above [[#Sample]] does not include all of the [http://dublincore.org/documents/dces/ Dublin Core elements].
 
 
 
== XMP Sample ==
 
<pre>
 
<x:xmpmeta xmlns:x="adobe:ns:meta/">
 
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
 
<rdf:Description rdf:about=""
 
  xmlns:xapRights="http://ns.adobe.com/xap/1.0/rights/">
 
  <xapRights:Copyright>This work is licensed to the public under the Creative Commons Attribution-ShareAlike license http://creativecommons.org/licenses/by-sa/2.0/ verify at http://example.com/svg-metadata.html</xapRights:Copyright>
 
  <xapRights:WebStatement>http://example.com/svg-metadata.html</xapRights:WebStatement>
 
  <xapRights:Marked>True</xapRights:Marked>
 
</rdf:Description>
 
<rdf:Description rdf:about=""
 
  xmlns:cc="http://creativecommons.org/ns#">
 
  <cc:license>http://creativecommons.org/licenses/by-sa/2.0/</cc:license>
 
</rdf:Description>
 
<rdf:Description rdf:about=""
 
  xmlns:dc="http://purl.org/dc/elements/1.1/">
 
  <dc:creator>
 
  <rdf:Seq>
 
    <rdf:li>John Doe</rdf:li>
 
    <rdf:li>Jane Doe</rdf:li>
 
  </rdf:Seq>
 
  </dc:creator>
 
  <dc:title>The title</dc:title>
 
  <dc:description>A description</dc:description>
 
  <dc:date>2007-01-01</dc:date>
 
  <dc:format>image/svg+xml</dc:format>
 
</rdf:Description>
 
</rdf:RDF>
 
</x:xmpmeta>
 
</pre>
 
 
 
== Developer Challenges ==
 
 
 
It is impractical to embed metadata in some file formats, and, it should be optional to store metadata outside of a file. So we need a specification for a "companion" metadata file that would define license and other metadata information. This could take
 
 
 
=== Implementations ===
 
 
 
* [http://www.openclipart.org/ Open Clip Art Library] puts RDF metadata and licensning info into a package of clip art that is named with *.rdf.
 
* Please add your implementation here :)
 
 
 
=== Examples ===
 
 
 
* See [http://openclipart.org/wiki/index.php/Metadata_Discussion this page detailing the Open Clip Art Library's solution].
 
* See the [[#Sample]] above to figure out how to connect your file with CC licesning and metadata.
 
* Please add your example, screenshot, mockup, etc here :)
 
 
 
=== TODO ===
 
 
 
* Please add your TODO here :)
 

Latest revision as of 19:51, 4 March 2008

File Type Information
Supports embedding license URL: supports_license_url::yes
Supports embedding web statement: supports_web_statement::yes
Supports embedding more permissions: supports_more_permissions::yes
Metadata Location: [[Metadata location::{{{metadata_location}}}]] | (unknown) }}
Metadata Format: [[Metadata format::{{{metadata_format}}}]] | (unknown) }}


An XMP Sidecar File is a file containing serialized metadata related to a document. Sub-optimal for obvious reasons, these are used by tools, including liblicense, when the file format does not support direct embedding.

See also: XMP Specification, p 36