PackageInfo.g

[olexandr-konovalov]

Please check that AbstractHTML is meaningful in PackageInfo.g files. For example, I've just found

AbstractHTML   :=  "",

in https://github.com/homalg-project/CAP_project/blob/master/CAP/PackageInfo.g. Thanks

[olexandr-konovalov]

ping? This is still the case, resulting e.g. in empty "Short Description" at https://www.gap-system.org/Packages/cap.html

[sebastianpos]

Thanks for the ping :-)

[olexandr-konovalov]

Thanks. In doubt how to fill in PackageInfo.g, please see https://github.com/gap-packages/example/blob/master/PackageInfo.g:

##  Provide a short (up to a few lines) abstract in HTML format, explaining
##  the package content. This text will be displayed on the package overview
##  Web page. Please use '<span class="pkgname">GAP</span>' for GAP and
##  '<span class="pkgname">MyPKG</span>' for specifing package names.
##  
# AbstractHTML := "This package provides  a collection of functions for \
# computing the Smith normal form of integer matrices and some related \
# utilities.",
AbstractHTML := 
  "The <span class=\"pkgname\">Example</span> package, as its name suggests, \
   is an example of how to create a <span class=\"pkgname\">GAP</span> \
   package. It has little functionality except for being a package.",

Another valid example, with multiline strings:

AbstractHTML     := """
This package provides routines for factoring integers, in particular:
<ul>
  <li>Pollard's <em>p</em>-1</li>
  <li>Williams' <em>p</em>+1</li>
  <li>Elliptic Curves Method (ECM)</li>
  <li>Continued Fraction Algorithm (CFRAC)</li>
  <li>Multiple Polynomial Quadratic Sieve (MPQS)</li>
</ul>
It also provides access to Richard P. Brent's tables of factors of integers of the form <em>b</em>^<em>k</em> +/- 1.
""",

[sebastianpos]

Thanks for the examples. I now use the proposed HTML tags for our package names. 8e8bd657b84b0f