Template:Project

From PDWiki

Jump to: navigation, search

The Project template creates a floating infobox that provides a quick overview of a project.

Usage

{{Project|ProjectName|
  curator=UserName|
  path=DepotPath|
  language=ProgrammingLanguage|
  download=DownloadDepotPath|
  documentation=DocumentationDepotPath|
  license=LicenseType|
  banner=BannerImageFile|
  icon=IconImageFile|
  screen=ScreenImageFile|
  brief=Brief description}}

All of the parameters after ProjectName are optional and can be specified in any order.

  • If curator is not specified, the page will be placed in the unowned projects category since it has presumably been abandoned.
  • If path is not specified, the page will be placed in the unsubmitted projects category since it has presumably not been submitted to the depot yet.
  • The license parameter should be the name of the license, not the license in its entirety; use Template:License to generate a full description of the license on the same page, or insert your own license under a heading of "License". If no license is specified, a link to PDWiki:License will be generated in its place.
  • If language is specified and there is an existing category for ProgrammingLanguage, the page will automatically be added to that category.
  • Both download and documentation should be given as fully qualified depot paths, just like path.
  • The icon, banner, and/or screen parameters must refer to images that have already been uploaded. They will be automatically resized to fit within certain size constraints, so it is best if you use an image that already has appropriate dimensions; icon should be a small and square image, banner should be a short and wide image, and screen should be a screenshot. (Remember that these are all optional and should only be used if appropriate to the project; screenshots, for example, do not make very much sense for a command-line utility.)

Examples

Minimal

This example uses only a few parameters to display a fairly minimal project info box. 

{{ Project     |           P4LOL          |
  path=         //guest/de_carabas/p4lol/ |
  curator=      De Carabas                }}

creates the box seen at right.

Extended

This example uses a few more of the optional parameters to show where each one will appear in the template. 

{{ Project     |                 P4LOL                 |
  language=     LOLcode                                |
  path=         //guest/de_carabas/p4lol/              |
  curator=      De Carabas                             |
  brief=        Perforce LOLcode API.  I CAN HAS P4?   |
  download=     //guest/de_carabas/p4lol/p4lol-bin/... |
  documentation=//guest/de_carabas/p4lol/README.txt    }}
  license=      BSD

creates the box seen at right.

If a LOLcode category existed, specifying LOLcode as the language would automatically add this page to that category and create a link to the corresponding category page.

Retrieved from "http://public.perforce.com/wiki/Template:Project"
Personal tools