Skip to content

Quickstart

A simple klartext document

klartext documents are plain text files. The following example shows a very simple klartext document:

Simple klartext document
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
process: #SD.2 name="Software Development Planning"

    purpose:
        The _objective_ of the "Software Development Planning" process 
        is to plan the software development tasks, communicate procedures 
        and goals to members of the development team.

        Systematic software development planning ensures that risks caused 
        by software are reduced and quality characteristics for the medical 
        device software are met.

Note

It is recommended to use the UTF-8 encoding for klartext files.

Semantically, this klartext file is equivalent to the following XML structure:

Equivalent XML file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
<process name="Software Development Planning" id="SD.2">

    <purpose>
        <p>
            The <em>objective</em> of the &quot;Software Development Planning&quot; process
            is to plan the software development tasks, communicate procedures
            and goals to members of the development team.
        </p>

        <p>
            Systematic software development planning ensures that risks caused
            by software are reduced and quality characteristics for the medical
            device software are met.
        </p>
    </purpose>

</process>

Parsing klartext files

The klartext library provides a parser that can be used to convert klartext source files to their XML representation.

The following python code is a simple example that shows how to perform the conversion:

import io, klartext

input = io.StringIO("""
process: #SD.2 name="Software Development Planning"

    purpose:
        The _objective_ of the "Software Development Planning" process 
        is to plan the software development tasks, communicate procedures 
        and goals to members of the development team.

        Systematic software development planning ensures that risks caused 
        by software are reduced and quality characteristics for the medical 
        device software are met.
""")

parser = klartext.Parser()

xml = parser.parse(input, convert_text=klartext.Parser.convertMarkdown)

print(xml.decode('UTF-8'))

Running this script will produce the following output:

<process name="Software Development Planning" id="SD.2">
    <purpose>
<p>The <em>objective</em> of the "Software Development Planning" process
is to plan the software development tasks, communicate procedures
and goals to members of the development team.</p>
<p>Systematic software development planning ensures that risks caused
by software are reduced and quality characteristics for the medical
device software are met.</p>
    </purpose>
</process>

Details about the parse function can be found in the API Reference.