Template:Infobox privacy statement/doc: Difference between revisions
MMoss (WMF) (talk | contribs) Moved documentation and templatedata to subpage; incorporated explanatory line about templatedata from en:Template:TemplateData header see that page for attribution |
LincolnBot (talk | contribs) m →TemplateData: cleanup using AWB |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
== Usage == |
== Usage == |
||
Using the main [[Template:Privacy statement|Privacy statement]] template is recommended to avoid duplicative work in adding parameters. However, if needed, this infobox may be added on its own: doing so through the [[mw:Extension:TemplateWizard|TemplateWizard]] is recommended to avoid errors, but the infobox can also be added by pasting the template as shown below into a page and then filling in the desired fields. Any parameters left blank or omitted will not be displayed. |
Using the main [[Template:Privacy statement|Privacy statement]] template is recommended to avoid duplicative work in adding parameters. However, if needed, this infobox may be added on its own: doing so through the [[:mw:Extension:TemplateWizard|TemplateWizard]] is recommended to avoid errors, but the infobox can also be added by pasting the template as shown below into a page and then filling in the desired fields. Any parameters left blank or omitted will not be displayed. |
||
=== Blank template with basic parameters === |
=== Blank template with basic parameters === |
||
{{Infobox privacy statement |
{{Infobox privacy statement |
||
|title= Title |
|title= Title |
||
|event= Yes |
|||
|services= No |
|||
|community= Yes |
|||
⚫ | |||
|outreach= Yes |
|||
|recording= No |
|recording= No |
||
|transcript= Yes |
|||
|demographic= Yes |
|||
|publish= Yes |
|publish= Yes |
||
|publish_identifying= No |
|publish_identifying= No |
||
|volunteers= Yes |
|volunteers= Yes |
||
|tool= Google Forms |
|||
|retention= 90 days |
|retention= 90 days |
||
}} |
}} |
||
Line 29: | Line 16: | ||
{{Infobox privacy statement |
{{Infobox privacy statement |
||
|title= |
|title= |
||
⚫ | |||
⚫ | |||
⚫ | |||
|find= <!-- Yes or No --> |
|||
|outreach= <!-- Yes or No --> |
|||
|recording= <!-- Yes or No --> |
|recording= <!-- Yes or No --> |
||
|transcript= <!-- Yes or No --> |
|||
|demographic= <!-- Yes or No --> |
|||
|publish= <!-- Yes or No --> |
|publish= <!-- Yes or No --> |
||
|publish_identifying= <!-- Yes or No --> |
|publish_identifying= <!-- Yes or No --> |
||
|volunteers= <!-- Yes or No --> |
|volunteers= <!-- Yes or No --> |
||
|tool= <!-- only Google Forms, Qualtrics, SurveyMonkey, LimeSurvey, Google Meet, Zoom, Skype, Eventbrite, or QuickSurveys currently supported --> |
|||
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported --> |
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported --> |
||
}} |
}} |
||
Line 51: | Line 25: | ||
{{clear}} |
{{clear}} |
||
=== Blank template with |
=== Blank template with most parameters === |
||
Only the most pertinent information should be included. Please remove unused parameters. |
Only the most pertinent information should be included. Please remove unused parameters. The visualized template does not use the "tool_other" parameter as doing so would eliminate the list of tools. |
||
{{Infobox privacy statement |
{{Infobox privacy statement |
||
|title= Title |
|title= Title |
||
Line 60: | Line 34: | ||
|event= No |
|event= No |
||
⚫ | |||
|services= Yes |
|services= Yes |
||
|community= No |
|community= No |
||
Line 92: | Line 67: | ||
|team= |
|team= |
||
|image= <!-- defaults to Wikipedia 20 images. For a specific image, input filename only without "File:" or "Image:" and without enclosing [[brackets]] --> |
|image= <!-- defaults to Wikipedia 20 images. For a specific image, input filename only without "File:" or "Image:" and without enclosing [[brackets]] --> |
||
|event= <!-- Yes or No --> |
|event= <!-- Yes or No --> |
||
⚫ | |||
|services= <!-- Yes or No --> |
|services= <!-- Yes or No --> |
||
|community= <!-- Yes or No --> |
|community= <!-- Yes or No --> |
||
Line 105: | Line 80: | ||
|account_activity= <!-- Yes or No --> |
|account_activity= <!-- Yes or No --> |
||
|demographic= <!-- Yes or No --> |
|demographic= <!-- Yes or No --> |
||
⚫ | |||
⚫ | |||
|recording2= <!-- Yes or No --> |
|recording2= <!-- Yes or No --> |
||
|wildcard= <!-- use only when necessary --> |
|wildcard= <!-- use only when necessary --> |
||
|publish= <!-- Yes or No --> |
|publish= <!-- Yes or No --> |
||
Line 117: | Line 93: | ||
|tool2= <!-- use only when necessary --> |
|tool2= <!-- use only when necessary --> |
||
|tool3= <!-- use only when necessary --> |
|tool3= <!-- use only when necessary --> |
||
|tool_other= <!-- use only when necessary --> |
|||
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported --> |
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported --> |
||
Line 124: | Line 101: | ||
== TemplateData == |
== TemplateData == |
||
This is the [[mw:Help:TemplateData|TemplateData]] for this template used by [[mw:Extension:TemplateWizard|TemplateWizard]], [[ |
This is the [[:mw:Help:TemplateData|TemplateData]] for this template used by [[:mw:Extension:TemplateWizard|TemplateWizard]], [[:w:en:VisualEditor|VisualEditor]] and other tools. |
||
<templatedata> |
<templatedata> |
||
{ |
{ |
||
Line 132: | Line 109: | ||
"description": "Title of the survey, event, etc.", |
"description": "Title of the survey, event, etc.", |
||
"type": "content", |
"type": "content", |
||
"required": |
"required": true |
||
}, |
}, |
||
"title_link": { |
"title_link": { |
||
Line 141: | Line 118: | ||
}, |
}, |
||
"team": { |
"team": { |
||
"label": "What |
"label": "What Wikimedia Foundation team is involved?", |
||
"description": "One team involved in the collection or use of data; do not include the word 'team' ", |
"description": "One team involved in the collection or use of data; do not include the word 'team' ", |
||
"type": "content", |
"type": "content", |
||
Line 153: | Line 130: | ||
}, |
}, |
||
"event": { |
"event": { |
||
"label": "Is there an event |
"label": "Is there an event?", |
||
"description": "Typically involves a registration form", |
"description": "Typically involves a registration form", |
||
"type": "string", |
|||
"suggestedvalues": [ |
|||
"Yes", |
|||
"No" |
|||
], |
|||
"required": false |
|||
}, |
|||
"meeting": { |
|||
"label": "Is there a meeting?", |
|||
"description": "Typically involves less complex data publishing than an event", |
|||
"example": "Interview", |
|||
"type": "string", |
"type": "string", |
||
"suggestedvalues": [ |
"suggestedvalues": [ |
||
Line 211: | Line 199: | ||
"No" |
"No" |
||
], |
], |
||
"required": |
"required": false |
||
}, |
}, |
||
"transcript": { |
"transcript": { |
||
Line 252: | Line 240: | ||
"autovalue": "No", |
"autovalue": "No", |
||
"suggestedvalues": [ |
"suggestedvalues": [ |
||
"Yes", |
|||
"No" |
|||
], |
|||
"required": false |
|||
}, |
|||
"device": { |
|||
"label": "Will device information be collected?", |
|||
"description": "Such as IP address, user agent", |
|||
"type": "string", |
|||
"suggestedvalues": [ |
|||
"Yes", |
|||
"No" |
|||
], |
|||
"required": false |
|||
}, |
|||
"session": { |
|||
"label": "Will nonpublic Wikimedia session information be collected?", |
|||
"description": "Such as page viewed, login status", |
|||
"type": "string", |
|||
"suggestedvalues": [ |
|||
"Yes", |
"Yes", |
||
"No" |
"No" |
||
Line 264: | Line 272: | ||
}, |
}, |
||
"recording": { |
"recording": { |
||
"label": "Will |
"label": "Will Wikimedia Foundation be recording?", |
||
"description": "Whether you will be doing video, audio, and/or screen recording", |
"description": "Whether you will be doing video, audio, and/or screen recording", |
||
"type": "string", |
"type": "string", |
||
Line 364: | Line 372: | ||
"QuickSurveys" |
"QuickSurveys" |
||
], |
], |
||
"required": false |
|||
}, |
|||
"tool_other": { |
|||
"label": "If additional tools are involved, list here:", |
|||
"description": "Bypasses the infobox list of data collection tools", |
|||
"example": "Google Forms is used to collect responses; please read their [//www.google.com/intl/en/policies/privacy/ Privacy Policy] and [//www.google.com/intl/en/policies/terms/ Terms of Service].", |
|||
"type": "string", |
|||
"required": false |
"required": false |
||
}, |
}, |
||
Line 393: | Line 408: | ||
"image", |
"image", |
||
"event", |
"event", |
||
"meeting", |
|||
"services", |
"services", |
||
"find", |
"find", |
||
Line 401: | Line 417: | ||
"tool2", |
"tool2", |
||
"tool3", |
"tool3", |
||
"tool_other", |
|||
"partner", |
"partner", |
||
"demographic", |
"demographic", |
||
"device", |
|||
"session", |
|||
"recording", |
"recording", |
||
"recording2", |
"recording2", |
||
Line 418: | Line 437: | ||
<includeonly>{{Sandbox other|| |
<includeonly>{{Sandbox other|| |
||
<!-- Categories below this line --> |
<!-- Categories below this line --> |
||
[[Category:Templates]] |
[[Category:Templates{{#translation:}}]] |
||
}}</includeonly> |
}}</includeonly> |
Latest revision as of 20:50, 11 March 2024
This is a documentation subpage for Template:Infobox privacy statement. It contains usage information, categories, and other content that is not part of the original template page. |
Usage
Using the main Privacy statement template is recommended to avoid duplicative work in adding parameters. However, if needed, this infobox may be added on its own: doing so through the TemplateWizard is recommended to avoid errors, but the infobox can also be added by pasting the template as shown below into a page and then filling in the desired fields. Any parameters left blank or omitted will not be displayed.
Blank template with basic parameters
{{Infobox privacy statement
|title=
|recording= <!-- Yes or No -->
|publish= <!-- Yes or No -->
|publish_identifying= <!-- Yes or No -->
|volunteers= <!-- Yes or No -->
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported -->
}}
Blank template with most parameters
Only the most pertinent information should be included. Please remove unused parameters. The visualized template does not use the "tool_other" parameter as doing so would eliminate the list of tools.
{{Infobox privacy statement
|title=
|title_link= <!-- Interwiki prefix code followed by page name, no pipe or enclosing [[brackets]] -->
|team=
|image= <!-- defaults to Wikipedia 20 images. For a specific image, input filename only without "File:" or "Image:" and without enclosing [[brackets]] -->
|event= <!-- Yes or No -->
|meeting= <!-- Yes or No -->
|services= <!-- Yes or No -->
|community= <!-- Yes or No -->
|find= <!-- Yes or No -->
|outreach= <!-- Yes or No -->
|research= <!-- Yes or No -->
|recording= <!-- Yes or No -->
|transcript= <!-- Yes or No -->
|paid= <!-- Yes or No -->
|account_activity= <!-- Yes or No -->
|demographic= <!-- Yes or No -->
|device= <!-- Yes or No -->
|session= <!-- Yes or No -->
|recording2= <!-- Yes or No -->
|wildcard= <!-- use only when necessary -->
|publish= <!-- Yes or No -->
|publish_identifying= <!-- Yes or No -->
|volunteers= <!-- Yes or No -->
|partner= <!-- use only when necessary -->
|tool= <!-- only Google Forms, Qualtrics, SurveyMonkey, LimeSurvey, Google Meet, Zoom, Skype, Eventbrite, or QuickSurveys currently supported -->
|tool2= <!-- use only when necessary -->
|tool3= <!-- use only when necessary -->
|tool_other= <!-- use only when necessary -->
|retention= <!-- only 90 days, 180 days, 360 days, and indefinitely currently supported -->
}}
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.
This infobox is designed for use with the Template privacy statement
Parameter | Description | Type | Status | |
---|---|---|---|---|
What is the project title? | title | Title of the survey, event, etc. | Content | required |
If there is a project page to link, input here: | title_link | Interwiki prefix code followed by page name, for example m:Test or mw:Test | String | optional |
What Wikimedia Foundation team is involved? | team | One team involved in the collection or use of data; do not include the word 'team' | Content | optional |
If a particular infobox image is requested, input here: | image | Do not include brackets or File: | Content | optional |
Is there an event? | event | Typically involves a registration form
| String | optional |
Is there a meeting? | meeting | Typically involves less complex data publishing than an event
| String | optional |
Will data be used to improve our services or tools? | services | Typically feedback requested or user testing
| String | optional |
Will data be used to find participants, applicants, or nominations? | find | Typically a form people use to indicate interest or qualifications
| String | optional |
Will data be used to support community development? | community | Whether more directly or indirectly
| String | optional |
Will data be used for outreach or further communication? | outreach | Whether username, email address, or other contact info is involved
| String | optional |
Will data be used for open research and study? | research | Whether this is connected to research
| String | optional |
What service collects responses? | tool | Off-wiki service used to collect raw data or on-wiki QuickSurveys
| String | required |
What is the second service that collects responses? | tool2 | Only use if two services collect responses
| String | optional |
What is the third service that collects responses? | tool3 | Only use if three services collect responses
| String | optional |
If additional tools are involved, list here: | tool_other | Bypasses the infobox list of data collection tools
| String | optional |
Other partner | partner | Input just the service provider's name. | String | optional |
Will demographic information be collected? | demographic | Such as gender or nationality
| String | optional |
Will device information be collected? | device | Such as IP address, user agent
| String | optional |
Will nonpublic Wikimedia session information be collected? | session | Such as page viewed, login status
| String | optional |
Will Wikimedia Foundation be recording? | recording | Whether you will be doing video, audio, and/or screen recording
| String | required |
Will there be media submissions? | recording2 | Whether you will collect video, audio, and/or screen recording
| String | optional |
Will transcripts be collected? | transcript | Whether there will be chat logs, captions, or screenshots collected
| String | optional |
Will Wikimedia activity records be used? | account_activity | Typically when usernames are collected for an editing event
| String | optional |
Will participants be paid? | paid | Typically a gratuity or thank you gift
| String | optional |
If other information will be collected, list here: | wildcard | Only use if you need to specify more information collected | String | optional |
Will results be published? | publish | Whether any results will be published
| String | required |
Will identifiable results be published? | publish_identifying | Whether quotes with attribution will be published
| String | required |
Will raw data be shared with volunteers? | volunteers | Whether Wikimedia volunteers need access to the raw data
| String | required |
How long will raw data be retained? | retention | The raw data collected will be deleted, de-identified, or aggregated within this time
| String | required |