The DITA Style Guide Best Practices for Authors

-dita-use-conref-target attribute value [1] [2]

abbreviated-form element [1]

abstract [1] [2]

accessibility [1]

acronyms [1]

action [1] [2]

action attribute [1]

adoption

aesthetical style [1]

agnostic

align attribute [1] [2]

alt attribute [1]

alternative short description [1]

alternative text [1]

ampersand character [1] [2]

ancestor [1]

animation [1]

apiname element [1]

applets [1]

architecture [1]

area element [1]

arguments [1]

ASCII [1]

assembly [1]

attributes [1]

audience attribute [1] [2] [3]

author comments [1]

author element [1]

authorial style [1]

automatic linking [1] [2]

automatically-generated links [1] [2]

back matter

backslash character [1] [2]

base content model [1] [2] [3] [4]

best practice [1]

block elements [1]

BMP [1]

body elements [1]

bodydiv element [1]

book [1]

bookmap [1]

bookmap element [1]

BookMaster [1]

bookmeta element [1]

booktitle element [1]

brand element [1]

breadcrumbs [1]

broken link [1]

bullet lists [1] [2]

buttons [1]

callouts [1] [2]

capitals [1]

Caroll, John [1]

cascades

cascading style sheets [1]

case [1]

case-sensitive

categories of elements [1]

category names [1]

cautions within steps [1]

char attribute [1]

character escapes [1]

charoff attribute [1]

chdesc element [1]

chdeschd [1]

chhead element [1]

choice element [1]

choice list [1]

choices element [1]

choicetable element [1] [2]

choicetables [1]

choption element [1]

choptionhd element [1]

chrow element [1]

chunk attribute [1] [2]

chunking [1] [2] [3] [4]

class attribute [1]

cmd element [1] [2]

cmdname element [1]

CMS [1] [2]

codeblock element [1] [2]

codeph element [1]

coderef element [1]

cohesion [1]

collection [1]

collection-type attribute [1] [2] [3] [4]

colsep attribute [1]

colspec element [1]

colwidth attribute [1]

command [1]

command syntax [1]

comments [1] [2]

company names [1]

complex tables [1]

complex tasks [1]

component element [1]

composite information type [1]

composite topics [1] [2] [3] [4] [5] [6]

computer keyboard [1]

conaction attribute [1]

concept information type [1]

concept topic [1]

condition attributes [1] [2] [3] [4]

conditional processing [1] [2] [3] [4] [5] [6] [7] [8] [9]

conditional publishing [1] [2] [3] [4]

conkeyref attribute [1] [2]

connected blocks [1]

conref [1] [2] [3] [4] [5] [6] [7]

conref attribute [1] [2] [3] [4] [5] [6] [7] [8]

conrefend attribute [1]

constraints [1] [2] [3] [4]

content assembly [1]

Content Management System [1] [2]

content model [1] [2] [3] [4] [5]

content re-use [1] [2] [3]

content reference [1] [2] [3]

context [1] [2]

context element [1]

context-agnostic writing [1] [2] [3]

controlled values [1]

controlling element choices [1]

conventions

coords element [1]

copy-to attribute [1]

copyrholder element [1]

copyright element [1]

copyryear element [1]

created element [1]

critdates element [1]

critical dates [1]

cross-references [1] [2] [3] [4] [5] [6]

CSS [1] [2] [3]

dangling topicref [1]

Darwin, Charles [1]

Darwinian Theory [1]

data element [1]

data vs metadata [1]

data-about element [1]

date attribute [1]

date format [1]

dates [1]

Day, Don [1]

dd element [1]

default topic [1]

definition

definition lists [1] [2] [3]

definitions [1]

delim element [1]

delimiting attribute values [1]

deliverable document [1]

department names [1]

dependent block elements [1]

desc element [1]

dialects [1]

dialogue [1]

directory names [1] [2]

disambiguation [1]

DITA

dita information type [1]

DITA Maturity Model [1]

DITA Technical Committee [1] [2]

ditabase [1] [2] [3] [4] [5] [6]

ditabase information type [1]

