|Did you know ...||Search Documentation:|
|Title for pldoc(object(section(3,'10.1',swi('/doc/packages/pldoc.html'))))|
To support the developer with an up-to-date version of the
documentation of both the application under development and the system
libraries the developer can start an HTTP documentation server using the
doc_server(?Port). A good way to deploy PlDoc for program
development is to write a file called e.g.,
sets up the preferred development environment and loads your program.
below is an example
debug.pl that starts PlDoc and prints
strings as text before loading the remainder of your program.
:- doc_server(4000). % Start PlDoc at port 4000 :- portray_text(true). % Enable portray of strings :- [load]. % load your program
doc_server(Port, [allow(localhost), workers(1)]). This predicate must be called before loading the program for which you consult the documentation. It calls doc_collect/1 to start collecting documentation while (re-)loading your program.
. Path must be an absolute URL location, starting with
and ending in
. Intented for public services behind a reverse proxy. See documentation of the HTTP package for details on using reverse proxies.
false, do not allow editing, even if the connection comes from localhost. Intended together with the
rootoption to make pldoc available from behind a reverse proxy. See the HTTP package for configuring a Prolog server behind an [Apache reverse proxy]http://httpd.apache.org/docs/1.3/mod/mod_proxy.html.
allow('.uva.nl')grants access to all machines in this domain. IP addresses are specified using the library(socket) ip/4 term. I.e. to allow access from the 10.0.0.X domain, specify
Access is granted iff