Cpdfmetadata (p.cpdf.2.6.doc.cpdf.Cpdfmetadata)

Types and Exceptions

type encoding =

| Raw
| UTF8
| Stripped

Possible output encodings for some function. Raw does no processing at all - the PDF string is output as-is. UTF8 converts loslessly to UTF8. Stripped extracts the unicode codepoints and returns only those which correspond to 7 bit ASCII.

val encode_output : encoding -> string -> string

Encode a string using a given encoding.

Metadata and settings

val copy_id : bool -> Pdf.t -> Pdf.t -> Pdf.t

copy_id keepversion copyfrom copyto copies the ID, if any, from copyfrom to copyto. If keepversion is true, the PDF version of copyto won't be affected.

val set_pdf_info : 
  ?xmp_also:bool ->
  ?xmp_just_set:bool ->
  (string * Pdf.pdfobject * int) ->
  Pdf.t ->
  Pdf.t

set_pdf_info (key, value, version) sets the entry key in the /Info directory, updating the PDF minor version to version.

val get_xmp_info : Pdf.t -> string -> string

Get XMP information for a given key.

val set_viewer_preference : (string * Pdf.pdfobject * int) -> Pdf.t -> Pdf.t

set_pdf_info (key, value, version) sets the entry key in the /ViewerPreferences directory, updating the PDF minor version to version.

val set_page_layout : Pdf.t -> string -> Pdf.t

Set the page layout to the given name (sans slash) e.g SinglePage

val set_page_mode : Pdf.t -> string -> Pdf.t

Set the page mode to the given name (sans slash) e.g UseThumbs

val set_non_full_screen_page_mode : Pdf.t -> string -> Pdf.t

Set the non full screen page mode to the given name (sans slash) e.g UseThumbs

val set_open_action : Pdf.t -> ?dest:string -> bool -> int -> Pdf.t

Set the open action. If the boolean is true, /Fit will be used, otherwise /XYZ

val set_version : int -> Pdf.t -> unit

Set the PDF version number

val get_info_utf8 : Pdf.t -> string -> string

Given a PDF, returns a function which can lookup a given dictionary entry from the /Info dictionary, returning it as a UTF8 string

val output_info : encoding -> Pdf.t -> unit

Output to standard output general information about a PDF.

val output_xmp_info : encoding -> Pdf.t -> unit

Output to standard output information from any XMP metadata stream in a PDF.

val create_metadata : Pdf.t -> Pdf.t

Create XMP metadata from scratch

XML Metadata

val set_metadata : bool -> string -> Pdf.t -> Pdf.t

set_metadata keepversion filename pdf sets the XML metadata of a PDF to the contents of filename. If keepversion is true, the PDF version will not be altered.

val set_metadata_from_bytes : bool -> Pdfio.bytes -> Pdf.t -> Pdf.t

The same, but the content comes from bytes.

val remove_metadata : Pdf.t -> Pdf.t

Remove the metadata from a file

val get_metadata : Pdf.t -> Pdfio.bytes option

Extract metadata to a Pdfio.bytes

val print_metadata : Pdf.t -> unit

Print metadate to stdout

val set_metadata_date : Pdf.t -> string -> Pdf.t

Set the metadata date

val expand_date : string -> string

Expands the date "now" to the date now. Leaves any other string alone.