CSP Wiki - User contributions [en]

Template:Csp show class definition

2026-02-18T08:23:10Z

Pagesync: Imported by PageSync

<noinclude>

This is the '''Csp show class definition''' template. It should be called in the following format:

<pre>
{{Csp show class definition
|$namespacename= (text) e.g. "Wiki"
|$page= (pagename without namespace) e.g. "Class definition/Application page"
|Class= (text) should always be "Class definition" for those created from CSP 1.8.0 or later
|Defines class= (text) e.g. "Person"
|Footer template= (full pagename)
|Page properties template= (full pagename)
|Sidebar template= (full pagename)
|Sub header template= (full pagename)
}}
</pre>

<div class="alert alert-warning">
Note about the use of '''"Template:"''' inside this template to create links in the results: this was done because properties of type pages in WikiSearch are returned without namespace (due to how SMW stores them in ES). An alternative would be to retrieve data from slots of the class definition page or to add new properties (of type Text) that also contain the template names. However this wouldn't be compatible with class definitions from before CSP 1.8.0. Once the old style class definitions have been officially deprecated (1.9.0 or later), this template could be updated to change this.
</div>

== Test ==

{{Csp show class definition
|$namespacename=Wiki
|$page=Class definition/Application page
|Class=Class definition
|Defines class=Application page
|Footer template=
|Page properties template=Csp class properties
|Sidebar template=Application page sidebar
|Sub header template=Application page subheader
}}{{Csp show class definition
|$namespacename=Wiki
|$page=Class definition/Person
|Class=Class definition
|Defines class=Person
|Footer template=Test footer
|Page properties template=Csp class properties
|Sidebar template=Csp default sidebar
|Sub header template=Csp default subheader
}}{{Csp show class definition
|$namespacename=Wiki
|$page=Article-settings
|Class=
|Defines class=Article
|Footer template=
|Page properties template=Article properties
|Sidebar template=Article sidebar
|Sub header template=Article subheader
}}{{Csp show class definition
|$namespacename=Wiki
|$page=Class definition/Class definition
|Class=Class definition
|Defines class=Class definition
|Page properties template=Class definition properties
|Sidebar template=Class definition sidebar
|Sub header template=Class definition subheader
}}

