Browse Source

fix article schema (html5) and replace obsolete anchors (html4) with ids

5HT 5 years ago
parent
commit
9792c590d4
6 changed files with 168 additions and 160 deletions
  1. 30 27
      man/kvs.htm
  2. 5 2
      man/kvs_fs.htm
  3. 1 1
      man/kvs_mnesia.htm
  4. 12 12
      man/kvs_rocks.htm
  5. 33 22
      man/kvs_st.htm
  6. 87 96
      man/kvs_stream.htm

+ 30 - 27
man/kvs.htm

@@ -17,9 +17,11 @@
     </div>
     </div>
   </div>
   </div>
 </nav><header>
 </nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>KVS</h1>
     <h1>KVS</h1>
-</header><main>
+</header>
+<main>
+  <article>
     <section>
     <section>
 
 
 <h3>INTRO</h3>
 <h3>INTRO</h3>
@@ -44,14 +46,14 @@
     </section>
     </section>
     <section>
     <section>
         <h3>API</h3>
         <h3>API</h3>
-        <a name="put"></a><p>Data operations.</p>
-        <h4>put(tuple()) -> ok | {error,any()}.</h4>
-        <a name="get"></a><p>Stores the record.</p>
-        <h4>get(atom(),any()) -> {ok,any()} | {error, not_found | duplicated }.</h4>
-        <a name="delete"></a><p>Retrieves the record.</p>
-        <h4>delete(atom(),any()) -> ok | {error,any()}.</h4>
-        <a name="index"></a><p>Deletes the data record.</p>
-        <h4>index(atom(),any(),any()) -> list(tuple()).</h4>
+        <p>Data operations.</p>
+        <h4 id="put">put(tuple()) -> ok | {error,any()}.</h4>
+        <p>Stores the record.</p>
+        <h4 id="get">get(atom(),any()) -> {ok,any()} | {error, not_found | duplicated }.</h4>
+        <p>Retrieves the record.</p>
+        <h4 id="delete">delete(atom(),any()) -> ok | {error,any()}.</h4>
+        <p>Deletes the data record.</p>
+        <h4 id="index">index(atom(),any(),any()) -> list(tuple()).</h4>
         <p>Searches the record by an indexed field and a given value.</p>
         <p>Searches the record by an indexed field and a given value.</p>
     </section>
     </section>
     <section>
     <section>
@@ -61,12 +63,12 @@
            Sequences are used to generate unique names for records per distributed table.
            Sequences are used to generate unique names for records per distributed table.
            If names in the table are not unique, e.g.
            If names in the table are not unique, e.g.
            then count function may return a different value than the current sequence.</p>
            then count function may return a different value than the current sequence.</p>
-        <a name="seq"></a><figure><code> -record(id_seq, { thing = atom(),
+        <figure><code> -record(id_seq, { thing = atom(),
                     id    = 0 :: integer() } ).</code></figure>
                     id    = 0 :: integer() } ).</code></figure>
 
 
-        <h4>seq(atom(), integer()) -> integer().</h4>
-        <a name="count"></a><p>Increments and returns id counter for the particular table.</p>
-        <h4>count(atom()) -> integer().</h4>
+        <h4 id="seq">seq(atom(), integer()) -> integer().</h4>
+        <p>Increments and returns id counter for the particular table.</p>
+        <h4 id="count">count(atom()) -> integer().</h4>
         <p>Returns number of records in table.</p>
         <p>Returns number of records in table.</p>
     </section>
     </section>
     <section>
     <section>
@@ -74,24 +76,25 @@
         <p>In <b>sys.config</b> you can specify main kvs backend module as <b>dba</b> parameter
         <p>In <b>sys.config</b> you can specify main kvs backend module as <b>dba</b> parameter
            and list of modules containing <b>metainfo/0</b> exported function. For the
            and list of modules containing <b>metainfo/0</b> exported function. For the
            stream operations you can specify the stream kvs backend module <b>dba_st</b> parameter.</p>
            stream operations you can specify the stream kvs backend module <b>dba_st</b> parameter.</p>
-        <a name="dir"></a><figure><code> [{kvs, [{dba,store_mnesia},
+        <figure><code> [{kvs, [{dba,store_mnesia},
           {dba_st,store_stream},
           {dba_st,store_stream},
           {schema,[kvs,kvs_stream]}]}].</code></figure>
           {schema,[kvs,kvs_stream]}]}].</code></figure>
-        <h4>dir() -> list({'table',atom()}).</h4>
+        <h4 id="dir">dir() -> list({'table',atom()}).</h4>
         <p>Returns actual tables.</p>
         <p>Returns actual tables.</p>
     </section>
     </section>
     <section>
     <section>
 
 
