Template:Project-summary: Difference between revisions

Revision as of 21:56, 8 January 2008

Template for Activity Grid; one row in a table. Comments for html alignment.

[[Image:activity-{{{simplename}}}.svg|40px| {{{simplename}}} icon]] [[{{{prettyname}}}]] : {{{description}}} [[Activities/{{{prettyname}}}|+/-]]
{{{comments}}}
Maintainers: {{{maintainers}}} · License: {{{license}}} · Mime types: {{{mimetypes}}} [[:Image:{{{packagename}}}-{{{version}}}.xo|Download v.{{{version}}}]] · [{{{source-url}}} source ]
[[Tests/{{{prettyname}}}|Tested]] in: {{{builds}}} (trac)
Translate: {{{l10n-link}}}
{{{l10n-notes}}}

Usage

Icons should be uploaded as svg's (just as in the bundles) named activity-<name>.svg. New versions of the bundles should be uploaded as <name>-<versionnumber>.xo. packagename is a version of simplename used in filenames and in software class names for readability. (This is for historical reasons. simplename and packagename should be merged across activities in our style guide, so that there are only two variations on a name aside from the unique service_name. Sj talk)

Key:

New activities should use the project-pre-summary template, including:

prettyname - the display name for the activity, such as Comic Maker. 
description - a few sentences describing the activity and its audience
categories - any keywords that match your activity and its use.  
   see the activities grid for examples.
maintainers - people actively working on the activity, with links to 
   their userpages or ways to contact them.
image - title of an uploaded image that may make a suitable icon
port-notes - notes on other platforms and potential or in-progress ports
mimetypes - mime types that the activity can read and launch.
comments - general comments about development.
l10n-notes - comments about localization, including links for translating
   existing related projects.
license - the name of the license[s] your activity uses, with a link
   to its full text.
status - from 0 to 6.  0:idea, 1:stub, 2:immature, 3:active development,
   4:beta, 5:stable, 6:finishing touches

Testable projects should review the style guide and use the project-summary template, also including:

simplename - a simple name for the activity: it should contain only lowercase 
   letters, numbers, hyphens, underscores.  Determines the name of some source files.
packagename - the name used for project bundles; it should not contain spaces.
   It can be the same as simplename (best option) or a CamelCase version of it 
   (some existing activities do this). 
license - the name of the license[s] your activity uses, with a link
   to its full text.
status - from 0 to 6.  0:idea, 1:stub, 2:immature, 3:active development,
   4:beta, 5:stable, 6:finishing touches
version - the version number of the latest build.
source-url - a raw url for the source repository .
builds - latest builds in which the activity has been tested.
l10n-url - url and title of a place to go to translate the activity.
   common options are {{pootle|xo_core}} and {{pootle|xo_bundled}}.