project: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
Line 165: Line 165:


== brainstorming ==
== brainstorming ==
== Format ==
=== In General ===
The projecta format is based on a set of fields common to numerous project sites and formats in use today on the web.  Where possible field names have been chosen based on those defined by the related [[hcard|hCard]], [[hatom|hAtom]], [[hcalendar|hCalendar]], and [[hrecipe|hRecipe]].


=== Schema ===
=== Schema ===
The projecta schema consists of the following:
The projecta schema consists of the following elements:


* projecta ('''<code>projecta</code>''')
* '''projecta'''
** '''version'''. optional. text.
** '''''fn'''''. required. text. the formatted name of the project. re-used from [[hCard]].
** '''summary'''. optional. text. serves as the title for the project.
** '''''summary'''''. optional. text. re-used from [[hCalendar]].
** '''type'''. optional. abstract | practical.
** '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]].
** '''project''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' )
** ''published''. optional. re-used from [[hAtom]]. [experimental]
** '''author'''. optional. '''[[hcard|hCard]]'''.
** ''tag''. optional. 1 or more. re-used from [[rel-tag]]. [experimental]
** '''description'''. optional. text with optional valid HTML markup.
** ''photo''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [experimental]
** '''goals'''. optional. text with valid HTML '''<code>ul</code>''' ('''<code>li</code>''') elements.
** ''requirement''. optional. text with optional valid (x)HTML markup.
** '''instructions'''. optional. text with valid HTML '''<code>ol</code>''' ('''<code>li</code>''') elements.
** ''instructions''. optional. text with optional valid (x)HTML markup. re-used from [[hRecipe]].
** '''accomplishments'''. optional. text with valid HTML '''<code>ul</code>''' ('''<code>li</code>''') elements.
** '''''duration'''''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
** '''requirements'''. optional. text {{may}} include valid HTML markup e.g. paragraphs or a list.  
** '''tags'''. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.
** '''permalink'''. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.


=== Field details ===
=== Field details ===
The fields of the projecta schema represent the following:
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".
==== fn ====
 
The title of a single project. The formatted name of what the projecta documents.
 
* The element is identified by class name <code>fn</code>.
* A projecta {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].
 
==== summary ====


'''summary''':: This optional field serves as the title for the project..
The summary provides a short introduction to or an accompanying statement about the project.


'''type''':: This optional field "type" provides the type of project, one of the following: abstract, practical. If omitted, then in some cases the project type may be inferred. For projects of type "abstract" {{should}} have "goals" and/or "accomplishments" fields completed. For projects of type "practical" {{should}} have "instructions" field completed.
* The element is identified by the class name <code>summary</code>.
* A projecta {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].


'''project''':: This required field {{must}} have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' project (a projecta describes only one project), {{may}} provide at least one URI ("url") for the project, and {{may}} provide at least one URL to a photo or depiction ("photo") of the project. However, when using item info subproperties ("fn", "url", "photo"), they {{must}} be nested <em>inside</em> the project element.
==== author ====


'''author''':: This optional field specifies the person who authored the project.  If the author is specified, an hCard representing the author {{must}} be provided.
The person who authored the project.


'''description''':: This optional field contains the full text representing the input of the author. The field {{may}} include valid HTML markup (e.g. paragraphs).  User agents {{should}} preserve any markup.
* The element is identified by class name <code>author</code>.
* A projecta {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].


'''goals''':: This optional field documents the project's goals.
==== published ====


'''instructions''':: This optional field documents the instructions required to complete the project. Re-used from [[hrecipe|hRecipe]].
The date the project was published.


'''accomplishments''':: This optional field documents the project's accomplishments.
* The element is identified by the class name <code>published</code>.
* A projecta {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.


'''requirements''':: This optional field contains the requirements of the project. The field {{may}} include links to products or other projects.
==== tag ====


'''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.
A keyword indicating a subject or an important aspect of the project like it's main requirement, type of project etc.


