CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/hyperxmp

                      |  THE HYPERXMP PACKAGE |
                      |                       |
                      |      Scott Pakin      |
                      | scott+hyxmp@pakin.org |


XMP (eXtensible Metadata Platform) is a mechanism proposed by Adobe
for embedding document metadata within the document itself.  The
metadata are designed to be easy to extract, even by programs that are
oblivious to the document's file format.  Most of Adobe's applications
store XMP metadata when saving files.  Now, with the hyperxmp package,
it is trivial for LaTeX document authors to store XMP metadata in
their documents as well.

hyperxmp integrates seamlessly with hyperref and requires virtually no
modifications to documents that already exploit hyperref's mechanisms
for specifying PDF metadata.  hyperxmp can embed a wide variety of
metadata as XMP, including the list of authors, document title,
contact information (telephone number, postal address, email address,
etc.), copyright statement, keywords, natural language, and much more.
hyperxmp is compatible with pdflatex, latex+dvips+ps2pdf,
latex+dvipdfm, xelatex, and lualatex.


To create hyperxmp.sty simply run "tex hyperxmp.ins".  Install
hyperxmp.sty somewhere where LaTeX can find it.  See
https://texfaq.org/FAQ-installthings for general information about
installing packages.

Building hyperxmp.pdf is a little more involved:

        pdflatex hyperxmp.dtx
        pdflatex hyperxmp.dtx
        makeindex -s gind-hyxmp.ist hyperxmp.idx -o hyperxmp.ind
        makeindex -s gglo-hyxmp.ist hyperxmp.glo -o hyperxmp.gls
        pdflatex hyperxmp.dtx
        pdflatex hyperxmp.dtx

Copyright and license

Copyright (C) 2019 Scott Pakin

This file may be distributed and/or modified under the conditions of
the LaTeX Project Public License, either version 1.3c of this license
or (at your option) any later version.  The latest version of this
license is in:


and version 1.3c or later is part of all distributions of LaTeX
version 2008/05/04 or later.

Down­load the con­tents of this pack­age in one zip archive (713.8k).

hy­per­xmp – Embed XMP meta­data within a doc­u­ment

XMP (eXten­si­ble Me­ta­data Plat­form) is a mech­a­nism pro­posed by Adobe for em­bed­ding doc­u­ment meta­data within the doc­u­ment it­self. The meta­data is de­signed to be easy to ex­tract, even by pro­grams that are obliv­i­ous to the doc­u­ment's file for­mat. Most of Adobe's ap­pli­ca­tions store XMP meta­data when sav­ing files. Now, with the hy­per­xmp pack­age, it is triv­ial for doc­u­ment au­thors to store XMP meta­data in their doc­u­ments as well.

Ver­sion 2.2 of the pack­age added sup­port for the IPTC Photo Me­ta­data schema. It al­lows \xm­p­comma and \xm­pquote to be used in any hy­per­xmp op­tion, not only those that re­quire spe­cial treat­ment of com­mas. And it in­tro­duces an \xm­pline­sep macro that con­trols how mul­ti­line fields are rep­re­sented in the XMP packet.

The pack­age in­te­grates seam­lessly with hy­per­ref and re­quires vir­tu­ally no mod­i­fi­ca­tions to doc­u­ments that al­ready ex­ploit hy­per­ref's mech­a­nisms for spec­i­fy­ing PDF meta­data. The cur­rent ver­sion of hy­per­xmp can em­bed the fol­low­ing meta­data as XMP: ti­tle, au­thors, pri­mary au­thor's ti­tle or po­si­tion, meta­data writer, sub­ject/sum­mary, key­words, copy­right, li­cense URL, doc­u­ment base URL, doc­u­ment iden­ti­fier and in­stance iden­ti­fier, lan­guage, source file name, PDF gen­er­at­ing tool, PDF ver­sion, and con­tact tele­phone num­ber/postal ad­dress/email ad­dress/URL. Hyper­xmp cur­rently em­beds XMP only within PDF doc­u­ments; it is com­pat­i­ble with pdf, XeLaTeX, +dvipdfm, and +dvips+ps2pdf.

Li­censesThe Project Public Li­cense 1.3c
Copy­right2017–2019 Scott Pakin
Main­tainerScott Pakin
TDS archivehyperxmp.tds.zip
Con­tained inTeX Live as hy­per­xmp
MiKTeX as hy­per­xmp
TopicsPDF fea­tures
Guest Book Sitemap Contact Contact Author