DocuTopic

application documentation

Documentation

This type is attached to topics that contain documentation. DocuTopics have a "documentation" section marked using

STARTSECTION{"documentation"}
...
ENDSECTION{"documentation"}

See also: DocuTopicTemplate

These sections can be extracted dynamically using RenderApplicationDocumentation. In general documentation should be as "near" to the application component as possible, that is it should be embedded into the topic the component represents.

For example all TopicFunctions should be DocuTopics too. The documentation of TopicFunctions are then aggregated on a master DocuTopic that contains calls to RenderApplicationDocumentation for a set of components that are a kind of group, e.g. all types, forms, views and templates implementing a certain model.

WikiApplications can contain documentation too. But if the documentation reaches a certain complexity it should be moved to separate DocuTopics that the WikiApplication topic links to.

DocuTopics, as all TopicTypes belong to a certain WikiApplication and can thus be grouped and distinguished.

Topics of type 'DocuTopic'

DocuTopic form

Name:	Type:	Size:	Values:	Description:	Attributes:	Default:
TopicType	label	1	DocuTopic, ApplicationTopic, WikiTopic	topic type		DocuTopic, ApplicationTopic, WikiTopic
TopicTitle	text	75
Summary	text	75		short description or tagline	c
WikiApplication	wikiapp	1		application this topic belongs to