How to document a PROV example

From Provenance WG Wiki
Revision as of 21:42, 3 March 2012 by Tlebo (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Step 1: determine your example number

Go to http://dvcs.w3.org/hg/prov/file/tip/examples/ and find the largest example number. Add one to that and you have your example number.

For example, if this was the listing:

drwxr-xr-x 			[up] 	 
drwxr-xr-x 			eg-1-asn-stub 	files
drwxr-xr-x 			eg-2-rdf-stub 	files
drwxr-xr-x 			eg-3-xml-stub document 	files
drwxr-xr-x 			eg-4-json-stub document 	files
drwxr-xr-x 			eg-5-self-portrait 	files
drwxr-xr-x 			eg-6-pcurl-py 	files
drwxr-xr-x 			eg-7-magetab2rdf document 	files
drwxr-xr-x 			eg-8-datafaqs-faqt-brick document 	files
drwxr-xr-x 			eg-9-provrdf-owl-coverage 	files

yours would be "10".

Step 2: reserve your example number

You need to clone the Mercurial repository so that you can add to it:

cd ~/Desktop
hg clone https://dvcs.w3.org/hg/prov
cd prov/examples
mkdir -p eg-10/document

if you want to give your example a title, use:

mkdir eg-10-my-super-title

Step 3: add the files of your examples

Follow the PROV examples - directory conventions

Step 4: commit your files to the repository

cd ~/Desktop
hg clone https://dvcs.w3.org/hg/prov
cd prov/examples
hg add eg-10
hg commit -m 'added eg 10' eg-10
hg push

They will show up at http://dvcs.w3.org/hg/prov/file/tip/examples/

Step 5: make your wiki page

Search "eg-10" at http://www.w3.org/2011/prov/wiki/Main_Page and click the red "eg-10" to create the page.

Paste this into your page and save:

 {{PROV example}}

 [[Category:PROV example]]

What to say

  • 1) identify the problem
  • 2) the use of provenance
  • 3) the PROV example
  • 4) how PROV is accessed and queried?

1 to 1 1/2 pages per each example.