</noinclude><includeonly><div class="card mb-3"><div class="card-header">[[{{{$namespacename|}}}:{{{$page|}}} |{{{Defines class|}}}]]</div><ul class="list-group list-group-flush"><li class="list-group-item">{{#switch:{{{Page properties template|}}} |Csp class properties=Csp class properties |=|#default=[[Template:{{{Page properties template|}}} |{{{Page properties template|}}}]] }}</li><li class="list-group-item">{{#if:{{{Footer template|}}} |[[Template:{{{Footer template|}}} |Footer]]|(no footer template) {{#widget:Link |type=a |href=#custom-footer-form-{{anchorencode:{{{Defines class|}}} }} |datatoggle=modal |text={{Fa|edit}} }}
{{Modal
|Targetid=custom-footer-form-{{anchorencode:{{{Defines class|}}} }}
|ModalHeading=Create custom footer template
|BodyText=<form id="footer-form-{{anchorencode:{{{Defines class|}}} }}" >
<_create mwwrite="[Footer template]" mwtemplate="wsnone" formfields="content" noseo mwfollow />
<_edit target="{{{$namespacename|}}}:{{{$page|}}}" template="Csp class properties" mwslot="ws-class-props" formfield="Footer template" />
{{Csp sidebar item
|Label=Footer template
|Value=<input type="text" name="Footer template" class="form-control" value="Template:Csp custom footer/{{{Defines class|}}}" />
}}
<input type="hidden" name="content" value="{{subst:Csp new component template}}" />
<div class="text-right">
<input type="submit" value="{{int:csp-label-save}}" class="btn btn-primary" />
</div>
</form>
|Hide link=Yes
}}
}}</li>{{#if:{{{Sidebar template|}}} |<li class="list-group-item">{{#switch:{{{Sidebar template|}}} |Csp default sidebar=Csp default sidebar {{#widget:Link |type=a |href=#custom-sidebar-form-{{anchorencode:{{{Defines class|}}} }} |datatoggle=modal |text={{Fa|edit}} }}
{{Modal
|Targetid=custom-sidebar-form-{{anchorencode:{{{Defines class|}}} }}
|ModalHeading=Create custom sidebar template
|BodyText=<form id="sidebar-form-{{anchorencode:{{{Defines class|}}} }}">
<_create mwwrite="[Sidebar template]" mwtemplate="subst:Csp new component template" formfields="Content" noseo mwfollow />
<_edit target="{{{$namespacename|}}}:{{{$page|}}}" template="Csp class properties" mwslot="ws-class-props" formfield="Sidebar template" />
{{Csp sidebar item
|Label=Sidebar template
|Value=<input type="text" name="Sidebar template" class="form-control" value="Template:Csp custom sidebar/{{{Defines class|}}}" />
}}
{{Csp sidebar item
|Label=Template content
|Value=<select name="Content" class="form-control" >
<input type="option" value="" selected="selected">(none)</input>
<input type="option" noparse value="Default sidebar">Default sidebar</input>
</select>
}}
<div class="text-right">
<input type="submit" value="{{int:csp-label-save}}" class="btn btn-primary" />
</div>
</form>
|Hide link=Yes
}}
|=|#default=[[Template:{{{Sidebar template|}}} |Sidebar]] }}</li>}}{{#if:{{{Sub header template|}}} |<li class="list-group-item">{{#switch:{{{Sub header template|}}} |Csp default subheader=Csp default subheader {{#widget:Link |type=a |href=#custom-subheader-form-{{anchorencode:{{{Defines class|}}} }} |datatoggle=modal |text={{Fa|edit}} }}
{{Modal
|Targetid=custom-subheader-form-{{anchorencode:{{{Defines class|}}} }}
|ModalHeading=Create custom subheader template
|BodyText=<form id="subheader-form-{{anchorencode:{{{Defines class|}}} }}">
<_create mwwrite="[Sub header template]" mwtemplate="subst:Csp new component template" formfields="Content" noseo mwfollow />
<_edit target="{{{$namespacename|}}}:{{{$page|}}}" template="Csp class properties" mwslot="ws-class-props" formfield="Sub header template" />
{{Csp sidebar item
|Label=Sub-header template
|Value=<input type="text" name="Sub header template" class="form-control" value="Template:Csp custom subheader/{{{Defines class|}}}" />
}}
{{Csp sidebar item
|Label=Template content
|Value=<select name="Content" class="form-control" >
<input type="option" value="" selected="selected">(none)</input>
<input type="option" noparse value="Copy default subheader">Copy default subheader</input>
</select>
}}
<div class="text-right">
<input type="submit" value="{{int:csp-label-save}}" class="btn btn-primary" />
</div>
</form>
|Hide link=Yes
}}|=|#default=[[Template:{{{Sub header template|}}} |Subheader]] }}</li>}}</ul></div></includeonly>

DevOps:Doc/FlexForm/Change-log

2026-02-18T08:22:35Z

Pagesync: Imported by PageSync

===Changelog===
* 2.6.6 : Tempex now supports select, checkboxes and radiobuttons.

* 2.6.5 : Update HTMLPurifier and move to composer. Added default user for internal api call.

* 2.6.4 : fix: A check at MW if a page title is usable was set to early.

* 2.6.3 : Changed Debug mode. For more information, see [[DevOps:Doc/FlexForm/2.0/Installation_of_FlexForm|Installing Flexform config options]]. Fixed leadingzero function. $output not defined fixed. Fix create range when it cannot be set. Have MW check page before it is created.

* 2.6.2 : Fixed deprecation messages

* 2.6.1 : Fixed messaging bug with persistent messages

* 2.6.0 : Added form tag : add-as-job. This will put any EDIT functions into jobs. Updated select2.js. Fixed https://github.com/Open-CSP/FlexForm/issues/77

* 2.5.0 : Maintenance script for syncing Wiki pages that have forms, for us with $config renderonlyapprovedforms and large wikis. '''This will also be the last feature update for MW1.35.x versions of FlexForm'''

* 2.4.2 : Better way of finding actual forms in a page

* 2.4.1 : Fix for select2 focus fields for jQuery bug

* 2.4.0 : Added option to choose which excel tabsheet needs converting

* 2.3.10 : Added additional rebuild data for edited or created page to set properties even if user is not allowed.

* 2.3.9 : Added honeypot when using recaptcha. Fixed an issue with single create and not using fields where noseo was not honoured

* 2.3.8 : Added optgroup support for select

* 2.3.7 : Default to now parse every argument given to tokens and selects

* 2.3.6 : FlexForm Secure JS changes

* 2.3.5 : Request https://github.com/Open-CSP/FlexForm/issues/50 added. Parsing of value for attachmessageto. Fixed Tempex JS issue.

* 2.3.4 : Fixed bug in create using next available option

* 2.3.3 : Version bump to keep in-line with REL1.39

* 2.3.2 : Added new security checks for the Messaging functions

* 2.3.1 : _create with instances and JSON fix and i18n Fix from Pull request #47.

* 2.3.0 : To get consistency: Added parsing of value of allowtags and added required=required to select attribute.

* 2.2.21 : check mwreturn changes to take server port in host into account.

* 2.2.20 : Token bugfix

* 2.2.19 : changed token behaviour for allowsort, allowclear and allowtags. Backwards compatible.

* 2.2.18 : re-write of loading necessary JavaScript

* 2.2.17 : Bug fixes in file upload

* 2.2.15 : Allow for field substitution when using _createuser.

* 2.2.14 : Fix for finding templates on a page with spaces. [https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.14REL1_39 <i class="fab fa-github"></i> v2.2.14REL1_39] / [https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.14REL1_35 <i class="fab fa-github"></i> v2.2.14REL1_35]

* 2.2.12 : Fix for creating pages with ranges. Fix reCaptcha on multiple forms.[https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.12REL1_39 <i class="fab fa-github"></i> v2.2.12REL1_39] / [https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.12REL1_35 <i class="fab fa-github"></i> v2.2.12REL1_35]

* 2.2.11 : Added reCaptcha Enterprise and Recaptcha v2 I'm not a Robot support. [https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.11REL1_39 <i class="fab fa-github"></i> v2.2.11REL1_39] / [https://github.com/Open-CSP/FlexForm/releases/tag/v2.2.11REL1_35 <i class="fab fa-github"></i> v2.2.11REL1_35]

* 2.2.10 : Added recursive parsing of content to find templates and values. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.10 <i class="fab fa-github"></i> REL1_39-v2.2.10] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.10 <i class="fab fa-github"></i> REL1_35-v2.2.10]

