Rand Stats

PDF::Class

zef:dwarring

[Raku PDF Project] / PDF::Class

PDF::Class

This Raku module is the base class for PDF::API6.

PDF::Class provides a set of roles and classes that map to the internal structure of PDF documents; the aim being to make it easier to read, write valid PDF files.

It assists with the construction of PDF documents, providing type-checking and the sometimes finicky serialization rules regarding objects.

Description

The entry point of a PDF document is the trailer dictionary. This is mapped to PDF::Class. It contains a Root entry which is mapped to a PDF::Catalog objects, and may contain other entries, including an Info entry mapped to a PDF::Info object.

    use PDF::Class;
    use PDF::Catalog;
    use PDF::Page;
    use PDF::Info;

    my PDF::Class $pdf .= open: "t/helloworld.pdf";

    # vivify Info entry; set title
    given $pdf.Info //= {} -> PDF::Info $_ {
        .Title = 'Hello World!';
        .ModDate = DateTime.now; # PDF::Class sets this anyway...
    }

    # modify Viewer Preferences
    my PDF::Catalog $catalog = $pdf.Root;
    given $catalog.ViewerPreferences //= {} {
        .HideToolbar = True;
    }

    # add a page ...
    my PDF::Page $new-page = $pdf.add-page;
    $new-page.gfx.say: "New last page!";

    # save the updated pdf
    $pdf.save-as: "tmp/pdf-updated.pdf";

This module is a work in progress. It currently defines roles and classes for many of the more commonly occurring PDF objects as described in the PDF 32000-1:2008 1.7 specification.

More examples:

Set Marked Info options

    use PDF::Class;
    use PDF::Catalog;
    use PDF::MarkInfo;
    my PDF::Class $pdf .= new;
    my PDF::Catalog $catalog = $pdf.catalog; # same as $pdf.Root;
    with $catalog.MarkInfo //= {} -> PDF::MarkInfo $_ {
        .Marked = True;
        .UserProperties = False;
        .Suspects = False;
    }

Set Page Layout & Viewer Preferences

    use PDF::Class;
    use PDF::Catalog;
    use PDF::Viewer::Preferences;

    my PDF::Class $pdf .= new;

    my PDF::Catalog $doc = $pdf.catalog;
    $doc.PageLayout = 'TwoColumnLeft';
    $doc.PageMode   = 'UseThumbs';

    given $doc.ViewerPreferences //= {} -> PDF::Viewer::Preferences $_ {
        .Duplex = 'DuplexFlipShortEdge';
        .NonFullScreenPageMode = 'UseOutlines';
    }
    # ...etc, see PDF::ViewerPreferences

List AcroForm Fields

use PDF::Class;
use PDF::AcroForm;
use PDF::Field;

my PDF::Class $doc .= open: "t/pdf/samples/OoPdfFormExample.pdf";
with my PDF::AcroForm $acroform = $doc.catalog.AcroForm {
    my PDF::Field @fields = $acroform.fields;
    # display field names and values
    for @fields -> $field {
        say "{$field.key}: {$field.value}";
    }
}

Gradual Typing

In theory, we should always be able to use PDF::Class accessors for structured access and updating of PDF objects.

In reality, a fair percentage of PDF files contain at least some conformance issues (as reported by pdf-checker.raku) and PDF::Class itself is under development.

For these reasons it possible to bypass PDF::Class accessors; instead accessing hashes and arrays directly, giving raw access to the PDF data.

This will also bypass type coercements, so you may need to be more explicit. In the following example forces the setting of PageMode to an illegal value.

    use PDF::Class;
    use PDF::Catalog;
    use PDF::COS::Name;
    my PDF::Class $pdf .= new;

    my PDF::Catalog $doc = $pdf.catalog;
    try {
        $doc.PageMode = 'UseToes'; # illegal
        CATCH { default { say "err, that didn't work: $_" } }
    }

    # same again, bypassing type checking
    $doc<PageMode> = PDF::COS::Name.COERCE: 'UseToes';

Scripts in this Distribution

pdf-append.raku --save-as=output.pdf in1.pdf in2.pdf ...

appends PDF files.

pdf-burst.raku --save-as=basename-%03d.pdf --password=pass in.pdf

bursts a multi-page PDF into single page PDF files

pdf-checker.raku --trace --render --strict --exclude=Entry1,Entry2 --repair input-pdf

This is a low-level tool for PDF authors and users. It traverses a PDF, checking it's internal structure against PDF:Class definitions as derived from the PDF 32000-1:2008 1.7 specification.

Example 1: Dump a simple PDF

