ntda processes and procedures - writedocwritedoc.com/resume/smcl/knowledge...

NTDA

NTDA Processes and ProceduresRelease: 02.00Document Revision: 02.10

www.nortel.com

KS-NTDA-020.

NTDARelease: 02.00Publication: KS-NTDA-020Document release date: 31 October 2008

Copyright © 2006-2008 Nortel NetworksAll Rights Reserved.

Printed in Canada

All rights reserved.

.

3.

ContentsIntroduction 13

NTDA system overview 15NTDA components 15

TS Portal 17SAM and Clarify 17Documentum 17XML Editor 17Legacy content 17Delivery Repository 17Release List 17Admin users 18

NTDA authoring tools 18Editor icons 19

Content development process 21Content development overview 21Content development tasks 21

PC configuration 22Minimum requirements 22PC desktops: current and refresh 23Recommended PC specification 23

Authoring in structure 23Using Unstructured FrameMaker 24Using Structured FrameMaker 25Using Arbortext Editor 25

Installing and configuring Arbortext Editor 5.2 27Uninstalling Epic Editor 5.1 27Installing Arbortext Editor 5.2 28Installing Editor 5.2 Nortel customizations 40

Using Editor 5.2 Nortel customizations 42Setting 5.2 environment variables 44Setting up Arbortext Editor 5.2 45Changing Arbortext License Manager Host 47Changing the DocBroker Host 47

NTDANTDA Processes and Procedures

KS-NTDA-020 02.1031 October 2008

Copyright © 2006-2008 Nortel Networks

.

4

Uninstalling Arbortext Editor 5.2 48

NonMTBI authoring 51NonMTBI variable options 52NonMTBI module authoring 52NonMTBI publishable building 54Editing a NonMTBI document 57NonMTBI PDF generation with reuse 59NonMTBI PDF generation without reuse 61NonMTBI PDF generation with profiled content 63Splitting NonMTBI publishable into 2 volumes 64

NonMTBI2 authoring 67Checklist for editing NonMTBI2 CVoIP modules 68

Checklist for editing NonMTBI2 modules 68Checklist for editing a NonMTBI2 upgrades module 69

Creating NonMTBI2 variables 71NonMTBI2 module authoring 73NonMTBI2 publishable building 75Editing a NonMTBI2 document 78NonMTBI2 PDF generation with reuse 80NonMTBI2 PDF generation without reuse 82NonMTBI2 PDF generation with profiled content 84NonMTBI2 content models 86

NonMTBI2 Front elements 86NonMTBI2 Body elements 88NonMTBI2 Back elements 96

MTBI2 authoring 99Modular Task-Based Information 100Creating MTBI2 variables 100MTBI2 module authoring 102MTBI2 publishable building 104Editing a MTBI2 document 108MTBI2 PDF generation without reuse 110MTBI2 PDF generation with reuse 112MTBI2 PDF generation with profiled content 114MTBI2 content models 116

MTBI2 Front elements 116MTBI2 Topics elements 118

Documentum information and procedures 129Documentum file structure 129

Documentum MTBI2 folder guidelines 130Documentum NonMTBI2 folder guidelines 131

Documentum Desktop Client tasks 132




.

5

Check in 132Check Out 133Cancel check out 134

Documentum Desktop Client tools 135File properties 136Virtual Document Manager 136View Document Info (versions) 137Display settings 138Recently used documents 139

Finding items in Documentum 140Documentum Adapter procedures 143

DLM information and procedures 145Using the Dynamic Link Manager 145

Inserting DLM links 146Inserting a DLM link to a profiled Heading (NonMTBI) 146Adding DLM link targets in procedures or ordered lists 148Inserting DLM web links 149Inserting links using the DLM Link Manager 151Removing previously deleted DLM resources 153Removing duplicate DLM target ids 154Registering a document with DLM 155Validating DLM links 158Saving the DLM link validation report 158Disabling the DLM server connection 159Enabling the DLM server connection 159Inserting intra-document DLM links 160

Fixing DLM errors 161Fixing DLM registration errors 163

Fixing DLM registration error A50087 163Fixing DLM registration error A30111 164Fixing DLM registration error A50140 165Fixing DLM registration error A50154 166

Graphics information and procedures 169Graphic size and format 169

Graphics size and location 169UI screen size 170

General graphic procedures 170Capturing screens 170Converting between formats 172Creating imagemaps with FrontPage 173Converting Postscript to PNG 174Converting EPS to PNG 175Converting EPS to JPG 177




.

6

Extracting embedded graphics using Acrobat and SnagIt 178Extracting embedded graphics using Acrobat and Photoshop 181Extracting embedded graphics using HTML and Illustrator 183

Graphic management 184Linking to graphics 184Storing source graphics 186Editing graphics 188

Cloning tasks and procedures 191Cloning a module 191

Cloning a module procedure 193Cloning publishable but not modules within it 194

Cloning a document but not modules within it 196Cloning a publishable and modules within it 198

Cloning a document and modules within it 200

File-naming conventions 203File-naming XML publishable objects 203File-naming module, text, and image objects 203

NTDA group file-naming strategy 205File-naming PDF publishable objects 207

Metadata assignment 209Metadata fundamentals 209Updating DocRevision policy 209

NTDA DocRevision policy 210

Change bar management 211Change bars and document lifecycle 211

Change bars and document lifecycle stages 211Applying change bars 212Removing change bars 214Controlling the display of change bars 215

NTDA profiling 219Profiling fundamentals 219Updating and replacing PCF and entities-config.acl files 220Creating profiles 221Applying profiles 223Viewing profiles 225

NTDA publishing 227Publishing fundamentals 227

Publishing process 227Release list metadata 228

Lifecycle process 228Lifecycle states 229




.

7

Lifecycle conversion tasks 235Approved lifecycles 236

Publishing from ecmprod - an interim process 236

Multistreaming options 239Multistreaming option 1 239

Multistreaming procedure, option 1 240Multistreaming option 1 examples 243

Multistreaming option 2 244Multistreaming procedure, option 2 244

Multistreaming option 3 245Multistreaming procedure, option 3 246

Future multistreaming 247Multistreaming in the future procedure 247

Converting to NTDA 249Conversion process 249Manual conversion procedures 250

Converting a paragraph 250Converting a table 251Converting a list 253

Conversion QA checklist 255255

Migrating publishables from 5.1 to 5.2 257Migration from 5.1 to 5.2 tasks 257Migrating a single document from 5.1 to 5.2 259Migrating a 5.1 publishable with locked modules to 5.2 260Migrating batch from 5.1 to 5.2 261Setting DTDVersion to the correct value 262

Installing and configuring Epic Editor 5.1 265Installing Epic Editor 5.1 265Installing Nortel 5.1 customizations 266Setting 5.1 environment variables 266Setting up Epic Editor 5.1 267

Transforming from NonMTBI to NonMTBI2 269Transforming publishables without re-used modules 270Transforming publishables with re-used modules 271

NonMTBI2 to MTBI2 transform 275Preparing to transform to MTBI2 275

NonMTBI 275NonMTBI2 275MTBI2 276NonMTBI2 to MTBI2 prep-tool 276




.

8

InfoCategory and InfoType values 277Transforming from NonMTBI2 to MTBI2 279Fixing transform errors 291Publishable structures and element mappings 295

Procedural publishable 296Combined publishable 298Conceptual publishable 299Reference publishable 301New in this release publishable 302Publishable element mappings 303

Module structures and element mappings 306Section attribute auto-population 306WhatsNewModule 307ConceptModule 312WorkflowModule 316TaskModule 321ProcedureModule 327ReferenceModule 331TerminologyModule 335ContentGroupingModule 337Common element mappings 339

Transform QA checklist 342

NTDA FAQ 345What characters can be used within headings? 345

Characters that can not be used in headings 346Why am I getting multiple Arbortext comments in my file? 346

Avoiding multiple Arbortext comments in files 346How do I type in commonly-used ASCII characters? 347

Key combinations for common ASCII characters 347What happens if I cancel a checkout after DLM registration? 347

Synchronizing DLM link information 347How do I get support outside regular working hours? 347

Contacting the IT Support Center 348How do I avoid duplicate modules or images? 349

Causes of duplicate modules or images 349Moving modules between different folders 351Updating the contents of entities-config.acl 351Renaming modules 353Deleting NTDA XML files from Documentum 354Adding comments to a document 355Removing unused text entities 356Cancelling the checkout of locked files 357Raising an NTDA CR 359




.

9

Training 367NTDA training strategy 367NTDA-GDE training 367NTDA training prerequisites 368NTDA training recommendations 368Download information for the NTDA training course 369Other training 369Project manager checklist 369Author checklist 370

Common procedural modules 371Inserting a citation 371Logging on to Documentum through Arbortext Editor 373Browsing Documentum through Arbortext Editor 375Checking out a document through Arbortext Editor 375Checking in a document through Arbortext Editor 375Modifying module attributes 375Inserting elements 376Applying formatting 378Creating an index 379Creating a text entity 381Checking completeness 382Fixing content errors 382Checking module into Documentum 383Modifying publishable attributes 383Pasting modules using object references 384Inserting text entity 384Inserting a Terminology module 385Checking publishable into Documentum 385Checking file out of Documentum 386Checking in file into Documentum as minor version 387Verifying local environment variables 387Verifying preferences 388Creating a neutral version of the NonMTBI document 388Verifying the neutral version of the NonMTBI document 389Generating a NonMTBI PDF with profiled content 390Saving the NonMTBI2 variable template 390Modifying variable attributes 391Saving NonMTBI2 module template 391Using a shared variable 391Saving NonMTBI2 publishable template 392Setting document heading numbering 392Setting the display of Nortel confidential 394




.

10

Generating a NonMTBI2 PDF with reuse 394Generating a NonMTBI2 PDF without reuse 395Creating a neutral NonMTBI2 document 396Verifying neutral NonMTBI2 document 397Generating a NonMTBI2 PDF with profiled content 399Saving the MTBI2 variable template 400Fixing WhatsNewModule or ConceptModule context errors 400Saving MTBI2 publishable template 403Generating a MTBI2 PDF without reuse 403Generating a MTBI2 PDF with reuse 404Creating a neutral version of an MTBI2 document 405Verifying the neutral version of the MTBI2 document 406Generating a MTBI2 PDF with profiled content 406Pasting objects using object references 407Exporting publishable onto your local PC 407Transforming NonMTBI document 408Opening the file in NonMTBI2 409Transforming post-converted text entities 410Importing transformed publishable into Documentum 410Deleting transform folders 410Exporting original file 411Renaming file v2 411Modifying v1 file 412Checking in v1 as same version 412Deleting v1 content in v2 413Checking in v2 as same version 413Resetting your authoring environment 414Using local variables 415Using the SME Access tool 416Customizing the MTBI2 Documentation Roadmap template 417Fixing formatting errors 419Importing variable into Documentum 420Download and install FileZilla 420Saving MTBI2 module template 422Saving NonMTBI module template 423Saving NonMTBI publishable template 424Generating a NonMTBI PDF with reuse 425Generating a NonMTBI PDF without reuse 426

Citrix information and procedures 427About Citrix 427

What Citrix is 427Advantage of Citrix 428Disadvantages of Citrix 428




.

11

What Citrix looks like 429Best practices for Citrix 429Installing and configuring the Citrix environment 430

Download the Citrix software and the Citrix client 430Install the Citrix software 432Download and Install FileZilla 434Configure FileZilla to access Citrix 434

Using Citrix 437Launching Citrix 437Downloading a file from Citrix to your PC 438

Webtop information and procedures 439About WebTop 439

What WebTop is 439Advantages of WebTop 440Disadvantages of WebTop 440

Best Practices for Webtop 440Install and configure WebTop 440

Launch WebTop from Citrix 442Remove any existing java files from the Documentum shared directory on your

PC 443Clean up Internet cache files 443Install a Java Runtime Environment 446Verify the Java Runtime Environment Installation 447Launch WebTop from Windows 448Configure WebTop 448

Using WebTop 451Launching WebTop 452Changing permissions on an object with WebTop 452Checking in a publishable, chapter, or module with WebTop 455Checking out a chapter or module that is not part of a publishable with

WebTop 457Checking out a chapter or module that is part of a publishable with

WebTop 458Checking out a publishable with WebTop 459Creating and using a shortcut in WebTop 460Exporting a document with WebTop 461Finding out where a chapter or module is used with WebTop 462Importing a chapter or module into an XML document by reference with

WebTop 464Importing a new MTBI2 module with WebTop 466Importing a new MTBI2 publishable with WebTop 467Importing a new nonmtbi2 module with WebTop 467Importing a nonmtbi2 publishable with WebTop 468Performing a search with WebTop 468




.

12

Updating a graphic with WebTop 471Setting up the 5.2 WDK adapter 471

ProceduresRaising an IT support ticket using IT Express 357Customizing the MTBI2 Roadmap publishable template 417Customizing the MTBI2 Roadmap module template 418Fixing table row overflow errors 419




.

13.

IntroductionNortel Technical Documentation Application (NTDA) Processes andProcedures provides information on the NTDA system, tools, andauthoring procedures.

Navigation• "NTDA system overview" (page 15)

• "Installing and configuring Arbortext Editor 5.2" (page 27)

• "NonMTBI authoring" (page 51)

• "NonMTBI2 authoring" (page 67)

• "MTBI2 authoring" (page 99)

• "Documentum information and procedures" (page 129)

• "DLM information and procedures" (page 145)

• "Graphics information and procedures" (page 169)

• "Cloning tasks and procedures" (page 191)

• "File-naming conventions" (page 203)

• "Metadata assignment" (page 209)

• "Change bar management" (page 211)

• "NTDA profiling" (page 219)

• "NTDA publishing" (page 227)

• "Multistreaming options" (page 239)

• "Converting to NTDA" (page 249)

• "Migrating publishables from 5.1 to 5.2" (page 257)

• "Installing and configuring Epic Editor 5.1" (page 265)

• "Transforming from NonMTBI to NonMTBI2" (page 269)

• "NonMTBI2 to MTBI2 transform" (page 275)

• "NTDA FAQ" (page 345)

• "Training" (page 367)




.

14 Introduction

• "Common procedural modules" (page 371)

• "Citrix information and procedures" (page 427)

• "Webtop information and procedures" (page 439)




.

15.

NTDA system overviewThe following information provides an overview of the NTDA system,authoring tools, and processes.

Navigation• "NTDA components" (page 15)

• "NTDA authoring tools" (page 18)

• "Content development process" (page 21)

• "PC configuration" (page 22)

• "Authoring in structure" (page 23)

NTDA componentsThe NTDA consists of many components working together to getdocumentation out to our customers. Figure 1 "NTDA system overview"(page 16) illustrates the relationships between each component.




.

16 NTDA system overview

Figure 1NTDA system overview

Navigation

• "TS Portal" (page 17)

• "SAM and Clarify" (page 17)

• "Documentum" (page 17)

• "XML Editor " (page 17)

• "Legacy content" (page 17)

• "Delivery Repository" (page 17)

• "Release List" (page 17)

• "Admin users" (page 18)




.

NTDA components 17

TS PortalThe Technical Support (TS) Portal is the gateway for all content forall users internally and externally. The portal is designed to offer ourcustomers online self help service tools such as electronic softwaredelivery, access to a self help solutions database, easily searcheddocumentation, online case management and other tools. For moreinformation see http://nortel.com/support

The portal’s documentation site provides the relevant technicaldocumentation for all products listed. Documentation is divided first intoJob Function and then into specific documentation types for each jobfunction. This allows you to find all the documentation for a specific phaseof your network operations grouped together.

SAM and ClarifySAM and Clarify control all user access to the TS Portal.

DocumentumDocumentum is the database repository for all content under development.Documentum lets you access, use, reuse, and distribute informationquickly and easily. Publishables, modules, and graphics are storedin company repositories within Documentum called Docbases.Documentum allows our authors to access documents across differentdepartments and sites, and across different computer platforms.Furthermore, Documentum allows publishables to be imported fromyour local PC to the appropriate Docbase in Documentum. Assigningversion numbers to help keep track of revisions is also a featurewithin Documentum. For more information on Documentum go tohttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9793344.

XML EditorXML Editor is used to author content and the editor currently used isArbortext Editor. The Dynamic Link Manager (DLM) is used for linkmanagement within documents authored by Arbortext Editor.

Legacy contentLegacy Content includes Dots 2.0, DDMEZ, and Helmsman documents.

Delivery RepositoryDelivery Repository stores all content accessible to users.

Release ListRelease List is a web application that controls the publishing of documentsfrom Documentum and Legacy Content. For release list use cases seehttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9279230.




.

http://nortel.com/support

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>objId=9793344




Admin usersThe Admin users control access to Documentum and the DeliveryRepository.

NTDA authoring toolsNTDA uses a number of tools to author and publish all technicaldocumentation types. The NTDA System supports both MTBI andNonMTBI XML-based documentation. The overall intent is to migrateall Nortel customer documentation to an MTBI XML base over the nextfew years and to leverage the advantages of such a system for increasedefficiency and effectiveness in fulfilling our overall vision of Just for Me,Just Enough, Just in Time customer documentation. Figure 2 "NTDAauthoring tools" (page 18) illustrates the relationships between the tools.

Figure 2NTDA authoring tools

Authors use Arbortext Editor, and the applications within it, to create ourdocuments. These documents are stored within Documentum based onconfiguration rules. The Release List is created here and populates theDelivery Repository which contains both PDF and HTML versions of ourdocuments. They are then released to the TS Portal whereby the end usercan search and view all of our technical publications.

The NTDA terminology associated with the NTDA authoring tools isdefined in Table 1 "NTDA terminology" (page 19)




.

NTDA authoring tools 19

Table 1NTDA terminology

Tool Purpose

XML extensible markup language

DTD document type definition (nonmtbi, nonmtbi2 and mtbi2)

XSL extensible style language

SVG scaleable vector graphics

XHTML extensible hyper-text markup language

DLM dynamic link manager

MIR modularization and information reuse

Metadata set of pre-defined identifiers that describe information attributes

MTBI modular task-based information based on the Information Modeland MIR strategy

Editor iconsWithin Editor, icons appear to the left of objects. The icons appear in theDocument Map and in the Edit window. The display of icons that appear inthe Edit window is dependent on the settings of the showiconsfulltags,showiconspartialtags, and showiconsnotags commands (all with adefault setting of on). Available icontype names are case sensitive and arelisted in Table 2 "Icons and their use within Editor" (page 19).

Table 2Icons and their use within Editor

Icon Name Default use

Attribute Indicates that an element has attributesassigned to it.

BadAttribute Indicates that an element has attributesassigned to it and at least one of those attributesis not legal for the current document typedefinition.

BadElement Indicates an element whose position or elementname are not legal for the current documenttype definition.

CheckedOut Indicates a document object accessed by aRepository Adapter is locked or checked out bythe current user.

Contracted Indicates that the element’s contents arecollapsed and hidden from view.




.


Table 2Icons and their use within Editor (cont’d.)


DocObject Indicates a document object accessed by aRepository Adapter that is neither locked norchecked out.

Document Indicates a document.

Element Indicates an SGML or XML element.

Empty Indicates an element with no content.

End Indicates an end tag.

Expanded Indicates that the element’s contents areexpanded for viewing.

FileEntity Indicates a referenced file entity.

Graphic Indicates a graphic element.

GrayCheckedOut Indicates a document object accessed from aRepository Adapter that is locked or checked outby the current user but is unavailable.

GrayDocObject Indicates a document object accessed froma Repository Adapter that is neither lockednor checked out by the current user and isunavailable

GrayLocked Indicates a document object accessed from aRepository Adapter that is locked or checked outby another user and is unavailable.

Locked Indicates a document object accessed by aRepository Adapter is locked or checked out byanother user.

Missing Indicates where a required element is missing.




.

Content development process 21

Table 2Icons and their use within Editor (cont’d.)


ReadOnly Indicates a element that is not editable

Table Indicates a table element.

Content development processThe XML development process goes through a series of steps from authorto release coordinator.

Content development overviewTo see how each step in the process work together in the contentdevelopment process see Figure 3 "Content development process" (page21)

Figure 3Content development process

Content development tasksThe following defines each task involved in the content developmentprocess.




.


Project Management tasksProject management tasks define documentation project deliverables(Release List); develop or track project plan; override approval ofdocuments from Review to Approved state.

Design tasks

Design tasks both design and identify information blocks, objects, units tobe written or modified.

Authoring tasksAuthoring tasks edit information blocks, objects and units.

Review tasksReview tasks verify content for technical accuracy as well as verifyformatting.

Publishing tasksPublishing tasks submit or modify or delete documentation release list forpublishing; verify published content on staging package final document list(may include documentation release list plus additional items from othersources) for CD, print delivery; log file analysis

Administration tasksAdministration tasks schedule or manually trigger publishing processesoperation; log file analysis; site monitoring; create a master CD from a runlist

PC configurationThe following information describes how your PC should be configuredin the NTDA system.

Navigation• "Minimum requirements" (page 22)

• "PC desktops: current and refresh" (page 23)

• "Recommended PC specification" (page 23)

Minimum requirementsThe minimum PC configuration required for authoring in the NTDAenvironment is:

• Pentium 4, 3.0 GHz CPU with 2MB L2 cache; 1GB RAM, 80GB harddrive; 19-inch monitor.

• Windows 2000 Professional or Windows XP Professional operatingsystem.




.

Authoring in structure 23

• Documentum 5.2.5 SP3 and Arbortext Editor 5.2 M100 or greater(Documentum must be installed or upgraded before Arbortext Editor).

• Adobe Acrobat 7 or later

PC desktops: current and refreshAll current desktop hardware available for PC refresh within Nortel usea minimum of 1GB of RAM and meet the minimum requirements forauthoring in the NTDA environment.

A slower CPU on existing PCs is acceptable but 1GB RAM is required forall existing PCs that will be used for authoring in the NTDA environment.

When an author’s PC is ready to be refreshed, it is recommended that itbe replaced with the Nortel Desktop - Design Bundle rather than theDesktop – Standard Bundle. Why?

• 2GB and faster RAM instead of slower 1GB RAM

• 21-inch monitor instead of a 19-inch

• faster 80GB hard drive

• faster CPU

• faster video

The increased cost of the Desktop - Design Bundle will be easilyrecouped many times during the 5-year PC desktop lifecycle due toimproved author productivity.

Recommended PC specificationThe Desktop – Design Bundle specifications are available at http://navigate.us.nortel.com/imds?pg=/is/computer/pcrefresh/portfolio/des_dt

Authoring in structureStructure is defined as something arranged in a definite pattern oforganization. All content within customer documents produced byNortel follows a definite pattern of organization. For example, content iscontained in books, front covers, table of contents, chapters, paragraphs,lists, tables, figures, etc. These content containers are referred to ascontent elements. The relationship between content elements followcontent and editorial rules. For example, books contain chapters, headingsprecede paragraphs, paragraphs precede figures, etc. For furtherbackground reading go to Structured Authoring and XML (Scriptorium)




.

http://navigate.us.nortel.com/imds?pg=/is/computer/pcrefresh/portfolio/des_dt

http://navigate.us.nortel.com/imds?pg=/is/computer/pcrefresh/portfolio/des_dt



Navigation

• "Using Unstructured FrameMaker" (page 24)

• "Using Structured FrameMaker" (page 25)

• "Using Arbortext Editor" (page 25)

Using Unstructured FrameMakerDocument structure (page layout, paragraph formats, character formats,variables, table formats, and cross-references) is controlled by the useof a template (usually based on some form of the Nortel TechnicalDocumentation Standard).

The correct application of template elements is author controlled viaselection, guided by a template user guide, of the appropriate element andattributes through the tool interface. The template can be, and often is,modified by authors.

Documents produced via templates are very structured and often look thesame. However, local template modifications have led to the proliferationof templates across groups along with an associated ongoing maintenancecost for each group. See Figure 4 "Unstructured Frame view" (page 24)

Figure 4Unstructured Frame view




.

Authoring in structure 25

Using Structured FrameMakerStructure is implemented and controlled by the Element DefinitionDocument (EDD). Application of elements and attributes is controlledby authors via selection from tool interface. Less local modification ispossible. See Figure 5 "Framemaker structure view" (page 25)

Figure 5Framemaker structure view

Using Arbortext EditorWhen using Arbortext Editor structure is implemented and controlled by anXML-based DTD (document type definition). Application of elements andattributes is controlled by authors via selection from tool interface. SeeFigure 6 "Using Arbortext view" (page 26)




.


Figure 6Using Arbortext view




.

27.

Installing and configuring ArbortextEditor 5.2

The following procedural information shows how to install and configureArbortext Editor 5.2.

Navigation• "Uninstalling Epic Editor 5.1" (page 27)

• "Installing Arbortext Editor 5.2 " (page 28)

• "Installing Editor 5.2 Nortel customizations " (page 40)

— "Using Editor 5.2 Nortel customizations " (page 42)

• "Setting 5.2 environment variables" (page 44)

• "Setting up Arbortext Editor 5.2" (page 45)

• "Changing Arbortext License Manager Host" (page 47)

• "Changing the DocBroker Host" (page 47)

• "Uninstalling Arbortext Editor 5.2" (page 48)

Uninstalling Epic Editor 5.1Use the following procedure to uninstall Epic Editor 5.1 from your desktop.

Procedure Steps

Step Action

1 From your tool bar click Start, Run and enter the followingcommand:

“path_to_epic_software\Epic\bin\epic.exe” -UnRegAnyServer

2 If you get a COM unregisteration failed message, click OK.




.

28 Installing and configuring Arbortext Editor 5.2

3 From the tool bar select Start, Programs, Arbortext, UninstallEpic 5.1 to uninstall Epic 5.1.

Attention: If you get a message that some items could not bedeleted ignore it.

4 Restart your PC.

5 Delete the complete Arbortext directory in your C or D ProgramFiles directory).

6 Right-click My Computer, select Properties, Advanced,Environment Variables.

7 If they exist Delete the following in the User and SystemEnvironment Variables sections: APTLMHOST,APTPNGUSERES, APTPRFWCF, and HOME

.

--End--

Installing Arbortext Editor 5.2Use the following procedure to install Arbortext Editor 5.2 on your PC.

Procedure Steps

Step Action

1 On your PC, create an Epic 5.2 Install folder.

2 From Livelink location http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=21041820 , download into your Epic5.2 Install folder the Editor_5-2_ software_installer.zip andarb52-M100-win.zip files.

3 Unzip Editor_5-2_software_installer.zip into your Epic 5.2Install folder. The unzipped folder will be created.




.



Installing Arbortext Editor 5.2 29

Attention: Disk space needed: Installer-193MB;Application-620MB.

4 Within the Epic 5-2 software installer folder, double-clickSETUP.EXE. The Arbortext Editor 5.2 - InstallShield Wizard Boxappears.

5 In the InstallShield Wizard welcome box click Next.

6 In the InstallShield Wizard country and language box verifythat U.S., Canada, Mexico, Central America, South America,Others not listed below (English) is highlighted. Click Next.

7 In the InstallShield Wizard license and agreement box clickAccept.




.


8 In the InstallShield Wizard products box verify that theAbortext Editor 5.2 and Create desktop icons for eachinstalled product. check boxes are selected. Click Next.

9 In the InstallShield Wizard file types box deselect all file typesto associate with Arbortext Editor. Click Next.




.


10 In the InstallShield Wizard file types box verify English (US) ishighlighted. Click Next.

11 Install Arbortext Editor on the disk where you have the mostspace (usually in the C or D drive). For example, D:\ProgramFiles\Arbortext\Editor\. Click Change.




.


Browse to the destination folder. Click OK.

Click Next.




.


12 In the InstallShield Wizard select type box verify select theCustomoption. Click Next.

13 In the InstallShield Wizard Custom Setup box select therequired program features select the drop-down arrow and selectThis feature will be installed on local hard drive.

Select the following features:

• Dynamic Link Manager

• Print Composer

• Optional Adapters, Adapter to Documentum




.


• Optional Adapters, XML and Adapter to Documentum

• Optional Adapters, WDK

Click Next.

14 In the InstallShield Wizard Licensing box select Both typesof licenses. Click Next.

15 In the InstallShield Wizard Using Arbortext PublishingEngine box check Using an Arbortext Publishing Engineserver. In the URL box type 47.10.32.186.




.


16 In the InstallShield Wizard Concurrent License Server boxenter in 47.10.32.186 as the concurrent license server.

17 In the InstallShield Wizard Ready to Install the Program clickInstall.




.


Arbortext 5.2 will install on your PC.

18 In the InstallShield Wizard Completed box verify that RunLicense Administrator now. is checked. Click Finish.




.


19 In the ArbortextLM: Install Key box enter your Epic Editor v4install key.

Attention: For Nortel staff, you can retrieve your Epic Editorlicense from http://paygo.ca.nortel.com/cgi-bin/lq_welcome.cgi?products+0

In the ArbortextLM success box click OK.

20 In the ArbortextLM: Install Key box click Exit.




.

http://paygo.ca.nortel.com/cgi-bin/lq_welcome.cgi?products+0

http://paygo.ca.nortel.com/cgi-bin/lq_welcome.cgi?products+0


21 Navigate to your Epic 5-2 software installer folder, double-clickSETUP.EXE. The Arbortext Editor 5.2 - InstallShield Wizard Boxappears.

22 Click Next until you have arrived to the InstallShield WizardFile Types box. Check all files. Click Next.

23 Continue to click Next until you arrive at the InstallShieldWizard Ready to Install the Program and click Install. ClickFinish.

24 Navigate to your Epic 5-2 software installer folderand Unziparb52-M100-win.zip into your ProgramFiles\Arbortext\Editor directory. Overwrite all files and folderswith the same name.




.


25 Select Start, Run and enter the command regsvr32 “Editor5.2 install path \adapters\epicdctm5.dll”

Click OK.

The RegSvr32 succeeded box appears.

Click OK.

--End--




.


Installing Editor 5.2 Nortel customizationsUse the following procedure to install Editor 5.2 Nortel customizations.

Attention: This procedure must be done before any transform andwhenever customizations are updated or added.

Procedure Steps

Step Action

1 Close all Arbortext Editor sessions.

2 Delete the .aptcache folder in your local Arbortext/Editor/custom folder.

3 Download Editor_5-2_Nortel_custom from http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objid=21041820.

4 Unzip Editor_5-2_Nortel-custom.zip to your desktop to createthe Editor_5-2 Nortel-custom folder.

5 Move the contents of each folder in Editor_5-2 Nortel-customto the folder with the same name your local Arbortext/Editor/custom folders that are as follows:

• classes

• dialogs

• editinit

• init

• lib

• scripts

6 If there is a problem in installing and using the Editorcustomizations, check for an APTCUSTOM environmentvariable; if there is, delete it. Right-click My Computer and thenselect Properties, Advanced, Environment Variables.

7 Check out any document of each doctype, and then immediatelycancel the checkout, to get the latest DTD files.

--End--

Job aidThe custom folders shown should only contain the files listed below;delete all other files (eg memory.acl) and replace existing files that havethe same names.




.

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>objid=21041820

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>objid=21041820

Installing Editor 5.2 Nortel customizations 41

Folder name Files

classes • cyclops.jar

• dlmclientvalidation.jar

• tools.jar

dialogs • dlmclientvalidation.xml

editinit • image-size.acl

init • 0memory.acl

• allcondtext.acl

• batchmigrate.acl

• blank-nonmtbi2.acl

• changebars.acl

• changed_link_deleted_validator.js

• checkurls.acl

• clean-unused-entities.acl

• dlmclientvalidation.acl

• dlmlinkfosi.acl

• dupe_link_id_validator.js

• findNoTargetLinks.js

• findUnregisteredLinks.js

• fix_del_markers.acl

• fix-intro-proc.acl

• fix_link_readds.js

• fix-text-entities-for-dtd2.acl

• gentextupdate.acl

• link_id_validator.js

• post-mtbi2.acl

• prep-tool.acl

• profile-reports.acl

• read_only_link_validator.js

• deletecondtext.acl

• space.acl

• target_not_in_doc_validation.js

• validation_label_generator.acl




.


Folder name Files

Attention: In 0memory.acl, you may need to changejavavmmemory from 768 to 512 or 268

lib • global.dlmcf

Attention: If they exist, do not remove dll or locale

scripts • comp_pdf1.acl

• content_handling.acl

• date_converter.acl

• dlm_e3.acl

• link_finder.acl

• no-heading.acl

• note_handling.acl

• ntda-text-entities.acl

• ntp_hooks.acl

• ntp_setup.acl

• replace_space.acl

• section_toc_handling.acl

• spaces.acl

• val_seqnums.acl

Using Editor 5.2 Nortel customizationsEditor 5.2 Nortel customization commands are available from the Nortelmenu at the end of the main menu bar and, for nonmtbi, from the File,Compose menu.

The instance.acl file adds the customization commands to eachmenu and it is stored and maintained in the DTD folder within eachDocumentum docbase. The latest version is automatically downloadedwhen a document is checked out of Documentum




.

Installing Editor 5.2 Nortel customizations 43

Menu item Use

Add/update manually-added targettext

Adds step/item numbers to target elements within proceduresteps or ordered lists (custom/scripts/link_finder.acl).Processing results are recorded in fix_manually_added_targets.log

Add/update CVoIP text entities Adds or updates SN09u, SN10, or cvm11 text entitiesfrom entities-config.acl stored in the DTD folder(custom/scripts/ntda-text-entities.acl).Processing results are recorded in update_text_entities.log

Change the status of DLM links Changes the status of previously-added DLM links fromAdded to Unchanged (custom/init/fix_link_readds.js).

Check for URLs longer than 127characters

Checks for URLs longer than 127 characters (custom/init/checkurls.acl)

Check for illegal characters inheadings

Verifies that headings, title, captions, and targetText do notcontain illegal characters (custom/classes/tools.jar)

Check the size of the currentimage

Checks the size of the currently selected image(custom/editinit/image-size.acl)

Check the size of the currentimage

Checks the size of the currently selected image(custom/editinit/image-size.acl)

Clear ChangeBars in document Clears all ChangeBar attributes within a document, asks ifthey should be cleared if Delete is set and notes if there areread-only modules (custom/init/changebars.acl)

Clear ChangeBars in element Clears all ChangeBar attributes in selected elements, asks ifthey should be cleared if Delete is set and notes if there areread-only modules (custom/init/changebars.acl)

Delete all profile attributes fromchunkable elements

Remove all profile attributes from Chapter, Module andTerminology elements (custom/init/deletecondtext.acl)

Delete spurious namespaceattributes

Deletes namespace (xmlns) attributes that should not be inXML source files (custom/init/post-mtbi2.acl)

Find invalid sequence numbers inDLM links

Find links containing invalid sequence numbers(custom/scripts/val_seqnums.acl)

Find targetText in elements withno headings

Finds elements without optional headings with targetTextpopulated (custom/scripts/no-heading.acl)

Find unregistered DLM links Finds unregistered DLM links (custom/init/findUnregisteredLinks.js)

List links within CondText withunspecified ct-Content values

Finds and lists links within CondText element with unspecifiedct-Content values (custom/init/allcondtext.acl)

NonMTBI2 to MTBI2 prep-tool Identifies how well a NonMTBI2 document meets transformprerequisites (custom/init/prep-tool.acl)

PDF file with Bookmarks Used with nonmtbi documents (custom/scripts/comp_pdf1.acl)and the PDFnonmtbiWBM stylesheet




.


Menu item Use

Delete NonMTBI2 DCTMattributes

Deletes all DCTM attributes, except from Read-Only, in preparation for transforming to MTBI2 (custom/init/prep-tool.acl)

Pre-convert text entities Use before transforming a document (custom/init/fix-text-entities-for-dtd2.acl)

Post-convert text entities Use after transforming a document (custom/init/fix-text-entities-for-dtd2.acl)

Post-MTBI2: Change NonMTBI2transformed attribute to yes

Changes the value of transformed attribute from no toyes in NonMTBI2 modules that have been transformed(custom/init/post-MTBI2.acl)

Profile Usage Reports Lists the profile attributes used in modules (custom/init/profile-reports.acl)

Record DLM logs in dlm_client.log Creates a dlm_client.log file in the same folder as the sourceXML file (usually Documentum/Checkout)

Remove unused text entities Removes unused text entities (custom/init/clean-unused-entities.acl)

Replace NonMTBI2 Introductionwithout siblings with SectionBody

Replaces a NonMTBI2 Introduction with a SectionBody inSections that do not have child Sections (custom/init/fix-intro-proc.acl)

Replace ObjectName pi andIdentifier values

The NonMTBI2 to MTBI2 transform script auto-populatesthe ObjectName attribute of MTBI2 modules created fromNonMTBI2 Sections; it uses XX for pi and TRANSFORM forIdentifier in pimm_Identifier_Title, where pi is the productidentifier; mm is the module type; Identifier identifies theauthoring group; Title identifies the Section." This commandprompts for pi and Identifier values to be used to replace theXX and TRANSFORM values (custom/init/post-mtbi2.acl)

Replace spaces in CliResponse,Command, and GuiResponse

Replace spaces with an en-space and a zero-width-spacecombination; this is to ensure that multiple spaces arerecognized and allows hyphenation to break correctly for longtext in these elements (custom/init/space.acl)

Validate Links… Count Finds the total number of links in the current document(custom/init/dlmclientcustomization.acl)

Validate Links… Document Validates all links in current document & fixes commonproblems (custom/init/dlmclientcustomization.acl)

Validate Links… Element Validates all links in current element & fixes commonproblems (custom/init/dlmclientcustomization.acl)

Setting 5.2 environment variablesUse the following procedure to set your 5.2 environment variables.




.

Setting up Arbortext Editor 5.2 45

Procedure Steps

Step Action

1 Exit from all Arbortext Editor sessions.


3 Right-click My Computer and select Properties.

4 Select Advanced, Environment Variables.

5 Verify that APTLMHOST is set to @47.10.32.186.

6 Under User variables, click New.

7 For Variable Name, type APTPNGUSERES.

8 For Variable Value, type yes.

9 Click OK.


11 For Variable Name, type HOME.

12 For Variable Value, type the path to where you want to store theepic epic.wcf file and the .aptcache directory.

13 Click OK.

14 Click OK in the Environment Variables window.

The Environment Variables window closes.

15 Click OK in the System Properties window.

The System Properties window closes.

--End--

Setting up Arbortext Editor 5.2Use the following procedure to set up your Arbortext Editor 5.2 properties.




.


Prerequisites

• The location of Arbortext Editor cache and windows configuration fileshave been set, see "Setting 5.2 environment variables" (page 44).

Procedure Steps

Step Action

1 Delete the .aptcache folder in your local Arborttext/Editor/custom folder.

2 Open Arbortext Editor and select Tools, Preferences.

3 Click Windows and click Full Menus and Command Line.

4 Click Advanced; locate and set:

• fileentityfontcolor to blue

• fosiwarnings to off

• gentextautoupdate to none

• gentextwarnings to 0

• savewindowconfiguration to yes

• usedistiller to off

• writeaticomment to off

• peservices to on

5 Set the peserverurl to one of the following:

• Nortel staff: http://47.10.32.229:8080/e3/servlet/e3/ (ztcfs0n8)

• Vendor staff: http://47.10.32.186:8080/e3/servlet/e3/(ztcfs0mh)

• Testing: http://47.10.32.150:8080/e3/servlet/e3/ (ztcfs0m2)

6 Click Close an then click OK.

7 Click File, Exit and click Yes to save the configuration file.




.

Changing the DocBroker Host 47

Attention: When opening a document, you may be promptedto locate a DTD for the document, browse to your localDocumentum/XML Applications/ecmprod folder and click therequired DTD.

--End--

Changing Arbortext License Manager HostThe Arbortext License Manager Host is stored as an EnvironmentVariable. Only execute this procedure if you have problems.

Procedure Steps

Step Action

1 Exit from Arbortext Editor.



4 Browse to User variable APTLMHOST, select Edit and changevalue to new_value. Click OK.

5 Click OK in Environment Variables window.

6 Click OK in System Properties window.

--End--

Changing the DocBroker HostDocumentum DocBroker Host is stored in file DMCL.INI. Only execute thisprocedure if you have problems.

Procedure Steps

Step Action

1 Log Off from all Documentum Docbases.

2 Click Windows Start, Run.

3 Type dmcl.ini and click OK.




.


4 Type an octothorpe (#) before the current host.

5 Type: host = new_docbroker_host

6 Click File, Exit and Yes to save the changed file.

The new Documentum DocBroker host will be used when youLog On to a Docbase.

--End--

Uninstalling Arbortext Editor 5.2Use the following procedure to uninstall Arbortext Editor 5.2.

Procedure Steps

Step Action

1 On your PC, issue the following Start, Run command:“Editor 5.2 install path\Editor\bin\epic.exe”–UnRegAnyServer.




.

Uninstalling Arbortext Editor 5.2 49

2 Uninstall Arbortext Editor from the Start, Settings, ControlPanel, Add/Remove Programs option.

3 Restart your PC.

4 Delete the Arbortext\Editor installation directory.

5 Delete, if they exist, the following User and System EnvironmentVariables:

• APTLMHOST

• APTPNGUSERES

• APTPRFWCF

• HOME

--End--




.





.

51.

NonMTBI authoringUse the information herein to author documents using the NonMTBIdoctype.

NonMTBI authoring tasksThis work flow shows you the sequence of tasks you perform to authora NonMTBI publishable. To link to any task, go to "NonMTBI authoringnavigation" (page 52)

Figure 7NonMTBI authoring task flow




.

52 NonMTBI authoring

NonMTBI authoring navigation• "NonMTBI variable options" (page 52)

• "NonMTBI module authoring" (page 52)

• "NonMTBI publishable building" (page 54)

• "Editing a NonMTBI document" (page 57)

• "NonMTBI PDF generation with reuse" (page 59)

• "NonMTBI PDF generation without reuse" (page 61)

• "NonMTBI PDF generation with profiled content" (page 63)

• "Splitting NonMTBI publishable into 2 volumes" (page 64)

NonMTBI variable optionsThe following information describes variables that are used within aNonMTBI publishable.

Within Arbortext Editor, the equivalent of FrameMaker variables areEntities.

Entities are blocks of content that you want to be able to use repeatedly.Documents that contain entities are automatically updated when thecontent of the entity is changed. You can create text entities or file entities.

Within nonmtbi, use text entities for local variables; that is, variables usedonly within a single Documentum object. Do not use file entities. You canuse them in the following ways:

• If text entities are defined in a publishable object, they can only be usedby modules within that publishable.

• If text entities are defined in a module object, the module, completewith text entities, can be used in multiple publishables.

NonMTBI module authoringCreate multiple NonMTBI modules to compile into a NonMTBI publishable.

Prerequisites to NonMTBI module authoring

• Download GDE-NTDA_templates from ecmprod/Templates/NTDAin Documentum.

• Unzip GDE-NTDA_templates and move the Templates folder intoyour local Documentum/XML Applications/ecmprod folder.




.

NonMTBI module authoring 53

NonMTBI module authoring tasksThis task flow shows you the sequence of tasks you perform to authora NonMTBI module. To link to any task, click on the task in "NonMTBImodule authoring navigation" (page 54).

Figure 8NonMTBI module authoring task flow




.


NonMTBI module authoring navigation

• "Saving NonMTBI module template" (page 423)

• "Modifying module attributes" (page 375)

• "Inserting elements" (page 376)

• "Linking to graphics" (page 184)

• "Inserting a citation" (page 371)

• "Inserting DLM links" (page 146)

• "Applying formatting" (page 378)

• "Creating an index" (page 379)

• "Creating a text entity" (page 381)

• "Checking completeness" (page 382)

• "Fixing content errors" (page 382)

• "Registering a document with DLM" (page 155)

• "Fixing DLM errors" (page 161)

• "Validating DLM links" (page 158)

• "Checking module into Documentum" (page 383)

NonMTBI publishable buildingImport NonMTBI modules to build the NonMTBI publishable.

NonMTBI publishable building proceduresThis task flow shows you the sequence of tasks you perform to build aNonMTBI publishable. To link to any task, click on the task in "NonMTBIpublishable building navigation" (page 56).




.

NonMTBI publishable building 55

Figure 9NonMTBI publishable building task flow




.


Figure 10NonMTBI publishable building task flow continued

NonMTBI publishable building navigation

• "Saving NonMTBI publishable template" (page 424)

• "Modifying publishable attributes" (page 383)




.

Editing a NonMTBI document 57

• "Pasting modules using object references" (page 384)

• "Inserting text entity" (page 384)

• "Inserting a Terminology module" (page 385)



• "Checking publishable into Documentum" (page 385)

• "Checking file out of Documentum" (page 386)

• "Inserting intra-document DLM links" (page 160)




• "Saving the DLM link validation report" (page 158)

• "Checking in file into Documentum as minor version" (page 387)

Editing a NonMTBI documentTo edit your document and keep the changes you must check thedocument out and back into Documentum.

Editing a NonMTBI document proceduresThis task flow shows you the sequence of tasks you perform to edit theNonMTBI documents. To link to any task, click on the task in "Editing aNonMTBI document navigation" (page 58).




.


Figure 11Editing a NonMTBI document task flow

Editing a NonMTBI document navigation











.

NonMTBI PDF generation with reuse 59








NonMTBI PDF generation with reuseComplete the necessary verifications to generate a PDF from a NonMTBIxml source.

NonMTBI PDF generation with reuse tasksThis task flow shows you the sequence of tasks you perform to generate aPDF from a NonMTBI source file. To link to any task, click on "Generatinga PDF from a NonMTBI publishable navigation" (page 60).




.


Figure 12NonMTBI PDF generation task flow

Generating a PDF from a NonMTBI publishable navigation

• "Verifying local environment variables" (page 387)

• "Verifying preferences" (page 388)






.

NonMTBI PDF generation without reuse 61




• "Generating a NonMTBI PDF with reuse" (page 425)

NonMTBI PDF generation without reuseComplete the necessary verifications to generate a PDF from a NonMTBIxml source that does not contain reuse.

NonMTBI PDF generation without reuse tasksThis task flow shows you the sequence of tasks you perform to generatea PDF from a NonMTBI source file that does not contain reuse. To linkto any task, click on




.


Figure 13NonMTBI PDF generation without reuse tasks

NonMTBI PDF generation without reuse navigation








.

NonMTBI PDF generation with profiled content 63




• "Generating a NonMTBI PDF without reuse" (page 426)

NonMTBI PDF generation with profiled contentCreate a neutral version of the NonMTBI source file with profiled content togenerate a PDF.

NonMTBI PDF generation with profiled content tasksThis task flow shows you the sequence of tasks you perform to generatea PDF from a NonMTBI source file that does not have reuse. To link toany task, click on

Figure 14NonMTBI PDF generation with profiled content task flow




.


NonMTBI PDF generation with profiled content navigation







• "Disabling the DLM server connection" (page 159)

• "Creating a neutral version of the NonMTBI document" (page 388)

• "Enabling the DLM server connection" (page 159)

• "Verifying the neutral version of the NonMTBI document" (page 389)

• "Generating a NonMTBI PDF with profiled content" (page 390)

Splitting NonMTBI publishable into 2 volumesTaking a large NonMTBI publishable and splitting it into 2 volumes.

Splitting NonMTBI publishable tasksThis task flow shows you the sequence of tasks you perform to split aNonMTBI publishable into 2 voluems. To link to any task, click on "SplittingNonMTBI publishable navigation" (page 65)




.

Splitting NonMTBI publishable into 2 volumes 65

Figure 15Splitting NonMTBI publishable flowchart

Splitting NonMTBI publishable navigation

• "Exporting original file" (page 411)

• "Renaming file v2" (page 411)


• "Modifying v1 file" (page 412)




.









• "Checking in v1 as same version" (page 412)

• "Deleting v1 content in v2" (page 413)








• "Checking in v2 as same version" (page 413)




.

67.

NonMTBI2 authoringUse the information herein to author documents using the NonMTBI2doctype.

NonMTBI2 authoring tasksThis work flow shows you the sequence of tasks you perform to author aNonMTBI2 publishable. To link to any task, go to "NonMTBI2 authoringnavigation" (page 68)




.

68 NonMTBI2 authoring

NonMTBI2 authoring navigation• "Checklist for editing NonMTBI2 CVoIP modules" (page 68)

• "Creating NonMTBI2 variables" (page 71)

• "NonMTBI2 module authoring" (page 73)

• "NonMTBI2 publishable building" (page 75)

• "Editing a NonMTBI2 document" (page 78)

• "NonMTBI2 PDF generation with reuse" (page 80)

• "NonMTBI2 PDF generation without reuse" (page 82)

• "NonMTBI2 PDF generation with profiled content" (page 84)

• "NonMTBI2 content models" (page 86)

Checklist for editing NonMTBI2 CVoIP modulesThe following are checklists for editing NonMTBI2 CVoIP modules.

Navigation• "Checklist for editing NonMTBI2 modules" (page 68)

• "Checklist for editing a NonMTBI2 upgrades module" (page 69)

Checklist for editing NonMTBI2 modulesUse the following checklist with all modules except for CVoIP Upgradeones.

• Never register a Send To copy of a module

• Never copy any content containing a DLM link

• Validate links to profiled content, ensure that all links to profiled contentinclude at least one of the profile values included on the target element

• Before deleting or replacing content that contains a DLM target id:

— 1. Click Tools, Dynamic Link Manager, Where Used. Thiscommand returns a list of links pointing to the selected target.

— 2. If there are any, delete links pointing to the target and thenreinsert any new links required.

• To create a PDF File of a module containing profiles:

— 1. Close all Arbortext Editor sessions. Disable DLM. Open modulewith Arbortext Editor.

— 2. Click File, Compose, Using XSL specify the neutralNonMTBI2.xsl stylesheet, set the required profiles, Save Asprofiled-filename.xml; click OK.

— 3. Close Editor without saving the file. Enable DLM. Openprofiled-filename.xml with Editor.




.

Checklist for editing NonMTBI2 CVoIP modules 69

— 4. If there are errors, identify their location and close Editor; enableDLM; open the original module and fix the errors, save the module,and then repeat procedure from Step 1.

— 5. Type blanknonmtbi2() after the Arbortext Editor Command:prompt.

— 6. Click Nortel, Add/update link text for manually-added targets.

— 7. Type spaces::remove() after the Arbortext Editor Command:prompt.

— 8. Click on File, Compose, PDF File and select NonMTBI2 v5.2PDF Stylesheet.

Attention: If you need to display the publishable content status, useDocStatus Standard NonMTBI2 PDF Stylesheet.

— 9. Close Editor. Delete profiled-filename.xml and the associatedfolder created during Step 2.

• When changing profiles on elements that contain a DLM target id,check to see if there any links pointing to the target and that theycontain the correct profiles (use the DLM Where Used option to findlinks).

• When inserting links, ensure you are linking to the correct DLM targetid; if the target is profiled, the link must include at least one of theprofile values included on the target element.

• Verify that all links only include one DLM target id.

• After adding, updating, or deleting links always register and validate:

— 1. Click Tools, Dynamic Link Manager, Register, Document.

— 2. Click Nortel, DLM, Validate Links, Document and save themodule.

— 3. If the DLM Validation Report contains errors, fix them and startagain at Step 1.

• Chapters re-used between publishables must be identical; if youneed to add or delete a module in the reused Chapter for a specificpublishable, you will have to create a new Chapter in that publishable.

• After registering a module, always check it back into Documentum.

• Before checking in any document, always close all Arbortext Editorsessions.

Checklist for editing a NonMTBI2 upgrades moduleUse the following checklist with modules used in the -450 or -211.




.


• Never register a Send To copy of a module.

• Never copy any content containing a DLM link.

• Validate profiled links, on the Editor Command: prompt, type:condtext::links450() for links used in the NN10440-450.

Or condtext::links211() for links used in the NN20000-211.

These scripts return a list of links that have been profiled with valuesdifferent than those used for the specified publishable

• Before deleting or replacing content that contains a DLM target id:

— 1. Click Tools, Dynamic Link Manager, Where Used.This command returns a list of links pointing to the selected target.

— 2. If there are any, delete links pointing to the target and thenreinsert any new links required.

• To create a PDF File of a module containing profiles:

— 1. Close all Editor sessions. Disable DLM. Open module withEditor.

— 2. Click File, Compose, Using XSL specify the neutralNonMTBI2.xsl stylesheet, set the required profiles, Save Asprofiled-filename.xml; click OK.

— 3. Close Editor without saving the file. Enable DLM. Openprofiled-filename.xml with Editor.

— If there are errors, identify their location and close Editor; enableDLM; open the original module and fix the errors, save the module,and then repeat procedure from Step 1.

— 4. Type blanknonmtbi2() after the Arbortext Editor Command:prompt.

— 5. Click Nortel, Add/update link text for manually-added targets.

— 6. Type spaces::remove() after the Arbortext Editor Command:prompt.

— 7. Click File, Compose, PDF File and select NonMTBI2 v5.2 PDFStylesheet.


— 8. Close Arbortext Editor. Delete profiled-filename.xml and theassociated folder created during Step 2.

• When changing profiles on elements that contain a DLM target id,check to see if there any links pointing to the target and that theycontain the correct profiles (use the DLM Where Used option to findlinks).




.

Creating NonMTBI2 variables 71

• When inserting links, ensure you are linking to the correct DLM targetid; if the target is profiled, the link must include at least one of theprofile values included on the target element.

• Verify that all links only include one DLM target id.

• After adding, updating, or deleting links always register and validate:

— 1. Click Tools, Dynamic Link Manager, Register, Document.— 2. Click Nortel, DLM, Validate Links Document and save module.

— 3. If the DLM Validation Report contains errors, fix them and startagain at Step 1.

• Chapters re-used between publishables must be identical; if youneed to add or delete a module in the reused Chapter for a specificpublishable, you will have to create a new Chapter in that publishable.

• After registering a module, always check it back into Documentum.

• Before checking in any document, always close all Arbortext Editorsessions.

Creating NonMTBI2 variablesThe following shows the order and dependencies of procedures to create aNonMTBI2 variable.

Creating variables proceduresThis task flow shows you the sequence of tasks you perform to build aNonMTBI2 publishable. To link to any task, click on the task in




.


Figure 16Creating variables task flow

Creating variables navigation

• "Saving the NonMTBI2 variable template" (page 390)

• "Modifying variable attributes" (page 391)




.

NonMTBI2 module authoring 73












• "Importing variable into Documentum" (page 420)

NonMTBI2 module authoringCreate multiple NonMTBI modules to compile into a NonMTBI publishable.

Prerequisites to NonMTBI2 module authoring



NonMTBI2 modules authoring proceduresThis task flow shows you the sequence of tasks you perform to author aNonMTBI2 module. To link to any task, click on the task in "NonMTBI2authoring navigation" (page 68).




.


Figure 17NonMTBI2 modules authoring task flow

NonMTBI2 module authoring navigation

• "Saving NonMTBI2 module template" (page 391)



• "Using a shared variable" (page 391)










.

NonMTBI2 publishable building 75






NonMTBI2 publishable buildingImport NonMTBI2 modules to build the NonMTBI2 publishable.

NonMTBI2 publishable building proceduresThis task flow shows you the sequence of tasks you perform to build aNonMTBI2 publishable. To link to any task, click on the task in "NonMTBI2publishable building navigation" (page 77).




.


Figure 18NonMTBI2 publishable building task flow




.

NonMTBI2 publishable building 77

Figure 19NonMTBI2 publishable building task flow

NonMTBI2 publishable building navigation

• "Saving NonMTBI2 publishable template" (page 392)






.



• "Inserting a Terminology module" (page 385)

• "Setting document heading numbering" (page 392)

• "Setting the display of Nortel confidential" (page 394)











Editing a NonMTBI2 documentTo edit your document and keep the changes you must check thedocument out and back into Documentum.

Editing a NonMTBI2 document proceduresThis task flow shows you the sequence of tasks you perform to edit theNonMTBI2 documents. To link to any task, click on the task in "Editing aNonMTBI2 document navigation" (page 79).




.

Editing a NonMTBI2 document 79

Figure 20Editing a NonMTBI2 document task flow

Editing a NonMTBI2 document navigation









.











NonMTBI2 PDF generation with reuseComplete the necessary verifications to generate a PDF from a NonMTBI2xml source that has reuse.

NonMTBI2 PDF generation with re-used modules proceduresThis task flow shows you the sequence of tasks you perform to generate aPDF from a NonMTBI2 source file that has reuse. To link to any task, clickon "NonMTBI2 PDF generation with reuse navigation" (page 81).




.

NonMTBI2 PDF generation with reuse 81

Figure 21NonMTBI2 PDF generation with reuse task flow

NonMTBI2 PDF generation with reuse navigation






.







• "Generating a NonMTBI2 PDF with reuse" (page 394)

NonMTBI2 PDF generation without reuseComplete the necessary verifications to generate a PDF from a NonMTBI2xml source that does not reuse its modules.

NonMTBI2 PDF generation without re-used modules proceduresThis task flow shows you the sequence of tasks you perform to generatea PDF from a NonMTBI2 source file that does not have reuse. To link toany task, click on "NonMTBI2 PDF generation without reuse navigation"(page 83)




.

NonMTBI2 PDF generation without reuse 83

Figure 22NonMTBI2 PDF generation without reused modules flowchart

NonMTBI2 PDF generation without reuse navigation






.







• "Generating a NonMTBI2 PDF without reuse" (page 395)

NonMTBI2 PDF generation with profiled contentCreate a neutral version of the NonMTBI2 source file with profiled contentto generate a PDF.

NonMTBI2 PDF generation with profiled content tasksThis task flow shows you the sequence of tasks you perform to generatea PDF from a NonMTBI2 source file that does not have reuse. To link toany task, click on




.

NonMTBI2 PDF generation with profiled content 85

Figure 23NonMTBI2 PDF generation with profiled content task flow

NonMTBI2 PDF generation with profiled content navigation










.


• "Creating a neutral NonMTBI2 document" (page 396)


• "Verifying neutral NonMTBI2 document" (page 397)

• "Generating a NonMTBI2 PDF with profiled content" (page 399)


NonMTBI2 content modelsThis reference information contains the content models available in eachelement of the nonmtbi2dtd.

The meaning of the symbols used in all content models are:

Symbol Meaning

* 0 or more

+ 1 or more

? 0 or 1

Navigation• "NonMTBI2 Front elements" (page 86)

• "NonMTBI2 Body elements" (page 88)

• "NonMTBI2 Back elements" (page 96)

NonMTBI2 Front elements

• "NonMTBI2 PublicationMetadata elements" (page 87)

• "NonMTBI2 PublicationHistory elements" (page 87)

• "NonMTBI2 Frontmatter elements" (page 88)




.

NonMTBI2 content models 87

NonMTBI2 PublicationMetadata elements

NonMTBI2 PublicationHistory elements




.


NonMTBI2 Frontmatter elements

NonMTBI2 Body elements

• "NonMTBI2 Chapter elements" (page 89)

• "NonMTBI2 Introduction elements" (page 89)

• "NonMTBI2 Module elements" (page 90)

• "NonMTBI2 Section elements" (page 90)

• "NonMTBI2 Procedure elements" (page 91)

• "NonMTBI2 common elements" (page 92)




.


NonMTBI2 Chapter elements

NonMTBI2 Introduction elements




.


NonMTBI2 Module elements

NonMTBI2 Section elements




.


NonMTBI2 Procedure elements




.


NonMTBI2 common elementsThis section contains elements used by other elements:

• "NonMTBI2 IndexTerm elements" (page 93)

• "NonMTBI2 Figure elements" (page 93)

• "NonMTBI2 List elements" (page 93)

• "NonMTBI2 Note element" (page 94)




.


• "NonMTBI2 Paragraph element" (page 94)

• "NonMTBI2 Example element" (page 94)

• "NonMTBI2 Precaution elements" (page 95)

• "NonMTBI2 Where element" (page 95)

• "NonMTBI2 Table elements" (page 95)

• "NonMTBI2 CondText elements" (page 96)

•




.





.


NonMTBI2 CondText elements

NonMTBI2 Back elements

NonMTBI2 Backmatter elements

NonMTBI2 Terminology elements




.





.

99.

MTBI2 authoringUse the information herein to author documents using the MTBI2 doctype.

MTBI2 authoring tasksThis work flow shows you the sequence of tasks you perform to author aMTBI2 publishable. To link to any task, go to "MTBI2 authoring navigation"(page 100).




.

100 MTBI2 authoring

MTBI2 authoring navigation• "Modular Task-Based Information" (page 100)

• "Creating MTBI2 variables" (page 100)

• "MTBI2 module authoring" (page 102)

• "MTBI2 publishable building" (page 104)

• "Editing a MTBI2 document" (page 108)

• "MTBI2 PDF generation without reuse" (page 110)

• "MTBI2 PDF generation with reuse" (page 112)

• "MTBI2 PDF generation with profiled content" (page 114)

• "MTBI2 content models" (page 116)

Modular Task-Based InformationNTP content is authored in modules. This content comprises mandatoryand optional elements that must be placed in a specific order. While theNTDA tool set enforces the sequence of elements, the NCDS should beconsulted to determine the sequence of modules and the content within itas well as the elements that should be used within each module for thedifferent NTP types. See Nortel Customer Documentation Standards, (CS1808.00) .

Creating MTBI2 variablesThe following shows the order and dependencies of procedures to create aMTBI2 variable.

Creating MTBI2 variables proceduresThis task flow shows you the sequence of tasks you perform to build aNonMTBI2 publishable. To link to any task, click on the task in




.

Creating MTBI2 variables 101

Figure 24Creating MTBI2 variable task flow

Creating MTBI2 variables navigation

• "Saving the MTBI2 variable template" (page 400)

• "Modifying variable attributes" (page 391)










.

102 MTBI2 authoring






• "Importing variable into Documentum" (page 420)

MTBI2 module authoringCreate multiple MTBI2 modules to compile into a MTBI2 publishablemtbimap.

Prerequisites to MTBI2 module authoring



MTBI2 modules authoring proceduresThis task flow shows you the sequence of tasks you perform to author anMTBI2 module. To link to any task, click on the task in "MTBI2 moduleauthoring navigation" (page 103).




.

MTBI2 module authoring 103

Figure 25MTBI2 modules authoring task flow

MTBI2 module authoring navigation

• "Saving MTBI2 module template" (page 422)








.

104 MTBI2 authoring












MTBI2 publishable buildingImport MTBI2 modules to build a MTBI2 publishable.

MTBI2 publishable building proceduresThis task flow shows you the sequence of tasks you perform to build aNonMTBI2 publishable. To link to any task, click on the task in "Navigationto MTBI2 publishable building" (page 106)




.

MTBI2 publishable building 105

Figure 26MTBI2 publishable building task flow




.

106 MTBI2 authoring

Figure 27MTBI2 publishable building task flow continued

Navigation to MTBI2 publishable building

• "Saving MTBI2 publishable template" (page 403)



• "Using a shared variable" (page 391)




.

MTBI2 publishable building 107











Job aidThe following are guidelines for defining structure:

• Define publishable hierarchical relationships within mtbimap.

• Enclose all modules within mtbitopicref.

• While you currently can, do not embed ConceptModule orWhatsNewModule elements within themselves

• Do not nest modules in WorkflowModule.

• Do not nest modules below a Level 3 in the structure.

• Nest ProcedureModule within TaskModule.

• Use ContentGroupingModule to group related ReferenceModule.

See Figure 28 "MTBI2 map" (page 108) .




.

108 MTBI2 authoring

Figure 28MTBI2 map

Editing a MTBI2 documentTo edit your document and keep the changes you must check thedocument out and back into Documentum.

Editing a MTBI2 document proceduresThis task flow shows you the sequence of tasks you perform to edit theMTBI2 documents. To link to any task, click on the task in "Editing aMTBI2 document navigation" (page 109).




.

Editing a MTBI2 document 109

Figure 29Editing a MTBI2 document task flow

Editing a MTBI2 document navigation









.

110 MTBI2 authoring










MTBI2 PDF generation without reuseComplete the necessary verifications to generate a PDF from a MTBI2 xmlsource that does not reuse its modules.

MTBI2 PDF generation without re-used modules proceduresThis task flow shows you the sequence of tasks you perform to generate aPDF from a NonMTBI2 source file that does not have reuse. To link to anytask, click on "MTBI2 PDF generation without reused modules navigation"(page 111).




.

MTBI2 PDF generation without reuse 111

Figure 30MTBI2 PDF generation without reuse task flow

MTBI2 PDF generation without reused modules navigation






.

112 MTBI2 authoring






• "Generating a MTBI2 PDF without reuse" (page 403)

MTBI2 PDF generation with reuseComplete the necessary verifications to generate a PDF from a MTBI2 xmlsource that has reuse.

MTBI2 PDF generation with re-used modules proceduresThis task flow shows you the sequence of tasks you perform to generate aPDF from a MTBI2 source file that has reuse. To link to any task, click on"MTBI2 PDF generation with reuse navigation" (page 113)




.

MTBI2 PDF generation with reuse 113

Figure 31MTBI2 PDF generation with reuse task flow

MTBI2 PDF generation with reuse navigation






.

114 MTBI2 authoring






• "Generating a MTBI2 PDF with reuse" (page 404)

MTBI2 PDF generation with profiled contentCreate a neutral version of the MTBI2 source file with profiled content togenerate a PDF.

MTBI2 PDF generation with profiled content tasksThis task flow shows you the sequence of tasks you perform to generatea PDF from a MTBI2 source file that does not have reuse. To link to anytask, click on




.

MTBI2 PDF generation with profiled content 115

Figure 32MTBI2 PDF generation with profiled content task flow

MTBI2 PDF generation with profiled content navigation








• "Creating a neutral version of an MTBI2 document" (page 405)





.

116 MTBI2 authoring

• "Verifying the neutral version of the MTBI2 document" (page 406)

• "Generating a MTBI2 PDF with profiled content" (page 406)

MTBI2 content modelsThis reference information contains the content models available in eachelement of the mtbi2.dtd.

The meaning of the symbols used in all content models are:

Symbol Meaning

* 0 or more

+ 1 or more

? 0 or 1

Navigation• "MTBI2 Front elements" (page 116)

• "MTBI2 Topics elements" (page 118)

MTBI2 Front elements

MTBI2 PublicationMetadata elements




.

MTBI2 content models 117

MTBI2 PublicationHistory elements

MTBI2 Overview elements




.

118 MTBI2 authoring

MTBI2 Topics elements

Navigation• "MTBI2 mtbitopicref elements" (page 118)

• "MTBI2 Concept elements" (page 119)

• "MTBI2 ContentGrouping elements" (page 119)

• "MTBI2 ProcedureModule elements" (page 120)

• "MTBI2 ReferenceModule elements" (page 122)

• "MTBI2 TaskModule elements" (page 123)

• "MTBI2 Terminology elements" (page 124)

• "MTBI2 WhatsNewModule elements" (page 125)

• "MTBI2 WorkflowModule elements" (page 125)

• "MTBI2 common elements" (page 126)

MTBI2 mtbitopicref elements




.


MTBI2 Concept elements

MTBI2 ContentGrouping elements




.

120 MTBI2 authoring

MTBI2 ProcedureModule elements




.





.

122 MTBI2 authoring

MTBI2 ReferenceModule elements




.


MTBI2 TaskModule elements




.

124 MTBI2 authoring

MTBI2 Terminology elements




.


MTBI2 WhatsNewModule elements

MTBI2 WorkflowModule elements




.

126 MTBI2 authoring

MTBI2 common elementsThis section contains elements used by other elements:

• "MTBI2 Purpose elements" (page 126)

• "MTBI2 Navigation elements" (page 126)

• "MTBI2 Prerequisites elements" (page 126)

• "MTBI2 AppliesTo elements" (page 127)

• "MTBI2 IfGraphic elements" (page 127)




.





.

128 MTBI2 authoring




.

129.

Documentum information andprocedures

Documentum is the database repository for all content under development.Documentum lets you access, use, reuse, and distribute informationquickly and easily. Our publishables, modules, and graphics arestored in company repositories within Documentum called Docbases.Documentum allows our authors to access documents across differentdepartments and sites, and across different computer platforms.Furthermore, Documentum allows publishables to be imported fromyour local PC to the appropriate Docbase in Documentum. Assigningversion numbers to help keep track of revisions is also a featurewithin Documentum. For more information on Documentum go tohttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9793344.

Navigation• "Documentum file structure" (page 129)

• "Documentum Desktop Client tasks" (page 132)

• "Documentum Desktop Client tools" (page 135)

• "Finding items in Documentum" (page 140)

• "Documentum Adapter procedures" (page 143)

Documentum file structureUsing the metadata attributes assigned to a publishable, the Documentumrepository has a filtering system to organize the publishable and itselements.

Navigation

• "Documentum MTBI2 folder guidelines" (page 130)

• "Documentum NonMTBI2 folder guidelines" (page 131)




.


130 Documentum information and procedures

Documentum MTBI2 folder guidelinesAfter a MTBI2 XML file is authored it must be checked into Documentum.Once checked in, Documentum places the document into two folder types.The Publishables folder which contains the high-level structure of thedocument; and the Modules folder, which contains all the low-level contentwithin.

XML files are automatically stored in the Publishables folder with the DocNumber filename. Each XML module within the publishable is stored in theModules folder with its own DocNumber/ComponentName/GroupNamefolder. Within the DocNumber/ComponentName/GroupName folder eachmodule type is separated and stored within an InfoCategory folder eachwith its own InfoType subfolder.

Attention: For modules that are re-used with multiple publishables, theDocNumber attribute can contain a ComponentName or GroupNamerather than a publishable document number. For example, theDocNumber attribute contains Core_Upgrades for all modules re-usedbetween core upgrade publishables.

Documentum stores all the graphics and variables from the document intoa predefined folder (Graphics2 and Variables) common to both MTBI2and NonMTBI2 types. The Links folder is an area for authors or groupsto manually define links to frequently-used files. See Figure 33 "MTBI2folder hierarchy" (page 130) .

Figure 33MTBI2 folder hierarchy




.

Documentum file structure 131

Documentum NonMTBI2 folder guidelinesOnce a NonMTBI2 document is checked into Documentum, the moduleis stored automatically based on the DocType, DocNumber andInfoCategory attributes.

Attention: For modules that are re-used with multiple publishables, theDocNumber attribute can contain a ComponentName or GroupNamerather than a publishable document number. For example, theDocNumber attribute contains Core_Upgrades for all modules re-usedbetween core upgrade publishables.

The DocType storage is based on whether the module is IM or NTP. ForIM digits 6 and 7 (right-to-left) of the DocNumber routes modules to anIMtype folder.

If the DocType is NTP , DocNumber is used to route modules to theDocNumber/Component/GroupName folder of the same title. TheInfoCategory option filters the document to an InfoCategory folder withinthe DocNumber/ComponentName/GroupName folder.

If the chunk option is set to No it keeps the NTP as a single document inthe DocNumber/ComponentName/GroupName folder (Yes is the defaultoption).

XML files within the ks_publishable are automatically stored inPublishables with DocNumber filename.

Documentum stores all the graphics into the Graphics folder for graphicswithin NonMTBI modules or Graphics2 folder for graphics within MTBI2 orNonMTBI2 modules. The Links folder is an area for authors or groups tomanually define links to frequently-used files. See Figure 34 "NonMTBI2folder hierarchy" (page 132) . The Variables folder is used to storevarables.




.


Figure 34NonMTBI2 folder hierarchy

Documentum Desktop Client tasksOnce logged into Documentum there are many options to save and updateyour publishable. The following explains each option available for yourpublishable.

Navigation

• "Check in" (page 132)

• "Check Out" (page 133)

• "Cancel check out" (page 134)

Check inAfter you have made updates to the document that was checked out, youmay want to place these changes into the docbase, see Figure 35 "Checkin option" (page 133) .




.

Documentum Desktop Client tasks 133

Figure 35Check in option

The Check In... option allows you to:

• Saves the document in the docbase (with possibly a new versionnumber) in the same location as it originated.

• Removes it from your local Documentum/Checkout directory.

• Removes the lock from the file within Documentum

You can override the default settings and add a description of changesmade to the file.

Check OutYou need to check out a document from Documentum in order to edit it,see Figure 36 "Check Out option" (page 134) .




.


Figure 36Check Out option

As you Check Out a document:

• The current version (or the last checked in version) is retrieved.

• A lock is placed on this file in Documentum so that it can not be editedby others with access to the file.

• A copy of the file is placed into the Documentum/Checkout directoryon your hard drive.

After checking out the document, you must launch Arbortext Editor andopen the document from within the Documentum/Checkout directory.

Any document that includes other Documentum objects (images or othermodules), is identified with a specific icon.

If you check out one of these documents, the system asks you if you wishto check out its descendents. A descendent is another object referencedby the document.

Cancel check outIf you decide to close the file that you are editing and not save changes,you can cancel the check out of the document, see Figure 37 "CancelCheckout option" (page 135)




.

Documentum Desktop Client tools 135

Figure 37Cancel Checkout option

Figure 38Cancel Checkout Yes option

The Cancel Check Out Yes option:

• Removes the lock from the file.

• Puts document back in docbase.

• Cancels the changes.

Documentum Desktop Client toolsThe following information describes useful tools in Documentum.

Navigation

• "File properties" (page 136)

• "Virtual Document Manager" (page 136)

• "View Document Info (versions)" (page 137)

• "Display settings" (page 138)

• "Recently used documents" (page 139)




.


File propertiesIn Documentum, when you click File, Properties it displays currentinformation (version, owner, security) Display Object or Unit Attributes, seeFigure 39 "File properties display" (page 136) .

Figure 39File properties display

File, Properties gives you access to the following module properties:

• Version: displays the version of the document and if this one ischecked out or not

• Security: displays allowed permissions (read, write, …) of thedocument.

• Advanced: you may configure event notifications.

• Basic Attributes: displays the product name.

• RIU, RIO, … Attributes. Display the information model category, topic,topic group, module type.

Virtual Document ManagerThe Virtual Document Manager displays a view of your document structureby double-clicking the document, see Figure 40 "Virtual DocumentManager display" (page 137)




.


Figure 40Virtual Document Manager display

The VDM contains pointers to:

• All objects cross-referenced by the parent object

• All objects imported by reference into the parent object

You can only do this if the file has the icon that indicates it has crossreferences. If the documents that are referenced in the original document(or parent document) also have references to other documents, they willhave plus signs next to them. The virtual document manager will displaythe text insets also.

From Virtual Document Manager, you can also check out, check in or editthe document.

View Document Info (versions)When selecting View, Document Info, Windows Explorer has a panethat is displaying at the right bottom. It enables you to see all the existingavailable version of your document, see Figure 41 "View Document Infodisplay" (page 138)




.


Figure 41View Document Info display

In the view combo box, if selecting the location of version option from thedrop-down menu, all cross-referenced elements with the selected elementare displayed. It is very convenient to know what is reused in the selectedmodule.

Attention: No version management is performed for the moment. Only1.0 version as current version is displayed

Display settingsThe Display Settings options allows you to set which properties to display.You can add or remove property columns to displayed detail file list in thewindows explorer browser. You can also move up or down the propertycolumns to change the display order, see Figure 42 "Display settingsoption" (page 139) .




.


Figure 42Display settings option

Recently used documentsThe “Recent Documents” option in Desktop Client can be very useful. Itshows a listing of the 15 files that you most recently Checked Out of thedocbase, see Figure 43 "Recently used documents display" (page 139)

Figure 43Recently used documents display

If you wish to Check Out or View a recently used file, just select theappropriate file from the list. You will then be asked whether you wish toview it or edit it.




.


Attention: Do not use this to open checked out files in your Checkoutdirectory (open the file from the application in your Checkout directory).

Finding items in DocumentumUse the following to find objects in Documentum.

Procedure Steps

Step Action

1 Open Documentum Desktop Client.

2 Select Tools, Find, Document Items in Desktop Client.

3 Specify your search elements.

4 Click Find.

Results of your search are displayed in the Results tab.

5 Right-click file names to display options.

--End--

Job aidIn searching for an element type select from the Look for options inthe General tab. Type keyword that you are looking for. See Figure 44"Element type search fields" (page 141)




.

Finding items in Documentum 141

Figure 44Element type search fields

In searching for with a property select from the options in the Propertiesto look for drop-down menu in the General tab. Type keyword that youare looking for. See

Figure 45Property search fields




.


You can also select a rule to include or exclude elements from your searchin the Properties to look for option in the General tab. See Figure 46"Select rule search fields" (page 142)

Figure 46Select rule search fields

You can search with several properties with the Add Property or RemoveProperty rows for a complex search in the docbase in the General tab.See Figure 47 "Add Property and Remove Property search option" (page143)




.

Documentum Adapter procedures 143

Figure 47Add Property and Remove Property search option

Documentum Adapter proceduresThe Arbortext Adapter to Documentum/XML is an interface betweenArbortext Editor and Documentum. To verify that the adapter is installed,click Help, About Arbortext Editor, Session, Components .

Within NTDA, it is recommended that the Arbortext Adapter toDocumentum/XML only be used to browse to and paste objects intodocuments by reference.

Navigation• "Logging on to Documentum through Arbortext Editor" (page 373)

• "Browsing Documentum through Arbortext Editor" (page 375)

• "Checking out a document through Arbortext Editor" (page 375)

• "Checking in a document through Arbortext Editor" (page 375)




.





.

145.

DLM information and proceduresThe creation and management of all links within documents(intra-document links), links among documents (inter-document links), andweb links is controlled by the Arbortext Dynamic Link Manager (DLM).

DLM is accessed from the Arbortext Editor Tools menu. DLM linkinginvolves two steps: registering targets and inserting links to targets.DLM is configured to auto-register targets for all main headings,figures, and tables; specified in the doctype.dcamcf (stored in theDocumentum/XML Applications/docbase folder) and global.dlmcf(stored in the Arbortext/Editor/custom/libfolder) files, global.dlmcf alsocontains the service location URL to the DLM database). Targets can alsobe manually added using the target element.

All new content must be checked into Documentum before DLMregistration or validation of targets or links. In addition, checked outdocuments must be unchanged before DLM registration or validation oftargets or links.

Attention: DO NOT register or validate new targets or links in DLM untilafter the document has been checked into Documentum. For example, ifyou insert new links, do no register or validate them in DLM until after thedocument has been checked in and then out of Documentum.

Navigation• "Using the Dynamic Link Manager" (page 145)


Using the Dynamic Link ManagerThe following Dynamic Link Manager (DLM) procedures illustrate differentmethods in managing specific situations.

Navigation




.

146 DLM information and procedures


• "Inserting a DLM link to a profiled Heading (NonMTBI)" (page 146)

• "Adding DLM link targets in procedures or ordered lists" (page 148)

• "Inserting DLM web links" (page 149)

• "Inserting links using the DLM Link Manager" (page 151)

• "Removing previously deleted DLM resources" (page 153)

• "Removing duplicate DLM target ids" (page 154)







Inserting DLM linksUse the following procedure to insert DLM links into your document.

Procedure Steps

Step Action

1 Place the cursor within the place the required link will be insert.

2 Click Tools, Dynamic Link Manager, Insert Link.

Select Target dialog box displays.

3 Click the Current Document tab.

4 Highlight the required location, and click OK.

The Link Properties dialog box displays.

5 Click OK.

--End--

Inserting a DLM link to a profiled Heading (NonMTBI)This procedure shows you how to manually add target elements and linktext outside of procedures and ordered lists.




.

Using the Dynamic Link Manager 147

Procedure Steps

Step Action

1 Within the Heading element that requires multiple headings, typein any text that is common to both headings.

2 After or before the common text, insert a CondText element andinsert the text unique to the first heading.

3 Repeat for text unique to the second heading.

4 Within each CondText element apply the profile required for thatheading. Select Edit, Profiles, Apply Profiles.

5 Position the cursor immediately after the Heading element andpress enter and select Paragraph to insert the Paragraph tags.

6 Within the blank Paragraph element insert a target elementfor each heading and insert the required heading text in thetargetText attribute.

7

8 Insert links to the manually-added targets at all the requiredlocations and save the document.

9 Save the document.

10 Select Tools, Dynamic Link Manager, Register, Document.

11 At the required locations insert a link to the target id containingthe required heading link text and apply the required profileto each link (you may need to insert and apply to a CondTextelement).

12 Save the document.

13 SelectTools, Dynamic Link Manager, Register, Document.Then click View, Generated Text, Update.

--End--




.


Adding DLM link targets in procedures or ordered listsThe following procedure shows you how to manually add target elementswithin procedure steps or ordered list items.

Procedure Steps

Step Action

1 Position cursor at a required target Step or Item location.

2 Press Enter and select the target element.

3 Repeat for each required location.

4 From the main Arbortext Editor menu bar, select Nortel,Add/update link text for manually-added targets.

Attention: Do not execute this step if you are using profilingwith manually-added targets.

Attention: The targetText attribute is auto-populated ormodified with Step #, Item #, or Sub-step # to match the currentprocedure step or list item number. If the auto-populated textis not used in targetText & numbers are included, use onlyalphanumeric characters and the non-breaking space character( ) before numbers.

5 Click View, Generated, Text, Update.




.


--End--

Inserting DLM web linksUse the following procedure to insert DLM web links.

Procedure Steps

Step Action

1 Position cursor at required insertion point and press Ctrl+K.

2 Select Target window appears.

3 Click DLM Repository, ecmprod, and Web Links and browseto the required web link.

4 If it exists, select it and click OK. Click OK in the Link Propertieswindow to insert the link

5 If the required web link does not already exist, click the Othertab and check the Web Resource option and then click OK.




.


6 Place the cursor in the Display Name field and enter the nameof the link. This will be the link text that appears in the document.

Attention: Link text can contain up to 100 characters.

7 Place the cursor in the Locator text field and enter a fullyqualified URL for the link. Or click Browse and find the URL tobe used

Attention: The URL must include the protocol indicator (eg,http:// or ftp://).

8 Click the Parent Folder, Browse button and select Web Links.




.


9 Click OK in the Target Properties window and then OK in theLink Properties window.

The URL link is now inserted into the document.

10 Click View, Generated, Text, Update to view your link.

--End--

Inserting links using the DLM Link ManagerUse the following procedure to insert DLM links using the DLM LinkManager

Procedure Steps

Step Action

1 Click Tools, Dynamic Link Manager, Link Manager.

The Link Manager window displays.




.


Attention: By default, the window will appear in the ArbortextEditor window to the right of the structure window. It can bedragged-and-dropped outside the Arbortext Editor window. TheLink Manager window is persisent.

2 Click the Current Document tab.

3 Position the cursor at required insertion point.

4 Click Name, Tag Name, or XML ID to organize by link name,element type, or DLM-id.

5 Browse to the required target, click Go To to verify that you haveselected the correct target and then Go Back to return to the linkinsertion point.

Attention: Target and Link text can contain up to 100characters

6 Double-click the required target.

The link text will be inserted at the insertion point.




.


7 To see the link text immediately, press Alt+Ctrl+G.

Attention: This can slow down the process of inserting otherlinks.

8 Repeat until all required links have been inserted.

9 Save the document and then click View, Generated Text,Update.

--End--

Removing previously deleted DLM resourcesUse the following procedure to remove previously deleted DLM resources.

Procedure Steps

Step Action

1 Click on Tools, Dynamic Link Manager, Connect and type dcain the username field.

2 Click on Tools, Preferences, DLM and check all the DLMpreferences.

3 Click on OK.

4 Click on Tools, Dynamic Link Manager, Register, Document.




.


5 Click on File, Exit and Save the changes.

--End--

Removing duplicate DLM target idsUse the following procedure to remove duplicate DLM target IDs.

Procedure Steps

Step Action

1 After running a completeness check that indicates duplicates,Enter show ids in the Arbortext Editor Command Line.

The ID and ID References window will be displayed.

2 Click Next Error.

The cursor will move to the next Id with an error in the list.

3 Click Go To ID to position the cursor at the error in the Editwindow.

4 In the Edit window, select the element that contains the duplicateId and then click Edit , Edit Selection as XML Source.

5 In the Edit Selection as XML Source window, select and deletethe id attribute.

For example, id="DCAM-4938836" .

6 Click File, Close and save the changes.

7 Repeat until all duplicates have been deleted.

8 In the ID and ID References window, click Close.

9 Click File, Save.

10 Click Tools, Check Completeness and verify that there are nocompleteness errors.

11 Click on Tools, Dynamic Link Manager, Register, Document.


--End--

Job aidIf there are many duplicate target ids: connect to DLM online; click File,Save As and specify a different file name (this will assign new DLM-idsto all elements). Close Arbortext Editor; delete the original file and thenrename the new file to have the same name as the original file.




.


Registering a document with DLMUse the following procedure to register DLM targets in your file.

Procedure Steps

Step Action

1 Click on View, Generated Text, No Auto-Updates

2 Click on Tools, Preferences, select DLM in the left-hand paneland verify that all boxes, in the right-hand window, contain acheck mark




.


3 Connect to DLM, click onTools, Dynamic Link Manager,Connect....

4 Type dca in the User Name field.




.


5 Click onTools, Dynamic Link Manager, Register, Document.

Registration Report displays.

--End--




.


Validating DLM linksUse the following procedure to validate your links.

Procedure Steps

Step Action

1 Click Nortel, Check for URLs longer than 127 characters; ifthere are any, reduce to 127 characters or less.

2 Click Nortel, Check for illegal characters in headings; if illegalcharacters are found, remove them

3 Click Nortel , DLM , Validate Links, Document.

Attention: If validation seems to be going abnormally slow,more than a few seconds per link, abort link validation, close allArbortext Editor sessions, delete the .aptcache folder in yourlocal Arborttext/Editor/custom folder, and then start again.

--End--

Saving the DLM link validation reportThe Validation Report lists all the errors in your publishable. This includesa list of all the read-only modules in your publishable. In saving thevalidation report a list of read-only modules is created for reference. Usethis list as an indicator to which read-only modules need to be fixed andregistered.

The following procedure shows how to save the validation report.

Procedure Steps

Step Action

1 Click Save in the Validation Report box.

2 Enter in a filename.

3 Specify where you would like the Validation Report to be saved.

It will automatically want to save it in your Checkout folder.

4 Click Save.




.


An HTML version of the Validation Report is created.

--End--

Disabling the DLM server connectionUse the following procedure to disable the DLM server connection on yourlocal PC.

Procedure Steps

Step Action

1 Close all running Arbortext Editor sessions.


3 Click Advanced and then Environment Variables.

4 Select APTLMHOST in System variable (and User variable,if it exists).

5 Click Edit and rename APTLMHOST (in System & Uservariables) to GDE-APTLMHOST, click OK.

6 Click OK twice to return to the desktop of your PC.


--End--

Enabling the DLM server connectionUse the following procedure to Enable the DLM server connection.

Procedure Steps

Step Action

1 Close all running Arbortext Editor sessions.


3 Click Advanced and then Environment Variables.

4 Select GDE-APTLMHOST in System variable (and Uservariable, if it exists).




.


5 Click Edit and rename GDE-APTLMHOST (in System & Uservariables) to APTLMHOST, click OK.

6 Click OK twice to return to the desktop of your PC.


--End--

Inserting intra-document DLM linksUse the following procedure to register targets in your file.

Procedure Steps

Step Action

1 Click Tools, Dynamic Link Manager, Connect.

2 Type dca and click OK

Attention: The option to work offline is available, click WorkOffline.

3 Position cursor at required link insertion point and press Ctrl+k.

The Select Target window appears.




.

Fixing DLM errors 161

4 If working online, select Current Document.

5 Click Name, Tag Name, or XML ID to organize by link name,element type, or DLM-id.

6 Browse to the required target, click Go To to verify that you haveselected the correct target and then Go Back to return to the linkinsertion point.

7 Double-click the required target and then OK to insert a link.

8 To see the link text immediately, pressAlt+Ctrl+G.

This will slow down the insertion of other links.

9 Repeat until all required links have been inserted.

10 Save the document and select Tools, Dynamic Link Manager,Register, Document, then click View, Generated Text, Update.

--End--

Fixing DLM errorsUse the following procedure to fix any target errors if your document failsto register.

Procedure Steps

Step Action

1 Check out a document from Documentum and open it withArbortext Editor; if prompted to, click Bring Online.

2 Before working with DLM, ensure that• Click on View > Generated Text > No Auto-Updates• Click on Tools > Preferences and select DLM in the left

panel and ensure that all square boxes are checked in theright-hand window

3 Click on Tools, Dynamic Link Manager, Connect and type dcain the User Name field and click OK.

4 Click on Tools > Dynamic Link Manager > Register >Document

If there are registration errors, fix them and repeat this step until thereare no errors.

5 Validate links by selecting Nortel, DLM, Validate Links,Document and wait for validation to complete.

If validation is needed subsequent to fixing some links anda complete validation was done already, run the followingcommands:




.


• Validate the links that are fixed by selecting the elementcontaining the link and click onNortel, DLM, ValidateLinks...Element

• Click on Tools, Dynamic Link Manager, Register,Document

Three types of errors are possible from link validation

• Link errors that are fixed automatically by the validation. Youmust register the document again to fix these errors: Tools,Dynamic Link Manager, Register, Document. For thesetypes of errors watch for the word fixed or CHANGED in theerror message; for example, Link marked as ADDED, butalready exists on the server (fixed by setting the links’ state toCHANGED).

• Links that have targets outside the document. These errorscan be ignored; for example, The target is not in the currentdocument.

• Link errors that should be fixed in the XML source file; forexample, The link key is used for multiple links in the currentdocument. Contact the authoring prime to fix these errors infilename.xml.

6 Click Nortel, Check for illegal characters in headings to verifythat there are no invalid characters in Heading, Title, Caption, orin target targetText.

7 Turn on the recording of DLM logs locally. Click Nortel DLM,Record logs in C:\DLM_client.log.

8 Click Tools, Dynamic Link Manager, Register, Document.

9 If document fails to register and the document contain only a fewlinks, delete all links and reinsert them.

10 Scroll down towards the bottom of the dlm_client.log file if thereare any remaining errors and address any of the errors in thefollowing ways:

• The message ERROR – Database error creating linkindicates that the link is already in the database. Delete thelink and recreate it.

• Navigate to the Troubleshooting section of this document.

• For all other error messages or if there are no errormessages, raise an NTDA CR and exit procedure.

11 Save the document and Close all running Arbortext Editorsessions.

--End--




.

Fixing DLM registration errors 163

Fixing DLM registration errorsThe following procedures show how to fix specific DLM registration errors.

Navigation• "Fixing DLM registration error A50087" (page 163)

• "Fixing DLM registration error A30111" (page 164)



Fixing DLM registration error A50087Use the following to fix the DLM regristation error A50087.

Procedure Steps

Step Action

1 Click OK on the Alert.

2 From the Nortel menu, click Change the status of DLM links.

3 Click OK.




.


--End--

Fixing DLM registration error A30111This error occurs after trying to register a document that has read-onlymodules that contain new, modified, or deleted links that need to beregistered. Use the following to fix the DLM regristation error A50111.

Procedure Steps

Step Action


2 Click Tools,Dynamic Link Manager, Connect and type dca asthe username.

3 Validate links, click Nortel, DLM, Validate Links, Documentand save the document. if there are errors, fix them and save thedocument again. .




.



5 Verify that the registration Report does not contain any errors. Ifthere are, fix them, save the document, and repeat.

Attention: If a link is deleted and the document is notregistered before checkin the atidlm:delete markers will keepre-appearing until the document is registered.

--End--


Procedure Steps

Step Action


2 From the Nortel menu, click Find DLM links with no targets.

If a link is found with no targets, it will be selected in thedocument and the following message will be displayed.

3 If a link is found with no targets click OK. Delete the link andthen insert a link to the required target

4 Repeat until the following message is displayed:




.


5 Click OK.

--End--


Procedure Steps

Step Action


2 Click the Collapse/Expand Divisions icon and click Expand Allto display the content of the entire document.

3 Click Nortel, Find invalid sequence numbers in DLM links.

The edit window will scroll to and highlight the first link with aninvalid sequence number.

Click OK on the following message will be displayed:




.


4 Right-click the highlighted link and click Modify Link.

5 If prompted to logon to DLM. Typedca in username field.

6 Note the Referenced Target Name and XML ID; click OK.

7 Delete the link and insert a new one that contains the notedtarget Name and XML ID.

8 Repeat until you get the No invalid link markup foundmessage.

9 Click OK.

--End--




.





.

169.

Graphics information and proceduresInformation and procedures for using graphics with the NTDA are groupedtogether here.

Navigation• "Graphic size and format" (page 169)

• "General graphic procedures" (page 170)

• "Graphic management" (page 184)

Graphic size and formatThe following information describes the NTDA standard on graphic sizeand format.

Navigation

• "Graphics size and location" (page 169)

• "UI screen size" (page 170)

Graphics size and locationFour NTDA graphic sizes are supported, based on Nortel TechnicalDocumentation Standard, 164.00:

• column: width between 15 and 31 pica, left-aligned, with a caption anda full frame (max of 29-picas, allowing for 2-pica of white space aroundthe graphic, or 695 pixels @ 144ppi).

• halfColumn: width up to 15-pica, left-aligned, with no caption or frame(360 pixels @ 144ppi).

• page: width between 31 and 38 pica, left-aligned, with a caption and afull frame (max of 36-picas, allowing for 2-pica of white space aroundthe graphic, 864 pixels @ 144ppi).

• margin: width up to 6-pica, with the graphic located in the center of themargin column, no frame.

Maximum graphic height is 51 – 6 which equals to 45-pica allowing forwhite space and figure number-caption, 1080 pixels @ 144ppi.




.

170 Graphics information and procedures

Maximum graphic width within procedures (aligning with Action column) is31–2– 2.5 which equals to 26.5-pica, 635 pixels @ 144ppi.

UI screen sizeUI screen size is 800 (width) x 600 (height) pixels.

Maximum printed graphic size is 36-pica (width) x 45-pica (height); whichis 6.0-inches by 7.5-inches

Maximum online graphic size @ 96ppi: 576.0 (width) x 720 (height) pixels.

Maximum printed graphic size width at 144ppi is 800/144 which equalsto 5.56-inch equalling to 33.4-pica.

General graphic proceduresMultiple procedures are available for configuring graphics to the properNTDA standard.

Navigation• "Capturing screens" (page 170)

• "Converting between formats" (page 172)

• "Creating imagemaps with FrontPage" (page 173)

• "Converting Postscript to PNG" (page 174)

• "Converting EPS to PNG" (page 175)

• "Converting EPS to JPG" (page 177)

• "Extracting embedded graphics using Acrobat and SnagIt" (page 178)

• "Extracting embedded graphics using Acrobat and Photoshop" (page181)

• "Extracting embedded graphics using HTML and Illustrator" (page 183)

Capturing screensUse this procedure to capture screens for your publishable.

Prerequisites

• Ensure a standard windows wallpaper, cursor and bar configurationsare used.

• Ensure SnagIt 8 is downloaded on your PC.

Procedure Steps

Step Action

1 Open SnagIt.




.

General graphic procedures 171

2 From the Capture menu select Input and select what type ofregion will be captured from the list.

3 From theCapture menu select Output, Properties .

4 In theImage File tab set Always use this format to PNG.

5 Click Options. File Format Options box appears.

6 Select True Color (24-bit) from the list. Click OK.

7 Click Apply. Click OK.

8 From the Capture menu select Filters, Color Depth and verifythat it is set toNone.

9 From the Capture menu select Filters, Color Substitution andverify that it is set toNone.

10 From the Capture menu select Filters, Image scaling and verifythat it is set toNone.

11 In the Profile Settings select effects and options as applicablefor your screen capture.




.


12 When image is set up, select the Capture button.

13 Save the image on your local PC.

--End--

Converting between formatsUse this procedure to batch convert between graphic formats.

Procedure Steps

Step Action

1 Open Easy Graphic Converter.

2 Click Settings and select the required Output Format.

3 Specify No Resize and the Output Directory.

4 Click OK.

5 Click Add and select the files to be converted.




.


6 Click Start to convert the selected files.

--End--

Creating imagemaps with FrontPageUse the following procedure to create imagemaps for work flows and taskflows with FrontPage.

Procedure Steps

Step Action

1 Open FrontPage.

2 From the File menu, select New, Page or Web.

3 In the New Page or Web panel under New, select Blank Page.

4 From the Insert menu, select Picture, From File.

5 Select the required image file.

Image opens in FrontPage.

6 Click on the image.

7 On the Pictures toolbar, click the Rectangular Hotspot tool.




.


8 On the image, draw a rectangle around the area where you wanta hotspot .

Insert Hyperlink dialog opens.

9 Click the Existing File or Web Page.

10 In the Address field, type the link text and click OK.

11 Repeat steps 7 to 10 for all required hotspots.

12 Click File, Save As and specify an imagemap_filename with anhtm extension.

--End--

Converting Postscript to PNGUse this procedure to convert Inspiration graphics to PNG.

Procedure Steps

Step Action

1 Print the required graphic to a Postscript file.

2 Open the Postscript file with GSview.




.


3 Select File, Convert.

4 In the Device option select png16m from the list.

5 In the Resolution option type 144 and click OK.

6 Specify a filename and click Save.

Attention: You can also use GSview to convert EPS to PNG,but you will have to crop excess white space.

--End--

Converting EPS to PNGUse this procedure to convert existing EPS files.




.


Procedure Steps

Step Action

1 Open the EPS file with Illustrator.

2 Select File, Export.

3 Select File, Save As type in PNG and click Save.

4 Specify a Resolution of 144ppi and do not select Anti-Alias.

5 Set PNG options Interlace to None and Filter to Adaptive.




.


6 Click OK.

Attention: GSview can be used to convert EPS to PNG, butyou will have to crop excess white space.

--End--

Converting EPS to JPGUse this procedure to convert existing EPS files to PNG standard format.

Attention: Only use JPEG if PNG size is greater than 500kB.

Procedure Steps

Step Action

1 Open the EPS file with Illustrator.


3 Select Save As and type in JPEG.

4 Select a Image Quality 8.

5 Specify Custom Resolution of 144ppi.

Attention: Do not select Anti-Alias.




.


6 Click OK.

--End--

Extracting embedded graphics using Acrobat and SnagItGraphics created by the FrameMaker graphics editor and inline embeddedgraphics for which you do not have an external file, have to be extractedfrom FrameMaker and saved as PNG files for inclusion by reference inEpic Editor XML files. Use the following procedure to extract embeddedgraphics using Acrobat and SnagIt.

Procedure Steps

Step Action

1 Open the required FrameMaker file.

2 Right-click the required embedded graphic and select Copy.

3 Open a new FrameMaker document and Paste the imagecopied in step 2.

4 Save Framemaker document as an .fm file.

5 Save FrameMaker document as a .pdf file.

6 Open the PDF with Acrobat 7 Professional.

7 Select Tools, Advanced Editing, Crop Tool and draw a Cropbox around the image.




.


8 Double-click inside the crop box and verify that the cropped pagesize width is equal to or less than 33.6 picas for page-wide,29-picas for column-wide, or 26.5-picas for procedures (allowingfor white space around the graphic); Click OK.

9 Select File, Save As.

10 Select PNG from the list and then select Settings. The Save AsPNG Settings dialog box appears.

11 In the File Settings option set Interlace to None and Filter toAdaptive.

12 In the Color Management option set RGB to Embed profile andGrayscale to Off.

13 In the Conversion option set Colorspace to Color: RGB; andtype 144 pixels/inch for the Resolution. Click OK.

The Save As PNG Setting dialog box closes.

14 Specify a storage folder and file name click Save.




.


15 Open the PNG file with SnagIt 7 Editor.

16 Select Image, Scale, Resize Image.

17 Verify that the image width is 800 pixels or less.

18 Select Image, Resolution.

19 Verify that the Resolution (dots per inch) is 144; click OK.




.


20 Select File, Exit and Save the changes.

--End--

Extracting embedded graphics using Acrobat and PhotoshopGraphics created by the FrameMaker graphics editor and inline embeddedgraphics for which you do not have an external file, have to be extractedfrom FrameMaker and saved as PNG files for inclusion by reference inEpic Editor XML files. Use the following procedure to extract embeddedgraphics using Acrobat and Photoshop.

Procedure Steps

Step Action

1 Open the required FrameMaker file.

2 Right-click the required embedded graphic and select Copy.

3 Open a new FrameMaker document and Paste the imagecopied in step 2.

4 Save Framemaker document as an .fm file.

5 Save FrameMaker document as a .pdf file.

6 Open Photoshop.

7 From within Photoshop, select File, Open and open the required.pdf file.

8 Specify a Resolution of 144 pixels/inch and Mode as RGBColor and click OK.

9 Select the Rectangular Marguee Tool.




.


10 Draw a rectangular area around the image.

11 Select File, Crop.

12 Select Image, Image Size. Image Size box appears.

13 Verify that Width is less than 800 pixels, in the PixelDimensions.Image Size.

14 Verify that the Width is less than 33.6 pica and the Height isless than 47 pica in the Print Size option.

15 Click OK. The Image Size box closes.

16 Select File, Save for Web.

17 Set Settings to PNG24 and click OK.




.


18 Save the file at the required location.

--End--

Extracting embedded graphics using HTML and IllustratorGraphics created by the FrameMaker graphics editor and inline embeddedgraphics for which you do not have an external file, have to be extractedfrom FrameMaker and saved as PNG files for inclusion by reference inEpic Editor XML files. If you plan to continue to use the FrameMakergraphics editor, copy and paste each FrameMaker-editable graphic into itsown graphics-only FrameMaker (.fm) file. Use the following procedure toextract embedded graphics using HTML and Illustrator.

Procedure Steps

Step Action

1 Open the required Framemaker file.

2 Right-click each graphic created by the FrameMaker graphic tooland select Copy and Paste into separate FrameMaker (.fm)files.

3 Select File, Utilities, HTML Setup.

4 Exit out of the HTML Setup window.

5 Select View Reference Pages.

6 Find the HTML Option Table.

7 In the Image Format row, change Value to EPS.

8 Select File, Save As. and navigate to the required Save infolder. Type in the required filename.

9 Save the file as HTML (*htm). Click Save.

10 Open the folder that contains the saved files.

11 Change all GIF file extensions to EPS.

12 Open each EPS file with Illustrator.

13 Select Edit, Select All.

14 Delete the bounding box, if there is one.

15 Select Window, Show Info.

16 Verify that the image width is less than 33.6 pica and the imageheight is less than 45 pica.

17 Resize the image, if necessary.





.


19 Select Save As and type PNG.

20 Specify a Resolution of 144 ppi and do not select Anti-Alias.

21 In the PNG Options box set Interlace to None and Filter toAdaptive.

22 Click OK.

--End--

Graphic managementCreate source graphics in PNG format to link from your local PC to thepublishable.

Graphic management proceduresThis task flow shows you the sequence of procedures you perform toconfigure the ATM MPE. To link to any procedure, link to any procedure,go to "Graphic management navigation" (page 184)

Graphic management navigation


• "Storing source graphics" (page 186)

• "Editing graphics" (page 188)

Linking to graphicsUse this procedure to insert graphics into your XML document.




.

Graphic management 185

Prerequisites

• Ensure images follow NTDA guidelines

Procedure Steps

Step Action

1 Ensure all images are available on your PC.

2 For an existing image, locate it in Documentum. Right-click theimage and select Check Out. Checked out images will be storedin your local Documentum Checkout folder.

3 Position the cursor where you want to insert a figure. Pressthe Enter key; and then select Figure from the list of availableoptions.

4 Locate the required image file and click Open.

5 Specify the Image attributes and click OK.




.


6 Specify the Figure attributes and click OK.

Attention: When you check in a document with graphics, theywill be stored automatically in a Documentum docbase GraphicsDocNumber or ComponentName folder.

--End--

Storing source graphicsAll new graphics must be stored on your PC. Use this procedure to storesource graphics into Documentum.

Prerequisites

• Ensure all graphics follow NTDA graphic guidelines

• Ensure all source graphics are in PNG format.

Procedure Steps

Step Action

1 Store all new graphics on your local PC they are to be linkedfrom.

2 From XML document, link to a PNG, JPG, GIF, or SVG and saveit.

3 Using the Documentum Desktop Client, Check In the document.All linked graphics will be auto-stored in Graphics /DocNumber orComponentName folders.

4 For each graphic that has an editable source graphic (eg, EPS,FM, INS), click the associated graphic in Documentum andselect View, Document Info.




.


5 Click View and select Renditions of Version from the list.

6 Drag-and-drop the source graphic into the Renditions Windowarea.

7 Click OK to paste the source graphic as a rendition.

Graphic is pasted into Documentum.




.


--End--

Editing graphicsUse this procedure to edit graphics for your publishable.

Prerequisites

• Existing editable graphics are stored as Documentum Renditions.

Procedure Steps

Step Action

1 Click the Arbortext Documentum menu item and select Browse.

2 In Docbase Browser, navigate to docbase Graphics.

3 Right-click the required graphic and select Check Out.

4 From the Rendition window, drag-and-drop the editable graphicinto the local Documentum Checkout folder.




.


5 Open and Edit the editable graphics file and Save the changesmade.

6 Export a PNG format version and replace the current PNGversion in the Documentum Checkout folder.

7 Using Desktop Client, right-click the checked-out graphic andselect Check In. Check in the document as a new version(Minor change).




.


8 Within XML files that need to use the updated graphic, link to thenew version of the graphic.

--End--




.

191.

Cloning tasks and proceduresPerform the following tasks to clone a file as necessary.

Navigation• "Cloning a module" (page 191)

• "Cloning a publishable and modules within it" (page 198)

• "Cloning publishable but not modules within it" (page 194)

Cloning a moduleThe following tasks show how to properly clone a module.

Cloning a module tasksThis task flow shows you the sequence of tasks you perform to clone amodule.To link to any task, click on "Cloning a module Navigation" (page192)




.

192 Cloning tasks and procedures

Figure 48Cloning a module tasks

Cloning a module Navigation

• "Cloning a module procedure" (page 193)










.

Cloning a module 193

• "Pasting objects using object references" (page 407)






Cloning a module procedureUse this procedure to create a new module based on an existing one.

Attention: Do not use this procedure if the module contains other chunked modules that you do not want to clone; for example, Chapter/Module,ProcedureModule/ProcedureUnit, or ReferenceModule/ReferenceUnit. See"Cloning a document but not modules within it" (page 196)

Procedure Steps

Step Action

1 Before cloning any module, prepare a spreadsheet of imagesand links used by it and identify other documents that re-use themodules/images.

2 Navigate to the module to be cloned within nonmtbi, nonmtbi2,or mtbi2 within the ecmprod docbase.

Attention: Prior to cloning, the document must be valid,complete, and error free.

3 Right-click the required module and select File, Send To,Folder, As Document.

4 Select Also export descendents and Save the file on your localPC in a new folder as old-filename.xml.

5 Open the saved file with Arbortext Editor.

6 Select Tools, Dynamic Link Manager, Connect. Type dca;click OK.

7 Modify the module ObjectName attribute value and DocNumberattribute value.




.


8 Click View, Generated Text and verify that Show and NoAuto-Updates are checked.

9 Select File, Save As type new-filename.xml.

10 Verify that new-filename and old-filename DCAM/DLM-ids aredifferent.

--End--

Cloning publishable but not modules within itThe following task flow shows how to properly create a new publishablethat re-uses the same modules as an existing publishable.

Cloning publishable but not modules within it tasksThis task flow shows you the sequence of tasks you perform to clone apublishable and modules within it. To link to any task, click on "Cloningpublishable but not modules within it Navigation" (page 195)




.

Cloning publishable but not modules within it 195

Cloning publishable but not modules within it Navigation

• "Cloning a document but not modules within it" (page 196)








.









Cloning a document but not modules within itUse this procedure to create a new publishable, chapter, or module basedon an existing one. This procedure supports the following situations:

• Any mtbi2, nonmtbi, or nonmtbi2 publishable

• Any nonmtbi2 Chapter element that contains Module elements

• Any mtbi2 ProcedureModule or ReferenceModule that containschunked ProcedureUnit or ReferenceUnit elements

Procedure Steps

Step Action

1 Close all Arbortext Editor sessions and turn off theDocumentum XML adapter. With Notepad, openfeature.cf in the Arbortext/Editor/lib folder and setfeatureAdapterXMLDocumentum to off.

2 Navigate to the document in mtbi2, nonmtbi or nonmtbi2 to becloned within the ecmprod docbase.




.

Cloning publishable but not modules within it 197


3 Right-click on the required document and select File, Send To,Folder, As Document.

4 Deselect Also export descendents and then Save the file onyour local PC in a new folder as old-filename.xml.


Attention: The file can take longer to open than you wouldnormally expect.


7 Within the top-level element, enter new-filename in theObjectName attribute field (determines the object filename). Ifrequired, also change the value in the DocNumber attribute fieldand click OK.



10 Verify that the top-level element in new-filename andold-filename have different DCAM/DLM ids.

11 Close all Arbortext Editor sessions and turn on theDocumentum XML adapter. With Notepad, openfeature.cf in the Arbortext/Editor/lib folder and setfeatureAdapterXMLDocumentum to on.




.


--End--

Cloning a publishable and modules within itThe following task flow illustrates how to properly clone publishables andmodules and images within it.

Cloning a publishable and modules within it tasksThis task flow shows you the sequence of tasks you perform to clone apublishable and modules within it. To link to any task, click on "Cloning apublishable and modules within it navigation" (page 199)




.

Cloning a publishable and modules within it 199

Cloning a publishable and modules within it navigation

• "Cloning a document and modules within it " (page 200)









.








Cloning a document and modules within itUse this procedure to create a new publishable or module and imageswithin them based on an existing publishable or module.

Procedure Steps

Step Action

1 Before cloning any publishable or module, prepare aspreadsheet of modules and images used by it and identify otherdocuments that re-use the modules/images.

Attention: If you clone re-used modules, all links between andto them will have to be re-inserted.

2 Navigate to the publishable or module to be cloned within thenonmtbi, nonmtbi2, or mtbi2) cabinet within the ecmproddocbase.


3 Right-click the required document and select File, Send To,Folder, As Document.

4 Select Also export descendents and Save the file on your localPC in a new folder as old-filename.xml.




.

Cloning a publishable and modules within it 201



7 In all documents that use re-use modules/images, delete allre-used modules/images and then save the document.

8 Within all modules, enter the required ObjectName attributevalue and DocNumber attribute value.



11 Verify that new-filename and old-filename DCAM/DLM-ids aredifferent.

--End--




.





.

203.

File-naming conventionsNTDA file-naming conventions are provided for XML publishable objects;modules, text, and graphic objects; and PDF publishable objects.

Navigation• "File-naming XML publishable objects" (page 203)

• "File-naming module, text, and image objects" (page 203)

• "File-naming PDF publishable objects" (page 207)

File-naming XML publishable objectsThe XML the file name format is ObjectName.xml.

When saving a publishable the ObjectName is the DocNumber. Usethe DocNumber as the filename. You can use up to 15 alphanumericcharacters, plus dash and underscore.

Filename conventions Example

NNnnnnn-nnn.xml NN18354-179.xml

nnnnnnnn.xml NT4K00AA.xml

nnn-nnnn-nnn.xml 241-6001-100.xml

The IM DocNumber format is composed of a customer code (ccc), marketcentre code (mcmc), module type (mm), and method number (nnnn).

Filename conventions Example

cccmcmc-mm-nnnn 0000007-28-0483.xml

File-naming module, text, and image objectsThe format of the filename should be: ObjectName.xml (.png, .jpg, .gif,.svg) = pimm_Identifier_Title, where

• ObjectName become the filename in Documentum and should be nomore than 60 characters (maximum of 64 including 4 characters for afile extension of .xml, .png, .jpg, .gif, or.svg).




.

204 File-naming conventions

• pi is a two-character product identifier; for example, KS indicatesKnowledge Services. See Product Identifiers - filenaming @ http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10985474

• mm is a two-character module type, see Table 3 "Module types" (page204)

• Identifier is an unique identifier composed of 4 to 16 alphanumericcharacters; for example, NTDA indicates the Nortel TechnicalDocumentation Application. Typically, an authoring group acronym isused for the identifier.

• Title contains the text of the top-level heading (maximum of 38 to 50characters)

Table 3Module types

Module type character

ConceptModule CM

ConceptUnit CU

Content Grouping CG

Media Object(Image, audio, video)

MO

ProcedureModule PM

ProcedureUnit PU

ReferenceModule RM

ReferenceUnit RU

Taskflow TF

TerminologyModule TM

WhatsNew WN

Workflow WF

In general, do not include a DocNumber in any module ObjectName. Youcan use the alphanumeric characters, em dash and underscore.




.



File-naming module, text, and image objects 205

Attention: Do not use the following characters ~ ‘ ! @ # $ % ^ & * ( ) = +[ ] { } \ | ‘ ’ “ ” < > / ? , . : ; spaces

Communicate your file-naming strategy with other groups that are sharingyour content.

Example

KSWF_NTDA001_Workflow.xml

KSTF_NTDA002_NonMTBI-Taskflow.xml

KSPM_NTDA003_Editing-documents.xml

KSPU_NTDA003_Example-editing-documents.xml

KSRM_NTDA004_Invalid-characters-headings.xml

KSRU_NTDA004_Example-Invalid-characters-headings.xml

KSMO_NTDA005_Authoring-process.png

NTDA group file-naming strategyThe file-naming strategy used by the NTDA tools group is defined below.

The format of the filename should be: ObjectName = KSmm_NTDA_cccnnn_ObjectTitlefilename should be: ObjectName.xml (.png, .jpg, .gif,.svg) = KSmm_NTDA_cccnnn_ObjectTitle, where

• KS is the Knowledge Services product identifier

• mm is a 2 character module type, see Table 4 "NTDA module types(mm)" (page 205)

• NTDA NTDA indicates the Nortel Technical Documentation Applicationtools group.

• ccc is a three character code that indicates the topic class, see Table 5"NTDA topic classes (ccc)" (page 206)

• nnn is a number in the range 000 to 999

• ObjectTitle is the object’s alphanumeric (and - or _) heading (up to 46characters)

Table 4NTDA module types (mm)


ConceptModule CM

ConceptUnit CU

ContentGrouping CG




.


Table 4NTDA module types (mm) (cont’d.)


Media Object(Image, audio, video)

MO

ProcedureModule PM

ProcedureUnit PU

ReferenceModule RM

ReferenceUnit RU

Taskflow TF

TerminologyModule TM

WhatsNew WN

Workflow WF

Table 5NTDA topic classes (ccc)

Topic class Code

Authoring AUT

Documentum DOC

Dynamic Link Manager DLM

Frequently-Asked Questions FAQ

General GEN

onProduct Help HLP

Image IMG

Multistreaming MST

Profiling PRO




.

File-naming PDF publishable objects 207

Table 5NTDA topic classes (ccc) (cont’d.)

Topic class Code

Publishing PUB

Training TRN

In general, do not include a DocNumber in any module ObjectName. Youcan use the alphanumeric characters, em dash and underscore.

Attention: Do not use the following characters ~ ‘ ! @ # $ % ^ & * ( ) = +[ ] { } \ | ‘ ’ “ ” < > / ? , . : ; spaces

Communicate your file-naming strategy with other groups that are sharingyour content.

Examples

KSWF_NTDA_AUT001_NonMTBI2-Authoring.xml

KSTF_NTDA_DLM002_Fixing-DLM-Errors.xml

KSPM_NTDA_AUT003_Editing_documents.xml

KSPU_NTDA_AUT003_Editing-module.xml

KSRM_NTDA_FAQ004_Invalid_characters.xml

KSRU_NTDA_FAQ004_Invalid-characters-headings.xml

KSMO_NTDA_AUT005_Authoring-process.png

File-naming PDF publishable objectsFor a PDF publishable there is a maximum of 31 characters, including the.pdf extension. The current maximum of 31 characters is to accommodatedelivering PDF via Helmsman which uses the ISO 9660 standard; a futureversion of NTDA will support 64 characters.

The file name format for a PDF publishable is: DocNumber_DocRevision_Descriptor.pdf

The formatting is as follows:

• The DocNumber must only be 1 to 15 characters in XML andmaximum 20 characters for migration in Documentum.

• DocRevision must be 5 characters in XML and 6 for migration inDocumentum.

• The Descripter is an optional free-form element ranging from 0 to 5characters.




.


• The DocNumber_DocRevision portion of the file name must beunique for all PDF publishables.

• Can only use alphanumeric characters plus dash, underscore, andperiod.

Example

NN18354-179_04-01.pdf

NN18354-179_v1_04-01.pdf

NT4K00AA_01-01.pdf

241-6001-100_b-05.pdf




.

209.

Metadata assignmentMetadata assignment determines each attribute to a publishable.The appropriate attributes are assigned in both Arbortext Editor andDocumentum.

Navigation• "Metadata fundamentals" (page 209)

• "Updating DocRevision policy" (page 209)

Metadata fundamentalsMetadata must be assigned to all XML files. Some metadata mustbe specified within the XML file and the rest when the file is checkedinto Documentum. The required metadata assignment depends onwhat type is assigned to the file when it is checked in: ks_module orks_publishable.

Metadata assignment in the XML file is used to determine the storagefolder in Documentum.

Metadata assignment in Documentum determines how the content canbe filtered in the publishing environment (TS Portal). The DocRevisionattribute controls the publishing of documents to the TS Portal.

When a XML file is checked out of Documentum, metadata common toboth ks_module and ks_publishable can be viewed in the XML file viametadata attributes defined in the Document Type Definition (DTD) file.

Updating DocRevision policyWithin the NTDA system, the DocRevision attribute is used to controlthe publishing of documents to the TS Portal. In order to automate thepublishing of documents DocRevision must be used consistently by allgroups using the NTDA system.




.

210 Metadata assignment

NTDA DocRevision policyThis policy defined below must be used to define a value for theDocRevision attribute.

• Each time a publishable is checked into Documentum, theDocRevision value must be updated

• For a new publishable, the DocRevision value must be set to 01.01or a.01

• DocRevision value has two parts: nn.nn or a.nn

— The first nn or a is the major number/letter. It must be incrementedby 1 when a document is published for different software releases.

— The second nn is the minor number. It must be incremented by 1when a document is republished within the same software release.

• During development and for internal viewing only (that is, it will notbe published by the Release List to the TS Portal), use alphabeticcharacters for the minor number; for example, 01.AA, 01.AB, 01.AC,etc.

• For external customer viewing (that is, for publishing by the ReleaseList to the TS Portal), use numeric characters for the minor number; forexample, 01.01, 01.02, 01.03, etc.

Attention: For more details and examples, see the NCDS IssueInformation section (http://livelink-ott.ca.nortel.com/livelink/livelink.exe/open/23708639)




.

http://livelink-ott.ca.nortel.com/livelink/livelink.exe/open/23708639


211.

Change bar managementChange bars are used to indicate changes in documents. They shouldbe applied during document development and removed before deliveringto customers. Change bars are set on individual elements using aChangeBar attribute value. For nonmtbi2 and mtbi2, the display of changebars in PDF files is controlled by the ChangeBarOn attribute on the parentelement.

Not all projects require change bars; consult with your project manager(PM) to determine whether you require change bars in your documents.

Navigation• "Change bars and document lifecycle" (page 211)

• "Applying change bars" (page 212)

• "Removing change bars" (page 214)

• "Controlling the display of change bars" (page 215)

Change bars and document lifecycleChange bars should only be used to indicate technical and contentchanges in a document, not editorial or format changes. Continue todocument all changes in the WhatsNewModule.

The following reference information shows how to use change bars at eachstep of the document lifecycle.

Change bars and document lifecycle stagesPre-CuRThe Project Manager (PM) can optionally release documents to the TSPortal with change bars displayed. Check with your PM about whether ornot to display change bars pre-CuR.




.

212 Change bar management

CuR and post-CuRChange bars must never be visible to customers in documents on theTS Portal. Leave the change bar tags in the XML source but turn off thedisplay before you release the document to the TS Portal so that they donot show in the PDF rendition of the document.

Remove content marked for deletion before you release the document tothe TS Portal. If you do not remove content marked for deletion it will showwith the strikethrough in the PDF rendition of the document, even when thedisplay of change bars is turned off.

Post-ChRAuthors can optionally use change bars to indicate CR fixes. Changebars must never be visible to customers in documents on the TS Portalpost-ChR. Leave the change bar tags in the XML source but turn off thedisplay before you release the document to the TS Portal so that they donot show in the PDF rendition of the document. Remove content markedfor deletion before you release the document to the TS Portal.

In a new version of a document based on a new release streamClear all change bar tags from the XML source and add them again fromscratch as you make changes.

Under investigationKnowledge Services (KS) needs additional guidelines about the useof change bars in reuse and multistreaming situations. Core IA isinvestigating and will provide information about these scenarios asappropriate.

Applying change barsChange bars are used to indicate changes in documents. They should beapplied during document development. Use the following procedure toapply change bars to elements that contain changed content.

Procedure Steps

Step Action

1 Within any element containing content that requires a change barindication, click Edit, Modify Attributes.




.

Applying change bars 213

2 In the ChangeBar attribute field, select Changed or Delete andthen click OK.

Attention: For nonmtbi, do not use the Add or Unchangedvalues and do not set the ChangeBar attribute on any Heading,Title, or Caption element.

3 Repeat for each element containing changed content and thensave the document

--End--

Change bars in XML and PDFWhen a PDF file is created, a change bar will be inserted in the outsidepage margin; for the Delete value, the text will also include a strikethroughline.

Figure 49Change bars in XML

Figure 50Change bars in PDF

NonMTBI2 elements that support change barsThe display of change bars is restricted to elements that support theChangeBar attribute, which is available on the following elements:

Caption Module Term

Chapter Note TermDef

CliResponse Paragraph TermGroup

Command Precaution Terminology

Definition Precautions Title




.


Example Procedure Where

Figure Section Option

GuiResponse Step Value

Heading StepGroup Context

List Table Item

MTBI2 elements that support change barsThe display of change bars is restricted to elements that support theChangeBar attribute, which is available on the following elements:

Attention List ReturnTo

Caption Navigation Section

CliResponse Note Step

Command Overview SubList

ConceptModule Paragraph SubListItem

ContentGroupingModule Precaution Table

Definition Prerequisites TaskModule

Example PrItem Term

Figure PrList TermDef

Flowchart ProcedureModule TermGroup

GuiResponse ProcedureUnit TerminologyModule

Heading Purpose Title

IfGraphic ReferenceItem WhatsNewModule

Item ReferenceModule WorkflowModule

JobAid ReferenceUnit

Removing change barsUse the following procedure to remove change bars before delivering tocustomers.

Procedure Steps

Step Action

1 To remove a single ChangeBar setting within a single element,click Edit , Modify Attributes.

2 Select the blank ChangeBar value and click OK.




.

Controlling the display of change bars 215

3 To remove all ChangeBar settings in the currently opendocument, click Nortel, Remove all ChangeBars

--End--

Controlling the display of change barsThe display of change bars in PDF files on elements containing aChangeBar attribute is controlled by the ChangeBarsOn attribute onparent elements.

The ChangeBarsOn setting applies to all child elements that have aChangeBar Changed or Delete setting.

The ChangeBarsOn attribute is supported on the following elements:

• NonMTBI2 elements:: nonmtbi2, Chapter, Module, Terminology

• MTBI2 elements: mtbimap, mtbitopicref, ConceptModule,ContentGroupingModule, ProcedureModule, ProcedureUnit,ReferenceModule, ReferenceUnit, TaskModule, TerminologyModule,WhatsNewModule, WorkflowModule

Procedure Steps

Step Action

1 Within an element that supports the ChangeBarOn attribute,click Edit , Modify Attributes.

2 In the ChangeBarOn field, select the required attribute value.• Select No to hide change bars.• Select Yes to display change bars.

Attention: Select the attribute value even if it already indicatesthe required setting.

3 Click OK to set the selected attribute value.

--End--




.


Controlling the display of change bars in a nonmtbi2 PDF fileFor example, If ChangeBarsOn is set to No on the mtbimap ormtbitopicref element and ChangeBarsOn is set to Yes on chunkablemodule elements that contain elements with the ChangeBar attribute setto Changed or Delete, then no change bars will be displayed in the PDFfile.

If the ChangeBar attribute is set on a chunkable element, the display ofchange bars in the PDF file is controlled by the ChangeBarsOn settingof the parent element independently of its own ChangeBarsOn setting.For example, if a Chapter ChangeBarsOn attribute is set to No and theChangeBar attribute is set to Changed, change bar display in the PDFfile for the complete Chapter is controlled by the ChangeBarsOn settingon the nonmtbi2 element.

Table 6Change bars in a NonMTBI2 PDF file

Chapter Modulenonmtbi2 ChangeBarsOn

ChangeBarsOn

ChangeBar

ChangeBarsOn

ChangeBar

Change bars inPDF file

Yes Yes - Yes - Yes on all elements

No Yes - Yes - No

Yes No Changed Yes - Yes on completeChapter

Yes Yes - No - Yes on Chapter. No onModule.

Yes Yes - No Changed Yes on Chapter and oncomplete Module

Controlling the display of change bars in an mtbi2 PDF fileIf ChangeBarsOn is set to No on the mtbimap or mtbitopicref elementand ChangeBarsOn is set to Yes on chunkable module elements thatcontain elements with the ChangeBar attribute set to Changed or Delete,then no change bars will be displayed in the PDF file.

If the ChangeBar attribute is set on a chunkable module, the display ofchange bars is controlled by the ChangeBarsOn setting of the parentelement independently of its own ChangeBarsOn setting. For example,if a ConceptModule ChangeBarsOn attribute is set to No and theChangeBar attribute is set to Changed, the change bar display in the PDFfile for the complete ConceptModule is controlled by the ChangeBarsOnsetting on the mtbitopicref and mtbimap elements.




.

Controlling the display of change bars 217

Table 7Change bars in an MTBI2 PDF file

Chunkable Module Chunkable UnitmtbimapChangeB

arsOn

mtbitopicref Change

BarsOnChangeB

arsOnChangeBar

ChangeBarsOn

ChangeBar

Change bars inPDF file

Yes Yes Yes - Yes - Yes on Module andUnit

No Yes Yes - Yes - No

Yes No Yes - Yes - No

Yes Yes No - Yes - No

Yes Yes Yes - No - Yes on Module. Noon Unit




.





.

219.

NTDA profilingThe following outlines different profiling procedures.

Navigation• "Profiling fundamentals" (page 219)

• "Updating and replacing PCF and entities-config.acl files" (page 220)

• "Creating profiles" (page 221)

• "Applying profiles" (page 223)

• "Viewing profiles" (page 225)

Profiling fundamentalsWithin Arbortext Editor, the equivalent of Conditional Text is Profiling.

Arbortext Editor profiles let you designate that certain elements containinformation targeted at a specific audience or contain information that onlyapplies when a particular set of circumstances exist.

Profiles to use are set at publishing time. Only those sections of thedocument that are unprofiled or have the same profiles applied to them asthose profiles you set at publishing time appear in the published document.The profiles you can apply are defined in the DTD profiling configurationfile (PCF). The PCF file is centrally controlled for use with all documentsglobally.




.

220 NTDA profiling

Figure 51Profiling process

Updating and replacing PCF and entities-config.acl filesProfile configuration file (PCF) and entities-config.acl files are replacedweekly. New profile values should only be added to contentProfile.pcfand releaseProfile.pcf.

Attention: Text entities within entities-config.acl files (one for nonmtbiand one for nonmtbi2/mtbi2) are only supported for CVoIP releases andthe CVoIP authoring groups are responsible for updating and testing thevalues therein, see "Updating the contents of entities-config.acl" (page351)

Profile value changes are added to the appropriate profile configuration file(PCF) by the NTDA core team. The NTDA core team is also responsiblefor replacing the updated and tested PCF and entities-config.acl files inDocumentum and on the PE servers.

PCF change and entities-config.acl replacement requests mustbe initiated via an NTDA CR that includes specific change detailsand the names of the approving PMs and IAs; requests that do notinclude all the required information will be returned. To raise a NTDACR, see "CRs - Raising a CR against NTDA" available on Livelink athttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10985474

All complete and approved requests received before Wednesday noonwill be included in the Documentum nonmtbi, nonmtbi2, and mtb2 DTDfolders by Thursday noon.




.


Creating profiles 221

After the checkout of any document from the docbase being used, theupdated profile and text entity values can be applied immediately byauthors.

An IT ticket will be raised by Thursday noon to request that the updatedfiles be added to the nonmtbi, nonmtbi2, and mtbi2 DTD folders on allPE servers and the Profile tab in Documentum. After a weekly-scheduledrestart of the PE servers at 8pm ET on Thursday, updated profile valueswill be available for setting while composing PDF files. Updates to textentities within entities-config.acl do not require a PE server restart. Thisprocess is outlined in Figure 52 "Updating PCF tasks" (page 221)

Figure 52Updating PCF tasks

Creating profilesWithin the NTDA environment, the DTD profiling configuration file (PCF)is centrally controlled for use with all documents globally. Creating newprofiles involves creating a group PCF using Arbortext Editor; editingglobalProfiles.pcf using Arbortext Editor; and adding new profile attributesto the globalProfiles.ent entity definition file which is referenced from theDTD. Use the following procedure to create profiles.

Attention: This for information purposes only.




.

222 NTDA profiling

Procedure Steps

Step Action

1 Check out and open groupnameProfile.pcf, with ArbortextEditor, and rename the file to <YourGroupName>Profile.pcf.

2 Position cursor after ProfileClasses, press Enter and selectProfile.

3 In alias and attribute, type your groupname; in attribute, prefixgroupname with ct- and click OK.

4 Insert Allowed or ProfileFolder elements for each condition;add Allowed elements for each condition value.

5 Save and Check In <YourGroupName>Profile.pcf.

6 Check out and open, with Arbortext Editor, globalProfiles.entand add your group profile attribute, Save and Check in.

7 Check out and open, with Arbortext Editor, globalProfiles.pcfand insert a reference to <YourGroupName>Profile.pcf, Saveand Check in.

All future checkouts will receive the updated profiles

--End--




.

Applying profiles 223

Job aidFor more information on customizing your site’s profiling configuration, seeArbortext Editor Customizers Guide (http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9793342)

Applying profilesUse the following procedure to apply profiles.

Procedure Steps

Step Action

1 Insert the cursor anywhere in the element to be profiled.

2 Select Edit, Profiles, Apply Profiles.

3 In the Mode section of the Apply Profiles dialog box select ApplyIndividual Profiles.

4 In the Apply Individual Profiles dialog box check the requiredprofile values.

5 Click OK to apply the specified profiling.




.



224 NTDA profiling

The selected profile values will be added to the elementattributes.

--End--

Example of applying profiles to table rows

Procedure Steps

Step Action

1

Attention: Do not apply profiles to the tgroup or tbodyelements or to all row elements.

In the Editor Document Map window, double-click the rowelement to be profiled.

2 Select Edit, Profiles, Apply Profiles.




.

Viewing profiles 225

3 In the Mode section of the Apply Profiles dialog box select ApplyIndividual Profiles.

4 In the Apply Individual Profiles dialog box check the requiredprofile values.

5 Click OK to apply the specified profiling.

The selected profile values will be added to the elementattributes.

--End--

Viewing profilesUse the following procedure to view the created profiles in yourpublishable.

Procedure Steps

Step Action

1 Select Edit, Profiles, View Profiled Document.

2 Click the profile values to select and click OK.

Both unprofiled and selected profiled content will be displayedand unselected profiled content is hidden.

--End--




.

226 NTDA profiling




.

227.

NTDA publishingNTDA publishing currently involves manually creating a PDF file or HTMLhelpset.

Navigation• "Publishing fundamentals" (page 227)

• "Lifecycle process" (page 228)

• "Publishing from ecmprod - an interim process" (page 236)

Publishing fundamentalsThe following reference information shows the publishing process includingorder of tasks and metadata fields.

Navigation• "Publishing process" (page 227)

• "Release list metadata" (page 228)

Publishing processAfter authoring content and checking it into Documentum all content thathas been checked in as type ks_publishable can be published.

Publishing is controlled by a Release List created and controlled by aRelease Coordinator. A Release List represents a logical grouping ofdocuments that fall under the same criteria of Product Name and/orSoftware Release Number and/or Feature Set and/or Security Level andPart Number. See the process, Figure 53 "Release list tasks" (page 228) .




.

228 NTDA publishing

Figure 53Release list tasks

Legacy PDF documents, that are not stored in Documentum, can bepublished after metadata assignment.

Release list metadataThe following release list metadata must be specified. The metadata ispopulated in the following format.

Metadata Assignment

Collection Title free text

Collection Revision auto populated

Collection Publish Date auto populated

Product TS Portal Pick List

Software Release TS Portal Pick List

Feature Set TS Portal Pick List

Release Coordinator free text

Security Level TS Portal Pick List

Part Number optional

Status auto populated

Comment free text

Lifecycle processThe following information describes Lifecycles and its process.

Navigation

• "Lifecycle states" (page 229)

• "Lifecycle conversion tasks" (page 235)

• "Approved lifecycles" (page 236)




.

Lifecycle process 229

Lifecycle statesA NTDA Lifecycle represents the state of a content object insideDocumentum during the authoring and review cycle until it is publishedto Enigma. The final end state is the archived state where the content isphysically removed from active storage.

There are five main NTDA Lifecycles:

• ks_module, see Figure 54 "ks_module tasks" (page 230)

• ks_publishable

• SMEReview module, see Figure 56 "SMEReview module tasks" (page233)

• SMEReview publishable

• im_publishable

Attention: There is also a sixth lifecycle for use during conversion, titled:Conversion.

The ks_module lifecycle state uses the following process, see Figure 54"ks_module tasks" (page 230)




.

230 NTDA publishing

Figure 54ks_module tasks

To apply the ks_publishable lifecycle modules are created to buildpublishables. Reviewers are assigned and a workflow is attached toinitiate auto-generation of PDF.

Existing PDF deleted before new PDF generated. Once the new PDF isgenerated publishable is locked (modules remain unlocked) and it is autopromoted to Review. An email is sent to promoter.

If email response is Approved the publishable is auto promoted toConditionally Approved, an email sent to Release List Coordinator. IfRejected publishable is auto demoted to assembling phase, it becomesunlocked and PDF file not deleted.

Release Coordinator reviews PDF after receiving an email. If approvedPDF is auto promoted to Approved. If Rejected it is auto demoted to theassembling phase.




.


Publishables available for selection in Release List application. ReleaseList is created by Release Coordinator. Release List is QA’d (entirecollection); Release Coordinator needs to be able to view documentswithin QA environment (includes all formats for the web channel).

When Release List is approved the Release List is Published. When thePDFs/HTMLs are created they are put in a staging area. You will be ableto go in and look at the documents in the context of the Release List todetermine if you are ready to publish.

The cancelled option is not currently used. Possible production use.(Cancel could triggers RL app to do something, then moves it to Archivedto trigger Documentum to do something) Need to consider in future release(2.1/2.2); eg, 2.1 -> Canceled takes a document out of possible selectionby RL app. See Figure 55 "ks_publishable tasks" (page 232) for anoverview of the whole process.




.

232 NTDA publishing

Figure 55ks_publishable tasks

SMEReview module uses the following process, see Figure 56"SMEReview module tasks" (page 233)




.


Figure 56SMEReview module tasks

The SMEReveiw publishable process is as follows, see Figure 57"SMEReview publishable tasks" (page 234) .




.

234 NTDA publishing

Figure 57SMEReview publishable tasks

The im_publishable process is as follows, see Figure 58 "im_publishabletasks" (page 235)




.


Figure 58im_publishable tasks

Lifecycle conversion tasksDuring the conversion of a publishable a ConversionLifecycle is appliedby Innodata and an Innodata employee is assigned as the Owner.




.

236 NTDA publishing

When the converted publishable is ready for a QA review by Nortel,Innodata promotes the ConversionLifecycle to the ConvReview state.

After a successful QA review and acceptance by Nortel the convertedpublishable ConversionLifecycle state should be promoted to theConvApproved state by the Nortel approver.

Attention: At the ConvApproved state it will still have an Innodataemployee assigned as the Owner.

Approved lifecyclesBefore editing a converted and approved publishable the Ownershould be changed to a Nortel RFT or vendor employee and a newks_publishable_lifecycle should be attached to it. Eventually, allpublishables must be in an Approved ks_publishable_lifecycle statebefore they can be published using the NTDA Release List to the NortelTS Portal.

Publishing from ecmprod - an interim processUntil the NTDA Release List application is fully developed, use thisprocess to publish documents.

Procedure Steps

Step Action

1 Ensure that the APTLMHOST environment variable is set to @47.10.32.186

2 Verify that:

• peservices set to on

• showenties set to both

Verify that the peserverurl is set to the appropriate url:

• http://47.10.32.229:8080/e3/servlet/e3/ Nortel staff (ztcfs0n8)

• http://47.10.32.186:8080/e3/servlet/e3/ Vendor staff(ztcfs0mh)

• http://47.10.32.150 :8080/e3/servlet/e3/ testing (ztcfs0m2)

3 Within a Documentum ecmprod Publishables folder, locate theXML publishable to be published.

4 Check out and open the XML publishable with Arbortext Editor.




.

Publishing from ecmprod - an interim process 237

5 Connect to the DLM server, select Tools, Dynamic LinkManager, Connect.

6 Generate a PDF file, select File, Compose, PDF Fileor PDF File With Bookmarks. For nonmtbi, select thePDFnonmtbiWBM.xsl stylesheet.

7 Close the document and cancel the checkout of the XMLdocument.

8 Click the XML document and select View, Document Info.

9 In the bottom window of Documentum, select View: Renditionsof Version from the drop-down list.

10 Drag-and-drop the PDF file into the rendition window.

11 Right-click the XML document and select Properties.

12 Click the Advanced tab and check if a lifecycle has beenattached to the XML document, then click Cancel. If there is anattached lifecycle go to step 15.

13 Right-click the XML document and select Document Lifecycleand Apply.

14 Select ks_publishable_lifecycle.

15 Right-click the XML document and select Document Lifecycleand Promote.

16 Repeat step 15 until the document lifecycle State indicated isApproved.

17 Use your existing non-XML process to publish the PDF filecreated during step 6.

For example, store the PDF file in LiveLink or on a server andthen publish via Helmsman using the metadata defined in theXML document.

Attention: If you open the PDF file and change anything,always use Save As to automatically save the file as "Fast WebView".

--End--




.

238 NTDA publishing




.

239.

Multistreaming optionsA full multi-streaming enhancement is planned for a future NTDA release;until this enhancement is introduced, NTDA currently supports partialmulti-streaming using one of three options (a fourth option is also beingtested but is not generally available yet). For all options, the samepublishable can not be used for different software release deliverables.The option used is at the discretion of PMs. All projects sharing re-usedmodules must use the same option. The following describes thisinformation.

Navigation• "Multistreaming option 1" (page 239)

— "Multistreaming procedure, option 1" (page 240)

— "Multistreaming option 1 examples" (page 243)

• "Multistreaming option 2" (page 244)


• "Multistreaming option 3" (page 245)


• "Future multistreaming" (page 247)

— "Multistreaming in the future procedure" (page 247)

Multistreaming option 1Start a new release with a publishable branch and re-used modules withprofiling.

Start a new stream by checking out an existing publishable and thenchecking it in as a new major version of the publishable that re-usesthe current version of existing modules with changes between streamscontrolled by profiling within the re-used modules.

Both streams use the current version of all shared modules; only thelatest stream uses the current version of the publishable. Changing andrepublishing an earlier stream involves checking out a previous version of




.

240 Multistreaming options

the publishable, making the required changes, applying the appropriateprofiles, and checking it in again as a new branch minor version withoutmaking it the current version.

Attention: This is the preferred option because it minimizes duplication;maximizes re-use; and minimizes any change needed when fullmulti-streaming is introduced.

Advantages and disadvantages are as follows:

• Single publishable object but have to manage branch versions ofpublishables and profiles within modules

Multistreaming procedure, option 1Use the following partial multistreaming procedure by starting a newrelease with a publishable branch and re-used modules with profiling.

The current version of all modules is used at all times; multi-streaming iscontrolled using profiling within re-used modules

Attention: Do not clone the publishable or use a different filename; adifferent version of the same publishable is used for the different streams

Procedure Steps

Step Action

1 Check out the current or previous version of a publishablewithout descendents.

2 Check it back in and specify the following:

• For a new release, a new Major change version (forexample, 1.4 to 2.0); or, for a previous release, a new Branchversion (for example, 1.4 to 1.4.1.0)

• For a new release, check the Make this the current versionoption; for a previous Branch version, uncheck the Make thisthe current version option




.

Multistreaming option 1 241

• A release number within the Label property (for example,1.1b or 1.1c)

• New DocRevision and SoftwareRelease values by selectingProperties, Basic I tab.

Attention: A new release may require the creation of newprofile value or group that must be added to contentProfile.pcf orreleaseProfile.pcf

3 Delete or add modules to the publishable according to therequirements of the new release

4 Change content of modules (profile changes including links tonew content or content no longer required for the new release).Only use the Content and Release profiles.

Attention: When profiling content, pay special attention to linksto profiled content

Attention: Do not apply profiling to complete modules(Chapter, Module, etc)

--End--

Multistreaming procedure, option 1 examplesUse the following partial multistreaming procedure to create a new streamfrom an existing publishable.

Option 1 Example 1Procedure Steps

Step Action

1 Using Desktop Client, locate and right-click malcolmtest4 inecmprod/NonMTBI/Publishables.

2 Click Check Out, select Do not download descendents andthen click Check Out.




.


3 Using Desktop Client, right-click on malcolmTest4, click CheckIn and then specify

• a new Major change version of 2.0.

• release number 1.1c within the Label property

• Right-click malcolmTest4, select Properties.

• In Properties, Basic 1, tab set DocRevision to 02.01 andSoftwareRelease to 1.1c

4 Click OK.

5 Request that Release value 2.0 be added to gdeProfile.pcf

6 Right-click malcolmTest4, click Document Lifecycle andchange to the required ks_publishable_lifecycle state.


8 Change content of modules (profile changes including links tonew content or content no longer required for the new release).

9 When ready to publish, promote the ks_publishable_lifecycleto the Approved state.

--End--

Multistreaming, option 1 example 2 - republishing an earlier versionof a publishableProcedure Steps

Step Action

1 Using Desktop Client, locate and right-click malcolmtest4 inecmprod/NonMTBI/Publishables

2 Click Show: All Versions.

3 Right-click Version 1.4 of malcolmTest4 and click Check Outand then click Selected.

4 Select Do not download descendents and then click CheckOut.

5 Using Desktop Client, right-click version 1.4, click Check In andthen specify

• a Branch version of 1.4.1.0

• release number 1.1b within the Label property

• Uncheck , Make this the current version, click Check In.




.


• Right-click , Version 1.4.1.0,1.1b, of malcolmTest4 clickProperties and thenSelected.

• In Properties, Basic 1, set DocRevision to 01.02 andSoftwareRelease to 1.1b.

6 Click OK.

7 Right-click Version 1.4.1.0,1.1b of malcolmTest4,click Document Lifecycle and change to the requiredks_publishable_lifecycle state.

8 Delete or add modules to the publishable according to therequirements of the release (never check in as current version

9 Change content of modules (profile changes including links tonew content or content no longer required for the new release).

10 When ready to publish, promote the ks_publishable_lifecycleto the Approved state.

--End--

Multistreaming option 1 examplesExample 1 will create a new current stream from the current version of themalcolmTest4 publishable and reuse the current version of its modulesChapter1 and Chapter 2.

Doc ObjectName

(.xml) Documentum

Version Doc Revision

Software

Release

Stream1

Stream2

Stream 1 Stream2

Stream1

Stream2

Stream1

Stream2

malcolmTest4

malcolmTest4

malcolm Test4

1.4,Current 2.0,Cur 01.01 02.01 1.1b 1.1c

Chapter1

Chapter1

Chapter1

1.3,Current 1.3,Cur

Chapter2

Chapter2

Chapter2

1.1,Current 1.1,Cur

Example 2 will republish an earlier stream of the malcolmTest4 publishableand will reuse the current version its modules Chapter1 and Chapter 2.

Document

ObjectName

(.xml) Documentum


Software

Release

Stream 1 Stream2

Stream 1 Stream 2 Stream 1

Stream2

Stream1

Stream2

malcolmTest4

malcolmTest4

malcolm Test4

1.4 1.4.1.0,1.1b

01.01 01.02 1.1b 1.1b




.


Document

ObjectName

(.xml) Documentum


Software

Release

Stream 1 Stream2

Stream 1 Stream 2 Stream 1

Stream2

Stream1

Stream2

Chapter1

Chapter1 Chapter1

1.3,Current 1.3,Cur

Chapter2

Chapter2 Chapter2

1.1,Current 1.1,Cur

Multistreaming option 2Start a new release with a new publishable and re-used modules withprofiling.

Start a new stream by cloning an existing publishable but not moduleswithin it and checking in the cloned publishable as a new Documentumobject that re-uses the current version of existing modules; changesbetween streams are controlled by profiling within the re-used modules.

Both streams use the current version of all shared modules. Changingand republishing an earlier stream involves checking out the publishablefor that stream, making the required changes, applying the appropriateprofiles, and checking it in again as a new minor version and making it thecurrent version.


• Separate publishable for each stream but have to manage profileswithin modules.

Multistreaming procedure, option 2Use the following partial multistreaming procedure by starting a newrelease with a publishable branch and re-used modules with profiling.

The current version of all modules is used at all times; multi-streaming iscontrolled using profiling within re-used modules

Prerequisites

• For a new release clone the existing publishable, see Cloning apublishable but not modules within it.

• To avoid duplicate object names, ensure that the new publishable hasa different ObjectName than the existing publishable.




.


Procedure Steps

Step Action

1 Check out the cloned publishable.


Attention: Do not add profiling to complete modules (Chapter,Module, etc)

3 Change content of modules (profile changes including links tonew content or content no longer required for the new release).Only use the Content and Release profiles.

Attention: A new release may require the creation of newprofile value or group that must be added to contentProfile.pcf orreleaseProfile.pcf


--End--

Multistreaming option 3Start a new release with a new publishable and modules.

Start a new stream by cloning an existing publishable and all moduleswithin it and checking in the cloned publishable and modules as newDocumentum objects. Modules are not re-used and profiling is not used tocontrol changes between streams.

Changes common to different releases have to be made in the affectedmodules in each stream. Changing and republishing an earlier streaminvolves checking out the publishable for that stream, making the requiredchanges, and checking it in again as a new minor version and makingit the current version.




.



• Separate publishable for each stream and do not have to managerelease profiles in modules but additional effort needed to incorporatechanges that affect multiple releases.

Multistreaming procedure, option 3Use the following partial multistreaming procedure by starting a newrelease with a new publishable and new modules.

The current version of all modules are used at all times; modules are notshared with any other publishable

Prerequisites

• For a new release see Cloning a publishable and modules within it.

• To avoid duplicate names in folders, ensure that the cloned publishableuses a different ObjectName and that every cloned module uses adifferent DocNumber (if the DocNumber is not included in the modulename, the same ObjectName can be used).

Procedure Steps

Step Action

1 Check out the cloned publishable.


Attention: Do not add profiling to complete modules (Chapter,Module, etc)

3 Change content of modules (profile changes including links tonew content or content no longer required for the new release).Only use the Content profile.

Release profiling is not used but Content profiling may be used





.

Future multistreaming 247

Attention: Changes affecting multiple releases have to bemade the affected modules in each stream

--End--

Future multistreamingVanilla Documentum with Arbortext Editor 5.2 DLM (Dynamic LinkManager) customizations (document set and label hooks).

Each stream is associated with a specific release. Every publishable andmodule is associated with a specific release. Each release is specified witha value defined within the Documentum Label property. Modules usedwithin a publishable must be bound to a use a specific Label value. Tomanage and validate DLM links, each publishable must be assigned to aDLM document set that associates DLM links with a value within the Labelproperty.

Starting a new stream involves:

• creating a new publishable or a Major version of an existing publishablethat reuses existing modules

• assigning a new release value to the Label property when thepublishable is checked in

• creating new or updating module content and checking them in aseither a new or a Major version

• assigning a release value to the Label property.

• within the publishable virtual document, the module version to be usedmust be bound to the publishable.

• the publishable must be assigned to a DLM document set.

Multistreaming in the future procedureWithin each stream, module use in a publishable is controlled by whichversion is bound to the publishable.

Procedure Steps

Step Action

1 For a new release, check out an existing publishable or createa new one.




.


2 Check the publishable in and specify

• A new or Major change version (for example, 1.9 to 2.0)

• A new release number within the Label property (eg, SN-10)

• New DocRevision and SoftwareRelease values (byselecting Properties, Basic I tab)

3 Create new modules or change the content of existing modules;check them in as either new versions or Major change versions;assign a new release number to the Label property.

4 Delete or add modules to the publishable according to therequirements of the new release.

5 Open the publishable virtual document and bind to thepublishable the module version to be used (as defined by thevalue in the Label property).

6 Assign the publishable to a DLM document set.

--End--




.

249.

Converting to NTDAAny source file can be converted to XML for use with the NTDA. ExistingKS production documents authoring in FrameMaker, PDF, or Interleafwere converted to XML using the process outlined below. Existingdocuments have also been manually converted.

Navigation• "Conversion process" (page 249)

• "Manual conversion procedures" (page 250)

•

Conversion processAll documents (NTP and IM) to be converted to XML will be converted byan external conversion vendor, according to an agreed schedule. Afterconversion, all documents will be moved into the NTDA DocumentumRepository where they can be checked out for editing or selected forpublishing via the Release List.

The process is as follows, see Figure 59 "High-level conversion tasks"(page 249)

Figure 59High-level conversion tasks




.

250 Converting to NTDA

Manual conversion proceduresNavigation

• "Converting a paragraph" (page 250)

• "Converting a table" (page 251)

• "Converting a list" (page 253)

Converting a paragraphUse this procedure to convert a paragraph into XML format.

Procedure Steps

Step Action

1 Copy (shortcut Ctrl+C) the text from a paragraph in the sourcefile.

2 Position the cursor where you want to insert the text and pressthe Enter key. From the list of elements that can be inserted,select Paragraph.

3 Paste (shortcut Ctrl+V) the copied text between the destinationParagraph tags.




.

Manual conversion procedures 251

--End--

Converting a tableUse this procedure to convert a table to XML format.

Procedure Steps

Step Action

1 Position the cursor where you want to insert the text and pressEnter. From the list of elements that can be inserted, selectTable.

2 Specify the Table Size and click OK.




.


3 Copy (Ctrl+C) the text from a cell in the source table.

4 Position the cursor in the cell where you want to insert thetext and press the Enter key; from the list of elements, selectParagraph.

5 Press Ctrl+V to paste the copied text into the cell

6 Repeat step 3-5 for each table cell.




.

Manual conversion procedures 253

--End--

Converting a listUse the following procedure to convert a List into a XML format.

Procedure Steps

Step Action

1 Position the cursor where you want to insert a list. Press Enterand then click on List.

2 Within the Item tags, press Enter and select Paragraph

3 Copy (Ctrl+C) the text of the source list item




.


4 Paste (Ctrl+V) the copied text between the List Item Paragraphtags

5 For additional list items, position the cursor after the last Itemtag, press Enter and click on Item.

6 Go to step 2 Repeat Steps 5-6 for each list item




.

Conversion QA checklist 255

--End--

Conversion QA checklistThis module provides a QA checklist that should be used after a documenthas been converted to XML.

Generic QA checks

Did the document open with an error message window? If so, see Fixing a document

Are there any comment tags in the document? If so, see Fixing a document

Conversion or transform QA checks (compare with original PDF)

Are the NTDA filenaming conventions properly applied to all XML and image files?

Has all metadata been captured correctly in the XML file and within Documentum?

Are there any invalid attributes or invalid attribute values?

Are all XML documents chunked and stored in the correct locations withinDocumentum?

Are all image files stored in the correct locations within Documentum?

Can the publishable be checked out/in with descendents from Documentum?

Can a PDF be generated using the PE server?

Has all content been converted/transformed to the correct DTD element?

Are there any orphan elements that don’t map to a DTD element (enclosed incomment or Transform-Wrap tags)?

Have all styles/elements been converted/transformed correctly?

Have all images been imported by reference at the correct location?

Have all editable source graphics (fm, eps, etc) been stored as renditions inDocumentum?




.


Have all tables and lists been converted/transformed correctly?

Have all links in the original been converted/transformed correctly to DLM links?

Was all conditional text captured correctly?

Were all local variables captured correctly as text entities and populated throughoutthe content?

To approve a converted document, change the lifecycle state to ConvApproved

Before editing a converted and approved document, see Accepting a converteddocument

Also see the “Preconversion Checklist” and “Post Conversion QA checklist” @http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=13005659




.

257.

Migrating publishables from 5.1 to 5.2The following procedures show how to migrate your publishables viadifferent scenarios.

Navigation• "Migration from 5.1 to 5.2 tasks" (page 257)

• "Migrating a single document from 5.1 to 5.2" (page 259)

• "Migrating a 5.1 publishable with locked modules to 5.2" (page 260)

• "Migrating batch from 5.1 to 5.2" (page 261)

• "Setting DTDVersion to the correct value" (page 262)

Migration from 5.1 to 5.2 tasksUpgrade from Epic Editor 5.1 to Arbortext Editor 5.2.

Migrating tasksThis task flow shows you the sequence of tasks you perform to migratesoftware from Epic Editor 5.1 to Arbortext Editor 5.2. To link to any task,click on the task in "Migrating navigation" (page 258)




.

258 Migrating publishables from 5.1 to 5.2

Figure 60Migrating tasks flowchart

Migrating navigation

• "Uninstalling Epic Editor 5.1" (page 27)

• "Installing Arbortext Editor 5.2 " (page 28)

• "Installing Editor 5.2 Nortel customizations " (page 40)


• "Setting up Arbortext Editor 5.2" (page 45)

• "Changing Arbortext License Manager Host" (page 47)

• "Changing the DocBroker Host" (page 47)




.

Migrating a single document from 5.1 to 5.2 259

Migrating a single document from 5.1 to 5.2Use the following procedure to migrate a single document from 5.1 to 5.2.

Procedure Steps

Step Action

1 Check out a 5.1 document, publishable or module withdescendents, from ecmprod. All modules in a document must beunlocked.

2 Open Arbortext Editor 5.2.

3 Click Tools, Dynamic Link Manager, Connect. Type dca andverify DLM Repository is 47.10.32.186.

4 Answer OK or Yes to subsequent dialogs.

5 Answer OK or Yes to subsequent dialogs. Be patient, it can takean hour or more to migrate a document, the time depends on thenumber of links in the document.

6 Check the migrated document into Documentum as a NewMajor version and type Migrated to 5.2 in the Description field.

Migrated to 5.2 will be added to the User Comments field underthe Documentum Properties Version tab for each publishableand each module within it.

7 Check out the migrated document from ecmprod and open it withArbortext Editor 5.2

8 Validate links, click Nortel, DLM, Validate Links, Document. ifthere are errors, fix them and save document.

9 Register links in DLM by clicking Tools, Dynamic LinkManager, Register, Document.

Fix any errors.

10 Click View, Generated Text, Update to view the link text of newlinks.

11 Save the document and Exit Arbortext Editor.

12 Check the document back into Documentum as a new Minorversion.

Attention: Locked modules within the document will have to beunlocked and migrated using this procedure.




.


--End--

Migrating a 5.1 publishable with locked modules to 5.2

Procedure Steps

Step Action

1 Within ecmprod, right-click the 5.1 publishable with lockedmodules. Select Check Out and Download and check outdescendents.

You will have to click Continue for each locked module.


3 Click Tools, Dynamic Link Manager, Connect. Type dca andverify DLM Repository is 47.10.32.186.

4 Open the checked out publishable with Editor 5.2.

5 Answer OK or Yes to subsequent dialogs.

Be patient, it can take an hour or more to migrate a document;the time depends on the number of links in the document.Read-only, locked, and previously-migrated modules will not bechanged.

6 Save the migrated publishable



Fix any errors.


10 Check the migrated document into Documentum as a NewMajor version and type Migrated to 5.2 in the Description field.

Migrated to 5.2 will be added to the User Comments field underthe Documentum Properties Version tab for each publishableand each editable module.

Attention: Unlocked modules migrated within a documentcontaining locked modules will have to be registered separately




.

Migrating batch from 5.1 to 5.2 261

--End--

Migrating batch from 5.1 to 5.2Use the following procedure to migrate a batch of documents from 5.1 to5.2.

Procedure Steps

Step Action

1 Check out the 5.1 documents to be migrated (with descendents),publishables or modules, from ecmprod.

Attention: All modules in a document must be unlocked; or, ifthey are locked, they must have been previously migrated andregistered.


3 Click Tools, Dynamic Link Manager, Connect. Type dca andverify that the DLM Repository is 47.10.32.186.

4 Verify that the Arbortext Editor Command line is being displayed.If it is not, click Tools, Preferences and check the box next toCommand Line.

5 After Command: type batch::migrate() and press Enter.

The progress of the migration will be displayed in anArbortext Editor Eval Output window and recorded in thebatchmigrate_to_5-2.log file at the root level on the C drive.

6 Check a migrated document into Documentum as a New Majorversion and type Migrated to 5.2 in the Description field.

Migrated to 5.2 will be added to the User Comments field underthe Documentum Properties Version tab.

7 Check out the migrated document and open it with ArbortextEditor 5.2.



Fix any errors.




.



11 Save the document and Exit Arbortext Editor.

12 Check the document into Documentum as a new Minor version.

13 Repeat for each migrated document. gration of all documentschecked out in Step 1 is complete.

--End--

Setting DTDVersion to the correct valueAfter migration or transformation the DTDVersion attribute value of v1.12hor v2.0N could be replaced by entity name &DTD version. This procedureprovides the steps to change the DTDVersion attribute value back to thecorrect value throughout a document.

Procedure Steps

Step Action

1 Start Arbortext Editor 5.2 and then open a document.

2 Select the complete document; for example, in the structurewindow, double-click the nonmtbi element to highlight all contentin the document.

3 Click on Edit, Edit Selection as XML Source

4 Click Find, Find Replace.

Find/Replace dialog box displays.

5 In the Find What: field enter in &DTDVersion.

6 In the Replace With field enter v1.12h for nonmtbi or v2.0N fornonmtbi2 or mtbi2.

7 Click Replace All.

8 Click Close.




.

Setting DTDVersion to the correct value 263


--End--




.





.

265.

Installing and configuring Epic Editor5.1

The following procedural information shows how to uninstall, install andconfigure Epic Editor 5.1

Navigation• "Installing Epic Editor 5.1" (page 265)

• "Installing Nortel 5.1 customizations" (page 266)


• "Setting up Epic Editor 5.1" (page 267)

Installing Epic Editor 5.1Use the following procedure to install Epic Editor 5.1.

Procedure Steps

Step Action

1 Obtain an Epic Editor license (from PayGo for Nortel staff; see http://paygo/cgi-bin/softindex.htmhttp://paygo/cgi-bin/softindex.htm)

2 Download the EpicEditor51 folder (from PayGo).

3 Double-click Setup.exe in the EpicEditor51 folder.

4 Follow the installer instructions and accept the defaults exceptfor those shown in the figures here. The value entered for theConcurrent License Server, which is also used for the DCAMhost, is used to populate the APTLMHOST environment variable.

5 Install your Epic Editor license (the really-long number) whenprompted to do so.

6 Upgrade to the latest version of Epic Editor, see “Upgrade Epic5.1, 5.1k, 5.1m, 5.1p, or 5.1T to 5.1U” at http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9770359

7 Issue the following Start, Run command:




.

http://paygo/cgi-bin/softindex.htm

http://paygo/cgi-bin/softindex.htm



266 Installing and configuring Epic Editor 5.1

regsvr32 "path_to_epic_software\adapters\epicdctm5.dll"

--End--

Installing Nortel 5.1 customizationsUse the following procedure to install the Nortel 5.1 customizations.

Procedure Steps

Step Action

1 Download Nortel_5-1Epic_custom.zip from http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9770359

2 Unzip Nortel_5-1Epic_custom.zip to your desktop to createNortel_Epic folder.

3 Move the contents of each folder in Nortel_Epic to the folderwith the same name in the custom folder within your local Epicinstallation directory.

4 If there is a problem in installing and using the Nortel Epiccustomizations, check to see if there is an APTCUSTOMenvironment variable. If there is, delete it by right-clickingMy Computer and then select Properties, Advanced,Environment Variables.

5 Check out a document to get the latest DTD files.

--End--

Job aidAfter moving, the following local Epic/custom folders should contain:

• classes: cyclops.jar and tools.jar

• editinit: addMenuItem.acl

• init: 0memory.acl, dup_link_finder.acl, fix-text-entities-for-dtd2.acl,clean-unused-entities.acl, space.acl

• scripts: comp.pdf.acl, link_find.acl, ntda-text-entities.acl,ntp_dcam_support.acl, ntp_hooks.acl, and ntp_setup.acl

Setting 5.1 environment variablesUse the following procedure to set the 5.1 environment variables on yourlocal PC.




.



Setting up Epic Editor 5.1 267

Procedure Steps

Step Action

1 Exit from all Arbortext Epic sessions.



4 Verify that APTLMHOST is set to @47.10.32.186.


6 For Variable Name, type APTPNGUSERES.

7 For Variable Value, type yes.

8 Click OK.


10 For Variable Name, type HOME.

11 For Variable Value, type the path to where you want to store theepic.wcf file and the .aptcache directory.

For example, D:\Program Files\Arbortext\Epic\custom.

12 Click OK. Click OK in the Environment Variables window. ClickOK in the System Properties window.

--End--

Setting up Epic Editor 5.1Use the following procedure to set up Epic Editor 5.1.

Procedure Steps

Step Action

1 Open Epic Editor and select Tools, Preferences.

2 Click Windows and click Full Menus.

3 Click Advanced

• fileentityfontcolor, set to blue

• locate e3composition, set to on

• locate usedistiller, set to off

• writeaticomment, set to off

• locate fosiwarnings, set to off

• locate gentextwarnings, set to 0

4 locate e3serverurl, set to:




.

268 Installing and configuring Epic Editor 5.1

• Nortel staff: http://ztcfs0n8:8080/e3/servlet/e3/ (47.10.32.229)

• Vendor staff: http://ztcfs0mh:8080/e3/servlet/e3/(47.10.32.186)

• Testing: http://ztcfs0m2:8080/e3/servlet/e3/ (47.10.32.150)

5 Click Close an then click OK.

6 Click File, Exit.

7 If prompted, click Yes to Save Window Configuration prompt.

--End--




.

269.

Transforming from NonMTBI toNonMTBI2

The NTDA 5.2 transform procedures assume that the original NonMTBIpublishable, and all modules included in it, will continue to be used afterthe NonMTBI2 version has been created. The new NonMTBI2 publishableand modules will contain different DLM-ids than the original NonMTBIpublishable and modules.

NonMTBI to NonMTBI2 document transformation tasksThis task flow shows you the sequence of tasks you perform to clone amodule. To link to any task, click on

NonMTBI to NonMTBI2 document transformation navigation• "Cloning a publishable and modules within it" (page 198)

• "Cloning publishable but not modules within it" (page 194)

• "Transforming publishables without re-used modules" (page 270)

• "Transforming publishables with re-used modules" (page 271)




.

270 Transforming from NonMTBI to NonMTBI2

Transforming publishables without re-used modulesTransform the publishables that have no reuse from the NonMTBI to theNonMTBI2 doctype.

Transform publishables without re-used modules tasksThis task flow shows you the sequence of tasks you perform to clone apublishable and modules within it. To link to any task, click on "Transformpublishables without re-used modules navigation" (page 271)

Figure 61Transform publishabels without re-used modules tasks




.

Transforming publishables with re-used modules 271

Transform publishables without re-used modules navigation


• "Exporting publishable onto your local PC" (page 407)

• "Transforming NonMTBI document" (page 408)

• "Opening the file in NonMTBI2" (page 409)



• "Transforming post-converted text entities" (page 410)

• "Importing transformed publishable into Documentum" (page 410)







• "Deleting transform folders" (page 410)

Transforming publishables with re-used modulesTransform the publishables that have no reuse from the NonMTBI to theNonMTBI2 doctype.

Prerequisites

• Modules re-used between publishables must be identified beforetransforming publishables; otherwise re-used modules will betransformed multiple times and there will be duplicates within theNonMTBI2 environment. Prepare a spreadsheet of modules andpublishables that have re-use.

Transforming publishables with re-used modules tasksThis task flow shows you the sequence of tasks you perform to clonea publishable and modules within it. To link to any task, click on"Transforming publishables with re-used modules navigation" (page 272)




.


Figure 62Transforming publishables with re-used modules task flow

Transforming publishables with re-used modules navigation


• "Exporting publishable onto your local PC" (page 407)

• "Transforming NonMTBI document" (page 408)

• "Opening the file in NonMTBI2" (page 409)




.

Transforming publishables with re-used modules 273



• "Transforming post-converted text entities" (page 410)

• "Importing transformed publishable into Documentum" (page 410)










• "Deleting transform folders" (page 410)




.





.

275.

NonMTBI2 to MTBI2 transformTransforming from NonMTBI2 to MTBI2 involves preparing to transform,executing the transform, and verifying the transform.

Navigation• "Preparing to transform to MTBI2" (page 275)

• "Transforming from NonMTBI2 to MTBI2" (page 279)

• "Publishable structures and element mappings" (page 295)

• "Module structures and element mappings" (page 306)

• "Transform QA checklist" (page 342)

Preparing to transform to MTBI2Preparing to transform to MTBI2 involves ensuring that the sourceNonMTBI2 is ready to be transformed.

Navigation• "NonMTBI" (page 275)

• "NonMTBI2" (page 275)

• "MTBI2" (page 276)

• "NonMTBI2 to MTBI2 prep-tool" (page 276)

• "InfoCategory and InfoType values" (page 277)

NonMTBINonMTBI documents will have to be transformed to NonMTBI2 beforethey can be transformed to MTBI2. See "Transforming from NonMTBI toNonMTBI2" (page 269)

NonMTBI2Each NonMTBI2 document must meet the following prerequisites:

• NonMTBI2 documents must be at .8/.9 on the MTBI Roadmap. Thismeans that all concept modules, procedural modules, referencemodules are NCDS compliant with all procedures linked to from




.

276 NonMTBI2 to MTBI2 transform

workflows and taskflows. See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=19554587

• In addition, NonMTBI2 documents must follow the structure defined in“Interim solutions for Roadmap compliancy (for NonMTBI2)” (Core IABulletin 2007-026.1). See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=15072860

If these prerequisites are not met, the post-transformation cost will besignificantly higher. A pre-transformation script (prep-tool.acl) has beencreated to help identify possible problems.

MTBI2Before transforming from NonMTBI2 to MTBI2:

• All authors should have experience or training in using the MTBI2 DTD.NTDA does provide an instructor-led MTBI2 training course (2246F)and self-paced training in the form of MTBI2 demos @ NTDA TrainingDemos.

• As part of the transform activity, and before invoking the XSL transformscript, all NonMTBI2 modules (Chapter, Module, and Terminology)will have to be assigned an InfoCategory and InfoType value(selected from a predefined list). This is because the InfoCategoryand InfoType values are required by the MTBI2 doctype; within theNonMTBI2 doctype they are optional. Within the NonMTBI2 doctype,InfoType is not being used at all but some groups, for example CVoIP,do use InfoCategory values. The value assigned to InfoType will beused by the XSL transform script to identify which destination MTBI2module type should be used.

After transforming a NonMTBI2 document to MTBI2, cleanup and QA willbe required to verify a successful transform.

NonMTBI2 to MTBI2 prep-toolTo help authors identify if a NonMTBI2 source XML file meets theidentified prerequisites, a NonMTBI2 to MTBI2 transform preparation script(prep-tool.acl) has been created. This script checks that

• Procedure elements are not nested and there are no more than two ina Module or Section; if there are two, one must be within an Exampleelement

• InfoCategory and InfoType are populated; both are needed in MTBI2

• List elements are not nested to more than two levels; only two levels(List and SubList) are supported in MTBI2

• Note elements do not contain List elements; Note is mapped to anMTBI2 Attention and List is not supported therein

• Context and StepGroup elements within Procedure elements; theseelements are not supported in MTBI2




.





http://livelink-ott.ca.nortel.com/livelink/livelink.exe/fetch/2000/403434/1084509/7488004/8410997/9762597/10985474/14532709/23455032/index.htm?nodeid=23454462<?Pub & EntityName=amp>vernum=0


Preparing to transform to MTBI2 277

• Number of Section elements in a Workflow Chapter should be nomore than four (Prerequisites, Tasks, Navigation, and JobAid)

• Number of Section elements in a ContentGroup Chapter should beno more than four (Applies To, Prerequisites, Navigation, Interfacegraphic)

• Chapter within Appendixes element; appendices are not supported inMTBI2

• CliResponse, GuiResponse, Command, Procedure, Example,TermDef, elements within Introduction. NonMTBI2 Introduction ismapped to MTBI2 Purpose and these elements are not supported inPurpose.

• Lists the settings of the transformed attribute.

The NonMTBI2 to MTBI2 transform preparation script (prep-tool.acl isstored in the Arbortext/Editor/custom/init folder) is invoked from theArbortext Editor Nortel, Transform, NonMTBI2 to MTBI2 prep-tool menu

InfoCategory and InfoType valuesThe InfoCategory and InfoType attribute picklist values determine theDocumentum storage folders within the folder defined by the DocNumberattribute value.




.


Figure 63Documentum folder structure

InfoCategory valuesFor guidance on setting the InfoCategory value, see Information ModelSpreadsheet @ http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=12381711. Suggest starting at the left-hand side of thespreadsheet and selecting the first category that fits.

• AboutTheProduct

• Administer

• Commission

• Configure

• CustomerSupport

• InstallHardware

• InstallSoftware

• ManageAccounting

• ManageFaults

• ManagePerformance

• ManageSecurity

• MarketingAndSales

• PlanAndEngineer

• TechnologyBasics

InfoType values and abbreviations for filenamingFor the NTDA module file-naming conventions, see "File-naming module,text, and image objects" (page 203).

• Conceptual (CM and CU)

• ContentGroup (CG)




.

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll <?Pub & EntityName=amp>amp;objId=12381711

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll <?Pub & EntityName=amp>amp;objId=12381711

Transforming from NonMTBI2 to MTBI2 279

• Procedural (PM and PU)

• Reference (RM and RU)

• TaskFlow (TF)

• Terminology (TM)

• WhatsNew (WN)

• WorkFlow (WF)

Transforming from NonMTBI2 to MTBI2This module contains a high-level procedure for transforming a NonMTBI2document to an MTBI2 document.

Prerequisites

• Author has experience, or training, in authoring using the MTBI2 DTD.

• A valid and complete NonMTBI2 document that is compliant to:

— MTBI Roadmap .8/.9, see http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=19554587

— NCDS, see http://livelink-ott.ca.nortel.com/livelink/livelink.exe/open/23708639

— Core IA Bulletin 2007-026.1, see http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=15072860

Procedure Steps

Step Action

1 Verify that the latest Editor 5.2 Nortel customizations areinstalled, see "Installing Editor 5.2 Nortel customizations " (page40)

2 If you don’t already have one, create a NonMTBI2 to MTBI2folder on your PC desktop.

3 Within Documentum, right-click on a NonMTBI2 document,filename.xml, to be transformed and check it out with all itsdescendents

Attention: The document could contain re-used modules thathave already been transformed.

4 Verify that for each NonMTBI2 chunk (Chapter, Module,Terminology) InfoCategory and InfoType values have been set.




.








If they have not, set them and save the file. To help you identifyvalid InfoType combinations, see "Valid InfoType values forNonMTBI2 Chapter-Module combinations" (page 288)

Attention: InfoCategory and InfoType must be set beforetransformation to MTBI2 and to set the correct storage path inDocumentum. The InfoType value also determines the MTBI2module type.

5 Replace all Introduction elements within Section elementsthat do not have sibling Section elements with SectionBodyelements, click on Nortel, Transform, Replace NonMTBI2Introduction without siblings with SectionBody, and thensave the document.

6 Verify that the prerequisites specified above have been met; toassist in determining if the NonMTBI2 publishable is ready to betransformed, select Nortel, Transform, NonMTBI2 to MTBI2prep-tool.




.


Attention: For what a clean report should look like, see "Cleanprep-tool report" (page 290)

7 Fix any problems reported by Nortel, Transform, NonMTBI2 toMTBI2 prep-tool and save the document.

8 Save the cleaned-up NonMTBI2 document; close all ArbortextEditor sessions; and check the NonMTBI2 document back intoDocumentum.

9 Check out the NonMTBI2 document just checked in; open it withArbortext Editor; connect to DLM; register all links; validate alllinks; save the document; close Arbortext Editor; and check thedocument back into Documentum.

1. Within Documentum, right-click on the cleaned-up NonMTBI2document, filename.xml, and check it out with all itsdescendents

2. Click on Tools, Dynamic Link Manager, Connect, type dcain the User Name field and then click on OK.

3. Click on Tools, Dynamic Link Manager, Register,Document until the document has been successfullyregistered.

4. Click on Nortel, DLM, Validate Links... Document; fix anyinvalid links; and repeat from the previous step.

5. Click on File, Save and then on File, Exit.

6. Check the cleaned-up and link registered and validateddocument back into Documentum.

10 Check out the cleaned-up and link registered and validatedNonMTBI2 document just checked in and open it with ArbortextEditor.

11 Create a PDF file with a filename of filename-NonMTBI2.pdf

12 Remove DCTM attributes from all chunks except Read-Onlyones, click on Nortel, Transform, Delete NonMTBI2 DCTMattributes.




.


13 Connect to DLM, click on Tools, Dynamic Link Manager,Connect...; type a User Name of dca and then click on OK.

Connection to DLM established

14 Click on File, Save As...; browse to your NonMTBI2 to MTBI2folder; specify a File name of filename-NonMTBI2.xml and thenclick on Save.

15 Verify that the DCAM/DLM-ids in the original filename.xml,in the Checkout folder, and filename-NonMTBI2.xml, in theNonMTBI2 to MTBI2 folder, are different.

1. Within the currently open file, scroll to the top of the file andclick in-between the root element and the next element; forexample,

2. Click on Edit, Modify Attributes... and note the value withinthe id field.




.


3. Open the original filename.xml in the Checkout folder; scrollto the top of the file and click in-between the root elementand the next element; depress the Ctrl+d keys and note thevalue in the id field.

4. Compare the id values noted, they should be different; if theyare not (most likely because you didn’t save with a differentfilename), repeat from Step 10.

16 Close all Arbortext Editor sessions.

17 Select all the images used by the original NonMTBI2 documentwithin the Checkout folder, press the Ctrl+c keys to copy allthe images; open the NonMTBI2 to MTBI2 folder and press theCtrl+v keys to paste all the copied images into the NonMTBI2 toMTBI2 folder.

18 Rename the original checked-out NonMTBI2 file, in theCheckout folder, from filename.xml to filename.xml1

19 Disable the DLM server connection, see "Disabling the DLMserver connection" (page 159).

Attention: Rename Environment Variable APTLMHOST anddelete the .aptcache folder.




.


20 Open the NonMTBI2 file filename-NonMTBI2.xml, in theNonMTBI2 to MTBI2 folder, with Arbortext Editor

21 Select Nortel, Transform, Pre-convert text entities

22 Select File, Compose, Using XSL

1. Specify a Save As filename of filename.xml

2. Select Stylesheet NonMTBI2 to MTBI2 Transform

3. Click OK

23 Close Arbortext Editor without saving the document

24 Fix any transform errors, see "Fixing transform errors" (page291)

25 Open the transformed MTBI2 document, filename.xml, in theNonMTBI2 to MTBI2 folder, with Arbortext Editor

26 Click Nortel, Transform, Post-convert text entities

27 In all MTBI2 module elements that were transformed fromNonMTBI2 Section elements, within the ObjectName attribute(pimm_Identifier_Title), all occurrences of XX and TRANSFORMhave to be replaced with pi and Identifier values appropriate foryour product and authoring group.

Attention: For the NTDA file-naming convention forObjectName, see "File-naming module, text, and image objects"(page 203).

1. Click on Nortel, Transform, Replace ObjectName pi andIdentifier values

2. Read the text in the pop-up windows and then click on Yesto proceed.




.


3. In the pop-up window, specify the required pi and Identifiervalues and then click on OK to continue (the followingexample specifies a pi value of KS and an Identifier ofMALCOLM. )

4. Confirm that you want to make the specified changes andthen click on Yes to change XX and TRANSFORM within allObjectName attributes.

5. In the results window, review the ObjectName changes andthen close the window.




.


28 Click on Nortel, Transform, Delete spurious namespaceattributes

29 Save the MTBI2 document and exit from Arbortext Editor

CAUTIONEnsure you have successfully completed all theprevious steps before proceeding further. If youdon’t, you may not be able to import the documentand cause yourself more work after importing thedocument.

30 Import the MTBI2 document, from the NonMTBI2 to MTBI2folder, into Documentum

31 Verify that all MTBI2 modules are stored correctly inDocumentum

32 Enable DLM; see "Enabling the DLM server connection" (page159)

Attention: Rename Environment Variable APTLMHOST anddelete the .aptcache folder.

33 Check out the MTBI2 document, just checked in, fromDocumentum

34 Open the MTBI2 document, within the Checkout folder, withArbortext Editor

35 Add back in any previously-transformed MTBI2 chunksdeleted by the transform (identified by comments added by thetransform)

1. Position cursor at the required insertion point

2. Click Documentum, Browse…

3. Right-click on required module and select Copy

4. Click Documentum, Paste Object Reference




.


Attention: MTBI2 modules created from NonMTBI2 Sectionelements will be stored as separate chunks within Documentumand will not be automatically checked out when a parent moduleis as they were with a NonMTBI2 Chapter or Module. If aChapter or Module that contained Section elements is reused,the new chunks, created from Section elements, will also haveto added to the publishable within mtbitopicref elements.

36 Save the MTBI2 document and exit from Arbortext Editor andcheck the MTBI2 document back into Documentum.

37 Check out the MTBI2 document, just checked in, fromDocumentum and open it with Arbortext Editor.

38 Connect to DLM and register the MTBI2 document in DLM

39 Fix any DLM errors found

40 Click on Nortel, DLM, Validate Links... Document

41 Perform a QA on the transformed MTBI2 document

1. Create a PDF of the MTBI2 transformed document(filename-MTBI2.pdf)

2. Compare the original and transformed PDF files(filename-NonMTBI2.pdf and filename-MTBI2.pdf) and noteany differences, see "Transform QA checklist" (page 342)

42 Save the MTBI2 document and exit from Arbortext Editor

43 Check the MTBI2 document back into Documentum

44 Rename the original checked out NonMTBI2 document fromfilename.xml1 to filename.xml and open it with Arbortext Editor.

45 Click on Nortel, Transform, Post-MTBI2: Change NonMTBI2transformed attribute to yes.

Attention: For all modules that were transformed, thetransformed attribute will be set to yes.




.


46 Save the NonMTBI2 document and check it back intoDocumentum.

--End--

Valid InfoType values for NonMTBI2 Chapter-Module combinationsAn InfoType attribute is only available on a Chapter, Module, orTerminology elements. The InfoType attribute setting is selected froma predefined list of values.

To set the required InfoType value:

1. Position the cursor within a Chapter, Module, or Terminologyelement

2. Click on Edit, Modify Attributes...

3. Click on the InfoType attribute and select the required value.

4. Click on OK.

Chapter elements can contain Module elements, only certaincombinations of InfoType combinations are valid, see Table 8 "ValidInfoType values for NonMTBI2 Chapter-Module combinations" (page 289).




.

Transform

ingfrom

NonM

TB

I2to

MT

BI2

289

Table 8Valid InfoType values for NonMTBI2 Chapter-Module combinations

Module InfoTypeChapter InfoType

Conceptual ContentGroup Procedural Reference Taskflow Terminology WhatsNew Workflow

Conceptual OK X X X X X X X

ContentGroup OK X OK OK X X X X

Procedural X X X X X X X X

Reference X X X X X X X X

Taskflow X X OK X X X X X

Terminology X X X X X X X X

WhatsNew X X X X X X OK X

Workflow X X OK X OK X X X

OK = valid X = invalidNT

DA

NT

DA

Processes

andP

roceduresK

S-N

TD

A-020

02.1031

October

2008C

opyright©

2006-2008N

ortelNetw

orks

.


Clean prep-tool reportNonMTBI2 prep-tool version 1.14 released Oct1, 2008.===============================CHECKING NESTED PROCEDURE LIST ELEMENTS FOR SECOND LEVEL AND BEYOND.Total number of Procedure elements is: 1**** PASSED **** there are 0 nested Procedure elements found.===============================CHECKING NESTED LIST ELEMENTS FOR THIRD LEVEL AND BEYOND.Total number of List elements is: 3**** PASSED **** there are 0 nested List elements found.===============================CHECKING VALUES OF THE ATTRIBUTE INFOTYPE AND INFOCATEGORY IN CHAPTERS ANDMODULES.Total number of chunkable elements is: 5**** PASSED **** found no invalid InfoType or InfoCategory attribute values...===============================CHECKING NUMBER OF PROCEDURE ELEMENTS IN A PROCEDURAL MODULE.Total number of Procedural Module elements is: 0**** PASSED **** found no invalid Procedure elements...===============================CHECKING LIST ELEMENTS IN NOTE ELEMENTS.Total number of Note elements is: 1**** PASSED **** found no List elements inside Note elements...===============================CHECKING CONTEXT ELEMENTS.Total number of Context elements is: 0**** PASSED **** found no Context elements...================================CHECKING NUMBER OF SECTIONS IN A CONTENTGROUP CHAPTER.Total number of ContentGroup Chapter elements is: 2**** PASSED **** found no ContentGroup Chapters with invalid number ofSections....===============================CHECKING NUMBER OF SECTIONS IN A WORKFLOW CHAPTER.Total number of WorkFlow Chapter elements is: 0**** PASSED **** found no WorkFlow Chapters with invalid number of Sections....===============================CHECKING STEPGROUP ELEMENTS.Total number of StepGroup elements is: 0**** PASSED **** found no StepGroup elements...===============================CHECKING APPENDIXES ELEMENT.**** PASSES **** found no Appendixes elements...=============================CHECKING INVALID ELEMENTS INSIDE INTRODUCTION.Total number of Introduction elements is: 5**** PASSED **** found no invalid elements in Introduction...===============================CHECKING IF THERE ARE PROCEDURE ELEMENTS IN CONCEPTUAL CHAPTERS AND MODULES.Total number of Conceptual Chapter and Module elements is: 1**** PASSED **** found no Procedures in Conceptual Chapters or Modules ....




.

Fixing transform errors 291

===============================CHECKING IF THERE ARE SECTIONS INSIDE SECTIONS IN WHATSNEW CHAPTERS AND MODULES.Total number of WhatsNew Chapter and Module elements is: 0**** PASSED **** found no Sections Inside Sections in WhatsNew Chapters orModules ....===============================CHECKING IF A TASKFLOW CHAPTER HAS SECTIONS.Total number of WorkFlow Chapter elements is: 0**** PASSED **** found no TaskFlow Chapters with Sections....===============================CHECKING THE TRANSFORMED ATTRIBUTE FOR MODULES AND CHAPTER.PASS - transform attribute value will be changed to yes for /Chapter/Heading :Chapter with Modules number of modules 1... PASS - : transform attribute value will be changed to yes forModule/Heading :Conceptual modulePASS - transform attribute value will be changed to yes for /Chapter/Heading :Chapter 2 with a Module number of modules 1... PASS - : transform attribute value will be changed to yes forModule/Heading :Linking to MalcolmPASS - transform attribute value will be changed to yes for /Terminology/Heading: List of Terms===============================

Fixing transform errorsThis module contains a procedure for fixing errors in an MTBI2 documentthat was transformed from NonMTBI2 using the NonMTBI2_to_MTBI2.xsl.

Prerequisites

• You have experience or training in using the MTBI2 DTD. NTDA doesprovide a self-paced training in the form of MTBI2 demos @ NTDATraining Demos

• Steps 1 to 23 have been executed within "Transforming fromNonMTBI2 to MTBI2" (page 279)

Procedure Steps

Step Action

1 Open the transformed MTBI2 document, filename.xml, in theNonMTBI2 to MTBI2 folder, with Arbortext Editor

2 If prompted, locate and select the mtbi2.dtd in your localDocumentum/XML Applications/ecmprod/mtbi2 folder.




.




3 If there are transform errors in the MTBI2 file, Context Rules willbe turned off while opening the file.

Attention: Invalid elements will be wrapped in aTransform-Wrap element; move the wrapped contents to a validlocation and then delete the Transform-Wrap element

4 Scan the structure of the entire document looking formajor sections (Chapter, Module, or Section) within redTransform-Wrap elements. If you find any, exit this procedureand repeat Steps 9-23 of "Transforming from NonMTBI2 toMTBI2" (page 279).

5 If the Arbortext Editor Parser Messages window appeared whenyou opened the MTBI2 document, double-click on each error totake you to where the error is in the document and fix it. See"How to fix reported NonMTBI2 to MTBI2 errors" (page 293).

6 Save and close the document.

7 Open the document with Arbortext Editor and repeat from Step5 until the Arbortext Editor Parser Messages window no longerappears.

8 Click Tools and verify Context Rules is checked.

Attention: Clicking on Tools, Context Rules will move you tothe next invalid element

9 Verify that Tools, Context Rules is checked; if it is not, repeatthe previous step.

10 Click Tools, Check Completeness

11 If the Arbortext Editor Completeness Check window appears witha list errors, fix the errors. Close the window when done andrepeat this step until there are no completeness errors.




.

Fixing transform errors 293

12 Save the document and Close Arbortext Editor.

--End--

Step 25 in "Transforming from NonMTBI2 to MTBI2" (page 279)How to fix reported NonMTBI2 to MTBI2 errors

Reportederror

How to fix

General: structural errors (Context Rules will be off)

To help identify what elements are valid at the current cursor location, referto "MTBI2 content models" (page 116), "Publishable structures and elementmappings" (page 295), or "Module structures and element mappings" (page 306)

To identify what can be inserted at the current cursor location, opening anappropriate MTBI2 template, that have Context Rules turned on, can be helpfulto identify what can be inserted; the mtbi2 templates should be located in Documentum/XML Applications/ecmprod/Templates/mtbi2 (if they are not there,download them from ecmprod/Templates/NTDA/GDE-NTDA_templates.zip andmove Templates into the ecmprod folder).

CHECKING NESTED LIST ELEMENTS FOR THIRD LEVEL AND BEYOND.Total number of List elements is: 20... Warning ... Nested List: <Paragraph>sub-sublist</Paragraph>... Warning ... Nested List:.... there are 2 nested List elements found.

This error indicates that List elements have been nested within each other to morethan two levels, which indicates that the following structure has been used:

To fix this problem move the List containing the sub-sublist item out a level; thismay involve a rewrite.




.


Reportederror

How to fix

CHECKING VALUES OF THE ATTRIBUTE INFOTYPE AND INFOCATEGORY IN CHAPTERS ANDMODULES.Total number of chunkable elements is: 14... FAIL:Chapter has no value for attribute InfoType..... Introduction... INFORMATION: Valid InfoTypes are: ContentGroup, WorkFlow, TaskFlow,WhatsNew, Conceptual ........ FAIL:Chapter has no value for attribute InfoCategory..... Introduction

This sample error indicates that values have not been specified for the InfoTypeand InfoCategory attributes for the Introduction Chapter. To fix the problem,position the cursor in the Chapter element and select a value for each attribute.

CHECKING STEPGROUP ELEMENTS.Total number of StepGroup elements is: 1... WARNING: found StepGroup element which is not allowed in MTBI2...<Context>In a StepGroup</Context>...CHECKING CONTEXT ELEMENTS.Total number of Context elements is: 1... WARNING: found Context element which is not allowed in MTBI2...In aStepGroupThere is no such element as ’StepGroup’There is no such element as ’Context’

StepGroup and Context elements are not supported in MTBI2. If they are leftin the NonMTBI2 source, after transforming to MTBI2, StepGroup and Contextelements and all text within them will be wrapped in a Transform-Wrap element.To fix the problem, select the text within the Context element and move it withineach Step that it applies to; then delete the Transform-Wrap, StepGroup, andContext elements.

Within MTBI2, the ProcedureUnit Heading element is not required. Delete theTransform-Wrap and its contents.




.

Publishable structures and element mappings 295

Reportederror

How to fix

CHECKING INVALID ELEMENTS INSIDE INTRODUCTION.Total number of Introduction elements is: 14...Invalid element Command inside Introduction....Command in Introduction...Invalid element CliResponse inside Introduction....CliResponse inIntroduction...Invalid element GuiResponse inside Introduction....GuiReponse inIntroduction

Content within an NonMTBI2 Introduction element is mapped to an MTBI2Purpose element. Within an MTBI2 Purpose element, Command, CliResponse,GuiResponse, Procedure, Example, TermDef elements are not valid.

If they are not removed from the NonMTBI2 source, they will appear in MTBI2within a Transform-Wrap element and they will have to moved.

Publishable structures and element mappingsNortel documentation deliverables are called publishables and five typesare supported; see “Technical documentation types” in Nortel TechnicalDocumentation Standards (CS1808.00) .

Within the NTDA, each publishable is authored within XML modules, whichare stored as separate files in Documentum, using XML elements whosecontent model and relationships are defined within an XML documenttype definition (DTD). These XML modules are collected together in ahierarchical structure defined within an XML publishable element, alsodefined in the XML DTD, to form the publishable deliverables. The XMLpublishable elements are nonmtbi2 and mtbimap.




.




Attention: For an NTDA XML template for each publishable, downloadand install GDE-NTDA_templates.zip from ecmprod/Templates/NTDA(after unzipping, move the Templates folder into your localDocumentum/XML Applications/ecmprod folder).

NavigationThe NonMTBI2 and MTBI2 structures for each of the five types of NCDSpublishable are presented in:

• "Procedural publishable" (page 296)

• "Combined publishable" (page 298)

• "Conceptual publishable" (page 299)

• "Reference publishable" (page 301)

• "New in this release publishable" (page 302)

For the overall NonMTBI2 to MTBI2 publishable element mappings, see"Publishable element mappings" (page 303).

Attention: Transform-Wrap is used to indicate that a NonMTBI2element can not be mapped to an MTBI2 element within the currentcontext.

Procedural publishableProcedural publishables always contain ProcedureModules. Proceduralpublishables that only contain ProcedureModules (no WorkflowModulesor TaskModules) usually comprise a group of logically-relatedProcedureModules that do not have an order, flow, or dependencies andare grouped together in a ContentGroupingModule.

NonMTBI2 structure




.


MTBI2 structure




.


Attention: TaskModules related to a WorkflowModule are nestedwithin the WorkflowModule. ProcedureModules related to aTaskModule are nested within the TaskModule. Unrelated or commonProcedureModules are nested in a ContentGroupingModule.

Combined publishableCombined publishables can contain multiple module types.

NonMTBI2 structure

MTBI2 structure




.


Attention: ContentGroupingModule for ProcedureModules orReferenceModules are only required when a number of common orunrelated ProcedureModules or ReferenceModules are grouped togetherin a NonMTBI2 Chapter.

Conceptual publishableConceptual publishables consist of ConceptModules that containinformation about how a product or feature works.

NonMTBI2 structure




.


MTBI2 structure




.


Reference publishableReference publishables comprise ReferenceModules that containinformation that users refer to when performing a task.

NonMTBI2 structure

MTBI2 structure




.


Attention: ContentGroupingModules for ReferenceModules are onlyrequired when a number of ReferenceModules are grouped together in aNonMTBI2 Chapter.

New in this release publishableA New in this release publishable describes new features and changeson a suite-wide basis.

NonMTBI2 structure




.


MTBI2 structure

Publishable element mappingsThis section provides publishable element and attribute mappings.




.


Attributes on all elements: copy as is; delete invalid attributes in MTBI2after transform.

Attention: Transform-Wrap indicates that a NonMTBI2 element can notbe mapped to an MTBI2 element within the current context.

NonMTBI2 element or attribute MTBI2 element or attribute

nonmtbi2 mtbimap

Front Front

PublicationMetadata PublicationMetadata

Copyright, Country, Legal, Feedback Copyright, Country, Legal, Feedback

FrontCover FrontCover

PublicationHistory PublicationHistory

Contents (nonmtbi2 attributes) Contents (mtbi2 attributes)

FrontMatter, Chapter, Heading Overview, Heading

Module, Heading Purpose, Transform-Wrap

Introduction Purpose

Introduction, Paragraph Purpose, Paragraph

Introduction, List Purpose, List

Introduction, Note Purpose, Attention

Introduction, Figure Purpose, Figure

Introduction, Precaution Purpose, Precaution

Introduction, Table Purpose, Table

Introduction, Procedure Purpose, Transform-Wrap

Introduction, CliResponse Purpose, Transform-Wrap

Introduction, Command Purpose, Transform-Wrap

Introduction, Example Purpose, Transform-Wrap

Introduction, GuiResponse Purpose, Transform-Wrap

Introduction, Where Purpose, Table (see Common)

Introduction, TermDef Purpose, Transform-Wrap

Section, Heading (Prerequisites) Overview, Prerequisites, Heading

Section, Heading (Navigation) Overview, Navigation, Heading

Section(s)if not Prerequisites or Navigation

Overview, Transform-Wrap




.



SectionBody, Figure Prerequisites | Navigation, Figure

SectionBody, List Prerequisites | Navigation, List

SectionBody, Note Prerequisites | Navigation, Attention

SectionBody, Paragraph Prerequisites | Navigation, Paragraph

SectionBody, CliResponse Prerequisites | Navigation, Transform-Wrap

SectionBody, Command Prerequisites | Navigation, Transform-Wrap

SectionBody, Example Prerequisites | Navigation, Transform-Wrap

SectionBody, GuiResponse Prerequisites | Navigation, Transform-Wrap

SectionBody, Precaution Prerequisites | Navigation, Precaution

SectionBody, Where Prerequisites | Navigation, Table (see Common)

SectionBody, Procedure Prerequisites | Navigation, Transform-Wrap

SectionBody, Table Prerequisites | Navigation, Table

SectionBody, TermDef Prerequisites | Navigation, Transform-Wrap

nonmtbi2, Body mtbimap, Topics

chapter_wrap Topics, mtbitopicref

Chapter Topics, mtbitopicref, moduletype (InfoType)

Module_wrap Topics, mtbitopicref

Module Topics, mtbitopicref, moduletype (InfoType)

nonmtbi2, Back mtbimap, Back

Back, Appendixes, chapter_wrap mtbimap, Topics, mtbitopicref

Back, Appendixes, Chapter mtbimap, Topics, mtbitopicref, moduletype (InfoType)

Back, terminology_wrap mtbimap, Topics, mtbitopicref

Back, Backmatter, Terminology mtbimap, Topics, mtbitopicref, TerminologyModule

Back, Index Back, Index

Back, BackCover Back, BackCover




.


Module structures and element mappingsThe NTDA supports three XML doctypes: NonMTBI, NonMTBI2, andMTBI2. Excluding the NonMTBI doctype, the modules supported by eachdoctype are:

• NonMTBI2: Chapter, Module, and Terminology

• MTBI2: WhatsNewModule, ConceptModule, WorkflowModule, TaskModule, ProcedureModule, ReferenceModule, TerminologyModule, andContentGroupingModule.

NavigationThe section presents the NonMTBI2 to MTBI2 module structures andelement mappings under the following headings:

• "Section attribute auto-population" (page 306)

• "WhatsNewModule" (page 307)

• "ConceptModule" (page 312)

• "WorkflowModule" (page 316)

• "TaskModule" (page 321)

• "ProcedureModule" (page 327)

• "ReferenceModule" (page 331)

• "TerminologyModule" (page 335)

• "ContentGroupingModule" (page 337)

• "Common element mappings" (page 339)

Attention: Transform-Wrap is used to indicate that a NonMTBI2element can not be mapped to an MTBI2 element within the currentcontext.

Section attribute auto-populationWhen NonMTBI2 Section elements are mapped to MTBI2 chunkableelements, required attributes have to be populated. The required attributesand how they are auto-populated by the transform (which should bechanged after the transform) are:

• DocNumber: uses the value from the parent Module or Chapter

• InfoCategory: uses the value from the parent Module or Chapter

• InfoType: uses the value from the parent Module or Chapter




.

Module structures and element mappings 307

• Title: uses the value from the Section Heading

• ObjectName: pimm_Identifier_Title (see "File-naming module, text, andimage objects" (page 203))

— pi is a two-character product identifier; by default will be populatedwith XX (see Product Identifiers – filenaming @ http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10985474)

— mm is a two-character module type (CM, CU, CG, PM, PU, RM,RU, TF, TM, WN, WF) based on the InfoType value

— Identifier is 4-16 alphanumeric characters that identifiesthe authoring group, by default will be populated withTRANSFORM-nnn where nnn = 000 to 999

— Title is value from the Section Heading (max of 38 to 50characters)

WhatsNewModuleA WhatsNewModule contains information that describes changes in apublishable, or a collection of publishables, due to new features and otherfactors. Each publishable must include a WhatsNewModule as the firstmodule.

NonMTBI2 WhatsNewModule structureBefore transforming. Chapter and Module attributes: InfoCategoryshould be set to the appropriate category and InfoType set to WhatsNew




.

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>amp;objId=10985474

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>amp;objId=10985474


MTBI2 WhatsNewModule structureThe MTBI2 structure is presented in:

• Figure 64 "Overall structure" (page 308)

• Figure 65 "Feature structure" (page 309)

• Figure 66 "Other changes structure" (page 310)

Attention: Each feature and change are in their own WhatsNewModuleand hierarchical structural relationships are defined by the use ofmtbitopicref elements within the publishable (mtbimap). It has beenproposed that WhatsNewUnit and WhatsNewItem be added so thatfeatures and changes can be presented in a single WhatsNewModule.

Figure 64Overall structure




.


Figure 65Feature structure




.


Figure 66Other changes structure

WhatsNewModule element mappingsChapter and Module InfoType attribute set to WhatsNew



NonMTBI2 element MTBI2 element

Chapter, Heading mtbitopicref, WhatsNewModule, Heading


Introduction, List (1st) Navigation, List




.



Module, Heading mtbitopicref, WhatsNewModule, Heading



Section, Heading mtbitopicref, WhatsNewModule, Heading

SectionBody, Paragraph WhatsNewBody, Paragraph

SectionBody, List WhatsNewBody, List

If present...

Introduction, Note, Paragraph Purpose, Attention, Paragraph

Introduction, Note, List Purpose, Attention, Transform-Wrap











If present...

SectionBody, Figure WhatsNewBody, Figure

SectionBody, Note WhatsNewBody, Attention

SectionBody, CliResponse WhatsNewBody, Transform-Wrap

SectionBody, Command WhatsNewBody, Transform-Wrap

SectionBody, Example WhatsNewBody, Transform-Wrap

SectionBody, GuiResponse WhatsNewBody, Transform-Wrap

SectionBody, Precaution WhatsNewBody, Transform-Wrap

SectionBody, Where WhatsNewBody, Table

SectionBody, Procedure WhatsNewBody, Transform-Wrap

SectionBody, Table WhatsNewBody, Table

SectionBody, TermDef WhatsNewBody, Transform-Wrap




.


ConceptModuleA ConceptModule contains information that supports the user inunderstanding how a product or feature works, what a product feature is,and why a solution uses that product or feature. A ConceptModule canalso provide information that is required to correctly and safely performa task or procedure.

NonMTBI2 ConceptModule structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to Conceptual

MTBI2 ConceptModule structureThe MTBI2 structure is presented as the:

• Figure 67 "Overall structure" (page 313)

• Figure 68 "ConceptUnit structure" (page 314)

Attention: Each concept is presented in their own ConceptModule andhierarchical structural relationships are defined by the use of mtbitopicrefelements within the publishable (mtbimap). A change has been initiatedso that related concepts can be presented in a single ConceptModule, butthis change has not been approved yet.




.


Figure 67Overall structure




.


Figure 68ConceptUnit structure

ConceptModule element mappingsChapter and Module InfoType attribute set to Conceptual.




Chapter or Module, Heading mtbitopicref, ConceptModule, Heading





.



Introduction, List Navigation, Heading, List

Section, Heading mtbitopicref, ConceptModule, Heading

Section, Introduction, Paragraph Purpose, Paragraph

Section, Introduction, List Navigation, Heading, List

SectionBody, Paragraph ConceptBody, Paragraph

SectionBody, List ConceptBody, List

If present...










Introduction, Where Purpose, Table


Introduction, List (after 1st) Purpose, List

If present...

SectionBody, Figure ConceptBody, Figure

SectionBody, Note ConceptBody, Attention

SectionBody, CliResponse ConceptBody, CliResponse

SectionBody, Command ConceptBody, Command

SectionBody, Example ConceptBody, Transform-Wrap

SectionBody, GuiResponse ConceptBody, GuiResponse

SectionBody, Precaution ConceptBody, Precaution

SectionBody, Where ConceptBody, Table (see Common)

SectionBody, Procedure ConceptBody, Transform-Wrap

SectionBody, Table ConceptBody, Table

SectionBody, TermDef ConceptBody, Transform-Wrap




.


WorkflowModuleA WorkflowModule shows the order and dependencies among a groupof tasks and provides a high-level context. A WorkflowModule containsmandatory and optional elements. When included in a proceduralpublishable it must be the first module. In a combined publishable, it mustfollow the introduction or conceptual modules.

NonMTBI2 WorkflowModule, with Sections, structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to Workflow

NonMTBI2 WorkflowModule, with no Sections, structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to Workflow. Chapter containsonly Module elements (with an InfoType of Taskflow or Procedural).Chapter does not contain Prerequisites or JobAid content.




.


MTBI2 WorkflowModule structure




.


WorkflowModule, with Sections, element mappingsChapter InfoType attribute set to Workflow. Chapter contains Sectionelements.



NonMTBI2 element MTBI element

Chapter, Heading mtbitopicref, Workflow, Heading














Section, Heading (prerequisites) Prerequisites, Heading

SectionBody, Figure Prerequisites, Figure

SectionBody, List Prerequisites, List

SectionBody, Note Prerequisites, Attention

SectionBody, Paragraph Prerequisites, Paragraph

SectionBody, CliResponse Prerequisites, Transform-Wrap

SectionBody, Command Prerequisites, Transform-Wrap

SectionBody, Example Prerequisites, Transform-Wrap

SectionBody, GuiResponse Prerequisites, Transform-Wrap




.



SectionBody, Precaution Prerequisites, Precaution

SectionBody, Where Prerequisites, Table (see Common)

SectionBody, Procedure Prerequisites, Transform-Wrap

SectionBody, Table Prerequisites, Table

SectionBody, TermDef Prerequisites, Transform-Wrap

Section, Heading (tasks) Flowchart, Heading

SectionBody, Figure Flowchart, Figure

SectionBody, List Flowchart, Transform-Wrap

SectionBody, Note Flowchart, Transform-Wrap

SectionBody, Paragraph Flowchart, Paragraph

SectionBody, CliResponse Flowchart, Transform-Wrap

SectionBody, Command Flowchart, Transform-Wrap

SectionBody, Example Flowchart, Transform-Wrap

SectionBody, GuiResponse Flowchart, Transform-Wrap

SectionBody, Precaution Flowchart, Transform-Wrap

SectionBody, Where Flowchart, Table (see Common)

SectionBody, Procedure Flowchart, Transform-Wrap

SectionBody, Table Flowchart, Transform-Wrap

SectionBody, TermDef Flowchart, Transform-Wrap

Section, Heading (navigation) Navigation, Heading

SectionBody, Figure Navigation, Figure

SectionBody, List Navigation, List

SectionBody, Note Navigation, Attention

SectionBody, Paragraph Navigation, Paragraph

SectionBody, CliResponse Navigation, Transform-Wrap

SectionBody, Command Navigation, Transform-Wrap

SectionBody, Example Navigation, Transform-Wrap

SectionBody, GuiResponse Navigation, Transform-Wrap

SectionBody, Precaution Navigation, Precaution

SectionBody, Where Navigation, Table (see Common)




.



SectionBody, Procedure Navigation, Transform-Wrap

SectionBody, Table Navigation, Table

SectionBody, TermDef Navigation, Transform-Wrap

Section, Heading (jobaid) JobAids, JobAid, Heading

SectionBody, Figure JobAid, Figure

SectionBody, List JobAid, List

SectionBody, Note JobAid, Attention

SectionBody, Paragraph JobAid, Paragraph

SectionBody, CliResponse JobAid, CliResponse

SectionBody, Command JobAid, Command

SectionBody, Example JobAid, Transform-Wrap

SectionBody, GuiResponse JobAid, GuiResponse

SectionBody, Precaution JobAid, Precaution

SectionBody, Where JobAid, Table (see Common)

SectionBody, Procedure JobAid, ProcedureUnit

SectionBody, Table JobAid, Table

SectionBody, TermDef JobAid, Transform-Wrap

WorkflowModule, with no Sections, element mappingsChapter InfoType attribute set to Workflow. Chapter contains noSection elements and it contains Module elements (with an InfoType ofTaskflow or Procedural). Chapter does not contain Prerequisites orJobAid content.




Chapter, Heading mtbitopicref, Workflow, Heading




.



Introduction, Paragraph (before Figure) Purpose, Paragraph

Introduction, List (before Figure) Purpose, List

Introduction, Note (before Figure) Purpose, Attention

Introduction, Precaution (before Figure) Purpose, Precaution

Introduction, Table (before Figure) Purpose, Table

Introduction, Where (before Figure) Purpose, Table (see Common)

Introduction, Figure (work flow) Flowchart, Heading, Figure

Introduction, List (after Figure) Navigation, Heading, List

Introduction, Precaution (after Figure List) Navigation, Precaution

Introduction, Procedure Transform-Wrap (in context)

Introduction, CliResponse Transform-Wrap (in context)

Introduction, Command Transform-Wrap (in context)

Introduction, Example Transform-Wrap (in context)

Introduction, GuiResponse Transform-Wrap (in context)

Introduction, TermDef Transform-Wrap (in context)

TaskModuleA TaskModule shows the order and dependencies among a groupof procedures. The hierarchical parent of a TaskModule must be aWorkflowModule or a ContentGroupingModule.

NonMTBI2 TaskModule Chapter structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to Taskflow. Module attributes:InfoCategory should be set to the appropriate category and InfoType setto Procedural




.


NonMTBI2 TaskModule Module structureBefore transforming. Module attributes: InfoCategory should be set to theappropriate category and InfoType set to Taskflow.

NonMTBI2 Chapter structure that contains a Taskflow ModuleBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to Workflow.




.


For structure and element mappings, see "WorkflowModule, with noSections, element mappings" (page 320)and "WorkflowModule, withSections, element mappings" (page 318).

MTBI2 TaskModule structure

TaskModule Chapter element mappingsChapter InfoType attribute set to Taskflow




Chapter, Heading mtbitopicref, TaskModule, Heading

Introduction, Paragraph (1st) Purpose, Paragraph

Introduction, List (1st) Prerequisites, List




.



Introduction, Paragraph (flowchart) Flowchart, Paragraph

Introduction, Figure Flowchart, Figure

Introduction, List (after Figure) Navigation, List

Module mtbitopicref, moduletype (InfoType)

If present… Because can’t determine the context …

Introduction, Paragraph Transform-Wrap

Introduction, List Transform-Wrap

Introduction, Note Transform-Wrap

Introduction, Figure Transform-Wrap

Introduction, Precaution Transform-Wrap

Introduction, Table Transform-Wrap

Introduction, Procedure Transform-Wrap

Introduction, CliResponse Transform-Wrap

Introduction, Command Transform-Wrap

Introduction, Example Transform-Wrap

Introduction, GuiResponse Transform-Wrap

Introduction, Where Transform-Wrap

Introduction, TermDef Transform-Wrap

TaskModule Module element mappingsModule InfoType attribute set to Taskflow.




Module, Heading mtbitopicref, Taskflow, Heading







.













Section, Heading (prerequisites) Prerequisites, Heading

SectionBody, Figure Prerequisites, Figure


SectionBody, Note Prerequisites, Attention

SectionBody, Paragraph Prerequisites, Paragraph

SectionBody, CliResponse Prerequisites, Transform-Wrap

SectionBody, Command Prerequisites, Transform-Wrap

SectionBody, Example Prerequisites, Transform-Wrap

SectionBody, GuiResponse Prerequisites, Transform-Wrap

SectionBody, Precaution Prerequisites, Precaution

SectionBody, Where Prerequisites, Table (see Common)

SectionBody, Procedure Prerequisites, Transform-Wrap

SectionBody, Table Prerequisites, Table

SectionBody, TermDef Prerequisites, Transform-Wrap

Section, Heading (task) Flowchart, Heading

SectionBody, Figure Flowchart, Figure

SectionBody, List Flowchart, Transform-Wrap

SectionBody, Note Flowchart, Transform-Wrap

SectionBody, Paragraph Flowchart, Paragraph

SectionBody, CliResponse Flowchart, Transform-Wrap

SectionBody, Command Flowchart, Transform-Wrap




.



SectionBody, Example Flowchart, Transform-Wrap

SectionBody, GuiResponse Flowchart, Transform-Wrap

SectionBody, Precaution Flowchart, Transform-Wrap

SectionBody, Where Flowchart, Table (see Common)

SectionBody, Procedure Flowchart, Transform-Wrap

SectionBody, Table Flowchart, Transform-Wrap

SectionBody, TermDef Flowchart, Transform-Wrap

Section, Heading (task list) Navigation, Heading

SectionBody, Figure Navigation, Figure

SectionBody, List Navigation, List

SectionBody, Note Navigation, Attention

SectionBody, Paragraph Navigation, Paragraph

SectionBody, CliResponse Navigation, Transform-Wrap

SectionBody, Command Navigation, Transform-Wrap

SectionBody, Example Navigation, Transform-Wrap

SectionBody, GuiResponse Navigation, Transform-Wrap

SectionBody, Precaution Navigation, Precaution

SectionBody, Where Navigation, Table (see Common)

SectionBody, Procedure Navigation, Transform-Wrap

SectionBody, Table Navigation, Table

SectionBody, TermDef Navigation, Transform-Wrap


SectionBody, Figure JobAid, Figure

SectionBody, List JobAid, List

SectionBody, Note JobAid, Attention

SectionBody, Paragraph JobAid, Paragraph

SectionBody, CliResponse JobAid, CliResponse

SectionBody, Command JobAid, Command

SectionBody, Example JobAid, Transform-Wrap

SectionBody, GuiResponse JobAid, GuiResponse




.



SectionBody, Precaution JobAid, Precaution

SectionBody, Where JobAid, Table (see Common)

SectionBody, Procedure JobAid, ProcedureUnit

SectionBody, Table JobAid, Table

SectionBody, TermDef JobAid, Transform-Wrap

ProcedureModuleA ProcedureModule presents information that a user needs to install,operate, maintain, or troubleshoot a product. A ProcedureModulehas mandatory and optional structural elements. The hierarchicalparent of a ProceduralModule must be a TaskModule or aContentGroupingModule.

NonMTBI2 ProcedureModule structureBefore transforming. Chapter and Module attributes: InfoCategoryshould be set to the appropriate category and InfoType set to Procedure.




.


MTBI2 ProcedureModule structure

ProcedureModule element mappingsModule InfoType attribute set to Procedural.




Module, Heading mtbitopicref, ProcedureModule, Heading


Section, Heading Prerequisites, Heading


Section, Heading ProcedureUnit, Heading

SectionBody, Procedure, Step ProcedureUnit, Step




.



Section, Heading (variable definitions) VariableDefnsTable, Heading

SectionBody, Table VariableDefnsTable, Table

Section, Heading (example) Example, Heading

SectionBody, Procedure, Step ProcedureUnit, Step


SectionBody JobAid

Procedure, Heading ProcedureUnit, Heading

Precautions, Precaution Precautions, Precaution

Context Transform-Wrap

Step Step

StepGroup Transform-Wrap

Step, Action, Paragraph Step, Action, Paragraph

Step, Action, List Step, Action, List

Step, Action, List, List Step, Action, List, SubList

Step, Action, List, List, List Step, Action, List, SubList, Transform-Wrap

Step, Action, CliResponse Step, CliResponse

Step, Action, Command Step, Command

Step, Action, Example Step, Transform-Wrap

Step, Action, Figure Step, Figure

Step, Action, GuiResponse Step, GuiResponse

Step, Action, Note Step, Attention

Step, Action, Precaution Step, Precaution

Step, Action, Where Step, Table (see Common)

Step, CliResponse Step, CliResponse

Step, Command Step, Command

Step, Example Step, Transform-Wrap

Step, Figure Step, Figure




.



Step, GuiResponse Step, GuiResponse

Step, List Step, List

Step, List, List Step, List, SubList

Step, List, List, List Step, List, SubList, Transform-Wrap

Step, Note Step, Attention

Step, Note, Paragraph Step, Attention, Paragraph

Step, Note, List Step, Attention, Transform-Wrap

Step, Observation, element Step, element (using same rules as Step)

Step, Paragraph Step, Paragraph

Step, Precautions, Precaution Step, Precaution

Step, Precaution Step, Precaution

Step, Precaution, SubHeading Step, Precaution, SubHeading

Step, Precaution, Paragraph Step, Precaution, Paragraph

Step, Precaution, List Step, Precaution, List

Step, Precaution, Note Step, Precaution, Note

Step, Precaution, Example Step, Precaution, Example

Step, Procedure Step, Transform-Wrap

Step, Table Step, Table

Step, Where Step, Table (see Common)

If present... Within the context of the mapping above…

Introduction, Paragraph Paragraph

Introduction, List List

Introduction, Note Attention

Introduction, Figure Figure

Introduction, Precaution Precaution

Introduction, Table Table





.





Introduction, Exampe Transform-Wrap


Introduction, Where Table (see Common)



SectionBody, Figure Figure

SectionBody, List List

SectionBody, Note Attention

SectionBody, Paragraph Paragraph

SectionBody, CliResponse CliResponse

SectionBody, Command Command

SectionBody, Example Transform-Wrap

SectionBody, GuiResponse GuiResponse

SectionBody, Precaution Precaution

SectionBody, Where Table (see Common)

SectionBody, Procedure Transform-Wrap(except in SectionBody indicated)

SectionBody, Table Table

SectionBody, TermDef Transform-Wrap

ReferenceModuleA ReferenceModule supports a user in making decisions that are requiredto complete a task. Reference information is something a user consultsbut does not memorize. Examples of reference information includes: logs,commands, and definitions. A ReferenceModule can be included a childof a ContentGroupingModule using the mtbitopicref element.

NonMTBI2 ReferenceModule structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to ContentGroup. Moduleattributes: InfoCategory should be set to the appropriate category andInfoType set to Reference




.


MTBI2 ReferenceModule structureThe MTBI2 structure is presented as:

• ReferenceModule structure

• ReferenceModule in ContentGroupingModule within mtbimap structure

Attention: Reference content is presented in ReferenceModule modules and related reference content is included in a ContentGroupingModuleby using mtbitopicref elements within the publishable (mtbimap).




.


Figure 69ReferenceModule structure

Figure 70ReferenceModule in ContentGroupingModule within mtbimap structure




.


ReferenceModule element mappingsChapter InfoType attribute set to ContentGroup and Module InfoTypeattribute set to Reference




Chapter, Heading mtbitopicref, ContentGroupingModule, Heading



Module, Heading mtbitopicref, ReferenceModule, Heading


Introduction, List Navigation, List

Section, Heading (refunit, with children) ReferenceUnit, Heading


Section, Heading (refitem) ReferenceItem, Heading


Section, Heading (refunit, no children) ReferenceUnit, Heading

SectionBody, Paragraph ReferenceUnitBody, Paragraph



Introduction, List (after 1st) List











.








SectionBody, Figure Figure

SectionBody, List List

SectionBody, Note, Paragraph Attention, Paragraph

SectionBody, Note, List Attention, Transform-Wrap


SectionBody, CliResponse CliResponse

SectionBody, Command Command

SectionBody, Example Transform-Wrap

SectionBody, GuiResponse GuiResponse

SectionBody, Precaution Precaution

SectionBody, Where Table (see Common)

SectionBody, Procedure Transform-Wrap

SectionBody, Table Table

SectionBody, TermDef Transform-Wrap

TerminologyModuleA TerminologyModule is used to contain definitions of terms usedthroughout a document. It is included within a publishable using themtbitopicref within the mtbimap element.

NonMTBI2 TerminologyModule structureBefore transforming. Terminology attributes: InfoCategory should be setto the appropriate category and InfoType set to Terminology.




.


MTBI2 TerminologyModule structure

TerminologyModule element mappingsTerminology InfoType attribute set to Terminology.





.




Terminology, Heading Topics, mtbitopicref, TerminologyModule, Heading

Paragraph Purpose, Paragraph

TermGroup, Heading TermGroup, Heading

TermDefinitions TermDefinitions

TermDef, Term TermDef, Term

TermDef, Definition, Paragraph TermDef, Definition, Paragraph

ContentGroupingModuleA ContentGroupingModule supports the grouping together of relatedmodules. Examples of related modules includes: logs, commands, anddefinitions. Modules are included as a child of ContentGroupingModuleusing the mtbitopicref element within the publishable mtbimap element.

NonMTBI2 ContentGroupingModule structureBefore transforming. Chapter attributes: InfoCategory should be set tothe appropriate category and InfoType set to ContentGroup

The NonMTBI2 structure is a Chapter that can contain Section or Moduleelements.




.


MTBI2 ContentGroupingModule structure

ContentGroupingModule element mappingsChapter InfoType attribute set to ContentGroup.

Module elements within a Chapter, typically have an InfoType value ofConceptual, Procedural, or Reference. A source NonMTBI2 Chaptercan not contain a combination of Section and Module elements.




Chapter, Heading mtbitopicref, ContentGroupingModule, Heading


Introduction, List (1st one) Navigation, List

Section, Heading (Applies To) AppliesTo, Heading




.



Section, Heading (Prerequisites) Prerequisites, Heading

Section, Heading (Navigation) Navigation, Heading

Section, Heading (Interface graphic) IFGraphic, Heading

Module, Heading mtbitopicref, moduletype (InfoType)



Introduction, List (after 1st) List












Common element mappingsThis section provides common element and attribute mappings




xmlns : http://www.nortel.com/ xml/doctypes/nonmtbi2

xmlns : http://www.nortel.com/xml/doctypes/mtbi2

MTBI :nonmtbi MTBI :mtbi




.



Citation Citation

title title

number number

InlineFormat InlineFormat

DomainItemMention DomainItemMention

CondText CondText

IndexTerm IndexTerm

TopicAlias TopicAlias

xref xref

Caption Caption

Title Title

image image

ImageMap ImageMap

MapName MapName

Area Area

Href Href

target target

Note, Paragraph Attention, Paragraph

Note, List Attention, Transform-Wrap

_comment () _comment ()

_linefeed ( _linefeed (

_newpage ()

_newpage ()




.





.



Precaution (attention) Attention

List, Item List, Item

List, Item, List, Item List, Item, SubList, SubListItem

List, Item, List, Item, List List, Item, SubList, SubListItem, Transform-Wrap

List, Item, Precaution (attention) List, Item, Attention

List, Item, List, Item, Precaution (attention) List, Item, SubList, SubListItem, Attention

Where Table (two column,no Title,frame=none,Width=column)

OptionValueSet Table, Row

Option Row, Column1 (bold)

Value Row, Column2

Table, tgroup, tbody, row, entry, Precaution(attention)

Table, tgroup, tbody, row, entry, Attention

Table, tgroup, tbody, row, entry, List, Item, List,Item, Precaution (attention)

Table, tgroup, tbody, row, entry, List, Item,SubList, SubListItem, Attention

Table, tgroup, tbody, row, entry, List, Item, List,Item, List

Table, tgroup, tbody, row, entry, List, Item,SubList, SubListItem, Transform-Wrap

Table, tgroup, tbody, row, entry, Where Table,tgroup,tbody,row,entry, Table (Wheremapping)

Transform QA checklistThis module provides a QA checklist that should be used after a documenthas been transformed from NonMTBI2 to MTBI2.

Generic QA checks

Did the document open with an error message window? If so, see Fixing a document

Are there any comment tags in the document? If so, see Fixing a document

Are there any Transform-Wrap tags in the document? If so, see Fixing a document

Transform QA checks (compare with original PDF)

Are the NTDA filenaming conventions properly applied to all XML and image files?

Has all metadata been captured correctly in the XML file and within Documentum?

Are there any invalid attributes or invalid attribute values?

Are all XML documents chunked and stored in the correct locations withinDocumentum?

Are all image files stored in the correct locations within Documentum?




.

Transform QA checklist 343

Can the publishable be checked out/in with descendents from Documentum?

Can a PDF be generated using the PE server?

Has all content been transformed to the correct DTD element?

Are there any orphan elements that don’t map to a DTD element (enclosed inTransform-Wrap tags)?

Have all elements been transformed correctly?

Have all images been imported by reference at the correct location?

Have all tables and lists been converted/transformed correctly?

Have all links in the original been transformed correctly ?

Was all conditional text captured correctly?

Were all local variables captured correctly as text entities and populated throughoutthe content?

Also see the “Preconversion Checklist” and “Post Conversion QA checklist” @http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=13005659




.





.

345.

NTDA FAQThe following are answers and procedures to frequently asked questions.

Navigation• "What characters can be used within headings?" (page 345)

• "Why am I getting multiple Arbortext comments in my file?" (page 346)

• "How do I type in commonly-used ASCII characters?" (page 347)

• "What happens if I cancel a checkout after DLM registration?" (page347)

• "How do I get support outside regular working hours?" (page 347)

• "How do I avoid duplicate modules or images?" (page 349)

• "Moving modules between different folders" (page 351)

• "Updating the contents of entities-config.acl" (page 351)

• "Renaming modules" (page 353)

• "Deleting NTDA XML files from Documentum" (page 354)

• "Adding comments to a document" (page 355)

• "Removing unused text entities" (page 356)

What characters can be used within headings?Certain characters used within headings cause processing problems withinthe NTDA and should not be used.

Wherever possible, use only alphanumeric characters, up to a maximumlength of 100 characters.

Within headings, you can use the English alphanumeric (a-z, A-Z, 0-9)and the space, comma, period, dash, forward slash (/), and underscorecharacters.




.

346 NTDA FAQ

Characters that can not be used in headingsThe following characters are known to cause problems when used inHeading, Caption, Title, IndexTerm, TopicAlias elements, and in thetargetText attribute within the target element.

Character Description

$ dollar sign

% percent sign

^ caret, circumflex accent

* asterisk

\ backslash

‘’ apostrophes, single-quotes

“” double-quotes

< >angle brackets, chevrons, less-than and gre

ater-than symbols

# number sign, octothorpe, pound sign

& ampersand or logical AND sign

() brackets, parenthesis should only be used in pairs

™ trademark symbol

Why am I getting multiple Arbortext comments in my file?By default, Arbortext Editor will automatically add the following Arbortextidentifying comment to the 3rd line in all XML files that it opens: 

When a file is included by reference within another file, if an Arbortextidentifying comment is included in the referenced file it will be displayedjust before the inclusion point.

If the referenced file does not include an Arbortext identifying comment,Arbortext Editor will automatically add a new comment to the source fileeach time it is opened.

Avoiding multiple Arbortext comments in filesThe automatic inclusion of the Arbortext identifying comment can besuppressed. From the main Arbortext Editor menu bar: click on Tools,Preferences, Advanced and set writeaticomment to off.

The Arbortext identifying comment can be deleted from an XML file afteropening it with a text editor (eg, Notepad or WordPad).




.

How do I get support outside regular working hours? 347

How do I type in commonly-used ASCII characters?Certain ASCII characters can only be typed in using Alt + keypadcombinations (press the Num Lock key first).

Key combinations for common ASCII characters

Table 9Key combinations for common ASCII characters

Character Key combination

… Alt + 0133 (horizontal ellipsis)

– Alt + 0150 (en-dash)

— Alt + 0151 (em-dash)

™ Alt + 0153 (trademark sign)

Alt + 0160 (non-breaking space)

© Alt + 0169 (copyright sign)

® Alt + 0174 (registered trademark)

� Alt + 0176 (degree sign)

± Alt + 0177 (plus-minus sign)

µ Alt + 0181 (micro sign)

What happens if I cancel a checkout after DLM registration?Any content changes made to the document while it was checked out willbe lost, this includes all added or deleted DLM link information.

DLM link information within the cancelled document will be out-of-sync withthe link information within the DLM database.

Synchronizing DLM link informationTo bring the document and database DLM link information back into sync:

1. Select Nortel, DLM, Validate Links, Document

2. Save the document

3. Click Tools, Dynamic Link Manager, Register, Document.

How do I get support outside regular working hours?To get support outside regular business hours (Eastern time zone NorthAmerica) or during Nortel shutdown for holidays you must contact the ITSupport Center.




.

348 NTDA FAQ

Attention: NTDA support is usually initiated by raising a clarifyCR, see "CRs - Raising a CR against NTDA" available on Livelink athttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10985474.Clarify GDE/NTDA CRs are not monitored during Nortel holidayshutdowns; for example, over the Christmas period.

Contacting the IT Support CenterFor critical Severity 1 issues you must contact IT by phone at1-800-NT-4-HELP (1-800-684-4357) and indicate the application GCCM,DOCUMENTUM or NTDA. IT will raise the ticket for you. You can alsocontact IT by phone for Severity 2 or lower issues. IT will open the ticketfor you.

For Severity 2 or lower issues you can raise a ticket online:

1. In a web browser window, type http://zrchh00q.us.nortel.com/isexpress/?submit.html

2. Click on Case Submit.

3. Type in a Global ID

4. Answer the questions shown in Figure 71 "IS Express Case Submitform" (page 349)

5. Type in a brief description of the issue

6. Click on Next and then on Continue

7. Specify Details of the issue

8. Click on Next and confirm your request.




.


http://zrchh00q.us.nortel.com/isexpress/?submit.html


How do I avoid duplicate modules or images? 349

Figure 71IS Express Case Submit form

How do I avoid duplicate modules or images?Duplicate modules/images are caused when files are checked intoDocumentum with the same ObjectName. The duplicates are mostobvious when they are checked into the same Documentum folder;however, duplicates are less obvious when the same file is stored indifferent Documentum folders.

Causes of duplicate modules or imagesThe common causes of duplicate modules are presented below.




.

350 NTDA FAQ

During conversion from FrameMaker to XML or while transformingfrom nonmtbi to nonmtbi2, publishables that share modules/images areconverted or transformed independently of each other and the sharedmodules/images are duplicated and stored in different locations.

Avoiding: Identify shared modules/images before converting ortransforming publishables and store a single copy of each shared modulein a common location

Importing more than one copy of a module with the same metadata.

Avoiding: Before importing a module that contains the same content asan existing module, verify that it doesn’t already exist in Documentum.

Attention: Every module should have a unique name based on NTDAmodule naming conventions.

Importing a publishable complete with modules without changing themodule metadata.

Avoiding: When cloning a publishable verify that all the module metadatais changed before importing. When creating a new publishable that reusesexisting modules, build the new publishable by importing the modulesusing the Documentum, Paste Object Reference option.

Checking in files from the local PC that have the same name withinDocumentum using the Documentum Check in from file option.

Avoiding: Never check in XML files, other than checked out files alreadyin the Documentum Checkout folder, using the Check in from file option.

Importing modules into a publishable using the Documentum, PasteObject Duplicate option instead of the Paste Object Reference option.

Avoiding: Never use the Documentum, Paste Object Duplicate option.

Importing a module from the local PC into a publishable using the Insert,File or the Insert, File Reference options.

Avoiding: Never import modules into a publishable using the Insertmenu. Always check a module into Documentum before importing into apublishable using the Documentum, Paste Object Reference option.




.

Updating the contents of entities-config.acl 351

Moving modules between different foldersHere is an example of move module WI411-9001-106NewInThisReleasefrom the 411-9001-131 folder to the 411-9001-106 folder.

Procedure Steps

Step Action

1 Using a new Desktop Client session, open the 411-9001-131folder.

2 Using a different Desktop Client session, open the 411-9001-106folder

3 With WI411-9001-106NewInThisRelease checked in, in the 411-9001-131 window, click on WI411-9001-106NewInThisReleaseand drag-and-drop it into the 411-9001-106 window.

4 In the 411-9001-106 window, double-click on WI411-9001-106NewInThisRelease. Select Edit, Download and check out withdescendents, Check Out, Content, then open it with Epic Editor.

5 Change the DocNumber attribute on the top-level element from411-9001-131 to 411-9001-106, Save the document and Exitfrom Epic Editor.

6 Right-click on WI411-9001-106NewInThisRelease in the DesktopClient window the 411-9001-106 folder and Check In as a newversion.

Attention: Publishables that link to WI411-9001-106NewInThisRelease will not be affected, they will automatically pick it upfrom the new location.

--End--

Updating the contents of entities-config.aclThe entities-config.acl file contains text entities grouped by CVoIPrelease. The text entities for each release can be inserted into anypublishable using the Nortel, Add/Update CVoIP text entities menu item.This menu item is a Nortel Epic customization. The entities-config.acl fileis centrally controlled and distributed for use by all CVoIP authors.




.

352 NTDA FAQ

Attention: The CVoIP authoring group, or assigned prime,are responsible for changing and testing the contents of theentities-config.acl files for the nonmtbi and nonmtbi2/mtbi2 doctypes.Two versions of the entities-config.acl file are needed because themarkup is different for the nonmtbi and nonmtbi2/mtbi2 doctypes.

Procedure Steps

Step Action

1 Identify the required changes and obtain approval to add thechanges from your IA and PM.

2 Make the changes, or arrange to have them made bythe assigned authoring prime, to your local nonmtbi andnonmtbi2 copies of entities-config.acl (Documentum/XMLApplications/ecmprod/nonmtbi and nonmtbi2).

3 Test the changes with a publishable on your local PC andconfirm that they are correct.

4 Raise an NTDA CR. Include details of the change; the approvingIA and PM; who tested the change; and attach the updatedentities-config.acl files.

Attention: See "Updating and replacing PCF andentities-config.acl files" (page 220)

5 The NTDA Core team will respond to the NTDA CR and replacethe entities-config.acl file in the nonmtbi, nonmtbi2 and mtbi2DTD folders in the Documentum ecmprod docbase.

6 The NTDA Core team will raise a CSC ticket and send an emailrequesting that the entities-config.acl files be replaced in thenonmtbi, nonmtbi2 and mtbi2 DTD folders on all PE servers.

7 After receiving verification in the NTDA CR that the file has beenreplaced, check out and open any document to receive theupdated entities-config.acl file.

8 In an open publishable, click Nortel, Add/update CVoIP textentities and select the required text entity group to import textentities into the file.

9 Position your cursor anywhere you can use a text entity, clickEntities, Text, verify that you can see and insert the changedtext entities




.

Renaming modules 353

10 Exit the publishable and cancel the checkout without savingchanges.

11 Close the NTDA CR raised in Step 4.

Attention: Only import text entities into publishables; do notimport into modules.

--End--

Renaming modulesThe following example is how to rename TDR09010a4d80083519malcolmg-Chapter1 to malcolmg-Chapter1 modules. References from publishableswill not be affected.

Procedure Steps

Step Action

1 Using a new Desktop Client session, browse to documentum\Docbases\ecmstag2\NonMTBI\Modules\NTP\malcolmg1.

2 Right-click TDR09010a4d80083519malcolmg-Chapter1 and clickProperties.

3 Within the General properties tab, change TDR09010a4d80083519malcolmg-Chapter1 to malcolmg-Chapter1 and then clickOK.

4 Verify that the Name has changed and that the Version Labelhas remained the same.

5 Check out malcolmg-Chapter1 and change the ObjectNameattribute from TDR09010a4d80083519malcolmg-Chapter1 tomalcolmg-Chapter.

The document will check back in with a filename that equals thecontents of ObjectName and the checked out filename will beignored.

6 Check malcolmg-Chapter1 back in.

Attention: Publishables that previously linked toTDR09010a4d80083519malcolmg-Chapter1 will not be affected,they will now automatically link to malcolmg-Chapter1.




.

354 NTDA FAQ

--End--

Deleting NTDA XML files from DocumentumAuthors can not delete NTDA XML files (for example, duplicates orclones) from Documentum. Authors have to move XML files to thedocumentum\Docbases\ecmprod\ToBeDeleted folder. The followingexample shows how to move the file to the ToBeDeleted folder.

Procedure Steps

Step Action

1 Navigate to the module folder containing the file to be deletedand click on it.

2 Click View and ensure that Document Info and Details areselected.

3 In the Document Info View menu, select Locations of Version.

4 In the Document Info window, check to see if the file is beingused by a publishable, if it is:

• Check out the publishable and remove the module.

• Using the NTDA procedure for building a publishable, add therequired module

• Save and Exit from Editor and check in the publishable

5 Repeat if there are multiple versions of the publishable using themodule to be deleted.

6 Click the file to be deleted.

Attention: In the Document Info View menu, select AllVersions.

7 Select all versions listed in the Document Info window anddrag-and-drop them into the documentum\Docbases\ecmprod\ToBeDeleted folder.

--End--




.

Adding comments to a document 355

Adding comments to a documentAdding notes to a document for yourself or others who work on it can behelpful and convenient. You can do this in Arbortext Editor by insertingcomments. Comments do not appear in the formatted document. Theydo, however, appear in the Edit window of your document. The followingshows how to insert comments into your document.

Procedure Steps

Step Action

1 Place the cursor where you want the comment added.

2 From the Arbortext Editor menu bar, select Insert, Comment orpress the Alt+Ctrl+M keys.

3 With your cursor between the _comment tag pair, enter yournotes or comments.

4 By default, comments are displayed.

To turn off comments display, go to the Tools, Preferences.Choose the View category, and clear the Comments check box.




.

356 NTDA FAQ

Your comments will be hidden and the comment tags will bedisplayed as a double-pointed arrow icon.

5 To turn on comments display, click Tools, Preferences dialogbox. Choose the View category, and check the Commentscheck box to display comments.

Attention: Do not insert comments before the first tag in a file;for example, before nonmtbi, nonmtbi2, Front; mtbi2, Module,Chapter, ProcedureModule, ReferenceModule.

Attention: Do not insert comments between Step, Item,SubStep, or PrItem tags.

--End--

Removing unused text entitiesThe use of square brackets within text entities causes checkout andreuse problems. After a publishable has been checked in and text entitiesthat include square brackets are added to a module, the publishable canno longer be checked out until the square brackets in text entities are




.

Cancelling the checkout of locked files 357

removed from all modules referenced by the publishable. In addition,modules can not be copied and pasted by reference into any publishable.The following example shows how to fix this problem.

Procedure Steps

Step Action

1 Using the Documentum Desktop Client, check out an XML filethat may contain a text entity with square brackets.

2 Open the XML file with Arbortext Editor.

3 Click on Tools, Preferences and verify that Command Linepreference is checked.

4 In the Command window, type clean_entities::clean_unused_entities() and then press Enter.

All unused text entities will be removed from the currently openfile.

5 Save the file and check it back into Documentum

6 Repeat for all file that may contain text entities with squarebrackets.

Attention: It is recommended that this procedure be executedon all CVoIP modules and publishables that use them.

--End--

Cancelling the checkout of locked filesOccasionally, users leave the company to go on vacation with files stillchecked out of Documentum. If the original author is not available tocancel the checkout, the only way to cancel the checkout is to raise an ITsupport ticket to have CSC cancel the checkout.

CAUTIONCancelling a checkout means that all changes made while thedocument is checked out on the absent user’s computer willbe lost. After CSC cancels the checkout, you need to removeall checked out files from your Checkout directory (C: or D:\Documentum\Checkout

Because you will need to supply accurate path information, and capturingthe path over the phone is difficult, the method we recommend is to raise aticket using the IT Express web page.




.

358 NTDA FAQ

CAUTIONCancelling a checkout means that all changes made while the document ischecked out on the absent user’s computer will be lost. After CSC cancelsthe checkout, you need to remove all checked out files from your Checkoutdirectory (C: or D: \Documentum\Checkout

Raising an IT support ticket using IT ExpressProcedure Steps

Step Action

1 Launch your Web browser.

2 Access the following LiveLink page:


3 Click Case Submit

4 In the Case Submit - IS Express page, enter the your employeenumber as the Global ID then select the values for the fieldsshown in the following figure.

5 Click Next

An ENTER DETAILS FOR YOUR CASE page opens.

6 In the ENTER DETAILS FOR YOUR CASE page, enter theinformation as shown in the following figure.




.


Raising an NTDA CR 359

7 Click Next

A review case page opens.

8 In the review case page, check what you entered, then clickSubmit.

A window opens that contains your case number.

9 Write down the case number.

10 Send an e-mail to Katherine Minkofska-Garrigues([email protected]).

In the e-mail, include the case number and the information youtyped in the Details box of your IT Express case.

--End--

Raising an NTDA CRRaising an NTDA CR creates a record of a problem that is sent toscreeners in Knowledge Services. The screeners direct the CR to theperson or group who is best qualified to fix the problem and most readilyavailable able to solve a problem for you.

When raising an NTDA CR:

• limit the CR to one issue. Any CR that contains multiple unrelatedissues will be returned to you with a request to break it up into anumber of CRs

• ensure that you include the name and phone number of the personwho is experiencing the problem, if that person is not you




.

360 NTDA FAQ

• ensure that you include the full path in Documentum of any publishableor module affected

• include delivery dates impacted by the problem

• include screen captures of any error messages or source files

• specify the release of NTDA to which the CR applies

• dispatch the CR to the QU_KS_Documentation_Tool queue. Do notdispatch it directly to an individual. That individual may already bebusy.

Procedure Steps

Step Action

1 From the Start menu on your PC, select ClarifyCRM12.0,ClarifyCRM Client for Oracle

The ClarifyCRM login window opens.

2 Enter your Nortel account name (for example, your Americaseaccount name) in the User Name field, your Norpass passwordin the Password field, then click Login.

The Clarify CRM-ClearSupport window opens.

Attention: Do not alter the Server or Database fields.

3 If an administration message window opens, read it forinformation about outages, then click Done.

4 In the Clarify CRM - ClearSupport - [Console] window, selectthe ClearQuality icon




.


5 Click the New Change Request icon (the one that looks like abug).

The change request untitled window opens.

Attention: All of the items that have an asterisk (*) in frontof them are mandatory. You can leave all other items blank orunchanged.

6 In the Title field, type in a concise title for the problem.

For example: Unable to register NonMTBI2 document241-6001-121 in ecmprod

7 Click Product .

The change request product window opens.

8 In the change request product window:

1. In the Prereg Family field, select Knowledge Services

2. In the Preg Line field, select Documentation Tools

3. In the Prereg Module field, select:

— GDE/NTDA if the problem is not an enhancement




.

362 NTDA FAQ

— Core IA if the problem is an enhancement

4. Click List.A list appears in the bottom panel of the window.

5. In the list, select the Part No that best represents what theproblem applies to. See Table 10 "GDE/NTDA Part numbers"(page 365)

6. Click Use/DoneThe change request product window closes

Here is an example of what the change request product windowcan look like when you have made the selections:

9 In the Type field of the Change Request window, select one of:

• Hardware

• Software

• System

• Documentation

10 In the Priority field, select one of:

• 1 if you cannot deliver because of the problem

• 2 if you can deliver even with the problem but there is aserious defect.

• 3 if you can live with the defect in the short term




.


• 4 if the problem is niggly

• 5 if the problem can only be fixed by an enhancement.

11 In the Frequency field, select one of:

• Reproducible

• Intermittent

12 In the Details field enter a description of the problem. Be sure to

• limit the CR to one issue

• include the name and phone number of the person who isexperiencing the problem, if that person is not you

• include the full path name in Documentum of anypublishable(s)or module(s) involved

• include any deliverable dates impacted by the problem

• include the steps that led up to the problem

13 In the Found in Release field, select the release of NTDA inwhich the problem was found:

• 1.1c for problems found in nonmtbi

• 2.0 for problems found in nonmtbi2 or mtbi2

Here is an example of the window with the fields completed.

14 Click Save/Done.

The CR closes




.

364 NTDA FAQ

15 Attach screen captures or files. Be sure to attach:

• screen captures of any error messages you get

• source files or compiled files needed to understand the issue

• a completed change request form if you are requestingan enhancement. Here is a link to the copy of this form:http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=21041820

1. To attach a screen capture, open the CR in your inbox, clickNo attachments.A dialog in opens in which you can browse to find the graphic toattach.

Attention: You will not be able to complete the attachment unless youspecify a name for the graphic.

2. When you have attached the screen capture, clickSave/Done.The CR closes

16 Select the completed CR in your inbox.

17 Press the right mouse button to open a pop-up menu and selectDispatch

A Dispatch window opens.

18 In the Dispatch window:

1. Type QU_KS_Documentation_Tool in the field ahead of theList button.

2. Click List.QU_KS_Documentation_Tool appears under Queue name.

3. Click DispatchThe Dispatch window closes and the Clarify software sends the CRto the NTDA tools CR queue.




.




--End--

Table 10GDE/NTDA Part numbers

Part No’s that appear if you select GDE/NTDA

CD creating files for CDs

Conversion conversion from Frame to XML

Documentum problems with Documentum itself. Forexample, you don’t have a userid.

DTD DTD issues

Epic Authoring the Editor tool or using Editor

HTML Stylesheet not used yet

Linking broken links, problems registering, validationissues

OnProduct anything associated with onProduct Help

PDF stylesheet things that do not appear as they should inPDF

Publishing publishing issues. For example, cannot createa PDF at all.

Training problems with a training course

Transform NonMTI to NonMTBI2 or NonMTBI2 to MTB2transform problems




.

366 NTDA FAQ

Table 10GDE/NTDA Part numbers (cont’d.)

Part No’s that appear if you select GDE/NTDA

TS Portal things that should appear on the portal andare not appearing or that are not appearingcorrectly (wrong version)

Figures creation of figures

Part No’s that appears if you select Core IA

LiveLink arrangment of things in LiveLink

MTBI2 Modules anything to do with MTBI2 modules. This isthe Part No you are most likely to use.

Publishing publishing issues

Writing writing issues

Conventions convention issues




.

367.

TrainingThis reference information contains prerequisites, descriptions, and linksfor the NTDA training strategy.

Navigation• "NTDA training strategy" (page 367)

• "NTDA-GDE training" (page 367)

• "NTDA training prerequisites" (page 368)

• "NTDA training recommendations" (page 368)

• "Download information for the NTDA training course" (page 369)

• "Other training" (page 369)

• "Project manager checklist" (page 369)

• "Author checklist" (page 370)

NTDA training strategyThe NTDA training strategy is the following:

• Identify a number of key early adopters (names) in each area based onthe Conversion Schedule.

• Identify the documents to be converted and use them to test theconversion process with conversion vendor.

• Train the early adopters and ensure that they will be using the newNTDA-GDE tools.

• For everyone else, training will be scheduled according to theconversion schedule and conducted, ideally, within a week of having toactually start using the NTDA tools.

NTDA-GDE trainingThe planned NTDA-GDE training ranges from 0.5 to 4.5 days. Thecourses are the following:

• GDE System Overview & End-to-End Processes (0.5 day) for all of KS.




.

368 Training

• GDE Processes & Procedures (2 days) for all authors.

• GDE Release List & Publishing (1 day) for all Release Coordinators.

• GDE Change Management (1 day) for anyone with responsibility formanaging process and tool changes.

All training will be conducted via Centra. All participants are expected tohave the NTDA-GDE authoring environment (Documentum 5.2.5 andEditor 5.2) set up on their own machines in order to create the courseexamples and thereby gain hands-on experience in using the NTDA tools.

NTDA training prerequisites• Pentium 4, 1GB RAM Windows 2000/XP PC

• Documentum Desktop Client 5.2.5 SP3 and Arbortext Editor 5.2 M071or greater installed on your PC C or D drive (whichever has the mostspace). Documentum must be installed first. See: http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9762597

• For vendor authors: access to Nortel, Documentum, DLM, and Livelink.

• Registered for training and Centra set up on your PC. See:http://centra.nortelnetworks.com/

• Documentum user account in docbase ecmstag2.

• Acrobat 7 installed on your PC. See PAYGO at http://paygo.ca.nortel.com/cgi-bin/softindex.htm

NTDA training recommendationsIt is recommended that are authors have the following:

• Familiarity with basic Documentum concepts and functions such asdocument check in/out (as outlined in the “Documentum 5 DesktopClient User Guide”). See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9793344.

• Familiarity with the Nortel Customer Documentation Standards (NCDS).See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=14618351.

• Review Arbortext’s “Getting Started with Epic Editor for Authors”. Seehttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=9793342.

• Knowledge of, and where to locate, current KS Global Level 3processes. See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=12381615.

• Knowledge of, and where to locate, the KS Information Model. See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=12381615.




.



http://centra.nortelnetworks.com/

http://paygo.ca.nortel.com/cgi-bin/softindex.htm

http://paygo.ca.nortel.com/cgi-bin/softindex.htm











Project manager checklist 369

• Familiarity with the concepts and benefits of structured authoring. Seehttp://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10032733.

• Familiarity with basic XML terms and concepts. See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10032733.

• Authors who are going to author modules using the MTBI2 DTD musthave MTBI training including task analysis, task breakdown, and taskflow training sessions. See http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=12381385.

Download information for the NTDA training courseInformation for the NTDA training course (course code 2242F) is availableon Livelink, see http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10985474.

From the information available on Livelink:

• Unzip GDE 2242F XML Document into your NTDA Training folder.

• Print a copy of the NTDA Process and Procedures document (its big).

• Install the 30-day Mapedit trial software, available at http://www.boutell.com/mapedit/

Other trainingOther training is available, see the following:

• End-user training on using the TS Portal should be minimal.

• Conversion Vendor training: largely use the same training materialidentified above with some additional material for logging into thesystem and transferring files.

• Authoring vendor training: use same training material to train vendorpersonnel.

Project manager checklistPMs should use the following checklist as a guideline for the conversionprocess:

• Determine the conversion strategy: NonMTBI, NonMTBI2, or MTBI2.

• Ensure all authoring workstations meet minimum requirements;coordinate with vendor management as necessary.

• Ensure all authors (Nortel and vendor) have Documentum accountsand DTC 5.2.5 SP3 installed.




.









http://www.boutell.com/mapedit/

http://www.boutell.com/mapedit/

370 Training

• Ensure all authors (Nortel and vendor) have installed Arbortext Editor5.2 M071 and DLM.

• Identify all books for conversion and update conversion inventory withina 10% page count accuracy.

• Confirm conversion schedule with Laila Kamoun.

• Identify resources for pre- and post-conversion work.

• Complete the Conversion Forms for the source files (this providesmetadata and source file location for each NTP).

• Perform post-conversion QA; see Performing a QA check.

• Verify that all affected authors have registered for GDE-NTDA trainingduring the month of conversion.

• Make XML files available for authors to begin work.

• Cleanup the metadata in legacy PDFs in Helmsman

Author checklistAuthors should use the following checklist as a guideline for the conversionprocess:

• Make sure files for conversion are clean and production-ready (no extrafiles, book is generated, all graphics included). For more information,see the Document pre-pub checklist (version 01.01) KSID WI 3041available at http://livelink-ott.ca.nortel.com/livelink/livelink.exe/open/5950432.

• Ensure that training prerequisites have been met one month beforetraining.

• Attend NTDA training during the month of conversion, register athttp://www.nortel.com/training




.



http://www.nortel.com/training

371.

Common procedural modulesAll common procedural modules are grouped together here and linked tofrom elsewhere.

Inserting a citationUse the following procedure to insert a citation within your document.

Procedure Steps

Step Action

1 Using the Documentum Desktop Client, locate the requireddocument in the ecmprod doctype cabinet.

docbase.

2 Double-click on the required document and edit it

The document will open in Arbortext Editor.

3 Within any element where Citation is valid, press Enter andthen click on Citation.




.

372 Common procedural modules

Attention: The Citation element replaces InlineFormatDocTitle. Furthermore, currently the format of the Citationelement while authoring is incorrect; the format is correct in thePDF.

4 Within the Citation element tags, press the Enter key.

Then click on title.

The title tags will be inserted within the Citation element.

5 Within the title element, type the document title.

6 Within the Citation element and after the title end tag, pressEnter and then click on number.

7 Within the number element, type the document number.




.

Logging on to Documentum through Arbortext Editor 373

8 Repeat steps 3-7 for each Citation.

9 Click on File, Close and Save the changes made.

10 Using the Documentum Desktop Client, right-click on thedocument and select Check In.

--End--

Logging on to Documentum through Arbortext EditorUse the following procedure to log on to Documentum via Arbortext Editor.

Procedure Steps

Step Action

1 In the Arbortext Editor window select Documentum, Connect.




.


2 Select the required docbase from the drop-down menu.

3 Type in your Global_ID and NorPass.

4 Click Log On.

--End--




.

Modifying module attributes 375

Browsing Documentum through Arbortext EditorUse the following procedure to browse Documentum through ArbortextEditor.

Procedure Steps

Step Action

1 In the Arbortext Editor window select Documentum, Browse.

Docbase Browser box opens.

2 Expand the acquired Docbase element.

3 Right-click the necessary files.

--End--

Checking out a document through Arbortext EditorUse the following procedure to check out a document in Documentumthrough Arbortext Editor.

Procedure Steps

Step Action

1 Right-click the required object in the Documentum Browserwindow.

2 Click Check Out.

--End--

Checking in a document through Arbortext EditorUse the following procedure to check in a document via Arbortext Editor.

Procedure Steps

Step Action

1 Right- click document in Documentum Browser window.

2 Update version number accordingly.

3 Click Check In.

--End--

Modifying module attributesUse the following procedure to modify the attributes to the module.




.


Procedure Steps

Step Action

1 Put the cursor before the first module tag and click theModifyAttributes icon on the tool bar.

2 Set DocType to NTP or IM.

3 Set the required InfoCategory.

Attention: Optional for NonMTBI.

4 Set MTBI to N or Y.

5 For NonMTBI publishables only set Numbered field to No orYes.

6 Type the Title.

7 In the DocNumber field, type the DocNumber.

8 Set InfoType from a dropdown list.

9 In the ObjectName field type the component name of yourmodule.

10 Click Save.

--End--

Inserting elementsUse this procedure to insert elements into an XML document opened byArbortext Editor.

Prerequisites

• A document has already been opened by Arbortext Editor

Procedure Steps

Step Action

1 Position the cursor where you want to insert an element and thenpress the Enter key.

A list of the elements valid at the insertion point will be displayed in apop-up window.

2 Within the pop-up window, click on the required element.

3 Within the inserted element, type in the required content.




.

Inserting elements 377

4 Repeat Steps 1-3 for each required element

--End--

Examples of inserting elements

Inserting a List elementProcedure Steps

Step Action

1 Position the cursor where you want to insert a list, press Enterand then click on List.

2 Type in the required content.

3 For additional list items, position the cursor after the last Itemtag, press Enter, click on Item, and repeat from Step 2 untildone.

--End--

Inserting a Table elementProcedure Steps

Step Action

1 Position the cursor where you want to insert a table, press theEnter key and then click on Table.




.


2 Specify the Table Size and click on OK.

3 Position the cursor in the cell where you want to insert text andpress the Enter key; from the list of elements, select the requiredelement.

4 Type in the required content, and repeat Step 3 until done.

--End--

Applying formattingUse the following procedure to format your document.

Procedure Steps

Step Action

1 Place the cursor where you would like the formatting to occur.




.

Creating an index 379

2 Press the Enter key.

3 Then select DomainItemMention from the list.

The DomainItemMention attribute window will be displayed.

4 Select a DomainItemMention Type and click OK.

5 Save the changes made.

--End--

Job aidTo understand when to apply formatting to your document please seethe Writing Conventions in Nortel Customer Documentation Stanards(CS1808.00) .

Creating an indexUse the following procedure for creating an index.

Procedure Steps

Step Action

1 Using the Documentum Desktop Client, locate the requireddocument in the appropriateecmprod doctype cabinet.




.


2 Double-click on the required document and edit it.

The document will open in Arbortext Editor..

3 Within any element where IndexTerm is valid, press the Enterkey and then click on IndexTerm.

Attention: Index only passages where you discuss a term ortopic not where you just mention them; typically, this involvesplacing your cursor before a Heading containing the term ortopic you want to index.

4 Within the Primary element tag, type in the required text.

Attention: Use lowercase text unless it’s an acronym or propername.

5 If a 2nd level IndexTerm is required, while still within theIndexTerm element, press the Enter key.

Then click on Secondary and type in the required text.




.

Creating a text entity 381

6 If a 3rd level IndexTerm is required, while still within theIndexTerm element, press the Enter key and click on Tertiaryand type in the required text.

7 Insert See to cross reference synonyms of an index entry.

8 Insert SeeAlso to cross-reference a related index entry.

9 Repeat steps 3-8 for each index entry.

10 Insert an Index element, within the publishable, to initiate indexgeneration within the publishable.

11 Click on File, Close and Save the changes made.

12 Using the Documentum Desktop Client, right-click on thedocument and select Check In

--End--

Creating a text entityUse the following procedure to create a text entity.

Procedure Steps

Step Action

1 Select Tools, Preferences and select Window, check FullMenus, click OK.

2 Select the required text.

3 Select Entities, Create Text Entity From Selection.

4 In the Name field, type a varName. Click OK.

Attention: For CVoIP only, a set of text entities are definedin the entities-config.acl file which are inserted via Nortel,Add/update CVoIP text entities.




.


--End--

Checking completenessWith the Tools, Check completeness option checked, ArbortextEditor checks that all components required by the document type arepresent. As you create and edit a document, Arbortext Editor constantlychecks the context of your intended changes or additions and providesfeedback to ensure you are creating a valid XML document. Requiredelements, however, may still be missing when you try to save and exityour document.

Use the following procedure to check file completeness.

Procedure Steps

Step Action

1 In Arbortext Editor click Tools, Dynamic Link Manager,Connect and type in dca in the username field.

2 Click Tools and verify Context Rules are on.

3 Click Tools, Check Completeness.

4 If correct the message No completeness errors found (entitiesincluded) will appear at the bottom tool bar.

If there are errors the Arbortext Editor Completeness Checkbox displays.

--End--

Fixing content errorsUse the following procedure to fix any content errors in your document.

Procedure Steps

Step Action

1 In the Arbortext Editor Completeness Check box double click oneach error.

The cursor will be positioned at the error location in thedocument.

2 Identify why there is a structural error and fix the issueaccordingly.




.

Modifying publishable attributes 383

The Nature of Error column can help identify if the error is anelement inserted at the wrong location or a non-existent element.

For a non-existent or invalid attribute, shown in red, delete theattribute value.

For a non-existent element, shown in red, delete the element.

3 Save and Close the document.

4 Re-open the document and confirm there are no existing errors.

--End--

Checking module into DocumentumUse the following procedure to check the module file into Documentum.

Procedure Steps

Step Action

1 Save and Exit out of all Arbortext Editor sessions.

2 Open and log into Documentum using your Global ID andNorpass.

3 Navigate to the file on your local PC.

4 Navigate to the appropriate Docbase then click on theappropriate doctype.

5 Drag-and-drop the file from your local PC to the Modules folder.

The Import box displays.

6 In the format field choose ks_module from the drop-down menuand the appropriate doc type in the type field.

7 Click Import.

Module and its descendants are checked into Documentum.

--End--

Modifying publishable attributesUse the following procedure to modify the attributes the publishable.

Procedure Steps

Step Action

1 Put the cursor before the first publishable tag and click ModifyAttributes icon on the tool bar.

2 Set DocType to NTP or IM.




.


3 Set the required InfoCategory.

Attention: Optional for NonMTBI.

4 Set MTBI to N or Y.

5 For NonMTBI publishables only set Numbered field to No orYes.

6 Type the Title.

7 In the DocNumber field, type the DocNumber.

8 Set InfoType from a dropdown list.

9 In the ObjectName field type the DocNumber of yourpublishable.

10 Click Save.

--End--

Pasting modules using object referencesUse the following procedure to paste modules into the publishable.

Procedure Steps

Step Action

1 Place cursor after the Body or Topic tags.

2 Click Documentum, Connect.

3 Enter your Global ID and Norpass in the log in fields.

4 Click Documentum, Browse.

Documentum Browser opens.

5 Browse to the require module.

6 Right click the file and click Copy.

7 Click Documentum, Paste Object Reference.

8 Do this for each required module. Ensure modules follow correctorder and structure.

--End--

Inserting text entityUse the following procedure to insert text entities.




.

Checking publishable into Documentum 385

Procedure Steps

Step Action

1 Place cursor within an element and select Entities, Text.

2 Select the required text entity.

3 Click Insert.

The text entity is inserted.

4 Click View, Text Entities or File Entities.

--End--

Inserting a Terminology moduleUse the following procedure to insert a Terminology module.

Attention: Only use a Terminology module in Fundamentals documents.

Procedure Steps

Step Action

1 Place cursor within the Backmatter Tags.

2 Press Enter, and select Terminology.

3 Enter in the appropriate metadata in the DocNumber,ObjectName and Title fields.

4 Place the cursor within the Terminology tags and press Enter.Select the Heading tag from the list and enter in Terminology.

5 Place the cursor after the Heading tag and select TermGroup orTermDef and enter in the terms as necessary.

--End--

Checking publishable into DocumentumUse the following procedure to check the publishable file intoDocumentum.

Procedure Steps

Step Action





.



3 Navigate to the file on your local PC.

4 Navigate to the appropriate Docbase then click on theappropriate doctype.

5 Drag-and-drop the file from your local PC to the Publishablesfolder.

The Import box displays.

6 In the format field choose ks_publishable from the drop-downmenu and the appropriate doc type in the type field.

7 Click Import.

File properties dialog box displays.

8 Click theBasic I tab and enter in:

• DocRevision

• Language Product

• SoftwareRelease

9 Click theBasic II tab and enter in:

• JobFunction

• SubFunction

• DocReleaseDate

10 Click Apply, OK.

Publishable and its descendants are checked into Documentum.

--End--

Checking file out of DocumentumUse the following procedure to check the file out of Documentum.

Procedure Steps

Step Action

1 In Documentum click the correct Docbase and navigate to theappropriate file.

2 For a publishable, update the DocReleaseDate (Basic II),DocRevision (Basic I), and DocStatus (BasicII) properties.

3 Right-click the file and select Check Out.




.

Verifying local environment variables 387

4 Select Download and check out descendants and click CheckOut.

File is placed into your local Documentum/Checkout folder.

5 Start Arbortext Editorand open the file.

File opens in Arbortext Editor.

--End--

Checking in file into Documentum as minor versionUse the following procedure to check file a file into Documentum as aminor version to save changes made.

Procedure Steps

Step Action



3 Navigate to the appropriate file location in Documentum.

4 Right click the file and select Check In.

Check In to Docbase box displays.

5 Select Check in as Minor Version.

6 Click Check In.

File and descendants are checked into Documentum withchanges saved.

--End--

Verifying local environment variablesUse the following procedure to verify that your local environment variablesare set correctly.

Procedure Steps

Step Action

1 Right-click My Computer, Properties, Advanced.

2 Verify APTPNGUSERES=yes.




.


3 Verify [email protected].

--End--

Verifying preferencesUse the following procedure to verify preferences are set correctly inEditor.

Procedure Steps

Step Action

1 Click Tools, Preferences, Advanced .

2 Verify that:

• peservices set to on

• showentities set to both

• peserverurl set to:http://47.10.32.229:8080/e3/servlet/e3/ Nortel staff (ztcfs0n8)http://47.10.32.186:8080/e3/servlet/e3/ Vendor staff(ztcfs0mh)

--End--

Creating a neutral version of the NonMTBI documentUse the following procedure to create a neutral version of the NonMTBIsource file that contains profiled content.

Procedure Steps

Step Action

1 Within Documentum, right-click the document and select SendTo, Folder, As document and save the publishable includingdescendents to a new folder on your local PC.

2 Open the publishable with Arbortext Editor.

3 Verify that the Tools, Dynamic Link Manager menu option isdisabled.

4 Select File, Compose, Using XSL.

5 Specify a Save As filename of profiled-filename.xml2.

6 Select Stylesheet (e3) /gde/e3/v5.2/custom/doctypes/nonmtbi/NeutralnonMTBI.xsl




.

Verifying the neutral version of the NonMTBI document 389

7 Click Set Profile and select the required profiles and click onOK.

8 Click OK.

Publish using XSL complete is displayed in the lower left side ofthe status bar at the bottom of the Arbortext Editor window.

Attention: This step should be completed in less than 15minutes. If it is taking longer, verify that the amount of RAMbeing used is less than the maximum available; if it is more,abort, free up RAM, and try again .

9 Close, without saving, the filename.xml document and Exit fromArbortext Editor.

--End--

Verifying the neutral version of the NonMTBI documentUse the following procedure to verify the neutral version of the NonMTBIdocument.

Procedure Steps

Step Action

1 Open profiled-filename.xml with Arbortext Editor.

2 if you are prompted to choose the DTD by browsing toDocumentum/XML Applications/ecmprod/nonmtbi and selectnonmtbi.dtd.

3 Connect to DLM by selecting Tools, Dynamic Link Manager,Connect and type dca as the username.

4 Click Nortel, Add/Update link text for manually-addedtargets.


6 Click Nortel, DLM, Validate Links, Document.

7 There should be 0 errors. If there are any errors, identify thecause and close the document; repeat this procedure from thefirst task and fix the errors in the source XML document.

8 Click View, Generated Text, Update.

--End--




.


Generating a NonMTBI PDF with profiled contentUse the following procedure to generate a NonMTBI PDF with profiledcontent via the profile-filename.xml.

Procedure Steps

Step Action

1 Click File, Compose, PDF File.

2 Specify where to save the file via Save As.

3 Select View, PDF File, With Bookmarks and StylesheetNonMTBI 5.2 PDF bookmarks (e3) (…/PDFnonmtbiWBM.xsl).

4 Click OK to start composing the PDF file.

The PDF file will be automatically displayed.

5 Close the XML document without saving it and then delete thefolder which the profile-filename.xml is saved in.

--End--

Saving the NonMTBI2 variable templateUse this procedure to save the variable template.

PrerequisitesVerify that you have downloaded and installed GDE-NTDA_templates.zipfrom ecmprod/Templates/NTDA and, after being unzipped,that the Templates folder is in your local Documentum/XMLApplications/ecmprod folder.

Procedure Steps

Step Action

1 Within ecmprod/Templates/nonmtbi2, open var_nonMTBI2_Variable_template.xml with Arbortext Editor.

2 Click File, Save As and specify the required storage_path andfilename, then click File, Exit.

Attention: Use the var prefix all variable filenames.

--End--




.

Using a shared variable 391

Modifying variable attributesUse the following procedure to modify the variable attributes.

Procedure Steps

Step Action

1 Open the file for editing.

2 With the cursor just after the Variable start tag, select Edit,Modify Attributes and use the filename of the variable inthevarnameoption. .

3 Set chunk=yes.

4 Click OK.

--End--

Saving NonMTBI2 module templateUse the following procedure to save your NonMTBI2 module template thatyou will use.


Procedure Steps

Step Action

1 Open Arbortext Editor.

2 Browse to your NonMTBI2 templates folder; for example, D:\Documentum\XML Applications\ecmprod\Templates\nonmtbi2

3 Open the required template: module_template.xml,chapter_template.xml, chapter_with_modules_template.xmlor terminology_template.xml.

4 Click File, Save As and enter your module filename.

5 Click Save.

--End--

Using a shared variableUse this procedure to use shared variables.




.


Procedure Steps

Step Action

1 Position the cursor at the required insertion point for a variable,select Documentum, Browse and find the required variablewithin the Variables cabinet

2 Right-click the required variable and select Copy.

3 Position the curser at a valid insertion point and selectDocumentum, Paste Object Reference

4 Repeat steps 2-4 for each location where you want to use ashared variable.

--End--

Saving NonMTBI2 publishable templateUse the following procedure to save your NonMTBI2 publishable templatethat you will use.


Procedure Steps

Step Action


2 Browse to your NonMTBI2 templates folder; for example, D:\Documentum\XML Applications\ecmprod\Templates\nonmtbi2

3 Open NonMTBI2_publishable_template.xml.xml.

4 Click File, Save As and enter your publishable filename.

5 Click Save.

--End--

Setting document heading numberingUse the following procedure to set the document heading numbering.




.

Setting document heading numbering 393

Procedure Steps

Step Action

1 Using the Documentum Desktop Client, locate the requireddocument in the ecmprod NonMTBI2 Publishable folder.

2 Double-click on the document; select Edit, Check Out, Content.The document will open in Epic Editor.

3 Position the cursor just before the nonmtbi2 Front element atthe top of the file and then click the left mouse button.

4 Click on Edit, Modify Attributes…

5 Set the Numbered attribute to Unnumbered or Unnumberedaccording to the table below.

NonMTBI Attribute isUnnumbered

NonMTBI attribute isNumbered

• Chapter

• Module

• Section

Will be unnumbered tomatter what the settingof their Numberedattribute setting.

• Chapter

• Module

• Section

Numbering will beaccording to the valueof their Numberedattribute setting.

• Figure

• Table

• Procedure

The Numberedattribute settings willbe respected.

• Figure

• Table

• Procedure

The Numberedattribute settings willbe respected.




.


6 Click File, Compose, PDF File

7 Verify that the document is numbered according to the logicdefined above.

--End--

Setting the display of Nortel confidentialUse the following procedure to set the Nortel confidential to display in yourpublishable.

Procedure Steps

Step Action

1 Position the cursor just before the nonmtbi2 Front element atthe top of the file and then click the left mouse button.

2 Click Edit, Modify Attributes.

3 Set the Confidential attribute to Yes and then click OK.


5 Verify that Nortel Confidential appears in the lower right-handcorner of the footer on every page.

--End--

Generating a NonMTBI2 PDF with reuseUse the following procedure to generate a PDF of a NonMTBI document.




.

Generating a NonMTBI2 PDF without reuse 395

Procedure Steps

Step Action

1 Right-click the publishable in Documentum and select SendTo, Folder, As document and save the document includingdescendents to a new folder on your local PC.

2 Open the XML publishable with Arbortext Editor.

3 In the Command window, type spaces::remove() and thenpress Enter.

4 Select File, Compose, PDF File or PDF File with BookMarks.


6 Select the Stylesheet: NonMTBI2 v5.2 PDF Stylesheet

Attention: If you need to display the publishable contentstatus, use DocStatus Standard NonMTBI2 PDF Stylesheet.

7 Select View PDF File.

8 Click Set Profiles to set the profiles to be applied.


The PDF file will be displayed.

10 Close the XML document without saving it and then delete thefolder created in Step 2

--End--

Generating a NonMTBI2 PDF without reuseUse the following procedure to generate a PDF of a NonMTBI2 documentwithout reuse.

Procedure Steps

Step Action




4 Select the Stylesheet: NonMTBI2 v5.2 PDF Stylesheet




.


Attention: If you need to display the publishable contentstatus, use DocStatus Standard NonMTBI2 PDF Stylesheet.





--End--

Job aidThe nonmtbi2.dtd supports unlimited nesting of Sections; up to only 4levels are recommended (Chapter plus 3 levels of Sections). The PDFstylesheet provides unique formatting for up to 5 levels (Chapter plus4 levels of Sections, additional Sections are formatted the same asSection level 4). The TOC includes up to 3 levels (Chapter plus 2 levelsof Sections). In PDF, bookmarks are included for all registered Sectionswith TOC=Yes.

Creating a neutral NonMTBI2 documentUse the following procedure to create a PDF file of a NonMTBI2publishable containing profiled content.

Procedure Steps

Step Action

1 Open the file with Arbortext Editor.





.

Verifying neutral NonMTBI2 document 397

3 Specify a Save As filename of profiled-filename.xml,

4 Select Stylesheet (e3)/gde/e3/v5.2/custom/doctypes/nonmtbi2/NeutralnonMTBI2.xsl.

5 Click Set Profile and select the required profiles and click OK.

6 Click OK.

Publish using XSL complete is displayed in the lower left side.

Attention: This step should be completed in less than 15minutes. If it is taking longer, verify that the amount of RAMbeing used is less than the maximum available. If it is more,abort, free up RAM and try again.

7 Close without saving the filename.xml document and Exit fromArbortext Editor.

--End--

Verifying neutral NonMTBI2 documentUse the following procedure to verify the neutral version of the NonMTBI2profiled document.




.


Procedure Steps

Step Action

1 Open the profiled-filename.xml with Arbortext Editor.

2 If you are prompted to choose a DTD, browse toDocumentum/XML Applications/ecmprod/nonmtbi2and select nonmtbi2.dtd.

3 If there are any errors, identify the cause, and then:

• Save and Close profiled-filename.xml.

• Open the source XML document (filename.xml).

• Repeat the task from the "Checking completeness" (page382)procedure in Figure 23 "NonMTBI2 PDF generation withprofiled content task flow" (page 85) .

4 Connect to DLM by selecting Tools, Dynamic Link Manager,Connect, and type dca as the username.

5 Type blanknonmtbi2() after the Arbortext Editor Command:prompt.


7 Click Nortel, DLM , Validate Links, Document or ValidateLinks, Element (for the 2nd and subsequent passes in elementswhere a link was fixed).

There should be 0 errors.

Three types of errors are possible from link validation

• Link errors that are fixed automatically by the validation. Youmust register the document again to fix these errors: Tools,Dynamic Link Manager, Register, Document. For thesetypes of errors watch for the word fixed or CHANGED in theerror message; for example, Link marked as ADDED, butalready exists on the server (fixed by setting the links’ state toCHANGED).

• Links that have targets outside the document. These errorscan be ignored; for example, The target is not in the currentdocument.

• Link errors that should be fixed in the XML source file; forexample, The link key is used for multiple links in the currentdocument. Contact the authoring prime to fix these errors inthe source XML file filename.xml.

8 If there are any errors, identify the cause, and then:




.

Generating a NonMTBI2 PDF with profiled content 399

• Save and Close profiled-filename.xml.

• Open the source XML document (filename.xml).

• Repeat the task from the "Checking completeness" (page382)procedure in Figure 23 "NonMTBI2 PDF generation withprofiled content task flow" (page 85) .

--End--

Generating a NonMTBI2 PDF with profiled contentUse the following procedure to generate a NonMTBI2 PDF with profiledcontent.

Procedure Steps

Step Action

1 In the profiled-filename.xml document type spaces::remove()after the Arbortext Editor Command: prompt.

2 Click File, Compose, PDF File....

• Specify where to save the file via Save As (by default, it willbe saved in the Checkout folder).

• Select View PDF File and Stylesheet NonMTBI2 v5.2 PDFStylesheet.


• Click OK to start composing the PDF file. The PDF file will beautomatically displayed.

3 After closing it, move the PDF file to your desktop.

4 Close profiled-filename.xml without saving it.

Attention: Do Not import it into Documentum.

5 Delete profiled-filename.xml and the associated folder.

6 Perform a QA on the PDF file and verify that there are noerrors; if there are errors you will have to fix them in the source




.


XML file (filename.xml), repeat the task from the "Checkingcompleteness" (page 382)procedure in Figure 23 "NonMTBI2PDF generation with profiled content task flow" (page 85) .

--End--

Saving the MTBI2 variable templateUse this procedure to save the variable template.


Procedure Steps

Step Action

1 Within ecmprod/Templates/mtbi2, open var_MTBI2_Variable_template.xml with Arbortext Editor.

2 Click File, Save As and specify the required storage_path andfilename, then click File, Exit.

Attention: Use the var prefix all variable filenames.

--End--

Fixing WhatsNewModule or ConceptModule context errorsDirect embedding of WhatsNewModule and ConceptModule elementswithin themselves used to be supported, it is no longer. Openingdocuments containing such embedding turns off context checking.

This procedure presents the steps required to fix context errors due to thedirect embedding of WhatsNewModule or ConceptModule elements.

Procedure Steps

Step Action

1 Open a checked out document with Arbortext Editor.




.

Fixing WhatsNewModule or ConceptModule context errors 401

If there are structural errors, a message window will appear thatindicates that context checking has been turned off.

2 Click on OK in the Arbortext Editor Message window to proceed.

3 Locate the errors, click on Tools, Context Rules.

For WhatsNewModule or ConceptModule structural errors, you will getan error message in the status bar stating that context rules are off.

4 Position the cursor immediately after the WhatsNewModuleor ConceptModule closing tag, but still within the existingmtbitopicref element, and click on Insert, Markup... , thenselect mtbitopicref and click on Insert.

5 Move the WhatsNewModule or ConceptModule into theinserted mtbitopicref element.

6 Repeat until Context Rules stays on (which indicated nostructural errors).

7 Save and close the document and then re-open it.

The document should open with no structural errors and Context Ruleson.

--End--

WhatsNewModule exampleFigure 72 "Invalid WhatsNewModule structure" (page 402) indicates anincorrectly embedded WhatsNewModule with a structural error and Figure73 "Valid WhatsNewModule structure" (page 402) indicates the fixed andcorrect structure.




.


Figure 72Invalid WhatsNewModule structure

Figure 73Valid WhatsNewModule structure

ConceptModule exampleFigure 74 "Invalid ConceptModule structure" (page 402) indicates anincorrectly embedded ConceptModule with a structural error and Figure75 "Valid ConceptModule structure" (page 402) indicates the fixed andcorrect structure.

Figure 74Invalid ConceptModule structure

Figure 75Valid ConceptModule structure




.

Generating a MTBI2 PDF without reuse 403

Saving MTBI2 publishable templateUse the following procedure to save your MTBI2 publishable template thatyou will use.


Procedure Steps

Step Action


2 Browse to your MTBI2 templates folder; for example, D:\Documentum\XML Applications\ecmprod\Templates\mtbi2

3 Open the template for the type of publishable being created:

• mtbi2_combined_publishable.xml

• mtbi2_conceptual_publishable.xml

• mtbi2_new-in-this-release_publishable.xml

• mtbi2_procedural_publishable.xml

• mtbi2_reference_publishable.xml

4 Within the mtbimap element, select Edit, Modify Attributes...and specify the required publishable attributes (they areunderlined):

• DocNumber

• ObjectName

• Title


6 Click Save.

--End--

Generating a MTBI2 PDF without reuseUse the following procedure to generate a PDF of a MTBI2 documentwithout reuse.




.


Procedure Steps

Step Action




4 Select the Stylesheet: MTBI2 v5.2 PDF Stylesheet

Attention: If you need to display the publishable contentstatus, use DocStatus Standard MTBI2 PDF Stylesheet.





--End--

Generating a MTBI2 PDF with reuseUse the following procedure to generate a PDF of a MTBI2 document withreuse.

Procedure Steps

Step Action

1 Right-click the required document in Documentum and selectSend To, Folder, As document and save the documentincluding descendents to a new folder on your local PC.

2 Click Nortel, Replace spaces in CliResponse, Command andGuiResponse

3 Select File, Compose, PDF File.


5 Select the Stylesheet: MTBI2 v5.2 PDF Stylesheet.




.

Creating a neutral version of an MTBI2 document 405






--End--

Creating a neutral version of an MTBI2 documentUse the following procedure to create a neutral version of an MTBI2source file that contains profiled content.

Procedure Steps

Step Action

1 Within Documentum, right-click the document and select SendTo, Folder, As document and save the publishable includingdescendents to a new folder on your local PC.

2 Open the publishable with Arbortext Editor.

3 Verify that the Tools, Dynamic Link Manager menu option isdisabled.


5 Specify a Save As filename of profiled-filename.xml2.

6 Select Stylesheet (e3) /gde/e3/v5.2/custom/doctypes/mtbi2/NeutralMTBI2.xsl

7 Click Set Profile and select the required profiles and click onOK.

8 Click OK.

Publish using XSL complete is displayed in the lower left side ofthe status bar at the bottom of the Arbortext Editor window.

Attention: This step should be completed in less than 15minutes. If it is taking longer, verify that the amount of RAMbeing used is less than the maximum available; if it is more,abort, free up RAM, and try again .




.


9 Close, without saving, the filename.xml document and Exit fromArbortext Editor.

--End--

Verifying the neutral version of the MTBI2 documentUse the following procedure to verify the neutral version of the MTBI2document.

Procedure Steps

Step Action

1 Open profiled-filename.xml with Arbortext Editor.

2 if you are prompted to choose the DTD by browsing toDocumentum/XML Applications/ecmprod/mtbi2 and selectmtbi2.dtd.

3 Connect to DLM by selecting Tools, Dynamic Link Manager,Connect and type dca as the username.



6 Click Nortel, DLM, Validate Links, Document.

7 There should be 0 errors. If there are any errors, identify thecause and close the document; repeat this procedure from thefirst task and fix the errors in the source XML document.

8 Click View, Generated Text, Update.

--End--

Generating a MTBI2 PDF with profiled contentUse the following procedure to generate a MTBI2 PDF with profiledcontent via the profile-filename.xml.

Procedure Steps

Step Action

1 Click Nortel, Replace spaces in CliResponse, Command andGuiResponse






.

Exporting publishable onto your local PC 407

4 Select View PDF File and Stylesheet MTBI2 v5.2 PDFStylesheet.



The PDF file will be automatically displayed.

6 Close the XML document without saving it and then delete thefolder which the profile-filename.xml is saved in.

--End--

Pasting objects using object referencesUse the following procedure to insert objects into your file.

Procedure Steps

Step Action

1 Select Documentum, connect.

2 Enter in your Norpass.

3 Click Log on.

4 Select Documentum, Browse.

Docbase browser displays.

5 Navigate to the object to be inserted.

6 Right-click and select Copy.

7 Select Documentum, Paste Object Reference.

8 Repeat for each object to be inserted.

--End--

Exporting publishable onto your local PCUse the following procedure to export the local publishable onto your PC

Procedure Steps

Step Action

1 Navigate to the publishable cloned within docbase ecmprod.




.


2 Right-click the required publishable and select File, Send To,Folder, As Document.

3 Select Also export descendents and Save the file into a newfolder on your local PC.

--End--

Transforming NonMTBI documentUse the following procedure to transform the NonMTBI document.

Procedure Steps

Step Action

1 Open filename.xml in the new folder with Arbortext Editor.

Attention: The Tools, Dynamic Link Manager menu option willbe disabled.

2 Click Nortel, Transform: pre-convert text entities.

If there are any text entities in the file, all text entities are copiedand inserted text entities are renamed.

If you get it, you can ignore the message [A11906] String notfound [case insensitive, markup included]


4 Specify a Save As filename of filename.xml2.

5 Select Stylesheet NonMTBI to NonMTBI2 Transform, v5.2.0(e3) (.xsl).

6 Click OK.

Publish using XSL complete is displayed in the lower left side ofthe status bar at the bottom of the Arbortext Editor window fora successful transform.

Attention: The transform also creates a new graphics folder inthe new folder created in Step 4, this is expected and you canignore it




.

Opening the file in NonMTBI2 409

7 Close without saving the document and Exit from ArbortextEditor.

8 Rename filename.xml to filename.xml1 and filename.xml2 tofilename.xml.

In the Rename window, click Yes to confirm the filenameextension changes; also note the file icon changes.

--End--

Opening the file in NonMTBI2Use the following procedure to open the file transformed from NonMTBI toNonMTBI2.

Prerequisites

• Verify the nonmtbi2 DTD folder is placed in your localDocumentation/XML Applications/ecmprod folder. If it is not present,navigate to the ecmprod/NonMTBI2/Publishables folder; right-clickon any publishable and select Check Out; immediately after checkouthas completed, right-click on the checked out publishable and selectCancel Check Out.

Procedure Steps

Step Action

1 Open the recently transformed file with Arbortext Editor.

2 If prompted locate a DTD for the document by browsing to yourlocal Documentum/XML Applications/ecmprod folder and clickon nonmtbi2.dtd.

The message Unable to obtain a license for optional componentDLM will appear in the lower left side of the status bar at thebottom of the Arbortext Editor window.

Attention: The file may take a long time to open (30 min orlonger). When the file opens, missing graphics at the top of thefile is expected. The TOC does not include page numbers (theydo appear in the PDF).

--End--




.


Transforming post-converted text entitiesUse the following procedure to transform post-converted text entities.

Procedure Steps

Step Action

1 Click Nortel, Transform: post-convert text entities.

All text entities copied and are declared and inserted text entitiesare renamed back to their original names.

2 If cvoip-sn09u or cvoip-sn10 text entities are used, click Nortel,Add/update CVoIP text entities . Click Entities, Text and in theText Entities window delete all text entities that include the string<InlineFormatType=’DocTitle’>.

3 Save the document and Exit from Arbortext Editor.

--End--

Importing transformed publishable into DocumentumUse the following procedure to import the recently transformed publishableinto Documentum.

Procedure Steps

Step Action

1 In Documentum Desktop Client navigate to ecmprod/NonMTBI2folder.

2 Drag-and-drop the file into the ecmprod NonMTBI2 folder.

3 Set Type to ks_publishable .

4 Set XML Category to nonmtbi2.

5 Click Import.

Attention: If you get a “Fatal SAX Exception Occurred” error,check the required metadata on Chapter elements.

--End--

Deleting transform foldersUse the following procedure to delete transform folders off your local PC.




.

Renaming file v2 411

Procedure Steps

Step Action

1 Navigate to the transform folder saved on your local PC.

2 Highlight and press the Delete key.

3 Delete any cloning folders as well.

--End--

Exporting original fileUse the following procedure to export the original file to be split into 2volumes.

Procedure Steps

Step Action

1 Using Desktop Client, navigate to the document to be split withinecmprod.

2 Right-click the required document.

3 Select File, Send To, Folder, As Document.

4 Save the document on your local PC in new folder DocSplit.

--End--

Renaming file v2Use the following procedure to rename the volume 2 of your split NonMTBIpublishable.

Procedure Steps

Step Action

1 From the DocSplit folder, open the folder saved with ArbortextEditor.

2 Select Tools, Dynamic Link Manager, Connect and type dca.

3 Select File, Save As and enter v2 filename.

4 Rename the nonmtbi ObjectName and DocNumber attributevalues.

5 Add v2 to the end of the nonmtbi Title attribute value.

6 Verify that v2 file and v1 file have different DCAM/DLM-ids.




.


7 Select File, Save and then File, Exit to close.

--End--

Modifying v1 fileUse the following procedure to modify the content in volume 1 of thepublishable.

Procedure Steps

Step Action

1 From your Documentum Checkout folder, open file v1.

2 Select Tools, Dynamic Link Manager, Connect.

3 Rename the nonmtbi ObjectName and DocNumber attributevalues to v1.

4 Add v1 to the end of the nonmtbi Title attribute value.

5 Locate the last Module | Chapter to be included in v1.

6 Delete all Modules/Chapters from that point onwards up to theBackPage element.

7 Fix or remove all DLM links to deleted modules.

--End--

Checking in v1 as same versionUse the following procedure to check in file v1 into Documentum as thesame version.

Procedure Steps

Step Action

1 Navigate to the file inecmprod/NonMTBI/publishables folder.

2 Right-click the file and select Check In.

3 Select As Same Version and click Check In.




.

Checking in v2 as same version 413

--End--

Deleting v1 content in v2Use the following procedure to delete the content from v1 in the v2publishable.

Procedure Steps

Step Action

1 Locate, within DocSplit, and open v2 with Arbortext Editor.

2 Select the modules included in v1 and delete them.

3 Fix or remove all DLM links to deleted modules.

4 Save and Exit.

--End--

Checking in v2 as same versionUse the following procedure to check in file v2 into Documentum as thesame version.

Procedure Steps

Step Action

1 Navigate to the file inecmprod/NonMTBI/publishables folder.

2 Right-click the file and select Check In.

3 Select As Same Version and click Check In.




.


--End--

Resetting your authoring environmentUse this procedure to delete Documentum and Editor cache files.

Procedure Steps

Step Action

1 Ensure that DTCSP3-Documentum Desktop.msi is in a folderon your PC somewhere.

If unavailable on your PC download from http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=10105062

2 If possible, checkin or cancel the checkout of all documents andlogout of all Documentum docbases.

3 Right-click on the Documentum icon and select Work Offline.

4 In your local Documentum folder, delete the ecmprod, ecmdev,ecmstag2, and dmcl folders and any .arc files.

5 In your local Documentum\XML Applications\ecmprod folder,delete the nonmtbi, mtbi, nonmtbi2, and mtbi2 folders.

6 Right-click on the Documentum icon and de-select Work Offline.




.



Using local variables 415

7 Ensure that Editor is not running and then delete the .aptcachefolder within your Editor custom folder.

eg, D:\Program Files\Arbortext\Editor\custom

8 Restart your PC.

Attention: After a reset, when opening a document you maybe prompted to locate a DTD to use; browse to your localDocumentum/XML Applications/ecmprod folder and click therequired DTD.

--End--

Using local variablesUse this procedure to create and use local variables.

Procedure Steps

Step Action

1 To create a text entity select Tools, Preferences, and selectWindow. Ensure Full Menus check box is checked. Click OK.

2 Select the required text.

3 Choose Entities, Create Text Entity From Selection.

4 In the Name field, type a varName. Click OK. Use the var prefixfor all variables.




.


5 To insert a text entity place cursor within an element and selectEntities, Text.

6 Select the required text entity.

7 Click Insert.

The text entity is inserted.

--End--

Using the SME Access toolUse the following to observe how the SME Access tool process isexecuted.

Attention: Do not use, for information purposes only.

Procedure Steps

Step Action

1 Checkout and open the XML document with Epic Editor.

2 Generate a PDF file, select File, Compose, PDF File.

3 Cancel the Checkout of the XML document.

4 Right-click the XML document and select Document Lifecycle,Apply, SME_Review_Lifecycle.

5 Select View, Document Info; click the XML document.




.

Customizing the MTBI2 Documentation Roadmap template 417

6 In bottom window, select View: Renditions of Version.

7 Drag and drop the PDF file into the rendition window.

8 Right-click the XML document and select Properties.

9 Right-click the XML document and select Document Lifecycle,Apply, SME_Review_Lifecycle.

10 Type http://smeaccess.ca.nortel.com/index.jsp.

11 Select Assign SMEs, see http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=12832753

--End--

Customizing the MTBI2 Documentation Roadmap templateRoadmap 1.0 Milestone 0.4 requires that project groups remove the"About this document" section from Nortel technical documents and placethe appropriate content in either a standalone Documentation Roadmappublishable or a module within a Fundamentals publishable. An MTBI2Documentation Roadmap publishable template (NN10810-005) is availableto assist you. The procedures provided herein show you how to customizethe template to create a Documentation Roadmap publishable or module.

Navigation

• "Customizing the MTBI2 Roadmap publishable template" (page 417)

• "Customizing the MTBI2 Roadmap module template" (page 418)

Prerequisites

• Boilerplate text is indicated by comments in the XML source.

• Do not modify boilerplate text.

• Customizing the MTBI2 Roadmap publishable templateProcedure Steps

Step Action

1 For a new publishable, browse to ecmprod\Templates\NTDA\NN10810-005; right-click on it and select Send To and savethe publishable, and all descendents, into a new folder on yourdesktop.

2 Open, with Arbortext Editor, NN10810-005.xml and connect toDLM.

3 Within the mtbimap element, change DocNumber andObjectName to the required document number.

4 Expand the Front element.




.

http://smeaccess.ca.nortel.com/index.jsp




5 Customize the PublicationMetadata as required.

6 Expand the Topics element.

7 Expand each mtbitopicref element.

8 Within each mtbitopicref element expand each module and childelement.

9 Within each module element, change the DocNumber value tomatch the new document number.

10 Customize the content within each module and child elementwhere indicated by comments.

11 Save the new publishable with a filename that matches theObjectName value specified in the mtbimap element.

12 After exiting Arbortext Editor, check the file into Documentum.

--End--

Procedure Steps

Step Action

Customizing the MTBI2 Roadmap module templateProcedure Steps

Step Action

1 Browse to ecmprod\MTBI2\Modules\NN10810-005\CustomerSupport\Reference\KS_Roadmap2; right-click on it and selectSend To and save the module, and all descendents, into a newfolder on your desktop.

2 Open, with Arbortext Editor, KS_Roadmap2.xml and connectto DLM.

3 Within the ReferenceModule and ReferenceUnit elements,change DocNumber to the required value (for example, thepublishable document number).

4 Within the expanded ReferenceModule and ReferenceUnitelements, customize the content where indicated by comments.

5 Save the new module with a filename that matches theObjectName value specified in the ReferenceModule element.

6 After exiting Arbortext Editor, check the file into Documentum.

--End--




.

Fixing formatting errors 419

Fixing formatting errorsWithin a PDF file, the format of elements can sometimes be incorrect. Thismodule provides instructions for fixing common formatting issues.

Navigation

Problem Procedure

The contents of a table rowoverflows its bounds andoverwrites either the footer orthe contents of the next row

"Fixing table row overflow errors" (page 419)

Fixing table row overflow errorsProcedure Steps

Step Action

1 In the XML source file, click in the Table row that has theformatting problem.

2 Click on Table, Properties...

3 Click on the Row tab and ensure that Natural is selected.




.


4 Click on OK to set the row height to Natural.

--End--

Importing variable into DocumentumUse this procedure to import the created variable into documentum.

Procedure Steps

Step Action

1 Navigate to the ecmprod/ Variables cabinet.

2 Identify or create a folder to store the new variable.

3 Drag-and-drop the document into the folder identified.

4 For type select ks_module. Specify the required XML category.

5 Click Import. Do not Check In to Documentum if there are anyerrors.

--End--

Download and install FileZillaThis procedure installs and performs basic configuration on the FileZillasoftware.

You will need FileZilla to do the following:

• FTP PDFs from the Citrix server to your PC

• FTP Neutralized XML source to your PC if you are preparing onProducthelp




.

Download and install FileZilla 421

If you already have FileZilla installed on your PC, you can skip thisprocedure.

Procedure Steps

Step Action


http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=25916096&objAction=browse&sort=name&viewType=1

2 Double-click FileZilla_2_2_18_setup.exe.

A File Download window opens.

3 Click Save.

A dialog opens in which you can select the destination of the download.

4 Navigate to your desktop, then click Save.

A download progress dialog opens and the FileZilla_2_2_18_setup.exedownloads to your desktop.

5 Double-click the FileZilla_2_2_18_setup.exe on the desktop.

The installer launches.

6 Use the default values to complete the installation.

7 Double-click the FileZilla shortcut on your Desktop.

A FileZilla window opens on your Desktop.

8 From the Edit menu, select Settings.

A FieZilla Options window opens.

9 In the menu panel, select Interface Settings.

The Interface Settings window opens.

10 In the interface Settings window, select the following items.Ensure all of the other items are deselected.

• Always use the following configuration below

• Toolbar

• Show view labels

• Minimize task bar (default)

11 In the menu panel, select Local file list.

The local file list window opens.

12 In the Local file list window, select the following items. Ensure allof the other items are deselected:




.

http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll<?Pub & EntityName=amp>objId=25916096<?Pub & EntityName=amp>objAction=browse<?Pub & EntityName=amp>sort=name<?Pub & EntityName=amp>viewType=1



• Always use the following configuration

• Default list Details

• File size

• File type

• Last modified time

• Show status bar with information about selected files

• File size format in details Auto

• Transfer

13 In the menu panel, select Remote File list.

• The remote file list window opens.

14 In the Remote file list window, select the following items. Ensureall other items are deselected.

• Always use the following configuration

• Default list Details

• Filesize

• Filetype

• Date

• Time

• Permissions

• Owner/Group

• Show status bar with information about (selected) file

• File double-click action Transfer

15 Click OK to close the FileZilla options window.

--End--

Saving MTBI2 module templateUse the following procedure to save your MTBI2 module template that youwill use.





.

Saving NonMTBI module template 423

Procedure Steps

Step Action


2 Browse to your MTBI2 templates folder; for example, D:\Documentum\XML Applications\ecmprod\Templates\mtbi2

3 Open the required module template:

• mtbi2_ConceptModule_multipleconcepts-Level1_template.xml

• mtbi2_ConceptUnit_no-sub-topics-Level2_template.xml

• mtbi2_ConceptUnit_with-sub-topics-Level2_template.xml

• mtbi2_ConceptItem-Level3_template.xml

• mtbi2_ConceptItem-Level4_template.xml

• mtbi2_ContentGroupingModule_template.xml

• mtbi2_ProcedureModule_template.xml

• mtbi2_ReferenceModule_template.xml

• mtbi2_TaskModule_template.xml

• mtbi2_TerminologyModule_template.xml

• mtbi2_WhatsNewModule_features_template.xml

• mtbi2_WhatsNewModule_featuredescription_template.xml

• mtbi2_WhatsNewModule_otherchanges_template.xml

• mtbi2_WhatsNewModule_changedescription_template.xml

• mtbi2_WorkflowModule_template.xml

4 Within the top-level element, click on Edit, Modify Attributes...and specify the required attributes (underlined):

• DocNumber

• ObjectName

• Title


6 Click Save.

--End--

Saving NonMTBI module templateUse the following procedure to save your NonMTBI module template thatyou will use.




.



Procedure Steps

Step Action


2 Browse to your NonMTBI templates folder; for example, .D:\Documentum\XML Applications\ecmprod\Templates\nonmtbi

3 Open the required template: module_template.xml,chapter_template.xml, appendix_template, orterminology_template.xml.

4 Within the top-level element, click on Edit, Modify Attributes...and specify the required attributes (underlined):

• DocNumber

• ObjectName

• Title


6 Click Save.

--End--

Saving NonMTBI publishable templateUse the following procedure to save your NonMTBI publishable templatethat you will use.


Procedure Steps

Step Action


2 Browse to your nonmtbi templates folder; for example, D:\Documentum\XML Applications\ecmprod\Templates\nonmtbi




.

Generating a NonMTBI PDF with reuse 425

3 Open publishable_template.xml

4 Within the nonmtbi element, click on Edit, Modify Attributes...and specify the required attributes (underlined):

• DocNumber

• ObjectName

• Title


6 Click Save.

--End--

Generating a NonMTBI PDF with reuseUse the following procedure to generate a PDF of a NonMTBI document.

Procedure Steps

Step Action

1 Right-click the publishable in Documentum and select SendTo, Folder, As document and save the document includingdescendents to a new folder on your local PC.

2 Open the XML publishable with Arbortext Editor.



5 Select the Stylesheet to use

• For PDF File use NonMTBI 5.2 PDF (e3) (…/PDFnonmtbi.xsl);

• For PDF File with Bookmarks use NonMTBI 5.2 PDFbookmarks (e3) (…/PDFnonmtbiWBM.xsl);





9 Close the XML document without saving it and then delete thefolder created in Step 2

--End--




.


Generating a NonMTBI PDF without reuseUse the following procedure to generate a PDF of a NonMTBI xml sourcefile that does not have reuse.

Procedure Steps

Step Action

1 For only NN20000-901 publishables, type spaces::remove()after the Command: prompt and then press Enter.



4 Select one of the following Stylesheets:

• NonMTBI 5.2 PDF (e3) (…/PDFnonmtbi.xsl)

• NonMTBI 5.2 PDF bookmarks (e3) (…/PDFnonmtbiWBM.xsl)




--End--

Job aidThe nonmtbi.dtd supports unlimited nesting of Sections; up to only 4levels are recommended (Chapter plus 3 levels of Sections). The PDFstylesheet provides unique formatting for up to 5 levels (Chapter plus4 levels of Sections, additional Sections are formatted the same asSection level 4). The TOC includes up to 3 levels (Chapter plus 2 levelsof Sections). In PDF, bookmarks are included for all registered Sectionswith TOC=Yes.




.

427.

Citrix information and proceduresInformation and procedures about, installing and using Citrix with theNTDA are grouped together here.

Navigation• "About Citrix" (page 427)

• "Best practices for Citrix" (page 429)

• "Installing and configuring the Citrix environment" (page 430)

• "Using Citrix" (page 437)

About CitrixThis section tells you what Citrix does, who can use it, its advantages, andits disadvantages.

Topics

• "What Citrix is" (page 427)

• "Advantage of Citrix" (page 428)

• "Disadvantages of Citrix" (page 428)

• "What Citrix looks like" (page 429)

What Citrix isCitrix is emulator software that runs on a PC or on a workstation. It letsyou:

• run an operating system that is different from the one that normallyruns on the PC or workstation

• access that operating system and run applications on it remotely fromyour PC

In the case of Citrix for NTDA, it lets:

• us run the Windows Operating System on a UNIX server workstation

• users on remote PCs access and run the following applications on theUNIX server workstation:




.

428 Citrix information and procedures

— Arbortext Editor

— Documentum DeskTop Client

— Documentum WebTop

— An FTP client to let you download and upload files from the UNIXworkstation

Advantage of CitrixCitrix is useful for users at remote sites whose connections to the UNIXworkstations that run Documentum and the DLM server are slow andunstable. It will improve check out, check in, and registration performancedramatically for these users.

When you check something out and in, your PC and Documentumexchange a large number of messages. The same applies to your PC andthe DLM server when you register a document or validate links. If you areat a remote site, network latency and retries slow down the messaging andyour check out, check in, and registration. If your connection is unstable,you also run the risk of timeouts or loss of connection.

With the Citrix environment, Citrix, Editor, Documentum, and theDLM server run on UNIX workstations that are at same site. In factDocumentum and the DLM server both run on the same UNIX workstation.Consequently, messaging is local and takes very little time. All that travelsbetween your PC and the UNIX workstation are keystrokes, mousemovements, mouse clicks, and screen updates. This uses very littlebandwidth and response is therefore very fast.

Disadvantages of CitrixHere is the downside to Citrix:

• Citrix directories are shared between users and there is a limitedamount of disk space. So:

— Delete uncessary files from your FTP folder

— Do not clutter up the Documentum\Checkout directory withPDF files, and ASV files. Clean them out when they are notneeded

• On your, PC the CPU runs Editor for one user. On Citrix, the sameCPU runs all Editor sessions for all users. Response while using Editorwill slow as more users run Editor at the same time. We estimate thepractical limit to be 5 users. We will continue to monitor performanceand we are negotiating to get a larger dedicated server for 2008.




.

Best practices for Citrix 429

What Citrix looks likeTo Launch Citrix, you double-click a Citrix ica icon on your desktop, enteryour Americase userid, and your Norpass password. A Citrix windowopens and looks like this:

The items in the Citrix main window are as follows:

• FTP is a folder into which you upload files to the server from your PC ,and download files from the server to your PC.

• Arbortext Editor launches the latest version of Arbortext Editor withthe latest customizations.

• AdobeFrameMaker 7.1 launches FrameMaker 7.1. We do not usethis for NTDA.

• documentum launches the 5.2.5 SP3 Documentum Desktop Client.

• WebTop is a link to Documentum’s WebTop client. WebTop is analternate to client that you can use to access Documentum instead ofdocumentum DeskTop Client. WebTop is a new client that we haveprovided just to overcome a problem checking in very large MTBI2documents. It should not be used for anything else because it is stillunder test.

Best practices for CitrixHere are a set of best practices for using the Citrix environment:

• Delete uncessary files from the FTP folder. This folder is sharedamong users. Keeping unnecessary files in this folder will force otherusers to scroll through your files to reach theirs and will gobble up diskspace.

• Do not clutter up the Documentum\Checkout directory with PDFfiles, and ASV files. Clean them out when they are not needed for thesame reasons as you need to delete unecessary files from the FTPfolder.

• Do not have more than 5 users using Editor simultaneously. Morethan five users will reduce performance in Editor below acceptablelevels.

• If you check out something in Citrix, work on it by running Editoronly in Citrix, then check it back in again through Citrix. Do not betempted to check out a publishable out through Citrix, FTP it to yourPC, work on it, FTP it back to Citrix, then check it in again through




.


Citrix. If you do this you will experience, check-in problems, andsubsequent check-in problems after a seemingly successful checkout..

• Use WebTop only for checking out and checking in large MTBIdocuments. Large MTBI2 documents will not check out and in againwith Desktop Client. They will with WebTop, but we have not fullytested WebTop yet, so only use it for this purpose.

• If you check out a document with WebTop then use WebTop foradding modules by reference, and for Checking in. Do not mix theuse of Desktop Client and WebTop in the same checkout.Althoughwe have not encountered any issues if you do this, PTC warns us thatdoing this will cause problems.

• WebTop does not have the ability to show locations of versionwhich shows which publishables a shared module is used in. Weare investigating a means to do this with API commands.

Installing and configuring the Citrix environmentPerform the procedures listed in Navigation to install and configure thesoftware you need to use the Citrix environment.

NavigationPerform the following tasks to install and configure your Citrix Environment

1. "Download the Citrix software and the Citrix client" (page 430).

2. "Install the Citrix software" (page 432).

Attention: You only have to install the Citrix software. You do not needto install the Citrix client. Downloading the Citrix client is sufficient to makeit available to the Citrix software.

3. "Download and Install FileZilla" (page 434).

Attention: If you have already downloaded and installed FileZilla tocompile onProduct help, you can skip this procedure.

4. "Configure FileZilla to access Citrix" (page 434).

Download the Citrix software and the Citrix clientThis procedure downloads a copy of the Citrix client software and a CitrixClient that is configured specifically for use with NTDA.




.

Installing and configuring the Citrix environment 431

There are 3 possible Citrix clients. The one you need to use depends onwhether you are a Nortel employee or a Vendor employee ,and if you area Vendor employee, whether you have transparent or proxy access to theserver. Most Vendor employees will have proxy access to the server.

Procedure Steps

Step Action

1 Access the following Web page:

http://www.citrix.com/English/SS/downloads/details.asp?dID=2755&downloadID=679581&pID=186

The Citrix Web page opens.

2 Click the Download Here link for Client Package Version 10.1.

A File Download dialog opens.

3 Click Save.



A download progress dialog opens and a ica32pkg.msi Citrix softwarefile downloads to your desktop.


http://livelink-ott.ca.nortel.com/livelink/livelink.exe?func=ll&objId=25916096&objAction=browse&sort=name&viewType=1

6 Download one of the three icon files according to your access

If you are Do the following

a Nortel employee Select the drop down menu beside theNotrtelGDE_ztcfd0nf.ica icon and chooseDOWNLOAD.

a Vendor employee and have proxy access(most frequent type of access)

Select the drop down menu beside theVendorGDE_ztcfd0nf_proxy.ica icon andchoose DOWNLOAD.

a Vendor employee and have transparentaccess (least frequent type of access)

Select the drop down menu beside theVendorGDE_ztcfd0nf_transparent.ica iconand choose DOWNLOAD.




.

http://www.citrix.com/English/SS/downloads/details.asp?dID=2755<?Pub & EntityName=amp>downloadID=679581<?Pub & EntityName=amp>pID=186

http://www.citrix.com/English/SS/downloads/details.asp?dID=2755<?Pub & EntityName=amp>downloadID=679581<?Pub & EntityName=amp>pID=186




Attention: Do not double click the GDE_ztcfd0nf.ica iconbecause this will launch Citrix and you do not want to do that.

7 Click Save.



A download progress dialog opens and the client icon softwaredownloads to your desktop.

--End--

Install the Citrix softwareThis procedure installs the Citrix software that the Citrix client needs torun.

There is no installation needed for the Citrix client. Downloading the clientmakes it available to the Citrix software and lets you log in to the server.

Procedure Steps

Step Action

1 Double-click the ica32pkg.msi file on your desktop.

An install dialog opens. Then a Select language dialog opens withEnglish as the default value.

2 Click OK to select the default of English and launch the install.

A Citrix Presentation Client Server setup window opens. It may take awhile for a Next button to appear in the window.

3 Click Next.

A license window opens.

4 Select I accept the license agreement then click Next.

A select client window opens.

5 In the Feature destination field, browse to the location whereyou want the software installed:

• D:\Program Files\Citrix

• C:\Program Files\Citrix

6 Select Citrix Presentation Server Client and expand it.




.


7 Expand Program Neighborhood Agent and select Entirefeature will be unavailable..

An X appears in front of Program Neighborhood Agent.

8 Expand Program Neighborhood and select Entire feature willbe unavailable.

An X appears in front of Program Neighborhood.

9 Click Next.

A Client name window opens.

10 Deselect Use machine name as client nametype youramericase userid in the Client name field, then click Next.

A Use Local Name and Password field opens.

11 Select No, then click Next.

An installation summary window opens.

12 Check that the contents of the window looks like this:




.


13 Click Next.

An installation progress window opens while the program is beinginstalled. When installation is completed, a Citrix Presentation ServerClient window opens.

14 Click Finish to close the install program window.

--End--

Download and Install FileZillaThis procedure downloads and installs FileZilla on your PC.

You will need FileZilla to do the following:

• FTP PDFs from the Citrix server to your PC

• FTP Neutralized XML source to your PC if you are preparing onProducthelp

If you already have FileZilla installed on your PC, you can skip thisprocedure.

Configure FileZilla to access CitrixUse this procedure to configure FileZilla so that you can FTP files betweenyour Pc and the Citrix environment running on the UNIX workstation.




.


Procedure Steps

Step Action

1 Launch FileZilla.

2 From the File menu, select Site Manager.

A file window opens.

3 Select New Site.

A New FTP Site icon appeas with the renam feature turned on.

4 Rename New FTP Site to Citrix.

5 Fill in the following fields but leave all of the rest ot the fieldsblank:

Field Value

Host ztcfd0nf.ca.nortel.com

Server type FTP

Logon type Account

User americase/<americase userid>

Account your global id or cnt number

Password your Norpass password

Figure 76Example of FileZilla setting to access Citrix




.


6 Select Advanced.

An Advanced window opens.

7 Fill in the following fields but leave all the rest at their defaultvalues.

Field Value

Default local directory Click the Browse button andset this to the directory of yourchoice. As a suggestion, set it toyour desktop.

Remote local directory Set this to <your userid>/FTP.For example, set it tothawkes/FTP.

Figure 77Example of advanced settings for Citrix

8 Click OK to close the advanced settings window.

9 In the File window select Connect.

If you have configured FileZilla for Citrix correctly, you should seesomething like this:




.

Using Citrix 437

--End--

Using CitrixThis section contains procedures for using your Citrix environment. Wehave grouped the procedures for using WebTop into a separate sectionbecause not all users need to use WebTop in the Citrix environment.

Navigation• "Launching Citrix" (page 437)

• "Downloading a file from Citrix to your PC" (page 438)

Launching CitrixUse this procedure to log in to Citrix.

Procedure Steps

Step Action

1 Double-click the GDE_ztcfd0nf.ica icon on your desktop.

A connecting to Citrix window opens, Citrix loads, the connectingto Citrix window closes, then a Warning Notice opens.

2 Click OK to confirm that you have read the warning :).

The warning window closes and a login window opens.

3 In the login window, enter your americase userid in the UserName field, your Norpass password in the Password field, donot modify the Log into field, then Click OK.

The login window closes, a progress window opens then closes, thenthe Citrix window opens.




.


--End--

Downloading a file from Citrix to your PCThis procedure downloads a file from the FTP folder in your Citrixenvironment to your PC

Prerequisites

• You must have installed FileZilla and configured it to FTP files betweenyour PC and the Citrix server.

• The file to download must be present in the Citrix environment.

Procedure Steps

Step Action

1 In the Citrix window, drag the file to be downloaded into the FTPfolder.

2 Double-click the FileZilla icon on your desktop.

3 From the File menu, select Site Manager.

The File window opens.

4 In the left panel of the File window, select Citrix.

5 Click Connect.

The FTP directory opens in the right half of the File window.

6 In the right panel, select the file to download and drag it into theleft panel..

The file downloads to your PC.

7 If you do not need the file in the FTP folder on Citrix, delete it tosave disk space.

--End--




.

439.

Webtop information and proceduresInformation and procedures for using Webtop with the NTDA are groupedtogether here.

Navigation• "About WebTop" (page 439)

• "Best Practices for Webtop" (page 440)

• "Install and configure WebTop" (page 440)

• "Using WebTop" (page 451)

• "Setting up the 5.2 WDK adapter " (page 471)

About WebTopThis section tells you what WebTop does, who can use it, its advantages,and its disadvantages.

Topics

• "What WebTop is" (page 439)

• "Advantages of WebTop" (page 440)

• "Disadvantages of WebTop" (page 440)

What WebTop isWebTop is an alternative to Documentum’s desktop client.

It is only intended to be used for large MTBI2 documents that will notcheck in with DeskTop Client.

CAUTIONDo not use WebTop for anything other than large MTBI2documents that will not check in with DeskTop Client. We havenot fully tested WebTop fully as a complete replacement forDeskTop Client..




.

440 Webtop information and procedures

Advantages of WebTopHere are the advantages of WebTop:

• WebTop has a faster response time than DeskTop Client. UnlikeDeskTop Client, the WebTop client software on your PC only dealswith keystrokes and screen refreshes. Most of the other functions areperformed on the Documentum server instead of the client PC. As aresult, there is less messaging between your PC and the Documentumserver and response is faster.

• WebTop includes a structured view that lets you quickly findout what components and their versions make up a publishable.Unlike DeskTop Client, you do not have to launch a special VirtualDocument Manager tool to see the document structure. Browsing thestructure is therefore much faster.

• WebTop does not crash when you use the locations of version tofind the parent documents that an object is used in. DocumentumDesktop Client often crashes when you attempt to do a locations ofversion in a virtual document that is many objects deep.

• WebTop does not crash if you attempt to change permissions onan object. Desktop Client often crashes when you attempt to changepermissions on a object.

Disadvantages of WebTopHere is the downside to WebTop:

• You can only display 100 objects (publishables or modules) on apage in WebTop. This means you have to do a lot of paging to get toa publishable or module you want to check out. You can compensateby creating bookmarks to the publishables and modules you work onfrequently.

Best Practices for WebtopHere are a set of best practices for using WebTop:

• If you check out something in WebTop, check it back in again withWebTop.

• Use WebTop only for checking out and checking in documentsthat will not checkout with DeskTop Client. Large MTBI2 documentswill not check out and in again with Desktop Client. They will withWebTop, but we have not fully tested WebTop yet, so only use it forthis purpose not as the wholesale replacement for DeskTop Client.

Install and configure WebTopBefore you can use WebTop, you need to install and configure it.




.

Install and configure WebTop 441

Flowchart for installing and configuring WebTopUse the flowchart called "Flowchart for installing and configuring WebTop"(page 441) to determine the procedures you need to perform to install andconfigure WebTop.

Figure 78Tasks for installing and configuring WebTop




.


TopicsIf you are going to use WebTop within a Citrix environment perform thefollowing procedures:

1. "Launch WebTop from Citrix" (page 442)

2. "Configure WebTop" (page 448)

If you are going to use WebTop outside a Citrix environment, perform thefollowing procedures:

1. "Remove any existing java files from the Documentum shared directoryon your PC" (page 443)

2. "Clean up Internet cache files" (page 443)

3. "Install a Java Runtime Environment" (page 446)

4. "Verify the Java Runtime Environment Installation" (page 447)

5. "Launch WebTop from Windows" (page 448)

6. "Configure WebTop" (page 448)

Launch WebTop from CitrixUse this procedure to launch WebTop from within a Citrix environment.If you are not working within a Citrix environment, see instead "LaunchWebTop from Windows" (page 448).

PrerequisitesYou must have already installed the Citrix environment. See the CitrixProcesses and Procedures Guide for the instructions to install andconfigure Citrix.

Procedure Steps

Step Action

1 Log in to Citrix.

2 Click the WebTop Icon

Internet Explorer launches and displays a WebTop Login window.

3 Enter your global id in the Login name field, your Norpasspassword in the Password field, select ecmprod in theRepository field, and click Log in to log into Docmentum throughWebTop.

A WebTop window opens.

--End--




.


Remove any existing java files from the Documentum shared directoryon your PC

Use this procedure to clean up any existing Java files associated with yourDocumentum environment on your PC. You may not actually have any, butyou need to check. At the end of this procedure, you will have removedany Java files.

Attention: You do not need to perform this procedure if you are going touse WebTop in a Citrix environment.

Procedure Steps

Step Action

1 Navigate to the following folder

D:/profiles<your userid>/Documentum/ucf/<computername>/shared

Example:

D:/profiles/thawkes/Documentum/ucf/THAWKES-3/shared/

Here is an example of what you might see in the shared folder:

2 If there are any jre zip files in the shared folder remove them.

3 If there are any jre folders in shared folder remove them.

Once you are done, your shared folder should look like this:

--End--

Clean up Internet cache filesAt the end of this procedure, you will have removed all Internet cache filesfrom this PC that might interfere with the operation of WebTop.




.


Attention: This procedure uses the disk cleanup facility of the operatingsystem and disk cleanup is slow. It took 15 minutes to run disk cleanup onmy PC.


Procedure Steps

Step Action

1 On the desktop, double-click the My Computer icon.

A window opens that lists all of the drives on your PC.

2 Select the C drive, press the right mouse button to open apop-up menu, and choose Properties.

A properties window opens.

3 In the Properties window, select the General tab.

4 In the General tab, select Disk Clean Up.




.


A disk cleanup progress window opens while the operating systemdetermines which files to clean up. Determining which files to clean uptakes 15 minutes or more. When the operating system has determinedthe files to clean up, it opens a Disk Cleanup window that displays thefiles to clean up.

5 Click OK in the Properties window to close it.

6 When the Disk Cleanup window opens make the followingselections:

Item Selected or deselected

Recycle Bin Deselected.

Temporary OfflineFiles

Selected

Offline files Selected

Compress old files Selected

Catalog files for theContent Indexer

Deselected

7 Click OK.

The Disk Cleanup window closes and a new window opens that asksyou if you want do delete the files.

8 Click Yes to confirm that you want to delete files.




.


The system opens a progress window while it deletes the files.

--End--

Install a Java Runtime EnvironmentAt the end of this procedure, you will have installed a java runtimeenvironment on your PC and this will allow WebTop to work properly.


Procedure Steps

Step Action

1 Launch a Web browser and access the following page:

http://www.java.com/en/download/manual.jsp

A Java Downloads for all Operating Systems page opens.

2 Select: Windows XP/Vista/200/2003 Offline.

A File Download window opens.

3 In the File Download window, click Save.

A window opens in which you can choose the destination of the javasoftware.

4 Navigate to your desktop and select Save.

The Java software downloads to the desktop of your PC.

5 On your desktop, double-click the Java icon labelledjre-6u3-windows-i586-p-s.exe.




.

http://www.java.com/en/download/manual.jsp


A windows installer window opens momentarily followed by a Welcometo Java banner page.

6 In the Welcome to Java page, click Accept.

A Java Setup Google window opens.

7 In the Java Setup Google window, deselect Google Toolbar ForInternet Explorer, then click Next.

A progress window opens while the operating system installs Java.When the operating system finishes installing Java it opens a finishedinstallation window.

8 Click Finish.

--End--

Verify the Java Runtime Environment InstallationPerform this procedure to ensure that your web browser is making use ofthe new Java Runtime environment that you installed.


Procedure Steps

Step Action

1 If Internet Explorer is open, close it.

2 Launch Internet Explorer.

Internet Explorer opens.

3 In the Internet Explorer window, open the Tools menu. Thereshould be a new item called Sun Java Console.

4 From the Tools menu, select Internet Options

An Internet Options window opens.

5 Select the Advanced tab.

6 In the Advanced tab, make sure that the following is selected:

Java Sun Use JRE1.6.0_0.3 for <applet> (requiresrestart)

7 Click OK to close the Internet Options window.

--End--




.


Launch WebTop from WindowsUse this procedures to launch WebTop from your PC (You are not in aCitrix environment)


Procedure Steps

Step Action

1 Open Internet Explorer, type the following URL into the addressfield of your browser, then click Go.

http://ztcfv0n9.ca.nortel.com:8080/webtop/component/main?__dmfClientId=1191954785460

A login window opens


If this is the first time, you are accessing ecmprod throughWebTop, a window may open asking you to confirm that this is atrusted site. If you get this window, enter yes to confirm. Then aWebTop window opens.

If this is not the first time that you are accessing ecmprodthrough WebTop, a WebTop window opens

3 Add this site to your favorites.

--End--

Configure WebTopThis procedure configures the WebTop interface. WebTop is an alternateinterface to DeskTop client for doing things with Documentum. Only useit for checking out and checking in large MTBI2 documents until furthernotice. It is not a fully tested interface.

Procedure Steps

Step Action

1 Double-click the Citrix .ica icon on your desktop. It will be one of:




.




• NortelGDE_ztcfd0nf.ica

• VendorGDE_ztcfd0nf_proxy.ica

• VendorGDE_ztcfd0nf_transparent.ica

A connecting to Citrix window opens, Citrix loads, the connecting toCitrix window closes, then a Warning Notice opens.

2 Click OK to confirm that you have read the warning. :)

The warning window closes and a login window opens.

3 In the login window, enter your americase userid in the UserName field, your Norpass password in the Password field, donot modify the Log into field, then Click OK.

The login window closes, a progress window opens then closes, thenthe Citrix window opens.

4 Double-click the WebTop link.

Internet Explorer launches and displays a WebTop Login window.



6 In the WebTop window, set the interace type to Streamline, setthe number of items to display to 100, then click Preferences.

A preferences window opens.

7 Select the General tab.

8 In the General tab, select the following and leave the rest at theirdefault values:




.


Item Value

WebTop ApplicationType

Streamline

Section to start in Cabinets

Drag and Drop selected

9 Click the Columns tab.

10 In the Columns tab, there are two columns: one titled Classicand the other titled StreamLine. You only need to work in theStreamline column.

In the Streamline column, find the row labelled Cabinets.

11 Click the link labelled Edit

A preferences window opens.

12 In the preferences window add and remove attributes until youhave the following items displayed:

13 Click OK to close the preferences window.




.

Using WebTop 451

14 Set the same preferences for the following items in the displaypreferences:

• Streamline: Categories

• Streamline: Home cabinet

• Streamline: Virtual documents

• Streamline: Search results

15 Select Search tab.

16 in the Search tab, select Current repository only.

17 Click OK to close the preference dialog. Your preferences will beremembered the next time you log in.

18 Click Logout to exit WebTop.

--End--

Using WebTopThis section contains a set of procedures for using the WebTop interfaceto Documentum. Please only use WebTop to check in an check out largedocuments that will not check in with DeskTop Client. Do not use it foranything else because it is not fully tested yet.

Prerequisites• You must have installed and configured WebTop.

NavigationYou can perform the following procedures with WebTop. With theexception of the first procedure, Launching WebTop, all of the proceduresare listed in alphabetical order.

• "Launching WebTop" (page 452)

• "Changing permissions on an object with WebTop" (page 452)

• "Checking in a publishable, chapter, or module with WebTop" (page455)

• "Checking out a chapter or module that is not part of a publishable withWebTop" (page 457)

• "Checking out a chapter or module that is part of a publishable withWebTop" (page 458)

• "Checking out a publishable with WebTop" (page 459)

• "Creating and using a shortcut in WebTop" (page 460)

• "Exporting a document with WebTop" (page 461)




.


• "Finding out where a chapter or module is used with WebTop" (page462)

• "Importing a chapter or module into an XML document by referencewith WebTop" (page 464)

• "Importing a new MTBI2 module with WebTop" (page 466)

• "Importing a new MTBI2 publishable with WebTop" (page 467)

• "Importing a new nonmtbi2 module with WebTop" (page 467)

• "Importing a nonmtbi2 publishable with WebTop" (page 468)

• "Performing a search with WebTop" (page 468)

• "Updating a graphic with WebTop" (page 471)

Launching WebTopUse this procedure to log in to Documentum using WebTop.

Prerequisites

• You must have configured WebTop.

Procedure Steps

Step Action

1 If you are launching WebTop from within Citrix log in to Citrix andDouble-click the WebTop icon.

If you are not using Citrix, launch Intenet Explorer, then accessthe following link:


Hint: Please bookmark this link.

Internet Explorer launches a displays a WebTop Login window.

2 Enter your global id in the Login name field, you Norpasspassword in the Password field, select ecmprod in theRepository field, then click Log in to log into Docmentumthrough WebTop.


--End--

Changing permissions on an object with WebTopUse this procedure to change the permissions on a single object using theWebTop interface so that only a particular user can write to it.




.



Using WebTop 453

Before using this procedure, consider using the group-security file-lockingfeature.

Prerequisites

• You must have launched WebTop

Procedure Steps

Step Action

1 Navigate to the object (Chapter, publishable, module, graphic)whose permissions you want to change.

2 Ensure that there is not a key or padlock symbol ahead of theobject whose permissions you want to change. If there is, theobject is locked and you cannot change the permissions on it.

3 Click the information symbol to the right of the object name.

A properties info window opens.

4 Select the Permissions tab.

The permissions tab opens.

5 In the Permissions tab, scroll down until you reach thePermissions for users and groups table.

6 Set the items per page to 100.

7 Click [Add].

A choose user/group window opens.




.


8 In the choose user/group window, select Show Users:

9 Scroll down until you find a user that you want to add to this list.

10 Select the name of the user you want to add, then click the rightarrow to add the user. in the following sample, user TerenceHawkes was added.

11 Click OK.

The choose user/group window closes and a set access permissionswindow opens in which you can set the permissions for the user youjust added.

12 In the Basic Permissions field choose Delete if you want theuser to have read-write and delete permissions.

13 You do not need to modify the extended permissions.

14 Click OK to close the choose user/group permissions windowand reopen the properties permissions window. The new userand the permissions for the user now appear in the window.




.

Using WebTop 455

15 Select authors then click Edit

A set access permissions window opens.

16 In the set access permissions window, select Read (includesbrowse).

17 Click OK to close the window and re-ope the properties/permissions window.

The properties/permssions window opens and show that members ofthe authors group now only have read permission.

18 Do not modify permissions on dm_owner, admingroup.profileadmins. xmladmins, or dm_world.

19 If you need to reset the permissions back to the default later,open the permissions tab, click Select in the Permission setname field

• Select the object again.

• Click the information (i) icon.

• Open the permissions tab.

• Click Select in the Permission set name field.

• Type au in place of [show all] and click Go.

• Select AuthorACL

• Click OK.

The permssions are now reset back to the defaults.

--End--

Checking in a publishable, chapter, or module with WebTopUse this procedure to check in a previously checked out publishable,chapter, or module with WebTop.




.


Procedure Steps

Step Action

1 Save the publishable chapter, or module in Editor then closeEditor.

2 In WebTop, navigate to the location of the checked-outpublshable, chapter or module.

3 Click Check-in to the right of the chapter, publishable, or moduleto be checked in.

A check-in options dialog opens.

4 Select:

• minor version if what you are checking in is for the samerelease

• major version if what you are checking in is for a newrelease

5 Click OK.




.

Using WebTop 457

A progress bar opens and the publishable, chapter, or module checksin to Documentum. When check-in is complete WebTop updates areremoves the key symbol to indicate that the item is no longer checkedout.

--End--

Checking out a chapter or module that is not part of a publishable withWebTop

Use this procedure to check out a chapter or module in a publishable usingDocumentum’s WebTop interface when the chapter or module is not partof any publishable.

If the chapter or module is part of a publishable, see instead: "Checkingout a chapter or module that is part of a publishable with WebTop" (page458)

Procedure Steps

Step Action

1 Double click the name of the cabinet, the Modules folder, thennavigate to the folder that contains the chapter or module youwant to check out.

2 Scroll down until you reach the chapter or module you want tocheck out.

3 Select Edit to the right of the Chapter or module you want tocheck out.

An Editor dialog opens

4 Select what you want to check out:




.


Click OK.

A progress window opens while the Chapter or Module checks out.

When the checkout is complete, Editor opens and displays thecontents of the Chapter or Module . A lock symbol appears beside thepublishable in WebTop.

--End--

Checking out a chapter or module that is part of a publishable withWebTop

Use this procedure to check out a chapter or module in a publishable usingDocumentum’s WebTop interface when the chapter or module is part of apublishable.

If the chapter or module is on its own and not part of a publishable, seeinstead "Checking out a chapter or module that is not part of a publishablewith WebTop" (page 457)

Procedure Steps

Step Action

1 Double click the name of the cabinet , the Publishables folder,then navigate to the publishable that contains the chapter ormodule you want to check out.

2 Select the name of the publishable that contains the chapter ormodule.

A page opens that lists the versions of the chapters and modules thatmake up the publishable you selected.

3 Scroll down until you reach the chapter or module you want tocheck out.

4 Select Edit to the right of the Chapter or module you want tocheck out.




.

Using WebTop 459


5 Select what you want to check out:

Click OK.

A progress window opens while the Chapter or Module checks out.

When the checkout is complete, Editor opens and displays thecontents of the Chapter or Module . A lock symbol appears beside thepublishable in WebTop.

--End--

Checking out a publishable with WebTopAt the end of this procedure, you will have checked out a publishable withor without descendents.

PrerequisitesYou are logged in to Documentum through WebTop.

Procedure Steps

Step Action

1 In the Streamline window couble click the name of the cabinet, then the Publishables folder

2 Scroll down the list of publishables until you reach the oneyou wish to check out. If there is more than one page ofpublishables, you may need to click Next page.

Hint: If you are going to work on this publishable again in thefuture, bookmark of the page that has this publishable.




.


3 Select Edit.


4 Select what you want to check out

Click OK.

A progress window opens while the publishable checks out.

When the checkout is complete, Editor opens and display the contentsof the publishable. A lock symbol appears beside the publishable inWebTop.

--End--

Creating and using a shortcut in WebTopFed up with scrolling through screens of information to get at a documentyou edit often? Use this procedure to create a shortcut on your desktop.When you click this shortcut, WebTop opens and lets you view, or checkout and edit the document.

PrerequisitesYou must have already Installed and configured WebTop to use theStreamlined interface and activate the drag and drop option.




.

Using WebTop 461

Procedure Steps

Step Action

1 Launch WebTop.

2 Navigate to the document you want to create a shortcut for.

3 Select the information icon to the right of the document.

A properties window opens.

4 Drag the funny little green icon to your destop.

A shortcut appears on your desktop.

5 Rename the shortcut to the name of the document to which youcreated the shortcut.

Clicking the shortcut launches WebTop if it is not alreadylaunched and opens a page in which you can View or Edit(check out and edit) the document.

--End--

Exporting a document with WebTopUse this procedure to export a snapshot of an XML document fromDocumentum.

Procedure Steps

Step Action

1 Create a folder on your PC to contain the document to beexported.

2 Launch WebTop/




.


3 Navigate to the XML document you want to export.

4 On the line that contains information about the document, selectMore->File->Export.

5 Click OK.

A select folder window opens.

6 Navigate the new new folder you created and select OK.

An export winfow opens.

7 In the Export window, select Download descendents, then clickOK.

A progress bar opens while the document and its descendentsdownload to the folder you created on your PC.

--End--

Finding out where a chapter or module is used with WebTopUse this procedure to find out where a chapter or module is used.It can be used in a publishable or a chapter (nonmtbi2), or anothermodule (mtbi2). Performing this procedure with WebTop is equivalent toperforming a locations of version in DeskTop Client.

PrerequisitesYou must have launched WebTop.




.

Using WebTop 463

Procedure Steps

Step Action

1 Navigate to the chapter or module you need to find outinformation about..

2 Click the More...item the right of the chapter or module.

A pop-up menu opens.

3 In the pop-up menu, select View->Locations.

A window opens that shows what publishables or chapters the moduleis used in and the location of the module in Documentum.

Here is an example of where a module is used:

--End--




.


Importing a chapter or module into an XML document by referencewith WebTop

Use this procedure to import a chapter or module into an XML documentby reference using the Documentum document browser.

It does not matter whether you are using WebTop or DocumentumDeskTop Client, this procedure uses the Documentum document browserthat is integrated with Editor.

Here is a list of what you can import by reference, according to the DTDand the XML document:

DTD XML document What you can import into it byreference

nonmtbi2 Publishable Chapter

Chapter Module

MTBI2 Publishable WhatsNewModule

ConceptModule

ContentGroupingModule

ProcedureModule

ReferenceModule

TaskModule

WorFlowModule

ReferenceModule ReferenceUnit

ProcedureModule ProcedureUnit

Note: You can also nest modules inside one another. For example, you cannest a ProcedureModule within a ContentGroupingModule.

Prerequisites

• The chapter or module to be imported by reference must already existin Documentum.

• The chapter or module to be imported by reference must also bechecked in.

• The XML document into which you are going to import the chapter ormodule must be checked out on your PC and open in Editor.

• You must have selected the Documentum WDK adapter when youinstalled Editor. If you have followed the installation procedurescorrectly, you will have installed this adapter.




.

Using WebTop 465

Procedure Steps

Step Action

1 Open the XML document into which you want to import thechapter or module in Editor.

2 If you are working in an MTBI2 document create an mtbitopicrefelement.

If you are working in nonmtbi2 document, place the cursorimmediately after the previous chapter or module element.

3 From the Documentum menu in Editor, select Browse.

The Documentum document browser opens.

4 In the Documentum browser, navigate to the chapter or moduleyou want to import.

5 In the Documentum browser, select the chapter or module toimport, press the right mouse button to open a popup menu andselect Copy.

6 In Editor, place your cursor in the empty mtbitopicref element ifyou are working in the.MTBI2 DTD or after the previous chapteror module element, if you are working in the nonmtbi2 DTD.

7 Press the right mouse button, to open a popup menu, and selectPaste.

8 In the dialog, select Reference.




.


CAUTIONDo not select DuplicateIf you select Duplicate you will create a duplicate ofthe module you are importing by reference when youcheck the parent XML document back in.

The contents of the imported document appears in Editor.

--End--

Importing a new MTBI2 module with WebTopUse this procedure to create a new MTBI2 module and import it intoDocumentum with WebTop.

PrerequisitesYou must have done the following:

• checked out at least one MTBI2 publishable to ensure that the XMLapplications directory on your PC has a copy of the MTBI2 DTD

• exported a copy of the GDE-templates.zip file from ecmprod\templates\NTDA, unzipped it, and move a copy of the Templates folder inside itinto Documentum\XML Applications\ecmprod on your PC.

Procedure Steps

Step Action

1 Within the ecmprod\Templates\]mtbi2 folder, open the requiredtemplate with Editor.

2 From the File menu, select Save As.

A Save As dialog opens.

3 In the dialog, specify the location of the file, and the new filename. Make sure you follow the NTDA naming conventions fornew modules.

4 Open the new file you just created with the Save As operation inEditor.

5 Place the cursor just after the starting tag of the module element,select Edit, Modify attributes.

An attributes window opens.




.

Using WebTop 467

6 Specify the following in the attributes window:

Attribute name What to type

ObjectName name of the file. This name must match thefile naming conventions

DocNumber the publication number or the componentname. The DocNumber sets the name ofthe folder in ecmprod\modules where themodule will be stored.

Title The heading of the module. You must typeexactly the same string that you enter in theHeading element of the module.

InfoCategory Select a category that best describesthe type of information that will be in themodule.

InfoType Select the type of information that bestdescribes what the module contains.

7 Click OK to accept the values and close the attributes window.

8 Add content to the module (but no links yet), by placing thecursor where you want to add the content, pressing Enter,choosing the tag, then type in the content inside the tag.

CAUTIONDo not use single quotes, double-quotes, em dashes,en dashes,

--End--

Importing a new MTBI2 publishable with WebTopUse this procedure to import a new MTBI2 publishable into Documentumusing the WebTop interface.

Procedure Steps

Step Action

1 To be supplied

--End--

Importing a new nonmtbi2 module with WebTopUse this procedure to create a new nonmtbi2 module and import it intoDocumentum using the WebTop interface.




.


Procedure Steps

Step Action

1 To be supplied

--End--

Importing a nonmtbi2 publishable with WebTopUse this procedure to create a new nonmtbi2 publishable and import it intoDocumentum using the WebTop interface.

Procedure Steps

Step Action

1 To be supplied.

--End--

Performing a search with WebTopThis procedure provides you the general principles of performing a searchin WebTop and saving your search. We cannot show you all of thepossible options in this procedure.

Hints for performing a search

• Always click the Advanced search button as described in thisprocedure. The simple search in which you enter the string to searchon in the Search field has such a wide scope that it takes a very longtime to get results, thereby making it virtually useless.

• When setting up the folders to search, the default is ecmprod. Narrowdown the search to folders inside ecmprod to shorten the search time.

• Save common searches such as finding out all of the items locked byyourself.

• Using the search function is a bit like searching the intenet. It takespractice to get good at searching

• The Contains field in the advanced search window is used to search forstrings in all files in ecmprod. I recommend that you do not do this kindof search because it takes an unacceptably long time.

Procedure Steps

Step Action

1 Launch WebTop




.

Using WebTop 469

2 Log in to ecmprod.

3 Click the Advanced button.

An advanced search window opens.

4 Leave the Contains field empty.

You could enter a string here that Documentum would searchfor in all files of ecmprod. But ecmprod is so large any searchcriteria entered here will result in a very long search, whichrenders the search useless.

5 Click Edit beside the Locations field to open a window in whichyou can narrow your search. The narrower the search theshorter time the search will take.

6 In the Object Type field, select:

• Document (dm_document) if you want to search amongpublishables, chapters, modules, and graphics. Choosing thisobject type finds all of them.

• Document (ks_publishable) if you only want to searchamong publishables.

• Document (ks-module) if you want to search amongmodules, chapters, and graphics.

7 In the Properties field you can select a large number of attributes- only a few of which are useful. What is available in the otherfields changes according to what you select in the first field.

Here are the useful attributes, ignore the rest:




.


Name Description

ACL name name of the permissions set applied to theobject. For now, all authors have the samepermission set (ACL) so all files created byauthors have a permission set of AuthorACL.

Creator name Name of the person who first imported the fileinto Documentum. Note: This is not the sameas the owner. See the defintiion for owner.

Format The file format: Frame, png, pdf and so on...

Lock owner Name of the user who has the file locked, if thefile is checked out.

Modified by Name of the user who last modified the file.

Name The file name, folder name, or cabinet name.

Owner Name of the user who has permission to deletea folder, chapter, module, or graphic. By defaultthe person who created it is the owner, but itdoes not have to be. Someone other than thecreator can become the owner.

Title The title that you entered into the Title attributein XML for a Publishable, Chapter, or any typeof Module.

Type ks module, ks-publishable

Version label As in 1.0 CURRENT

8 If you want to add another criterium for your search click Addproperty .

An additional line of property fields appears in a line below the first lineof property fields. the additional line is preceded by the words AND orOR.

• AND to appears in the search results, and object must meetthe properties in this line of properties and all previous linesof properties

• OR means that this line of properties or any of the previouslines of properties will produce output in the search results

9 Select AND or OR then select the new properites

AND To appear in the search results, an object must meetthe properties in this line of properties and in allprevious lines of properties.

OR To appear in the search results, an object only needsto meet the properties in this line of properties orthe properties in any one of the previous lines ofproperties.




.

Setting up the 5.2 WDK adapter 471

10 Leave the date and size fields at their default values. They arenot useful.

11 Select Find hidden object and Find all versions.

12 Click OK to begin the search.

A new window opens with the search results.

13 If you want to save the search criteria for future use, select SaveSearch.

--End--

Updating a graphic with WebTopUse this procedure to update a an existing graphic in Documentum usingthe WebTop interface.

Procedure Steps

Step Action

1 To be supplied

--End--

Setting up the 5.2 WDK adapterThe following procedure shows how to set the 5.2 WDK adapter.

Procedure Steps

Step Action

1 Exit from all Arbortext Editor sessions.



Environment Variables dialog box displays.


5 For Variable Name, type APTDMSERVERURL.

6 For Variable Value, type http://ztcfv0n9.ca.nortel.com:9080/epic-webtop/ and click OK.




.


7 Click OK in the System Properties window.

8 Open Internet Explorer and select Tools, Internet Options.

9 Click Security.

10 Click Trusted sites, Sites and type http://ztcfv0n9.ca.nortel.com.

11 Ensure that Require server verification (https:) for all sites in thiszone is not checked and then click OK.

12 Click Custom Level and scroll to the ActiveX controls andplug-ins list of options. Ensure that each option is set to Enable.

13 Click OK to accept the new settings.

14 Click Advanced and select Enable third party browserextensions (requires restart).

15 Click OK to exit the Internet Options window and Restart yourPC.

16 Select Start, Run and enter the following commands:

• regsvr “Editor 5.2 install path \adapters\wdkEpicAdapter.dll”

• regsvr “Editor 5.2 install path \adapters\DctmWDKocx.dll”

• regsvr “Editor 5.2 install path \adapters\DctmWDKocx.ocx”

17 Verify that the XML file type is associated with Arbortext Editorby selecting Tools, Folder Options.

Attention: The WDK adapter requires that both the default andopen actions are associated with Arbortext Editor.

--End--




.

NTDA

NTDA Processes and ProceduresCopyright © 2006-2008 Nortel NetworksAll Rights Reserved.

Printed in CanadaRelease: 02.00Publication: KS-NTDA-020Document revision: 02.10Document release date: 31 October 2008

Send all feedback on NTDA Processes and Procedures (October 31, 2008 HTML version) to Malcolm Graham,[email protected]

To provide feedback or to report a problem in this document, go to www.nortel.com/documentfeedback.

www.nortel.com

All rights reserved.

.