DITA Flashcards
(140 cards)
1
Q
What does DITA stand for?
A
Darwin Information Typing Architecture
2
Q
What file type organises dita topics?
A
Dita maps
3
Q
What is the basic building block for DITA information?
A
The topic
4
Q
What are the 3 basic DITA topic types?
A
Concept (what is?)
Task (how to?)
Reference (reference)
5
Q
What are the 2 types of references most commonly used in DITA?
A
Key reference (product names, etc.) Content reference (warnings, notices, etc.)
6
Q
Who created DITA and when?
A
IBM created DITA in 2005. It was donated to OASIS
7
Q
What language is DITA based on?
A
XML
8
Q
What provides additional information about a XML tag?
A
Attributes and its value
tag attribute=”value” /tag
9
Q
Where are XML tags defined?
A
In a different file
10
Q
What are called tag names in DITA?
A
Elements
11
Q
What is the name of the 3 most common root tags in DITA?
A
Concept, task, reference
12
Q
What is a necessary attribute for a topic tag?
A
id (ex: topic id=”sample”)
13
Q
What element provides a 2-3 sentence summary of the topic content?
A
shortdesc
14
Q
What element provides the title of a topic?
A
title
15
Q
What element provides the bulk of information of a topic?
A
body
16
Q
What are the two task types provided by DITA?
A
Strict task
General task
17
Q
What is information about information called?
A
Metadata
18
Q
What is a common attribute to include language of a topic?
A
xml:lang=”en-us”
Ex: topic id=”123” xml:lang=”en-us”
19
Q
What element allows you to store metadata for the entire topic?
A
prolog
20
Q
What is used to specify metadata on the element level?
A
attributes
21
Q
On the map level, where do you specify the metadata of a referenced topic?
A
topicref
ex: topicref href=”abc.dita” audience=”novice”
22
Q
What are the 3 default attribules that support filtering or conditional processing?
A
Audience
Product
Platform
23
Q
What does a basic DITA topic require?
A
XML declaration (?xml version=”1.0” encoding=”UTF-8”?)
DOCTYPE declaration !DOCTYPE topic PUBLIC “-//OASIS//DTD DITA Topic//EN” “topic.dtd”
A topic topic id=”myfirsttopic”
id attribute on the topic id=”myfirsttopic”
Title title Hello world /title
24
Q
What element lets you create notes, cautions, warnings, and other admonishments
A
note
25
What are the most common list types in DITA?
```
unordered list ( ul)
ordered list ( ol )
```
26
What are the 2 types of tables included in DITA?
```
Simple tables (simpletable)
Tables (table)
```
27
What are the 3 possible elements in simple tables?
sthead
strow
stentry
28
In a ditamap, what element provides a link to a specific topic?
topicref
29
In a ditamap, what element provides a link to another map?
mapref
30
In what language are most stylesheets of the DITA Open Toolkit written in?
XSL (Extensible Stylesheet Language)
31
What element is used to create links from text to other locations in text, figures, tables or websites?
xref href="target"
32
What is safer than using xref?
Relationship tables (reltables)
33
Where are reltables located?
In the map file (usually at the end)
34
What element is used to reuse pieces of content?
conref
35
What is the DOCTYPE statement used for?
To identify the topic type (ex. Concept, task, etc.)
36
What is the ?xml statement used for?
Identify the file as an xml file
37
Should the ol element be used for step-by-step instructions?
No! The Task topic should be used instead
38
What attribute is used by the image element to create a link to the image's location?
href
39
What element is used to add a caption to an image?
fig
40
What element is used to give a definition?
term
41
What element is used for a citation?
cite
42
What element is used for a word or phrase that may change based on the user's circumstances?
varname
43
What element is used for subscript text?
sub
44
What element is used for superscript text?
sup
45
What element is used to add a footnote?
fn
46
What element is used to indicate the order of a menu path?
menucascade
| then uicontrol
47
What elements contains a definition list (a list of terms with their corresponding definition)
dl (definition list)
dlentry (definition entry)
dt (definition term)
dd (definition definition)
48
What element is used to write pieces of code?
codeblock
49
What element is used to mark a single word or phrase as code inside a p element?
codeph (codephrase)
50
What element is used to include a quote from an outside source?
lq (long quote)
51
What element is used to divide body of a topic into subsections with individual titles?
section
52
What element allows the creation of a comment in the DITA code that won't be rendered in the final transformation?
draft-comment
53
What element allows to wrap content that is tagged incorrectly?
required-cleanup
54
What optional element in a task describes what the reader needs before performing the task?
prereq
55
What optional element in a task provides background information about the task, like its purpose, etc.
context
56
What are the 4 main elements of steps within a task?
steps
step
cmd
info
57
What is an essential element of a step?
cmd
58
What is an optional element of a step?
info
59
What type of voice should be used in a cmd element?
Active voice
60
What do strict tasks only allow a single steps tag?
To ensure that the topic only describes how to perform one task
61
How many sentences should a cmd tag have in order to follow best practices?
One
62
In a task, how many info tags can be added after a cmd element?
Any number
63
What elements can be used when listing choices to the reader?
choices
| choicetable
64
What element is used to add more detail to a step?
substeps
65
What element can be used to give step examples on how to perform a step in a task topic?
stepxmp
66
What element is used to describe the result of a step?
stepresult
67
What element is used to add comments between two steps in a task topic?
stepsection
68
What two elements can be used to add admonitions to the reader before a cmd element of a step in a task?
note
| hazardstatement
69
What element is used to describe a completed task?
result
70
What element is used to show an example of an entire task?
example
71
What element tells you what to do once a task is completed?
postreq (postrequisites)
72
To what question do Reference topics answer?
What?
73
To what question does the Concept topic answer?
Why?
74
To what question does the Task topic answer?
How?
75
What 2 refbody elements are specific to the reference topic?
refsyn
| properties
76
What element denotes the name of a command when referenced as a part of software?
cmdname
77
In the Reference topic type, what element used for code syntax is a specialization of the section element
refsyn
78
What elements are the preferred way to show syntax diagrams in the refsyn element?
synph (syntax phrase)
| syntaxdiagram
79
What are the 4 most common sub-elements of the properties element?
property
proptype
propvalue
propdesc
80
The properties element is a specialization of what element?
simpletable
81
How do you call an element related to a specific field (like programming, etc)?
domain element
82
What topic type should be used to define a specific term or concept contained within your content?
Glossary entry topic
83
How do you call a file with multiple glossary entry topics?
glossary group
84
What is the root element of a glossary entry topic?
glossentry
85
What element is a glossterm a specialization of?
title
86
It is best practice to add what before the filename of a glossary entry?
g_
87
Where is it better to gather all glossary topics?
in a dita map file
88
What element is used to add a topic inside a map?
topicref
89
Where should maps be stored on your file system?
At the top level, since topicrefs cannot link to topics located above the map level.
90
What is the difference between a map and a bookmap?
Bookmaps provide elements to create book-like structures. (chapters, appendices, parts)
91
When is it generally preferable to use bookmaps instead of maps?
When your content is in print or PDF form.
92
What is the bookmap's frontmatter element typically used for?
table of contents or preface
93
What is the bookmap's backmatter element typically used for?
index or glossary
94
How many bookmap chapters can be nested inside bookmap chapters?
0
95
What element is used to add metadata to maps?
topicmeta
96
Which metadata takes precedence over the other, a topic metadata defined in a map's topicref, or the referenced' topic file's metadata (e.g., prolog)?
The metadata defined in a map's topicref
97
What frontmatter and backmatter element can be used for toc, indexlist or glossarylist?
booklists
98
What element inside the booklists element of a bookmap is used to say where to generate a table of contents?
toc
99
What bookmap element is used to generate an index at that location within the map?
indexlist
100
What element of a bookmap is used to change the title of a reused topic?
navtitle
101
What attribute of topicref in a bookmap should you change in order to use the navtitle element?
locktitle="yes"
102
Why is the topichead element useful?
It helps you group topics together that are contextually related without implying a hierachical relationship
103
In what element can you find a reltable?
map or bookmap
104
Where are reltables located inside a map?
at the very end, just before the map or bookmap closing tag
105
In a reltable, what relcell attribute can be used to make the reltable cell topics relate one another?
collection-type="family"
106
What attribute of a topicref in a reltable makes this topic only the target of other topics (i.e., you can have a link to topic B, but topic B will not have any links to other topics)
linking="targetonly"
107
What attribute of a topicref in a reltable prevents this topic from being a target for other topics?
linking="sourceonly"
108
How do you override the link types of recolspecs in reltables?
by adding a title tag in the relcospec element
109
What are the different reuse facilities offered by DITA?
topics and maps
fragments (conref)
variables (keys)
filtering (conditions)
110
What type of reuse involves pulling shared pieces of content, usually elements?
Fragment (conrefs)
111
What type of reuse is best suited for company names, product names, URLs, or filenames?
Variables (keys)
112
What type of reuse is best suited to selectively remove certain pieces of content, based on different conditions, to create product- or customer-specific deliverables?
Filtering (conditions)
113
What attribute do you need to use when you reuse a topic multiple times in a single map?
copy-to="first_copy.dita"
| copy-to="second_copy.dita
114
What element could be the best example of a reusable element using a conref?
note
115
What are the two parts of a conref?
a referenced element
| a referencing element
116
What attribute is necessary for conref referenced elements?
ID
117
What are the four basic conditional attributes used for content filtering?
audience
platform
product
otherprops (custom aspect)
118
How do you specify multiple values in attributes for content filtering?
use space
119
What file is used to indicate which attributes and values to filter out of your content?
ditaval files
120
In DITA 1.3, what element within a map is used to include a ditaval file?
ditavalref
121
What is the root element of a ditaval file?
val
122
What is the main child element of a val tag?
prop (prop att="platform" val="iphone" action="exclude" /)
123
In a ditaval file, what element can be used to add images bofore and after a flagged element?
startflag
| endflag
124
Where is the final value for a key defined?
In a DITA map
125
What element defines keys in a ditamap?
keydef
126
What attribute references a key?
keyref
ex: image keyref="product_image"/
ph keyref="product_name"/
127
What elements must you nest inside a keydef that will contain a text string?
keydef
topicmeta
keywords
keyword
128
What 3 elements can reference a string of text?
ph
term
keyword
129
What content reference element uses a key instead of a file path?
conkeyref
130
How do you call folders and files containing topics and maps destined to be reused?
Warehouses
131
What element is used to pull a sequence of two or more elements into a topic?
conrefend and conref
132
What conref attribute allows you to "push" content into a topic of the same map?
conaction="pushreplace"
conaction="pushbefore"
conaction="pushafter"
133
What attribute of a topicref in a map should be used to avoid displaying a specific topic?
processing-role="resource-only"
134
What is the difference between a conref and a conkeyref attribute?
conref references an element's id
| conkeyref references an element's key
135
Why should you use a conkeyref?
They make your topic reusable
136
What does CCMS stand for?
Component Content Management System
137
What is DITA's open source publishing tool?
DITA OT
138
What can be used to change the Look-and-feel of default DITA-OT publishes?
Custom plugins
139
What knowledge is required to customize or update custom plugins?
Ant, XSL and DTD for the base
| XHTML, JavaScript and XSL-FO for the output
140
What document type can be used to simply change the output style?
CSS
