You are here: Foswiki>Applications Web>TopicType>TopicView>RssViewTemplate (11 Feb 2025, ProjectContributor)Edit Attach

RssViewTemplate
View for the rss feeds

%TMPL:DEF{"rsshead"}% %TMPL:END%

%TMPL:DEF{"rssbody"}%%TMPL:END%

%TMPL:DEF{"rsschannel::header"}% Applications - Foswiki https://wiki.physik.rwth-aachen.de/Applications Applications Library /pub/System/ProjectLogos/foswiki-logo.png Applications - Foswiki https://wiki.physik.rwth-aachen.de/Applications en-us Copyright 2026 by contributing authors %TMPL:END%

%TMPL:DEF{"rsschannel::query"}% RenderTopicThumbnail https://wiki.physik.rwth-aachen.de/Applications/RenderTopicThumbnail 2019-05-02T09:18:00Z ProjectContributor

]]> GNU General Public License, version 2 https://wiki.physik.rwth-aachen.de/Applications/GnuGeneralPublicLicense 2019-05-02T09:18:00Z ProjectContributor GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. 

%STARTSECTION{"notice"}%
This file is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version. For
more details read the [[Applications.GnuGeneralPublicLicense][LICENSE]].

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
%ENDSECTION{"notice"}%

]]> ApplicationTopic https://wiki.physik.rwth-aachen.de/Applications/ApplicationTopic 2019-05-02T09:18:00Z ProjectContributor

Create a new ApplicationTopic

Title:

Summary:

short description or tagline

WikiApplication:

application this topic belongs to
Submit

topic index TopicTitle TopicType WikiApplication Changed

]]> TopicView https://wiki.physik.rwth-aachen.de/Applications/TopicView 2019-05-02T09:18:00Z ProjectContributor

Create a new TopicView

Title:

Summary:

short description or tagline
Submit

topic index TopicTitle Summary WikiApplication Changed

]]> RenderImageSelector https://wiki.physik.rwth-aachen.de/Applications/RenderImageSelector 2019-05-02T09:18:00Z ProjectContributor

]]> CompleteDocumentation https://wiki.physik.rwth-aachen.de/Applications/CompleteDocumentation 2019-05-02T09:18:00Z ProjectContributor Table of Contents

Description

The WikiWorkbench is a standardized way to write and deploy WikiApplications. It is WikiApplication to write WikiApplications. At its core it establishes a certain terminology (such as TopicTypes and TopicFunctions) that are common in non-web applications. A WikiWorkbench implements a standard set of means to ease the administration of even large-scale WikiApplication. WikiApplications, i.e. its TopicFunctions ease the extraction of application documentation. Merging a set of applications obeying this framework into the same web grants a higher level of compatibility and re-usability.

Documentation

Type Hierarchy

TopicType

ApplicationLicense

a license for wiki applications
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

ApplicationTopic

a part of an application
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 :

... read more

DataForm

form definition for structured wiki content
DataForms add structured information to wiki topics.

See also: DataFormTemplate, DataForms

... read more

DataFormAttribute

value definition for formfields in a DataForm
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

DocuTopic

application 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.

... read more

TopicFunction

Function library
See also: TopicFunctionTemplate, TopicFunctionViewTemplate

... read more

TopicStub

a placeholder topic pointing to another one
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

TopicTemplate

templates for wiki topics
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

TopicType

TopicType of all TopicTypes
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

TopicView

a topic view or edit template
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

WebTool

a special page used to manage a web
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

WikiApplication

a documentation topic for a wiki application
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

WikiTopic

a base topic for wiki content
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 Ta and type Tb you indicate that the attached form contains all form attributes that are in form Fa and from Fb, given that type Ta comes with form Fa and Tb with Fb.

See also: WikiTopicViewTemplate, WikiTopicEditTemplate

... read more

DataForm

ApplicationLicense

a license for wiki applications
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

ApplicationTopic

a part of an application
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 :

... read more

DataForm

form definition for structured wiki content
DataForms add structured information to wiki topics.

See also: DataFormTemplate, DataForms

... read more

DataFormAttribute

value definition for formfields in a DataForm
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

DocuTopic

application 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.

... read more

LexiconForm

DataForm for WebLexicon entries
... read more

TopicFunction

Function library
See also: TopicFunctionTemplate, TopicFunctionViewTemplate

... read more

TopicStub

a placeholder topic pointing to another one
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

TopicTemplate

templates for wiki topics
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

TopicType

TopicType of all TopicTypes
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

TopicView

a topic view or edit template
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

WebTool

a special page used to manage a web
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

WikiApplication

a documentation topic for a wiki application
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

WikiTopic

