Applications - Flatiron Institute Documentation Center https://wiki.flatironinstitute.org/Applications Applications Library https://wiki.flatironinstitute.org/pub/System/ProjectLogos/FI-primary-logo-color.svg Applications - Flatiron Institute Documentation Center https://wiki.flatironinstitute.org/Applications en-us Copyright 2026 by contributing authors RenderApplicationDocumentation https://wiki.flatironinstitute.org/Applications/RenderApplicationDocumentation https://wiki.flatironinstitute.org/Applications/RenderApplicationDocumentation RenderRss 2025-02-11T08:48:26Z

]]> First Steps https://wiki.flatironinstitute.org/Applications/FirstSteps https://wiki.flatironinstitute.org/Applications/FirstSteps RenderRss 2025-02-11T08:48:26Z

How to proceed

Each application has a master topic located in the application's subweb, which captures all information and documentation for this application. This is is a topic of type WikiApplication. Create it and give it the same name as your newly created application web. For example given you created a new web Applications.MyNewApp then create a new WikiApplication topic Applications.MyNewApp.MyNewApp. That's where application-level documentation goes. All topic-level documentation is done within the ApplicationTopics themselves. In addition of being an ApplicationTopic these are tagged DocuTopic and contain a named section "docu". The WikiApplication topic contains a control function that gathers all topic-level documentation by extracting the section "docu" from DocuTopics.

Model

When starting to write a new WikiApplication, you may proceed by creating new TopicTypes, that are specific for it. TopicTypes will define the data model, and optionally an installer and a factory that help in deploying and creating a new topic of the new type.

Now create a few instances of the new TopicType. For now, it only has a plain text and probably a DataForm attached to it. The TopicTypes are used to create a topic of that type, together with an optional TopicTemplate as a blueprint. This blueprint shall have all the specific means pre-installed that are needed to properly display a topic of that type.

View

After you created the data model and a few topic instances of that type, you can start writing TopicFunctions to control this data. For example create a RenderMyNewTopicType that displays the data of one topic. Now create a TopicView that includes a call to this new TopicFunction. Then apply the TopicView to a topic by setting its VIEW_TEMPLATE property. Add this setting to the TopicTemplate so that each newly authored topic of that type will have the correct view applied to it.

Control

When you finished implementing the data model and the view you may proceed by creating reports and queries to list a set of topics of that type and display the appropriately.

The further alley your application takes is very dependent on the kind of application you are about to implement.

Deployment

Finally, you will need a way to deploy the application into another web. This is done by either implementing an web template containing the blueprint of a complete web with all functions already installed. You may then deploy an instance of the application by creating a new web on this base. Alternatively, the application can be added to an already existing web by installing the relevant TopicTypes into the target web. This is done by using the installers on the TopicTypes and WebTools each.

If you add an application to an already existing web for the first time, you may also need to create the basic infrastructure of TopicTypes by deploying the TopicType "TopicType" and "TopicStub" into the target web.

Documentation

Each part of your application can come with its own documentation. Mark it to be of type DocuTopic so that its documentation will be extracted automatically in the master topic. For example each topic of type TopicType is also of type DocuTopic by default. Create pure DocuTopics that describe overall documentation about your application.

Last not least delete this text and replace it with a meaningful description and introduction to your application.

]]> RenderTopicInstaller https://wiki.flatironinstitute.org/Applications/RenderTopicInstaller https://wiki.flatironinstitute.org/Applications/RenderTopicInstaller RenderRss 2025-02-11T08:48:26Z

Install WebRss

Target web:

Select a web where to deploy this component.
Submit

]]> TopicStubEditTemplate https://wiki.flatironinstitute.org/Applications/TopicStubEditTemplate https://wiki.flatironinstitute.org/Applications/TopicStubEditTemplate RenderRss 2025-02-11T08:48:26Z %TMPL:INCLUDE{"Applications.WikiTopicEdit"}% 
%TMPL:DEF{"formattop"}%%TMPL:END%

