CompleteDocumentation

WikiApplication to develop WikiApplications

Every WikiApplication comes with an ApplicationLicense. A topic of this type must have a notice section that will be displayed on components that make use of this license. The notice section contains a short summary of the ApplicationLicense.

… read more

An ApplicationTopic is a topic that belongs to a WikiApplication. TopicTypes, TopicFunctions, TopicViews etc are all ApplicationTopics as they belong to some WikiApplication. Based on this information all parts of an application are gathered to create documentation and use it for packaging purposes.

See also :

• ApplicationTopicViewTemplate
• ApplicationTopicEditTemplate

… read more

DataForms add structured information to wiki topics.

See also: DataFormTemplate, DataForms

… read more

A DataFormAttribute, also called form field or form attribute, is a part of a DataForm. It may be used as an entity that defining all values a form field can take by using listing them in a FoswikiTable

See also: DataFormAttributeTemplate

… read more

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.

… read more

See also: TopicFunctionTemplate, TopicFunctionViewTemplate

… read more

This is a type of topics that has no own net data but includes all data from another topic. Thereby content from another web can be integrated into this web without reduplication. Every TopicStub has a rather rigid structure and varies only in its target topic (see TopicStub).

This TopicType is similar to TopicFunctions but does not compute a specific function. Moreover it is useful to reduce redundancy of pure content, whereas TopicFunctions are part of a WikiWorkbench library and thus reduce redundancy in WikiApplications.

See also: TopicStubTemplate, TopicStubViewTemplate, TopicStubEditTemplate

… read more

A TopicTemplate is used to create new topics and serves as a kind of blueprint of its content. For example, the simple topic creator takes a TopicTemplate and a DataForm definition to initialize the new topic with the given properties by using the TopicTemplate for the content, and attaching the given DataForm.

… read more

The TopicType is the root of the type system of the WikiWorbench. Every WikiTopic has got one or more TopicTypes. TopicTypes always define a DataForm, where a type indicates the properties and use of the form being attached to a topic.

TopicTypes overcome Foswiki's limitation to only allow one form to be attached to a topic. If you'd like to attach a second form to a topic, create a new DataForm that mixes two others and indicate this by merging the resulting TopicType properties. This procedure is the recommended way to derive new TopicTypes from existing ones building on top of them, e.g. by augmenting a CategorizedTopic with additional formfields.

TopicTypes have a special property that you might use to indicate a special way of derivation by means of inheritance. There is no real inheritance in Foswiki but the way of thinking when dealing with objects and types can be clarified this way.

When you start writing a WikiApplication, first think of the data objects you will need and create TopicTypes for each.

… read more

