relpipe-data/specification.xml
branchv_0
changeset 156 2be00f14dc78
parent 154 aec6545b2350
child 157 65b71e6a0973
--- a/relpipe-data/specification.xml	Thu Nov 29 22:36:50 2018 +0100
+++ b/relpipe-data/specification.xml	Fri Nov 30 16:43:11 2018 +0100
@@ -14,7 +14,11 @@
 			that independent implementation of the format will be possible.
 		</p>
 		
-		<h2>Stream structure structure</h2>
+		<h2>
+			<m:name/> data format
+		</h2>
+			
+		<h3>Stream structure structure</h3>
 		
 		
 		<m:tabulka>
@@ -24,7 +28,7 @@
 		</m:tabulka>
 		
 		
-		<h2>Data types</h2>
+		<h3>Data types</h3>
 		
 		<p>Currently, there are only three data types.</p>
 		
@@ -35,6 +39,28 @@
 			0x03	string	character string in UTF-8
 		</m:tabulka>
 		
+		<h2>Libraries</h2>
+		
+		<h3>relpipe-lib-writer</h3>
+		
+		<p>Wraps an output stream (usually STDOUT), accepts method calls (relations, attributes) and generates <m:name/> data on the stream.</p>
+		
+		<h3>relpipe-lib-reader</h3>
+		
+		<p>
+			Wraps an input stream (usually STDIN). The caller creates and sets handlers (zero or more) using <code>addHandler()</code> and then calls <code>process()</code> method.
+			During this method call, the reader reads the input and calls the handlers.
+			Handlers receive relations and attributes.
+		</p>
+		
+		<h2>Tools</h2>
+		
+		<h3>relpipe-in-cli</h3>
+		<h3>relpipe-in-fstab</h3>
+		<h3>relpipe-out-tabular</h3>
+		<h3>relpipe-out-xml</h3>
+		<h3>relpipe-out-qui</h3>
+		
 	</text>
 
 </stránka>