Abandon ancient approach to generating docs

Author: g-andrade

.gitignore

@@ -14,4 +14,3 @@ erl_crash.dump
 logs
 _build
 .idea
-doc/overview.edoc

Makefile

@@ -38,9 +38,17 @@ dialyzer: $(REBAR3)
 xref: $(REBAR3)
 	@$(REBAR3) xref
 
-doc: build
-	./scripts/hackish_inject_version_in_docs.sh
-	./scripts/hackish_make_docs.sh
+doc: $(REBAR3)
+	@$(REBAR3) edoc
+
+README.md: doc
+	# non-portable dirty hack follows (pandoc 2.1.1 used)
+	# gfm: "github-flavoured markdown"
+	@pandoc --from html --to gfm doc/overview-summary.html -o README.md
+	@tail -n +11 <"README.md"   >"README.md_"
+	@head -n -12 <"README.md_"  >"README.md"
+	@tail -n  2  <"README.md_" >>"README.md"
+	@rm "README.md_"
 
 test: $(REBAR3)
 	@$(REBAR3) eunit

README.md

@@ -1,78 +1,66 @@
+# erlffx
 
+-----
 
-# erlffx #
+`erlffx` is an Erlang implementation of the mechanism described in the
+2010 paper [The FFX Mode of Operation for Format-Preserving
+Encryption](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.304.1736&rep=rep1&type=pdf)
+by Bellare, Rogaway and Spies. It is based on an existing [Java
+implementation](https://github.com/michaeltandy/java-ffx-format-preserving-encryption)
+by Michael Tandy.
 
-Copyright (c) 2017-2021 Guilherme Andrade
+\* AES-128 / AES-192 (only Erlang 19 and up) / AES-256 keys are
+supported (CBC mode) \* Any positive word length is supported \* Any
+radix / alphabet size between 2 and 255 is acceptable (10 by default) \*
+Optional 'tweak' values may be defined \* Number of rounds is
+configurable (10 by default)
 
-__Version:__ 1.1.1
+The code was successfully tested on generations 17, 18 and 19 of
+Erlang/OTP; the unit tests themselves were written using the following
+lists of test vectors: \* [AES FFX Test Vector
+Data](http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/proposedmodes/ffx/aes-ffx-vectors.txt)
+\* [FF1
+samples](http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/FF1samples.pdf)
 
-__Authors:__ Guilherme Andrade ([`erlffx(at)gandrade(dot)net`](mailto:erlffx(at)gandrade(dot)net)).
-
-`erlffx`: Format Preserving Encryption - FFX for Erlang
-
-
----------
-
-`erlffx` is an Erlang implementation of the mechanism described in the 2010 paper [The FFX Mode of Operation for Format-Preserving Encryption](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.304.1736&rep=rep1&type=pdf) by Bellare, Rogaway and Spies. It is based on an existing [Java implementation](https://github.com/michaeltandy/java-ffx-format-preserving-encryption) by Michael Tandy.
-
-* AES-128 / AES-192 (only Erlang 19 and up) / AES-256 keys are supported (CBC mode)
-* Any positive word length is supported
-* Any radix / alphabet size between 2 and 255 is acceptable (10 by default)
-* Optional 'tweak' values may be defined
-* Number of rounds is configurable (10 by default)
-
-The code was successfully tested on generations 17, 18 and 19 of Erlang/OTP; the unit tests themselves were written using the following lists of test vectors:
-* [AES FFX Test Vector Data](http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/proposedmodes/ffx/aes-ffx-vectors.txt)
-* [FF1 samples](http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/FF1samples.pdf)
-
-
-### <a name="Examples">Examples</a> ###
-
-
-```erlang
+### <span id="Examples">Examples</span>
 
+``` erlang
 % AES-128 CBC / 10-digit decimal words
 AesKey = <<43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60>>,
 ValueLength = 10,
 Config = erlffx:config(AesKey, ValueLength).
 
 Encrypted = erlffx:encrypt(Config, 123456789). % 2433477484
 Decrypted = erlffx:decrypt(Config, Encrypted). % 123456789
-
 ```
 
----------
-
-```erlang
+-----
 
+``` erlang
 % AES-128 CBC / 10-digit decimal words / custom tweak
 AesKey = <<43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60>>,
 ValueLength = 10,
 Config = erlffx:config(AesKey, ValueLength, #{ tweak => "9876543210" }).
 
 Encrypted = erlffx:encrypt(Config, 123456789). % 6124200773
 Decrypted = erlffx:decrypt(Config, Encrypted). % 123456789
-
 ```
 
----------
-
-```erlang
+-----
 
+``` erlang
 % AES-128 CBC / 16-digit base-36 words / custom tweak
 AesKey = <<43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60>>,
 ValueLength = 16,
 Config = erlffx:config(AesKey, ValueLength, #{ tweak => "TQF9J5QDAGSCSPB1", radix => 36 }).
 
 Encrypted = erlffx:encrypt(Config, 36#C4XPWULBM3M863JH). % 36#C8AQ3U846ZWH6QZP
 Decrypted = erlffx:decrypt(Config, Encrypted).           % 36#C4XPWULBM3M863JH
-
 ```
 
----------
-
-```erlang
+-----
 
+``` erlang
 % AES-256 CBC / 6-digit binary words
 AesKey = <<43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60,
            239,67,89,216,213,128,170,79,127,3,109,111,4,252,106,148>>,
@@ -81,13 +69,8 @@ Config = erlffx:config(AesKey, ValueLength, #{ radix => 2 }).
 
 Encrypted = erlffx:encrypt(Config, 2#000001).  % 2#100100
 Decrypted = erlffx:decrypt(Config, Encrypted). % 2#000001
-
 ```
 
+-----
 
-## Modules ##
-
-
-<table width="100%" border="0" summary="list of modules">
-<tr><td><a href="https://github.com/g-andrade/erlffx/blob/master/doc/erlffx.md" class="module">erlffx</a></td></tr></table>
-
+*Generated by EDoc*

doc/.gitignore

@@ -0,0 +1 @@
+*

doc/overview-summary.html

@@ -8,10 +8,7 @@
 <body bgcolor="white">
 <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 <h1>erlffx</h1>
-<p>Copyright © 2017-2021 Guilherme Andrade</p>
-<p><b>Version:</b> 1.1.1</p>
-<p><b>Authors:</b> Guilherme Andrade (<a href="mailto:erlffx(at)gandrade(dot)net"><tt>erlffx(at)gandrade(dot)net</tt></a>).</p>
-<p><code>erlffx</code>: Format Preserving Encryption - FFX for Erlang</p>
+
 
 <hr>
 
@@ -28,7 +25,7 @@ <h1>erlffx</h1>
 * <a href="http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/FF1samples.pdf">FF1 samples</a></p>
 
 <h3><a name="Examples">Examples</a></h3>
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 10-digit decimal words
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 10,
@@ -40,7 +37,7 @@ <h3><a name="Examples">Examples</a></h3>
 
 <hr>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 10-digit decimal words / custom tweak
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 10,
@@ -52,7 +49,7 @@ <h3><a name="Examples">Examples</a></h3>
 
 <hr>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 16-digit base-36 words / custom tweak
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 16,
@@ -64,7 +61,7 @@ <h3><a name="Examples">Examples</a></h3>
 
 <hr>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-256 CBC / 6-digit binary words
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60,
            239,67,89,216,213,128,170,79,127,3,109,111,4,252,106,148&gt;&gt;,

overview.edoc doc/overview.edoc

@@ -1,8 +1,5 @@
-@author Guilherme Andrade <erlffx(at)gandrade(dot)net>
-@copyright 2017-2021 Guilherme Andrade
-@version 1.1.1
 @title erlffx
-@doc `erlffx': Format Preserving Encryption - FFX for Erlang
+@doc
 
 <hr/>
 
@@ -19,7 +16,7 @@ The code was successfully tested on generations 17, 18 and 19 of Erlang/OTP; the
 * <a href="http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/FF1samples.pdf">FF1 samples</a>
 
 == Examples ==
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 10-digit decimal words
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 10,
@@ -31,7 +28,7 @@ Decrypted = erlffx:decrypt(Config, Encrypted). % 123456789
 
 <hr/>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 10-digit decimal words / custom tweak
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 10,
@@ -43,7 +40,7 @@ Decrypted = erlffx:decrypt(Config, Encrypted). % 123456789
 
 <hr/>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-128 CBC / 16-digit base-36 words / custom tweak
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60&gt;&gt;,
 ValueLength = 16,
@@ -55,7 +52,7 @@ Decrypted = erlffx:decrypt(Config, Encrypted).           % 36#C4XPWULBM3M863JH
 
 <hr/>
 
-<pre lang="erlang">
+<pre lang="erlang" class="erlang">
 % AES-256 CBC / 6-digit binary words
 AesKey = &lt;&lt;43,126,21,22,40,174,210,166,171,247,21,136,9,207,79,60,
            239,67,89,216,213,128,170,79,127,3,109,111,4,252,106,148&gt;&gt;,