a base topic for wiki content
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 Ta and type Tb you indicate that the attached form contains all form attributes that are in form Fa and from Fb, given that type Ta comes with form Fa and Tb with Fb.

See also: WikiTopicViewTemplate, WikiTopicEditTemplate

... read more

TopicView

ApplicationTopicEditTemplate

Editor for ApplicationTopics
... read more

ApplicationTopicViewTemplate

TopicView for ApplicationTopics
... read more

AtomViewTemplate

View for the atom feeds
... read more

FormEditTemplate

TopicView to edit the DataForm only
... read more

HiddenFormViewTemplate

View to hide System.DataForms
... read more

RssViewTemplate

View for the rss feeds
... read more

TextEditTemplate

TopicView to edit the topic text only
... read more

TextViewTemplate

Minimal TopicView usefull to generate xml output
... read more

TopicFunctionViewTemplate

TopicView for TopicFunctions
... read more

TopicStubEditTemplate

... read more

TopicStubViewTemplate

... read more

TopicTypeEditTemplate

Editor for TopicTypes
... read more

WikiTopicEditTemplate

TopicView to edit a WikiTopic
... read more

WikiTopicViewTemplate

Generic topic view
... read more

TopicFunction

GetTopicTypes

returns a list of TopicTypes known in the base web
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

RenderApplicationDocumentation

Extracts the documentation section from all parts of a WikiApplication
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

RenderApplicationManifest

Render a list of all files making up a given application
... read more

RenderDataFormList

Renders a list of DataForms that make use of the given DataFormAttribute
Parameters
  • ATTR: DataFormAttribute to search for, defaults to BASETOPIC
  • THEWEB: web to examin, defaults to BASEWEB

... read more

RenderFunctionCallers

Render a list of topics that use a given TopicFunction
... read more

RenderImageSelector

Renders a widget to select an image attached to a topic
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

RenderIndexItem

Fallback to render a summary for WikiTopic that does not have a type specific version of to render an index item
This method is called by Applications.ClassificationApp.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

RenderInheritanceGraph

a directed graph of TopicType inheritance
This function requires GraphvizPlugin

... read more

RenderRecentChanges

renders a list of recent changes in a web
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

RenderRss

default implementation of an rss view of a single topic
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

RenderSideBar

Render the sidebar navigation for the WikiWorkbench
... read more

RenderSimpleTopicCreator

TopicFunction to display a simple form to create a new topic
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

RenderTopicInstaller

Render a simple factory to deploy a topic in another web
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 Applications.TopicStubTemplate
  • FORM: DataForm used for this topic, defaults to Applications.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

RenderTopicThumbnail

Display thumbnail image for a topic
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

RenderTopicsOfType

Display a table of topcis of a given type
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

RenderWikiApplicationFactory

Renders a form to create a new WikiApplication
This is used to create a new WikiApplication

... read more

RenderWikiApplicationWebHome

Renders a dashboard for an application web
Renders the WebHome of a WikiApplication subweb

Parameters
None

... read more

RenderWikiTopicView

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

Installation

...

Manifest

#Sorted ascending Name Type
  a license for wiki applications
  a part of an application
  Editor for ApplicationTopics
  TopicView for ApplicationTopics
  View for the atom feeds
  form definition for structured wiki content
  value definition for formfields in a DataForm
  application documentation
  What's next: first steps after creating a new workbench web
  TopicView to edit the DataForm only
  returns a list of TopicTypes known in the base web
  Standard Open Source License
  View to hide System.DataForms
  DataForm for WebLexicon entries
  Extracts the documentation section from all parts of a WikiApplication
  Render a list of all files making up a given application
  Renders a list of DataForms that make use of the given DataFormAttribute
  Render a list of topics that use a given TopicFunction
  Renders a widget to select an image attached to a topic
  Fallback to render a summary for WikiTopic that does not have a type specific version of to render an index item
  a directed graph of TopicType inheritance
  renders a list of recent changes in a web
  default implementation of an rss view of a single topic
  Render the sidebar navigation for the WikiWorkbench
  TopicFunction to display a simple form to create a new topic
  Render a simple factory to deploy a topic in another web
  Display thumbnail image for a topic
  Display a table of topcis of a given type
  Renders a form to create a new WikiApplication
  Renders a dashboard for an application web
   
  View for the rss feeds
  TopicView to edit the topic text only
  Minimal TopicView usefull to generate xml output
  Function library
  TopicView for TopicFunctions
  a placeholder topic pointing to another one
   
   
  templates for wiki topics
  TopicType of all TopicTypes
  Editor for TopicTypes
  a topic view or edit template
  Library of all WikiApplications installed on Foswiki
   
  a special page used to manage a web
  a documentation topic for a wiki application
  a base topic for wiki content
  TopicView to edit a WikiTopic
  Generic topic view
