Help:Wiki administration - Revision history

Marc Schleiss at 12:55, 10 December 2024

2024-12-10T12:55:59Z

← Older revision		Revision as of 14:55, 10 December 2024
Line 14:		Line 14:

	A complete list of all the installed extensions, plus detailed information on software versions can be found in each wiki's [[Special:Version]] page		A complete list of all the installed extensions, plus detailed information on software versions can be found in each wiki's [[Special:Version]] page


	=Wiki Ecosystem=		=Wiki Ecosystem=

Andre Castro: /* creating new users */

2024-09-24T10:10:08Z

creating new users

← Older revision		Revision as of 12:10, 24 September 2024
Line 69:		Line 69:

	==creating new users==		==creating new users==
	~~Wiki Admins bureaucrats (see wiki admins list in [~~
	~~https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special%3AListUsers&username=&group=bureaucrat Special:ListUsers]) can use the page [[Special:CreateAccount]] to create new user accounts~~

	Once the account is created an email, similar to the following template ~~can~~ be sent out to the new user:		'''New users can request accounts via Github issues in https://github.com/ruisdael-observatory/Ruisdael-Data-Catalog/issues/new?template=WikiAccount.yml'''.

			The issue form is based on a template used is located in https://github.com/ruisdael-observatory/Ruisdael-Data-Catalog/blob/main/.github/ISSUE_TEMPLATE/WikiAccount.yml which can be changed easily.

			[[File:Screenshot 2024-09-24 at 11-53-36 New Issue · ruisdael-observatory Ruisdael-Data-Catalog.png\|500px]]



			Wiki admins & bureaucrats (see wiki admins list in [https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special%3AListUsers&username=&group=bureaucrat Special:ListUsers]) can use the page [[Special:CreateAccount]] to create new user accounts

			'''Once the account is created, an email, similar to the following template, shall be sent out to the new user.'''

	<syntaxhighlight lang="email">		<syntaxhighlight lang="email">

	~~Created a~~ account for ~~you in~~ the Ruisdael Observatory Data Catalog ~~Wiki~~ (https://ruisdael-catalog.citg.tudelft.nl) under the username @@@given-name surname@@@		Your user-account for the Ruisdael Observatory Data Catalog (https://ruisdael-catalog.citg.tudelft.nl) has been under the username @@@given-name surname@@@

	The default password is: @@@XYZ@@@. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)		The default password is: @@@XYZ@@@. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)
Line 82:		Line 90:
	</syntaxhighlight>		</syntaxhighlight>

	'''~~User names~~ should be the ~~given-name + family name of~~ the ~~user~~''' ~~ie Marc Schleiss~~
			'''A comment should be added to the Github issue''' ie. "Your user account has been created. Check your mailbox for further details", '''followed by the issue closure'''.

	=Semantic Properties and Categories=		=Semantic Properties and Categories=

Andre Castro: /* creating new users */

2024-09-17T14:01:27Z

creating new users

← Older revision		Revision as of 16:01, 17 September 2024
Line 76:		Line 76:
	<syntaxhighlight lang="email">		<syntaxhighlight lang="email">

	Created a account for you in the Ruisdael Observatory Data Catalog Wiki (https://ruisdael-catalog.citg.tudelft.nl)		Created a account for you in the Ruisdael Observatory Data Catalog Wiki (https://ruisdael-catalog.citg.tudelft.nl) under the username @@@given-name surname@@@

	The default password is: @@@XYZ@@@. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)		The default password is: @@@XYZ@@@. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)

Andre Castro: /* creating new users */

2024-09-17T13:57:55Z

creating new users

← Older revision		Revision as of 15:57, 17 September 2024
Line 78:		Line 78:
	Created a account for you in the Ruisdael Observatory Data Catalog Wiki (https://ruisdael-catalog.citg.tudelft.nl)		Created a account for you in the Ruisdael Observatory Data Catalog Wiki (https://ruisdael-catalog.citg.tudelft.nl)

	The default password is: ~~changemenow~~. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)		The default password is: @@@XYZ@@@. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)

	</syntaxhighlight>		</syntaxhighlight>

Andre Castro: /* creating new users */

2024-09-17T13:56:52Z

creating new users

← Older revision		Revision as of 15:56, 17 September 2024
Line 82:		Line 82:
	</syntaxhighlight>		</syntaxhighlight>

			'''User names should be the given-name + family name of the user''' ie Marc Schleiss

	=Semantic Properties and Categories=		=Semantic Properties and Categories=

