project

Project

This is a page for tracking the effort to develop a project microformat for authors and publishers to markup public projects like open-source software or other kinds of artistic distributions.

Per the microformats process. Start always with number one.

The project-*

1. *examples
2. *formats
3. *brainstorming
4. hproject
5. faq
6. *implementations

Please read process first, before creating new pages!

problem statement

scenarios

One of its primary intent is to allow robots to automatically classify projects in a freshmeat manner by browsing the web. ZimbaTm 08:31, 12 Jan 2008 (PST)

real world examples

Freshmeat.net

Description of the software project

• http://freshmeat.net

• • full project name (This is the publicly visible project name.)
  • short project name (This will be used to generate a /projects/<shortname>/ URL for your project.)
  • full description
  • short description
  • name of author
  • email address
  • branch name
  • branch description
  • license
  • homepage
  • version
  • release focus

43things.com

• http://43things.com

How I did a project

• • goal title
  • last words (One sentence summary.)
  • how
  • lessons
  • resources

Analysis of Examples

Common review fields

• project (name/title|URL(s)|image)
• author (name|email|URL)
• summary

existing formats

Please document in project-formats.

• A vocabulary for describing projects (primarily goal-oriented)
• DOAP: Description of a Project (software project specific)
• Program Evaluation and Review Technique

Related microformats

• hCalendar for timelines, milestones, and to-do items
• Resources
  • hCard for participating people
  • product for stuff(?)
    • rel-payment
• hReview for debriefing

brainstorming

Schema

The projecta schema consists of the following:

• Projecta (projecta)
  • version. optional. text.
  • summary. optional. text.
  • project info. required. (url || photo )
  • author. optional. hCard.
  • description. optional. text with optional valid HTML markup.
  • requirements. optional. text with optional url to products or other projects.
  • steps. optional. text with valid HTML ol (li) elements.
  • tags. optional. keywords or phrases, using rel-tag, each with optional rating.
  • permalink. optional, using rel-bookmark and rel-self.

Field details

The fields of the projecta schema represent the following:

version:: This optional field permits projecta publishers to specify a particular version of projecta that their content uses. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.1".

summary:: This optional field serves as a title for the project itself.

project info:: This required field MUST have at a minimum the name However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested inside the item element.

author:: The optional field specifies the person who authored the project. If the author is specified, an hCard representing the author MUST be provided. The projecta format is intended to be used in conjunction with MediaWiki which will require a username to submit a new project. The username will be represented with an hCard.

description:: This optional field contains the full text representing the written opinion of the author. The field MAY include valid HTML markup (e.g. paragraphs). User agents SHOULD preserve any markup.

requirements:: This optional field contains the requirements of the project. The field MAY include links to products or other projects.

steps:: Steps are represented using an ordered list of tasks required to complete the project. Represented as an ordered list with list elements.

tags:: Tags are represented using a list of keywords or phrases (using the rel-tag microformat for each individual keyword or phrase tag) that the author associates with the project.

permalink:: This optional field is a URL for the projecta. In addition to using the <a href> tag for this field, the attribute rel="self bookmark" MUST be used to indicate that the hyperlink is a permalink for the project itself. If the hyperlink already contains a rel attribute, then the values self and bookmark MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a project as a unique ID in order to identify and collate the same project from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the project. Authors MAY use the classname of "permalink" on the element representing the permalink.

The following field names have been reused from the hCard, hCalendar, and hReview microformats: version, summary, fn, url, photo, description, tags, permalink. In addition, items and authors described by hCards MAY contain any hCard field. The rel value "self" has been reused from the Atom 1.0 specification.

markup sample

Note: this markup sample is not based on any project-examples implied schema, and therefore is an a priori brainstorm that is not suitable for a microformat.

<div class="project" id="urn:uuid:233f6e5d-2ad2-4b7e-a3fe-1b90ef2fef57">
  <img class="logo" src="..." />
  <span class="name">Microformats</span>
  <span class="desc">An initiative to extract common patterns from POSH</span>

  <h1>Some informations</h1>
  <a href="http://microformats.org/" rel="home">The primary home page of the project.</a>
  <a href="..." rel="source">Here you can find its source code.</a>
  <a href="..." rel="release">Get the releases.</a>
  <-- Every hCard is looked as a participant [including venues? ] -->

  <h1>Project's tags</h1>
  <ul>
    <li class="tag">open</li>
    <li class="tag">format</li>
    <li class="tag">standard</li>
  </ul>
</div>

CSS selection specification

Note: this markup sample is not based on any project-examples implied schema, and therefore is an a priori brainstorm that is not suitable for a microformat.

A good way to describe the structure, is to look at it trough the view of CSS selectors. Designers sometimes need wrappers, which makes it hard to keep a strict structure. If you used jQuery, you know what I mean.

.project[@id] : is an UUID (see http://ietf.org/rfc/rfc4122.txt).
A unique identifier for the project.
It is used to resolve name clashes.
.project .name : the content describes the project name.
Should not appear more that one time per project.
.project IMG.logo : the src is a link to the logo.
Can have different sizes with by adding "low | mid | high" classes.
.project A[@rel=home] : a project's home page
.project A[@rel=source] : a link to the project's source.
If it is a scm, it is generally solved by using different uris.
Like git:// or bzr:// or http+git://
.project A[@rel=release] : the linked pages contains file releases.
This page can contain hRelease microformat.
.project A[@rel=...] : many extensions can be imagined, like :
 "blog | wiki | parent-project | ..."
.project .tag : the content describes a project tag. You can
have as many as you wish.

to-do

• project-examples
• project-formats
• Lots of discussion I guess, to satisfy different kinds of projects
• Semantic approval of experts

Notes

Please, keep the format simple. The current brainstorms above don't follow an existing standard (existing standards must first be documented in project-formats before proceeeding). It is preferable to re-use and develop minimal modules rather than being verbose. Are these bad or good for example: the uuid:.. or scm:// ones ?

Related ideas

• Release: semantic description of a project release. Possible usages : automatic tracking and/or conversion for package managers, automatic platform/mirror selection for download managers.