xmetal dita workshop
DESCRIPTION
Slides from DocTrain East 2008 Workshop: Introduction to XMetaL and DITA.TRANSCRIPT
![Page 1: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/1.jpg)
Introduction to DITA and XMetaL
Simon BateScriptorium Publishing Services
![Page 2: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/2.jpg)
Course Agenda
Overview of XMetaLElements and structured authoringGenerating output AttributesImagesTablesWriting topics
Sections and nested topicsCross-referencesMetadata and indexesTrack changesDITA mapsReusing content
![Page 3: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/3.jpg)
Course purpose
Learn how to author content using XMetaL Author Enterprise EditionUnderstand DITAPut theory into practice, learn by doing
![Page 4: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/4.jpg)
About DITA
Darwin Information Typing ArchitectureCreated at IBMNow developed and maintained by OASISStandard XML language
Cost-effective way to create, publish, reuse, and exchange structured content
![Page 5: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/5.jpg)
Role of DITA Tools
An authoring tool is a user interface for creating DITA content
![Page 6: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/6.jpg)
DITA documentation
DITA Language ReferencePurpose and content model for each elementHelp > DITA Specifications > DITA Language Reference
DITA Architectural SpecificationDescribes overall behavior of DITAVery technicalHelp > DITA Specifications > DITA Architectural Specification
![Page 7: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/7.jpg)
Overview of XMetaL
![Page 8: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/8.jpg)
XMetaL Author
Standard word-processing environmentMultiple undo (and redo)Spell checking & thesaurusChange tracking
Create and edit textFamiliar editing features to create content
![Page 9: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/9.jpg)
XMetaL Author Interface: OverviewMenu
Structure View
Tool bar
Document Pane
View Mode buttons
Element List
![Page 10: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/10.jpg)
Inserting symbols and special characters
Insert > Symbols
Insert > Special Characters
Or click View > Toolbars, Then toggle appropriate checkboxes
![Page 11: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/11.jpg)
Typographical elements
BoldItalicUnderline
![Page 12: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/12.jpg)
View modes
Four view modes for the document pane:NormalPage PreviewTags OnPlain Text
Controls in bottom left corner of the pane: Indicate the current viewSwitch between views
![Page 13: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/13.jpg)
Normal view
Shows content No XML element tagsIndicated by this icon: Use most of the time when writing content
![Page 14: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/14.jpg)
Tags On view
Shows content Shows XML element tagsIndicated by this icon: Allows precise insertionAllows tag deletion/unwrappingClick box to expand/collapse:Tip: CTRL+SHIFT toggles Tags On & Normal
![Page 15: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/15.jpg)
Plain Text view
Edit all XML markup and contentIndicated by this icon: Does not check validityCan create invalid XML
![Page 16: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/16.jpg)
Page Preview view
Shows a formatted preview Indicated by this icon: Verify the content is formatted correctlyXML document transformedOpens in browser or Acrobat
![Page 17: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/17.jpg)
Tip:
Can�t see the menus?Open a DITA document
Want to see the structure view?View > Structure View
![Page 18: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/18.jpg)
Workbook Exercise:Basic File Operations
![Page 19: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/19.jpg)
Options for saving and opening files
Click Tools > Options
To use default toolbars, press CTRL on startup
![Page 20: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/20.jpg)
File and folder naming
Be systematic and carefulNo spacesNo special characters
![Page 21: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/21.jpg)
Elements and Structured Authoring
![Page 22: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/22.jpg)
Elements: Key terms
Element Element type (or name)Element contentsStart tagEnd tagAttribute
![Page 23: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/23.jpg)
Structure and validity
XML must be:Well-formedValid
DITA content model defines validityHow to order elements Hierarchy of element typesAttributes
![Page 24: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/24.jpg)
Validating documents
Click Tools > ValidateErrors most common in converted legacy documentsFix �missing required element� problems first
![Page 25: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/25.jpg)
Structure and "Smart Insert"
When pasting XMetaL content:XMetaL inserts content at closest valid locationMay be far from the insertion pointMay not be pasted at all
When pasting Word or HTML content:XMetaL uses DITA elementsClosest match to paste and locationBest advice: watch when pasting
![Page 26: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/26.jpg)
Identifying the current element
See context bar (at bottom of screen)Also shows ancestors' hierarchyBased on:
Cursor locationCurrently selected element
Here's a <li> within a <ul> within a <section>�
![Page 27: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/27.jpg)
Be aware of what is selected
Identifying the current element
![Page 28: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/28.jpg)
ENTER key
XMetaL inserts the most logical next element Often the same type as the current one
![Page 29: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/29.jpg)
Insert menu
Allows you to insert elementsShows most available elementsContext free�Smart Insert�
Inserts an element in the next valid locationSometimes asks if you want to split the current element � usually this is what you want
![Page 30: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/30.jpg)
Element List
View > Element ListLists available valid elementsDepends on cursor location
Insert newChange selected
![Page 31: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/31.jpg)
Paragraph menu
Change paragraphs to notes and long quotationsSpecify note types:
dangertip
Apply and remove bullets and numbering
![Page 32: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/32.jpg)
Format markup vs. Semantic markup
Separation of content from formatting
Format markup: how something should lookSemantic markup: what something means
Examples:<b> vs. <uicontrol><li> vs. <step>
![Page 33: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/33.jpg)
Inserting domain elements
Domain elements cross topic typesInsert > * Element menus
ProgrammingSoftwareUser InterfaceUtilitiesOther
![Page 34: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/34.jpg)
Domains in Element List
Domain elements are listed in Element ListTools > DITA Options Only affects the Element List
Not the Insert menu
![Page 35: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/35.jpg)
Modifying elements
Change element typeRadio button in Insert element list
Expand and collapse content displaysDelete elements
![Page 36: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/36.jpg)
Deleting elements
Easiest on Tags On view
To "unwrap" an element (leave content):Click just after the start tag, then press Backspace
To delete the element and content:Click a tag to select the entire element, then press Delete or Backspace
![Page 37: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/37.jpg)
Workbook Exercise:Working with Elements
![Page 38: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/38.jpg)
Generating Output (Publishing)
![Page 39: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/39.jpg)
DITA Open Toolkit
Open-source application for publishing DITA content to multiple output formats
Integrated with XMetaL
Help > Third-Party Components > DITA Open Toolkit User Guide
![Page 40: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/40.jpg)
Publishing formats
XHTMLPDFCHMRTFEclipse HelpJavaHelp
![Page 41: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/41.jpg)
PDF options
XMetaL Enhanced PDFBest all-purpose PDF deliverable type
XMetaL Enhanced PDF via Acrobat DistillerUse if your documents have EPS graphics
![Page 42: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/42.jpg)
Generating output
File > Generate Output for DITA Topic
Troubleshooting:File > View Output Log
![Page 43: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/43.jpg)
Workbook Exercise:Generating Output
![Page 44: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/44.jpg)
Attributes
![Page 45: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/45.jpg)
Purpose of attributes
Provide additional informationwidth = �250 px�
Point to a file or URLhref = �http://www.microsoft.com�href = �images/red_button.gif�
Identify an elementid = �p_73412763�
Conditionalize an elementplatform = �macintosh�
![Page 46: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/46.jpg)
Attribute Inspector
Click View > Attribute InspectorAllows you to examine and change values of XML attributesCursor position is important
![Page 47: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/47.jpg)
Working with attributes
XMetaL creates element IDs automaticallySome dialog boxes set attributes
Insert ImageSet Conditional Text
Use Attribute Inspector
![Page 48: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/48.jpg)
Attribute tooltips
Tip: Hover over a tag in Tags On view to see attributes
![Page 49: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/49.jpg)
Workbook Exercise:Attributes
![Page 50: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/50.jpg)
Images
![Page 51: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/51.jpg)
Supported image formats
PNG, GIF, JPEGSVG (if an appropriate plug-in is installed)EPS
displays in XMetaL if preview information is available in the filerequires Acrobat Distiller to produce optimal PDF output
TIF, other formatsmay not display in all output formats
![Page 52: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/52.jpg)
Working with images
Inserting imagesInsert > Image
Insert an image with a titleInsert > Figure with Title
Add a title to an existing imageSelect Image and wrap in figInsert > Other Element > Title
Modify the properties of an existing image
![Page 53: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/53.jpg)
Image sizing
Do one of the following:Best-supported: Resize the image using a graphics editorSpecify �width� in pixels, inches, cm, etc.Specify �height�Least-supported: Specify �scale� by a percentage
![Page 54: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/54.jpg)
Workbook Exercise:Images
![Page 55: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/55.jpg)
Tables
![Page 56: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/56.jpg)
Tables
Click Table > Insert TableChoose type:
Normal table = table with titleSimple table = informal table (no title)Step choices (task topics only) Properties (reference topics only)
Specify rows and columnsSpecify header or not
![Page 57: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/57.jpg)
Header rows
To make the first row of a table a header row:Click Table > Insert Table
Add later with Table > Table Properties
![Page 58: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/58.jpg)
Working with table properties
Tip: Click in a row to change the properties of that row. Don�t select the whole row.
![Page 59: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/59.jpg)
Workbook Exercise:Tables
![Page 60: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/60.jpg)
Writing topics
![Page 61: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/61.jpg)
Topics
A Topic is a DITA unit of informationHas a title, short description, and content All topics have the same basic structure and capabilitiesLong enough to make sense on its own Short enough to provide essential info
![Page 62: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/62.jpg)
Topic typesMain topic types:
Generic TopicConceptsTasksReference
DITA also includes:Composite or multiple topic typeGlossary entry (DITA 1.1)Specialization
![Page 63: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/63.jpg)
Topics: Determining the topics you need
Identify a task to document.Identify the subtasks for the task.Identify the concepts you need to support the task and subtasks.Identify the supporting reference information.
![Page 64: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/64.jpg)
XMetaL authoring templatesTemplates include commonly-needed elements to get started
To delete empty elements, click between the tags, then press Backspace
Blue-on-blue placeholder text is not shown in output
![Page 65: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/65.jpg)
Common elements in topicsTitleShort description
Briefly introduce the topic and provide a concise answer to the question �What is this?� Begin with a definition, and then expand upon it Contain the main point of the topic1-3 sentences, no more than 50 words
Body
![Page 66: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/66.jpg)
Concept topics
Concept topics explain and teach. Help users build on their experience and knowledge. Read before using the product or completing a task.Can contain paragraphs, lists, tables, sections, images, etc.
![Page 67: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/67.jpg)
Concept topics: examples
Concept topics can focus on specific types of information:
TechnologyUser concernsDecisionsBackgroundOverviewRelationshipsProcess overview
![Page 68: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/68.jpg)
Sections and nested topics
![Page 69: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/69.jpg)
Sections, topics, and headings
DITA is structuredNot like HTML or WordCannot put headings where you want
DITA requires more planning of your heading hierarchy
![Page 70: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/70.jpg)
SectionsUse in Concept and Reference topicsCan have more than one sectionCan�t nest sectionsAll following paragraphs must be in section
![Page 71: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/71.jpg)
Working with sections
Use Tags On view to see section boundariesMake sure section encloses all following content elements
![Page 72: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/72.jpg)
Sections and subtopics
To nest information, either:Nest topics within a DITA mapInsert subtopics within the DITA topic
DITA maps are far preferredThink about reusability
![Page 73: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/73.jpg)
Workbook Exercise:Creating Topics
![Page 74: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/74.jpg)
Reference topics
Reference topics provide quick access to factsInfo users need to complete their tasksOften read when the info is neededLittle or no background or explanatory detailLinks to other closely related reference topics
Contents defined by your Style GuideGood use of specialization
![Page 75: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/75.jpg)
Reference topics: examples
Documents the facts for categories such as:
device supportAPIsmessagesschemas
settingssymbolslanguage elementsand so on
![Page 76: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/76.jpg)
Task topics
Task topics document proceduresAbout 70% of topics are tasksEach task topic presents information in a strict chronological sequence:
PrerequisitesContextSteps (required)ResultExamplePostrequisites
![Page 77: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/77.jpg)
Task topics: Prerequisites
DITA element: <prereq>Things that users need to know or do before starting the task steps
![Page 78: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/78.jpg)
Task topics: Context
DITA element: <context>Background information on the task
![Page 79: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/79.jpg)
Typical task topic
<steps> element provides numbered steps
![Page 80: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/80.jpg)
Sequence within a <step> element
<cmd> (required)Any number of the following:
<info> (tables, images, paragraphs, notes)<substeps > (2a, 2b, 2c� )<tutorialinfo> <stepxmp ><choicetable ><choices>
<stepresult>
![Page 81: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/81.jpg)
Example of <steps>
![Page 82: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/82.jpg)
Steps: Example in a step
DITA element: <stepxmp>Optional step elementIllustrates the successful completion of the current step
![Page 83: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/83.jpg)
Steps: Step result
DITA element: <stepresult>Describes the result of the current stepOptional step elementExample:
When you depress the Lock button, all doors are locked automatically.
![Page 84: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/84.jpg)
Steps: Substeps
DITA elements: <substeps>, <substep>Subdivides a major step in a sequence. Output is the equivalent of a nested ordered list within an ordered list. Can use all the elements valid for <step>, except for <choices> and <choicetable>.
Example: 3. Do the following:
a. Browse for the file. b. Type the file name.
![Page 85: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/85.jpg)
Steps: Choices
DITA elements: <choices>, <choice>Decisions within a major step in a sequenceOutput is the equivalent of a nested unordered list within an ordered list. Can contain any general DITA elements
Example: 4. Select one of the following options:
Import all files Import selected files
![Page 86: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/86.jpg)
Steps: Choice tables
DITA elements: <choicetable>, <chrow>, <choption>, <chdesc>Decisions within a major step in a sequence
Require a significant amount of informationWhere there are multiple options
Output is the equivalent of a tableCan contain any general DITA elementsExample:
type attribute for the <note> element
![Page 87: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/87.jpg)
Steps: Choice table output
Option Description
Click in the same window
To open the perspective in the same window. When you open the window, it replaces the currently open window.
Click in a new window
To open the perspective in a new window. When you open the window, it opens in a new window and the currently open window remains open.
Specify how to open new perspectives:
![Page 88: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/88.jpg)
Task with unordered steps
Bullets instead of numbers <steps-unordered> element
![Page 89: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/89.jpg)
Task topics: Results
DITA element: <result>Illustrates the successful completion of the taskExample: The device is fully configured and ready for use.
![Page 90: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/90.jpg)
Task topics: Example
DITA element: <example>Illustrates a successful completion of the task steps. <example> is a type of <section> element
![Page 91: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/91.jpg)
Task topics: Postrequisites
DITA element: <postreq>Things that users need to know or do upon completing the task steps.
![Page 92: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/92.jpg)
Workbook Exercise:Task Topics
![Page 93: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/93.jpg)
Cross-references and links
![Page 94: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/94.jpg)
Types of links
Inline links <xref>Cross-reference <xref href="#target"/>File reference <xref href="file.typ"/>Web link <xref href="http://..."/>
Related links <related-links>Links generated by relationship tables
![Page 95: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/95.jpg)
Inserting links
Insert > Link > ...Cross-referenceFile referenceWeb link
All add <xref> elements
Related links added at end of topic
![Page 96: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/96.jpg)
Refreshing References
To update content in cross-references: Click Edit > Refresh All ReferencesClose and reopen the document
![Page 97: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/97.jpg)
Workbook Exercise:Cross-references and Links
![Page 98: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/98.jpg)
Metadata and index elements
![Page 99: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/99.jpg)
Metadata in DITA
Maintained in <prolog> elementExamples: author, publisher, copyright informationMetadata is usually company-specificClick Insert > Topic Metadata
This dialog can get you started, but best to create your own
![Page 100: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/100.jpg)
Indexing
Use <indexterm>Can nest <indexterm> elementsCannot put in <title> elements
Place <indexterm> where appropriateDITA Open Toolkit will compile an index
![Page 101: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/101.jpg)
Creating index entries
Click Insert > Index MarkerTip: Press Alt+Shift+XUse commas to create subentries
![Page 102: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/102.jpg)
Editing index entries
Braces ({ and }) are XMetaLIndex entry:
Nested index entry:
Nested entry produces: “Stylesheets, troubleshooting....37”
![Page 103: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/103.jpg)
Advanced indexing features
DITA 1.1 Page rangesSee/See alsoSort as
![Page 104: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/104.jpg)
Workbook Exercise:Metadata and Index Elements
![Page 105: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/105.jpg)
Track changes
![Page 106: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/106.jpg)
Purpose:Communicate to reviewers about what�s newHave reviewers communicate about what they wantHelp you manage your writing process
XMetaL uses processing instructions to track changes
Track changes
![Page 107: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/107.jpg)
Using change tracking
Turn on and off:Tools > Track Changes
Accept/reject changes:Tools > Accept or Reject Changes
Can also use: View > Toolbars [Reviewing]To change styles:
Name: Tools > Options [General]Format: Tools > Options [Change Tracking]
![Page 108: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/108.jpg)
Workbook Exercise:Track Changes
![Page 109: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/109.jpg)
DITA Maps
![Page 110: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/110.jpg)
DITA maps
Organize DITA topics in a TOC-like structureReferences to DITA topicsAnalogous to a FrameMaker Book fileCan also contain topic metadata
![Page 111: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/111.jpg)
Topics and mapsTopic
Unit of information that is meaningful when it stands alone
MapOrganizes topics into a coherent setTypically for different deliverables or media
Topics DITA Maps Deliverables
![Page 112: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/112.jpg)
Working with maps
Map Editor displays maps in a GUIYou can:
Add and remove topicsChange topic orderNest topicsEdit with drag and drop or toolbar buttonsChange map properties
![Page 113: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/113.jpg)
Insert a reference to an existing topic
Select the map entry under which you want to nest the topicClick Insert > Topic ReferenceBrowse for a topic
![Page 114: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/114.jpg)
Tips for working with maps
Plan where to put your map and topic filesusually close to each other
Remember file and folder naming rules:no spaces, no special characters
Make sure you�re using files in the location you think you�re using
![Page 115: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/115.jpg)
Insert and create a topic
Select the topic above where you want the new topicClick Insert > Topic Reference
![Page 116: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/116.jpg)
Insert a topic heading
Click Insert > Topic Heading
![Page 117: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/117.jpg)
Create a new map
Click (small) File > New Map.
or
Click (big) File > NewThen choose the DITA Map template
![Page 118: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/118.jpg)
Insert a submap
Both maps must exist Click (small) Insert > Map Reference
![Page 119: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/119.jpg)
Specify map properties
In the Map Editor, select the Properties button.In the Map Properties dialog, click the Special Attributes tabInteresting attributes include:
Navigation titleScopeInclude in TOCPrint
![Page 120: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/120.jpg)
Workbook Exercise:Organizing Topics with Maps
![Page 121: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/121.jpg)
Switch to XML view
Click (small) File > Switch to XML View of Map.
![Page 122: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/122.jpg)
Switch to Map Editor
Select File > Switch to Map Editor
![Page 123: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/123.jpg)
Different views for different tasksTask Map
editorXML View
Create the table of contents, a.k.a. the �hierarchical� part of the map
Browse topics by double-clicking
Edit relationship tables
Use conditional text to make parts of the map conditional
Troubleshoot
![Page 124: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/124.jpg)
Relationship tables
Automatically generate �Related x� sectionsSpecial type of semantic table
Columns define information typesRows define relationships between topicsEach <topicref> in a cell will link to the other topic references in that rowCan control linking
![Page 125: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/125.jpg)
Map metadata
Metadata in mapscan fine-tune linking in relationship tablescan be used instead of topic metadatais inherited from parent elements
![Page 126: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/126.jpg)
Relationship Tables: XML View
![Page 127: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/127.jpg)
Create a relationship table
Switch to XML viewInsert the relationship tableAdd the <topicref> elementsGenerate the mapReview the linksUpdate the relationship tableGenerate and reviewSwitch to Map Editor
![Page 128: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/128.jpg)
Insert a relationship table
Click Table > Insert Relationship Table.Choose one of several common formats, then click OK:
![Page 129: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/129.jpg)
Attributes for managing links
In a <relcell> element:collection-type = �family�
topicrefs in cell link to each otherlinking = �targetonly�
topicrefs can be targets, but cannot be linkslinking = �sourceonly�
topicrefs can be links, but cannot be targets
![Page 130: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/130.jpg)
Add topicsHold CTRL and drag Task topics from the navigation portion of the map into the relationship table. This copies the <topicref>.Think of the Concept and Reference topics that are related to each Task. Paste <topicref>s for those topics on the same row.Generate the map and open the file.
![Page 131: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/131.jpg)
Workbook Exercise:Relationship Tables
![Page 132: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/132.jpg)
Glossaries
![Page 133: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/133.jpg)
Glossaries
Writing glossary contentAssembling glossary content
![Page 134: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/134.jpg)
Glossary content
Basic markup:<glossentry>
<glossterm></glossterm><glossdef></glossdef>
</glossentry>
One or more <glossentry> elements in a fileSpecialization of <concept>DITA 1.1
![Page 135: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/135.jpg)
Assembling glossary content
Create a Bookmap file and point the <glossarylist> element to your glossary content files.Add a <topicref> to your map file pointing to your Bookmap file.
![Page 136: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/136.jpg)
Publishing glossaries
During �Generate Output�:
All glossary content is pulled into the same glossary and is sorted alphabetically.
![Page 137: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/137.jpg)
Reusing content
![Page 138: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/138.jpg)
Content reuse: overview
Reuse is about reducing duplication and delivering more customized content
Two main approaches to reuse: Conditional textModular reuse:
reusing topics in different mapscontent references (conref)
![Page 139: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/139.jpg)
Conditional text
Single source fileContent for multiple deliverablesMarkup identifies different subsetsFor example,
Windows: "Press Ctrl+S"Macintosh: "Press Command+S"
![Page 140: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/140.jpg)
What does conditional text markup look like?
No conditional text markup:
<p>Press Ctrl+S.</p>
Conditional text markup:
<p platform = "windows">Press Ctrl+S.</p>
attribute attribute value
![Page 141: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/141.jpg)
Conditional text overview
Configure XMetaL with conditionsTypically: products, platforms, audiences
In XMetaL:Mark content as conditionalStyle conditional contentGenerate output
specify conditional content
![Page 142: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/142.jpg)
Make content conditional
Select text or an element Click Reuse > Apply/Remove Conditions
![Page 143: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/143.jpg)
Assigning conditional attributes
Windows only:<p platform="windows">Press Ctrl+S.</p>
Windows and Macintosh, but not Unix:<p platform="windows macintosh">Press Ctrl+S.</p>
All platforms:<p>Press Ctrl+S.</p>
![Page 144: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/144.jpg)
What content can you make conditional?
DITA allows a high degree of granularitySingle words can be made conditional(But consider practicality)Not limited to text, other types of content
![Page 145: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/145.jpg)
Elements that can be made conditional:
Yes:TextImagesCross-referencesIndex markersTablesRows in tablesContent within content referencesTopic references in DITA maps
No:Individual table cellsTable columnsRequired elements
Text within required elements is OK
![Page 146: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/146.jpg)
<ph> element
If you make selected text conditional, XMetaL inserts <ph> tags so it can �hang� attributes on the <ph> element.
![Page 147: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/147.jpg)
Style conditional text
Styles help keep track of conditional textXMetaL only, not in deliverablesReuse > Style Conditional Text
![Page 148: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/148.jpg)
Generate conditional output
Choose what platforms, products, and audiences you want to include
![Page 149: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/149.jpg)
How DITA handles multiple condition types
In output for this audience and product:
Does the element appear?
Notes
EuropeMacintosh
No* The element is for the right audience. The element is not for the right platform.
North AmericaWindows
No* The element is not for the right audience. The element is for the right platform.
Europe Windows and Macintosh
Yes The element is for the right audience. The element is for one of the right platforms.
For an element marked as audience = �Europe� and platform = �windows�
*Would appear if you used native FrameMaker® 7.x conditions instead of DITA
![Page 150: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/150.jpg)
Multiple condition types: the rule
In this example: Content must be for both the right platform and the right audience in order to be included.The general rule: An element is included if, for each attribute mentioned in Show/Hide Conditional Text:
It doesn't have any values for that attribute, i.e. it is "common to all"OR it matches at least one value that should be included.
![Page 151: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/151.jpg)
Planning to use conditional text
Determine your team's needs in terms of content reuse:
What product variations are similar enough they could be documented through one set of source files?What audiences do you want to customize documentation for?Would it make sense to achieve reuse through conditional text, through content modularization, or both?
![Page 152: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/152.jpg)
Configuring XMetaL conditions
Edit ct_config.xml<conditions> <attribute name="audience" title="Audience"> <value name="student" title="Student" />
<value name="teacher" title="Trainer" /> <value name=�self-study" title=�Self-Study" />
</attribute>
<attribute name="platform" title="Platform"> <value name="windowsxp" title="Windows XP� />
<value name="windows2000" title="Windows 2000 /><value name="linux" title="Linux" /><value name="macosx" title="MacOSX� />
</attribute></conditions>
![Page 153: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/153.jpg)
Content references (conrefs)
Standard DITA element attributeReferences another element of same typeOn output, content from referenced element substituted for the conref elementSimilar to FrameMaker �text insets�Analogous to referencing an image file
![Page 154: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/154.jpg)
Content references in XMetaL
Content shown in conref is:Read-onlyUpdated when a document is opened
To manually refresh:Click Edit > Refresh All ReferencesOr press F11
![Page 155: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/155.jpg)
Working with content references
Open a document containing a content referenceRight-click to switch between viewing local content and referenced content
Local content is highlighted in yellow
![Page 156: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/156.jpg)
Reusable components
Reusable components:Managed snippets of XMLHave titles, short descriptions, and reusable-content.
One reusable component per fileClick Reuse > Create Reusable ComponentXMetaL only; not transportable
![Page 157: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/157.jpg)
Reuse strategiesReuse Opportunity Solution
Multiple similar deliverables Flag some content as conditional
Piece of content used in many different contexts
Include it in different topics using content references
(Modular reuse)
Topic used in many different deliverables
Include it in different deliverables through DITA maps
(Modular reuse)
![Page 158: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/158.jpg)
Workbook Exercise:Reusing Content
![Page 159: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/159.jpg)
Additional resources
DITA Users group on Yahoo! groups:http://tech.groups.yahoo.com/group/dita-users/XMetaL-DITA group on Yahoo! groups:http://tech.groups.yahoo.com/group/xmetal-dita/dita.xml.org www.justsystems.com (webinars, events)
![Page 161: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/161.jpg)
1
Introduction to DITA and XMetaL
Simon BateScriptorium Publishing Services
![Page 162: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/162.jpg)
2
Course Agenda
Overview of XMetaLElements and structured authoringGenerating output AttributesImagesTablesWriting topics
Sections and nested topicsCross-referencesMetadata and indexesTrack changesDITA mapsReusing content
![Page 163: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/163.jpg)
3
Course purpose
Learn how to author content using XMetaL Author Enterprise EditionUnderstand DITAPut theory into practice, learn by doing
![Page 164: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/164.jpg)
4
About DITA
Darwin Information Typing ArchitectureCreated at IBMNow developed and maintained by OASISStandard XML language
Cost-effective way to create, publish, reuse, and exchange structured content
![Page 165: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/165.jpg)
5
Role of DITA Tools
An authoring tool is a user interface for creating DITA content
![Page 166: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/166.jpg)
DITA documentation
DITA Language ReferencePurpose and content model for each elementHelp > DITA Specifications > DITA Language Reference
DITA Architectural SpecificationDescribes overall behavior of DITAVery technicalHelp > DITA Specifications > DITA Architectural Specification
6
![Page 167: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/167.jpg)
Overview of XMetaL
7
![Page 168: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/168.jpg)
8
XMetaL Author
Standard word-processing environmentMultiple undo (and redo)Spell checking & thesaurusChange tracking
Create and edit textFamiliar editing features to create content
![Page 169: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/169.jpg)
9
XMetaL Author Interface: OverviewMenu
Structure View
Tool bar
Document Pane
View Mode buttons
Element List
![Page 170: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/170.jpg)
Inserting symbols and special characters
Insert > Symbols
Insert > Special Characters
Or click View > Toolbars, Then toggle appropriate checkboxes
10
![Page 171: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/171.jpg)
Typographical elements
BoldItalicUnderline
11
![Page 172: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/172.jpg)
12
View modes
Four view modes for the document pane:NormalPage PreviewTags OnPlain Text
Controls in bottom left corner of the pane: Indicate the current viewSwitch between views
![Page 173: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/173.jpg)
13
Normal view
Shows content No XML element tagsIndicated by this icon: Use most of the time when writing content
![Page 174: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/174.jpg)
14
Tags On view
Shows content Shows XML element tagsIndicated by this icon: Allows precise insertionAllows tag deletion/unwrappingClick box to expand/collapse:Tip: CTRL+SHIFT toggles Tags On & Normal
![Page 175: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/175.jpg)
15
Plain Text view
Edit all XML markup and contentIndicated by this icon: Does not check validityCan create invalid XML
![Page 176: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/176.jpg)
16
Page Preview view
Shows a formatted preview Indicated by this icon: Verify the content is formatted correctlyXML document transformedOpens in browser or Acrobat
![Page 177: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/177.jpg)
Tip:
Can�t see the menus?Open a DITA document
Want to see the structure view?View > Structure View
17
![Page 178: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/178.jpg)
11/03/08 18
Workbook Exercise:Basic File Operations
18
![Page 179: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/179.jpg)
Options for saving and opening files
Click Tools > Options
To use default toolbars, press CTRL on startup
For training, it is useful to turn this option off because having too many files open confuses people
19
![Page 180: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/180.jpg)
File and folder naming
Be systematic and carefulNo spacesNo special characters
20
![Page 181: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/181.jpg)
Elements and Structured Authoring
21
![Page 182: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/182.jpg)
Elements: Key terms
Element Element type (or name)Element contentsStart tagEnd tagAttribute
22
![Page 183: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/183.jpg)
Structure and validity
XML must be:Well-formedValid
DITA content model defines validityHow to order elements Hierarchy of element typesAttributes
23
![Page 184: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/184.jpg)
Validating documents
Click Tools > ValidateErrors most common in converted legacy documentsFix �missing required element� problems first
24
![Page 185: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/185.jpg)
Structure and "Smart Insert"
When pasting XMetaL content:XMetaL inserts content at closest valid locationMay be far from the insertion pointMay not be pasted at all
When pasting Word or HTML content:XMetaL uses DITA elementsClosest match to paste and locationBest advice: watch when pasting
25
![Page 186: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/186.jpg)
26
Identifying the current element
See context bar (at bottom of screen)Also shows ancestors' hierarchyBased on:
Cursor locationCurrently selected element
Here's a <li> within a <ul> within a <section>�
![Page 187: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/187.jpg)
27
Be aware of what is selected
Identifying the current element
![Page 188: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/188.jpg)
ENTER key
XMetaL inserts the most logical next element Often the same type as the current one
28
![Page 189: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/189.jpg)
Insert menu
Allows you to insert elementsShows most available elementsContext free�Smart Insert�
Inserts an element in the next valid locationSometimes asks if you want to split the current element � usually this is what you want
29
![Page 190: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/190.jpg)
30
Element List
View > Element ListLists available valid elementsDepends on cursor location
Insert newChange selected
![Page 191: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/191.jpg)
Paragraph menu
Change paragraphs to notes and long quotationsSpecify note types:
dangertip
Apply and remove bullets and numbering
31
![Page 192: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/192.jpg)
Format markup vs. Semantic markup
Separation of content from formatting
Format markup: how something should lookSemantic markup: what something means
Examples:<b> vs. <uicontrol><li> vs. <step>
32
![Page 193: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/193.jpg)
Inserting domain elements
Domain elements cross topic typesInsert > * Element menus
ProgrammingSoftwareUser InterfaceUtilitiesOther
![Page 194: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/194.jpg)
Domains in Element List
Domain elements are listed in Element ListTools > DITA Options Only affects the Element List
Not the Insert menu
34
![Page 195: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/195.jpg)
Modifying elements
Change element typeRadio button in Insert element list
Expand and collapse content displaysDelete elements
35
![Page 196: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/196.jpg)
Deleting elements
Easiest on Tags On view
To "unwrap" an element (leave content):Click just after the start tag, then press Backspace
To delete the element and content:Click a tag to select the entire element, then press Delete or Backspace
36
![Page 197: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/197.jpg)
11/03/08 37
Workbook Exercise:Working with Elements
37
![Page 198: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/198.jpg)
Generating Output (Publishing)
38
![Page 199: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/199.jpg)
DITA Open Toolkit
Open-source application for publishing DITA content to multiple output formats
Integrated with XMetaL
Help > Third-Party Components > DITA Open Toolkit User Guide
39
![Page 200: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/200.jpg)
Publishing formats
XHTMLPDFCHMRTFEclipse HelpJavaHelp
40
![Page 201: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/201.jpg)
PDF options
XMetaL Enhanced PDFBest all-purpose PDF deliverable type
XMetaL Enhanced PDF via Acrobat DistillerUse if your documents have EPS graphics
41
![Page 202: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/202.jpg)
Generating output
File > Generate Output for DITA Topic
Troubleshooting:File > View Output Log
42
![Page 203: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/203.jpg)
11/03/08 43
Workbook Exercise:Generating Output
43
![Page 204: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/204.jpg)
Attributes
44
![Page 205: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/205.jpg)
Purpose of attributes
Provide additional informationwidth = �250 px�
Point to a file or URLhref = �http://www.microsoft.com�href = �images/red_button.gif�
Identify an elementid = �p_73412763�
Conditionalize an elementplatform = �macintosh�
45
![Page 206: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/206.jpg)
Attribute Inspector
Click View > Attribute InspectorAllows you to examine and change values of XML attributesCursor position is important
46
![Page 207: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/207.jpg)
Working with attributes
XMetaL creates element IDs automaticallySome dialog boxes set attributes
Insert ImageSet Conditional Text
Use Attribute Inspector
47
![Page 208: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/208.jpg)
Attribute tooltips
Tip: Hover over a tag in Tags On view to see attributes
48
![Page 209: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/209.jpg)
11/03/08 49
Workbook Exercise:Attributes
49
![Page 210: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/210.jpg)
Images
50
![Page 211: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/211.jpg)
Supported image formats
PNG, GIF, JPEGSVG (if an appropriate plug-in is installed)EPS
displays in XMetaL if preview information is available in the filerequires Acrobat Distiller to produce optimal PDF output
TIF, other formatsmay not display in all output formats
51
![Page 212: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/212.jpg)
Working with images
Inserting imagesInsert > Image
Insert an image with a titleInsert > Figure with Title
Add a title to an existing imageSelect Image and wrap in figInsert > Other Element > Title
Modify the properties of an existing image
52
![Page 213: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/213.jpg)
Image sizing
Do one of the following:Best-supported: Resize the image using a graphics editorSpecify �width� in pixels, inches, cm, etc.Specify �height�Least-supported: Specify �scale� by a percentage
53
![Page 214: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/214.jpg)
11/03/08 54
Workbook Exercise:Images
54
![Page 215: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/215.jpg)
Tables
55
![Page 216: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/216.jpg)
Tables
Click Table > Insert TableChoose type:
Normal table = table with titleSimple table = informal table (no title)Step choices (task topics only) Properties (reference topics only)
Specify rows and columnsSpecify header or not
56
![Page 217: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/217.jpg)
Header rows
To make the first row of a table a header row:Click Table > Insert Table
Add later with Table > Table Properties
57
![Page 218: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/218.jpg)
Working with table properties
Tip: Click in a row to change the properties of that row. Don�t select the whole row.
58
![Page 219: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/219.jpg)
11/03/08 59
Workbook Exercise:Tables
59
![Page 220: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/220.jpg)
Writing topics
60
![Page 221: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/221.jpg)
61
Topics
A Topic is a DITA unit of informationHas a title, short description, and content All topics have the same basic structure and capabilitiesLong enough to make sense on its own Short enough to provide essential info
![Page 222: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/222.jpg)
62
Topic typesMain topic types:
Generic TopicConceptsTasksReference
DITA also includes:Composite or multiple topic typeGlossary entry (DITA 1.1)Specialization
![Page 223: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/223.jpg)
63
Topics: Determining the topics you need
Identify a task to document.Identify the subtasks for the task.Identify the concepts you need to support the task and subtasks.Identify the supporting reference information.
![Page 224: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/224.jpg)
XMetaL authoring templatesTemplates include commonly-needed elements to get started
To delete empty elements, click between the tags, then press Backspace
Blue-on-blue placeholder text is not shown in output
64
![Page 225: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/225.jpg)
Common elements in topicsTitleShort description
Briefly introduce the topic and provide a concise answer to the question �What is this?� Begin with a definition, and then expand upon it Contain the main point of the topic1-3 sentences, no more than 50 words
Body
65
![Page 226: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/226.jpg)
66
Concept topics
Concept topics explain and teach. Help users build on their experience and knowledge. Read before using the product or completing a task.Can contain paragraphs, lists, tables, sections, images, etc.
![Page 227: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/227.jpg)
67
Concept topics: examples
Concept topics can focus on specific types of information:
TechnologyUser concernsDecisionsBackgroundOverviewRelationshipsProcess overview
![Page 228: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/228.jpg)
Sections and nested topics
68
![Page 229: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/229.jpg)
Sections, topics, and headings
DITA is structuredNot like HTML or WordCannot put headings where you want
DITA requires more planning of your heading hierarchy
69
![Page 230: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/230.jpg)
SectionsUse in Concept and Reference topicsCan have more than one sectionCan�t nest sectionsAll following paragraphs must be in section
70
![Page 231: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/231.jpg)
71
Working with sections
Use Tags On view to see section boundariesMake sure section encloses all following content elements
![Page 232: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/232.jpg)
72
Sections and subtopics
To nest information, either:Nest topics within a DITA mapInsert subtopics within the DITA topic
DITA maps are far preferredThink about reusability
![Page 233: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/233.jpg)
11/03/08 73
Workbook Exercise:Creating Topics
73
![Page 234: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/234.jpg)
74
Reference topics
Reference topics provide quick access to factsInfo users need to complete their tasksOften read when the info is neededLittle or no background or explanatory detailLinks to other closely related reference topics
Contents defined by your Style GuideGood use of specialization
![Page 235: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/235.jpg)
Reference topics: examples
Documents the facts for categories such as:
device supportAPIsmessagesschemas
settingssymbolslanguage elementsand so on
75
![Page 236: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/236.jpg)
Task topics
Task topics document proceduresAbout 70% of topics are tasksEach task topic presents information in a strict chronological sequence:
PrerequisitesContextSteps (required)ResultExamplePostrequisites
76
![Page 237: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/237.jpg)
77
Task topics: Prerequisites
DITA element: <prereq>Things that users need to know or do before starting the task steps
![Page 238: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/238.jpg)
Task topics: Context
DITA element: <context>Background information on the task
![Page 239: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/239.jpg)
Typical task topic
<steps> element provides numbered steps
79
![Page 240: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/240.jpg)
Sequence within a <step> element
<cmd> (required)Any number of the following:
<info> (tables, images, paragraphs, notes)<substeps > (2a, 2b, 2c� )<tutorialinfo> <stepxmp ><choicetable ><choices>
<stepresult>
80
![Page 241: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/241.jpg)
Example of <steps>
81
![Page 242: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/242.jpg)
82
Steps: Example in a step
DITA element: <stepxmp>Optional step elementIllustrates the successful completion of the current step
![Page 243: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/243.jpg)
83
Steps: Step result
DITA element: <stepresult>Describes the result of the current stepOptional step elementExample:
When you depress the Lock button, all doors are locked automatically.
![Page 244: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/244.jpg)
84
Steps: Substeps
DITA elements: <substeps>, <substep>Subdivides a major step in a sequence. Output is the equivalent of a nested ordered list within an ordered list. Can use all the elements valid for <step>, except for <choices> and <choicetable>.
Example: 3. Do the following:
a. Browse for the file. b. Type the file name.
![Page 245: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/245.jpg)
85
Steps: Choices
DITA elements: <choices>, <choice>Decisions within a major step in a sequenceOutput is the equivalent of a nested unordered list within an ordered list. Can contain any general DITA elements
Example: 4. Select one of the following options:
Import all files Import selected files
![Page 246: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/246.jpg)
86
Steps: Choice tables
DITA elements: <choicetable>, <chrow>, <choption>, <chdesc>Decisions within a major step in a sequence
Require a significant amount of informationWhere there are multiple options
Output is the equivalent of a tableCan contain any general DITA elementsExample:
type attribute for the <note> element
![Page 247: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/247.jpg)
87
Steps: Choice table output
Option Description
Click in the same window
To open the perspective in the same window. When you open the window, it replaces the currently open window.
Click in a new window
To open the perspective in a new window. When you open the window, it opens in a new window and the currently open window remains open.
Specify how to open new perspectives:
![Page 248: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/248.jpg)
Task with unordered steps
Bullets instead of numbers <steps-unordered> element
88
![Page 249: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/249.jpg)
89
Task topics: Results
DITA element: <result>Illustrates the successful completion of the taskExample: The device is fully configured and ready for use.
![Page 250: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/250.jpg)
90
Task topics: Example
DITA element: <example>Illustrates a successful completion of the task steps. <example> is a type of <section> element
Haven't introduced <section> yet.
![Page 251: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/251.jpg)
91
Task topics: Postrequisites
DITA element: <postreq>Things that users need to know or do upon completing the task steps.
![Page 252: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/252.jpg)
11/03/08 92
Workbook Exercise:Task Topics
92
![Page 253: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/253.jpg)
Cross-references and links
93
![Page 254: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/254.jpg)
Types of links
Inline links <xref>Cross-reference <xref href="#target"/>File reference <xref href="file.typ"/>Web link <xref href="http://..."/>
Related links <related-links>Links generated by relationship tables
94
![Page 255: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/255.jpg)
Inserting links
Insert > Link > ...Cross-referenceFile referenceWeb link
All add <xref> elements
Related links added at end of topic
![Page 256: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/256.jpg)
Refreshing References
To update content in cross-references: Click Edit > Refresh All ReferencesClose and reopen the document
96
![Page 257: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/257.jpg)
11/03/08 97
Workbook Exercise:Cross-references and Links
97
![Page 258: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/258.jpg)
Metadata and index elements
98
![Page 259: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/259.jpg)
Metadata in DITA
Maintained in <prolog> elementExamples: author, publisher, copyright informationMetadata is usually company-specificClick Insert > Topic Metadata
This dialog can get you started, but best to create your own
99
![Page 260: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/260.jpg)
Indexing
Use <indexterm>Can nest <indexterm> elementsCannot put in <title> elements
Place <indexterm> where appropriateDITA Open Toolkit will compile an index
100
![Page 261: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/261.jpg)
Creating index entries
Click Insert > Index MarkerTip: Press Alt+Shift+XUse commas to create subentries
101
![Page 262: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/262.jpg)
Editing index entries
Braces ({ and }) are XMetaLIndex entry:
Nested index entry:
Nested entry produces: “Stylesheets, troubleshooting....37”
Explain how to correct a misspelling in an index entry
102
![Page 263: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/263.jpg)
Advanced indexing features
DITA 1.1 Page rangesSee/See alsoSort as
103
![Page 264: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/264.jpg)
11/03/08 104
Workbook Exercise:Metadata and Index Elements
104
![Page 265: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/265.jpg)
Track changes
105
![Page 266: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/266.jpg)
Purpose:Communicate to reviewers about what�s newHave reviewers communicate about what they wantHelp you manage your writing process
XMetaL uses processing instructions to track changes
Track changes
106
![Page 267: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/267.jpg)
Using change tracking
Turn on and off:Tools > Track Changes
Accept/reject changes:Tools > Accept or Reject Changes
Can also use: View > Toolbars [Reviewing]To change styles:
Name: Tools > Options [General]Format: Tools > Options [Change Tracking]
107
![Page 268: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/268.jpg)
11/03/08 108
Workbook Exercise:Track Changes
108
![Page 269: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/269.jpg)
DITA Maps
109
![Page 270: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/270.jpg)
110
DITA maps
Organize DITA topics in a TOC-like structureReferences to DITA topicsAnalogous to a FrameMaker Book fileCan also contain topic metadata
Can have multiple maps for multiple deliverables.EG: data sheet vs concepts guide
![Page 271: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/271.jpg)
111
Topics and mapsTopic
Unit of information that is meaningful when it stands alone
MapOrganizes topics into a coherent setTypically for different deliverables or media
Topics DITA Maps Deliverables
![Page 272: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/272.jpg)
112
Working with maps
Map Editor displays maps in a GUIYou can:
Add and remove topicsChange topic orderNest topicsEdit with drag and drop or toolbar buttonsChange map properties
![Page 273: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/273.jpg)
113
Insert a reference to an existing topic
Select the map entry under which you want to nest the topicClick Insert > Topic ReferenceBrowse for a topic
![Page 274: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/274.jpg)
Tips for working with maps
Plan where to put your map and topic filesusually close to each other
Remember file and folder naming rules:no spaces, no special characters
Make sure you�re using files in the location you think you�re using
114
![Page 275: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/275.jpg)
Insert and create a topic
Select the topic above where you want the new topicClick Insert > Topic Reference
Break and re-form a link in a map, by changing the file name for a referenced topic. See how the topic title changes to italics.
115
![Page 276: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/276.jpg)
Insert a topic heading
Click Insert > Topic Heading
116
![Page 277: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/277.jpg)
117
Create a new map
Click (small) File > New Map.
or
Click (big) File > NewThen choose the DITA Map template
![Page 278: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/278.jpg)
118
Insert a submap
Both maps must exist Click (small) Insert > Map Reference
![Page 279: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/279.jpg)
119
Specify map properties
In the Map Editor, select the Properties button.In the Map Properties dialog, click the Special Attributes tabInteresting attributes include:
Navigation titleScopeInclude in TOCPrint
![Page 280: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/280.jpg)
11/03/08 120
Workbook Exercise:Organizing Topics with Maps
120
![Page 281: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/281.jpg)
121
Switch to XML view
Click (small) File > Switch to XML View of Map.
![Page 282: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/282.jpg)
122
Switch to Map Editor
Select File > Switch to Map Editor
![Page 283: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/283.jpg)
123
Different views for different tasksTask Map
editorXML View
Create the table of contents, a.k.a. the �hierarchical� part of the map
Browse topics by double-clicking
Edit relationship tables
Use conditional text to make parts of the map conditional
Troubleshoot
![Page 284: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/284.jpg)
124
Relationship tables
Automatically generate �Related x� sectionsSpecial type of semantic table
Columns define information typesRows define relationships between topicsEach <topicref> in a cell will link to the other topic references in that rowCan control linking
![Page 285: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/285.jpg)
125
Map metadata
Metadata in mapscan fine-tune linking in relationship tablescan be used instead of topic metadatais inherited from parent elements
![Page 286: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/286.jpg)
126
Relationship Tables: XML View
![Page 287: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/287.jpg)
127
Create a relationship table
Switch to XML viewInsert the relationship tableAdd the <topicref> elementsGenerate the mapReview the linksUpdate the relationship tableGenerate and reviewSwitch to Map Editor
![Page 288: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/288.jpg)
128
Insert a relationship table
Click Table > Insert Relationship Table.Choose one of several common formats, then click OK:
![Page 289: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/289.jpg)
Attributes for managing links
In a <relcell> element:collection-type = �family�
topicrefs in cell link to each otherlinking = �targetonly�
topicrefs can be targets, but cannot be linkslinking = �sourceonly�
topicrefs can be links, but cannot be targets
129
![Page 290: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/290.jpg)
130
Add topicsHold CTRL and drag Task topics from the navigation portion of the map into the relationship table. This copies the <topicref>.Think of the Concept and Reference topics that are related to each Task. Paste <topicref>s for those topics on the same row.Generate the map and open the file.
![Page 291: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/291.jpg)
11/03/08 131
Workbook Exercise:Relationship Tables
131
![Page 292: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/292.jpg)
Glossaries
132
![Page 293: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/293.jpg)
Glossaries
Writing glossary contentAssembling glossary content
133
![Page 294: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/294.jpg)
Glossary content
Basic markup:<glossentry>
<glossterm></glossterm><glossdef></glossdef>
</glossentry>
One or more <glossentry> elements in a fileSpecialization of <concept>DITA 1.1
134
![Page 295: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/295.jpg)
Assembling glossary content
Create a Bookmap file and point the <glossarylist> element to your glossary content files.Add a <topicref> to your map file pointing to your Bookmap file.
135
![Page 296: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/296.jpg)
Publishing glossaries
During �Generate Output�:
All glossary content is pulled into the same glossary and is sorted alphabetically.
136
![Page 297: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/297.jpg)
Reusing content
137
![Page 298: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/298.jpg)
Content reuse: overview
Reuse is about reducing duplication and delivering more customized content
Two main approaches to reuse: Conditional textModular reuse:
reusing topics in different mapscontent references (conref)
138
![Page 299: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/299.jpg)
Conditional text
Single source fileContent for multiple deliverablesMarkup identifies different subsetsFor example,
Windows: "Press Ctrl+S"Macintosh: "Press Command+S"
139
![Page 300: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/300.jpg)
What does conditional text markup look like?
No conditional text markup:
<p>Press Ctrl+S.</p>
Conditional text markup:
<p platform = "windows">Press Ctrl+S.</p>
attribute attribute value
![Page 301: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/301.jpg)
Conditional text overview
Configure XMetaL with conditionsTypically: products, platforms, audiences
In XMetaL:Mark content as conditionalStyle conditional contentGenerate output
specify conditional content
..\XMetaL\Author\Conditional Text\configs\ct_config.xml.
141
![Page 302: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/302.jpg)
Make content conditional
Select text or an element Click Reuse > Apply/Remove Conditions
142
![Page 303: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/303.jpg)
Assigning conditional attributes
Windows only:<p platform="windows">Press Ctrl+S.</p>
Windows and Macintosh, but not Unix:<p platform="windows macintosh">Press Ctrl+S.</p>
All platforms:<p>Press Ctrl+S.</p>
143
![Page 304: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/304.jpg)
What content can you make conditional?
DITA allows a high degree of granularitySingle words can be made conditional(But consider practicality)Not limited to text, other types of content
144
![Page 305: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/305.jpg)
145
Elements that can be made conditional:
Yes:TextImagesCross-referencesIndex markersTablesRows in tablesContent within content referencesTopic references in DITA maps
No:Individual table cellsTable columnsRequired elements
Text within required elements is OK
![Page 306: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/306.jpg)
<ph> element
If you make selected text conditional, XMetaL inserts <ph> tags so it can �hang� attributes on the <ph> element.
146
![Page 307: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/307.jpg)
147
Style conditional text
Styles help keep track of conditional textXMetaL only, not in deliverablesReuse > Style Conditional Text
![Page 308: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/308.jpg)
Generate conditional output
Choose what platforms, products, and audiences you want to include
148
![Page 309: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/309.jpg)
How DITA handles multiple condition types
In output for this audience and product:
Does the element appear?
Notes
EuropeMacintosh
No* The element is for the right audience. The element is not for the right platform.
North AmericaWindows
No* The element is not for the right audience. The element is for the right platform.
Europe Windows and Macintosh
Yes The element is for the right audience. The element is for one of the right platforms.
For an element marked as audience = �Europe� and platform = �windows�
*Would appear if you used native FrameMaker® 7.x conditions instead of DITA
FM conditions were linked with Boolean OR. Now conditional expressions in FM 8.0 help (a bit).
XMetaL conditions linked with Boolean AND.
149
![Page 310: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/310.jpg)
Multiple condition types: the rule
In this example: Content must be for both the right platform and the right audience in order to be included.The general rule: An element is included if, for each attribute mentioned in Show/Hide Conditional Text:
It doesn't have any values for that attribute, i.e. it is "common to all"OR it matches at least one value that should be included.
150
![Page 311: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/311.jpg)
151
Planning to use conditional text
Determine your team's needs in terms of content reuse:
What product variations are similar enough they could be documented through one set of source files?What audiences do you want to customize documentation for?Would it make sense to achieve reuse through conditional text, through content modularization, or both?
![Page 312: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/312.jpg)
152
Configuring XMetaL conditions
Edit ct_config.xml<conditions> <attribute name="audience" title="Audience"> <value name="student" title="Student" />
<value name="teacher" title="Trainer" /> <value name=�self-study" title=�Self-Study" />
</attribute>
<attribute name="platform" title="Platform"> <value name="windowsxp" title="Windows XP� />
<value name="windows2000" title="Windows 2000 /><value name="linux" title="Linux" /><value name="macosx" title="MacOSX� />
</attribute></conditions>
![Page 313: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/313.jpg)
153
Content references (conrefs)
Standard DITA element attributeReferences another element of same typeOn output, content from referenced element substituted for the conref elementSimilar to FrameMaker �text insets�Analogous to referencing an image file
![Page 314: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/314.jpg)
154
Content references in XMetaL
Content shown in conref is:Read-onlyUpdated when a document is opened
To manually refresh:Click Edit > Refresh All ReferencesOr press F11
![Page 315: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/315.jpg)
Working with content references
Open a document containing a content referenceRight-click to switch between viewing local content and referenced content
Local content is highlighted in yellow
155
![Page 316: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/316.jpg)
Reusable components
Reusable components:Managed snippets of XMLHave titles, short descriptions, and reusable-content.
One reusable component per fileClick Reuse > Create Reusable ComponentXMetaL only; not transportable
156
![Page 317: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/317.jpg)
Reuse strategiesReuse Opportunity Solution
Multiple similar deliverables Flag some content as conditional
Piece of content used in many different contexts
Include it in different topics using content references
(Modular reuse)
Topic used in many different deliverables
Include it in different deliverables through DITA maps
(Modular reuse)
157
![Page 318: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/318.jpg)
11/03/08 158
Workbook Exercise:Reusing Content
158
![Page 319: XMetaL DITA Workshop](https://reader034.vdocuments.mx/reader034/viewer/2022042510/555670f6d8b42abc5a8b4cf5/html5/thumbnails/319.jpg)
Additional resources
DITA Users group on Yahoo! groups:http://tech.groups.yahoo.com/group/dita-users/XMetaL-DITA group on Yahoo! groups:http://tech.groups.yahoo.com/group/xmetal-dita/dita.xml.org www.justsystems.com (webinars, events)
159