Overview

A custom edition importer allows us to ingest your print edition content and display it in the Pugpig app, combining PDF page views with tappable hotspots that link to the underlying article content. Each edition is delivered to us as a single ZIP file via SFTP, with an internal structure and naming convention agreed during setup.

1. The ZIP Package

Each edition must be delivered as a single ZIP file. The ZIP must follow an agreed filename pattern and contain all required assets (manifest, article XML, images and PDFs). The exact internal structure and naming conventions will be agreed and documented as part of the importer setup. Changes to this structure without prior agreement will cause import failures.

2. Edition Metadata

The following must be included for each edition:

• Edition name - the user-facing title (e.g. "The Daily News - 30 April 2026")
• Publish date - the date the edition should be made available to readers
• A stable edition key/ID - a unique, consistent identifier for this edition (e.g. derived from publication code and date), used for deduplication and linking
• Article and page ordering - a sequence or page number that determines the correct order of pages and articles within the edition

3. PDFs

• One PDF per page is required - we do not accept a single multi-page PDF for splitting on our end
• PDFs should be web optimised (i.e. linearised/suitable for streaming)
• We will render pages at the dimensions we receive them - please ensure PDFs are supplied at the correct intended display size
• By default, the first page of the PDF will be used as the edition cover. If a separate cover image is required, this should be supplied explicitly as an additional asset

4. Article XML

For each article, an XML file is required containing:

• Headline
• Standfirst / subheadline (if available)
• Author / byline
• Section - used to display sections in the edition navigator (e.g. News, Sport, Business). Section data can be provided either in the page manifest or on the article itself
• Issue date and modification date
• Article body content, ideally including inline styling such as bold and italic markup
• Inline image references, with optional captions, where images appear within the article body
• A unique article identifier referenced by the hotspot data (see section 6)

5. Article Images

• A separate image file for each article, used as the article thumbnail and lead image
• JPG/JPEG is preferred. PNG is supported but not ideal
• Images must be named or referenced in a way that maps them clearly to their corresponding article XML

6. Hotspot Coordinates

To overlay PDF pages with tappable links to article content, we need coordinate data for each hotspot on each page. Hotspots are expressed as absolute pixel values on a fixed canvas size agreed as part of setup - we normalise these internally.

Each hotspot requires:

• x, y - position of the top-left corner of the hotspot in pixels on the fixed canvas
• w, h - width and height in pixels on the same canvas
• Article identifier - a reference to the unique ID of the article this hotspot should link to

Note: This importer supports article links only. Advert hotspots with external URLs are not part of this template. If you require tappable advert links or external URL hotspots, this would need to be discussed as a separate custom requirement.

7. Edition Cover

• By default, we use the first page of the supplied PDF as the edition cover image in the storefront
• If a separate cover image is required, please supply this as an explicit additional asset alongside the ZIP

8. Optional: Supplements, Regional Variants and Filter Groups

If your publication includes supplements, regional editions or other grouped variants, additional metadata may be required. This is not active by default but can be configured. Fields that may be needed include:

• Supplement or group identifier
• Supplement or group display name
• Regional or variant code
• Storefront filter grouping slug and display name
• Parent/child relationship between a main edition and any supplements

Please discuss your requirements with your Pugpig contact if this applies to you.

9. Platform Capabilities: Multimedia and Advertising

The following are available as separate custom configurations and are not part of the standard delivered package:

• Multimedia overlays - if you need to overlay videos or image galleries on PDF pages, we have ways of supporting this. Speak to your Pugpig contact to discuss
• GAM interstitials - we can automatically insert Google Ad Manager served interstitials into the edition after import. This requires separate setup and is not configured via the delivery package

10. SFTP Delivery

All edition assets are delivered to us via SFTP using SSH key authentication. Username/password authentication is not supported. To set this up we will need:

• Confirmation of who will need SFTP access
• An SSH public key for each user or system that will be uploading content

We will provide SFTP server details, the required path structure and naming conventions once the above is confirmed.