% pdf-checker.raku --trace t/helloworld.pdf
xref:   << /ID ... /Info 1 0 R /Root 2 0 R >>   % PDF::Class
  /ID:  [ "×C¨\x[86]üÜø\{iÃeH!\x[9E]©A" "×C¨\x[86]üÜø\{iÃeH!\x[9E]©A" ] % PDF::COS::Array[Str]
  /Info:        << /Author "t/helloworld.t" /CreationDate (D:20151225000000Z00'00') /Creator "PDF::Class" /Producer "Raku PDF::Class 0.2.5" >>        % PDF::COS::Dict+{PDF::Info}
  /Root:        << /Type /Catalog /Pages 3 0 R >>       % PDF::Catalog
    /Pages:     << /Type /Pages /Count 1 /Kids ... /Resources ... >>    % PDF::Pages
      /Kids:    [ 4 0 R ]       % PDF::COS::Array[PDF::Content::PageNode]
        [0]:    << /Type /Page /Contents 5 0 R /MediaBox ... /Parent 3 0 R >>   % PDF::Page
          /Contents:    << /Length 1944 >>      % PDF::COS::Stream
          /MediaBox:    [ 0 0 595 842 ] % PDF::COS::Array[Numeric]
      /Resources:       << /ExtGState ... /Font ... /ProcSet ... /XObject ... >>        % PDF::COS::Dict+{PDF::Resources}
        /ExtGState:     << /GS1 6 0 R >>        % PDF::COS::Dict[Hash]
          /GS1: << /Type /ExtGState /ca 0.5 >>  % PDF::COS::Dict+{PDF::ExtGState}
        /Font:  << /F1 7 0 R /F2 8 0 R /F3 9 0 R >>     % PDF::COS::Dict[PDF::Resources::Font]
          /F1:  << /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >>  % PDF::Font::Type1
          /F2:  << /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >>       % PDF::Font::Type1
          /F3:  << /Type /Font /Subtype /Type1 /BaseFont /ZapfDingbats >>       % PDF::Font::Type1
        /ProcSet:       [ /PDF /Text ]  % PDF::COS::Array[PDF::COS::Name]
        /XObject:       << /Im1 10 0 R /Im2 11 0 R >>   % PDF::COS::Dict[PDF::Resources::XObject]
          /Im1: << /Type /XObject /Subtype /Image /BitsPerComponent 8 /ColorSpace /DeviceRGB /Filter /DCTDecode /Height 254 /Width 200 /Length 8247 >>  % PDF::XObject::Image
          /Im2: << /Type /XObject /Subtype /Image /BitsPerComponent 8 /ColorSpace ... /Height 42 /Width 37 /Length 1554 >>      % PDF::XObject::Image
            /ColorSpace:        [ /Indexed /DeviceRGB 255 12 0 R ]      % PDF::ColorSpace::Indexed
              [3]:      << /Length 768 >>       % PDF::COS::Stream
Checking of t/helloworld.pdf completed with 0 warnings and 0 errors

This example dumps a PDF and shows how PDF::Class has interpreted it.

The PDF contains has one page (PDF::Page) that references various other objects, such as fonts and xobject images.

Example 2: Check a sample PDF

% wget http://www.stillhq.com/pdfdb/000025/data.pdf
% pdf-checker.raku --strict --render data.pdf
Warning: Error processing indirect object 27 0 R at byte offset 976986:
Ignoring 1 bytes before 'endstream' marker
Rendering warning(s) in 28 0 R (PDF::Page):
-- unexpected operation 'w' (SetLineWidth) used in Path context, following 'm' (MoveTo)
-- unexpected operation 'w' (SetLineWidth) used in Path context, following 'm' (MoveTo)
Rendering warning(s) in 30 0 R  (PDF::XObject::Form):
-- unexpected operation 'w' (SetLineWidth) used in Path context, following 'm' (MoveTo)
Unknown entries 1 0 R (PDF::Catalog) struct: /ViewPreferences(?ViewerPreferences)
Checking of /home/david/Documents/test-pdf/000025.pdf completed with 5 warnings and 0 errors

In this example:

Notes

pdf-content-dump.raku --raku in.pdf

Displays the content streams for PDF pages, commented, and in a human-readable format:

% pdf-content-dump.raku t/example.pdf 
% **** Page 1 ****
BT % BeginText
  1 0 0 1 100 150 Tm % SetTextMatrix
  /F1 16 Tf % SetFont
  17.6 TL % SetTextLeading
  [ (Hello, world!) ] TJ % ShowSpaceText
  T* % TextNextLine
ET % EndText

The --raku option dumps using a Raku-like notation:

pdf-content-dump.raku --perl t/example.pdf 
# **** Page 1 ****
.BeginText();
  .SetTextMatrix(1, 0, 0, 1, 100, 150);
  .SetFont("F1", 16);
  .SetTextLeading(17.6);
  .ShowSpaceText($["Hello, world!"]);
  .TextNextLine();
.EndText();

pdf-info.raku in.pdf

Prints various PDF properties. For example:

% pdf-info.raku ~/Documents/test-pdfs/stillhq.com/000056.pdf 
File:         /home/david/Documents/test-pdfs/stillhq.com/000056.pdf
File Size:    63175 bytes
Pages:        2
Outlines:     no
Author:       Prince Restaurant
CreationDate: Wed Oct 03 23:41:01 2001
Creator:      FrameMaker+SGML 6.0
Keywords:     Pizza, Pasta, Antipasto, Lasagna, Food
ModDate:      Thu Oct 04 00:03:04 2001
Producer:     Acrobat PDFWriter 4.05  for Power Macintosh
Subject:      Take Out & Catering Menu
Title:        Prince Pizzeria & Bar
Tagged:       no
Page Size:    variable
PDF version:  1.3
Revisions:    1
Encryption:   no