-<p>This module may refer to:
-<a href="kvs_fs.htm">kvs_fs</a>,
-<a href="kvs_mnesia.htm">kvs_mnesia</a>,
-<a href="kvs_rocks.htm">kvs_rocks</a>,
-<a href="kvs_st.htm">kvs_st</a>,
-<a href="kvs_stream.htm">kvs_stream</a>.
-</p>
+	<p>This module may refer to:
+	<a href="kvs_fs.htm">kvs_fs</a>,
+	<a href="kvs_mnesia.htm">kvs_mnesia</a>,
+	<a href="kvs_rocks.htm">kvs_rocks</a>,
+	<a href="kvs_st.htm">kvs_st</a>,
+	<a href="kvs_stream.htm">kvs_stream</a>.
+	</p>
     </section>
     </section>
-</main><footer>
-    2005—2019 © Synrc Research Center
-</footer>
+  </article>
+</main>
+<footer>2005—2019 © Synrc Research Center</footer>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
-</body></html>
+</body>
+</html>

+ 5 - 2
man/kvs_fs.htm

@@ -17,9 +17,11 @@
     </div>
     </div>
   </div>
   </div>
 </nav><header>
 </nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>FS</h1>
     <h1>FS</h1>
-</header><main>
+</header>
+<main>
+  <article>
    <section>
    <section>
    <h3>INTRO</h3>
    <h3>INTRO</h3>
    <p>FS is a <b>filesystem</b> backend implementation for KVS.
    <p>FS is a <b>filesystem</b> backend implementation for KVS.
@@ -32,6 +34,7 @@
 </p>
 </p>
 
 
     </section>
     </section>
+  </article>
 </main><footer>
 </main><footer>
     2005—2019 © Synrc Research Center
     2005—2019 © Synrc Research Center
 </footer>
 </footer>

+ 1 - 1
man/kvs_mnesia.htm

@@ -18,7 +18,7 @@
     </div>
     </div>
   </div>
   </div>
 </nav><header>
 </nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>MNESIA</h1>
     <h1>MNESIA</h1>
 </header><main>
 </header><main>
    <article>
    <article>

+ 12 - 12
man/kvs_rocks.htm

@@ -15,9 +15,10 @@
     </div>
     </div>
   </div>
   </div>
 </nav><header>
 </nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>ROCKS</h1>
     <h1>ROCKS</h1>
-</header><main>
+</header>
+<main>
    <article>
    <article>
    <section>
    <section>
    <h3>INTRO</h3>
    <h3>INTRO</h3>
@@ -27,16 +28,15 @@
    <br />
    <br />
    </section>
    </section>
     <section>
     <section>
-<p>This module may refer to:
-<a href="kvs_st.htm"><b>kvs_st</b></a>,
-<a href="kvs_stream.htm"><b>kvs_stream</b></a>,
-<a href="kvs.htm"><b>kvs</b></a>.
-</p>
-
+	<p>This module may refer to:
+	<a href="kvs_st.htm"><b>kvs_st</b></a>,
+	<a href="kvs_stream.htm"><b>kvs_stream</b></a>,
+	<a href="kvs.htm"><b>kvs</b></a>.
+	</p>
     </section>
     </section>
    </article>
    </article>
-</main><footer>
-    2005—2019 © Synrc Research Center
-</footer>
+</main>
+<footer>2005—2019 © Synrc Research Center</footer>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
-</body></html>
+</body>
+</html>

+ 33 - 22
man/kvs_st.htm

@@ -1,39 +1,50 @@
-<!DOCTYPE html><html><head><meta charset="utf-8" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="" />
-<meta name="author" content="Maxim Sokhatsky" /><title>ST</title>
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+<meta name="description" content="" />
+<meta name="author" content="Maxim Sokhatsky" />
+<title>ST</title>
 <link rel="stylesheet" href="https://n2o.dev/blank.css" />
 <link rel="stylesheet" href="https://n2o.dev/blank.css" />
 <link rel="stylesheet" href="https://n2o.dev/zima.css" />
 <link rel="stylesheet" href="https://n2o.dev/zima.css" />
-</head><body><nav>
+</head>
+<body>
+<nav>
     <a href="https://n2o.dev">DEV</a>
     <a href="https://n2o.dev">DEV</a>
     <a href="https://kvs.n2o.dev">KVS</a>
     <a href="https://kvs.n2o.dev">KVS</a>
     <a href="#" style="background:#ededed;">ST</a>
     <a href="#" style="background:#ededed;">ST</a>