ditamap [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

ditamap elements [1]

ditaval [1] [2] [3] [4]

div elements [1]

dl element [1] [2]

dlentry element [1]

DocBook [1]

Document Development Life Cycle [1] [2]

documentation process [1]

domain elements [1]

domain specialisation [1]

domains [1] [2]

draft-comment element [1] [2]

dt element [1]

DTD [1] [2]

Dublin Core Metadata [1]

duplicate semantic element names [1]

duplicate topics [1]

dynamically-merged Help [1]

e-mail addresses

Eberlein, Kris [1]

Eclipse Help [1] [2]

element domains [1] [2]

element naming [1]

elements

embedded ditamaps [1] [2]

embedded links [1]

embedded topics [1]

English

Enter key [1]

entities [1] [2]

entry element [1]

enumerated attribute values [1]

enumerated list [1]

enumeration [1]

EPS [1]

escape characters [1] [2]

evolution [1]

example topic [1] [2] [3] [4] [5] [6]

examples

excluding [1]

exemplar

exemplar topic [1] [2] [3] [4] [5] [6] [7] [8] [9]

expiry attribute [1]

extensions

external

featnum element [1]

fig element [1] [2] [3] [4] [5] [6]

figure

figures [1] [2] [3] [4]

file extensions [1]

file formats

file management

file naming [1] [2] [3]

file structure

filtering [1] [2] [3] [4] [5] [6] [7] [8] [9]

finding re-use elements [1]

flagging [1] [2] [3]

Flash [1]

fn element [1]

folder names [1] [2]

folder structure [1]

footnotes [1]

foreign words and phrases [1]

format attribute [1]

format vs style [1]

formatting conventions

frame attribute [1]

front matter

general task information type [1] [2] [3]

generalisation [1] [2]

generated links [1] [2] [3] [4]

GIF [1]

glossary entry information type [1]

glossary of terms [1] [2]

glossentry information type [1]

glossref element [1] [2] [3]

glue text [1] [2]

golive attribute [1]

granularity [1] [2] [3]

graphics [1] [2]

group of elements

GUID [1]

hacks [1] [2]

headings [1] [2]

height attribute [1]

Help systems [1]

Hennum, Erik [1]

hexadecimal character references [1]

hierarchical links [1] [2]

hierarchy [1] [2] [3]

highlighting domain [1]

history of DITA [1]

home topic [1]

Horn, Robert [1]

hotspot graphics [1]

hover text [1]

href attribute [1] [2] [3] [4] [5] [6]

HTML

Hughes, Mike [1]

human languages [1]

Hunt, John [1]

hypergraphics [1] [2]

hyperlinks [1] [2] [3] [4]

hyphenation [1]

id attribute [1]

ID Doc [1]

identifying information types [1]

IETF [1]

IETF BCP 47 [1]

illustrations [1]

image element [1] [2] [3] [4] [5] [6] [7]

image file management [1]

image maps [1] [2]

imagemap element [1]

images [1] [2]

importance attribute [1] [2] [3]

in-line links [1]

in-text links [1]

index-see element [1]

index-see-also element [1]

indexes [1] [2]

indexing [1]

indexterm element [1] [2]

indirection [1] [2] [3] [4]

info element [1] [2] [3]

information architecture [1]

Information Mapping [1]

information types [1] [2] [3] [4]

inheritance [1] [2]

inline elements [1]

inline images [1]

intellectual property [1]

Internet

inverted commas [1] [2]

ISO 639 [1]

Java applets [1]

keyboard [1]

keycol attribute [1] [2] [3]

keydef element [1] [2]

keyref attribute [1] [2] [3] [4]

keys

keys and labels [1]

keys attribute [1] [2] [3]

keystrokes [1]

keyword element [1] [2] [3]

keywords element [1]

kwd element [1] [2]

labelling [1] [2] [3] [4]

labels [1]

language tags [1]

languages

lead-in sentences [1] [2]

leader lines [1]

legends [1]

length

letter case [1]

levels of DITA adoption [1]

life cycle [1]

limiting element choices [1]

line breaks [1] [2] [3]

lines [1]

link element [1] [2] [3]

link preview [1]

linkinfo element [1]

linking [1] [2] [3] [4]

linking attribute [1] [2]

linking protocol [1] [2]

linking relationships [1] [2]

linklist element [1]

linkpool element [1]

links [1] [2] [3]

linktext

linktext element [1] [2]

list elements [1]

list items [1]

lists [1] [2]

localisation [1]

localising graphics [1]

look-and-feel [1]

lq element [1] [2] [3]

management of content [1]

managing DITA content [1]

mandatory elements [1]

mandatory steps [1]

manifest [1] [2]

map [1]

map element [1] [2] [3]

map element in HTML [1]

map elements [1]

map file

map headings [1]

map structure [1]

mapref element [1] [2]

maps [1]

mark-up domains [1]

mark-up languages [1]

master-slave Help systems [1]

merge Help [1]

messages

metadata [1]

metadata attributes [1] [2] [3] [4] [5]

metadata domain [1]

metadata element [1]

metadata elements [1]

metadata vs data [1]

minimalism [1] [2]

mixed content [1] [2]

modified attribute [1]

modular [1] [2]

modular Help [1]

mother-of-all-topics [1]

movies [1]

MPG [1]

msgblock element [1]

msgnum element [1]

msgph element [1]

multi-level indexes [1]

multimedia [1]

multiple navigation pathways [1]

multiple values in attributes [1]

names

naming conventions [1] [2]

navigation [1] [2]

navref element [1]

navtitle attribute [1]

nested [1]

nested block elements [1]

nested content references [1]

nested ditamaps [1] [2] [3]

nested index entries [1]

nested procedures [1]

nested quotations [1]

nested tables [1]

non-breaking space [1]

non-DITA content in ditamaps [1]

non-sequential steps [1]

note element [1] [2] [3]

notes within steps [1]

number type [1]

numbered lists [1] [2]

numbering

numeric character references [1]

Nurnberg Funnel [1]

OASIS [1] [2] [3]

object element [1]

obsolete

Ockham's Razor [1]

On the Origin of the Species [1]

onlytopic.in.map [1]

open source [1]

open standard [1]

oper element [1]

option element [1]

optional steps [1]

ordered lists [1] [2]

organisation of elements [1]

organising re-use [1]

otherprops attribute [1] [2] [3] [4]

output [1]

output styling [1]

outputclass attribute [1] [2] [3]

overriding topic metadata in the ditamap [1]

page number references [1]

page numbering [1]

page references [1]

pagination [1]

paragraphs [1]

parameter lists [1]

parameters [1]

parent topics [1] [2]

parent-child links [1] [2] [3]

parent-child relationships [1]

parml element [1] [2]

parmname element [1]

pd entry [1]

PDF

peer [1]

pgwide attribute [1]

ph element [1] [2] [3]

ph versus text [1]

photo credits [1]

phrase elements [1]

phrase mark-up in titles [1]

picking list [1]

placement attribute [1]

platform attribute [1] [2]

platform element [1]

plentry element [1]

PNG [1]

poetry [1]

postreq element [1]

pre-formatting text [1]

pre-requisites [1]

prereq element [1] [2] [3]

presentational style [1]

preventing automatic linking [1]

preview text [1]

previews

Priestley, Michael [1] [2]

print attribute [1] [2] [3]

print only content [1]

print vs non-print [1]

priority [1]

procedures [1] [2] [3]

processes [1] [2] [3]

processing

processing output [1]

processing-role attribute [1]

processors [1]

prodinfo element [1]

prodname element [1]

product attribute [1] [2] [3]

product names [1]

profiling [1]

prognum element [1]

program names [1]

programming code [1]

programming domain [1] [2]

programming domain elements [1]

project names [1]

project planning [1]

prolog element [1]

prolog elements [1] [2]

properties element [1]

props attribute [1]

proto information type [1]

protocol [1] [2]

pt entry [1]

publication [1]

publisher element [1]

publishing

punctuation [1]

push [1]

q element [1] [2]

QuickTime [1]

quotation marks [1] [2]

quotations [1] [2]

re-use [1] [2] [3] [4] [5]

reducing element choices [1]

redundant elements [1]

refcols attribute [1]

reference information type [1]

reference topic

referenced element [1]

referenced elements [1]

references [1]

referencing element [1]

registered trademark [1]

related topic links

related topics [1]

related-links element [1] [2] [3] [4]

related-links elements

relationship links [1]

relationship table [1] [2] [3] [4] [5]

relcell element [1] [2] [3]

relcolspec element [1] [2]

relheader element [1]

relrow element [1]

reltable [1] [2] [3] [4] [5] [6]

rendering engines [1]

replacement domains [1]

required-cleanup element [1] [2]

resources

restricting available elements [1]

result element [1]

rev attribute [1] [2]

review comments [1]

revised element [1]

Rockley, Manning, et al [1]

role of a style guide [1]

row element [1]

row headings [1]

rowheader attribute [1]

rowsep attribute [1]

S1000D [1]

sample bookmap [1]

sample code [1]

sample topic [1] [2] [3] [4] [5] [6] [7]

samples

scale attribute [1]

scaling images [1]

Scent of Information [1]

Schell, Dave [1]

schema [1]

scope attribute [1] [2] [3] [4]

secondary index entries [1]

section element [1]

section vs topic [1] [2]

sectiondiv element [1]

sections [1] [2]

segmented hypergraphics [1]

select attributes [1] [2] [3] [4]

semantic mark-up [1]

semantics [1]

sep element [1]

separation of content and form [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

sequence [1]

serial commas [1]

series element [1]

service mark [1]

set of elements

SGML [1] [2] [3]

shape element [1]

short description [1] [2] [3]

shortdesc [1] [2] [3]

shortdesc element [1] [2] [3] [4]

simple lists [1] [2]

simple tables [1]

simpletable element [1] [2] [3] [4]

single sourcing

single step procedure [1]

size

skills [1]

slash character [1] [2]

SMB [1] [2]

snippets [1] [2]

software domain [1] [2]

software domain elements [1] [2]

source element [1] [2]

span

special characters [1]

special formatting of elements [1]

specialisation [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

specialisation elements [1]

Spool, Jared [1]

stages of the documentation process [1]

standard

status attribute [1]

STC [1]

stem sentences [1] [2] [3] [4] [5]

stem topic [1]

step element [1] [2] [3] [4]

step references [1]

stepresult element [1]

steps [1]

steps element [1] [2]

steps-informal element [1]

steps-unordered element [1]

stepxmp element [1]

STOP [1]

strict task information type [1]

structural specialisation [1]

structure

structure of files and folders [1]

structured authoring

structured writing [1]

stub content [1]

stub topic [1] [2]

style vs format [1] [2]

styles

subjectScheme element [1]

submaps [1]

subordinate block elements [1]

subordinate topic preview [1]

subordinate topics [1]

substep element [1] [2]

substeps element [1] [2]

summary topics [1]

SVG [1] [2] [3]

SWF [1]

Swope, Amber [1]

symbols

synblk element [1]

synph element [1] [2]

syntax

system messages [1]

systemoutput element [1]

Tab key [1]

table cells [1]

table domain elements [1]

table element [1] [2] [3] [4] [5]

table entries [1]

Table of Contents [1]

tables [1] [2]

tabular information [1]

tag abuse [1]

task [1]

task information type [1] [2]

task topic [1] [2] [3] [4] [5]

team [1]

term element [1] [2]

terms [1]

text element [1]

text fragments [1]

text versus ph [1]

TIF [1]

title element [1] [2] [3] [4] [5] [6] [7]

titles [1] [2]

tm element [1] [2]

TOC [1]

toc attribute [1]

tool tips [1]

top node in TOC [1]

topic [1]

topic element [1]

topic elements [1]

topic headings [1]

topic hierarchy

topic information type [1]

topic previews [1]

topic references

topic structure [1]

topic title [1]

topic types [1]

topic vs section [1]

topic-based authoring [1] [2] [3]

topical information unit [1]

topical unit of discourse [1]

topicgroup element [1] [2]

topichead element [1] [2] [3]

topicmeta [1] [2] [3]

topicmeta element [1] [2] [3]

topicref element [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

trademark [1]

transclusion [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

transitional information [1] [2]

translation [1] [2] [3]

type attribute [1] [2] [3] [4] [5]

typographic domain [1] [2]

typographical domain elements [1]

underscores in file names [1]

Unicode [1] [2]

unique identifiers [1]

unit of discourse [1]

unit testing [1]

unordered lists [1] [2]

upper case [1]

URI [1] [2] [3]

URL [1] [2] [3]

user input [1]

user interface controls [1]

user interface domain [1] [2]

user interface domain elements [1]

user interface messages [1]

utilities domain [1] [2]

utilties domain elements [1]

validation [1]

valign attribute [1]

var element [1] [2] [3]

variables [1] [2] [3] [4] [5] [6] [7]

variants [1]

varieties [1]

varname element [1] [2]

video clips [1]

vrmlist element [1]

WAI [1]

warnings within steps [1]

Web

Web only content [1]

Web vs print [1]

width attribute [1]

windows

work instruction [1]

workarounds [1] [2] [3]

workflow [1]

writing

writing style [1]

XHTML [1]

XML [1] [2] [3]

XML comment [1] [2]

XML languages

xml:lang attribute [1]

xref element [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]

XSD [1] [2]

XSL-FO [1]

XSL-T [1]