DocuTopic < Applications

You are here: Foswiki>Applications Web>TopicType>DocuTopicEditAttach

---++ Documentation
%STARTSECTION{"documentation"}%
This is a pure "marker" type that is attached to topics that contain documentation.
!DocuTopics have a ="documentation"= section marked using
<verbatim>
STARTSECTION{"documentation"}
...
ENDSECTION{"documentation"}
</verbatim>
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.
%ENDSECTION{"documentation"}%

---++ Topics of type '%TOPIC%'
%STARTINCLUDE%<!-- -->
%DBCALL{"Applications.RenderSimpleTopicCreator"
  TYPE="DocuTopic, ApplicationTopic"
  FORM="Applications.ApplicationTopic"
}%

%DBCALL{"Applications.RenderTopicsOfType"}%
%STOPINCLUDE%

TopicType edit

TopicType	TopicType, DocuTopic
TopicTitle	DocuTopic
Inheritance	ApplicationTopic
Summary	Topics that contain pure documentation.
WikiApplication	WikiWorkbench

Topic revision: r1 - 23 Dec 2012, ProjectContributor

Applications

Tools

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