Building and Delivering Publications in S1000DMichael Davis – Principal Business Consultant

SDL Proprietary and ConfidentialSDL Proprietary and Confidential

S1000 C

Objectives

• Discuss S1000D Publication Concepts and Implementation– Publication Module

– PM BuilderPM Builder

– Applicability

– Paper vs IETP

• Discuss and Demonstrate Publication Module Markup– PM Refs

PMEntry– PMEntry

– Referenced Publication Modules

• Publication in Action– Demonstrate Contenta S1000D Publication Module Builder

• Create New Publications

M dif E i ti P bli ti• Modify Existing Publications

– Demonstrate Contenta S1000D Publish Tool2

f f

Publication Module Characteristics

• Publication Module defines the content and structure of a publication and contains one or more references to:– Data Modules (Including front matter and illustrations )

– Publication Modules

– Legacy Technical Publications

IETP

CSDB Publication

R f IETP or Paper

PublicationData Modules

References

Publication Modules

Legacy PubsLegacy Pubs

Publication Module Markup

• <pm> - element defines the content and structure of a publication. PM element is made up of <identAndStatusSection> and <pmStatus> elementselements– <identAndStatusSection> -

• <pmAddress> - container element for publication module address information

– <issueDate> - Date that publication was released into wild

– <pmTitle> - Title of the publication as defined by your project

– <shortPmTitle> - Shortened version of <pmTitle>p

<pmStatus> element explained

– <pmStatus>• <sourcePmIdent> - source publication module identification information• <security> - security classification of the complete publication module and illustrations• <dataRestrictions> - instructions and info about use, storage, and handling of pub• <logo> - manufacturer’s or projects logo• <responsiblePartnerCompany> - responsible company or authority for pub module• <originator> - the person or company who delivered the publication• <applicCrossRefTableRef> - pointer to the ACT table which applies to pub module• <applic> - applic statement for pub• <pubMedia> - how the publication is delivered (cd,dvd,etc)• <qualityAssurance> - status of the Q/A process as required by project• <systemBreakdownCode> - code for component maintenance publication

<F ti lIt C d >• <FunctionalItemCode>• <reasonForUpdate> - short explanation on why publication was updated• <remarks> - used for inserting general remarks if required by project. Compliance

category of service bulletins are to be given under this heading.

5

<content> Section Markup

• <content> - contains one or more <pmEntry> elements. – <pmEntry> Central element of publication module

R i– Recursive– Allows publication module to be structured at variable depth.<content>

<pmEntry><pmEntryTitle>This is the title</pmEntryTitle><dmRef>This is a referenced data module</dmRef>

First Level <pmEntry>

<pmRef>This is a referenced publication module</pmRef><pmEntry>

<pmEntryTitle>Second Level recursive title</pmEntryTitle>Second Level <pmEntry>

<pmEntryTitle>Second Level recursive title</pmEntryTitle><dmRef>more data module references</dmRef>

</pmEntry></pmEntry>

Recursion = You dd

6

</pmEntry>

</content>can add as many

levels of pmentriesas you like

Build PM Screen – Reference Data Modules and Pub Modules

• Contenta S1000D PM Builder Application consists of easy to use web interface

Contenta S1000D PM Builder Application

web interface

• Select Data Modules and Publication Modules via SDC and SNS or via SDC and SystemSNS or via SDC and System, SubSystem, and SubSubSystemCode

M lti l D t M d l d• Multiple Data Modules and Publication Modules can be selected at the same time.

• Data Modules can be previewed via LiveContent preview before inclusion for Q/A purposes..

7

PM Properties Screen – Publication Metadata Management

• Simple data entry screen for all Publication Module metadata

N N d t XML dit• No Need to use XML editor

• Fields are explained to assist Publication managers

8

Bulding a Publication with Contenta S1000D PM Builder

Click Save button

Right Click

Press OKRight Click

Type in NameSelect Model ID

Right Click

Fill In Name

Fill In Version

Select SDC

Select SNSSelect SNS

Select Information CodeAdd to PM button addsselected data and pubSelect Information Code selected data and pub

modules to the publication underneath the selected pm entry

9

Select Data Modules

SDL Publish Tool

• One tool to publish paper (xpp) or IETP (LiveContent)

F ll I t t d A li bilit• Fully Integrated Applicability filtering

• Multiple Skins Supported

• Locator Graphic Support

• Ability to save publish settings

• Full publish reports

• Graphic Scaling in Paper Output

10

Integrated Publishing Using S1000D Publish Tool

Right Click

Click

Select Pub

Select Format“Flash Front Matter checkbox” modifies publishing control

“Upload Completed ZIP to CSDB”

automatically places a

Enter NameEnter Collection Name

Select Viewer

file for locator graphic support

copy of the published zip file into the CSDB under the deliverables

container

“Delete Content from Zip File” cleans up

previous publish runs

11

Applicability Publishing

Select PubClick to set applic for

publishing

Click for Applic

Select Applic OptionsPress OK

12

Upcoming Events

Fall Webinar Series: S1000D Lessons from

S1000D in Action Webinar SeriesSession 1 How to Use the BREX [recording]

the Leaders • Featuring Gulfstream,

US Navy and others

Builder

Session 2 Enhancing the IETP User Experience

[recording]

US a y a d o e s

• Starting in September

• Details coming soon

Experience

Session 3 The Power of Applicability [recording]

Session 4 Project Workflow Management

[recording]

Session 6 Enhancing the Clarity and 7/25/2012 S1000D EventsSession 6 Enhancing the Clarity and Language Quality of Technical Documentation

7/25/2012

• ATA e-Business ForumScottsdale, AZOctober 22-24

Browse all at www.sdl.com/s1000dwebinars

Q & A

Got questions?

Thanks for joining us!

Copyright © 2008-2012 SDL plc. All rights reserved.. All company names, brand names, trademarks, service marks, images and logos are the property of their respective owners.

This presentation and its content are SDL confidential unless otherwise specified, and may not be copied, used or distributed except as authorised by SDL.