'''permalink''':: This optional field is a URL for the projecta.  In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> {{must}} be used to indicate that the hyperlink is a permalink for the project itself.  If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> {{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 element is identified by class name <code>tag</code>.
* A projecta {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].


==== photo ====


=== markup sample ===
Accompanying image.
<strong>Note: this markup sample is not based on any [[project-examples]] implied schema, and therefore is an <em>a priori</em> brainstorm that is not suitable for a microformat.</strong>


<pre><nowiki>
* The element is identified by the class name <code>photo</code>.
<div class="project" id="urn:uuid:233f6e5d-2ad2-4b7e-a3fe-1b90ef2fef57">
* A projecta {{may}} include one or more photo elements.
  <img class="logo" src="..." />
* The element {{should}} use an &lt;img&gt; element.
  <span class="name">Microformats</span>
* The element {{may}} use any other element that contains a URL, such as &lt;a&gt; or &lt;object&gt;, but it is not recommended.
  <span class="desc">An initiative to extract common patterns from POSH</span>
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
 
==== requirement ====
 
Describes one or more requirements of the project.
 
* The element is identified by the class name <code>requirement</code>.
* A projecta {{must}} include one or more <code>requirement</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of requirements).
 
==== instructions ====


  <h1>Some informations</h1>
Documents the instructions required to complete the project.
  <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>
* The element is identified by the class name <code>instructions</code>.
  <ul>
* A projecta {{may}} include a <code>instructions</code> element.
    <li class="tag">open</li>
* The field {{may}} include valid HTML markup e.g. paragraphs or a list of steps.
    <li class="tag">format</li>
    <li class="tag">standard</li>
  </ul>
</div>
</nowiki></pre>


=== CSS selection specification ===
==== duration ====
<strong>Note: this markup sample is not based on any [[project-examples]] implied schema, and therefore is an <em>a priori</em> brainstorm that is not suitable for a microformat.</strong>


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.
The time it takes to complete the project described by the projecta. Multiple duration fields can be used to denote time taken per instruction.
* The element is identified by the class name <code>duration</code>.
* A projecta {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].


<pre><nowiki>
<pre><nowiki>
.project[@id] : is an UUID (see http://ietf.org/rfc/rfc4122.txt).
<div class="projecta">
A unique identifier for the project.
<h3 class="fn">Germinating Seeds</h3>
It is used to resolve name clashes.
<p class="summary">
.project .name : the content describes the project name.
How to germinate seeds in potting mix.<br />
Should not appear more that one time per project.
</p>
.project IMG.logo : the src is a link to the logo.
<p class="vcard fn">Derek Lewis</p>
Can have different sizes with by adding "low | mid | high" classes.
<p>Published <abbr class="published" title="2009-03-28T09:30-11:00">28. Mar 2009</abbr></p>
.project A[@rel=home] : a project's home page
<img src="/img/seed.png" class="photo" width="100" height="100" alt="Seed"/>
.project A[@rel=source] : a link to the project's source.
<h4>Requirements</h4>
If it is a scm, it is generally solved by using different uris.
<ul class="requirement">
Like git:// or bzr:// or http+git://
<li>Container(s) (With drain holes)</li>
.project A[@rel=release] : the linked pages contains file releases.
<li>Seed(s)</li>
This page can contain hRelease microformat.
<li>Potting Mix</li>
.project A[@rel=...] : many extensions can be imagined, like :
<li>Fresh Water</li>
"blog | wiki | parent-project | ..."
<li>A Light Source</li>
.project .tag : the content describes a project tag. You can
</ul>
have as many as you wish.
<h4>Instructions</h4>
<ol class="instructions">
<li>Loosen and dampen the potting mix.</li>
<li>Fill 2/3 of each container(s) with potting mix.</li>
<li>Put seed(s) in container with potting mix.</li>
<li>Sprinkle a few drops of water over of the seed(s). (Remember to repeat this once potting mix becomes dry.)</li>
<li>Place container under light source.</li>
</ol>
</div>
</nowiki></pre>
</nowiki></pre>


Revision as of 03:50, 29 March 2009

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.

View each individual page as the main page omits some content.

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

    • 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
    • Tar/GZ
    • Tar/BZ2
    • Zip
    • Changelog
    • RPM package
    • Debian package
    • OS X package
    • Bittorrent
    • BSD Ports URL
    • Autopackage URL
    • Jar
    • Purchase
    • CVS tree (cvsweb)
    • Bug tracker
    • Mailing list archive
    • Mirror site
    • Demo site
    • version
    • release focus
    • Dependencies

43things

How I did a project

    • goal title
    • last words (summary)
    • how (instructions)
    • lessons
    • time taken
    • resources

Moldova Aid Project

A humanitarian aid project

    • summary
    • achievements

CORDIS

Community Research and Development Information Service

    • project title
    • Research area
    • Coordinator (author)
    • Project description
    • Project details
      • Project Acronym
      • Project Reference
      • Start Date
      • Duration
      • Project Cost
      • Contract Type
      • End Date
      • Project Status
      • Project Funding
    • Participants

The World Bank

Moldova Community Forestry Project

    • project title
    • Project ID
    • Project Status
    • Approval Date
    • Closing Date
    • Total Project Cost
    • Region
    • Major Sector (Sector) (%)
    • Old Major Sector
    • Old Sector
    • Environmental Category
    • Bank Team Lead
    • Borrower
    • Implementing Agency
    • Project Goals
    • Available Project Documents
    • Related Country Information

Poncho

How to make a poncho

    • project title
    • summary
    • Material (requirements)
    • Gauge (notes)
    • directions (instructions)

RX-8 iPod Install

How to install an iPod into an RX-8

    • title
    • author
    • date
    • Car Compatibility List (summary)
    • Basic Idea (instructions)
    • Tools Needed (requirements)
    • notes
    • WARNING

How to fix a CD player

    • title
    • by (author)
    • date and time submitted
    • tags
    • description
    • summary
    • instructions

Analysis of Examples

Common project fields

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

existing formats

Please document in project-formats.

Related microformats

brainstorming

Format

In General

The projecta format is based on a set of fields common to numerous project sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related hCard, hAtom, hCalendar, and hRecipe.

Schema

The projecta schema consists of the following elements:

  • projecta
    • fn. required. text. the formatted name of the project. re-used from hCard.
    • summary. optional. text. re-used from hCalendar.
    • author. optional. 1 or more. re-used from hAtom using hCard.
    • published. optional. re-used from hAtom. [experimental]
    • tag. optional. 1 or more. re-used from rel-tag. [experimental]
    • photo. optional. 1 or more. using any element containing a URL, such as IMG. re-used from hCard. [experimental]
    • requirement. optional. text with optional valid (x)HTML markup.
    • instructions. optional. text with optional valid (x)HTML markup. re-used from hRecipe.
    • duration. optional. 1 or more. text (see ISO-31-1 duration brainstorming). re-used from hCalendar.

Field details

The fields of the projecta schema represent the following:

fn

The title of a single project. The formatted name of what the projecta documents.

  • The element is identified by class name fn.
  • A projecta MUST include a fn .
  • The element MUST follow the conventions outlined in hCard.

summary

The summary provides a short introduction to or an accompanying statement about the project.

  • The element is identified by the class name summary.
  • A projecta MAY include a summary.
  • The element MUST follow the conventions outlined in hCalendar.

author

The person who authored the project.

  • The element is identified by class name author.
  • A projecta MAY include one or more author elements.
  • The contents of the element MUST follow the conventions outlined in hCard.

published

The date the project was published.

  • The element is identified by the class name published.
  • A projecta MAY include a published date.
  • The element MUST follow the conventions outlined in hAtom.
  • The datetime-design-pattern SHOULD be used to encode the published datetime.
  • The element is considered experimental and may be removed from the final specification.

tag

A keyword indicating a subject or an important aspect of the project like it's main requirement, type of project etc.

  • The element is identified by class name tag.
  • A projecta MAY include one or more tag elements.
  • The element MUST follow the conventions outlined in rel-tag.

photo

Accompanying image.

  • The element is identified by the class name photo.
  • A projecta MAY include one or more photo elements.
  • The element SHOULD use an <img> element.
  • The element MAY use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
  • The contents of the element MUST follow the conventions outlined in hCard.

requirement

Describes one or more requirements of the project.

  • The element is identified by the class name requirement.
  • A projecta MUST include one or more requirements.
  • The field MAY include valid HTML markup (e.g. a list of requirements).

instructions

Documents the instructions required to complete the project.

  • The element is identified by the class name instructions.
  • A projecta MAY include a instructions element.
  • The field MAY include valid HTML markup e.g. paragraphs or a list of steps.

duration

The time it takes to complete the project described by the projecta. Multiple duration fields can be used to denote time taken per instruction.

  • The element is identified by the class name duration.
  • A projecta MAY include one or more durations.
  • The element MUST follow the conventions outlined in hCalendar.
<div class="projecta">
	<h3 class="fn">Germinating Seeds</h3>
	<p class="summary">
		How to germinate seeds in potting mix.<br />
	</p>
	<p class="vcard fn">Derek Lewis</p>
	<p>Published <abbr class="published" title="2009-03-28T09:30-11:00">28. Mar 2009</abbr></p>
	<img src="/img/seed.png" class="photo" width="100" height="100" alt="Seed"/>
	<h4>Requirements</h4>
	<ul class="requirement">
		<li>Container(s) (With drain holes)</li>
		<li>Seed(s)</li>
		<li>Potting Mix</li>
		<li>Fresh Water</li>
		<li>A Light Source</li>
	</ul>
	<h4>Instructions</h4>
	<ol class="instructions">
		<li>Loosen and dampen the potting mix.</li>
		<li>Fill 2/3 of each container(s) with potting mix.</li>
		<li>Put seed(s) in container with potting mix.</li>
		<li>Sprinkle a few drops of water over of the seed(s). (Remember to repeat this once potting mix becomes dry.)</li>
		<li>Place container under light source.</li>
	</ol>
</div>

to-do

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.
Retrieved from "http://microformats.org/wiki/index.php?title=project&oldid=38255"