Difference between revisions of "projecta"

From Microformats Wiki
Jump to navigation Jump to search
Line 5: Line 5:
 
=== In General ===
 
=== 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]], [[hcalendar|hCalendar]], and [[hreview|hReview]] standards.
 
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]], [[hcalendar|hCalendar]], and [[hreview|hReview]] standards.
 +
 +
== 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]], [[hcalendar|hCalendar]], [[hreview|hReview]], and [[hrecipe|hRecipe]].
  
 
=== Schema ===
 
=== Schema ===
 
The projecta schema consists of the following:
 
The projecta schema consists of the following:
  
* Projecta ('''<code>projecta</code>''')
+
* projecta ('''<code>projecta</code>''')
** '''<code>version</code>'''. optional. text.
+
** '''version'''. optional. text.
** '''<code>summary</code>'''. optional. text.
+
** '''summary'''. optional. text. one sentence.
** '''<code>project</code>'''. info. required. ('''<code>url</code>''' || '''<code>photo</code>''')
+
** '''type'''. optional. abstract | practical.
** '''<code>author</code>'''. optional. '''[[hcard|hCard]]'''.
+
** '''project''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' )
** '''<code>description</code>'''. optional. text with optional valid HTML markup.
+
** '''author'''. optional. '''[[hcard|hCard]]'''.
** requirements. optional. text with optional '''<code>url</code>''' to products or other projects.
+
** '''description'''. optional. text with optional valid HTML markup.
** steps. optional. text with valid HTML '''<code>ol</code>''' ('''<code>li</code>''') elements.
+
** '''goals'''. optional. text with valid HTML '''<code>ul</code>''' ('''<code>li</code>''') elements.
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.
+
** '''instructions'''. optional. text with valid HTML '''<code>ol</code>''' ('''<code>li</code>''') elements.
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.
+
** '''accomplishments'''. optional. text with valid HTML '''<code>ul</code>''' ('''<code>li</code>''') elements.
 +
** '''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 ===
Line 25: Line 32:
 
'''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".
 
'''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.
+
'''summary''':: This optional field serves as a one sentence summary of the project.
  
'''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 <em>inside</em> the item element.
+
'''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.
 +
 
 +
'''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''':: This optional field specifies the person who authored the project.  If the author is specified, an hCard representing the author {{must}} be provided.
 
'''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 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.
+
'''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.
 +
 
 +
'''goals''':: This optional field documents the project's goals.
 +
 
 +
'''instructions''':: This optional field documents the instructions required to complete the project. Re-used from [[hrecipe|hRecipe]].
 +
 
 +
'''accomplishments''':: This optional field documents the project's accomplishments.
  
 
'''requirements''':: This optional field contains the requirements of the project. The field {{may}} include links to products or other projects.
 
'''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.
 
'''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.
Line 42: Line 54:
 
'''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.
 
'''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 following field names have been reused from the [[hcard|hCard]], [[hcalendar|hCalendar]], and [[hreview|hReview]] microformats: <code>version, summary, fn, url, photo, description, tags, permalink</code>.  In addition, items and authors described by hCards {{may}} contain any hCard field.  The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].
+
The following field names have been reused from the [[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], and [[hrecipe|hRecipe]] microformats: <code>version, summary, url, photo, description, instructions, tags, permalink</code>.  In addition, items and authors described by hCards {{may}} contain any hCard field.  The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].

Revision as of 23:32, 24 March 2009

Projecta

Even though there are existing project formats, the projecta format MUST be developed because there is no established project format and it will enable decentralized development of projects.

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, hCalendar, and hReview standards.

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, hCalendar, hReview, and hRecipe.

Schema

The projecta schema consists of the following:

  • projecta (projecta)
    • version. optional. text.
    • summary. optional. text. one sentence.
    • type. optional. abstract | practical.
    • project info. required. fn (url || photo )
    • author. optional. hCard.
    • description. optional. text with optional valid HTML markup.
    • goals. optional. text with valid HTML ul (li) elements.
    • instructions. optional. text with valid HTML ol (li) elements.
    • accomplishments. optional. text with valid HTML ul (li) elements.
    • 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-design-pattern 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 one sentence summary of 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.

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 inside the project element.

author:: This optional field specifies the person who authored the project. If the author is specified, an hCard representing the author MUST be provided.

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.

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

instructions:: This optional field documents the instructions required to complete the project. Re-used from hRecipe.

accomplishments:: This optional field documents the project's accomplishments.

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

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, hReview, and hRecipe microformats: version, summary, url, photo, description, instructions, 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.