Getting Started with Doxml

Keyboard Shortcuts

  • Ctrl+E or F2 - Edit current page
  • Ctrl+I or F3 - Edit index file

Doxml Book Layout

Doxml book consists of chapters and articles organized using the following structure.

Book1/
|
├── Chapter X/
│   ├── Article X-1.xml
│   ├── Article X-2.xml
│   └── Article X-3.xml
|
├── Chapter Y/
│   ├── Article Y-1.xml
│   ├── Article Y-2.xml
│   └── Article Y-3.xml
│
└── _index.xml

Index file

Index file _index.xml contains information about the book such as security information and book contents. This information is used to display the navigation you can see on the left side (if not hidden).

<?xml version="1.0" encoding="utf-8" ?>
<book xmlns="http://codaxy.com/Doxml.xsd">
  <title>Sample Book</title>
  <access>
     <owner>[email protected]</owner>
  </access>
  <contents>
    <section title="Introduction">
      <topic>About</topic>
      <topic>Getting Started</topic>          
    </chapter>
    <section title="Chapter I">
      <topic title="Article I" path="Article1"/>
    </section>
  </contents>
</book>

Doxml Article Sample

This is how a typical Doxml article file looks like.

<?xml version="1.0" encoding="utf-8" ?>
<document xmlns="http://codaxy.com/Doxml.xsd">
  <meta>
    <title>Doxml Article</title>
  </meta>
  <content>
    <h1>Doxml Article</h1>
    <p>
       Article content... 
    </p>
    <snippet>
      Code snippet...
    </snippet>
  </content>
</document>