Andre Castro at 11:51, 17 September 2024

2024-09-17T11:51:06Z

← Older revision		Revision as of 13:51, 17 September 2024
Line 81:		Line 81:

	</syntaxhighlight>		</syntaxhighlight>


			=Semantic Properties and Categories=
			Powered by [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic Mediawiki (SMW)] extension

			'''Semantic properties and categories organize and describe content in machine-readable ways, allowing for structured queries and dynamic content aggregation'''

			* Semantic annotations via
			** ''categories'' to stipulate what each wiki page is. ie. [[:Category:Dataset]] categorizes the Dataset pages. All wiki categories are listed in [[Special:Categories]]
			** ''property::value'' pairs and , ie this page uses [[Property:Date]] and [[Property:pertainsTo]] associated a media file to other wiki pages. All declared properties are listed in [[Special:Properties]]

			'''Category declaration pages''' do not need to be created, in order to be used. See all categories used in this wiki at [[Special:Categories]].


			'''Property declaration pages''' are essential to define what each property is <ref>https://www.semantic-mediawiki.org/wiki/Help:List_of_datatypes</ref>, its data type<ref>https://www.semantic-mediawiki.org/wiki/Help:List_of_datatypes</ref> and other possible definitions such as label(s)<ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Has_preferred_property_label</ref>, descriptions <ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Has_property_description</ref>, allowed values<ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Allows_value</ref>, etc. See all special properties in in https://www.semantic-mediawiki.org/wiki/Help:Special_properties. See all properties used in this wiki at [[Special:Properties]].


			==Annotating Pages with Categories & Properties==

			Although categories and properties can be include onto wiki pages via text. ie. I can say that this page is described with the properties [[Property:Date]] and [[Property:relatedTo]] with the following piece of text:

			<nowiki>
			[[hasDate::2024.09.17]]
			[[relatedTo::Main Page]]
			</nowiki>

			The usual way the user will interact with them, is indirectly via forms and templates.

			==Editing with Form & Template pairs==

			In short the Form: pages pass-on the user entered content onto templates, and those templates have properties with template variables, that will be substituted with user entered content.

			See:
			* [https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special%3AAllPages&from=&to=&namespace=106 all Forms]
			* [https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special%3AAllPages&from=&to=&namespace=10 all Templates]

			==Querying the categories and properties==

			[[Special:Ask]] page provides a query interface, where users can draft semantic queries, to generate up-to-date results, based on properties and categories, displayed in chosen formats, ie. tables, lists, maps, timelines, etc. The query code can be copied from this interface and pasted on the page where the query results shall be expressed ie. see the [[Main Page]] for examples.

			For more info see https://www.semantic-mediawiki.org/wiki/Help:Browsing_and_searching


			==Data model of this wiki==
			see [[Help:Data Catalog Schema]]



	=References=		=References=

Andre Castro: /* Visibility and Permissions */

2024-09-17T11:37:38Z

Visibility and Permissions

← Older revision		Revision as of 13:37, 17 September 2024
Line 62:		Line 62:

	</syntaxhighlight>		</syntaxhighlight>


	'''[[Ruisdael Data Catalog Wiki]], [[GRS Wiki]], [[CCRES Wiki]]''': reading interface is public, editing is restricted to logged in users. Account creation restricted to administrators and bureaucrats.

	~~Config from [[Ruisdael Data Catalog Wiki]]:~~

	~~<syntaxhighlight lang=php>~~
	~~# Permissions~~
	~~$wgGroupPermissions['*']['read'] = true;~~
	~~$wgGroupPermissions['*']['edit'] = false;~~
	~~$wgGroupPermissions['user']['edit'] = true;~~
	~~$wgGroupPermissions['*']['createaccount'] = false;~~
	~~$wgGroupPermissions['bureaucrat']['createaccount'] = true;~~
	~~</syntaxhighlight>~~


	=wiki maintenance=		=wiki maintenance=

Andre Castro at 11:00, 17 September 2024

2024-09-17T11:00:18Z

← Older revision		Revision as of 13:00, 17 September 2024
Line 1:		Line 1:
			__TOC__

	=Ruisdael Observatory Data Catalog Wiki=		=Ruisdael Observatory Data Catalog Wiki=

Andre Castro at 10:59, 17 September 2024

2024-09-17T10:59:27Z

@@ Line 75: / Line 75: @@
 $wgGroupPermissions['bureaucrat']['createaccount'] = true;
 </syntaxhighlight>
 =wiki maintenance=