* 2.2.9 : Added convert from xls/xlsx to JSON. Added slot support for conversions. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.9 <i class="fab fa-github"></i> REL1_39-v2.2.9] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.9 <i class="fab fa-github"></i> REL1_35-v2.2.9]

* 2.2.8 : Added some addition CSS to instances. Changed no-disable-on-submit to work per form. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.8 <i class="fab fa-github"></i> REL1_39-v2.2.8] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.8 <i class="fab fa-github"></i> REL1_35-v2.2.8]

* 2.2.7 : Fixed no_submit_on_return and disabling submit button. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.7 <i class="fab fa-github"></i> REL1_39-v2.2.7] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.7 <i class="fab fa-github"></i> REL1_35-v2.2.7]

* 2.2.6 : Changed some implementations for messaging and fixes. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.6 <i class="fab fa-github"></i> REL1_39-v2.2.6] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.6 <i class="fab fa-github"></i> REL1_35-v2.2.6]

* 2.2.5 : Added persistent messages, a Messaging special page and update FlexForm per branch

* 2.2.4 : Input type=message now also if secure setting is false. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.4 <i class="fab fa-github"></i> REL1_39-v2.2.4] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.4 <i class="fab fa-github"></i> REL1_35-v2.2.4]

* 2.2.3 : Refresh SMW props changed and Debug options changed [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.3 <i class="fab fa-github"></i> REL1_39-v2.2.3] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.3 <i class="fab fa-github"></i> REL1_35-v2.2.3]

*2.2.2 : Removed HTML Special character on option fields. Deprecated showmessages https://www.open-csp.org/DevOps:Doc/FlexForm/2.0/Installation_of_FlexForm#Notification.2FMessages. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.2 <i class="fab fa-github"></i> REL1_39-v2.2.2] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.2 <i class="fab fa-github"></i> REL1_35-v2.2.2]

*2.2.0 : Added Messaging system. '''Make sure to run update.php for this release!''' [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.2.0 <i class="fab fa-github"></i> REL1_39-v2.2.0] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.2.0 <i class="fab fa-github"></i> REL1_35-v2.2.0]

*2.1.34 : Adjusted code to handle similar template names. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.34 <i class="fab fa-github"></i> REL1_39-v2.1.34] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.34 <i class="fab fa-github"></i> REL1_35-v2.1.34]

