Atomik Roundtrip 2.1: Tutorials << >>

Chapter 5 Tutorial 2 : Editing XML whilst using Atomik Roundtrip

In this tutorial you will learn about editing XML which is used with QuarkXPress documents.

This will include sending edits made to your XML within the QuarkXPress page back to the XML file. Such edits could include editing to fit the printed page or copy edits made by sub-editors who use QuarkXPress rather than an XML editor.

Also, this would include importing edits made to the XML in other applications and systems after the XML had originally been imported, allowing data which will be constantly updated during the production of the QuarkXPress document to be updated into the QuarkXPress page, without needing to re-import and re-format all of the data every time it changes.

The key stages in this tutorial are:

  1. Importing XML into a QuarkXPress document
  2. Exporting QuarkXPress copy edits to update an XML file
  3. Importing XML copy edits to QuarkXPress

Objective

The objective of this tutorial is to show how Atomik Roundtrip can be used as an active participant in an XML workflow.

  1. Click on the ‘Open Document’ button (
  1. ) on the ‘Roundtrip Control’ palette.

You will be presented with the QuarkXPress open dialog. Select the document ‘RT_Tutorial2.qxp’ document from the ‘Tutorials’ folder.

  1. Click on the ‘Import XML’ (
  1. ) button in the ‘Roundtrip XML’ palette. Import the file ‘RT_Tutorial2.xml’,

If the ‘Roundtrip XML’ palette is not showing, select ‘Show Roundtrip XML’ from the ‘view’ menu in QuarkXPress.

  1. Drag the first ‘GameTitle’ element into the empty text box on the document. You will see the text imported into the box.
  2. Click into the box where the ‘GameTitle’ element was dropped. You will notice that this text, despite having come from an XML file, is still standard QuarkXPress text, and can be edited and styled as normal.
  1. Now, make a change to the imported ‘GameTitle’ text (currently ‘The Neverland’). You can change the text to anything you like. In the examples, we’ve used ‘The Changed Text’.
  2. Switch back to the ‘Focus’ tab of the XML palette. Make sure that the ‘RT_Tutorial2.xml’ file is highlighted.

This is particularly important, as the behaviour of most of the controls in the XML palette, as well as the contents of the ‘XML’ and ‘DTD’ tabs of the palette, will change according to what is selected in the ‘Focus’ tab.

  1. Click the ‘Update XML from document’ button(
  1. ). If you now click back to the ‘XML’ tab of the ‘XML palette’, you’ll see that the XML content has now been updated to reflect what is on the page. Note that this change has not yet been made to the XML file on disk, only to the XML file which is stored within the QuarkXPress document.
  2. Click the ‘Save XML’ button (
  1. ), in the ‘XML palette’. The changes you have made are now saved to disk.
  2. Use the SimpleText application (Mac) or Notepad (Windows) to view the file ‘RT_Tutorial2.xml’, which you will find in the ‘Tutorials’ folder.

You will find the text which you just amended between the <GameTitle> and </GameTitle> tags in the text.

    This functionality is very useful in order to capture text edits which you have made in QuarkXPress back to your XML workflow, ensuring that any further usage of that text from your XML source - whatever that may be - will reflect the text which eventually went into print, rather than the pre-edited XML.

    1. Now, make a further change to that text which we previously edited : maybe change it completely to ‘My Updated Text’, within SimpleText or Notepad.

    Note: whilst editing XML directly you must be careful not to change the tags around the content.

    Now save your XML file, by selecting ‘Save’ from the ‘File’ menu in SimpleText or Notepad (or whichever other text editor you’re using).

    1. Return to your QuarkXPress page, select ‘Reload XML’ from the Roundtrip menu, and select the same XML file which you’ve just been editing (‘RT_Tutorial2.xml’) - just as you did in steps 1 and 2 of this Tutorial.
    2. Click on the ‘XML’ tab of the ‘Roundtrip XML palette’. You will notice that the text of the GameTitle text has changed in your XML palette, but not on your QuarkXPress page. This is to give users the opportunity to preview changes before bringing them onto the QuarkXPress page.

      14. If you’re unsure whether the XML differs, then you can check by clicking the ‘Compare XML with Document’ button (

      ).

          You’ll see that an XML which differs from the QuarkXPress page (either because the QuarkXPress document has changed, or because the XML has changed) will be highlighted in bold.

          15. Now click on the ‘Update Document from XML’ button in the XML palette (

          ). The changes which you have made are flowed onto the page.

              This functionality is particularly useful when working with data which is constantly being updated during the production process : maybe pricing information in a catalogue or holiday brochure, or possibly financial data in an annual report.

              Summary

              In this tutorial we have:

              1. Imported data into QuarkXPress from an XML file
              2. Made changes to the XML data from within QuarkXPress
              3. Imported updates made to an XML file into QuarkXPress