Académique Documents
Professionnel Documents
Culture Documents
Relevant scenario
A typical scenario where this workflow will come handy is as follows:
• Your team uses single-sourcing to produce output in multiple formats from the same
FrameMaker source files.
• The documentation set under consideration consists of multiple files shared across
several books.
• The source files have multiple text insets.
Prerequisites
Before you get started with creating a PDF, ensure the following:
• Your peers have checked in the latest source files into the version control repository.
• You have complete access to all the files and folders.
Important considerations
Cross references
Cross-references are • Cross-references are not updated automatically when the reference destinations are
not updated automat- within text insets.
ically when the • Application of conditional tags drastically alters cross-references.
reference destina-
Make sure that a cross-reference destination is not hidden in your book because of
tions are within text
insets. conditional text. In such cases, you'll get many unresolved cross-references when you
update the book.
A PDF PRODUCTION HANDBOOK 2
Change bars
When you are creating the final PDF for publication, remove the change bars. Note that
change bars appear again if you flatten the text insets in a book after you have cleared
all change bars across the book.
If you want to preserve the change bars in the
source, you can set their color to white in the
Change Bar Properties dialog (Format >
Document > Change Bars), so that they are not
visible in the PDFs. Later, if required, you can
set the change bar color again to a visible color.
See Identify revised text with change bars in
FrameMaker Helpfor more information.
If you choose to make the change bars white,
ensure that you don’t have a black background
for the page numbers in the header/footer. Otherwise, white change bars will be visible
alongside changed page numbers in the PDF.
Consult your editor for standard PDF settings such as the following that your organi-
zation applies to PDF documents:
• Document information such as the correct document title, copyright, author
information, etc.
• File naming conventions.
• How the PDF should open, how navigation should be, and what to show on the
Acrobat or Adobe Reader title bar.
• Document security. Understand the security settings that your organization
applies to published PDFs, such as allowing users to print, extract text, etc.
• PDF settings (joboptions file)
Specify the PDF • Specify the PDF settings for Adobe
settings for Adobe Distiller.
Distiller. • Style guide and production instruc-
tions
• For quick reference to verify
paragraph formats, naming
conventions, etc.
• Template files. You may have to import
and reapply the variables, paragraph,
character, and cross-reference formats
with the standard definitions from the
template files.
If you are creating the • Fonts. If you are creating the PDF on a machine different from the one where you
PDF on a machine created the documents, ensure that you have all the required fonts on your machine.
different from the one FrameMaker displays the list of missing fonts when you open such documents.
where you created the Copy such fonts to your machine. Typically, fonts such as dingbats used in bullet
documents, ensure
styles may be missing.
that you have all the
required fonts on your
machine. Stage 0: Prepare the content
From the following list, carry out all the steps that are required:
• Spell check. Use the spell-checking guidelines of your organization. Do remove all
the spell-checking overrides:
a In FrameMaker 9, click Edit > Spelling Checker.
b Click Options.
c In the Spelling Checker Options dialog, ensure that no options are selected
under Ignore.
Text insets and variables within the text are not spell-checked at this stage. To spell-
check the insets, check out the inset files from the version-control repository, spell-
check them, and check your changes back in.
Note: Preferably, spell check after applying the required conditional text show/hide
settings. For example, hide all editorial comments and author notes before you spell
check. If you applied word-or character-level conditional text settings, there could be
words running into each other that may be incorrectly flagged as misspelt words.
A PDF PRODUCTION HANDBOOK 4
• If you are using a version control system, update the links (or get the latest version
of the files)
• Remove format overrides. See About format overrides in FrameMaker Help for
more details.
A PDF PRODUCTION HANDBOOK 5
d Click Import.
5 From the Book window, select and open all files and do the following:
a Select all files and apply the conditional text show/hide setting:
• Select View > Show/Hide Conditional Text.
• Select the tags that you want to show.
A PDF PRODUCTION HANDBOOK 6
Caution: This is a partial step, as some of the cross-references may have their destina-
tions inside text insets. Resolving such broken cross-references will necessitate
flattening the insets to resolve. We will come to that step later. DO NOT flatten the text
insets now.
7 Set the document properties. Select File > File Info. Fill in the details according to
the metadata information that your organization requires.
For final production, 8 For final production, once the content is already frozen, find the editorial and self-
once the content is note character tags and delete them.
already frozen, find For interim builds, such as for beta release, comments or other such conditional text
the editorial and self- would be hidden in the PDF. Here's an easy way to find such character tags:
note character tags
and delete them. a Select a word and apply the Comment conditional tag to it.
b Select Edit > Copy Special > Copy Conditional Text settings.
c Select Edit > Find and then do the following:
• Select Character Tag and type the name of the character tag (for example,
checkthis, "Author Note", or "Author Question").
Locate external • Locate external hyperlinks (such as to web pages) and ensure that they work. Use
hyperlinks and ensure the following conventions:
that they work • If you inserted fully qualified web page address (those starting with http://),
then search for http:// and ensure that those links are live.
• Use a production checklist. You can create a spreadsheet and then convert it to
a PDF form.
e (Optional) Under the Window Options group, select Show: Document Title
This option will display the document title in the window title instead of file
name.
• If your PDF will only be printed and not hosted online for download by
users, you do not need to optimize the PDF size.
• Any attachments to the PDF are not optimized.
A PDF PRODUCTION HANDBOOK 12
Do...
Standardize
Create template files for each document type with only the relevant tags.
• Import the latest condition tags to documents from the latest template file.
• Create document-specific template files. Do not use a single template file for all
document types.
For example, conditions vary across different product lines. A general condition
repository could lead to an unmanageable list of condition tags that are irrelevant
to any book type.
• Name the condition tags intuitively.
For example, if you use condition tags to separate contents for the standard, profes-
sional, and enterprise versions, name the condition tags such as
sta_<product_name_prefix>, pro_<prefix>, etc.
• Create a list of housekeeping condition tags required for internal use. Text marked
with these tags should not appear in the output PDF.
For example, editorial comments, draft comments, obsolete notices, review notes,
etc, are housekeeping tags. These tags should have the same text formatting and
naming across your entire organization so that editors can easily recognize them.
• If you embedded web page addresses in text (such as Go to the Downloads page),
follow a standard lead word or phrase. For example, precede all such web page
addresses with See or Refer to.
For example, create a text format, Author Question, that would make critical questions
that you want the reviewers to notice stand out. For such as paragraph format, use red,
bold, sans-serif font (if the body text is serif font such as Arial), and with 1.5 lines of
vertical space above and below the para. For added effects, make the paragraph cover
both columns if you have a two-column layout.
In the same vein, make the notes to self such as Author Note appear faded out, as they
are for your own view. When you create a review version, hide such notes to self.
For such paragraph formats, you can set the auto numbering to Author Note/Author
Question or a referenced graphic. Use auto-numbering in conjunction with a condition
tag such as Author Note, so that you can show the Author Notes in the internal review
PDFs to alert the reviewers to sections that you want them to focus on, ask questions,
or even as a note to self.
For example, if you are sending a PDF for review with a section that would change
pending a UI change, you could write thus:
Author Note: The User Management screen to change by Sprint 4. The topic "User
Management" will change accordingly.
Author Question: Is 32-bit Windows Server 2003 supported as well?
Don’t...