This wiki is locked. Future workgroup activity and specification development must take place at
our new wiki
. For more information, see
this blog post about the new governance model
and
this post about changes to the website
.
TWiki
>
Main Web
>
CmHome
>
CmGuidelinesAndTips
(revision 4) (raw view)
---++ Purpose The intent of this page is to gather various guidelines and tips that the [[Sandbox.CmHome][Change Management domain]] has encountered. %TOC% ---++ Guidelines ---+++ Wiki * Prefix all Change Management pages with "Cm" * Make all "Cm" pages child topics of CmHome ---+++ Resource Definitions In addtion (or amended from) ResourceGuidelines XML based resource definitions: * Use UpperCamelCase for root element names * Use lowerCamelCase for child element names * Use element names that are same and compatible with JSON formats. Avoid characters like "-" and ".". * From Dublin Core Metadata Initiative (DCMI) properties namespace URI - http://purl.org/dc/terms/ (don't use elements) * Namespace definitions include the domain (or common concept) and version. For example, =http://open-services.net/cm/1.0= * Make content [[http://www.w3.org/TR/rdf-syntax-grammar/][RDF/XML]] valid * Don't require roold <RDF> element * MUST provide @rdf:about attribute on root elements * MUST use @rdf:resource attribute for references to resources (instead of @href) * When an element has a value that is a URL, simply put the URL as the element content and do NOT use <rdf:resource>. Examples of this are: CmServiceDiscovery <oscm:url> and ServiceProviderCatalog <osdisc:service> * Provide intermediate type elements (see [[http://www.w3.org/RDF/Validator/direct][validator]]) ---+++ Media Type Usage * Provide a media type per resource definition * When using non- [[http://www.iana.org/assignments/media-types/][IANA]] registered media types prefix with "x-". For example, =application/x-oscm-change-request= * When defining media types for a specific domain, like Change Management, include the "cm" in the media type. For example, =application/x-oscm-service-descriptor+xml= * Use [[http://www.ietf.org/rfc/rfc4627.txt][ =application/json= ]] instead of =text/json= ---+++ URL Parameters * To avoid name conflicts with existing parameters, prefix with "oscm.". For example, "oscm.query". ---+++ Specification Status Indicators Each specification should contain its status in the header (subtitle) of the page using one of the following statuses: * *Early Draft* - early, very rough form of a working draft for a specification * *Working Draft* - content maturing but changes still occuring * *Stabilizing Draft* - most if not all core content has been contributed and only minor updates to stablize * *Final Draft* - cleared IP non-assert and no further changes * *Note* - an informative document with supporting information to specifications ---++ Tips * Beware of TWiki bug of [[http://develop.twiki.org/~twiki4/cgi-bin/view/Bugs/Item6072][empty bullet in Firefox]]
Edit
|
Attach
|
P
rint version
|
H
istory
:
r7
<
r6
<
r5
<
r4
<
r3
|
B
acklinks
|
V
iew topic
|
Raw edit
|
More topic actions...
Topic revision: r4 - 14 Apr 2009 - 20:03:36 -
SteveSpeicher
Main.CmGuidelinesAndTips moved from Sandbox.CmGuidelinesAndTips on 08 Apr 2009 - 19:18 by
SteveSpeicher
-
put it back
Main
Main Web
Create New Topic
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Webs
Main
Sandbox
TWiki
Български
Cesky
Dansk
Deutsch
English
Español
Français
Italiano
日本語
Nederlands
Polski
Português
Русский
Svenska
简体中文
簡體中文
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our
Terms of Use
Ideas, requests, problems regarding this site?
Send feedback