how-to-start-a-new-microformat - Revision history

ManuSporny: /* Step 1: Determine if a New Microformat is Needed */

2007-08-08T05:10:36Z

Step 1: Determine if a New Microformat is Needed

← Older revision		Revision as of 05:10, 8 August 2007
Line 17:		Line 17:

	== Step 1: Determine if a New Microformat is Needed ==		== Step 1: Determine if a New Microformat is Needed ==

			After you understand the basics, make sure you understand the problem that you are trying to solve. Once you understand the problem you are trying to solve, make sure it hasn't already been solved.

	# '''Create a Problem Statement'''		# '''Create a Problem Statement'''

ManuSporny: /* Step 0: Before You Start */

2007-08-08T05:08:32Z

Step 0: Before You Start

← Older revision		Revision as of 05:08, 8 August 2007
Line 6:		Line 6:

	== Step 0: Before You Start ==		== Step 0: Before You Start ==

			You must make sure that you understand the basics before you propose a new Microformat. The first mistake that you can make is to not educate yourself about what we do here.

	# '''Educate Yourself About How This Community Operates''' - [[#Logic:_Educating_Yourself_Before_Proposing_a_Microformat\|Explain the logic...]]		# '''Educate Yourself About How This Community Operates''' - [[#Logic:_Educating_Yourself_Before_Proposing_a_Microformat\|Explain the logic...]]

ManuSporny: more fixes to editors/authors/contributors section

2007-08-08T05:07:28Z

more fixes to editors/authors/contributors section

← Older revision		Revision as of 05:07, 8 August 2007
Line 1:		Line 1:
	= The New Microformat HOW-TO =		= The New Microformat HOW-TO =
	Author: [[User:ManuSporny\|Manu Sporny]]<br/>		Primary Author/Editors: [[User:ManuSporny\|Manu Sporny]]<br/>
	Contributors: [[User:Brian\|Brian Suda]]<br/>		Contributors (in order of contribution): [[User:ManuSporny\|Manu Sporny]], [[User:Brian\|Brian Suda]]<br/>

	This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.		This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.

ManuSporny: added brian suda to contributors

2007-08-08T05:06:15Z

added brian suda to contributors

← Older revision		Revision as of 05:06, 8 August 2007
Line 1:		Line 1:
	= The New Microformat HOW-TO =		= The New Microformat HOW-TO =
	Author: [[User:ManuSporny\|Manu Sporny]]<br/>		Author: [[User:ManuSporny\|Manu Sporny]]<br/>
			Contributors: [[User:Brian\|Brian Suda]]<br/>

	This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.		This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.

ManuSporny: fixed typo in author name

2007-08-08T05:05:34Z

fixed typo in author name

← Older revision		Revision as of 05:05, 8 August 2007
Line 1:		Line 1:
	= The New Microformat HOW-TO =		= The New Microformat HOW-TO =
	Author: [[User:ManuSporny\|~~ManuSporny~~]]<br/>		Author: [[User:ManuSporny\|Manu Sporny]]<br/>

	This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.		This HOW-TO provides a step-by-step tutorial in the process of creating a new Microformat from beginning to end.

ManuSporny: /* Step 2: Gather Examples, Similar Projects and Documenting Current Behavior */

2007-08-08T05:04:33Z

Step 2: Gather Examples, Similar Projects and Documenting Current Behavior

← Older revision		Revision as of 05:04, 8 August 2007
Line 26:		Line 26:
	If several people on the microformats-new mailing list have stated that they are interested in working on your problem statement, and gather examples. You should also note every file format		If several people on the microformats-new mailing list have stated that they are interested in working on your problem statement, and gather examples. You should also note every file format

	# '''Gather example URLs''' - [[#Logic:~~_Why_Do_We_Gather_Examples~~\|Explain the logic...]]		# '''Gather example URLs''' - [[#Logic:_Gathering_Examples_First\|Explain the logic...]]
	## Example URLs that contain publishing behavior should be gathered. For example, if you are attempting to come up with a new image metadata microformat, you would collect website URLs that publish image metadata (such as [http://www.flickr.com/ Flickr]).		## Example URLs that contain publishing behavior should be gathered. For example, if you are attempting to come up with a new image metadata microformat, you would collect website URLs that publish image metadata (such as [http://www.flickr.com/ Flickr]).
	# '''Gather example file and markup formats'''		# '''Gather example file and markup formats'''

ManuSporny: /* Logic: Gathering Examples */

2007-08-08T05:04:02Z

Logic: Gathering Examples

