Editions and publishing

Editions and weekly change sets as PDF, web and JSON

Freeze approved paragraphs into a dated set, run the checks, and publish PDF, web pages and JSON from the same approved source.

Editions and weekly sets: group approved paragraphs with exact versions recorded

An edition is a full publication. A weekly change set holds only what changed that week. Both record the exact paragraph versions they contain.

  1. Create the edition or weekly change set

    Open Editions, select Create an edition, choose edition or weekly set, then set the label and the period it covers.

  2. Add approved paragraphs in order

    Add paragraphs in reading order. The list accepts only paragraphs with status approved. If a paragraph is still in draft or in review, send it for approval first.

  3. Compare the set with the last published edition

    Open the edition detail, compare it with the last edition, and read the linked change requests. Confirm each paragraph version is the one you want to publish.

  4. Run the checks and lock the set

    Run Checks for geography, chart numbers, broken references, headings, alt text and language. Fix each blocking item in the paragraph, re-run the check, then lock the set.

  5. Publish it as one unit, and correct it in a new set

    Publish the locked set. A published edition is locked, so a correction always creates a new edition or weekly set rather than editing the published one.

  • Only approved paragraphs can enter an edition or weekly set
  • A published edition is locked and a correction creates a new set
  • Each edition records the exact paragraph versions it contains

Publishing: preview, checklist, build log and saved outputs

Choose the outputs for the locked set, run the checklist, preview, and publish. One source produces each output as a separate transform.

  1. Choose the edition or weekly set

    Open Publishing, choose the locked edition or weekly set, and confirm every paragraph in it is approved.

  2. Choose PDF, web pages, JSON or more than one

    Select the formats you need. PDF is for print, web pages are for reading on a phone or computer, and JSON is for downstream data users.

  3. Run the approval and completeness checklist

    Confirm approval is recorded for every paragraph, required fields are complete, and blocking checks have passed. Publishing is blocked while any item fails.

  4. Preview, then publish

    Preview the output, check the edition date and paragraph order, then select Publish. The build records the snapshot it was built from.

  5. Confirm the files produced

    Open Output history, confirm each file name, format and date, and download a copy. Each output shows the snapshot it came from so it can be reproduced.

  6. When a build fails, fix it and try again

    Open the failed build log, read what failed and which paragraphs were involved, fix those paragraphs, then run the build again. The prior published files stay live until the new build succeeds.

PDF

Print ready pages for reading and printing, built from the locked snapshot with the same edition date as the web pages and JSON.

Web pages

Readable pages by chapter and paragraph, with geography, chart numbers, edition date and a report a change link on each page.

JSON

A data file with paragraph text, type, geography, chart numbers, edition and change date for downstream systems, from the same snapshot.

History: who changed what, when and why

Every save keeps a version. Restore an earlier version as a new version, so history is never lost.

  1. Open the paragraph history

    Open the paragraph, select History, and read each version with author, date and reason.

  2. Compare two versions

    Select two versions to compare them side by side before you decide what to restore.

  3. Restore as a new version

    Select Restore on the version you want. The restored text becomes the new current version, and later history stays in the list.

  4. Trace a change request to its edition

    Open the change request, follow the link to the paragraph version, then follow that version to the edition or weekly set that published it.

Build this week set step by step

Collect approved paragraphs, run the checks, compare the set, and mark it ready to publish.