Update website for ZeroMQInterface 0.15

gap-packages · Jul 3, 2024 · 4dfe5aa · 4dfe5aa
1 parent 5ab7907
commit 4dfe5aa
Show file tree

Hide file tree

Showing 14 changed files with 72 additions and 43 deletions.
diff --git a/PackageInfo.g b/PackageInfo.g
@@ -10,8 +10,8 @@ SetPackageInfo( rec(
 
 PackageName := "ZeroMQInterface",
 Subtitle := "ZeroMQ bindings for GAP",
-Version := "0.14",
-Date := "29/07/2022", # dd/mm/yyyy format
+Version := "0.15",
+Date := "01/07/2024", # dd/mm/yyyy format
 License := "GPL-2.0-or-later",
 
 Persons := [

diff --git a/_data/package.yml b/_data/package.yml
@@ -1,7 +1,7 @@
 name: ZeroMQInterface
-version: "0.14"
+version: "0.15"
 license: "GPL-2.0-or-later"
-date: 2022-07-29
+date: 2024-07-01
 description: |
     ZeroMQ bindings for GAP
 
@@ -20,15 +20,15 @@ GAP: ">= 4.9"
 needed-pkgs:
     - name: "GAPDoc"
       version: ">= 1.6.1"
-      url: "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc"
+      url: "https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc"
 
 www: https://gap-packages.github.io/ZeroMQInterface/
 readme: README.md
 packageinfo: https://gap-packages.github.io/ZeroMQInterface/PackageInfo.g
 
 downloads:
     - name: .tar.gz
-      url: https://github.com/gap-packages/ZeroMQInterface/releases/download/v0.14/ZeroMQInterface-0.14.tar.gz
+      url: https://github.com/gap-packages/ZeroMQInterface/releases/download/v0.15/ZeroMQInterface-0.15.tar.gz
 
 abstract: |
 
@@ -39,28 +39,28 @@ keywords: |
     zeromq, messaging, distributed.
 citeas: |
     <p class='BibEntry'>
-    [<span class='BibKey'>PBT22</span>]   <b class='BibAuthor'>Pfeiffer, M., Behrends, R. and GAP Team, T.</b>,
+    [<span class='BibKey'>PBT24</span>]   <b class='BibAuthor'>Pfeiffer, M., Behrends, R. and GAP Team, T.</b>,
      <i class='BibTitle'>ZeroMQInterface, ZeroMQ bindings for GAP,
-             Version 0.14</i>
-     (<span class='BibYear'>2022</span>)<br />
+             Version 0.15</i>
+     (<span class='BibYear'>2024</span>)<br />
     (<span class='BibNote'>GAP package</span>),
     <span class='BibHowpublished'><a href="https://gap-packages.github.io/ZeroMQInterface/">https://gap-packages.github.io/ZeroMQInterface/</a></span>.
     </p>
     
 
 bibtex: |
-    @misc{ ZeroMQInterface0.14,
+    @misc{ ZeroMQInterface,
       author =           {Pfeiffer, M. and Behrends, R. and GAP Team, T.},
       title =            {{ZeroMQInterface},  ZeroMQ bindings for GAP, {V}ersion
-                          0.14},
+                          0.15},
       month =            {Jul},
-      year =             {2022},
+      year =             {2024},
       note =             {GAP package},
       howpublished =     {\href
                           {https://gap-packages.github.io/ZeroMQInterface/}
-                          {\texttt{https://gap-packages.github.io/}\discretionary
+                          {\texttt{https://gap\texttt{\symbol{45}}packages.github.io/}\discretionary
                           {}{}{}\texttt{ZeroMQInterface/}}},
       keywords =         {zeromq; messaging; distributed},
-      printedkey =       {PBT22}
+      printedkey =       {PBT24}
     }
 
diff --git a/doc/chap0.html b/doc/chap0.html
@@ -29,10 +29,10 @@ <h1>ZeroMQInterface</h1>
 <h2>ZeroMQ bindings for <strong class="pkg">GAP</strong></h2>
 
 <p>
-    0.14</p>
+    0.15</p>
 
 <p>
-    29 July 2022
+    1 July 2024
   </p>
 
 </div>
@@ -180,6 +180,6 @@ <h3>Contents<a id="contents" name="contents"></a></h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap0.txt b/doc/chap0.txt
@@ -6,10 +6,10 @@
                            [1X ZeroMQ bindings for [5XGAP[105X [101X
 
 
-                                      0.14
+                                      0.15
 
 
-                                  29 July 2022
+                                  1 July 2024
 
 
                                 Markus Pfeiffer

diff --git a/doc/chap0_mj.html b/doc/chap0_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (ZeroMQInterface) - Contents</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -32,10 +32,10 @@ <h1>ZeroMQInterface</h1>
 <h2>ZeroMQ bindings for <strong class="pkg">GAP</strong></h2>
 
 <p>
-    0.14</p>
+    0.15</p>
 
 <p>
-    29 July 2022
+    1 July 2024
   </p>
 
 </div>
@@ -183,6 +183,6 @@ <h3>Contents<a id="contents" name="contents"></a></h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chap3_mj.html">3</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap1.html b/doc/chap1.html
@@ -62,6 +62,16 @@ <h4>1.3 <span class="Heading">Installation</span></h4>
 <span class="GAPprompt">&gt;</span> <span class="GAPinput">make</span>
 </pre></div>
 
+<p>Or</p>
+
+
+<div class="example"><pre>
+<span class="GAPprompt">&gt;</span> <span class="GAPinput">./configure --with-zmq=path-to-your-zeromq</span>
+<span class="GAPprompt">&gt;</span> <span class="GAPinput">make</span>
+</pre></div>
+
+<p>to specify where <span class="URL"><a href="https://zeromq.org">ZeroMQ</a></span> is located in you system.</p>
+
 <p><a id="X80D704CC7EBFDF7A" name="X80D704CC7EBFDF7A"></a></p>
 
 <h4>1.4 <span class="Heading">Feedback</span></h4>
@@ -75,6 +85,6 @@ <h4>1.4 <span class="Heading">Feedback</span></h4>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap1.txt b/doc/chap1.txt
@@ -29,6 +29,15 @@
     [4X[25X>[125X [27Xmake[127X[104X
   [4X[32X[104X
 
+  [33X[0;0YOr[133X
+
+  [4X[32X  Example  [32X[104X
+    [4X[25X>[125X [27X./configure --with-zmq=path-to-your-zeromq[127X[104X
+    [4X[25X>[125X [27Xmake[127X[104X
+  [4X[32X[104X
+
+  [33X[0;0Yto specify where ZeroMQ ([7Xhttps://zeromq.org[107X) is located in you system.[133X
+
 
   [1X1.4 [33X[0;0YFeedback[133X[101X
 

diff --git a/doc/chap1_mj.html b/doc/chap1_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (ZeroMQInterface) - Chapter 1: Introduction</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -65,6 +65,16 @@ <h4>1.3 <span class="Heading">Installation</span></h4>
 <span class="GAPprompt">&gt;</span> <span class="GAPinput">make</span>
 </pre></div>
 
+<p>Or</p>
+
+
+<div class="example"><pre>
+<span class="GAPprompt">&gt;</span> <span class="GAPinput">./configure --with-zmq=path-to-your-zeromq</span>
+<span class="GAPprompt">&gt;</span> <span class="GAPinput">make</span>
+</pre></div>
+
+<p>to specify where <span class="URL"><a href="https://zeromq.org">ZeroMQ</a></span> is located in you system.</p>
+
 <p><a id="X80D704CC7EBFDF7A" name="X80D704CC7EBFDF7A"></a></p>
 
 <h4>1.4 <span class="Heading">Feedback</span></h4>
@@ -78,6 +88,6 @@ <h4>1.4 <span class="Heading">Feedback</span></h4>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chap3_mj.html">3</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap2.html b/doc/chap2.html
@@ -100,7 +100,7 @@ <h4>2.1 <span class="Heading">Addresses, transports, and URIs</span></h4>
 
 <h5>2.1-1 <span class="Heading">The TCP transport</span></h5>
 
-<p>TCP URIs map to POSIX TCP stream sockets. The URI is of the form <code class="code">tcp://&lt;address&gt;:&lt;port&gt;</code> or <code class="code">tcp://*:&lt;port&gt;</code>. Here, <code class="code">address</code> is an internet address, either an IP address or a symbolic address (note that to resolve symbolic addresses, the library may have to consult DNS servers, which can take an indefinite amount of time or even fail). Port is a TCP port number. If a "*" is given instead of an address, this describes the so-called unspecified address; the URI can only be used for binding and will then accept incoming connections from all interfaces (as in binding to "0.0.0.0" in IPv4 or "::" in IPv6).</p>
+<p>TCP URIs map to POSIX TCP stream sockets. The URI is of the form <code class="code">tcp://&lt;address&gt;:&lt;port&gt;</code> or <code class="code">tcp://*:&lt;port&gt;</code>. Here, <code class="code">address</code> is an internet address, either an IP address or a symbolic address (note that to resolve symbolic addresses, the library may have to consult DNS servers, which can take an indefinite amount of time or even fail). Port is a TCP port number. If a <q>*</q> is given instead of an address, this describes the so-called unspecified address; the URI can only be used for binding and will then accept incoming connections from all interfaces (as in binding to <q>0.0.0.0</q> in IPv4 or <q>::</q> in IPv6).</p>
 
 <p><a id="X792BDF3F7AB76A99" name="X792BDF3F7AB76A99"></a></p>
 
@@ -124,7 +124,7 @@ <h5>2.1-3 <span class="Heading">The in-process transport</span></h5>
 
 <h4>2.2 <span class="Heading">Creating and closing sockets</span></h4>
 
-<p>Sockets are generally being created via calls to <code class="func">ZmqPushSocket</code> (<a href="chap2.html#X7E37F9DD7F0977F2"><span class="RefLink">2.2-1</span></a>), etc. Each such call takes two optional arguments, a URI and an identity. If a URI is given, a call to <code class="func">ZmqAttach</code> (<a href="chap2.html#X7C17743C874D56CF"><span class="RefLink">2.3-3</span></a>) will be performed immediately with the socket and URI. In particular, if the URI is prefixed with a "+" character, then the socket will connect to the address specified by the part after the "+" character; otherwise, it will be bound to the URI.</p>
+<p>Sockets are generally being created via calls to <code class="func">ZmqPushSocket</code> (<a href="chap2.html#X7E37F9DD7F0977F2"><span class="RefLink">2.2-1</span></a>), etc. Each such call takes two optional arguments, a URI and an identity. If a URI is given, a call to <code class="func">ZmqAttach</code> (<a href="chap2.html#X7C17743C874D56CF"><span class="RefLink">2.3-3</span></a>) will be performed immediately with the socket and URI. In particular, if the URI is prefixed with a <q>+</q> character, then the socket will connect to the address specified by the part after the <q>+</q> character; otherwise, it will be bound to the URI.</p>
 
 
 <div class="example"><pre>
@@ -195,7 +195,7 @@ <h5>2.2-8 ZmqRouterSocket</h5>
 <h5>2.2-9 ZmqSocket</h5>
 
 <div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#8227; ZmqSocket</code>( <var class="Arg">type</var> )</td><td class="tdright">(&nbsp;function&nbsp;)</td></tr></table></div>
-<p><code class="code">ZmqSocket</code> is a low-level function that is used by <code class="code">ZmqPushSocket</code> etc. to create sockets. Its argument is a string, one of "PUSH", "PULL", "REP", "REQ", "PUB", "SUB", "DEALER", "ROUTER", and it creates and returns a socket of that type.</p>
+<p><code class="code">ZmqSocket</code> is a low-level function that is used by <code class="code">ZmqPushSocket</code> etc. to create sockets. Its argument is a string, one of <q>PUSH</q>, <q>PULL</q>, <q>REP</q>, <q>REQ</q>, <q>PUB</q>, <q>SUB</q>, <q>DEALER</q>, <q>ROUTER</q>, and it creates and returns a socket of that type.</p>
 
 <p><a id="X878D7DF3846B3431" name="X878D7DF3846B3431"></a></p>
 
@@ -241,7 +241,7 @@ <h5>2.3-2 ZmqConnect</h5>
 <h5>2.3-3 ZmqAttach</h5>
 
 <div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#8227; ZmqAttach</code>( <var class="Arg">socket</var>, <var class="Arg">uri</var> )</td><td class="tdright">(&nbsp;function&nbsp;)</td></tr></table></div>
-<p><code class="code">ZmqAttach</code> is a unified interface for binding and connecting a socket. If <code class="code">uri</code> begins with a "+" character, then the <code class="func">ZmqConnect</code> (<a href="chap2.html#X7D00EE937F96175E"><span class="RefLink">2.3-2</span></a>) is called with the socket and the rest of the <code class="code">uri</code> string following the "+". Otherwise, <code class="func">ZmqBind</code> (<a href="chap2.html#X7F4A98227D65B573"><span class="RefLink">2.3-1</span></a>) is called with these arguments. The intended use is to construct a network of connections from a list of strings.</p>
+<p><code class="code">ZmqAttach</code> is a unified interface for binding and connecting a socket. If <code class="code">uri</code> begins with a <q>+</q> character, then the <code class="func">ZmqConnect</code> (<a href="chap2.html#X7D00EE937F96175E"><span class="RefLink">2.3-2</span></a>) is called with the socket and the rest of the <code class="code">uri</code> string following the <q>+</q>. Otherwise, <code class="func">ZmqBind</code> (<a href="chap2.html#X7F4A98227D65B573"><span class="RefLink">2.3-1</span></a>) is called with these arguments. The intended use is to construct a network of connections from a list of strings.</p>
 
 <p><a id="X7CB8FB7F8377B620" name="X7CB8FB7F8377B620"></a></p>
 
@@ -485,6 +485,6 @@ <h5>2.5-12 ZmqUnsubscribe</h5>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>