c279108f by Kyle Greenwell

edited README.md

1 parent bf642242
Showing 1 changed file with 10 additions and 5 deletions
1 # XID specification repository #
2
1 This is a public repo containing published XID (Xtensible Interface Definition) specifications. Files on the master branch are published specs. 3 This is a public repo containing published XID (Xtensible Interface Definition) specifications. Files on the master branch are published specs.
2 4
3 * Naming conventions 5
6 ----------
7
8 ## Naming conventions ##
4 9
5 Besides XID specs written in XML, there is a new concept of Concrete Interface Definitions (CID). These are complete specifications (no imports) that will have their own schema. XID and CID files can be written in XML, JSON, or XMF (if you are really the hardcore type person), XID CG should be able to input or output in these formats. Given that, the filename convention will be : 10 Besides XID specs written in XML, there is a new concept of Concrete Interface Definitions (CID). These are complete specifications (no imports) that will have their own schema. XID and CID files can be written in XML, JSON, or XMF (if you are really the hardcore type person), XID CG should be able to input or output in these formats. Given that, the filename convention will be :
6 11
7 [filename].[xid|cid].[xml|json|xmf] 12 **[filename].[xid|cid].[xml|json|xmf]**
8 13
9 Specifications stored in the published repo may have a packaging structure that is independent of namespace (not really recommended though), thus path reference to a definition would be : 14 Specifications stored in the published repo may have a packaging structure that is independent of namespace (not really recommended though), thus path reference to a definition would be :
10 15
11 {[dir1]{/[dir2]…{/dirN}}}/[version]/ [filename].[xid|cid].[xml|json|xmf] 16 **{[dir1]{/[dir2]…{/dirN}}}/[version]/[filename].[xid|cid].[xml|json|xmf]**
12 17
13 XSD Schemas for the XID/CID should be stored separately and versioned consistently with the pattern : 18 XSD Schemas for the XID/CID should be stored separately and versioned consistently with the pattern :
14 19
15 /schema/[version]/[specification].xsd 20 **/schema/[version]/[specification].xsd**
16 21
17 * Process 22 ## Process ##
18 23
19 Update access to the master branch will be limited. Updates and new XID specs must be added on branches and merged to master via pull requests. Updates to existing XID specification (other than typo and documentation updates), will require updating the version directory. 24 Update access to the master branch will be limited. Updates and new XID specs must be added on branches and merged to master via pull requests. Updates to existing XID specification (other than typo and documentation updates), will require updating the version directory.
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!