Difference between revisions of "Template:Dashboard.wikiedu.org assignment/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mathglot
(→‎Parameters: Add {{para|ended}}.)
imported>AntiCompositeNumber
(Add TemplateData)
 
Line 3: Line 3:
 
== Usage ==
 
== Usage ==
 
For placement in the header section of article talk pages of articles that are being worked on by students doing courses through [[WP:WEP|Wiki Education]].
 
For placement in the header section of article talk pages of articles that are being worked on by students doing courses through [[WP:WEP|Wiki Education]].
 +
<pre>
 +
{{Dashboard.wikiedu.org assignment |course= |assignments= |reviewers= |scholar= |start_date= |end_date= |term= |ended= }}
 +
</pre>
  
 
=== When to use ===
 
=== When to use ===
Line 16: Line 19:
  
 
== Parameters ==
 
== Parameters ==
{| class="wikitable plainrowheaders"
+
{{TemplateData header}}
|+ Parameters for Dashboard.wikiedu.org assignment
+
<templatedata>
|-
+
{
! scope="col" style="width:18%"| Parameter
+
"params": {
! scope="col" style="width:30em" | Notes
+
"ended": {
|-
+
"description": "whether the course has ended ('yes', 'y', 'true') or not ('no', 'n', 'false'). Alters the \"is or was\" text accordingly",
! scope="row" | course
+
"type": "boolean",
| The on-wiki course page with a full listing of students in the course and the articles they are assigned to work on.  
+
"default": "\"is or was\""
|-
+
},
! scope="row" | assignments
+
"term": {
| List of users who are assigned to work on this article. Bracketed, comma-separated.
+
"description": "time period of the course",
|-
+
"example": "Fall 2020",
! scope="row" | reviewers
+
"type": "line"
| List of users who are assigned to peer review their classmates contributions to this article
+
},
|-
+
"start_date": {
! scope="row" | scholar
+
"description": "The start date of the course.",
| Visiting Scholar who worked on this article
+
"type": "date",
|-
+
"suggested": true
! scope="row" | start_date
+
},
| The start date of the course.
+
"end_date": {
|-
+
"description": "The end date of the course.",
! scope="row" | end_date
+
"type": "date",
| The end date of the course.
+
"suggested": true
|-
+
},
! scope="row" | term
+
"course": {
| time period of the course, e.g., ''Fall {{CURRENTYEAR}}''
+
"description": "The on-wiki course page with a full listing of students in the course and the articles they are assigned to work on.",
|-
+
"suggested": true,
! scope="row" | ended
+
"type": "wiki-page-name"
| whether the course has ended ('yes', 'y', 'true') or not ('no', 'n', 'false'). Alters the "is or was" text accordingly. Default: "is or was".
+
},
|}
+
"assignments": {
 +
"description": "List of users who are assigned to work on this article. Should be linked and comma-separated.",
 +
"type": "line"
 +
},
 +
"reviewers": {
 +
"description": "List of users who are assigned to peer review their classmates contributions to this article ",
 +
"type": "line"
 +
},
 +
"scholar": {
 +
"description": "Visiting Scholar who worked on this article ",
 +
"type": "line"
 +
}
 +
},
 +
"description": "For placement in the header section of article talk pages of articles that are being worked on by students doing courses through Wiki Education.",
 +
"paramOrder": [
 +
"course",
 +
"assignments",
 +
"reviewers",
 +
"scholar",
 +
"start_date",
 +
"end_date",
 +
"term",
 +
"ended"
 +
],
 +
"format": "inline"
 +
}
 +
</templatedata>
  
 
== Redirects ==
 
== Redirects ==

Latest revision as of 19:38, 24 August 2020

Usage

For placement in the header section of article talk pages of articles that are being worked on by students doing courses through Wiki Education.

{{Dashboard.wikiedu.org assignment |course= |assignments= |reviewers= |scholar= |start_date= |end_date= |term= |ended= }}

When to use

This template is added and updated automatically by dashboard.wikiedu.org whenever course assignments are added or removed for a particular Wiki Education course.

How to use

Listed below are some examples of usage:

{{Dashboard.wikiedu.org assignment |course=Your course name|assignments=[[User:Student001]], [[User:Student004]]|start_date=Template:TODAY |end_date=31 December 2099}}

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Dashboard.wikiedu.org assignment

For placement in the header section of article talk pages of articles that are being worked on by students doing courses through Wiki Education.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Coursecourse

The on-wiki course page with a full listing of students in the course and the articles they are assigned to work on.

Pagesuggested
Assignmentsassignments

List of users who are assigned to work on this article. Should be linked and comma-separated.

Lineoptional
Reviewersreviewers

List of users who are assigned to peer review their classmates contributions to this article

Lineoptional
Scholarscholar

Visiting Scholar who worked on this article

Lineoptional
Start_datestart_date

The start date of the course.

Datesuggested
End_dateend_date

The end date of the course.

Datesuggested
Termterm

time period of the course

Example
Fall 2020
Lineoptional
Endedended

whether the course has ended ('yes', 'y', 'true') or not ('no', 'n', 'false'). Alters the "is or was" text accordingly

Default
"is or was"
Booleanoptional

Redirects

See also