1 ApplicationLicense TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
2 ApplicationTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
3 ApplicationTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
4 ApplicationTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
5 AtomViewTemplate TopicView, ApplicationTopic, WikiTopic
6 DataForm TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
7 DataFormAttribute TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
8 DocuTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
9 FirstSteps DocuTopic, ApplicationTopic, WikiTopic
10 FormEditTemplate TopicView, ApplicationTopic, WikiTopic
11 GetTopicTypes TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
12 GnuGeneralPublicLicense ApplicationLicense, ApplicationTopic, WikiTopic
13 HiddenFormViewTemplate TopicView, ApplicationTopic, WikiTopic
14 LexiconForm DataForm, ApplicationTopic, WikiTopic
15 RenderApplicationDocumentation TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
16 RenderApplicationManifest TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
17 RenderDataFormList TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
18 RenderFunctionCallers TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
19 RenderImageSelector TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
20 RenderIndexItem TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
21 RenderInheritanceGraph TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
22 RenderRecentChanges TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
23 RenderRss TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
24 RenderSideBar TopicFunction, ApplicationTopic, WikiTopic
25 RenderSimpleTopicCreator TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
26 RenderTopicInstaller TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
27 RenderTopicThumbnail TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
28 RenderTopicsOfType TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
29 RenderWikiApplicationFactory TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
30 RenderWikiApplicationWebHome TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
31 RenderWikiTopicView TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
32 RssViewTemplate TopicView, ApplicationTopic, WikiTopic
33 TextEditTemplate TopicView, ApplicationTopic, WikiTopic
34 TextViewTemplate TopicView, ApplicationTopic, WikiTopic
35 TopicFunction TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
36 TopicFunctionViewTemplate TopicView, ApplicationTopic, WikiTopic
37 TopicStub TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
38 TopicStubEditTemplate TopicView, ApplicationTopic, WikiTopic
39 TopicStubViewTemplate TopicView, ApplicationTopic, WikiTopic
40 TopicTemplate TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
41 TopicType TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
42 TopicTypeEditTemplate TopicView, ApplicationTopic, WikiTopic
43 TopicView TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
44 WebHome ApplicationTopic, WikiTopic
45 WebLexicon WebTool, ApplicationTopic, WikiTopic
46 WebTool TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
47 WikiApplication TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
48 WikiTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
49 WikiTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
50 WikiTopicViewTemplate TopicView, ApplicationTopic, WikiTopic

]]> RenderFunctionCallers https://wiki.physik.rwth-aachen.de/Applications/RenderFunctionCallers 2019-05-02T09:18:00Z ProjectContributor Calls to 'RenderRss' ]]> DocuTopic https://wiki.physik.rwth-aachen.de/Applications/DocuTopic 2019-05-02T09:18:00Z ProjectContributor

Create a new DocuTopic

Title:

Summary:

short description or tagline
Submit

topic index TopicTitle Summary WikiApplication Changed

]]> TopicTemplate https://wiki.physik.rwth-aachen.de/Applications/TopicTemplate 2019-05-02T09:18:00Z ProjectContributor

Create a new TopicTemplate

Title:

Summary:

short description or tagline

For TopicType:

TopicType that this template can be used for
Submit

topic index TopicTitle Summary ForTopicType Changed

]]> TopicStubEditTemplate https://wiki.physik.rwth-aachen.de/Applications/TopicStubEditTemplate 2019-05-02T09:18:00Z ProjectContributor }% %TMPL:INCLUDE{"Applications.WikiTopicEdit"}% %{}%

%{
}%
%TMPL:DEF{"firsttab"}%%TMPL:P{"detailstab"}%%TMPL:END%
%{
}%

%{
}%
%TMPL:DEF{"formfields"}%%TMPL:PREV%%TMPL:P{"texttab"}%%TMPL:END%
%{
}%

%{
}%
%TMPL:DEF{"detailstab"}%%TAB{"%TRANSLATE{"Details"}%"}%
%RENDERFOREDIT{
   exclude="\b(TopicType)\b"
   TopicTitle_default="%BASETOPIC%"
}%
%ENDTAB%%TMPL:END%
%{
}%

%{
}%
%TMPL:DEF{"texttab"}%%TAB{"%TRANSLATE{"Text"}%"}%
%TMPL:P{"textarea"}%
%ENDTAB%%TMPL:END%
%{
}%

]]> %TMPL:END%

%TMPL:DEF{"rsschannel::footer"}%%TMPL:END% %TMPL:DEF{"rssfooter"}%%TMPL:END%
Edit  | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback