README(Resource Shape Documents)
These resource shape documents are draft version of OASIS
OSLC-PROMCODE. All documents are written in Markdown format(*.md
files), RDF+Turtle and HTML (for header) .
Setup
These documents require Pandoc to generate HTML documents from Markdown.
- Install Pandoc to generate HTML from Markdown documents.
Usage
- run ./pandocall.sh to generate HTML files(*.html)
Why Markdown?
It is good for offline editing (rather than editing wiki), and much
better than writing HTML on specific editor. Editing on HTML file
requires patience.
Note
HTML files are automatically generated. Instead of edit them, You
need to edit Markdown and Turtle files. Therefore, markdown files
and Turtle files are strongly recommended to get version controled,
while HTML files are just for reference convenience.The only exception is header.html. This file contains script which
should be contained in generated HTML headers.
Summary
| Modify these files | Run command | Generate these files(should not modify) |
|---|---|---|
shape.md |
./pandocall.sh |
shape.html |
header.html |
./pandocall.sh |
shape.html |
*.ttl |
reload html | re-rendered shape.html |
OASIS OSLC Lifecycle Integration for Project Management of Contracted Delivery (OSLC PROMCODE) TC Wiki