*2.1.33 : Force update DeferredUpdate. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.33 <i class="fab fa-github"></i> REL1_39-v2.1.33] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.33 <i class="fab fa-github"></i> REL1_35-v2.1.33]

*2.1.32 : Trimming Tempex Fields before applying. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.32 <i class="fab fa-github"></i> REL1_39-v2.1.32] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.32 <i class="fab fa-github"></i> REL1_35-v2.1.32]

*2.1.31 : Fixed an issue where extension argument is empty. i18n update. ( https://github.com/Open-CSP/FlexForm/pull/35/commits ) [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.31 <i class="fab fa-github"></i> REL1_39-v2.1.31] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.31 <i class="fab fa-github"></i> REL1_35-v2.1.31]

*2.1.30 : Fixed https://github.com/Open-CSP/FlexForm/issues/34. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.30 <i class="fab fa-github"></i> REL1_39-v2.1.30] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.30 <i class="fab fa-github"></i> REL1_35-v2.1.30]

*2.1.29 : Next available namespace issue fix [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.29 <i class="fab fa-github"></i> REL1_39-v2.1.29] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.29 <i class="fab fa-github"></i> REL1_35-v2.1.29]

*2.1.28 : getWikitextForTransclusion double check for nulled content. Fix for instances and form fields arrays. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.28 <i class="fab fa-github"></i> REL1_39-v2.1.28] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.28 <i class="fab fa-github"></i> REL1_35-v2.1.28]

*2.1.27 : When using an unknown namespace when creating a page, use main namespace. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.27 <i class="fab fa-github"></i> REL1_39-v2.1.27] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.27 <i class="fab fa-github"></i> REL1_35-v2.1.27]

*2.1.26 : Could not resolve namespace check added. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.26 <i class="fab fa-github"></i> REL1_39-v2.1.26] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.26 <i class="fab fa-github"></i> REL1_35-v2.1.26]

*2.1.25 : Check to see if a page has a form has been updated to make it only check relevant pages [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.25 <i class="fab fa-github"></i> REL1_39-v2.1.25] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.25 <i class="fab fa-github"></i> REL1_35-v2.1.25]

*2.1.24 : Instances with multiple tokens bug fixed. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.24 <i class="fab fa-github"></i> REL1_39-v2.1.24] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.24 <i class="fab fa-github"></i> REL1_35-v2.1.24]

*2.1.23 : Added config option to toggle null edits (forceNullEdit) [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.23 <i class="fab fa-github"></i> REL1_39-v2.1.23] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.23 <i class="fab fa-github"></i> REL1_35-v2.1.23]

*2.1.22 : Fixed: Ajax calls end routine handling; clean post values are now recursive. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.22 <i class="fab fa-github"></i> REL1_39-v2.1.22] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.22 <i class="fab fa-github"></i> REL1_35-v2.1.22]

*2.1.21 : Fixed error in instances [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.21 <i class="fab fa-github"></i> REL1_39-v2.1.21] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.21 <i class="fab fa-github"></i> REL1_35-v2.1.21]

*2.1.20 : Mail update using composer. Changed organization. Instances not using relaxed search. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.20 <i class="fab fa-github"></i> REL1_39-v2.1.20] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.20 <i class="fab fa-github"></i> REL1_35-v2.1.20]

*2.1.19 : False positive check on secure forms. Added support for quoted json path keys. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.19 <i class="fab fa-github"></i> REL1_39-v2.1.19] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.19 <i class="fab fa-github"></i> REL1_35-v2.1.19]

*2.1.18 : Show error with incorrect use of multiple _creates in one form. Added 2nd check for incomplete secure fields. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.18 <i class="fab fa-github"></i> REL1_39-v2.1.18] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.18 <i class="fab fa-github"></i> REL1_35-v2.1.18]

*2.1.17 : Changed null edit to remove smwproperties refresh. [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.17 <i class="fab fa-github"></i> REL1_39-v2.1.17] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.17 <i class="fab fa-github"></i> REL1_35-v2.1.17]

