View source for Extension:Semantic Forms Select/ja

<languages/>
{{Extension
|name          = Semantic Forms Select
|status        = stable
|type1         = interface
|type2         = ajax
|hook1         = 
|hook2         =
|username      = 
|author        = Jason Zhang, James Hong Kong, Toni Hermoso Pulido
|maintainer    = {{gesinn.it}} and others
|description   = Allows to generate a selectable form element inside forms from semantic queries
|image         =
|imagesize     =
|version       = 4.0.0-beta
|update        = 2022-04-28
|mediawiki     = 1.35+
|compatibility = '''Compatibility'''
* Semantic MediaWiki 3.0+ / 4.0+
* Page Forms 5.3.0+
|needs-updatephp = No
|php           = 7.3+
|license       = GPL-2.0-or-later
|download      = {{GithubDownload|SemanticMediaWiki|SemanticFormsSelect|translatewiki=1}}
|composer      = mediawiki/semantic-forms-select
|readme        =
|changelog     =
|parameters    = 
|tags          =
|rights        = 
| translate = mwgithub-semanticformsselect
|example       = [https://sandbox.semantic-mediawiki.org/wiki/Category:Semantic_Forms_Select_example sandbox.semantic-mediawiki.org]
}}
<span lang="en" dir="ltr" class="mw-content-ltr">The '''Semantic Forms Select''' extension generates a select form element which option values are from semantic query or parser function.</span>
{{ll|Extension:Page Forms|Page Forms}} (originally Semantic Forms) provides useful input type for select elements such as dropdown, combobox, and listbox.
<span lang="en" dir="ltr" class="mw-content-ltr">Their option values can be derived from a static list, pages in a category, concept, property's allowed values, etc.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">However, it is still limited.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
This extension provides these features
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">The option values for select element is from an SMW query or parser function.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">If the SMW query or parser function is not parametrized, its optioned values are loaded at form generation time.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">If the SMW query or parser function is parametrized, in another word, its values depend on another form field.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Its values are loaded through ajax call when trigger field changes.</span>

<span id="Usage"></span>
== 使用法 ==
<span lang="en" dir="ltr" class="mw-content-ltr">Two form fields are involved.</span>
The first one is the form field we are trying to define.
It is termed as '''Select''' field.
The second one is the field the '''Select''' field depends on.
It is termed as '''Value''' field.
A change of Value field will trigger the loading of Select field.

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Query And Function parameters ===
</div>
The input type from this extension is '''SF_Select'''.
Field parameters are shown in the table below.
{| class="wikitable" style="clear:right"
!Name!!Required!!Description!!Note
|-
|query=x|| {{yes}} ||Semantic Query|| <span lang="en" dir="ltr" class="mw-content-ltr">Either query or function must be present.</span> <span lang="en" dir="ltr" class="mw-content-ltr">More information.</span>
|-
|function=x|| {{yes}} ||Parser Function|| <span lang="en" dir="ltr" class="mw-content-ltr">Either query or function must be present.</span> 詳細情報。
|-
|template=x|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">The template the Value field in</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Use either template or sametemplate</span>
|-
|sametemplate|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">The Value field is in the same template as the Select field</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Use either template or sametemplate</span>
|-
|field=x|| {{no}} ||the Value field name||'''Value field has to be pure text field or html select field. Fields with Autocomplete feature are not supported'''
|-
|rmdiv|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">remove current instance when Select field's value is not valid anymore</span>
| 詳細情報。
|-
|list|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">As it is defined in ''Page Forms''</span>
|
|-
|size=x|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">As it is defined in ''Page Forms''</span>
|
|-
|label|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">Query properties shown in queries as labels and page names as values</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">EXPERIMENTAL. Check example 3 below.</span>
|-
|mandatory|| {{no}} || <span lang="en" dir="ltr" class="mw-content-ltr">Whether input is mandatory.</span>
|
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Query And Function format ===
</div>
  <nowiki>{{{field|AllProtocols|input type=SF_Select|query=((Category:Protocol));format~list;sep~,;link~none;headers~hide;limit~500}}}</nowiki>
In the above example, the ''query'' is <nowiki>[[Category:Protocol]]|format=list|sep=,|link=none|headers=hide|limit=5000</nowiki>.
To avoid parsing and text transform, we have to convert '''[ to (''',''' = to ~ '''and '''| to ;''' in the query.

  <nowiki>{{{field|AllProtocols1|input type=SF_Select|function=ask:((Category:Protocol));format~list;sep~,;link~none;headers~hide;limit~500}}}</nowiki>

<span lang="en" dir="ltr" class="mw-content-ltr">Parser function follows the same rule.</span>
The parser function is ask in example above.
We can of course use other valid parser function.
To fit a parser function into field definition, Strip the <nowiki>{{#</nowiki> and <nowiki>}}</nowiki> at the beginning and the end of normal parser function format.

<div lang="en" dir="ltr" class="mw-content-ltr">
The result from query or parser function should be a list of string separated by '''comma'''.
</div>

<span id="Examples"></span>
=== 例 ===

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Example 1: Static query ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Values are retrieved when the form is loaded.
</div>

  <nowiki>{{{field|AllProtocols|input type=SF_Select|query=((Category:Protocol));format~list;sep~,;link~none;headers~hide;limit~500}}}</nowiki> 

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Example 2: Static function ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Values are retrieved when the form is loaded.
</div>

  <nowiki>{{{field|Users|input type=SF_Select|function=getallusers}}}</nowiki>
Here the getallusers is a custom parser function which gives all users in current installation.

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Example 3: Parametrized query/function ====
</div>

  <nowiki>{{{field|P2Protocols3|input type=SF_Select|query=((Category:Protocol))((Protocol Belongs to Project::@@@@));format~list;sep~,;link~none;headers~hide;limit~
200|sametemplate|field=Project1}}}</nowiki>

The parameter is the special character string '''@@@@'''.
<span lang="en" dir="ltr" class="mw-content-ltr">In this example, the Select field is P2Protocols3.</span>
The Value field is Project1.
Both Select field and Value field are in the same template since we have ''sametemplate'' in field definition.
If Value field is from another template, the ''template'' parameter should be used.
When Project1 field changes, the '''@@@@''' will be replaced by the value of Project1's value.
The query is then sent to server through ajax call.
The results will be the option values for P2Protocols3 field.
If the current template is multiple, the P2Protocols3 only depends on the Project1 in the same instance.

  <nowiki>{{{field|P2Protocols3|input type=SF_Select|query=((Category:Protocol))((Protocol Belongs to Project::@@@@));?Has Name;format~list;sep~,;link~none;headers~hide;limit~
200|sametemplate|field=Project1|label}}}</nowiki>
In this case above, when adding a property to be shown ('''Has Name''') and an extra <code>label</code> parameter, the property value is shown instead of the resulting page name.

Parser functions can be parametrized in the same way.
  <nowiki>{{{field|UserInGroup|input type=SF_Select|function=getallusersInGroup:@@@@|sametemplate|field=Group}}}</nowiki>
In this example, we list all users in the selected group of Group field.

In case the queried results contain a comma (,) as a separator one has to choose another separator like e.g. an asterisk (*). Use it both in the query and in the parser function.
 <nowiki>{{{field|Protocol1|input type=SF_Select|query=((Category:Protocol))((Protocol Belongs to Project::@@@@));format~list;sep~*;link~none;headers~hide;limit~200|sametemplate|field=Project1|sep=*}}}</nowiki>

==== Example 4: rmdiv ====
  <nowiki>
{{{for template|StudyProtocolMultiple3|label=Demonstrate External Dependency multiple, rmove|multiple}}}
{|
!Depends on Protocols 5 on Study template
|{{{field|Endpoint|input type=SF_Select|list|size=2|query=((Is a Protocol Endpoint::@@@@));mainlabel~-;?Endpoint Name;format~list;sep~,;headers~hide;limit~5
0|list|size=5|template=Study|field=P2Protocols4|rmdiv}}}
|}
{{{end template}}}
 </nowiki>
In this example, the Endpoint field depends on P2Protocols4 field in study template.
The current template is also a '''multiple''' template.
Endpoint's value is reloaded after P2Protocols4 changes.
After reloading, Endpoint may not have any selected values and it is left in an invalid state.
In this case, we may want to automatically remove the current instance.
This is what ''rmdir'' parameter is for.

<span id="Installation"></span>
== インストール ==
{{Note}} The extensions [[Extension:Semantic MediaWiki|Semantic MediaWiki]] and [[Extension:Page Forms|Page Forms]] are required and should be included before this extension in order to work.

; To install this extension:
# Use {{ll|Composer/For_extensions|composer}}:<syntaxhighlight lang="bash">php composer.phar require mediawiki/semantic-forms-select "~4.0"</syntaxhighlight>
# Add the following line to your "LocalSettings.php" file after invoking the extensions Semantic MediaWiki and Page Forms:<syntaxhighlight lang="php">
wfLoadExtension( 'SemanticFormsSelect' );</syntaxhighlight>
# Done!

<span id="Acknowledgement"></span>
== 謝辞 ==
This project was sponsored by [http://www.bioteam.net BioTeam] and [http://www.flexdms.com flexdms].

For support, please send email to the [[semantic-mw:Mailing list|user mailing list]] of  Semantic MediaWiki.

{{Used by}}

[[Category:Semantic MediaWiki extensions{{#translation:}}]]