Template:Semcon: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
No edit summary
 
(59 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{|border="5"
<includeonly>{{anchor|{{{id}}}}}{{#switch:{{{status}}}
|
|proposed={{semconProposed|{{{1}}}|{{date|{{{proposed|{{FIXME}}}}}}}|id={{{id|}}}|forum={{semcon/Check|{{{forum}}}}}}}
{|type="wikitable" border="0" style="background-color:#ffbbbb;"
|approved={{semconApproved|{{{1}}}|{{date|{{{proposed|{{FIXME}}}}}}}|{{date|{{{approved|{{FIXME}}}}}}}|id={{{id|}}}|forum={{semcon/Check|{{{forum}}}}}}}
|valign="top"|[[file:Private-cloud-icon.png|50px]][[category:Semantic constraints]]
|deprecated={{semconDeprecated|{{{1}}}|{{date|{{{proposed|{{FIXME}}}}}}}|{{date|{{{approved|{{FIXME}}}}}}}|{{date|{{{deprecated|{{FIXME}}}}}}}|forum={{semcon/Check|{{{forum}}}}}}}
|'''Semantic constraint:'''<br>{{{1}}}
|#default='''Obligatory argument ''status'' missing'''}}[[category:allSemcons]]</includeonly><noinclude>
|}
|}</includeonly><noinclude>
==Usage==
==Usage==
This template is designated for [[dev:Semantic Constraints|semantic constraints]]. It presents them in a standardized way and provides listing in [[:Sategory:Semantic constraints]].
This template is designated for [[dev:Semantic Constraints|semantic constraints]]. It presents them in a standardized way and provides listing in [[:Category:Semantic constraints]].
 
Please, don't forget to hint at semantic constraints with [[template:semconHint]]!
===Arguments===
===Arguments===
The template has one obligatoryargument for the constraint.
The template has one unnamed obligatory argument and four named arguments:
*1: The constraint.
*status: The status of the semantic constraint: ''proposed'', ''approved'' or ''deprecated''
*id: a unique designator for the respective semantic constraint with the rule "AA:NNN" where AA is the abbreviation of the subscheme (e.g. TT for timetable, IL for interlocking, ...) and NNN a three-digit, ascending and unique number
*{{anchor|forum}}forum: Link to the forum entry, where the semantic constraint was proposed. Please, don't introduce semantic constraints (not even proposed ones) without former discussion. If the value of ''forum'' is anything other than a link to the {{rml}} forum, an error message will appear.
*proposed: The date of proposal, obligatory
*approved: The approvement date, obligatory if status is either approved or deprecated
*deprecated: The deprecation date, obligatory if status=deprecated
{{note|The dates in parameters ''proposed'', ''approved'' and ''deprecated'' have to be entered in format '''yyyy-mm-dd''', as they are parsed by [[Template:Date]]!}}
 
==Example==
==Example==
<pre>{{semcon|Never put off until tomorrow what you can do today.}}</pre>
===Proposed semantic contraint===
<pre>{{semcon|All work and no play makes Jack a dull boy.|status=proposed|proposed=1980-10-16|id=AA:nnn|forum=https://www.railml.org/forum/index.php?t=msg&th=704&start=0&}}</pre>
delivers
{{semcon|All work and no play makes Jack a dull boy.|status=proposed|proposed=1980-10-16|id=AA:nnn|forum=https://www.railml.org/forum/index.php?t=msg&th=704&start=0&}}
 
===Approved semantic contraint===
<pre>{{semcon|People who live in glass houses shouldn't throw stones.<br>{{Deu|Wer im Glashaus sitzt, soll nicht mit Steinen werfen.}}|status=approved|proposed=2019-06-04|approved=2019-06-05|id=AA:nnn}}</pre>
delivers
delivers
{{semcon|Never put off until tomorrow what you can do today.}}
{{semcon|People who live in glass houses shouldn't throw stones.<br>{{Deu|Wer im Glashaus sitzt, soll nicht mit Steinen werfen.}}|status=approved|approved=2019-06-05|proposed=2019-06-04|id=AA:nnn}}
 
===Deprecated semantic contraint===
<pre>{{semcon|Never put off until tomorrow what you can do today.|status=deprecated|proposed=2019-02-12|approved=2019-03-18|deprecated=2019-04-05|id=AA:nnn}}</pre>
delivers
{{semcon|Never put off until tomorrow what you can do today.|status=deprecated|proposed=2019-02-12|approved=2019-03-18|deprecated=2019-04-05|id=AA:nnn}}
 
[[Category:Template for semantic constraints]]


[[category:template]]
{{interwiki}}
</noinclude>
</noinclude>

Latest revision as of 17:08, 26 November 2023

Usage

This template is designated for semantic constraints. It presents them in a standardized way and provides listing in Category:Semantic constraints.

Please, don't forget to hint at semantic constraints with template:semconHint!

Arguments

The template has one unnamed obligatory argument and four named arguments:

  • 1: The constraint.
  • status: The status of the semantic constraint: proposed, approved or deprecated
  • id: a unique designator for the respective semantic constraint with the rule "AA:NNN" where AA is the abbreviation of the subscheme (e.g. TT for timetable, IL for interlocking, ...) and NNN a three-digit, ascending and unique number
  • forum: Link to the forum entry, where the semantic constraint was proposed. Please, don't introduce semantic constraints (not even proposed ones) without former discussion. If the value of forum is anything other than a link to the railML® forum, an error message will appear.
  • proposed: The date of proposal, obligatory
  • approved: The approvement date, obligatory if status is either approved or deprecated
  • deprecated: The deprecation date, obligatory if status=deprecated
🗒️ The dates in parameters proposed, approved and deprecated have to be entered in format yyyy-mm-dd, as they are parsed by Template:Date!


Example

Proposed semantic contraint

{{semcon|All work and no play makes Jack a dull boy.|status=proposed|proposed=1980-10-16|id=AA:nnn|forum=https://www.railml.org/forum/index.php?t=msg&th=704&start=0&}}

delivers

Private-cloud-icon.png Proposed Semantic Constraint "AA:nnn":
 
All work and no play makes Jack a dull boy.
 
Proposed on October 16th 1980
Discuss this semantic constraint
Please, recognize our guidelines on semantic constraints

Approved semantic contraint

{{semcon|People who live in glass houses shouldn't throw stones.<br>{{Deu|Wer im Glashaus sitzt, soll nicht mit Steinen werfen.}}|status=approved|proposed=2019-06-04|approved=2019-06-05|id=AA:nnn}}

delivers

Private-cloud-icon.png Semantic Constraint "AA:nnn":
 
People who live in glass houses shouldn't throw stones.
Wer im Glashaus sitzt, soll nicht mit Steinen werfen.
 
Proposed on June 04th 2019
Approved on June 05th 2019
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Deprecated semantic contraint

{{semcon|Never put off until tomorrow what you can do today.|status=deprecated|proposed=2019-02-12|approved=2019-03-18|deprecated=2019-04-05|id=AA:nnn}}

delivers

Private-cloud-icon.png Deprecated Semantic Constraint:
 
Never put off until tomorrow what you can do today.
 
Proposed on February 12th 2019
Approved on March 18th 2019
Deprecated on March 18th 2019
Deprecated semantic constraints may still be valid for older railML® versions!
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints