Template:ProjectInfoBox: Difference between revisions

From CoMakingSpace Wiki

No edit summary
No edit summary
Line 78: Line 78:
<templatedata>
<templatedata>
{
{
    "description": "Provide information about a project you have built.",
"description": "Provide information about a project you have built.",
    "params": {
"params": {
        "project title": {
"project title": {
            "label": "The name of your project",
"label": "The name of your project",
            "type": "string",
"type": "string",
            "required": true,
"required": true,
            "description": "The name of your project",
"description": "The name of your project",
            "default": "Unnamed Project"
"default": "Unnamed Project"
        },
},
        "image": {
"image": {
            "label": "An image for your project",
"label": "An image for your project",
            "type": "wiki-file-name",
"type": "wiki-file-name",
            "required": false,
"required": false,
            "description": "The filename of the image which represents your project the best. This might be printed on our [[Project Wall]]"
"description": "The filename of the image which represents your project the best. This might be printed on our [[Project Wall]]",
        },
"suggested": true
        "status": {
},
            "label": "Status of your project",
"status": {
            "type": "string",
"label": "Status of your project",
            "required": false,
"type": "string",
            "description": "The current release status of your project",
"required": false,
            "default": "planned"
"description": "The current release status of your project",
        },
"default": "planned",
        "date": {
"suggested": true
            "label": "The release date of your project",
},
            "type": "date",
"date": {
            "required": false,
"label": "The release date of your project",
            "description": "The Date on which your project has been finished. Will be assigned to Property:ProjectDate and thus be searchable within [[Semantic MediaWiki]]."
"type": "date",
        },
"required": false,
        "initiator": {
"description": "The Date on which your project has been finished. Will be assigned to Property:ProjectDate and thus be searchable within [[Semantic MediaWiki]]."
            "label": "Who initiated your project?",
},
            "type": "string",
"initiator": {
            "required": false,
"label": "Who initiated your project?",
            "description": "The name of the person which initiated your project.",
"type": "string",
            "default": "who maintains it?"
"required": false,
        },
"description": "The name of the person which initiated your project.",
        "team": {
"default": "who maintains it?",
            "label": "The Team helping with your project.",
"suggested": true
            "type": "string",
},
            "required": false
"team": {
        },
"label": "The Team helping with your project.",
        "materials": {
"type": "string",
            "label": "Materials you have used.",
"required": false
            "type": "string",
},
            "required": false,
"materials": {
            "description": "A list of materials you have used in your project. Please provide them as wiki-links ([[Material]])"
"label": "Materials you have used.",
        },
"type": "string",
        "tools": {
"required": false,
            "label": "Tools you have used.",
"description": "A list of materials you have used in your project. Please provide them as wiki-links ([[Material]])"
            "type": "string",
},
            "required": false,
"tools": {
            "description": "A list of tools you have used in your project. Please provide them as wiki-links ([[Material]])"
"label": "Tools you have used.",
        },
"type": "string",
        "software": {
"required": false,
            "label": "Software you have used.",
"description": "A list of tools you have used in your project. Please provide them as wiki-links ([[Material]])"
            "type": "string",
},
            "required": false,
"software": {
            "description": "A list of softwareyou have used in your project. Please provide them as wiki-links ([[Material]])"
"label": "Software you have used.",
        },
"type": "string",
        "cost": {
"required": false,
            "label": "Costs of your project",
"description": "A list of softwareyou have used in your project. Please provide them as wiki-links ([[Material]])"
            "type": "string",
},
            "required": false,
"cost": {
            "description": "An estimate of the costs needed when someone wants to rebuild your project."
"label": "Costs of your project",
        }
"type": "string",
    }
"required": false,
"description": "An estimate of the costs needed when someone wants to rebuild your project."
}
}
}
}
</templatedata>
</templatedata>
</noinclude>
</noinclude>

Revision as of 00:54, 20 December 2020

ProjectInfoBox

Unnamed Project

Project-default.png
Status: planned
Release Date: (planned) finishing date
Initiator: who maintains it?


Inform others about your project in a compact overview!

Documentation

To use this template, simply copy this code into your page and enter the relevant parameters:

{{ProjectInfoBox
|project title=
|image=
|status=
|date=
|initiator=
|team=
|materials=
|tools=
|software=
|cost=
}}

Default values for some parameters exist, but will only be used if the entire line is omitted. For example, |image= leads to no image being displayed while not entering the image parameter at all will lead to the default image (light bulb) being displayed. Please make use of the "Show preview" button and it should be clear.

If you had/have helpers with your project, you can use the team value to give them credit. Try using Template:HelpNeeded here to find collaborators! If you delete it or leave it empty, that field is not displayed at all.

The software, materials and tools value behaves this way as well since some projects are realized with tools and materials but others are done mostly digitally.

Semantic MediaWiki

The content you enter for "date" can be queried under Property:ProjectDate.

Bugs/Future Development

  • selection instead of free text: status= planned/in progress/finished?

Provide information about a project you have built.

Template parameters

ParameterDescriptionTypeStatus
The name of your projectproject title

The name of your project

Default
Unnamed Project
Stringrequired
An image for your projectimage

The filename of the image which represents your project the best. This might be printed on our [[Project Wall]]

Filesuggested
Status of your projectstatus

The current release status of your project

Default
planned
Stringsuggested
The release date of your projectdate

The Date on which your project has been finished. Will be assigned to Property:ProjectDate and thus be searchable within [[Semantic MediaWiki]].

Dateoptional
Who initiated your project?initiator

The name of the person which initiated your project.

Default
who maintains it?
Stringsuggested
The Team helping with your project.team

no description

Stringoptional
Materials you have used.materials

A list of materials you have used in your project. Please provide them as wiki-links ([[Material]])

Stringoptional
Tools you have used.tools

A list of tools you have used in your project. Please provide them as wiki-links ([[Material]])

Stringoptional
Software you have used.software

A list of softwareyou have used in your project. Please provide them as wiki-links ([[Material]])

Stringoptional
Costs of your projectcost

An estimate of the costs needed when someone wants to rebuild your project.

Stringoptional