A TopicView defines a view for a topic. By default WikiTopics are displayed using the installed skin and the templates (don't confuse with TopicTemplate being a content blueprint for newly created topics). The view (compare with the 'view' term from the Model-View-Control school) computes the appearance of a WikiTopic and its form data. A new view is assigned to a topic by setting the VIEW_TEMPLATE variable.

For example the following will set th view to use the HiddenFormViewTemplate to hide the form table that is normally displayed below the wiki content.

   * Set VIEW_TEMPLATE = HiddenFormView

Note, that the ...Template string is appended automatically by the Foswiki engine.

Note also, that we use the TopicView type to mark even those views that are used during editting a wiki topic and is assigned using something like

   * Set EDIT_TEMPLATE = FormEdit

As such the FormEditTemplate is not used during Foswiki's view operation but during edit. The template is then used to render the view on the editor to be used. Edit templates either augment the normal Foswiki editor, or even implement a full substitute for its form data.

… read more

Note, that there is no creator to build a topic of this kind as it is a pure "marker type", that is topics are created with another creator tool and then in addition marked to be an WebTool. Topics of this type are ApplicationTopics too and take associated DataForm.

… read more

Normally there's only one WikiApplication topic in a wiki application as created using the WikiWorkbench. This will be used to capture the CompleteDocumentation, including version and license information.

See also: WikiApplicationTemplate

… read more

The WikiTopic form can be used for a wide range of TopicTypes that only need to be marked as being of a given TopicType. If you need more structure then you have to define a specific form that extends the attributes of the WikiTopic form. That is, the attributes defined here are a minimal set of attributes that all DataForms should share.

Every TopicType is used in combination with one DataForm, that is associated with it, either this generic WikiTopic form or a more specific one. Multiple TopicTypes can share the same form. In this case such a form must allow to select from a set of TopicTypes to mark it properly. A common case is where one TopicType uses one specific DataForm. Note, that a topic can be of several TopicTypes which indicates that it fullfills several duties at once. So by marking a topic of being of types T_a and type T_b you indicate that the attached form contains all form attributes that are in form F_a and from F_b, given that type T_a comes with form F_a and T_b with F_b.

See also: WikiTopicViewTemplate, WikiTopicEditTemplate

… read more

Every WikiApplication comes with an ApplicationLicense. A topic of this type must have a notice section that will be displayed on components that make use of this license. The notice section contains a short summary of the ApplicationLicense.

… read more

An ApplicationTopic is a topic that belongs to a WikiApplication. TopicTypes, TopicFunctions, TopicViews etc are all ApplicationTopics as they belong to some WikiApplication. Based on this information all parts of an application are gathered to create documentation and use it for packaging purposes.

See also :

• ApplicationTopicViewTemplate
• ApplicationTopicEditTemplate

… read more

DataForms add structured information to wiki topics.

See also: DataFormTemplate, DataForms

… read more

A DataFormAttribute, also called form field or form attribute, is a part of a DataForm. It may be used as an entity that defining all values a form field can take by using listing them in a FoswikiTable

See also: DataFormAttributeTemplate

… read more

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.

… read more

… read more

See also: TopicFunctionTemplate, TopicFunctionViewTemplate

… read more

This is a type of topics that has no own net data but includes all data from another topic. Thereby content from another web can be integrated into this web without reduplication. Every TopicStub has a rather rigid structure and varies only in its target topic (see TopicStub).

This TopicType is similar to TopicFunctions but does not compute a specific function. Moreover it is useful to reduce redundancy of pure content, whereas TopicFunctions are part of a WikiWorkbench library and thus reduce redundancy in WikiApplications.

See also: TopicStubTemplate, TopicStubViewTemplate, TopicStubEditTemplate

… read more

A TopicTemplate is used to create new topics and serves as a kind of blueprint of its content. For example, the simple topic creator takes a TopicTemplate and a DataForm definition to initialize the new topic with the given properties by using the TopicTemplate for the content, and attaching the given DataForm.

… read more

The TopicType is the root of the type system of the WikiWorbench. Every WikiTopic has got one or more TopicTypes. TopicTypes always define a DataForm, where a type indicates the properties and use of the form being attached to a topic.

TopicTypes overcome Foswiki's limitation to only allow one form to be attached to a topic. If you'd like to attach a second form to a topic, create a new DataForm that mixes two others and indicate this by merging the resulting TopicType properties. This procedure is the recommended way to derive new TopicTypes from existing ones building on top of them, e.g. by augmenting a CategorizedTopic with additional formfields.

TopicTypes have a special property that you might use to indicate a special way of derivation by means of inheritance. There is no real inheritance in Foswiki but the way of thinking when dealing with objects and types can be clarified this way.

When you start writing a WikiApplication, first think of the data objects you will need and create TopicTypes for each.

… read more

A TopicView defines a view for a topic. By default WikiTopics are displayed using the installed skin and the templates (don't confuse with TopicTemplate being a content blueprint for newly created topics). The view (compare with the 'view' term from the Model-View-Control school) computes the appearance of a WikiTopic and its form data. A new view is assigned to a topic by setting the VIEW_TEMPLATE variable.

For example the following will set th view to use the HiddenFormViewTemplate to hide the form table that is normally displayed below the wiki content.

   * Set VIEW_TEMPLATE = HiddenFormView

Note, that the ...Template string is appended automatically by the Foswiki engine.

Note also, that we use the TopicView type to mark even those views that are used during editting a wiki topic and is assigned using something like

   * Set EDIT_TEMPLATE = FormEdit

As such the FormEditTemplate is not used during Foswiki's view operation but during edit. The template is then used to render the view on the editor to be used. Edit templates either augment the normal Foswiki editor, or even implement a full substitute for its form data.

… read more

Note, that there is no creator to build a topic of this kind as it is a pure "marker type", that is topics are created with another creator tool and then in addition marked to be an WebTool. Topics of this type are ApplicationTopics too and take associated DataForm.

… read more

Normally there's only one WikiApplication topic in a wiki application as created using the WikiWorkbench. This will be used to capture the CompleteDocumentation, including version and license information.

See also: WikiApplicationTemplate

… read more

The WikiTopic form can be used for a wide range of TopicTypes that only need to be marked as being of a given TopicType. If you need more structure then you have to define a specific form that extends the attributes of the WikiTopic form. That is, the attributes defined here are a minimal set of attributes that all DataForms should share.

Every TopicType is used in combination with one DataForm, that is associated with it, either this generic WikiTopic form or a more specific one. Multiple TopicTypes can share the same form. In this case such a form must allow to select from a set of TopicTypes to mark it properly. A common case is where one TopicType uses one specific DataForm. Note, that a topic can be of several TopicTypes which indicates that it fullfills several duties at once. So by marking a topic of being of types T_a and type T_b you indicate that the attached form contains all form attributes that are in form F_a and from F_b, given that type T_a comes with form F_a and T_b with F_b.

See also: WikiTopicViewTemplate, WikiTopicEditTemplate

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

This is a "getter" TopicFunction that returns a list of known TopicTypes in a given web. Use it to create a selection in DataForms for the TopicType formfield. It adds the "none" type so that you can have (temporarily) un-typed topics. The type "TopicType" is added hardcoded so that you don't have to rely on that type being present in your web and to allow bootstrapping a type system in a web from scratch on as you will be able to create an initial TopicType TopicType this way.

Parameters

• WEBS: list of webs to search for TopicTypes, defaults to BASEWEB
• EXCLUDE: expression to exclude types (optional)
• ADDITION: types that are listed additionally (optional)

… read more

Parameters

• NAME: application name, defaults to BASEWEB
• THEWEB: web to search for docu, defaults to BASEWEB
• TYPE: extract documentation of topics of the given type
• NOTTYPE: don't list topics of that type

Css

• twbDocuHolder
• twbDocuSectionHolder
• twbDocuSectionSummary
• twbDocuSectionText

… read more

… read more

Parameters

• ATTR: DataFormAttribute to search for, defaults to BASETOPIC
• THEWEB: web to examin, defaults to BASEWEB

… read more

… read more

Select an image attached to a OBJECT topic

Parameters

• OBJECT, default BASEWEB.BASETOPIC
• SELECTED
• FIELDNAME
• EXTENSIONS, defaults to jpe?g|JPE?G|gif|GIF|png|PNG|svg|SVG|webp|WEBP

… read more

This method is called by RenderCategory to display a summary for an object. This method serves as a final fallback when no other TopicType-specific method was found.

Parameters

• OBJECT

… read more

This function requires GraphvizPlugin

… read more

This uses solr and infintescroll to create a frontpage widget.

Parameters

• HEIGHT: height of scroll container, defaults to 40em
• LIMIT: number of rows to render, defaults to 20
• PAGE: from which page to start rendering
• THEWEB: the web to render recent changes for
• FILTER: filter to be added to the search query

… read more

This method is called by RssViewTemplate for each topic found. Note that this is a base-implementation for all TopicTypes processed. Individual TopicTypes may implement their own version called MyTopicTypeRenderRss. These are then called automatically using the %DBCALL{"web.topic->RenderRss"}% method call of the RssViewTemplate.

Parameters

• OBJECT: the current topic

… read more

… read more

This function renders a topic creator form that holds a set of initial input elements to create a topic.

Parameters

• TEXT: headline text; defaults to "Create a new INCLUDINGTOPIC"
• LABEL: label of the TopicTitle field, defaults to "Title"
• BUTTONTEXT: text on the twisty buttinm; default New
• VALUE: initial value of the title input field (optional)
• VALUES: map of initial values to formfields; format is <fieldName1>=<value1>;<fieldName2>=<value2>;...
• FORM: DataForm to be used when creating a topic, defaults to INCLUDINGWEB.INCLUDINGTOPIC
• TEMPLATE: TopicTemplate to be used (optional)
• TYPE: initial TopicType value, defaults to values predefined in the form definition
• PARENT: parent topic for the new topic, defaults to the BASETOPIC
• WHITEBOARD: switch on/off the whiteboard textarea
• EXTRA: additional formfields
• SCRIPT: script to be used to create the topic, eg save or edit, defaults to edit
• EDITOR: TopicView to be used as an edit_template

… read more

This is a tool to add a topic based application, or part of it to another web. This is done by creating a TopicStub that points back to the implementation. For example, to add a new TopicType to web, you create a TopicStub that points back to the implementation of that TopicType.

The function will display a small input form to specify the web where the TopicStub is to be created.

Parameters

• TEXT: headline for the install form, defaults to "Install BASETOPIC"
• NAME: name of the topic to be created, defaults to BASETOPIC
• SOURCE: used to specify the TopicStub's target to be created, defaults to BASEWEB.BASETOPIC
• PARENT: topicparent of the new topic, defaults to HOMETOPIC
• TEMPLATE: TopicTemplate used to create this topic, defaults to TopicStubTemplate
• FORM: DataForm used for this topic, defaults to TopicStub
• TYPE: type of the new topic, defaults to TopicStub
• WIKIAPP: the name of the WikiApllication this topic belongs to, defaults to BASEWEB
• EXTRA: extra stuff to be send during save

… read more

This function gets the first image attachment from a topic and creates a 48x48 thumbnail using ImagePlugin. The attachment taken must end with jpeg, jpg, gif, bmp, svg or png. If there are multiple image attachments then the first one ordered by comment and name is taken. The empty string is returned if no image attachment is found.

Parameters

• OBJECT: topic to generate a thumbnail for
• ALIGN: optional alignment of image, defaults to right
• SIZE: optional size of thumbnail
• TYPE: image rendering type, see documentation of ImagePlugin, defaults to simple
• CROP
• TOOLTIP: switch on/off tooltips for thumbnails, defaults to on
• SORT: specifies which image to chose from the attachments, defaults to comment:name which will take the one that sorts first wrt the comment, falling back to the name

… read more

Parameters

• TYPE: the TopicType to be searched for, defaults to BASETOPIC
• FIELDS: columns of formfields to display, defaults to TopicTitle, Summary, WikiApplication, Changed
• SORT: sorting of rows, defaults to "Changed"
• REVERSE: sorting direction, defaults to "off", defaults to "on" if SORT="Changed"
• ROWS: number of rows to display initially, defauts to 10
• FILTER: additional filter expression (optional)
• THEWEB: web to examin, defaults to BASEWEB
• ROWNUMBERS: boolean toggle to switch on/off row numbers
• SELECTING: boolean toggle to switch on/off row selection, defaults to off
• SEARCHMODE: either have one single search box using global or one per column using multi, default global
• <field_name>_title: column title for the given field
• <field_name>_width: column width for the given field

… read more

This is used to create a new WikiApplication

… read more

Renders the Applications of a WikiApplication subweb

Parameters

None

… read more

This function renders a view for a wiki topic, showing its title and the summary line.

Parameters

• OBJECT: the topic to render the view for, defaults to %BASEWEB%.%BASETOPIC%
• TITLE_PREFIX: optional string put before the topic title
• TITLE_EXTRA: optional addition put behind the topic title
• DISPLAYREVISIONINFO: boolean flag to switch on/off revinfo rendered underneath the h1 element

… read more