Extension:Proofread Page/Index data configuration

From mediawiki.org
Jump to navigation Jump to search

The fields presented by the edit form in the Index namespace are configured by the JSON structure at the page MediaWiki:Proofreadpage index data config.

The content is an array of fields like this:

{
    "Title": {
        "type": "page",
        "size": 1,
        "default": "",
        "label": "Title",
        "help": "The title of the work."
        "header": true,
        "data": "title",
    },
    ...
}
The keys are
  • type the data type (see below)
  • size the default size of the form input for this field
  • default the default value (set on page creation)
  • label the human-readable label for this field
  • help the human-readable help text for this field
  • js include this field in the JS configuration structure in the Page namespace
  • header: boolean; include this field as a parameter to {{:Mediawiki:Proofreadpage header template}} in the header when <pagelist ... header=1 /></code> is used.
  • delimiter
  • data: the data that this field represents (see below)

Data types[edit]

There are several data types fields can have:

  • string free text
  • string/line free text with a multi-line field
  • page link to a Wiki page
  • langcode language code of the index
  • number numeric value
  • Authority control types:

You can specify a drop down with string and providing a list of options in values:

    "Status": {
        "type": "string",
        "values": {
            "T": "Done (all validated)",
            "V": "To be validated",
           ...
        },
        ...
    }

Data field[edit]

The data field denotes that the field has a particular meaning to ProofreadPage:

  • progress the progress of the index (e.g. fully validated, etc)
  • pagelist the content of the pagelist
  • wikibase-itemid the attached Wikidata item
  • ...