Update to latest GitHubPagesForGAP template

gap-packages · Feb 20, 2024 · c218afc · c218afc
1 parent 3682667
commit c218afc
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 7 deletions.
diff --git a/_data/package.yml b/_data/package.yml
@@ -1,5 +1,6 @@
 name: IO
-version: 4.8.2
+version: "4.8.2"
+license: "GPL-3.0-or-later"
 date: 2023-10-16
 description: |
     Bindings for low level C library I/O routines
@@ -30,3 +31,33 @@ abstract: |
 status: deposited
 doc-html: doc/chap0_mj.html
 doc-pdf: doc/manual.pdf
+keywords: |
+    input, output, I/O, C-library, network, http, object serialisation, unpredictable random numbers, TCP/IP, inter process communication, background jobs, parallel skeletons, I/O multiplexing.
+citeas: |
+    <p class='BibEntry'>
+    [<span class='BibKey'>NH23</span>]   <b class='BibAuthor'>Neunhöffer, M. and Horn, M.</b>,
+     <i class='BibTitle'>IO, Bindings for low level C library I/O routines,
+             Version 4.8.2</i>
+     (<span class='BibYear'>2023</span>)<br />
+    (<span class='BibNote'>GAP package</span>),
+    <span class='BibHowpublished'><a href="https://gap-packages.github.io/io">https://gap-packages.github.io/io</a></span>.
+    </p>
+    
+
+bibtex: |
+    @misc{ IO4.8.2,
+      author =           {Neunh{\"o}ffer, M. and Horn, M.},
+      title =            {{IO},  Bindings  for low level C library I/O routines,
+                          {V}ersion 4.8.2},
+      month =            {Oct},
+      year =             {2023},
+      note =             {GAP package},
+      howpublished =     {\href              {https://gap-packages.github.io/io}
+                          {\texttt{https://gap-packages.github.io/io}}},
+      keywords =         {input;  output;  I/O; C-library; network; http; object
+                          serialisation;  unpredictable  random numbers; TCP/IP;
+                          inter process communication; background jobs; parallel
+                          skeletons; I/O multiplexing},
+      printedkey =       {NH23}
+    }
+
diff --git a/_includes/button-bibtex.html b/_includes/button-bibtex.html
@@ -0,0 +1 @@
+<button type="button" class="btn active" data-clipboard-text="{{site.data.package.bibtex | xml_escape}}">Copy BibTeX to clipboard</button>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -4,21 +4,26 @@
     <meta charset="utf-8">
     <title>GAP package {{ site.data.package.name }}</title>
 
+    {% if site.data.package.keywords and site.data.package.keywords.size > 0 %}
+    <meta name="keywords" content="{{site.data.package.keywords}}" />
+    {% endif %}
+
     <link rel="stylesheet" type="text/css" href="stylesheets/styles.css">
     <link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css">
     <script type="text/javascript"
       src="javascripts/scale.fix.js">
     </script>
-    <script type="text/javascript"
-      src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
-    </script>
+    <script type="text/javascript" src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/latest.js?config=TeX-MML-AM_CHTML' async></script>
+
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
 
     <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
     <!--[if lt IE 9]>
     <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->
   </head>
   <body>
+    <script>new ClipboardJS('.btn');</script>
     <div class="wrapper">
       <header>
         <h1 class="header">{{ site.data.package.name }}</h1>
@@ -55,7 +60,9 @@ <h1 class="header">{{ site.data.package.name }}</h1>
 
       </section>
       <footer>
-        <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
+        <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a>,
+        based on <a href="https://github.com/gap-system/GitHubPagesForGAP">GitHubPagesForGAP</a>
+        using the Dinky theme</small></p>
         <p><small><em>Last updated: {{ 'now' | date: "%Y-%m-%d %H:%M" }}</em></small></p>
       </footer>
     </div>

diff --git a/index.md b/index.md
@@ -10,6 +10,10 @@ The current version of this package is version {{site.data.package.version}}, re
 For more information, please refer to [the package manual]({{site.data.package.doc-html}}).
 There is also a [README](README.html) file.
 
+{% if site.data.package.license %}
+  License: [{{ site.data.package.license }}](https://spdx.org/licenses/{{ site.data.package.license }})
+{% endif %}
+
 ## Dependencies
 
 This package requires GAP version {{site.data.package.GAP}}
@@ -43,6 +47,20 @@ The following additional GAP packages are not required, but suggested:
  {% endfor %}
 {% endif %}
 
+{% if site.data.package.citeas %}
+## Citing
+
+Please, cite this package as
+
+{{site.data.package.citeas}}
+
+You can get more info by typing `Cite("{{ site.data.package.name }}");` in the gap prompt.
+
+{% include button-bibtex.html %}
+
+{% endif %}
+
+
 {% if site.github.issues_url %}
 ## Feedback
 

diff --git a/update.g b/update.g
@@ -68,7 +68,10 @@ GeneratePackageYML:=function(pkg)
     SetPrintFormattingStatus(stream, false);
 
     AppendTo(stream, "name: ", pkg.PackageName, "\n");
-    AppendTo(stream, "version: ", pkg.Version, "\n");
+    AppendTo(stream, "version: \"", pkg.Version, "\"\n");
+    if IsBound(pkg.License) then
+        AppendTo(stream, "license: \"", pkg.License, "\"\n");
+    fi;
 
     # convert date from DD/MM/YYYY to ISO 8601, i.e. YYYY-MM-DD
     #
@@ -168,7 +171,23 @@ GeneratePackageYML:=function(pkg)
         fi;
     fi;
 
-    # TODO: use Keywords?
+    if IsBound(pkg.Keywords) and
+        Length(pkg.Keywords) > 0 then
+        AppendTo(stream, "keywords: |\n");
+        AppendTo(stream, "    ", JoinStringsWithSeparator(pkg.Keywords,", "),".\n");
+    fi;
+
+    AppendTo(stream, "citeas: |\n");
+    for tmp in SplitString(StringBibXMLEntry(ParseBibXMLextString(BibEntry(pkg)).entries[1],"HTML"),"\n") do
+        AppendTo(stream, "    ", tmp, "\n");
+    od;
+    AppendTo(stream, "\n");
+
+    AppendTo(stream, "bibtex: |\n");
+    for tmp in SplitString(StringBibXMLEntry(ParseBibXMLextString(BibEntry(pkg)).entries[1],"BibTeX"),"\n") do
+        AppendTo(stream, "    ", tmp, "\n");
+    od;
+    AppendTo(stream, "\n");
 
     CloseStream(stream);
 end;