%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%"
   TopicTitle_title="%TRANSLATE{"Title"}%"
}%
%ENDTAB%%TMPL:END%

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

%TMPL:DEF{"permissionstab::impl::start"}%%TMPL:PREV%
  <input type="hidden" name="Set+ALLOWTOPICCREATE" value="undefined" class="permset_create allow_create" />
  <input type="hidden" name="Set+DENYTOPICCREATE" value="undefined" class="permset_create deny_create" />
  <input type="hidden" name="Default+ALLOWTOPICCREATE" value="undefined" />
  <input type="hidden" name="Default+DENYTOPICCREATE" value="undefined" />
  <input type="hidden" name="Default+PERMSET_CREATE" value="default" />
  <input type="hidden" name="Default+PERMSET_CREATE_DETAILS" value="" />
%TMPL:END%

%TMPL:DEF{"permissionstab::impl::end"}%%IF{"'%FORMFIELD{"TopicType" topic="%FORMFIELD{"Target"}%"}%'=~'\bTopicType\b'" 
   then="$percntTMPL:P{\"permissionstab::impl::createstep\"
            permset_create=\"%TMPL:P{"getpreference" name="PERMSET_CREATE"}%\"
            permset_create_details=\"%TMPL:P{"getpreference" name="PERMSET_CREATE_DETAILS"}%\"
            allowtopic_create=\"%TMPL:P{"getpreference" name="ALLOWTOPICCREATE"}%\"
            denytopic_create=\"%TMPL:P{"getpreference" name="DENYTOPICCREATE"}%\"
         }$percnt"
}%%TMPL:PREV%%TMPL:END%

%TMPL:DEF{"permissionstab::impl::createstep"}%
<div class="foswikiFormStep ui-natedit-create-perms">
   <h3>%TRANSLATE{"Users who may create a topic of this type"}%:</h3>
   <p>
      <label title='%TRANSLATE{"default as defined in the [_1]" args="<nop>%WEBPREFSTOPIC%"}%'>
         <input type="radio" class="foswikiRadioButton" data-perm-type="create" name="Local+PERMSET_CREATE" value="default" %IF{"'%permset_create%'=~'^(default|)$'" then="checked"}% /> 
         %TRANSLATE{"Default"}%
      </label>
   </p>
   <p>
      <label title="%TRANSLATE{"everybody who has got an account on this site"}%">
         <input type="radio" class="foswikiRadioButton" data-perm-type="create" data-perms='%IF{"'%QUERY{"{AccessControlACL}{EnableDeprecatedEmptyDeny}"}%'='0'" then="{\"allow\":\"*\"}" else="{\"deny\":\" \"}"}%' name="Local+PERMSET_CREATE" value="registeredusers" %IF{"'%permset_create%'='registeredusers'" then="checked"}% /> 
         %TRANSLATE{"Registered users"}%
       </label>
   </p>
   <p>
      <label title='%TRANSLATE{"restrict permission to [_1]" args="%SPACEOUT{"%WIKINAME%"}%"}%'>
        <input type="radio" class="foswikiRadioButton" data-perm-type="create" data-perms='{"allow":"%WIKINAME%"}' name="Local+PERMSET_CREATE" value="justauthor" %IF{"'%permset_create%'='justauthor' and '%allowtopic_create%'='%WIKINAME%'" then="checked"}% />
        %TRANSLATE{"Just me"}%
      </label>
   </p>
   <p>
      <label title='%TRANSLATE{"strictly deny creating topics of this type"}%'>
         <input type="radio" class="foswikiRadioButton" data-perm-type="create" data-perms='{"allow":"AdminUser"}' name="Local+PERMSET_CREATE" value="nobody" %IF{"'%permset_create%'='nobody'" then="checked"}% /> 
         %TRANSLATE{"Nobody"}%
      </label>
   </p>
   <p>
      <label title='%TRANSLATE{"specify a list of users and/or groups"}%'>
         <input type="radio" class="foswikiRadioButton" data-perm-type="create" data-perms='details' name="Local+PERMSET_CREATE" value="details" %IF{"'%permset_create%'='details' or ('%permset_create%'='justauthor' and '%allowtopic_create%'!='%WIKINAME%') or ('%permset_create%'='' and '%allowtopic_create%'!='')" then="checked"}% />
         %TRANSLATE{"Specific users/groups"}%
      </label>
   </p>
   <div class="ui-natedit-details-container" %IF{"$'PERMSET_CREATE'!='details'" then="style='display:none'"}%>
      <input type="text" class="foswikiInputField" size="40" data-perm-type="create" data-perms='details' autocomplete="off" name="Local+PERMSET_CREATE_DETAILS" value="%IF{"'%permset_create%'='details' or ('%permset_create%'='justauthor' and '%allowtopic_create%'!='%WIKINAME%') or ('%permset_create%'='' and '%allowtopic_create%'!='')" then="%allowtopic_create%" else="%permset_create_details%"}%" />
    </div>
