How-To: Difference between revisions

Latest revision as of 11:25, 17 November 2024

This page is part of semorg's documentation.

How to enable a feature

Simply create the feature's overview page. It's basic content is

{{#semorg-overview:<feature>}}

If you don't use an overview page's canonical name you should change Mediawiki:Semorg-<feature>-page-name to your custom name.

You can use the page SemanticOrganization as a convenient starting point. There you can create overview pages with prefilled content with a click.

How to add a link to a feature the navigation

Just edit Mediawiki:Tweeki-navbar-left to add a link. For Details see the documentation for the Tweeki skin.

How to enable new fields in a form

Edit MediaWiki:Semorg-form-<feature>-rows and add the field. Predefined fields for every feature can be found on the page Fields in this documentation.

How to change the name of a group?

Use the „move“ feature in the dropdown next to the edit button. If you create a redirect (which is the default), existing group meetings will still be associated to the group. However the association could get lost when editing a meeting so you should either edit them manually or use the Replace Text extension.

How to add a field?

Create the property Property:Semorg-<feature>-<field>. You can use Special:CreateProperty (provided by the Page Forms extension). Chose the data type you want to use.
Create MediaWiki:Semorg-field-<feature>-<field>-name.
If needed create MediaWiki:Semorg-field-<feature>-<field>-parameters (or -input-type, -size, -help, -prefix, or -suffix).
If the field should be shown in the form add <field> to MediaWiki:Semorg-form-<feature>-rows.
Create a custom template. Copy Template:Semorg-<feature> to a new page in the template namespace (e.g. Template:Semorg-<feature>-custom).
In order to save the field in the database add the line |<field>={{{<field>|}}} to the call of {{#semorg-set:}}.
If the field's value should be shown in the detail table add the line |<field>={{{<field>|}}} to the call of {{#semorg-table:}}. You can add any formatting you want here.
Point Mediawiki:Semorg-<feature>-template to the newly created template.
If you already created calls to the old template, change them. You can use the Replace Text extension to quickly replace all appearances of {{semorg-<feature> with {{semorg-<feature>-custom.

If the field should be shown in lists

copy the contents of Template:Semorg-<feature>-row to Template:Semorg-<feature>-custom-row
add |?semorg-<feature>-<field>=<field> to the call of {{#semorg-list:}}
- if you want to change only one specific list, use the row template and headers parameters
- if you want it for all lists for this feature, change MediaWiki:semorg-list-<feature>-row-template and MediaWiki:semorg-list-<feature>-headers
- the value for the row template should be <feature>-custom (without “semorg-” and “-row”)

How to change the appearance of a list?

see also the documentation for the {{#semorg-list:}} parser function

List have two parts:

Headers
Rows, whose contents are controlled by a template.

In most cases you need to change both of them.

	default	globally (System Messages)	single use (Function Parameters)	example value
Headers		`MediaWiki:Semorg-list-<feature>-headers`	`headers`	group-name, group-description, group-host, group-members
Row template	`Template:Semorg-<feature>-row`	`MediaWiki:Semorg-list-<feature>-row-template`	`row template`	`<feature>-custom` (translates to `Template:semorg-<feature>-custom-row`

How to allow more than one responsible person for a task?

change the value for input type in MediaWiki:Semorg-field-task-responsible-parameters to tokens and add |list at the end

How to change users' display names

You can change how your users' names are displayed (i.e. how the property Semorg-person-name is set) by editing the MediaWiki:Semorg-person-user-name message.

You can use the following parameters:

$1: user name
$2: first name
$3: last name
$4: acronym

Default is "{{#if:$2$3|$2 $3|$1}}".

Attention! If you change this on an existing installation the attributes will only be updated after a resave of all affected pages!

@@ Line 1: / Line 1: @@
+{{semorg-docs}}
+=== How to enable a feature ===
+Simply create the feature's overview page. It's basic content is
+ <nowiki>{{#semorg-overview:<feature>}}</nowiki>
+If you don't use an overview page's canonical name you should change <code>Mediawiki:Semorg-<feature>-page-name</code> to your custom name.
+You can use the page [[SemanticOrganization]] as a convenient starting point. There you can create overview pages with prefilled content with a click.
+=== How to add a link to a feature the navigation ===
+Just edit <code>Mediawiki:Tweeki-navbar-left</code> to add a link. For Details see the [https://tweeki.kollabor.at/wiki/Messages#Navbar documentation for the Tweeki skin].
+=== How to enable new fields in a form ===
+Edit <code>MediaWiki:Semorg-form-<feature>-rows</code> and add the field. Predefined fields for every feature can be found on the page [[Fields]] in this documentation.
 === How to change the name of a group? ===
@@ Line 7: / Line 25: @@
 # Create the property <code>Property:Semorg-<feature>-<field></code>. You can use <code>Special:CreateProperty</code> (provided by the Page Forms extension). Chose the data type you want to use.
 # Create <code>MediaWiki:Semorg-field-<feature>-<field>-name</code>.
-# If needed create <code>MediaWiki:Semorg-field-<feature>-<field>-properties</code> (or <code>-input-type</code>, <code>-size</code>, <code>-help</code>, <code>-prefix</code>, or <code>-suffix</code>).
+# If needed create <code>MediaWiki:Semorg-field-<feature>-<field>-parameters</code> (or <code>-input-type</code>, <code>-size</code>, <code>-help</code>, <code>-prefix</code>, or <code>-suffix</code>).
 # If the field should be shown in the form add <code><field></code> to <code>MediaWiki:Semorg-form-<feature>-rows</code>.
 # Create a custom template. Copy <code>Template:Semorg-<feature></code> to a new page in the template namespace (e.g. <code>Template:Semorg-<feature>-custom</code>).
+# In order to save the field in the database add the line <code>|<field>=<nowiki>{{{<field>|}}}</nowiki></code> to the call of <code><nowiki>{{#semorg-set:}}</nowiki></code>.
+# If the field's value should be shown in the detail table add the line <code>|<field>=<nowiki>{{{<field>|}}}</nowiki></code> to the call of <code><nowiki>{{#semorg-table:}}</nowiki></code>. You can add any formatting you want here.
 # Point <code>Mediawiki:Semorg-<feature>-template</code> to the newly created template.
 # If you already created calls to the old template, change them. You can use the [https://www.mediawiki.org/wiki/Extension:Replace_Text Replace Text extension] to quickly replace all appearances of <code>{{semorg-<feature></code> with <code>{{semorg-<feature>-custom</code>.
-# In order to save the field in the database add the line <code>|<field>=<nowiki>{{{<field>|}}}</nowiki></code> to the call of <code><nowiki>{{#semorg-set:}}</nowiki></code>.
-# If the field's value should be shown in the detail table add the line <code>|<field>=<nowiki>{{{<field>|}}}</nowiki></code> to the call of <code><nowiki>{{#semorg-table:}}</nowiki></code>. You can add any formatting you want here.
+If the field should be shown in lists
+# copy the contents of <code>Template:Semorg-<feature>-row</code> to <code>Template:Semorg-<feature>-custom-row</code>
+# add <code><nowiki>|?semorg-<feature>-<field>=<field></nowiki></code> to the call of <code><nowiki>{{#semorg-list:}}</nowiki></code>
+#* if you want to change only one specific list, use the <code>row template</code> and <code>headers</code> parameters
+#* if you want it for all lists for this feature, change <code>MediaWiki:semorg-list-<feature>-row-template</code> and <code>MediaWiki:semorg-list-<feature>-headers</code>
+#* the value for the row template should be <code><feature>-custom</code> (without “semorg-” and “-row”)
 === How to change the appearance of a list? ===
@@ Line 21: / Line 47: @@
 List have two parts:
 * Headers
-* Rows
+* Rows, whose contents are controlled by a template.
+In most cases you need to change both of them.
 {| class="table table-bordered table-sm"
@@ Line 36: / Line 64: @@
 | group-name, group-description, group-host, group-members
 |-
-! Rows
+! Row template
 | <code>Template:Semorg-<feature>-row</code>
 | <code>MediaWiki:Semorg-list-<feature>-row-template</code>
-| <code>row-template</code>
+| <code>row template</code>
 | <code><feature>-custom</code> <small>(translates to <code>Template:semorg-<feature>-custom-row</code></small>
 |}
+=== How to allow more than one responsible person for a task? ===
+change the value for input type in <code>MediaWiki:Semorg-field-task-responsible-parameters</code> to <code>tokens</code> and add <code>|list</code> at the end
+=== How to change users' display names ===
+You can change how your users' names are displayed (i.e. how the property <code>Semorg-person-name</code> is set) by editing the <code>MediaWiki:Semorg-person-user-name</code> message.
+You can use the following parameters:
+* <code>$1</code>: user name
+* <code>$2</code>: first name
+* <code>$3</code>: last name
+* <code>$4</code>: acronym
+Default is "<code><nowiki>{{#if:$2$3|$2 $3|$1}}</nowiki></code>".
+'''Attention!''' If you change this on an existing installation the attributes will only be updated after a resave of all affected pages!