Index (Common Desktop Environment: Help System Author's and Programmer's Guide)

Common Desktop Environment: Help System Author's and Programmer's Guide

Previous: Glossary


Numbers and Symbols

	) ( ) ( )

	& (ampersand)
		entity reference ( ) ( )
		used as text character ( )

	* (asterisk), used in list ( )

	! (exclamation mark), used in shorthand markup ( )

	% (percent symbol), used in shorthand markup ( ) ( )

	+ (plus), used in shorthand markup ( ) ( ) ( )

	, used as comment ( )

	... ( ) ( ) ( ) ( )

	(backslash)
		end tag syntax ( )
		used as text character ( )
		used in multiline head ( )

	&copy ( )

	&empty ( )

	(semicolon) ( ) ( )


A

	abbreviating long titles ( )

	abstract for help volume ( ) ( )

	_abstract ID ( )

	actions, help ( )

	alias, used in execution links ( )

	ampersand (&)
		entity reference ( )
		used as text character ( )

	angle bracket ( ( )

	API, list of functions ( )

	apostrophe ( )

	AppDefined parameter ( )

	appearance, determining font scheme ( )

	application-configured, button enabling ( )

	application-defaults file, for dthelpview ( )

	application-defined
		hyperlink ( )
		link, creating ( )

	application entry points, verifying ( )

	application help ( )

	application package ( )

	application program interface, list of functions ( )

	application programmer, collaborating with ( )

	application registration ( )

	arrows ( )

	asterisk (*) , used in list ( )

	audience
		knowing ( )
		writing for international ( )

	author
		collaboration with application programmer ( )
		responsibilities ( )
		workflow ( )


B

	backslash ()
		to create a multiline head ( )
		used as text character ( )
		used in end tag ( )

	bitmap ( )

	blank leader ( )

	bold font ( )

	book title, creating ( ) ( )

	break, forcing line ( )

	browser help volume
		adding your help to ( )
		creating ( )
		defined ( )
		displaying ( )

	bullet
		entity name for ( )
		parameter in list ( )
		used in list ( )

	bulleted list ( )

	button, application-configured ( )

	buttons, navigation ( )


C

	callback
		adding close callback ( )
		adding help callback ( )
		close callback example ( )
		hyperlink, providing ( )

	caption, figure ( )

	card suit symbols ( )

	caution statement, adding ( )

	CDE Help System, introduction to ( )

	CDE HelpTag markup reference ( ) ( )

	chapter
		creating ( )
		in topic hierarchy ( )

	character, inserting special ( ) ( ) ( )

	character set
		defined ( )
		names of supported sets ( )

	checklist
		application programmer's ( )
		author's ( )
		internationalized help ( )
		product integrator's ( )
		product preparation ( )

	class, dialog widgets ( )

	clean parameter ( )

	CloseHelpCB() ( )

	column heading in labeled list ( )

	command
		dthelpgen ( )
		dthelpview ( )
		gencat ( )
		summary of help commands ( )

	command, Using Help menu ( )

	command variable, marking ( )

	comment, inserting ( ) ( )

	components, in help volume ( )

	computer, displaying input/output ( ) ( )

	continue parameter ( )

	copying Help4Help source files ( )

	copyright
		entity name of ( )
		notice ( ) ( )
		predefined help ID ( )
		used in meta information ( )

	_copyright ID ( ) ( )

	correcting errors ( )

	creating
		application-defined link ( )
		definition link ( )
		figure ( )
		file entity ( )
		general help dialog box ( )
		glossary ( )
		help dialog boxes ( ) ( )
		help family ( )
		home topic ( )
		hyperlink ( )
		index ( )
		language formatting table ( )
		man page link ( )
		message catalog ( )
		meta information topic ( )
		quick help dialog box ( )
		run-time help files ( )
		runtime help files ( )
		structure within topic ( )
		text entity ( )
		topic hierarchy ( )

	creating cross-references ( )

	cross-reference
		ID value ( )
		to list items ( )
		using link element ( )
		using location ID ( )
		using xref element ( )

	current date and time ( )


D

	danger, warning of ( )

	dash character
		em dash ( )
		en dash ( )

	data types, help ( )

	date, current ( )

	definition
		entering in glossary ( )
		of term ( )

	definition hyperlink ( )

	definition link
		creating ( )
		for term ( )

	delivery, preparing for product ( )

	destination
		cross-reference ( )
		hyperlink ( )

	dialog
		detecting when dismissed ( )
		handling event in ( )

	dialog box, creating quick help ( )

	dialog boxes
		creating and managing ( )
		creating general help ( )
		general help ( ) ( )
		quick help ( )

	display, font scheme for ( )

	displaying
		computer input/output examples ( )
		computer literal ( )
		graphics ( )
		help on help ( )
		help topic ( )
		help volume ( )
		inline graphic ( )
		man page ( )
		text file ( )
		text string ( )
		variable ( )

	displays, testing graphics on various ( )

	document title ( )

	Document Type Definition (DTD) ( )

	dotted leader ( )

	draft comment or question ( )

	DtCreateHelpQuickDialog() ( )

	DtHelp.cat ( )

	DtHelp.msg, message catalog source ( )

	DtHelp_TYPE_DYNAMIC_STRING ( ) ( )

	DtHELP_TYPE_FILE ( )

	DtHELP_TYPE_MAN_PAGE ( )

	DtHELP_TYPE_STRING ( ) ( )

	DtHelpDialogCallbackStruct ( )

	DtHelpExecAlias, keyword in execution link ( )

	dthelpgen, command line options ( )

	DtHelpReturnSelectedWidgetId() ( ) ( )

	dthelptag command
		command line options ( )
		run from command line ( )

	dthelpview command
		command line options ( )
		run from the command line ( )

	DtNhelpType ( )

	DtNhelpVolume ( )

	DtNlocationId ( )

	DtNmanPage ( )

	DTTAGOPT environment variable ( )

	dump, X Window ( )


E

	editor, structured ( )

	element
		entering inline ( )
		hierarchical structure ( )
		parameters ( )
		start and end tags ( )
		within topic, adding ID to ( )

	element tag ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( )
		...
			adding topics ( ) ( )
			examples ( )
			topic hierarchy ( ) ( )
		application-defined ( )
		definition link ( )
		examples ( )
		man page ( )
		meta information ( )

	em dash, entity name ( )

	emphasis
		using a note ( )
		using bold font ( )
		using italic font ( )

	empty (no text) ( )

	en-dash, entity name ( )

	end tag ( )

	entities
		multiple source files ( )
		special character ( )
		uses for ( )

	entity
		&empty ( )
		creating file entity ( )
		creating text entity ( )
		declaration ( ) ( )
		examples of ( )
		LanguageElementDefaultCharset ( ) ( )
		LanguageElementDefaultLocale ( )

	entity parameter ( ) ( ) ( )

	entity reference ( )

	entity reference, for special characters ( )

	entry points in application, verifying ( )

	environment variable
		DTTAGOPT, for parser options ( )
		LANG ( )
		system help search path ( )
		user help search path ( )

	errors, correcting ( )

	escape text ( )

	event
		hyperlink, responding to ( )
		in help dialog, handling ( )

	example
		complete standalone help volume ( )
		displayed verbatim ( )
		graphic file entity declarations ( )
		text entity declarations ( )
		using ( )
		using markup in ( )

	examples ( )

	exclamation mark (!)
		used in shorthand markup ( ) ( )

	execution alias
		creating ( )
		used in hyperlinks ( )

	execution hyperlink ( )

	execution link
		control policy ( )
		default behavior ( )

	external file, referencing ( )


F

	F1 (help key) ( )

	family
		definition of ( )
		finding ( )

	family file, creating ( )

	figure
		caption ( )
		creating ( )
		entity ( )
		ID ( )
		including ( )
		number ( )

	file
		displaying text ( )
		DtHelp.cat ( )
		DtHelp.msg ( )
		.htg ( )
		helpchar.ent ( ) ( )
		helptag.dtd ( )
		helptag.opt ( ) ( )
		inserting contents of ( )

	file entity, creating ( )

	FILE parameter ( ) ( )

	files, run-time help, creating ( )

	files, runtime help, creating ( )

	finding help files ( )

	font
		changing to bold ( )
		for computer literal ( )
		italic ( ) ( ) ( )
		scheme, determining actual appearance ( )
		scheme, for display ( )

	font resources, specifying ( )

	foreign language, creating help volume ( )

	formal markup
		caveats ( )
		defined ( )
		Document Type Defintion ( )
		entity declarations ( )
		processing of ( )
		SGML compliance ( )

	formal parameter ( )

	formatting table ( )

	front matter ( )
		uncategorized ( )

	function
		DtHelpReturnSelectedWidgetId() ( ) ( )
		HelpRequestCB() ( ) ( )
		ProcessOnItemHelp() ( )
		XtAddCallback() ( ) ( )


G

	gencat command ( )

	general help dialog box
		creating ( )
		dialog buttons ( )
		features ( ) ( )

	general markup guidelines ( )

	gentity parameter ( ) ( )

	getting help ( )

	ghyperlink parameter ( ) ( )

	glinktype parameter ( ) ( )

	gloss parameter ( )

	glossary
		component of help volume ( )
		creating ( )
		defining term in ( )
		element tag ( )
		term, marking ( )
		term, newly introduced ( )

	_glossary ID ( )

	goals for online help ( )

	gposition parameter ( )

	graphic
		displaying ( )
		displaying inline ( )
		element within text ( )
		formats ( )
		including ( )
		used as a hyperlink ( )
		wrapping text around ( )

	graphics, testing on various displays ( )

	Greek letters ( ) ( )

	group of related volumes, family as ( )

	guidelines, markup ( )


H

	heading
		section ( )
		starting new line ( )

	heading line, continuing ( )

	help
		actions ( )
		data types ( )
		topic organization ( )
		types of access ( )

	help, how users get ( )

	help browser ( )

	help dialog
		detecting when dismissed ( )
		handling events in ( )

	help entry points, required ( )

	help family
		creating ( )
		defined ( )

	help files, finding ( )

	Help4Help
		accessing from application ( )
		copying source files ( )
		helpOnHelpVolume resource ( )
		location of Help4Help volume ( )
		required entry points ( )

	help key ( )

	help menu, providing ( )

	help on help
		accessing ( )
		application resource ( )
		displaying ( )
		in quick help dialog box ( )
		quick help dialog box ( )
		writing volume ( )

	help topic
		adding an ID ( )
		assigning ID names ( )
		defined ( )

	help volume
		components ( )
		creating ( )
		defined ( )
		displaying ( )
		dthelpview command ( )
		overview ( )
		sample markup ( )

	help volume, processing ( )

	helpchar.ent file ( )

	helplang.ent file ( )

	helpOnHelpVolume resource, setting ( ) ( )

	HelpRequestCB() ( ) ( )

	helptag.dtd file ( )

	helptag.opt file
		memo option ( )
		sample of ( )
		search option ( )

	helptag software ( )

	hierarchy
		adding nonhierarchical topic ( )
		adding topic to ( )
		organizing elements ( )
		topic, creating ( )

	history, help ID for History dialog box ( )

	home topic
		creating ( )
		defined ( )
		in topic tree list ( )
		menu command ( )
		predefined help ID ( )

	_hometopic ID ( )

	horizontal space ( )

	.htg file ( )

	hyperlink
		application-defined link ( )
		attribute in link element ( )
		callback ( )
		callback, providing ( )
		creating ( )
		definition link ( )
		destination ( )
		display formats ( )
		event, responding to ( )
		execution link ( )
		jump type ( )
		man page link ( )
		types ( )
		validating hyperlinks ( )

	hyperlink parameter ( ) ( ) ( )

	HyperlinkCB() ( )


I

	ID
		adding to element within topic ( )
		adding to topic ( )
		figure ( )
		in list ( )
		naming rules ( )
		predefined names ( )
		used in ( )

	ID parameter
		in ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( )
		in ... ( )
		in element ( )

	indent parameter
		for image element ( )
		for paragraph element ( )

	index
		creating ( )
		help ID for Index Search dialog box ( )
		help ID for Search Volume Selection Dialog box ( )
		Index search dialog index ( )
		marking entry ( ) ( )
		providing index-search ID ( )
		sort order ( )

	information, meta ( )

	information model, help ( )

	inline elements, entering ( )

	inline elements, entering ( )

	inline graphic, displaying ( )

	input files, multiple ( )

	inserting
		comment ( )
		contents of another file ( )
		special character ( )
		writer's memo ( )

	installation package ( )

	international audiences, writing for ( )

	introduction to Help System ( )

	italic font ( ) ( ) ( )

	item help
		adding support for ( )
		invoking ( )

	item in list ( )


J

	job of author ( )

	jump type hyperlink ( )


K

	key, enabling help (F1) ( )


L

	labeled list ( )

	LANG environment variable ( )

	language
		foreign ( )
		formatting table ( )
		multibyte ( )

	leader
		blank ( )
		dotted ( )

	line
		continuing heading ( )
		definition spanning more than one ( )
		starting new heading ( )
		wrapping ( )

	line break
		forcing ( )
		within head ( )
		within title ( )

	line breaks, preserving ( ) ( ) ( )

	line endings, preserving ( )

	link
		creating application-defined ( )
		creating definition ( )
		creating execution alias ( )
		creating man page ( )
		hypertext ( )
		to meta information ( )

	list ( ) ( ) ( ) ( ) ( )
		bulleted ( )
		cross reference to item ( )
		entering ( )
		item in ( )
		labeled ( )
		labeled, heading ( )
		leader ( )
		numbered ( )
		plain ( )

	literal, displaying computer ( )

	locale
		creating entity for ( )
		specifying for help volume ( )

	localization ( )

	location IDs, predefined ( )

	loose parameter ( ) ( ) ( )


M

	man page
		creating link ( )
		displaying ( )
		hyperlink ( )

	Man parameter ( )

	managing help dialog boxes ( )

	manual title ( )

	markup
		formal (SGML) ( )
		guidelines ( )
		sample help volume ( )
		shorthand ( ) ( )

	markup language
		formal markup, SGML-compliant ( ) ( )
		shorthand markup ( )

	markup reference ( ) ( )

	math symbols ( ) ( )

	memo, inserting writer's ( )

	memo option ( )

	menu
		Edit ( )
		File ( )
		Help ( )
		Navigate ( )
		providing help menu ( )
		Search ( )

	message catalog
		creating ( )
		DtHelp.msg file ( )
		translating ( )

	meta information ( )
		defined ( )
		topic, creating ( )
		topic, linking to ( )
		volume title ( )

	mode, item help ( )

	model, help information ( )

	MoreHelpCB() ( )

	Motif ( )

	multibyte language support ( )

	multiple lines, definition spanning ( )

	multiple occurrences of same string of text ( )

	multiple source files ( )


N

	native language support
		checklist for authors and translators ( )
		creating online help ( )

	navigation, help buttons ( )

	new line
		forcing start of ( )
		within title ( )

	new paragraph, starting ( )

	nogloss parameter ( ) ( )

	nonhierarchical topic, adding ( )

	nonumber parameter ( ) ( )

	note, adding ( )

	number, figure ( )

	number parameter ( ) ( )

	numbered list ( )


O

	online help, objectives ( )

	online presentation format ( )

	option, memo ( )

	order, keyword index sort ( )

	order parameter ( ) ( )

	OSF/Motif ( )

	overview
		Help graphical user interface ( )
		help volume ( )


P

	paragraph
		indenting ( )
		starting ( )

	parameter
		alias_name ( )
		AppDefined ( )
		bullet ( ) ( )
		clean ( )
		continue ( )
		default_command ( )
		entity ( ) ( ) ( )
		FILE ( ) ( )
		format ( )
		gentity ( ) ( )
		ghyperlink ( ) ( )
		glinktype ( ) ( )
		gloss ( )
		gposition ( )
		hyperlink ( ) ( ) ( )
		ID in ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( )
		ID in ... ( )
		indent ( ) ( ) ( )
		loose ( ) ( ) ( )
		Man ( )
		nogloss ( ) ( )
		nonumber ( ) ( )
		number ( ) ( )
		order ( ) ( )
		plain ( ) ( )
		search ( )
		shortnames ( )
		smaller ( ) ( )
		smallest ( ) ( )
		tight ( ) ( ) ( )
		verbose ( )

	parameters in element ( )

	parser ( )

	parser errors ( )

	percent symbol (%), used in shorthand markup ( )

	perspective, seeing help from user's ( )

	pixmap ( )

	plain list ( )

	plain parameter ( ) ( )

	plus (+) , used in shorthand markup ( ) ( )

	points, entry, verifying in application ( )

	predefined entities ( )

	predefined ID
		_abstract ( )
		_copyright ( )
		_glossary ( )
		_hometopic ( )
		_title ( )

	printing
		dialog box ( )
		help ID for Print dialog box ( ) ( )
		help information ( )
		help topics ( )

	ProcessOnItemHelp() ( )

	product family
		creating ( )
		finding ( )

	product preparation checklist ( )

	programmer, application
		collaborating with ( )
		responsibility ( )

	prompt, user response to computer ( )


Q

	quick help dialog box
		buttons ( )
		creating ( ) ( )

	quotation mark
		double, entity name for ( )
		element for directional quotes ( )
		entity name for straight quotes ( )
		used in shorthand markup ( ) ( )

	quotation marks, printing text within ( )


R

	reference
		entity reference ( ) ( )
		section ( )
		subsection ( )
		to entity ( )

	referencing external file ( )

	registration
		help family ( )
		help volume ( )

	related volumes, family as group of ( )

	requests, responding to help ( )

	reserved IDs ( )

	resource
		DtNexecutionPolicy ( )
		DtNhelpType ( )
		DtNhelpVolume ( )
		DtNlocationId ( )
		DtNmanPage ( )
		helpOnHelpVolume ( )

	resources
		help dialog boxes ( )
		specifying fonts ( )

	responding to
		help requests ( )
		hyperlink event ( )

	responsibility
		author ( )
		programmer ( )

	reviewing
		errors ( )
		help as user will see it ( )

	run-time files, creating ( )

	runtime files, creating ( )


S

	sample application, integrated help ( )

	sample help volume markup ( )

	sample standalone help volume, steps to create ( )

	SDL (Semantic Delivery Language) ( ) ( )

	Search menu ( )

	section
		describing procedure ( )
		heading ( )
		heading within topic ( )
		reference ( )
		subsection within reference ( )
		topic ( )

	Semantic Delivery Language (SDL) ( ) ( )

	semicolon ( ( ) ( )

	SGML, compliance ( )

	shorthand markup ( ) ( )

	shortnames parameter ( )

	smaller parameter ( ) ( )

	smallest parameter ( ) ( )

	sort order, index ( )

	source files, multiple ( )

	space
		horizontal ( )
		significant ( )
		vertical ( )

	spacing, preserving ( ) ( ) ( )

	special characters, list of ( )

	special characters, inserting ( )

	standalone help ( ) ( )

	standalone help volume, sample ( )

	Standard Generalized Markup Language (SGML) ( )

	start tag ( )

	starting new line within title ( )

	starting paragraph ( ) ( )

	string of text
		displaying ( )
		multiple occurrences of same ( )

	structure, DtHelpDialogCallbackStruct ( )

	structure within topic, creating ( )

	structured editor ( )

	subheading, within topic ( ) ( )

	subsection within reference section ( )

	subtopics
		creating ( )
		definition ( )

	summary
		CDE HelpTag markup ( ) ( )
		Help System commands ( )

	supporting item help mode ( )

	symbol
		inserting ( ) ( )
		list of symbols ( )
		plus (+) ( )


T

	tag ( )

	Tagged Image File Format (TIFF) ( )

	tags, element ( ) ( )

	term
		defining in glossary ( )
		definition ( )
		glossary, marking ( )
		newly introduced ( )

	testing
		graphics on various displays ( )
		help ( )

	text
		entity, creating ( )
		file, displaying ( )
		preserving line endings ( )
		string, displaying ( )
		untranslated ( )
		wrapping around graphic ( )

	TIFF (Tagged Image File Format) ( )

	tight parameter ( ) ( ) ( )

	time, current ( )

	title
		abbreviating ( )
		book ( )
		entering book title ( )
		help volume ( )
		line break within ( )
		list ( )
		note ( )
		section ( )
		topic ( ) ( ) ( )

	_title ID ( )

	topic ( )
		accessing ( ) ( )
		adding ID to ( )
		adding ID to element within ( )
		adding nonhierarchical ( )
		adding to hierarchy ( )
		creating hierarchy ( )
		creating structure within ( )
		defined ( )
		displaying ( )
		home ( )
		home, creating ( )
		linking to meta information ( )
		providing subheadings within ( )
		starting new ( )
		structure of elements ( )
		subheading within ( )
		subordinate ( )
		title ( ) ( )
		volume as collection of ( )
		writing ( )

	topic tree
		in general help dialog ( )
		selecting topic ( )

	trademark, entity name ( )

	typographical symbols ( )


U

	unformatted text ( )

	untranslated text ( )

	user's perspective, seeing help from ( )

	Using Help command, providing ( )


V

	validating hyperlinks ( )

	variable
		displaying ( )
		marking in command ( )

	verbatim example ( )

	verbose parameter ( )

	verifying application entry points ( )

	vertical bar, used in shorthand markup ( )

	vertical space ( )

	viewing help volume ( )

	volume ( )
		abstract ( ) ( )
		as collection of topics ( )
		components ( )
		defined ( )
		desktop browser volume ( )
		displaying ( )
		family of volumes ( )
		finding ( )
		overview ( )
		registering ( )
		sample standalone help volume ( )
		standalone help ( )
		title ( )
		viewing ( )


W

	warning, of danger ( )

	warning statement, adding ( )

	widget classes ( )

	widget resources ( )

	window dump ( )

	wrapping text around graphic ( )

	writer's memo, inserting ( ) ( )

	writing
		for international audiences ( )
		help on help volume ( )
		topic ( )


X

	X Window Dump ( )

	XtAddCallback ( )

	XtAddCallback() ( )

	xwd graphic format ( )

Previous: Glossary