pdf-fields.raku --password=pass --page=n --save-as=out.pdf [options] in.pdf

Modes
General Options:

List, reformat or set PDF form fields.

pdf-revert.raku --password=pass --save-as=out.pdf in.pdf

undoes the last revision of an incrementally saved PDF file.

pdf-toc.raku --password=pass --/title --/labels in.pdf

prints a table of contents, showing titles and page-numbers, using PDF outlines.

% wget http://www.stillhq.com/pdfdb/000432/data.pdf
% pdf-toc.raku data.pdf
Linux Kernel Modules Installation HOWTO
  Table of Contents . . . i
  1. Purpose of this Document . . . 1
  2. Pre-requisites . . . 2
  3. Compiler Speed-up . . . 3
  4. Recompiling the Kernel for Modules . . . 4
    5.1. Configuring Debian or RedHat for Modules . . . 5
    5.2. Configuring Slackware for Modules . . . 5
    5.3. Configuring Other Distributions for Modules . . . 6

Note that outlines are an optional PDF feature. pdf-info.raku can be used to check if a PDF has them:

% pdf-info.raku my-doc.pdf | grep Outlines:

Development Status

The PDF::Class module is under construction and not yet functionally complete.

Note: The roles and classes in this module are primarly based on roles generated by the PDF::ISO_32000 module. The PDF::class module currently implements around 100 roles and classes of the 350+ objects extracted by PDF::ISO_32000.

See also

Classes Quick Reference

