Xmp Class

Summary

Reads XMP data from the input documents and adds it to the document metadata.
Assembly
Wyam.Xmp.dll
Namespace
Wyam.Xmp
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Xmp"] class Type type-node

Syntax

public class Xmp : IModule

Remarks

The SourceFilePath metadata key of each input document will be used to locate any sidecar files.

Constructors

Name Summary
Xmp(bool, bool, bool, bool) Reads XMP data from the input documents and adds it to the document metadata with the specified options.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
WithMetadata(string, string, bool) Xmp
Specifies an XML element to find in the XMP data along with the metadata key that will be used to set it in the document.
WithNamespace(string, string) Xmp
Adds or overrides a namespace for resolving namespace prefixes of the xmpPath specified in Wyam.Xmp.Xmp.WithMetadata(System.String,System.String,System.Boolean). Several default namespaces are predefined:
  • dc - - http://purl.org/dc/elements/1.1/
  • xmpRights - - http://ns.adobe.com/xap/1.0/rights/
  • cc - - http://creativecommons.org/ns#
  • xmp - - http://ns.adobe.com/xap/1.0/
  • xml - - http://www.w3.org/XML/1998/namespace
GitHub