*2.1.16 : Added timing information on debug [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_39-v2.1.16 <i class="fab fa-github"></i> REL1_39-v2.1.16] / [https://github.com/Open-CSP/FlexForm/releases/tag/REL1_35-v2.1.16 <i class="fab fa-github"></i> REL1_35-v2.1.16]

*2.1.15 : Creating a page not using a template fix for array values

*2.1.14 : Have tokens use the same required="required" options as normal input fields

*2.1.13 : Added non predefined value to show up in token instances. Added valid JSON schema check.

*2.1.12 : Added form permission argument

*2.1.11 : Added tokens rendering to json schema

*2.1.10 : Redirect issue fixed

*2.1.9 : Added replacevariables parser options on semantic ask query

*2.1.8 : Setting display title in a MCR slot fix

*2.1.7 : Fixed Pandoc images name uploads. (Thanks to Bernhard Krabina!)

*2.1.6 : Bug fix for canvas and signature uploads

*2.1.5 : Fixed possible wrong smw query path ( thnx to @Bovine-collab ). This closes https://github.com/Open-CSP/FlexForm/pull/30. Also added array checks not being empty.

*2.1.4 : Simplified phpList mailing ids

*2.1.3 : Managed approved forms bug fixed

*2.1.2 : Added a required field for the PHPList extension ( like a checkbox to allow to register ).

*2.1.1 : Some changes to the extension handler and the PHPList extension to support localsetting configuration for an extension

*2.1 : New features and changes : https://wikibase-solutions.com/developer-logs/flexform-2.1-release

*2.0.12 : Use wfExpandUrl to accommodate for non-null ArticlePath settings

*2.0.11 : Added loadscript config setting

*2.0.10 : TinyMCE selector change.

*2.0.9 : Added parsing of options and selected to Select and Token

*2.0.8 : new way of rendering select and tokens without options

*2.0.7 : fixed HTML argument custom

*2.0.6 : autosave || to &&, Added autosave="none", see docs.

*2.0.4 : Missing sortable on tokens

*2.0.3 : Edit on page id 0 fix

*2.0.2 : Minor tweaks to autosave buttons and the placing

*2.0.0 : Added approved forms, -usercan- options and code optimization, wgCapitalLinks and many more

*1.1.45 : Split wiki edit and create

*1.1.44 : JSON Support for instances. Fixed nooverwrite on create page option.

*1.1.43 : JSON Edit support. Dropped jQuery.UI dependency

*1.1.42 : Instances update and multiple _create json support

*1.1.41 : Add copy and paste support form formats. _create json support finished. Tempex and Calc secure and with instances. reCaptcha changes

*1.1.40 : _create json support

*1.1.39 : Localhost redirect fix

*1.1.38 : API next available warning removed

*1.1.37 : Secure calc added and resolve template fields. Docs : https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/number#Parameters

*1.1.35 : Calc options added. Added Fix for wikis with different paths and urls. Docs : Docs : https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/number#Parameters

*1.1.34 : file upload dropzone verbose fixes. Docs : https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file

*1.1.33 : template support for file pages. Docs : https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file

*1.1.32 : Separated Git from Special page

*1.1.31 : Version bump to git update

*1.1.28 : autosave '''onintervalafterchange'''. Added admin git update feature. Docs : https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/Form_options#autosave

*1.1.27 : Survey module added. More on this later. Filter option for SMQ Queries added. noseo option for _create

*1.1.26 : Rendering instances with default content will do a SMW Ask to get the Display property for a token using its value and Query

*1.1.25 : Instance default-content 2 token fix

*1.1.24 : Fixed an issue where select2 tokens callbacks were initiated multiple times. Removed 1.12 J-UI dependency.

*1.1.23 : Another instance update for tokens. Recent changes are now initiated.

*1.1.22 : Instances and textarea fix

*1.1.21 : Fixed Paragraph tag appearing in fieldset

*1.1.20 : Fixed file upload preview and dropzone issues

*1.1.19 : Added wscreate usefield like options. Fixed SMW query results being escaped

*1.1.17 : Fixed autosave with Instances

*1.1.16 : VE error message fix when nog VE loaded.

*1.1.15 : Extended the hook to contain extension name.

*1.1.14 : Create user email is now a system message. Added FFAfterFormHandling Hook.

*1.1.13 : Added extension support

*1.1.12 : Added entity decoding to mwreturn to support &-sign. Fixed multiple instances issue.

*1.1.11 : SEO url's to file upload

*1.1.10 : Added sortable tokens

*1.1.9 : Addendum and SEO setting

*1.1.8 : FileUpload fix

*1.1.7 : Add HTML screenshot upload (canvas)

*1.1.6 : reCaptcha fixed. Rdy to test. https://github.com/WikibaseSolutions/FlexForm/issues/8

*1.1.5 : Fixed slot creation bug

*1.1.4 : Instances changes

*1.1.3 : Added frame parsing for tokens. Form validation was set to input field validations.. Fixed!

*1.1.2 : Fixed no submit on enter per form. Security checksum changes.

*1.1.1 : Added support for anonymous users

*1.1.0 : Email bot api support, create user support, various fixed after refactoring. Added security options. Special note: By default only a sysop can now edit or create a page with FlexForm on it. This can be changed in the settings for FlexForm.

*1.0 : Initial first public release ''Compared to the previous version any File upload method is not supported and will be added in a later version. Rendering of a form has been rewritten to support themes.''

DevOps:Doc/FlexForm/2.1/input/file/examples

2026-02-18T08:22:19Z

Pagesync: Imported by PageSync

==== Example 1 ====
This will upload a file. If the filename is DCM10001.jpg, the file will be uploaded as '''pictures-DCM10001-732138982.jpg''', The filepage will have '''Information of the test file'''. Finally using '''error_id''' and '''verbose_id''', means the user should add two div's, one with an id="div-error" and one with an id="div-verbose" with these name themselves.
<syntaxhighlight lang="html">
<input type="file" id="fileUpload" name="test" target="pictures-[filename]-[mwrandom]" pagecontent="Information of the test file" error_id="div-error" verbose_id="div-verbose" />
</syntaxhighlight>

==== Example 2 ====
Always make sure an image will be transformed to jpeg.

Allow for multiple file upload.

Add form text field "description" on the files page content.
<syntaxhighlight lang="html">
<form enctype="multipart/form-data" >
<input type="file" id="fileUpload" name="myfile" multiple="multiple" parsecontent target="pictures-[filename]-[mwrandom]" pagecontent="Information for this image: [description]" force="jpg" />
<input type="text" name="description" />
<input type="submit" value="upload" />
</form>
</syntaxhighlight>

==== Example 3 ====
Store a template to the pagecontent. You can use this if you want the filepage to have structured content or if you want to store structured data with an extension like SMW.<syntaxhighlight lang="html">
<form enctype="multipart/form-data" >
<input type="file" id="fileUpload" name="myfile" target="picture-[mwrandom]" parsecontent template="Uploaded file" pagecontent="[flexform-template]|Uploaded from page={{FULLPAGENAME}}|Uploaded by={{CURRENTLOGGEDUSER}}|Comment=[Comment][/flexform-template]" />
<input type="text" name="Comment" placeholder="Comment" />
<input type="submit" value="upload" />
</form>

</syntaxhighlight>

==== Example 4 ====
Convert a Microsoft Docx document to a page in the Wiki. In our example the pagename will be the filename.
<syntaxhighlight lang="html">
<form enctype="multipart/form-data" messageonsuccess="File has been converted and uploaded">
<input type="file" name="myfile" id="fileUpload" multiple="multiple" parsecontent target="[filename]" pagecontent="This image belongs to : [filename]" action="convertfrom:docx" comment="converted and uploaded from {{PAGENAME}}" />
<input type="submit" value="upload" />
</form>

</syntaxhighlight>

==== Example 5 ====
Convert a Microsoft Excel document to a page in the Wiki. The Excel content (from the second sheet) is stored in json format in a slot and a create is used to also store a template in the main slot.
<syntaxhighlight lang="html">
<form enctype="multipart/form-data" messageonsuccess="File has been converted and uploaded">
<div class="form-group">
<fieldset class="form-group"><legend>Upload and convert Excel to Json</legend>
<_create noseo mwwrite="[FFUploadedFile-NewName-myfile]" mwtemplate="Test excel convert" mwfields="FFUploadedFile-UploadName-myfile::Original filename" />
<input type="file" class="form-control-file" id="testingFile" name="myfile" sheet_by_id="1" parsecontent target="[filename]" action="convertfrom:xlsx" slot="ws-data" comment="converted and uploaded from {{PAGENAME}}" accept=".xlsx" target="excel-data-[mwrandom]-[filename]" />
<input type="submit" value="upload" />
</fieldset>
</div>
</form>
</syntaxhighlight>

DevOps:Doc/FlexForm/2.1/input/file

2026-02-18T08:22:17Z

Pagesync: Imported by PageSync

===Name===
file
===Type===
input
===Synopsis===
Using file uploads
===Description===
Use a form to upload one or multiple files.
===Parameters===
input type="file"

'''target'''* : Name of the File page to be created

'''id'''* : This must always be unique, that is, it can only occur once on a page. Do not include a hyphen ("-"), underscore ("_"), or any special characters (also no spaces).

'''action'''* : defaults to '''upload'''. Read more below on using this to convert docx documents to pages in the wiki.

'''name'''* : As with any input field, a name is mandatory

'''pagecontent''': Text content to be added on the File Page. If you are using '''convertfrom''' then any images uploading during the convert will get the pagecontent.

'''comment''': Text to show in recent changes or contributions list

'''force ''': Force images to a certain format (png, jpg or gif). When using this option, any file uploaded that is not supported will be uploaded as is.

'''error_id ''': Id of a DOM Element where error notices will be shown

'''verbose_id ''': Id of a DOM element where information about the file is shown

'''use_label ''': Doesn't require a value. When an input field has a label attached to it, then the label will become the upload button and the input field will be hidden

'''dropzone ''': Doesn't require a value. Will turn the verbose div into an additional file drop zone. If you also '''use_label''', then the label will become the dropzone.

'''parsecontent''': Will force FlexForm to insert values from other form fields inside the pagecontent field. Use square brackets, like [fieldname], where values should be inserted.

'''template''' : If you want to store a template call inside the content of the File page, you can '''template=<name of your template>''' in combination with '''parsecontent'''. [flexform-template] inside your content field will be replaced by '''{{<name of your template''' and '''[/flexform-template]''' will be replaced by '''}}'''. See example 3 on the examples page.

'''multiple''' = multiple

'''*'''= a required variable

The '''target''' is basically the name you want to use to store the file or files. It recognizes '''[mwrandom]''', '''[filename]''' and other form fields, by using their name with square brackets around them (see example). '''pagecontent''' can also hold form variables.

=== action="convertfrom:????" ===
====Pandoc====
The '''action''' argument defaults to ''upload''. If you use '''action="convertfrom:????"''' and you have Pandoc installed on your system, FlexForm will convert a document and create it as a page in the Wiki. '''target''' will then be used as a Page Title. Depending on your version of Pandoc, the results might differ. '''convertfrom''' allows all Pandoc to MediaWiki text conversions. '''docx''' would be a good example : action="convertfrom:docx". Any images uploaded during the convert can have their content of their filepages be filled using '''pagecontent'''. Since version 2.2.9 you can also add an argument '''slot="<name of slot>"''' to have the converted Document be save to a specific slot on the target page, instead of the main slot. Keep in mind, MediaWiki slots need to be defined in your LocalSettings.
====Excel ( since version 2.2.9 )====
You can also use '''action="convertfrom:xls"''' or '''action="convertfrom:xlsx"'''. This allows for converting an Excel xls or xlsx file to JSON. Images are not supported. The argument '''slot''' is supported. ''This conversion is not done using Pandoc and thus will work without having Pandoc installed''. (just make sure you run composer update after you update FlexForm).

As off v2.4.0 the Excel convert action has two extra parameters that allow you to choose an Excel Sheet name, if the Excel document has multiple sheets. '''sheet_by_id''' and '''sheet_by_name'''. If you do not use them, it will work as '''sheet_by_id="0"''' (making it backwards compatible). If you use both arguments, then '''sheet_by_name''' will get the priority.

An excel document like this :
{| class="wikitable"
|'''options'''
|'''description'''
|'''HitCounter'''
|'''WSStats'''
|'''More'''
|-
|$wgDisableCounters
|automatically show hitcounts on a page and Special page
|yes
|no
|WSStats allows for adding this to a page using parser function
|-
|$wgHitcounterUpdateFreq
|frequency of counters update
|yes
|no
|WSStats uses MW DB abstraction layer to update hitcount. The approach is different
|-
|skip_user_groups
|Skip certain user groups in counting
|no
|yes
|
|-
|count_all_usergroups
|Count pages independend of a user group
|no
|yes
|
|}
Will result in the following JSON:
<syntaxhighlight lang="json">
[
{
"options": "$wgDisableCounters",
"description": "automatically show hitcounts on a page and Special page",
"HitCounter": "yes",
"WSStats": "no",
"More": "WSStats allows for adding this to a page using parser function"
},
{
"options": "$wgHitcounterUpdateFreq",
"description": "frequency of counters update",
"HitCounter": "yes",
"WSStats": "no",
"More": "WSStats uses MW DB abstraction layer to update hitcount. The approach is different"
},
{
"options": "skip_user_groups",
"description": "Skip certain user groups in counting",
"HitCounter": "no",
"WSStats": "yes"
},
{
"options": "count_all_usergroups",
"description": "Count pages independend of a user group",
"HitCounter": "no",
"WSStats": "yes"
}
]
</syntaxhighlight>

===HTMLtoImage===
You can also use the field input to upload an image created from part of the page shown where the form is rendered.

Basically, you tell FlexForm you want to render a part of your screen as an image and upload it to the wiki.

The syntax is the same as above, but it only needs : target, name and pagecontent. The other arguments are ignored. Additionally it needs an argument called '''presentor="canvas"''' and it needs the ID of the element you want to convert to an image: '''canvas_source_id'''.

''By default the image will always be a .jpg file. We plan to support png if this is requested.''

For example you have a DIV element with id="content-to-convert". Within this DIV you have content you want to convert to an image an upload to the Wiki.

A FlexForm to utilize this would look something like this :
<syntaxhighlight lang="html">
<div id="content-to-convert" style="width:500px">
<h1>Test Screenshot</h1>
<p>Lots of other content here</p>
</div>

<form>
<input type="file" presentor="canvas" id="canvasUpload" target="testCanvasFile.jpg" pagecontent="testing" canvas_source_id="content-to-convert" />
<input type="submit" value="upload" />
</form>
</syntaxhighlight>

'''You cannot use both file uploads in one form.'''

===Note===
An '''input type="file"''' always needs a unique ID! ( do not use "-", "_", any special characters ( also no spaces ) ).

A form that needs to upload files needs this argument : '''enctype="multipart/form-data"'''. The argument needs to be added to the Form tag, not the input tag. See also : https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/enctype

As FlexForm first handles File Upload, it will add the files processed to use in an _edit or a _create.
Every file upload field needs a name attribute and once a file has been uploaded you can use them in an edit or create in the following format :

*'''FFUploadedFile-UploadName-'''''<name attribute of input field>'' : Will hold the original file name uploaded
*'''FFUploadedFile-UploadBase-'''''<name attribute of input field>'' : Will hold the original file name uploaded without the extension
*'''FFUploadedFile-NewName-'''''<name attribute of input field>'' : Will hold the name of the file as it is uploaded into the Wiki ( Without the File: prefix )

If you use a multiple file upload, then the above values will all be ''',''' separated.

===Links===
====Tutorial====
[https://wikibase-solutions.com/developer-logs/flexform-multiple-file-upload Link to a quick tutorial video shows you how to use one FlexForm form to]:
* upload multiple files. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file input file documentation]
* add a template to the source of the file pages. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file input file documentation]
* have form input fields be added to the arguments for the template. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file input file documentation]
* show a success message after upload. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/Form_options form options]
* add a comment line to your upload visible in the Contributions list and recent changes. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/Form_options form options]
* use a dropzone to drag and drop files. Docs : [https://www.open-csp.org/DevOps:Doc/FlexForm/1.0/input/file input file documentation]
* align form fields using a MW table. Docs : [[mediawikiwiki:Help:Tables|MediaWiki tables]]
* add current date using Magic Words. Docs : [[mediawikiwiki:Help:Magic_words|MediaWiki magic words]]

====Other links====
https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/enctype

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file

https://pandoc.org/

Search-documentation

2026-02-18T08:20:51Z

Pagesync: Imported by PageSync

===Search documentation===
__NOTOC__{{#WikiSearchConfig:
|default operator=and
|base query=[[Class::Doc]]
|aggregation size=50
|Title
|Doc subject
|Doc synopsis
|Doc parent
|Subject version
|Doc target group
|Tag
|?Doc subject
|?Doc target group
|?Doc parent
|?Doc synopsis
|?Subject version
}}
<div class="main-search">
{{#WikiSearchFrontend:size=10
|facets=4
|sort=Modification date
|sort options=Modification date
|ordertype=Modification date
|order=desc
|title=_DTITLE
|layout=template
|template=Show_docs_search_result
|@Doc subject
|@Subject version
|@Doc target group
#label=Target group
|@Tag
#display=pill
|?Doc subject
|?Doc synopsis
|?Subject version
|?Doc target group
|?Doc parent
|?Title
|?$title
|?$snippet
|?$namespacename
|?$page
|?$Modification date#display=date#label=Updated#type=date}}
</div>