Adjust "Developer" page

Author: Zadamsa

_developer/basic.md

@@ -33,9 +33,10 @@ fields:
     ipfix: "29305/1"
     value:  "number of bytes in data flow (dst to src)"
   - 
-    name: "LINK_BIT_FIELD" 
-    type: "or"
-    value: "ODID  uint64 or uint32  exporter identification"
+    name: "LINK_BIT_FIELD or ODID"  
+    type: "uint64 or uint32"
+    ipfix: "-/-"
+    value:  "exporter identification"
   - 
     name: "TIME_FIRST"  
     type: "time"

developer.html

@@ -2,58 +2,48 @@
 title: Developer info
 heading: Developer info   
 ---
-
-
-{% assign sorted_developers = site.developer | sort: 'title' %}
 <section style="padding:0px; padding-bottom:100px">
   <div class="container"> 
     <div class="blog-post text-container">
 	  <p>The architecture of the ipfixprobe can be described by the following diagram:</p>
 	  <img src="/images/ipfixprobe_architecture.jpg" style = "width: 100%;">
-      <p>Process plugin can export data. Export format of each plugin is described in this section</p>
+	  <h1>Process plugin</h1>
+	  <p>The ipfixprobe contains script that creates template for new process plugin. To use it follow these steps:<br>
       <div class="text editable"  style="display: flex;flex-direction: column;justify-content: center;align-items: left;">
-      {% for export_table in sorted_developers  %} 
-      <hr>
-      <h1 class="clickable" id = "{{export_table.title}}">{{export_table.title}}</h1>
-	  {% assign textId = export_table.title | append: "_text" %}
-      <p id = "{{textId}}" class = "hidden">{{export_table.description}}</p>
-	  {% assign tableId = export_table.title | append: "_table" %}
-      <table id = "{{tableId}}" class = "hidden">
-    <thead>
-    <tr>
-      <th>Output field</th>
-      <th>Type</th>
-      <th>IPFIX Enterprise number/ID</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    {% for row in export_table.fields  %} 
-    <tr>
-      <td>{{row.name}}</td>
-      <td>{{row.type}}</td>
-      <td>{{row.ipfix}}</td>
-      <td>{{row.value}}</td>
-    </tr>
-    {% endfor %}
-  </tbody>
-</table>
-      {% endfor %}
-    </div>
+		<p>Run the script:</p>
+		<span>
+			<p style = "font-family: monospace;">cd process</p>
+			<p style = "font-family: monospace;">./create_plugin.sh</p>
+		</span>
+		<span>
+			<p>To create the process plugin follow these steps:</p>
+			<ol>
+				<li><p>Add <b>plugin_name.hpp</b> and <b>plugin_name.cpp</b> files to ipfixprobe_process_src variable in <b>Makefile.am</b>.</p></li>
+				<li><p>Implement process plugin event functions. Don't forget to remove unused events to keep default implementation.</p></li>
+				<li><p>Set <b>PLUGIN_NAME_UNIREC_TEMPLATE</b> and <b>IPFIX_PLUGIN_NAME_TEMPLATE</b> macros to export Unirec or IPFIX data respectively.</p></li>
+				<li><p>Define Unirec and IPFIX fields to export Unirec or IPFIX respectively.</p></li>
+				<li><p>Implement <b>fill_ipfix</b> and <b>fill_unirec</b>.</p></li>
+				<li><p>Update README.md.</p></li>
+			</ol>
+		</span>
+		<h2>Process plugin events</h2>
+		<p><b>pre_create</b> Is called before the creation of new flow from the initial packet.</p>
+		<p><b>post_create</b> is called after the flow is created, taket newly created flow and initial packet.</p>
+		<p><b>pre_update</b> is called when incoming packet belongs to the existing flow, before the data from the packet are added to the flow.</p>
+		<p><b>post_update</b> is called after the data of the packet are added to the flow.</p>
+		<p><b>pre_export</b> is called right before the flow is exported.</p>
+	  </div>
+	  <h1>Input plugin</h1>
+	  <p>You can also create own input plugin.</p>
+	  <span>
+			<p>To create the input plugin follow these steps:</p>
+			<ol>
+				<li>Create <b>plugin_name.hpp</b> and <b>plugin_name.cpp</b> in the <b>input</b> directory.</li>
+				<li>Add <b>plugin_name.hpp</b> and <b>plugin_name.cpp</b> files to ipfixprobe_input_src variable in <b>Makefile.am</b>.</li>
+				<li>Create a plugin class that inherites from the Input plugin class.</li>
+				<li>Override virtual Plugin class methods (<i>init</i>, <i>close</i>, <i>get_parser</i>, <i>get_name</i>) and Input plugin method to receive new packets(<i>get</i>).</li>
+			</ol>
+		</span>
   </div>
   </div>
-</section>
-
-<script>
-  document.addEventListener("DOMContentLoaded", function () {
-    document.querySelectorAll(".clickable").forEach(function (toggleButton) {
-      const description = document.getElementById(toggleButton.id + "_text");
-      const table = document.getElementById(toggleButton.id + "_table");
-
-      toggleButton.addEventListener("click", function () {
-        description.classList.toggle("hidden");
-        table.classList.toggle("hidden");
-      });
-    });
-  });
-</script>
+</section>