← Older revision		Revision as of 05:04, 8 August 2007
Line 127:		Line 127:
	Once you've found your 'problem,' ask yourself: 'is there a simpler problem here?' If so, let's solve that problem first. We want to deal with the simplest problems first and only then build up to more complex problems.		Once you've found your 'problem,' ask yourself: 'is there a simpler problem here?' If so, let's solve that problem first. We want to deal with the simplest problems first and only then build up to more complex problems.

	== Logic: Gathering Examples ==		== Logic: Gathering Examples First ==

	~~Why do we gather examples first?~~

	Remember, we're paving the cowpaths (http://ifindkarma.typepad.com/relax/2004/12/microformats.html)- before you do that you have to find the cowpaths. Your examples should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat. From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.		Remember, we're paving the cowpaths (http://ifindkarma.typepad.com/relax/2004/12/microformats.html)- before you do that you have to find the cowpaths. Your examples should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat. From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.

ManuSporny: /* Step 2: Gather Examples, Similar Projects and Documenting Current Behavior */

2007-08-08T05:03:25Z

Step 2: Gather Examples, Similar Projects and Documenting Current Behavior

← Older revision		Revision as of 05:03, 8 August 2007
Line 26:		Line 26:
	If several people on the microformats-new mailing list have stated that they are interested in working on your problem statement, and gather examples. You should also note every file format		If several people on the microformats-new mailing list have stated that they are interested in working on your problem statement, and gather examples. You should also note every file format

	# '''Gather example URLs'''		# '''Gather example URLs''' - [[#Logic:_Why_Do_We_Gather_Examples\|Explain the logic...]]
	## Example URLs that contain publishing behavior should be gathered. For example, if you are attempting to come up with a new image metadata microformat, you would collect website URLs that publish image metadata (such as [http://www.flickr.com/ Flickr]).		## Example URLs that contain publishing behavior should be gathered. For example, if you are attempting to come up with a new image metadata microformat, you would collect website URLs that publish image metadata (such as [http://www.flickr.com/ Flickr]).
	# '''Gather example file and markup formats'''		# '''Gather example file and markup formats'''

ManuSporny: /* Step 0: Before You Start */

2007-08-08T05:01:15Z

Step 0: Before You Start

← Older revision		Revision as of 05:01, 8 August 2007
Line 6:		Line 6:
	== Step 0: Before You Start ==		== Step 0: Before You Start ==

	# '''Educate Yourself About How This Community Operates'''		# '''Educate Yourself About How This Community Operates''' - [[#Logic:_Educating_Yourself_Before_Proposing_a_Microformat\|Explain the logic...]]
	## You can't create a Microformat until you understand some of the basics. [[introduction\|Understanding what microformats are]] is the first step. [[Main_Page#Drafts\|Understanding what kinds of Microformats exist]] is the second step. Finally, understanding the [[process\|microformats process]] is very important~~. [[#Logic:_Educating_Yourself_Before_Proposing_a_Microformat\|Learn more about the logic behind this suggestion]]~~.		## You can't create a Microformat until you understand some of the basics. [[introduction\|Understanding what microformats are]] is the first step. [[Main_Page#Drafts\|Understanding what kinds of Microformats exist]] is the second step. Finally, understanding the [[process\|microformats process]] is very important.
	# '''POSH-ify your website'''		# '''POSH-ify your website'''
	## Making your website more [[POSH]] is important to understanding web semantics.		## Making your website more [[POSH]] is important to understanding web semantics.

ManuSporny: /* Step 6: Gather Feedback on First Draft */

2007-08-08T04:59:19Z

Step 6: Gather Feedback on First Draft

← Older revision		Revision as of 04:59, 8 August 2007
Line 84:		Line 84:
	== Step 6: Gather Feedback on First Draft ==		== Step 6: Gather Feedback on First Draft ==

			Once you have finished the first draft, propose the draft to the microformats-new mailing list. There will be a great deal of discussion related to naming of classes, how the data should be represented, and if the microformat should exist at all. Be patient and logically discuss each point raised on the mailing list - be sure to be nice when doing so! Remember, most of the people on the list don't know as much about your Microformat as you do.

			# '''Create an Issues Page'''
			## You should create an issues page at this point so you can document and track issues that arise during this step in the process. The issues page will also let anybody add their concerns with the microformat without having to e-mail the list.
			# '''Discuss Each Issue Until it is Resolved'''
			## Discuss each issue in detail and attempt to come to a resolution. Be pro-active in diffusing flame-wars before they start. If you allow a flame-war to start during discussion, it will delay acceptance of your first draft.
			# '''Update the First Draft'''
			## Once each issue is resolved, update the first draft to reflect the resolution.

	== Step 7: Iterate Refine ==		== Step 7: Iterate Refine ==