Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
extra
LICENSE
Makefile
README.md
_CoqProject

README.md

CoqdocJS

CoqdocJS is a little script to dynamically improve the coqdoc output. The result can be seen here:

https://www.ps.uni-saarland.de/autosubst/doc/Ssr.POPLmark.html

It offers the following features:

  • Customizable Unicode display: It only changes the display, copy-paste from the website produces pure ASCII. It only replaces complete identifiers or notation tokens, possibly terminated by numbers or apostrophes. It does not replace randomly, like in "omega." or "tauto." To add new symbols, edit config.js.
  • Proof hiding: All proofs longer than one line are hidden by default. They can be uncovered by clicking on "Proof...".

All of this works with the ordinary coqdoc, by asking coqdoc to use a header file including the javascript files and some custom CSS.

Usage

Set-up a new project

This repo is a complete setup with a generic Makefile. Just add your Coq files in the same folder as the Makefile. Execute make to build the Coqdoc website in the folder html. Specify the name of your package in the file _CoqProject. Optionally, you can list your source files in _CoqProject. Then the makefile will only build these files and the documentation will list them in the specified order.

Integrate into existing project

Make sure that your Makefile passes header.html and footer.html as command-line arguments to coqdoc and copies the content of extra/resources to the folder containing the built website. Confer the supplied Makefile for details.

Files

  • Makefile and _CoqProject: a generic Makefile setup that calls coqc and coqdoc with the right parameters
  • config.js: contains the unicode replacement table
  • coqdoc.css: a replacement for the default Coqdoc CSS style. Can be removed to use the default style
  • coqdocjs.js and coqdocjs.css: the script rewriting the DOM and adding the dynamic features with a corresponding CSS style
  • header.html and footer.html: custom header and footer files used in every generated html file