Re: [Caml-list] [ANN] Argot: 1.0 release

[Gerd Stolpmann <info@gerd-stolpmann.de>]

Excellent! I'll definitely use it.

Another idea for a feature: more options how classes and modules are
shown. For example, I once had the problem that I wanted an included
module also to be included in-place in the documentation (rather than by
reference/link). I modified the ocamldoc generator to get this effect,
and the result is here:

http://projects.camlcity.org/projects/dl/pxp-1.2.1/doc/manual/html/ref/Pxp_types.html

The grey box contains actually the included definitions. This is much
easier to understand for the casual reader. The feature is accompanied
by a link rewriter, so the ocamldoc-generated links point to the
including module rather the included module.

A similar problem occurs for inherited class types. Of course, one wants
to enable this on a case-by-case basis.

I blogged about this some years ago:
http://blog.camlcity.org/blog/pxp121.html

The generator (very specific to this case):
https://godirepo.camlcity.org/svn/lib-pxp/tags/pxp-1.2.1/tools/src/odoc/chtml.ml

Gerd

Am Mittwoch, den 02.11.2011, 19:29 +0100 schrieb forum@x9c.fr:
> Dear list,
> 
> This post announces the 1.0 release of the Argot project, whose goal is to provide
> an enhanced HTML generator for ocamldoc, released under the GPL v3.
> 
> Home page: http://argot.x9c.fr
> Preview page (for search feature): http://argot.x9c.fr/distrib/argot-3.12-libref/index.html
> Forge page: https://forge.ocamlcore.org/projects/argot/
> 
> Main changes since 1.0-beta:
>   - new '-search' command-line switch to generate search information
>     (available on HTML pages through the magnifying glass icon)
>   - search by exact name
>   - search by name using regular expression
>   - search by type using isomorphisms (experimental)
>   - new '-definitions' command-line switch to load variables from file
>   - correct handling of embedded tables
>   - more predefined licenses for the '@license' tag
>   - some refactoring
> 
> 
> Xavier Clerc
> 
> 
> 

-- 
------------------------------------------------------------
Gerd Stolpmann, Darmstadt, Germany    gerd@gerd-stolpmann.de
Creator of GODI and camlcity.org.
Contact details:        http://www.camlcity.org/contact.html
Company homepage:       http://www.gerd-stolpmann.de
*** Searching for new projects! Need consulting for system
*** programming in Ocaml? Gerd Stolpmann can help you.
------------------------------------------------------------