DITA

Specifications
OASIS TC

Cover page information
Notices
Introduction
Topic and map document types
Usage of glossary entry topics
- Rendering of abbreviated-form elements
- Localization and the abbreviated-form element
Element reference
- Elements, A to Z
- Topic and map specializations
  - Book map elements
    - Book map content elements
      - abbrevlist
      - amendments
      - appendices
      - appendix
      - backmatter
      - bibliolist
      - bookabstract
      - booklibrary
      - booklist
      - booklists
      - bookmap
      - booktitle
      - booktitlealt
      - chapter
      - colophon
      - dedication
      - draftintro
      - figurelist
      - frontmatter
      - glossarylist
      - indexlist
      - mainbooktitle
      - notices
      - part
      - preface
      - tablelist
      - toc
      - trademarklist
    - Book map metadata elements
      - approved
      - bookchangehistory
      - bookevent
      - bookeventtype
      - bookid
      - bookmeta
      - booknumber
      - bookowner
      - bookpartno
      - bookrestriction
      - bookrights
      - completed
      - copyrfirst
      - copyrlast
      - day
      - edited
      - edition
      - isbn
      - maintainer
      - month
      - organization
      - person
      - printlocation
      - published
      - publisherinformation
      - publishtype
      - reviewed
      - revisionid
      - started
      - summary
      - tested
      - volume
      - year
  - Concept elements
  - Glossary entry elements
  - glossgroup
  - Reference elements
    - propdesc
    - propdeschd
    - properties
    - property
    - prophead
    - proptype
    - proptypehd
    - propvalue
    - propvaluehd
    - refbody
    - refbodydiv
    - reference
    - refsyn
  - Task elements
    - chdesc
    - chdeschd
    - chhead
    - choice
    - choices
    - choicetable
    - choption
    - choptionhd
    - chrow
    - cmd
    - context
    - info
    - postreq
    - prereq
    - result
    - step
    - stepresult
    - steps
    - steps-informal
    - stepsection
    - steptroubleshooting
    - steps-unordered
    - stepxmp
    - task
    - taskbody
    - tasktroubleshooting
    - tutorialinfo
  - Troubleshooting elements
- Domain specializations
  - Abbreviated-form domain elements
    - abbreviated-form
  - Equation domain
  - Glossary-reference domain elements
    - glossref
  - Hardware domain
    - hwcontrol
    - partno
  - Markup domain
    - markupname
  - MathML domain
    - mathml
    - mathmlref
  - Programming domain
    - apiname
    - codeblock
    - codeph
    - coderef
    - option
    - parmname
    - parml
    - plentry
    - pt
    - pd
  - Release management domain
  - Software domain
    - cmdname
    - filepath
    - msgblock
    - msgnum
    - msgph
    - systemoutput
    - userinput
    - varname
  - SVG domain
    - svg-container
    - svgref
  - Syntax diagram domain
    - delim
    - fragment
    - fragref
    - groupchoice
    - groupcomp
    - groupseq
    - kwd
    - oper
    - repsep
    - sep
    - synblk
    - synnote
    - synnoteref
    - synph
    - syntaxdiagram
    - var
  - User interface domain
    - menucascade
    - screen
    - shortcut
    - uicontrol
    - wintitle
  - XML mention domain
    - numcharref
    - parameterentity
    - textentity
    - xmlatt
    - xmlelement
    - xmlnsname
    - xmlpi
Conformance
Acknowledgments
Aggregated RFC-2119 statements
Attributes
Element-by-element recommendations for translators
Revision history

Troubleshooting elements

Troubleshooting elements provide the fundamental structure for troubleshooting topics. Troubleshooting topics describe problems and provide information about how to fix them.

cause
The <cause> element describes a potential source of the problem that is addressed by the troubleshooting topic.
condition
The <condition> element describes a state that the troubleshooting topic is intended to remedy. This information helps the user decide whether a troubleshooting topic might contain an applicable remedy for a problem.
diagnostics
The <diagnostics> element contains information that helps readers determine the cause of a problem.
diagnostics-general
The <diagnostics-general> element includes non-procedural information that can help determine the causes of a symptom. Results of the diagnoses might link to possible solutions.
diagnostics-steps
The <diagnostics-steps> element includes step-by-step information that can help readers determine the causes of a symptom. Results of the diagnostic steps might link to potential solutions.
remedy
The <remedy> element contains steps that are a potential solution for a problem. In addition, it also might contain information about the person or team who can perform the task.
responsibleParty
The <responsibleParty> element identifies the individual or team whose task it is to perform a remedy procedure. It also can provide important information about the qualifications that the person or team must have.
troublebody
The <troublebody> element contains the main content of the troubleshooting topic. The troubleshooting body can contain information about the condition, how to diagnose the cause, and one or more possible solutions.
troubleshooting
The <troubleshooting> element is the top-level element for a troubleshooting topic. Troubleshooting topics provide information that enables readers to identify a condition, diagnose a cause, and potentially fix the problem.
troubleSolution
Each <troubleSolution> element contains information about the cause of a problem and a potential remedy.

Parent topic: Topic and map specializations

Related concepts

Troubleshooting

Report an Issue · Colophon