/
DocuTopic.txt
46 lines (39 loc) · 2.01 KB
/
DocuTopic.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
%META:TOPICINFO{author="ProjectContributor" comment="autosave" date="1356278736" format="1.1" version="6"}%
%META:TOPICPARENT{name="TopicType"}%
---++ 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%
%META:FORM{name="Applications.TopicType"}%
%META:FIELD{name="TopicType" title="TopicType" value="TopicType, DocuTopic"}%
%META:FIELD{name="TopicTitle" attributes="" title="<nop>TopicTitle" value="DocuTopic"}%
%META:FIELD{name="Inheritance" attributes="" title="Inheritance" value="ApplicationTopic"}%
%META:FIELD{name="Summary" attributes="" title="Summary" value="Topics that contain pure documentation."}%
%META:FIELD{name="WikiApplication" attributes="" title="WikiApplication" value="WikiWorkbench"}%