Page MenuHomePhabricator

Add documentation to most used undocumented pages on Commons
Open, NormalPublic

Description

Many of the most used templates on Commons do not have documentation pages that meet current community standards. The task is to find an document such pages:

  1. Finding templates in need of documentation can be done with http://quarry.wmflabs.org/query/6313 query (also copied to this page ).
  2. Documenting templates should follow best Commons practices and should include: using /doc subpage and Template:TemplateBox . All the categories should be at the /doc page and all the interwiki links should be done through wikidata. If edits need to be done to protected templates than a message should be left at the template talk page with Template:Edit_request. Documentation should include description of all the input parameters and might require studying the template code and the code of pages using it.

Recommended steps:

  1. Create Wikipedia account if you do not have one.
  2. Go to this page and pick a template you would like to work on.
  3. In most cases templates will only have "<noinclude>{{documentation}}</noinclude>" at the end that links to documentation which link to /doc subpage.
    • If /doc subpage does not exist copy existing documentation somewhere and replace it with "<noinclude>{{documentation}}</noinclude>", then click on the red link to the /doc page. Once there use a link on the top to preload a TemplateBox with enough parameters and them merge old documentation into the page and expand it.
    • If /doc subpage does exist but does not use TemplateBox, than add and fill the template. Preload pages here might be useful.

See also

  1. https://commons.wikimedia.org/wiki/Commons:TemplateData
  2. https://commons.wikimedia.org/wiki/Special:MostTranscludedPages for live examples.

This task is meant as "Google-Code-In-2015" project.

Event Timeline

Jarekt created this task.Dec 4 2015, 2:01 PM
Jarekt raised the priority of this task from to Normal.
Jarekt updated the task description. (Show Details)
Jarekt added a subscriber: Jarekt.
Restricted Application added subscribers: Steinsplitter, Aklapper. · View Herald TranscriptDec 4 2015, 2:01 PM
zhuyifei1999 moved this task from Incoming to Backlog on the Commons board.Dec 5 2015, 5:00 AM
Nemo_bis added a subscriber: Nemo_bis.EditedJan 5 2016, 10:41 AM

As Jarekt pointed out at https://groups.google.com/d/msg/gci-mentors/PUWcFkZ8z4s/3gmQYf_pCQAJ, 3 students claimed this task and then abandoned it.

In my opinion this is not a beginner task because it requires multiple wiki editing skills. I propose to:

  1. make this a non-beginner task so that our non-beginner GCI students are allowed to pick it up;
  2. remove the link to quarry, refer to the on-wiki list;
  3. break down the point 2, link help pages explaining templates and template documentation including TemplateData;
  4. consider mentioning that the student should register an account;
  5. add a help page explaining what it means that "all the interwiki links should be done through wikidata";
  6. replace https://commons.wikimedia.org/wiki/Special:MostTranscludedPages with a link to a couple good examples to follow, to reduce confusion.
Jarekt added a comment.Jan 5 2016, 3:12 PM

Nemo, thanks for your recommendations. I modified the description and I think implemented all your suggestions. I run out of space so here is the section about recommended steps that did not fit:

  1. Create Wikipedia account if you do not have one.
  2. Go to this page and pick a template you would like to work on.
  3. In most cases templates will only have "<noinclude>{{documentation}}</noinclude>" at the end that links to documentation which link to /doc subpage.
    • If /doc subpage does not exist copy existing documentation somewhere and replace it with "<noinclude>{{documentation}}</noinclude>", then click on the red link to the /doc page. Once there use a link on the top to preload a TemplateBox with enough parameters and them merge old documentation into the page and expand it.
    • If /doc subpage does exist but does not use TemplateBox, than add and fill the template. Preload pages here might be useful.

Good!

I run out of space

That happens to me too for on-wiki editing tasks, but I found that I reduced student headaches a lot when being more verbose. :) You can keep the full description of the steps in the task description here and link this report from the GCI task.

Nemo_bis updated the task description. (Show Details)Jan 5 2016, 10:26 PM
Restricted Application added a subscriber: Poyekhali. · View Herald TranscriptMay 23 2016, 6:07 PM
Quiddity updated the task description. (Show Details)May 14 2017, 5:21 PM
Quiddity updated the task description. (Show Details)May 14 2017, 5:34 PM
jeropbrenda added a subscriber: jeropbrenda.EditedMar 14 2019, 12:24 PM

Hello, I'm a new contributor and I've made a draft for documentation of Template:IsNum here. Please review:)

Restricted Application added a subscriber: Liuxinyu970226. · View Herald TranscriptMar 14 2019, 12:24 PM
This comment was removed by Nikitrain.