@@ Line 95: / Line 96: @@
 </syntaxhighlight>
 =References=

Andre Castro: Created page with " =Ruisdael Observatory Data Catalog Wiki= This wiki consist of installations of [https://www.mediawiki.org/wiki/MediaWiki Mediawiki] software, with some added [https://www.mediawiki.org/wiki/Manual:Extensions Mediawiki extensions]. The most relevant extensions are: * [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic Mediawiki] (SMW) - allows wiki pages to contain structured data, through the use of semantic annotations, performed with with property:..."

2024-09-17T10:50:26Z

Created page with " =Ruisdael Observatory Data Catalog Wiki= This wiki consist of installations of [https://www.mediawiki.org/wiki/MediaWiki Mediawiki] software, with some added [https://www.mediawiki.org/wiki/Manual:Extensions Mediawiki extensions]. The most relevant extensions are: * [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic Mediawiki] (SMW) - allows wiki pages to contain structured data, through the use of semantic annotations, performed with with property:..."

New page

=Ruisdael Observatory Data Catalog Wiki=

This wiki consist of installations of [https://www.mediawiki.org/wiki/MediaWiki Mediawiki] software, with some added [https://www.mediawiki.org/wiki/Manual:Extensions Mediawiki extensions].

The most relevant extensions are:
* [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic Mediawiki] (SMW) - allows wiki pages to contain structured data, through the use of semantic annotations, performed with with property::value descriptors (see a list of all the properties used in this wiki at [[Special:Properties]]), and categories that identify the kind content a page represents (see a list of all the categories used in this wiki at [[Special:Categories]]).
This structure content can be used in queries that data to create dynamic representations such as tables, timelines, maps, lists, etc (see this wiki semantic search interface at [[Special:Ask]])
* [https://www.mediawiki.org/wiki/Extension:Page_Forms Page Forms] - provides the wiki with user-defined Forms (see [https://ruisdael-wiki.citg.tudelft.nl/index.php?title=Special%3AAllPages&from=&to=&namespace=106 all forms used in this wiki]) for creating and editing pages on your wiki, as well as for querying data. The data entered in these Forms is passed onto to wiki templates (see [[https://www.mediawiki.org/wiki/Help:Templates more on wiki templates]]) and displayed often as infoboxes
* [https://maps.extension.wiki/wiki/Maps_for_MediaWiki Maps] to visualize and work with semantic geographical information.
* [https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Result_Formats Semantic_Result_Formats] which extends the range of formats by which semantic data can be represented
* [https://www.mediawiki.org/wiki/Extension:SimpleBatchUpload SimpleBatchUpload] for uploading files in batches to the wiki

A complete list of all the installed extensions, plus detailed information on software versions can be found in each wiki's [[Special:Version]] page

=Wiki Ecosystem=

Mediwiki requires the following components to run:
* the programming language: PHP
* the database: MySQL/Mariadb
* the webserver: Nginx
* the software: Mediawiki

For details on the versions of each of these components see [[Special:Version]] page in each wiki

=Wiki Installation Process=

This wiki runs on non-dockerized configuration. Although Mediawiki can be run inside a docker container, it is quite cumbersome to setup extensions such as SMW in a docker container.

The approach we have chosen to easily install and configure the Mediawiki instances in operation is to run the '''[https://gitlab.tudelft.nl/ruisdael/ansible-playbooks/semantic-mediawiki-playbook/ semantic-mediawiki-playbook/]''' against a VM. Or for testing purposes, against a Vagrant box. In the playbook all the used extensions and their individual installation methods (either through [PHP Composer PHP Composer], Git or bundled with the Mediawiki Software) are defined in [https://gitlab.tudelft.nl/ruisdael/ansible-playbooks/semantic-mediawiki-playbook/-/blob/main/ansible/group_vars/all?ref_type=heads ansible/group_vars/all].

==configuration and directories==
The installation of the wikis is often circumscribed to the <code>/var/www/html/wiki/</code> directory. Inside which the configuration file <code>LocalSettings.php</code>.

LocalSettings.php defines most of the settings of the wiki, such as its:
* loaded & enabled extensions
* loaded & enabled skin
* visibility and user-rights
* wiki names, URLs and paths
* file upload restrictions

==Visibility and Permissions==

This wiki is configured to allow '''viewing''' to non-logged in users, but restrict '''editing''' only to logged in users, or allow editing to anyone, even without an account (not recommended due to spam)

It restricts '''account creation''' to only administrators or all users. Open account creation is not recommended as it can lead to a infestation of spam bot accounts, writing about the benefits of viagra on wiki pages.

More on [https://www.mediawiki.org/wiki/Manual:Preventing_access Manual:Preventing_access] and [https://www.mediawiki.org/wiki/Manual:User_rights Manual:User_rights]

The use configuration is:

<syntaxhighlight lang=php>

# Permissions
$wgGroupPermissions['*']['read'] = true;
$wgGroupPermissions['*']['edit'] = false;
$wgGroupPermissions['user']['edit'] = true;
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['bureaucrat']['createaccount'] = true;

</syntaxhighlight>

'''[[Ruisdael Data Catalog Wiki]], [[GRS Wiki]], [[CCRES Wiki]]''': reading interface is public, editing is restricted to logged in users. Account creation restricted to administrators and bureaucrats.

Config from [[Ruisdael Data Catalog Wiki]]:

<syntaxhighlight lang=php>
# Permissions
$wgGroupPermissions['*']['read'] = true;
$wgGroupPermissions['*']['edit'] = false;
$wgGroupPermissions['user']['edit'] = true;
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['bureaucrat']['createaccount'] = true;
</syntaxhighlight>

=wiki maintenance=

==Admin pages==
See [[Special:AdminLinks]] for a list of administrative pages in each wiki (available only to administrators)

==creating new users==
Wiki Admins bureaucrats (see wiki admins list in [
https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special%3AListUsers&username=&group=bureaucrat Special:ListUsers]) can use the page [[Special:CreateAccount]] to create new user accounts

Once the account is created an email, similar to the following template can be sent out to the new user:

<syntaxhighlight lang="email">

Created a account for you in the Ruisdael Observatory Data Catalog Wiki (https://ruisdael-catalog.citg.tudelft.nl)

The default password is: changemenow. You should change it in your user preferences (https://ruisdael-catalog.citg.tudelft.nl/index.php?title=Special:Preferences)

</syntaxhighlight>

==[https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic Mediawiki (SMW)]''==

===Declaring Categories & Properties===

'''Semantic properties and categories organize and describe content in machine-readable ways, allowing for structured queries and dynamic content aggregation'''

* Semantic annotations via
** ''categories'' to stipulate what each wiki page is. ie. this page is a Recipe since it is annotated with [[:Category:Recipe]]
** ''property::value'' pairs and , ie this page uses [[Property:hasDate]] and [[Property:relatedTo]] to describe its creation date and the other wiki pages is related to.

'''Category pages''' do not need to be created, in order to be used. See all categories used in this wiki at [[Special:Categories]].

'''Property declaration pages''' are essential to define what each property is <ref>https://www.semantic-mediawiki.org/wiki/Help:List_of_datatypes</ref>, its data type<ref>https://www.semantic-mediawiki.org/wiki/Help:List_of_datatypes</ref> and other possible definitions such as label(s)<ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Has_preferred_property_label</ref>, descriptions <ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Has_property_description</ref>, allowed values<ref>https://www.semantic-mediawiki.org/wiki/Help:Special_property_Allows_value</ref>, etc. See all special properties in in https://www.semantic-mediawiki.org/wiki/Help:Special_properties. See all properties used in this wiki at [[Special:Properties]].

===Annotating Pages with Categories & Properties===

Although categories and properties can be include onto wiki pages via text. ie. I can say that this page is part of [[:Category:Recipe]] and uses [[Property:hasDate]] and [[Property:relatedTo]] with the following piece of text:

<nowiki>
[[Category:Recipe]]
[[hasDate::2024.09.03]]
[[relatedTo::Ruisdael Data Catalog Wiki]]
</nowiki>

The usual way the user will interact with them, is indirectly via forms and templates.

In short the Form: pages pass-on the user entered content onto templates, and those templates have properties with template variables, that will be substituted with user entered content.

===Querying the categories and properties===

[[Special:Ask]] page provides a query interface, where users can draft semantic queries, to generate up-to-date results, based on properties and categories, displayed in chosen formats, ie. tables, lists, maps, timelines, etc. The query code can be copied from this interface and pasted on the page where the query results shall be expressed ie. see the [[Main Page]] for examples.

For more info see https://www.semantic-mediawiki.org/wiki/Help:Browsing_and_searching

===Data model of this wiki===
see [[Help:Datamodel]]

=References=