Template:VisualDataForm: Difference between revisions

From Visual Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
{{VisualDataForm
{{VisualDataForm
|schemas =  
|schemas =  
|selected-schema =
|title =  
|title =  
|action =  
|action =  
|overwrite-existing-article-on-create =
|view =  
|view =  
|layout =  
|layout =  
Line 13: Line 13:
|preload-data =  
|preload-data =  
|return-page =  
|return-page =  
|return-url =
|popup-size =  
|popup-size =  
|css-class =  
|css-class =  
Line 40: Line 41:
             "type": "string",
             "type": "string",
             "required": true,
             "required": true,
            "default": "",
            "example": ""
        },
        "selected-schema": {
            "label": "selected-schema",
            "description": "the preselected schema if using more then one shema",
            "type": "string",
            "required": false,
             "default": "",
             "default": "",
             "example": ""
             "example": ""
Line 65: Line 58:
             "required": true,
             "required": true,
             "default": "create",
             "default": "create",
            "example": ""
        },
        "overwrite-existing-article-on-create": {
            "label": "overwrite existing article on create",
            "description": "boolean",
            "type": "boolean",
            "required": false,
            "default": false,
             "example": ""
             "example": ""
         },
         },
Line 116: Line 117:
         },
         },
         "return-page": {
         "return-page": {
            "label": "return-page",
            "description": "return page",
            "type": "string",
            "required": false,
            "default": "",
            "example": ""
        },
        "return-url": {
             "label": "return-page",
             "label": "return-page",
             "description": "return page",
             "description": "return page",
Line 239: Line 248:
</templatedata>
</templatedata>
</noinclude>
</noinclude>
<includeonly>{{#visualdataform:{{{schemas}}}|selected-schema = {{{selected-schema|}}}|title = {{{title|}}}|action = {{{action|create}}}|view = {{{view|inline}}}|layout = {{{layout|tabs}}}|callback = {{{callback|}}}|edit-page = {{{edit-page|}}}|preload = {{{preload|}}}|preload-data = {{{preload-data|}}}|return-page = {{{return-page|}}}|popup-size = {{{popup-size|medium}}}|css-class = {{{css-class|}}}|pagename-formula = {{{pagename-formula|}}}|edit-freetext = {{{edit-freetext|}}}|edit-categories = {{{edit-categories|}}}|edit-content-model = {{{edit-content-model|}}}|target-slot = {{{target-slot|}}}|edit-target-slot = {{{edit-target-slot|}}}|default-categories = {{{default-categories|}}}|default-content-model = {{{default-content-model|wikitext}}}|layout-align = {{{layout-align|top}}}|popup-help = {{{popup-help|}}}|submit-button-text = {{{submit-button-text|submit}}}|validate-button-text = {{{validate-button-text|validate}}} }}
<includeonly>{{#visualdataform:{{{schemas}}}|title = {{{title|}}}|action = {{{action|create}}}|overwrite-existing-article-on-create = {{{overwrite-existing-article-on-create|}}}|view = {{{view|inline}}}|layout = {{{layout|tabs}}}|callback = {{{callback|}}}|edit-page = {{{edit-page|}}}|preload = {{{preload|}}}|preload-data = {{{preload-data|}}}|return-page = {{{return-page|}}}|return-url = {{{return-url|}}}|popup-size = {{{popup-size|medium}}}|css-class = {{{css-class|}}}|pagename-formula = {{{pagename-formula|}}}|edit-freetext = {{{edit-freetext|}}}|edit-categories = {{{edit-categories|}}}|edit-content-model = {{{edit-content-model|}}}|target-slot = {{{target-slot|}}}|edit-target-slot = {{{edit-target-slot|}}}|default-categories = {{{default-categories|}}}|default-content-model = {{{default-content-model|wikitext}}}|layout-align = {{{layout-align|top}}}|popup-help = {{{popup-help|}}}|submit-button-text = {{{submit-button-text|submit}}}|validate-button-text = {{{validate-button-text|validate}}} }}
</includeonly>
</includeonly>



Latest revision as of 08:25, 16 August 2024

{{VisualDataForm
|schemas = 
|title = 
|action = 
|overwrite-existing-article-on-create = 
|view = 
|layout = 
|callback = 
|edit-page = 
|preload = 
|preload-data = 
|return-page = 
|return-url = 
|popup-size = 
|css-class = 
|pagename-formula = 
|edit-freetext = 
|edit-categories = 
|edit-content-model = 
|target-slot = 
|edit-target-slot = 
|default-categories = 
|default-content-model = 
|layout-align = 
|popup-help = 
|submit-button-text = 
|validate-button-text = 
}}

Attention! VisualEditor won't handle the template correctly if it contains new lines!! <templatedata> {

   "description": "A parser function to enclose one or more schemas in a form",
   "params": {
       "schemas": {
           "label": "schemas",
           "description": "one more schema name, comma separated",
           "type": "string",
           "required": true,
           "default": "",
           "example": ""
       },
       "title": {
           "label": "title",
           "description": "title of the form (or the panel if a form containing multiple schemas)",
           "type": "string",
           "required": true,
           "default": "",
           "example": ""
       },
       "action": {
           "label": "action",
           "description": "form action, can be create or edit",
           "type": "string",
           "required": true,
           "default": "create",
           "example": ""
       },
       "overwrite-existing-article-on-create": {
           "label": "overwrite existing article on create",
           "description": "boolean",
           "type": "boolean",
           "required": false,
           "default": false,
           "example": ""
       },
       "view": {
           "label": "view",
           "description": "display mode of the form, can be inline or popup",
           "type": "string",
           "required": true,
           "default": "inline",
           "example": ""
       },
       "layout": {
           "label": "layout",
           "description": "form layout with multiple schemas, can be tabs or booklet",
           "type": "string",
           "required": true,
           "default": "tabs",
           "example": ""
       },
       "callback": {
           "label": "callback",
           "description": "(javascript) callback function called on submit",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "edit-page": {
           "label": "edit-page",
           "description": "title of the page holding the data to edit (with edit action)",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "preload": {
           "label": "preload",
           "description": "page name with preload wikitext",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "preload-data": {
           "label": "preload data",
           "description": "page name with preload json data",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "return-page": {
           "label": "return-page",
           "description": "return page",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "return-url": {
           "label": "return-page",
           "description": "return page",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "popup-size": {
           "label": "popup-size",
           "description": "popup-size, possible values: small, medium, large, larger full",
           "type": "string",
           "required": false,
           "default": "medium",
           "example": ""
       },
       "css-class": {
           "label": "css-class",
           "description": "css-class to be attached to the form",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "pagename-formula": {
           "label": "pagename-formula",
           "description": "formula used to create a new article through the form with the entered data, in the form contacts/<first_name> <last_name>, where <first_name> and <last_name> are the property names of the related schema",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "edit-freetext": {
           "label": "edit-freetext",
           "description": "whether the form allows to edit freetext",
           "type": "boolean",
           "required": false,
           "default": "0",
           "example": ""
       },
       "edit-categories": {
           "label": "edit-categories",
           "description": "whether the form allows to edit categories",
           "type": "boolean",
           "required": false,
           "default": "0",
           "example": ""
       },
       "edit-content-model": {
           "label": "edit-content-model",
           "description": "whether the form allows to edit the content model",
           "type": "boolean",
           "required": false,
           "default": "0",
           "example": ""
       },
       "target-slot": {
           "label": "target-slot",
           "description": "target slot for article metadata, could be jsondata or main",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "edit-target-slot": {
           "label": "edit target-slot",
           "description": "edit target slot",
           "type": "boolean",
           "required": false,
           "default": "0",
           "example": ""
       },
       "default-categories": {
           "label": "default-categories",
           "description": "default categories (comma separated)",
           "type": "string",
           "required": false,
           "default": "",
           "example": ""
       },
       "default-content-model": {
           "label": "default-content-model",
           "description": "default content model",
           "type": "string",
           "required": false,
           "default": "wikitext",
           "example": ""
       },
       "layout-align": {
           "label": "layout-align",
           "description": "default align for the OO.ui.FieldLayout, possible values are left right top inline",
           "type": "string",
           "required": false,
           "default": "top",
           "example": ""
       },
       "popup-help": {
           "label": "popup-help",
           "description": "corresponds to helpinline set to false in the OO.ui.FieldLayout",
           "type": "boolean",
           "required": false,
           "default": "0",
           "example": ""
       },
       "submit-button-text": {
           "label": "submit-button-text",
           "description": "text of the submit button",
           "type": "string",
           "required": false,
           "default": "submit",
           "example": ""
       },
       "validate-button-text": {
           "label": "validate-button-text",
           "description": "text of the validate button",
           "type": "string",
           "required": false,
           "default": "validate",
           "example": ""
       }
   }

} </templatedata>