</div>
%TMPL:END%

]]> RenderWikiApplicationFactory https://wiki.flatironinstitute.org/Applications/RenderWikiApplicationFactory https://wiki.flatironinstitute.org/Applications/RenderWikiApplicationFactory RenderRss 2025-02-11T08:48:26Z

Name:

This is the name of the web that will hold the wiki application. It will become a subweb of the Applications web. Example values: MyCompanyApp, TestApp

Summary:

Enter a short description what this wiki app is about. It will be stored in the WebPreferences of your newly created application web.
Submit
]]> RenderInheritanceGraph https://wiki.flatironinstitute.org/Applications/RenderInheritanceGraph https://wiki.flatironinstitute.org/Applications/RenderInheritanceGraph RenderRss 2025-02-11T08:48:26Z
G ApplicationLicense ApplicationLicense ApplicationTopic ApplicationTopic ApplicationTopic->ApplicationLicense DataForm DataForm ApplicationTopic->DataForm DataFormAttribute DataFormAttribute ApplicationTopic->DataFormAttribute DocuTopic DocuTopic ApplicationTopic->DocuTopic TopicStub TopicStub ApplicationTopic->TopicStub TopicTemplate TopicTemplate ApplicationTopic->TopicTemplate TopicView TopicView ApplicationTopic->TopicView WebTool WebTool ApplicationTopic->WebTool WikiApplication WikiApplication ApplicationTopic->WikiApplication WikiTopic WikiTopic WikiTopic->ApplicationTopic TopicType TopicType DataForm->TopicType TopicFunction TopicFunction DocuTopic->TopicFunction DocuTopic->TopicType
]]> WikiApplication https://wiki.flatironinstitute.org/Applications/WikiApplication https://wiki.flatironinstitute.org/Applications/WikiApplication RenderRss 2025-02-11T08:48:26Z

New application topic

Title:

title of this topic

Summary:

short description of this topic

Version:

software release number/id/phase

Author:

application author(s)
Submit

topic index TopicTitle Summary Version

]]> RenderWikiTopicView https://wiki.flatironinstitute.org/Applications/RenderWikiTopicView https://wiki.flatironinstitute.org/Applications/RenderWikiTopicView RenderRss 2025-02-11T08:48:26Z
RenderWikiTopicView
(deprecated)
12 Dec 2025 - 12:46 | Version 1 | ]]> DataFormTemplate https://wiki.flatironinstitute.org/Applications/DataFormTemplate https://wiki.flatironinstitute.org/Applications/DataFormTemplate RenderRss 2025-02-11T08:48:26Z Name: Type: Size: Values: Description: Attributes: Default: TopicType type 1 …, WikiTopic topic type h   TopicTitle text 75   title     Summary text 75   short description or tagline    

]]> DataFormAttribute https://wiki.flatironinstitute.org/Applications/DataFormAttribute https://wiki.flatironinstitute.org/Applications/DataFormAttribute RenderRss 2025-02-11T08:48:26Z

DataFormAttribute

Title:

Summary:

short description or tagline
Submit

topic index TopicTitle Summary Changed By

]]>