API Editorial Services Overview

1
API Editorial Services Overview

• Teresa RitchieEditorial Associate

2
Editorial Services Staff

• 1 Editorial Associate
• 4 Editors/Desktop Publishers/ Graphic Artists

3
Current Work Platforms

• Adobe FrameMaker
• Same software used by ISO
• Adobe Illustrator
• Adobe Photoshop

4
Submitting your Document to API

• when submitting electronic files for API
  Publications please take the following into
  consideration
• Do Not duplicate API Cover Page
• Do Not duplicate API Special Notes
• Do Not use dual columns
• Do Not use all caps
• Do Not indent paragraphs or subparagraphs
• Do Not use color type or graphics
• Do Not import graphics into the file
• Please submit a printout of the working draft of
  the publication from your word processing
  program.

5
Graphics

• When creating and saving graphics, save them into
  either .eps or .tif file
• (If you have any questions about programs or
  formats for creating or saving graphics, please
  contact API)

6
Elements of an API Standard

• Foreword
• 0 Introduction
• 1 Scope
• 2 References
• 3 Definitions
• 4 Begins the main text of the Document

7
Tables and Figures

• All tables and figures must be called out
  (referred to) in the text
• Tables and figures are numbered separately but
  sequentially, not by section, throughout the text
  
• Number Tables and figures in appendixes by the
  alphabetical designations of the appendix then
  numerically, as follows Table A-1, Table A-2,
  Figure A-1, Figure A-2, Table B-1, Table B-2,
  Figure B-1, Figure B-2

8
Creating a Table??

• When creating tables DO NOT use the table
  function, insert a tab where the columns should
  be separated. For example
• Table 17-Polished Rod Coating
  Composition (tab) Min (tab) Max
  Carbon (tab) 0.50 (tab) 1.00 Silicon (tab) 3
  .50 (tab) 5.50 Sulfur (tab) 0.00 (tab) 0.02

9
Send it in!
10
Editorial Services Processes

• Document received from API Associate with
  designated Level of Editing and any special
  instructions
• Level 1
• Level 2
• Level 3

11
Level 1

• When the associate and/or the committee have done
  extensive preparatory work of a technical nature
  and do not want the document changed, its a
  Level 1. We will
• Lay out the document in Frame
• Create tables and art, if needed
• ISO format it, if needed
• Proofread the laid-out pages to check that the
  complete manuscript printed out, sections and
  paragraphs are in order, equations converted
  correctly, and illustrations printed out to match
  the examples provided
• Ensure consistency in treatment of measures or
  technical terms within the document (but we wont
  change it to make it consistent with other API
  documents). If there is inconsistent usage within
  the document, well choose the predominant
  treatment (if there is one).

12
Level 1 (continued)

• We will not
• Change the text, unless proofreading of the page
  proofs reveals glaring errors such as
  misspellings or faulty punctuation. If the error
  could change the technical sense (e.g.
  subject/verb agreement, and the subject/verb are
  technical terms), well query you and you will
  decide if it should be changed.

13
Level 2

• This is light editing, our most commonly
  requested Level. We will
• Renumber a raw or old-style document into
  ISO-style format
• Organize the reference section in alpha order
  (after the API references, which always go first)
• Footnote references, checking for consistency in
  figure, equation, and table callouts
• Proof tables
• Proof text for spelling and punctuation, and
  agreement between nouns and verbs
• Proof covers, title pages, running heads, and
  tables of contents
• Note In some cases, even with a Level 2, we are
  requested to leave grammar aloneto not rewrite
  abbreviated sentences, list items, or oil
  language. If this is your preference, simply
  state it on the cover sheet.

14
Level 3

• When substantive editing is requested, and more
  time is automatically built into the schedule to
  allow for substantial work, its a Level 3. We
  will
• Rewrite
• Reorganize (ISO)
• Write translations and summaries
• Eliminate wordiness
• Review content for clarity and logic
• Ensure consistent tone for intended audience
• Do everything in Level 2We will query any
  technical content to the standards associate or
  committee. If were unsure whether a change
  alters a technical context, we promise to QUERY
  IT!

15
Outsourced Work

• when ES is overwhelmed
• Artwork
• Layout
• Editing
• Proofing

16
Getting the Job Done!

• Layout Text, Tables and Figures
• Create any figures not on file or not submitted
  with new manuscript
• Edit Document
• Incorporate any changes from Editor
• Quality Check
• Return to Associate with Page Proof Sign off Sheet

17
Getting the Job Done 2!

• Incorporate any and all changes from Associate
  and Reviewing Committee
• Note API Associate compiles all changes into
  one Page Proof to be returned to the
  Editor-in-Charge of the document
• Quality Check
• Return to Associate with
• TOC Complete
• Page Proof Sign off Sheet
• Request for Related Pubs
• Pricing Sheet
• Draft Publications Announcement
• at which time, mailing labels for past purchasers
  will be requested

18
Getting the Job Done 3!

• Incorporate any and all changes from Associate
  and Reviewing Committee
• Quality Check
• Return to Associate with
• related pubs form
• generic ad
• product number
• Continue process of review, incorporating changes
  and quality checks until EVERYONE is satisfied

19
Finishing the Document

• The API Associate will take care of providing
  Gratis copies (to those they deem worthy)
• The document will be uploaded to Global
  Engineering Documents for hard-copy and
  electronic sale
• A Publications Announcement will be posted on the
  API web site and mailed to past purchasers of the
  document

20
Why We Do What We Do

• Adobe FrameMaker
• is VERY ISO (or ISO type) numbering friendly
• if major changes are made to a document after it
  has been imported into Frame, the document will
  re-flow easily, while updating the numbering
  and keeping all figures and tables with the text
  they are assigned to.

21
Why We Do What We Do 2

• Adobe Illustrator
• is compatible with Adobe FrameMaker
• is user friendly for creating the types of
  figures in most API documents

22
If You Would Like.

• If you have a document that has had an
  extraordinary amount of time (or ) involved in
  the creation of a Word file and you would like it
  published as is
• Submit to API the completed Word file and a PDF
  file.
• The Word file will be archived for future
  editions
• We will print the Final Product from the PDF file
  with the addition of API formatted covers and
  Special Notes

23
Why We Cant Help...

• Documents published in Word can be very
  temperamental
• With each different PC, settings change and the
  document will change
• Headers and footers are not easily manipulated
• Page numbering has a mind of its own
• Graphics are not easily manipulated
• Section Break and Page Breaks are difficult to
  manage