CRUD

From Wikisphere
Revision as of 10:45, 27 January 2024 by Admin (talk | contribs)
Jump to navigation Jump to search
Subpages:

The following demonstrates the creation of a CRUD (create, read, update, delete) interface performed through a button opening a popup form, a visualdataquery parser function that creates the table, and a template, namely Template:Task_action, rendered within the column "action", holding another form that edits the same schema (VisualDataSchema:Task) based on the data of the page with value {{{pagetitle}}}, where {{{pagetitle}}} is the title of the article related to each row of the generated table. (see the docs for other parameters)

The template is associated to the column "action" using the following wikitext

template?action=Task action

and all the properties of the row, as well as the article title, are available as named parameters.


The form also demostrates the use of the option target-slot = main that instructs the form to save the json data to the main slot of the target article, as you can see here. Such data can then be edited through the edit button in the action column, through the tab "Edit semantic" in the target article, or even manually through "edit source" in the target article, and the changes will be reflected in the table below.

The form also shows the integration of Extension:VEForAll in the comments field.


form is loading...




Here are the components to implement it.

1) Json-schema describing the form: VisualDataSchema:Task (created through the Schema builder)


2) parser function for the form button

{{#visualdataform: Task
|title = Task
|action = create
|edit-page = 
|return-page = CRUD
|view = popup
|popup-size = large
|css-class =
|pagename-formula =CRUD/<id-increment>
|target-slot = main
|edit-freetext = false	
|edit-categories = false
|edit-content-model = false
|default-categories = 
|default-content-model = wikitext
|layout-align = top
|popup-help = true 
|submit-button-text =
|layout = tabs
|validate-button-text =
}}


3) Parser function for the table


{{#visualdataquery: [[CRUD/~]]
|schema=Task 
|?assignee
|?extension
|?status
|?action
|template?action=Task action
|format=datatable 
}}


4) template Template:Task action, containing another visualdata form, as mentioned called from the query for each row

5) The templates Template:Extensions_list and Task_status_list (actually not a template) used in the form's dropdowns

6) The extension IDProvider triggered from an hidden input in the same schema, and then used as pagename-formula

7) The extension VEForAll in order to display VisualEditor in the textarea


Of course the extension VisualData, Semantic MediaWiki is not required.




This is a page with an infobox that demonstrates the use of VisualData (latest version) used as a CRUD

Click the button below to edit the article's metadata through a popup or the tab "Edit semantic" among the article's actions.


form is loading...


The popup is rendered using the following code

{{#visualdataform: Book
|title = edit infobox and page
|action = edit
|edit-page = {{FULLPAGENAME}}
|return-page = 
|view = popup
|popup-size = medium
|css-class =
|pagename-formula =
|edit-freetext = true	
|edit-categories = false
|edit-content-model = false
|default-categories = 
|default-content-model = wikitext
|layout-align = top
|popup-help = true 
|submit-button-text =
|layout = tabs
|submit-button-text =
|validate-button-text =
}}

A Pageproperties' form can edit whatever page (through the parameter edit-page, and create new pages with user-defined title or using a pagename formula. It is json/schema compliant[1] and can handle subitems, multiple fields and multiple sub items. It is deeply integrated with the Mediawiki's OOUI library and uses a lot or most of its features. In the latest version can query properties and nested properties, as well as render them using templates and nested templates and does not rely on SemanticMediawiki.


The infobox is rendered through the following code:

{{#visualdataprint: {{FULLPAGENAME}}
|?cover
|?title
|?authors/name
|?authors/email
|schema=Book
|template=Book
|template?authors=Book authors
|format=template
}}


This is a SemanticMediawiki-like parser function that can be used as a shorthand to invoke the more complex {{#visualdataquery }} parser function that can handle multi-page results and provides a basic query language. (more about this on the official page of the extension to be updated soon)

The results are rendered on the page using 2 templates, Template:Book and Template:Book authors. The second is used as a nested template rendered inside the parent template (Template:Book) entitled to render the properties with path authors. Note that the parent template must include a reference to the name of the child template since both values and template's containers are passed as named parameters.


The form's schema(s) (a form can contain an arbitrary number of schemas, and a schema an arbitrary number of items and subitems) can be edited using this Special page or this interface (tab Edit semantic, edit icon on the right and then "Manage schemas")

The related schema created by the UI contains an hidden property "name" that is filled-in with the compounded value of the fields first_name and last_name. Also, the cover file name contains a value-formula, that allows the file to be saved with the article-id as prefix (also for new articles) which is useful to easily upload on the wiki files with similar names.


Have fun with this extension !!


See also

  1. It does not yet support allOf, anyOf, oneOf, and $refs both in the editor and in the viewer