PIDoc: Wiki style Literate Programming for Prolog

TL;DR

PIDoc is a literate programming system for Prolog that uses structured comments and a web interface to enhance documentation and ease of access to source code, promoting better programming practices.

Contribution

It introduces PlDoc, a minimal-distraction, web-integrated literate programming system tailored for Prolog, improving documentation and source code navigation.

Findings

Enhanced documentation practices for Prolog.

Web interface facilitates quick access to code and documentation.

Supports seamless navigation between documentation and source code.

Abstract

This document introduces PlDoc, a literate programming system for Prolog. Starting point for PlDoc was minimal distraction from the programming task and maximal immediate reward, attempting to seduce the programmer to use the system. Minimal distraction is achieved using structured comments that are as closely as possible related to common Prolog documentation practices. Immediate reward is provided by a web interface powered from the Prolog development environment that integrates searching and browsing application and system documentation. When accessed from localhost, it is possible to go from documentation shown in a browser to the source code displayed in the user's editor of choice.