THE POWER OF APPLICABILITYMichael Davis – Principal Business Consultant

SDL Proprietary and ConfidentialSDL Proprietary and Confidential

S1000 C

Objectives

• Discuss S1000D Applicability Concepts– What is it

– How does it workHow does it work

– What is Publication level Applicability

– What is Content level Applicability

• Discuss and Demonstrate Applicability Markup– ACT, PCT, and CCT Recap

Referenced Applic Groups– Referenced Applic Groups

• Applicability in Action– Demonstrate Applicability Assistant

• Create Assert Statements

• Modify Assert Statements

• Add Publication Level Applic• Add Publication Level Applic

• Adding Content Level Applic2

S1000 f

Applicability – What is it?

• Applicability is a mechanism in S1000D that allows authors to indentify a context for a data module or parts of data module. – Generally associated with a physical configuration of a product

– Also includes tool availability and environmental conditions

Applicability Bootcamp Series is available for review:Applicability Bootcamp Series is available for review:• http://www.sdl.com/en/xml/resources/resources-by-topic/topic-s1000d.asp

Applicability – ACT, PCT, and CCT Modules

ACT PCT Product Cross-reference Table

Domain of the Configuration Manager

ACT PCT

CCT

Product Cross reference Table

Conditions Cross-reference TableCCT

Applicability DMs

Conditions Cross reference TableInferred relationship

Project DMs and PMs

DMs PMs All data modules and publication modules have a reference in their <identAndStatusSection>

ICNs ICNs inherit the applicability of the data modules that

a reference in their <identAndStatusSection> element blocks to the ACT data module

of the data modules that reference them

Domain of Technical Writers

Data Module Applicability

• Stored in the <applic> construct in the identification and status section of the data module

• Always applies to all parts of content section within the data module• Always applies to all parts of content section within the data module

• Filters entire data modules in/out of the publication

• Human readable applicability annotation

• Computable applicability annotation

Pub Module

Applic Selections

Applicable Not Applicable

Applic Selections

Serial Number

Service Bulletin Status

5

Environmental Conditions

Data Module Applicability Markup

• Explanation• <displayText> element contains human

readable applicability annotation. In this i th t thi d t d l

• Markup<applic><displayText>

i l P T i M i bi l dcase we are saying that this data module only applies to Mountain Bicycles that are model Mountain Storm

• <evaluate> element contains the

<simplePara>Type is Mountain bicycle and model is Mountain Storm</simplePara>

</displayText><evaluate andOr="and">

tComputable applicability annotation made up of individual tests (<assert>) that grouped together.

• <assert> element defines each product

<assert applicPropertyIdent="type"applicPropertyType="prodattr" applicPropertyValues="Mountain bicycle”>/ tattribute or condition values that apply to

the data module. </assert><evaluate andOr=“and"><assert applicPropertyIdent="model"

applicPropertyType="prodattr”li P t V l "M t i t "

• Note: <evaluate> elements are used to string together <assert> elements to define

l hi d bl t t t

applicPropertyValues="Mountain storm"></assert></evaluate></evaluate>

/ li

6

complex machine readable statements. </applic>

Content Level Applicability

– Stored in the <referencedApplicGroup> construct in ID STATUS Section

– Applies to specifically marked elements within the content section of a data modulemodule

– Filters specific content in/out of a data module

– applicRefId attribute is used within content

Applicable Content

Data Module

Non Applicable Content

Applic Selections

7

Content Applicability Markup

• Explanation• <applic id=“app-0001”> a unique identifier

must be defined for each content level li t t t O th id h b

• Markup<referencedApplicGroup><applic id="app-0001">

di l Tapplic statement. Once the id has been created it can be placed into the applicRefidattribute on elements within the content section.

<displayText><simplePara>Temp Is Below Freezing</simplePara></displayText>

t• <displayText> element contains human readable applicability annotation. In this case we are saying that this data module only applies to Mountain Bicycles that are model Mountain Storm

<assertapplicPropertyIdent="TMP-T001" applicPropertyType="condition"applicPropertyValues="Below Freezing">/ tmodel Mountain Storm

• <assert> element defines each product attribute or condition values that apply to the content element you wish to reference.

</assert></applic></referencedApplicGroup>

t t• <warning> element is filtered in/out based upon applicRefid attribute that was previously defined within the <applic> element within <referencedApplicGroup>

<content><warning applicRefId="app-0001"></warning></content>

8

Applicability in Action – Contenta Plug-In

• Updated Contenta S1000D Arbortext Plug-in with Applicability AssistantAssistant– Create Applic without having to

handcode!!

– Assert Statement BuilderAssert Statement Builder

– Access saved applic settings at any time

– Apply settings from within Editor

– Real Time Preview of Applic settings.

Applicability Assistant - Contenta Menu

• Plug-in Choices– Manage Applicability

All th t t d dif• Allows the user to create and modify applic

– Assign Applicability• Allows users to assign pre created• Allows users to assign pre-created

applic statements

– Preview• Authors can instantly preview theirAuthors can instantly preview their

changes to verify before check-in

– Insert Reference• Author can instantly reference any data u o ca s a y e e e ce a y da a

module, pub module, or ICN

– Validate• Author can easily check Brex rules and y

all references in one click

Manage Applic Tab

• Manage Applicability Screen– Initial Screen as you enter from menu

– New Button allows you to create new applicability statements

– Modify allows user to modify existing statementstatement

– Reference Count keeps track of how many times each assert statement has been referenced

– XML Preview actually shows the current tagging

Build Applicability Screen

• Display Text– Enter human readable text

• Applicability IDApplicability ID– System generated to ensure uniqueness

• Saved Assert StatementsCan be easily recalled and used– Can be easily recalled and used

• Create Assert Statements– Create and modify asserts

XML P i• XML Preview– See the generated XML

• Insert XML– Places newly formed or changed assert

into the XML

Build Applicability - Referenced Group Level

• Product Selection– As Editor Selects Products, values

are displayed for easy identificationare displayed for easy identification

– Editor can create “And” or “Or” conditions

New or Old Assert statements are– New or Old Assert statements are easily modifiable

Applicability in Action – Updated XML

• XML is updated– When editor presses insert xml button the

newly created/modified XML is insertednewly created/modified XML is inserted into the checked-out data module.

– Author has just built complex assert tagging.

f

Preview – Initial Screen

• Preview screen allows authors the ability to verify that Applicability changes are working prior to check-in.

15

C f

Preview – Select Attributes or Conditions

• Author can select Product, Product Attributes, Condition, or Reference to test statements.

16

C S

Preview

• Current Applicability Shown – Allows authors to see exactly what applicability options have been chosen.

Optional Warning

17

Preview

• By changing the applicability option shown author can easily see what content has been supressed.

Suppressed Warning

18

Demonstration

Demonstrate Applicability Assistant

• Create Assert Statements

• Modify Assert Statements

Add P bli ti L l A li• Add Publication Level Applic

• Adding Content Level Applic

19

Upcoming Events

S1000D Events• AIA Tech Pubs

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

WorkshopClearwater, FLMay 10-11

Session 1 How to Use the BREX Builder

[ g]

Session 2 Enhancing the IETP User Experience

[recording]

• S1000D User ForumDenver, CO

Experience

Session 4 Project Workflow Management

5/17/2012

June 18-21

• ATA e-Business

Session 5 Building and Delivering Publications

6/28/2012

e us essForumScottsdale, AZOctober 22-24

Session 6 Enhancing the Clarity and Language Quality of Technical Documentation

7/25/2012

Register at www.sdl.com/xml under Events

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.