ClassTypesAccessorsMethodsDescriptionISO-32000 References
PDF::ClassdictEncrypt, ID, Info, Prev, Root(catalog), SizeBlob, Pages, add-page, add-pages, art-box, ast, bleed, bleed-box, core-font, creator, crop-box, crypt, delete-page, encrypt, fields, fields-hash, id, insert-page, iterate-pages, media-box, open, page, page-count, pages, permitted, save-as, trim-box, update, use-font, versionPDF entry-point. either a trailer dict or an XRef streamISO_32000::Table_15-Entries_in_the_file_trailer_dictionary
PDF::AcroFormdictCO(calculation-order), DA(default-appearance), DR(default-resources), Fields, NeedAppearances, Q(quadding), SigFlags, XFAfields, take-fieldsAcroForm role - see PDF::Catalog - /AcroForm entryISO_32000::Table_218-Entries_in_the_interactive_form_dictionary
PDF::Action::GoTodictD(destination), Next, S(subtype), Type(type)/Action Subtype - GoToISO_32000::Table_199-Additional_entries_specific_to_a_go-to_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::GoToRdictD(destination), F(file), NewWindow, Next, S(subtype), Type(type)/Action Subtype - GoToRISO_32000::Table_200-Additional_entries_specific_to_a_remote_go-to_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::JavaScriptdictJS(java-script), Next, S(subtype), Type(type)/Action Subtype - GoToISO_32000::Table_217-Additional_entries_specific_to_a_JavaScript_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::LaunchdictF(file), Mac, NewWindow, Next, S(subtype), Type(type), Unix, Win/Action Subtype - LaunchISO_32000::Table_203-Additional_entries_specific_to_a_launch_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::NameddictN(action-name), Next, S(subtype), Type(type)/Action Subtype - GoToISO_32000::Table_212-Additional_entries_specific_to_named_actions ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::SounddictMix, Next, Repeat, S(subtype), Sound, Synchronous, Type(type), Volume/Action Subtype - SoundISO_32000::Table_208-Additional_entries_specific_to_a_sound_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::SubmitFormdictFields, Flags, Next, S(subtype), Type(type)/Action Subtype - URIISO_32000::Table_236-Additional_entries_specific_to_a_submit-form_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::ThreaddictB(bead), D(thread), F(file), Next, S(subtype), Type(type)/Action Subtype - ThreadISO_32000::Table_205-Additional_entries_specific_to_a_thread_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Action::URIdictIsMap, Next, S(subtype), Type(type), URI/Action Subtype - URIISO_32000::Table_206-Additional_entries_specific_to_a_URI_action ISO_32000::Table_193-Entries_common_to_all_action_dictionaries
PDF::Annot::AdditionalActionsdictBl(blur), D(mouse-down), E(enter), Fo(focus), PC(page-close), PI(page-invisable), PO(page-open), PV(page-visable), U(mouse-up), X(exit)
PDF::Annot::CaretdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, RC(rich-text), RD(rectangle-differences), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), Sy(symbol), T(text-label), Type(type)annotsISO_32000::Table_180-Additional_entries_specific_to_a_caret_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::CircledictAP(appearance), AS(appearance-state), BE(border-effect), BS(border-style), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IC(interior-color), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, RC(rich-text), RD(rectangle-differences), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_177-Additional_entries_specific_to_a_square_or_circle_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::FileAttachmentdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FS(file-spec), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), Name(icon-name), OC(optional-content), P(page), Popup, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_184-Additional_entries_specific_to_a_file_attachment_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::HighlightdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::LinkdictA(action), AP(appearance), AS(appearance-state), BS(border-style), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), Dest(destination), ExData(external-data), F(annot-flags), FT(field-type), H(highlight-mode), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), PA(uri-action), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_173-Additional_entries_specific_to_a_link_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::PopupdictAP(appearance), AS(appearance-state), Border, C(color), Contents(content), DR(default-resources), F(annot-flags), FT(field-type), M(mod-time), NM(annotation-name), OC(optional-content), Open, P(page), Parent, Rect(rect), StructParent(struct-parent), Subtype(subtype), Type(type)annotsISO_32000::Table_183-Additional_entries_specific_to_a_pop-up_annotation ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::SquaredictAP(appearance), AS(appearance-state), BE(border-effect), BS(border-style), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IC(interior-color), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, RC(rich-text), RD(rectangle-differences), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_177-Additional_entries_specific_to_a_square_or_circle_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::SquigglydictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::StrikeOutdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::TextdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), Name(icon-name), OC(optional-content), Open, P(page), Popup, RC(rich-text), RT(reply-type), Rect(rect), State, StateModel, StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annots/Type Annot - Annotation subtypes See [PDF 32000 Section 12.5 Annotations]ISO_32000::Table_172-Additional_entries_specific_to_a_text_annotation ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::ThreeDdict3DA(activation), 3DB(view-box), 3DD(artwork), 3DI(interactive), 3DV(default-view), AP(appearance), AS(appearance-state), Border, C(color), Contents(content), DR(default-resources), F(annot-flags), FT(field-type), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Rect(rect), StructParent(struct-parent), Subtype(subtype), Type(type)annotsISO_32000::Table_298-Additional_entries_specific_to_a_ThreeD_annotation ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::UnderlinedictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::WidgetdictA(action), AA(additional-actions), AP(appearance), AS(appearance-state), BS(border-style), Border, C(color), Contents(content), DR(default-resources), F(annot-flags), FT(field-type), H(highlight-mode), M(mod-time), MK, NM(annotation-name), OC(optional-content), P(page), Parent, Rect(rect), StructParent(struct-parent), Subtype(subtype), Type(type)annotsISO_32000::Table_188-Additional_entries_specific_to_a_widget_annotation ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::_MarkupdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annotsISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::Annot::_TextMarkupdictAP(appearance), AS(appearance-state), Border, C(color), CA(constant-opacity), Contents(content), CreationDate, DR(default-resources), ExData(external-data), F(annot-flags), FT(field-type), IRT(reply-to-ref), IT(intent), M(mod-time), NM(annotation-name), OC(optional-content), P(page), Popup, QuadPoints, RC(rich-text), RT(reply-type), Rect(rect), StructParent(struct-parent), Subj, Subtype(subtype), T(text-label), Type(type)annots/Type Annot - Annotation subtypes See [PDF 32000 Section 12.5 Annotations]ISO_32000::Table_170-Additional_entries_specific_to_markup_annotations ISO_32000::Table_164-Entries_common_to_all_annotation_dictionaries
PDF::AppearancedictD(down), N(normal), R(rollover)Appearance role - see PDF::Annot - /AP entryISO_32000::Table_168-Entries_in_an_appearance_dictionary
PDF::Attributes::LayoutdictBBox, BackgroundColor, BaselineShift, BlockAlign, BorderColor, BorderStyle, BorderThickness, Color, ColumnCount, ColumnGap, ColumnWidths, EndIndent, GlyphOrientationVertical, Height, InlineAlign, LineHeight, O(owner), Padding, Placement, RubyAlign, RubyPosition, SpaceAfter, SpaceBefore, StartIndent, TBorderStyle, TPadding, TextAlign, TextDecorationColor, TextDecorationThickness, TextDecorationType, TextIndent, Width, WritingModeISO_32000::Table_327-Entry_common_to_all_attribute_object_dictionaries ISO_32000::Table_343-Standard_layout_attributes_common_to_all_standard_structure_types ISO_32000::Table_344-Additional_standard_layout_attributes_specific_to_block-level_structure_elements ISO_32000::Table_345-Standard_layout_attributes_specific_to_inline-level_structure_elements
PDF::Attributes::ListdictListNumbering, O(owner)Table 347 – Standard list attributeISO_32000::Table_327-Entry_common_to_all_attribute_object_dictionaries
PDF::Attributes::PrintFielddictDesc, O(owner), Role, checkedTable 348 – PrintField attributesISO_32000::Table_327-Entry_common_to_all_attribute_object_dictionaries ISO_32000::Table_348-PrintField_attributes
PDF::Attributes::TabledictColSpan, Headers, O(owner), RowSpan, Scope, SummaryTable Table 349 – Standard table attributesISO_32000::Table_327-Entry_common_to_all_attribute_object_dictionaries ISO_32000::Table_349-Standard_table_attributes
PDF::Attributes::UserPropertiesdictO(owner), P(properties)set-attributeISO_32000::Table_327-Entry_common_to_all_attribute_object_dictionaries
PDF::BorderdictD(dash-pattern), S(style), Type, W(width)/Type /BorderISO_32000::Table_166-Entries_in_a_border_style_dictionary
PDF::CIDSystemInfodictOrdering, Registry, SupplementISO_32000::Table_116-Entries_in_a_CIDSystemInfo_dictionary
PDF::CMapstreamCIDSystemInfo, CMapName, Type(type), UseCMap, WMode/Type /CMapISO_32000::Table_120-Additional_entries_in_a_CMap_stream_dictionary
PDF::Catalog::AdditionalActionsdictDP(did-print), DS(did-save), WC(will-close), WP(will-print), WS(will-save)ISO_32000::Table_197-Entries_in_the_document_catalogs_additional-actions_dictionary
PDF::ColorSpace::CalGrayarraySubtype, dictBlackPoint, Gamma, WhitePoint, props
PDF::ColorSpace::CalRGBarraySubtype, dictBlackPoint, Gamma, Matrix, WhitePoint, props
PDF::ColorSpace::DeviceNarrayAlternateSpace, Attributes, Names, Subtype, TintTransform
PDF::ColorSpace::ICCBasedarraySubtype, dictAlternate, Metadata, N, Range, props
PDF::ColorSpace::IndexedarrayBase, Hival, Lookup, Subtype
PDF::ColorSpace::LabarraySubtype, dictBlackPoint, Range, WhitePoint, props
PDF::ColorSpace::PatternarrayColorspace, Subtype
PDF::ColorSpace::SeparationarrayAlternateSpace, Name, Subtype, TintTransform
PDF::Destinationarrayfit, pagedelegate-destination, is-page-ref
PDF::EncodingdictBaseEncoding, Differences, Type/Type /EncodingISO_32000::Table_114-Entries_in_an_encoding_dictionary
PDF::ExData::Markup3Ddict3DA(activation), 3DV(default-view), MD5, Subtype(subtype), Type(type)ISO_32000::Table_313-Entries_in_an_external_data_dictionary_used_to_markup_ThreeD_annotations
PDF::ExtGStatedictAIS(alpha-source-flag), BG(black-generation-old), BG2(black-generation), BM(blend-mode), CA(stroke-alpha), D(dash-pattern), FL(flatness-tolerance), Font, HT(halftone), LC(line-cap), LJ(line-join), LW(line-width), ML(miter-limit), OP(overprint-paint), OPM(overprint-mode), RI(rendering-intent), SA(stroke-adjustment), SM(smoothness-tolerance), SMask(soft-mask), TK(text-knockout), TR(transfer-function-old), TR2(transfer-function), Type, UCR(under-color-removal-old), UCR2(under-color-removal), ca(fill-alpha), op(overprint-stroke)transparency/Type /ExtGStateISO_32000::Table_58-Entries_in_a_Graphics_State_Parameter_Dictionary
PDF::Field::AdditionalActionsdictC(calculate), F(format), K(change), V(validate)ISO_32000::Table_196-Entries_in_a_form_fields_additional-actions_dictionary
PDF::Field::ButtondictAA(additional-actions), DA(default-appearance), DS(default-style), DV(default-value), FT(subtype), Ff(field-flags), Kids, Opt, Parent, Q(quadding), RV(rich-text), T(key), TM(tag), TU(label), VISO_32000::Table_227-Additional_entry_specific_to_check_box_and_radio_button_fields
PDF::Field::ChoicedictAA(additional-actions), DA(default-appearance), DS(default-style), DV(default-value), FT(subtype), Ff(field-flags), I(indices), Kids, Opt, Parent, Q(quadding), RV(rich-text), T(key), TI(top-index), TM(tag), TU(label), VISO_32000::Table_231-Additional_entries_specific_to_a_choice_field
PDF::Field::SignaturedictAA(additional-actions), DA(default-appearance), DS(default-style), FT(subtype), Ff(field-flags), Kids, Lock, Parent, Q(quadding), RV(rich-text), SV(seed-value), T(key), TM(tag), TU(label), V(value)DVISO_32000::Table_232-Additional_entries_specific_to_a_signature_field
PDF::Field::TextdictAA(additional-actions), DA(default-appearance), DS(default-style), DV(default-value), FT(subtype), Ff(field-flags), Kids, MaxLen, Parent, Q(quadding), RV(rich-text), T(key), TM(tag), TU(label), VISO_32000::Table_229-Additional_entry_specific_to_a_text_field
PDF::FilespecdictCI, DOS, Desc, EF(embedded-files), F(file-name), FS(file-system), ID, Mac, RF(related-files), Type(type), UF, Unix, V(volatile)ISO_32000::Table_44-Entries_in_a_file_specification_dictionary
PDF::Font::CIDFontdictBaseFont, CIDSystemInfo, CIDToGIDMap, DW(default-width), DW2(default-width-and-height), FontDescriptor, Subtype(subtype), Type(type), W(widths), W2(heights)filter, font-name, font-obj, height, kern, make-font, protect, set-font-obj, stringwidth, underline-position, underline-thicknessISO_32000::Table_117-Entries_in_a_CIDFont_dictionary
PDF::Font::CIDFontType0dictBaseFont, CIDSystemInfo, CIDToGIDMap, DW(default-width), DW2(default-width-and-height), FontDescriptor, Subtype(subtype), Type(type), W(widths), W2(heights)filter, font-name, font-obj, height, kern, make-font, protect, set-font-obj, stringwidth, underline-position, underline-thicknessISO_32000::Table_117-Entries_in_a_CIDFont_dictionary
PDF::Font::CIDFontType2dictBaseFont, CIDSystemInfo, CIDToGIDMap, DW(default-width), DW2(default-width-and-height), FontDescriptor, Subtype(subtype), Type(type), W(widths), W2(heights)filter, font-name, font-obj, height, kern, make-font, protect, set-font-obj, stringwidth, underline-position, underline-thicknessISO_32000::Table_117-Entries_in_a_CIDFont_dictionary
PDF::Font::MMType1dictBaseFont, Encoding, FirstChar, FontDescriptor, LastChar, Name, Subtype(subtype), ToUnicode, Type(type), Widthsfilter, font-name, font-obj, height, kern, make-font, protect, set-font-obj, stringwidth, underline-position, underline-thicknessISO_32000::Table_111-Entries_in_a_Type_1_font_dictionary
PDF::Font::TrueTypedictBaseFont, Encoding, FirstChar, FontDescriptor, LastChar, Name, Subtype(subtype), ToUnicode, Type(type), Widthsfilter, font-name, font-obj, height, kern, make-font, protect, set-font-obj, stringwidth, underline-position, underline-thicknessTrueType fonts - /Type /Font /Subtype TrueType see [PDF 32000 Section 9.6.3 TrueType Fonts]ISO_32000::Table_111-Entries_in_a_Type_1_font_dictionary
PDF::FontDescriptor::CIDdictAscent, AvgWidth, CIDSet, CapHeight, CharSet, Descent, FD, Flags, FontBBox, FontFamily, FontFile, FontFile2, FontFile3, FontName, FontStretch, FontWeight, ItalicAngle, Lang, Leading, MaxWidth, MissingWidth, StemH, StemV, Style, Type, XHeightISO_32000::Table_122-Entries_common_to_all_font_descriptors ISO_32000::Table_124-Additional_font_descriptor_entries_for_CIDFonts
PDF::FontFilestreamLength1, Length2, Length3, Metadata, SubtypeISO_32000::Table_127-Additional_entries_in_an_embedded_font_stream_dictionary
PDF::FontStreamdictLength1, Length2, Length3, MetadataTarget of PDF::FontDescriptor FontFile or FontFile2 Attribute;
PDF::Function::ExponentialstreamC0, C1, Domain, FunctionType, N, Rangecalc, calculator/FunctionType 2 - ExponentialISO_32000::Table_40-Additional_entries_specific_to_a_type_2_function_dictionary ISO_32000::Table_38-Entries_common_to_all_function_dictionaries
PDF::Function::PostScriptstreamDomain, FunctionType, Rangecalc, calculator, parse/FunctionType 4 - PostScript see [PDF 32000 Section 7.10.5 Type 4 (PostScript Transform) Functions]ISO_32000::Table_38-Entries_common_to_all_function_dictionaries
PDF::Function::SampledstreamBitsPerSample, Decode, Domain, Encode, FunctionType, Order, Range, Sizecalc, calculator/FunctionType 0 - Sampled see [PDF 32000 Section 7.10.2 Type 0 (Sampled) Functions]ISO_32000::Table_39-Additional_entries_specific_to_a_type_0_function_dictionary ISO_32000::Table_38-Entries_common_to_all_function_dictionaries
PDF::Function::StitchingstreamBounds, Domain, Encode, FunctionType, Functions, Rangecalc, calculator/FunctionType 3 - Stitching see [PDF 32000 Section 7.4.10 Type 3 (Stitching) Functions]ISO_32000::Table_41-Additional_entries_specific_to_a_type_3_function_dictionary ISO_32000::Table_38-Entries_common_to_all_function_dictionaries
PDF::Group::TransparencydictCS(color-space), I(isolated), K(knockout), S, Type(type)ISO_32000::Table_147-Additional_entries_specific_to_a_transparency_group_attributes_dictionary ISO_32000::Table_96-Entries_Common_to_all_Group_Attributes_Dictionaries
PDF::ICCProfiledictAlternate, Metadata, N(num-colors), RangeISO_32000::Table_66-Additional_Entries_Specific_to_an_ICC_Profile_Stream_Dictionary
PDF::ImagestreamAlternates, BitsPerComponent, ColorSpace, Decode, Height, ID, ImageMask, Intent, Interpolate, Mask, Metadata, Name, OC(optional-content), OPI, SMask, SMaskInData, StructParent(struct-parent), Subtype, Type, Widthto-pngISO_32000::Table_89-Additional_Entries_Specific_to_an_Image_Dictionary
PDF::InfodictAuthor, CreationDate, Creator, Keywords, ModDate, Producer, Subject, Title, TrappedISO_32000::Table_317-Entries_in_the_document_information_dictionary
PDF::MCRdictMCID, Pg(page), Stm, StmOwn, Type(type)ISO_32000::Table_324-Entries_in_a_marked-content_reference_dictionary
PDF::MarkInfodictMarked, Suspects, UserPropertiesISO_32000::Table_321-Entries_in_the_mark_information_dictionary
PDF::Mask::AlphadictBC(backdrop-color), G(transparency-xobject), S(subtype), TR(transfer-function), TypeISO_32000::Table_144-Entries_in_a_soft-mask_dictionary
PDF::Mask::LuminositydictBC(backdrop-color), G(transparency-xobject), S(subtype), TR(transfer-function), TypeISO_32000::Table_144-Entries_in_a_soft-mask_dictionary
PDF::Metadata::XMLstreamMetadata, Subtype(subtype), Type(type)ISO_32000::Table_315-Additional_entries_in_a_metadata_stream_dictionary
PDF::NameTreedictKids, Limits, Namescoercer, name-tree
PDF::NamesdictAP, AlternatePresentations, Dests, EmbeddedFiles, IDS, JavaScript, Pages, Renditions, Templates, URLSISO_32000::Table_31-Entries_in_the_name_dictionary
PDF::NumberTreedictKids, Limits, Numscoercer, number-tree
PDF::OBJRdictObj(object), Pg(page), Type(type)/Type /OBJR - Object Reference dictionaryISO_32000::Table_325-Entries_in_an_object_reference_dictionary
PDF::OCGdictIntent, Name, Type(type), Usage/Type /OCG - Optional Content GroupISO_32000::Table_98-Entries_in_an_Optional_Content_Group_Dictionary
PDF::OCMDdictOCGs, P(visibility-policy), Type(type), VE(visibility-expression)ISO_32000::Table_99-Entries_in_an_Optional_Content_Membership_Dictionary
PDF::OutlinedictA(action), C(color), Count, Dest(destination), F(flags), First, Last, Next, Parent, Prev, SE(structure-element), TitleOutline - an entry in the Outlines Dictionary See /First and /Last Accessors in PDF::OutlinesISO_32000::Table_153-Entries_in_an_outline_item_dictionary
PDF::OutlinesdictCount, First, Last, Type/Type /Outlines - the Outlines dictionaryISO_32000::Table_152-Entries_in_the_outline_dictionary
PDF::OutputIntentdictDestOutputProfile, Info, OutputCondition, OutputConditionIdentifier, RegistryName, S(subtype), Type(type)/Type /OutputIntentISO_32000::Table_365-Entries_in_an_output_intent_dictionary
PDF::Page::AdditionalActionsdictC(page-close), O(page-open)
PDF::PagesdictCount, CropBox, Kids, MediaBox, Parent, Resources, Rotate(rotate), Type(type)add-page, add-pages, art-box, bbox, bleed, bleed-box, core-font, crop-box, delete-page, find-resource, height, images, iterate-pages, media-box, page, page-count, page-fragment, page-index, pages, pages-fragment, resource-entry, resource-key, resources, to-landscape, trim-box, use-font, use-resource, width/Type /Pages - a node in the page treeISO_32000::Table_29-Required_entries_in_a_page_tree_node
PDF::Pattern::ShadingdictExtGState, Matrix, PatternType, Shading, Type/ShadingType 2 - AxialISO_32000::Table_76-Entries_in_a_Type_2_Pattern_Dictionary
PDF::Pattern::TilingstreamBBox, Matrix, PaintType, PatternType, Resources, TilingType, Type, XStep, YStepbbox, canvas, contents, contents-parse, core-font, find-resource, finish, gfx, graphics, has-pre-gfx, height, html-canvas, images, mcid, new-gfx, next-mcid, open, pre-gfx, pre-graphics, render, resource-entry, resource-key, resources, save-as-image, tags, text, tiling-pattern, use-font, use-mcid, use-resource, width, xobject-form/PatternType 1 - TilingISO_32000::Table_75-Additional_Entries_Specific_to_a_Type_1_Pattern_Dictionary
PDF::ResourcesdictColorSpace, ExtGState, Font, Pattern, ProcSet, Properties, Shading, XObjectResource DictionaryISO_32000::Table_33-Entries_in_a_resource_dictionary
PDF::Shading::AxialdictAntiAlias, BBox, Background, ColorSpace, Coords, Domain, Extend, Function, ShadingType/ShadingType 2 - AxialISO_32000::Table_80-Additional_Entries_Specific_to_a_Type_2_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::CoonsstreamAntiAlias, BBox, Background, BitsPerComponent, BitsPerCoordinate, BitsPerFlag, ColorSpace, Decode, Function, ShadingType/ShadingType 6 - CoonsISO_32000::Table_84-Additional_Entries_Specific_to_a_Type_6_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::FreeFormstreamAntiAlias, BBox, Background, BitsPerComponent, BitsPerCoordinate, BitsPerFlag, ColorSpace, Decode, Function, ShadingType/ShadingType 4 - FreeFormISO_32000::Table_82-Additional_Entries_Specific_to_a_Type_4_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::FunctiondictAntiAlias, BBox, Background, ColorSpace, Domain, Function, Matrix, ShadingType/ShadingType 1 - FunctionalISO_32000::Table_79-Additional_Entries_Specific_to_a_Type_1_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::LatticestreamAntiAlias, BBox, Background, BitsPerComponent, BitsPerCoordinate, ColorSpace, Decode, Function, ShadingType, VerticesPerRow/ShadingType 5 - LatticeISO_32000::Table_83-Additional_Entries_Specific_to_a_Type_5_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::RadialdictAntiAlias, BBox, Background, ColorSpace, Coords, Domain, Extend, Function, ShadingType/ShadingType 3 - RadialISO_32000::Table_81-Additional_Entries_Specific_to_a_Type_3_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::Shading::TensorstreamAntiAlias, BBox, Background, BitsPerComponent, BitsPerCoordinate, BitsPerFlag, ColorSpace, Decode, Function, ShadingType/ShadingType 7 - TensorISO_32000::Table_84-Additional_Entries_Specific_to_a_Type_6_Shading_Dictionary ISO_32000::Table_78-Entries_Common_to_All_Shading_Dictionaries
PDF::SignaturedictByteRange, Cert, Changes, ContactInfo, Contents, Location, M(date-signed), Name, Prop_AuthTime, Prop_AuthType, Prop_Build, R, Reason, Reference, SubFilter, Type, Vbyte-rangesISO_32000::Table_252-Entries_in_a_signature_dictionary
PDF::SounddictB(bits), C(channels), CO(compression-format), CP(compression-params), E(encoding), R(rate), Type
PDF::StructElemdictA, ActualText, Alt(alternative-description), C(class), E(expanded-form), ID, K(kids), Lang, P(struct-parent), Pg(page), R(revision), S(tag), T(title), Typeattribute-dicts, class-map-keys, vivify-attributesan entry in the StructTree See also PDF::StructTreeRootISO_32000::Table_323-Entries_in_a_structure_element_dictionary
PDF::StructTreeRootdictClassMap, IDTree, K(kids), ParentTree, ParentTreeNextKey, RoleMap, Type(type)ISO_32000::Table_322-Entries_in_the_structure_tree_root
PDF::ViewerPreferencesdictCenterWindow, Direction, DisplayDocTitle, Duplex, FitWindow, HideMenubar, HideToolbar, HideWindowUI, NonFullScreenPageMode(after-fullscreen), NumCopies, PickTrayByPDFSize, PrintArea, PrintClip, PrintPageRange, PrintScaling, ViewArea, ViewClipViewerPreferences role - see PDF::Catalog - /ViewerPreferences entryISO_32000::Table_150-Entries_in_a_viewer_preferences_dictionary
PDF::XObject::FormstreamBBox, FormType, Group, LastModified, Matrix, Metadata, Name, OC(optional-content-group), OPI, PieceInfo, Ref, Resources, StructParent, StructParents, Subtype(subtype), Type(type)bbox, canvas, contents, contents-parse, core-font, find-resource, finish, gfx, graphics, has-pre-gfx, height, html-canvas, images, mcid, new-gfx, next-mcid, open, pre-gfx, pre-graphics, render, resource-entry, resource-key, resources, save-as-image, struct-parent, tags, text, tiling-pattern, use-font, use-mcid, use-resource, width, xobject-formXObject Forms - /Type /XObject /Subtype FormISO_32000::Table_95-Additional_Entries_Specific_to_a_Type_1_Form_Dictionary
PDF::XObject::ImagestreamAlternates, BitsPerComponent, ColorSpace, Decode, Height, ID, ImageMask, Intent, Interpolate, Mask, Metadata, Name, OC(optional-content), OPI, SMask, SMaskInData, StructParent(struct-parent), Subtype, Type, Widthbbox, data-uri, height, image-obj, image-type, inline-content, inline-to-xobject, open, source, to-png, width/Type XObject /Subtype /Image See [PDF 32000 Section 8.9 - Images ]ISO_32000::Table_89-Additional_Entries_Specific_to_an_Image_Dictionary
PDF::XObject::PSstreamLevel1, Subtype(subtype), Type(type)Postscript XObjects /Type XObject /Subtype PS See [PDF 32000 Section 8.8.2 PostScript XObjects]ISO_32000::Table_88-Additional_Entries_Specific_to_a_PostScript_XObject_Dictionary

(generated by etc/make-quick-ref.pl)