Documentation

This is a pure "marker" type that is attached to topics that contain documentation. DocuTopics have a "documentation" section marked using
STARTSECTION{"documentation"}
...
ENDSECTION{"documentation"}
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'

Create a new DocuTopic

Title:

Summary:

TopicType edit

TopicType TopicType, DocuTopic
TopicTitle DocuTopic
Inheritance ApplicationTopic
Summary Topics that contain pure documentation.
WikiApplication WikiWorkbench
Topic revision: r1 - 23 Dec 2012, ProjectContributor
 

Das Urheberrecht © liegt bei den mitwirkenden Autoren. Alle Inhalte dieser Kollaborations-Plattform sind Eigentum der Autoren.