PKB Data Format - hamstar/Braincase GitHub Wiki

As discussed in #80

This has been classed as over kill by James

Requirements

Unicode to allow the use of arabic and chinese characters
Binary data is not stored

Example

<pkb>
  <academic>
    <username>Joe</username>
    <id>2</id>
    <repository>
      <uri>[email protected]:joe.git</uri>
    </repository>
  </academic>
  <page>
    <title>Page Title</title>
    <id>51</id>
    <owner>
      <username>Joe</username>
      <id>2</id>
    </owner>
    <access>private</access>
    <revision>
      <id>319</id>
      <timestamp>2011-10-22T19:16:11Z</timestamp>
      <contributor>
        <username>Joe</username>
        <id>2</id>
      </contributor>
      <text xml:space="preserve">
        Page Content
      </text>
    </revision>
    <revision>...</revision>
    <revision>...</revision>
  </page>
  <page>...</page>
  <page>...</page>
</pkb>

Legend

pkb

The root node that holds all the information.

pkb.academic

The node that contains information about the academic that this export belongs to.

pkb.page

A page node, contains all the information about a certain page

pkb.page.access

Sets the access level of the page as one of:

private
public ro
public rw