-  <div class="dropdown">
+    <div class="dropdown">
     <a onclick="drop()" class="dropbtn">EN</a>
     <a onclick="drop()" class="dropbtn">EN</a>
     <div id="dropdown" class="dropdown-content">
     <div id="dropdown" class="dropdown-content">
       <a href="https://n2o.dev/deps/kvs/man/ua/kvs_st.htm">UA</a>
       <a href="https://n2o.dev/deps/kvs/man/ua/kvs_st.htm">UA</a>
       <a href="#">EN</a>
       <a href="#">EN</a>
     </div>
     </div>
   </div>
   </div>
-</nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+</nav>
+<header>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>ST</h1>
     <h1>ST</h1>
-</header><main>
+</header>
+<main>
+  <article>
     <section>
     <section>
-
-<h3>INTRO</h3>
-
-<p>The ST module provides STREAM interface for ROCKS backend.
-   Set the {dba,kvs_rocks} along with {dba_st,kvs_st} in order to use ST module for stream operations.</p>
+	<h3>INTRO</h3>
+	<p>The ST module provides STREAM interface for ROCKS backend.
+	   Set the {dba,kvs_rocks} along with {dba_st,kvs_st} in
+           order to use ST module for stream operations.</p>
     </section>
     </section>
     <section>
     <section>
-<p>This module may refer to:
-<a href="kvs_stream.htm"><b>kvs_stream</b></a>,
-<a href="kvs_rocks.htm"><b>kvs_rocks</b></a>,
-<a href="kvs.htm"><b>kvs</b></a>.
-</p>
+	<p>This module may refer to:
+	<a href="kvs_stream.htm"><b>kvs_stream</b></a>,
+	<a href="kvs_rocks.htm"><b>kvs_rocks</b></a>,
+	<a href="kvs.htm"><b>kvs</b></a>.
+	</p>
     </section>
     </section>
-</main><footer>
-    2005—2019 © Synrc Research Center
-</footer>
+  </article>
+</main>
+<footer>2005—2019 © Synrc Research Center</footer>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
-</body></html>
+</body>
+</html>

+ 87 - 96
man/kvs_stream.htm

@@ -16,138 +16,129 @@
     </div>
     </div>
   </div>
   </div>
 </nav><header>
 </nav><header>
-    <a href="../index.html"><img src="https://n2o.dev/img/Synrc Neo.svg" /></a>
+    <a href="../index.html"><img src="https://n2o.dev/img/synrc.svg" /></a>
     <h1>STREAM</h1>
     <h1>STREAM</h1>
-</header><main>
+</header>
+<main>
+  <article>
     <section>
     <section>
-
-<h3>INTRO</h3>
-
-<p>The STREAM module provides chain accumulation, traversal and persistence.
-   </p>
-
-        <p></p><blockquote><p></p><ul><li><b><a href="#writer">writer/1</a></b> — creates writer cursor to db.</li><li><b><a href="#reader">reader/1</a></b> — creates reader cursor to db.</li><li><b><a href="#save">save/1</a></b> — stores cursor to db.</li><li><b><a href="#load">load_reader/1</a></b> — loads reader cursor.</li><li><b><a href="#load">load_writer/1</a></b> — loads writer cursor.</li><li><b><a href="#top">top/1</a></b> — returns top of the chain.</li><li><b><a href="#bot">bot/1</a></b> — returns bottom of the chain.</li><li><b><a href="#next">next/1</a></b> — moves reader next.</li><li><b><a href="#prev">prev/1</a></b> — moves reader prev.</li><li><b><a href="#take">take/1</a></b> — takes N elements from reader.</li><li><b><a href="#drop">drop/1</a></b> — skips N elements from reader.</li><li><b><a href="#add">add/1</a></b> — adds element to list.</li><li><b><a href="#append">append/2</a></b> — adds element to feed.</li><li><b><a href="#append">cut/2</a></b> — cleanup feed by a given timestamp.</li></ul></blockquote>
-
-    <p>
-      You can grab <a style="margin-bottom:30px;" href="https://raw.githubusercontent.com/synrc/kvs/master/src/kvs_stream.erl">kvs_stream</a>
-      and use it in your applications without importing <b>synrc/kvs</b> dependency,
-      as this module is self-containing.
-      The possible applications are: public and private feeds, FIFO queues,
-   unread messages, chat applications, blockchain etc.<br /><br />
-    </p></section>
+	<h3>INTRO</h3>
+	<p>The STREAM module provides chain accumulation, traversal and persistence.</p>
+        <blockquote>
+          <ul><li><b><a href="#writer">writer/1</a></b> — creates writer cursor to db.</li>
+              <li><b><a href="#reader">reader/1</a></b> — creates reader cursor to db.</li>
+              <li><b><a href="#save">save/1</a></b> — stores cursor to db.</li>
+              <li><b><a href="#load_reader">load_reader/1</a></b> — loads reader cursor.</li>
+              <li><b><a href="#load_writer">load_writer/1</a></b> — loads writer cursor.</li>
+              <li><b><a href="#top">top/1</a></b> — returns top of the chain.</li>
+              <li><b><a href="#bot">bot/1</a></b> — returns bottom of the chain.</li>
+              <li><b><a href="#next">next/1</a></b> — moves reader next.</li>
+              <li><b><a href="#prev">prev/1</a></b> — moves reader prev.</li>
+              <li><b><a href="#take">take/1</a></b> — takes N elements from reader.</li>
+              <li><b><a href="#drop">drop/1</a></b> — skips N elements from reader.</li>
+              <li><b><a href="#add">add/1</a></b> — adds element to list.</li>
+              <li><b><a href="#append">append/2</a></b> — adds element to feed.</li>
+              <li><b><a href="#cut">cut/2</a></b> — cleanup feed by a given timestamp.</li>
+          </ul></blockquote>
+
+	<p>You can grab <a style="margin-bottom:30px;" href="https://raw.githubusercontent.com/synrc/kvs/master/src/kvs_stream.erl">kvs_stream</a>
+	   and use it in your applications without importing <b>synrc/kvs</b> dependency,
+	   as this module is self-containing.
+	   The possible applications are: public and private feeds, FIFO queues,
+	   unread messages, chat applications, blockchain etc.<br /><br /></p>
+    </section>
     <section>
     <section>
