1---++ SWI-Prolog documentation server
2
3Welcome to the SWI-Prolog documentation server.  This server provides an
4integrated search facility to the   SWI-Prolog Reference Manual, Package
5documentation as well as documented libraries.
6
7---++ Using this server
8
9Search all documentation using the search-box at the top-left corner.
10For example, try:
11
12==
13load xml
14==
15
16---++ Experimental server!
17
18This server is experimental. The UI has   not  been evaluated nor tested
19extensively. We modified most of  the   library  sources  to satisfy the
20PlDoc structured documentation conventions using  a simple =sed= script.
21The material has been  reviewed  and   corrected  very  partially.  Many
22libraries are not yet fully documented in the source.
23
24---++ Running the server locally
25
26You can install this server  locally   using  the  out-of-the-box 5.6.18
27release of SWI-Prolog  from   http://www.swi-prolog.org.  The  directory
28holding the server setup is   in  =|doc/packages/examples/pldoc|= If you
29have reusable libraries, document them according to the PlDoc structured
30comment specification and make sure  they   are  loaded into the server.
31This makes your libraries searchable in the same interface.
32
33