View source for Extension:VisualData/my

<languages/>
{{Extension
|name                 = VisualData
|status               = stable
|type1                = hook
|type2                = special page
|hook1                =
|hook2                =
|newhook1             =
|newhook2             =
|username             = thomas-topway-it
|author               =
|description          = VisualData is a full-fledged metadata management framework based on json-schema able to easily record, organize and query collection of data on your wiki.
|image                =
|imagesize            =
|version              = 1.0.6
|update               = 2024-04-09
|version preview      =
|update preview       =
|mediawiki            = >= 1.35.0
|compatibility policy = master
|php                  =
|needs-updatephp      =
|composer             =
|table1               =
|table2               =
|license              = GPL-2.0-or-later
|download             = {{WikimediaDownload|VisualData|phab=EPPR}}
|readme               =
|changelog            =
|example              =
|namespace            =
|parameters           =
|tags                 =
|rights               =
|compatibility        =
|bugzilla             =
|phabricator          =
|vagrant-role         =
}}

'''VisualData''' is a full-fledged metadata management framework based on [https://json-schema.org/ json-schema] able to easily record, organize and query collection of data on your wiki.

It is characterized by a strong emphasis on the UI/UX side and aims to present itself as a lightweight or modern alternative to [[Extension:Semantic_MediaWiki|Semantic MediaWiki]] and [[Extension:Cargo|Cargo]].

== Key-features ==
* Based on [https://json-schema.org/ json-schema] and [[Manual:Slot|slots]]
* [[Extension:VisualData/Forms|forms and pop-up forms]] auto-generated from json-schema
* Integrated [[Extension:VisualData/Schema Builder|SchemaBuilder]] to easily create json-schema compliant schemas, with nested items and OOUI widgets
* Forms are validated with industry-standard [https://github.com/ajv-validator/ajv ajv-validator]
* SMW's style inline [[Extension:VisualData/Queries|queries]] and [[Extension:VisualData/Result formats|result formats]]
* Can import/store/query large amount of data (with hierarchical structure) in specific articles/the entire wiki, and to rebuild them in minutes
<!-- * Easy to use for data structure prototyping (without renounce to inherent complexity) thanks to the UI-centric approach -->
<div lang="en" dir="ltr" class="mw-content-ltr">
== UI elements ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The extension adds the following interface elements to your wiki (some of them only for authorized users and/or sysops)
</div>

* A sidebar section where to access all special pages offered by the extension<br />

[[File:VisualDataScreenCapture-sidebar-links.png|240px|frameless]]<br />


* The action tab "Edit data" by which to assign schemas to article and fill-in them through automatically generated OOUI forms<br />

[[File:VisualDataScreenCapture-action-edit-data.png|360px|frameless]]<br />


* and a namespace tab where to access the slot with json-data registered within an article through the extension<br />

[[File:VisualDataScreenCapture-tab-jsondata-b.png|600px|frameless]]<br />


<span lang="en" dir="ltr" class="mw-content-ltr">The visibility of each of them can be managed using the [[#Global parameters|global parameters]] below.</span>

<!--
with links to the special page "New article", to create a new article through a OOUI form, a link  to the legacy special page "VisualData" to define some core properties of the current article plus SEO metadata, a link to the special page Manage Schemas where to manage [https://json-schema.org/ json-schema] compliant schemas to be assigned to wiki articles, and a linl to the special page "Browse Data" where you can browse data (json data produced by each schema), forms, queries, and schemas themselves, created on your wiki through the extension.
-->

<div lang="en" dir="ltr" class="mw-content-ltr">
==Installation==
</div>
* <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:ExtensionDistributor/VisualData|Download]] and place the file(s) in a directory called <code>VisualData</code> in your <code>extensions/</code> folder.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Add the following code at the bottom of your {{ll|Manual:LocalSettings.php|LocalSettings.php}}</span>
<syntaxhighlight lang="php">
wfLoadExtension( 'VisualData' );
</syntaxhighlight>
* Run <code>php maintenance/update.php</code> (this will install the required tables)
* run <code>composer install --no-dev</code> in the extension folder. This will install the required libraries<ref>although the extension works without additional libraries, they are required to handle rename of schemas and properties, and to support [[Extension:VisualData/Forms|preload-data override]]</ref>
* {{Done}} – <span lang="en" dir="ltr" class="mw-content-ltr">Navigate to [[Special:Version]] on your wiki to verify that the extension is successfully installed.</span>

Make sure to run
<pre>
php extensions/VisualData/maintenance/RebuildData.php
</pre>
after each update of the extension when indicated in the [[Extension:VisualData/Release_notes|Release notes]]. This will drop/recreate the tables based on the data stored on the wiki

== Main sections ==

{{ContentGrid
|content=

{{Colored box
|title =  New article UI
|style = grid-column: 1; grid-row: 1;
|content = [[Extension:VisualData/New article UI|New article UI]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Schema Builder & File upload
|style = grid-column: 2; grid-row: 1;
|content = [[Extension:VisualData/Schema Builder|Schema Builder]]

[[Extension:VisualData/File upload|File upload]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Edit data
|style = grid-column: 1; grid-row: 2;
|content = [[Extension:VisualData/Edit data|Edit data]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Forms
|style = grid-column: 2; grid-row: 2;
|content = [[Extension:VisualData/Forms|Forms]]

[[Extension:VisualData/Geolocation|Geolocation]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Queries
|style = grid-column: 1; grid-row: 3;
|content = [[Extension:VisualData/Queries|Queries]]

[[Extension:VisualData/Queries in forms|Queries in forms]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Result formats
|style = grid-column: 2; grid-row: 3;
|content = [[Extension:VisualData/Result_formats|Result formats]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Browse data
|style = grid-column: 1; grid-row: 4;
|content = [[Extension:VisualData/Browse data|Browse data]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Maintenance scripts
|style = grid-column: 2; grid-row: 4;
|content = [[Extension:VisualData/Maintenance scripts|Maintenance scripts]]
|link2 =
|view-text =
}}

{{Colored box
|title =  Miscellaneous
|style = grid-column: 1; grid-row: 5;
|content = [[Extension:VisualData/QueryLink parser function|QueryLink parser function (dynamic catalogue)]]

[[Extension:VisualData/Release notes|Release notes]]
|link2 =
|view-text =
}}

}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==Rights and privileges==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">The extension creates the following [[Special:MyLanguage/Manual:User rights|user rights]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">They can be both included manually in the [[Special:MyLanguage/Manual:LocalSettings.php|LocalSettings.php]] or to be managed through the interface (special page [[Special:UserRights]]).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Sysops and bureaucrats are assigned with the complete set of permissions by default.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
===Rights===
</div>

{| class="wikitable"
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">variable</span> !! <span lang="en" dir="ltr" class="mw-content-ltr">description</span>
|-
| {{phpi|visualdata-caneditdata}} ||  Can edit metadata related to wiki articles by editing/assigning json-schemas to them
|-
| {{phpi|visualdata-canmanageschemas}} || Can create/edit/delete schemas through the SchemaBuilder
|-
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
===Example configuration===
</div>

<syntaxhighlight lang="php">
$wgGroupPermissions['*']["visualdata-caneditdata"] = true;
$wgGroupPermissions['*']["visualdata-canmanageschemas"] = false;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
===Groups===
</div>
{| class="wikitable"
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">group</span> !! Can edit data || Can manage schemas
|-
| {{phpi|sysop}}, {{phpi|bureaucrat}} ||  {{done|1=&nbsp;}} || {{done|1=&nbsp;}}
|-
| {{phpi|visualdata-admin}} || {{done|1=&nbsp;}} || {{done|1=&nbsp;}}
|-
| {{phpi|visualdata-editor}} ||  {{done|1=&nbsp;}} || {{not done|1=&nbsp;}}
|-
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
==Global parameters==
</div>
{| class="wikitable"
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">variable</span> !! <span lang="en" dir="ltr" class="mw-content-ltr">description</span> !! <span lang="en" dir="ltr" class="mw-content-ltr">default</span>
|-
| {{phpi|$wgVisualDataDisableSlotsNavigation}} || ညွှန်ကြားရေး panel ပေါ်တွင် slot tab ကို hide လုပ်ပါ။ || <code>false</code>
|-
| {{phpi|$wgVisualDataDisableSidebarLink}} || <span lang="en" dir="ltr" class="mw-content-ltr">hide VisualData's links section on the sidebar</span> || <code>false</code>
|-
| {{phpi|$wgVisualDataEditDataNamespaces}} || default namespaces with editable metadata || <code> 0, 4 (Main, Project)</code>
|-
| {{phpi|$wgVisualDataJsonDataTrackingCategory}} || add a tracking category to articles with data || <code>false</code>
|-
| {{phpi|$wgVisualDataCreateJobsWarningLimit}} || <span lang="en" dir="ltr" class="mw-content-ltr">number of jobs created without emitting a notice</span>  || <code>0</code>
|-
| {{phpi|$wgVisualDataDisableVersionCheck}} || <span lang="en" dir="ltr" class="mw-content-ltr">disable version check of the extension</span>  || <code>false</code>
|-
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
== Known issues ==
</div>
* in some MediaWiki versions and configurations, the [[ResourceLoader]] may generate syntax errors when bundling the Javascript files. In this case please use <code>$wgResourceLoaderDebug = true;</code> in LocalSettings.php, this will include separately each file and should solve the problem.
* rename of schemas and properties must be kept in synch with property and schema names hardcoded in parser functions. This will be solved implementing a query and form builder (see [[#Roadmap]])
* queries require that the first printout exists, otherwise the row will not show. This could be solved using [https://dev.mysql.com/doc/refman/8.0/en/select.html DUAL] keyword
* the SchemaBuilder and the form processor do not yet support the directives <code>oneOf</code>, <code>anyOf</code> and support for the <code>$ref</code> keyword
* table/datatables do not yet provide dynamic navigation, although a navigation may be implemented by users using the limit/offset parameters and [[Extension:VisualData/QueryLink_parser_function|QueryLink parser function]]

<div lang="en" dir="ltr" class="mw-content-ltr">
== Roadmap ==
</div>
<!--* dependent values with wiki-lists (form generator)-->
* add <code>oneOf</code>, <code>anyOf</code> and <code>allOf</code> support to form generator and SchemaBuilder (the SchemaBuilder will contain a select on the schema main panel)
* add [https://json-schema.org/understanding-json-schema/reference/array#tupleValidation tuple] and  <code>$ref</code> keyword to SchemaBuilder (properties panel, besides 'add field', 'add content block', etc.)
* add additional properties to SchemaBuilder (additional panel)
* add query and form builder: this will store queries and forms as json schemas so that rename of schemas or properties can be updated within such schemas, not in the wikitext. The parser function will add queries and forms by their names or code
* UI for bulk-edit of json data in the BrowseData special page
* Ajax navigation for datatables, SearchPanes and SearchBuilder


Additionally:
* version control for schemas and related data, so that edits of the schema constrain to the data related to the previous data structure
* version control notice shown through [[Extension:Echo]] and/or complying better design practice
* partial editing of schemas and field operations like Firebase's ArrayUnion, ArrayRemove, etc.
* preload [https://json-ld.org/ json-ld]/[https://schema.org/docs/full.html schema.org] entities as json-schemas
* associate [https://json-ld.org/ json-ld]/[https://schema.org/docs/full.html schema.org] vocabulary to user-defined schemas


==Release notes==

[[Extension:VisualData/Release_notes|Extension:VisualData/Release notes]]


<div lang="en" dir="ltr" class="mw-content-ltr">
== Support & bugs ==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Please post error messages in the [[Special:MyLanguage/Extension talk:VisualData|Talk page of the extension]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Updates will be occasionally posted on the MediaWiki's [https://lists.wikimedia.org/postorius/lists/mediawiki-l.lists.wikimedia.org/ Wikitech mailing list].</span>

'''<span lang="en" dir="ltr" class="mw-content-ltr">For professional support please write at the email address posted [[User:Thomas-topway-it|here]]</span>'''

<div lang="en" dir="ltr" class="mw-content-ltr">
==See also==
</div>
* {{ll|Extension:Semantic MediaWiki}}
* {{ll|Extension:Cargo}}
* {{ll|Extension:PageForms}}
* {{ll|Extension:FlexForm}}
* {{ll|Manual:Managing data in MediaWiki}} – <span lang="en" dir="ltr" class="mw-content-ltr">An overview and comparison</span>
<!-- * {{ll|Extension:ContactManager}} -->

<div lang="en" dir="ltr" class="mw-content-ltr">
== References==
</div>
* [https://wikisphere.org/wiki/Test_pageproperties_2.0 Demos on Wikisphere]
* [https://json-schema.org/ json-schema]
* [https://pmk65.github.io/jedemov2/dist/demo.html json-editor demo]
* [https://json.bootsphp.com/jsonSchemaCreator/ json-schema creator]
* [https://www.schemastore.org/json/ schema store]
* [https://php-json-schema-model-generator.readthedocs.io/en/latest/gettingStarted.html php-json-schema-model-generator]

== Test it out ! ==

<!--[https://wikienterprise.org/wiki/Main_Page WikiEnterprise]-->
[https://wikisphere.org/wiki/Main_Page WikiSphere]

[[Category:Page metadata extensions{{#translation:}}]]
[[Category:Data extraction extensions{{#translation:}}]]
[[Category:Database_extensions{{#translation:}}]]
[[Category:Data management extensions{{#translation:}}]]
[[Category:Table extensions{{#translation:}}]]
[[Category:Page content extensions{{#translation:}}]]