+	<h3>WRITER</h3>
 
 
-<h3>WRITER</h3>
-
-<p>Writer cursor represents append list chain with some cached values.
-   E.g., chain size, first element of the chain, cached value of
-   previous written message and field for passing arguments for stream functions, like add.</p>
+	<p>Writer cursor represents append list chain with some cached values.
+	   E.g., chain size, first element of the chain, cached value of
+	   previous written message and field for passing arguments for stream functions, like add.</p>
 
 
-<figure><code>
-  -record(writer, { id    = [] :: term(),
+	<figure><code>  -record(writer, { id    = [] :: term(),
                     count =  0 :: integer(),
                     count =  0 :: integer(),
                     cache = [] :: [] | tuple(),
                     cache = [] :: [] | tuple(),
                     args  = [] :: term(),
                     args  = [] :: term(),
-                    first = [] :: [] | tuple() } ).
-
-</code></figure>
+                    first = [] :: [] | tuple() } ).</code></figure>
+	<p>For adding data to database you need first create writer cursor,
+	   set the args field with record from metainfo and call save function.</p>
 
 
-<p>For adding data to database you need first create writer cursor,
-   set the args field with record from metainfo and call save function.</p>
+	<h4 id="writer">writer(term()) -> #writer{}.</h4>
+	<p>Creates writer cursor.</p>
 
 
-<h4>writer(term()) -> #writer{}.</h4>
+	<h4 id="add">add(#writer{}) -> #writer{}.</h4>
+	<p>Adds element to list declared by writer cursor.</p>
 
 
-<p>Creates writer cursor.</p>
+	<h4 id="append">append(tuple(), list()) -> term().</h4>
+	<p>Adds record to feed.</p>
 
 
-<h4>add(#writer{}) -> #writer{}.</h4>
+	<h4 id="cut">cut(list(), term()) -> #ok{} | #error{}.</h4>
+	<p>Adds record to feed.</p>
 
 
-<p>Adds element to list declared by writer cursor.</p>
+	<h4 id="load_writer">load_writer(#writer{}) -> #writer{}.</h4>
+	<p>Loads writer cursor.</p>
 
 
-<h4>load_writer(#writer{}) -> #writer{}.</h4>
-
-<p>Loads writer cursor.</p>
-
-<h4>save(#writer{}) -> #writer{}.</h4>
-
-<p>Flushes writer cursor to database.</p>
+	<h4 id="save">save(#writer{}) -> #writer{}.</h4>
+	<p>Flushes writer cursor to database.</p>
 
 
     </section>
     </section>
     <section>
     <section>
 
 
-<h3>READER</h3>
-
-<figure><figcaption>Reader Cursor</figcaption><code>
-  -record(reader, { id    = [] :: integer(),
+	<h3>READER</h3>
+	<figure><figcaption>Reader Cursor</figcaption>
+	<code>  -record(reader, { id    = [] :: integer(),
                     pos   =  0 :: [] | integer(),
                     pos   =  0 :: [] | integer(),
                     cache = [] :: [] | integer(),
                     cache = [] :: [] | integer(),
                     args  = [] :: term(),
                     args  = [] :: term(),
                     feed  = [] :: term(),
                     feed  = [] :: term(),
-                    dir   =  0 :: 0 | 1 } ).
-
-</code></figure>
-
-<h4>reader(integer()) -> #reader{}.</h4>
-
-<p>Creates reader cursor.</p>
+                    dir   =  0 :: 0 | 1 } ).</code></figure>
 
 
-<h4>load_reader(#reader{}) -> #reader{}.</h4>
+	<h4 id="reader">reader(integer()) -> #reader{}.</h4>
+	<p>Creates reader cursor.</p>
 
 
-<p>Loads reader cursor from database.</p>
+	<h4 id="load_reader">load_reader(#reader{}) -> #reader{}.</h4>
+	<p>Loads reader cursor from database.</p>
 
 
-<h4>save(#reader{}) -> #reader{}.</h4>
+	<h4 id="save">save(#reader{}) -> #reader{}.</h4>
+	<p>Flushes reader cursor to database.</p>
 
 
-<p>Flushes cursor to database.</p>
-
-<h4>top(#reader{}) -> #reader{}.</h4>
-
-<p>Moves cursor to top of the list.</p>
-
-<h4>bot(#reader{}) -> #reader{}.</h4>
-
-<p>Moves cursor to bottom of the list.</p>
+	<h4 id="top">top(#reader{}) -> #reader{}.</h4>
+	<p>Moves cursor to top of the list.</p>
 
 
+	<h4 id="bot">bot(#reader{}) -> #reader{}.</h4>
+	<p>Moves cursor to bottom of the list.</p>
     </section>
     </section>
     <section>
     <section>
-
-<h3>ITER</h3>
-
-<figure><figcaption>KVS Stream Iterator</figcaption><code>
-  -record(iter,   { id    = [] :: [] | integer(),
+	<h3>ITER</h3>
+	<figure><figcaption>KVS Stream Iterator</figcaption>
+	<code>  -record(iter,   { id    = [] :: [] | integer(),
                     next  = [] :: [] | integer(),
                     next  = [] :: [] | integer(),
-                    prev  = [] :: [] | integer() } ).
-
-</code></figure>
+                    prev  = [] :: [] | integer() } ).</code></figure>
 
 
-<h4>next(#reader{}) -> #reader{}.</h4>
+	<h4 id="next">next(#reader{}) -> #reader{}.</h4>
+	<p>Moves cursor to next. Consume data down from top.
+	   Return error if list is empty, otherwise next element or last.</p>
 
 
-<p>Moves cursor to next. Consume data down from top.
-   Return error if list is empty, otherwise next element or last.</p>
+	<h4 id="prev">prev(#reader{}) -> #reader{}.</h4>
+	<p>Moves cursor to prev. Consume data up from bottom.
+	   Return error if list is empty, otherwise next element or last.</p>
 
 
-<h4>prev(#reader{}) -> #reader{}.</h4>
+	<h4 id="drop">drop(#reader{}) -> #reader{}.</h4>
+	<p>Drops N elements starting from reader.</p>
 
 
-<p>Moves cursor to prev. Consume data up from bottom.
-   Return error if list is empty, otherwise next element or last.</p>
-
-<h4>drop(#reader{}) -> #reader{}.</h4>
-
-<p>Drops N elements starting from reader.</p>
-
-<h4>take(#reader{}) -> #reader{}.</h4>
-
-<p>Trying to consume N records from stream using its current value and direction.
-   Returns consumed data. Usually you seek to some position and then consume some data.</p>
+	<h4 id="take">take(#reader{}) -> #reader{}.</h4>
+	<p>Trying to consume N records from stream using its current value and direction.
+	   Returns consumed data. Usually you seek to some position and then consume some data.</p>
 
 
     </section>
     </section>
     <section>
     <section>
-
-<p>This module may refer to:
-<a href="kvs.htm"><b>kvs</b></a>,
-<a href="kvs_st.htm"><b>kvs_st</b></a>.
-</p>
-
+	<p>This module may refer to:
+	<a href="kvs.htm"><b>kvs</b></a>,
+	<a href="kvs_st.htm"><b>kvs_st</b></a>.
+	</p>
     </section>
     </section>
-</main><footer>
-    2005—2019 © Synrc Research Center
-</footer>
+  </article>
+</main>
+<footer>2005—2019 © Synrc Research Center</footer>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
 <script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
-</body></html>
+</body>
+</html>