| 1 | ================================================================= |
|---|
| 2 | Logtalk - Object oriented extension to Prolog |
|---|
| 3 | Release 2.29.2 |
|---|
| 4 | |
|---|
| 5 | Copyright (c) 1998-2007 Paulo Moura. All Rights Reserved. |
|---|
| 6 | ================================================================= |
|---|
| 7 | |
|---|
| 8 | |
|---|
| 9 | This file contains detailed instructions for customizing your Logtalk |
|---|
| 10 | installation and working environment. Customization is mostly done on |
|---|
| 11 | a per-user basis by editing files on the Logtalk user folder (whose |
|---|
| 12 | path is stored on the LOGTALKUSER environment variable; the folder itself |
|---|
| 13 | can be created by running the "cplgtdirs" shell command). |
|---|
| 14 | |
|---|
| 15 | |
|---|
| 16 | 1. SETTING LIBRARY PATHS |
|---|
| 17 | |
|---|
| 18 | In Logtalk, a library is simply a directory containing source files. Library |
|---|
| 19 | paths can be declared using a dynamic predicate. This allows compiling and |
|---|
| 20 | loading of libraries and library files to be performed without worries about |
|---|
| 21 | library paths. |
|---|
| 22 | |
|---|
| 23 | Inside your Logtalk user folder, you will find a "libpaths" folder containing |
|---|
| 24 | a sample file which, when loaded, defines the library paths for the Logtalk |
|---|
| 25 | standard library and for all the supplied examples. This file may need to be |
|---|
| 26 | edited to match both your Logtalk installation and your Prolog compiler and |
|---|
| 27 | operating-system requirements. For details, see the file "libpaths/NOTES". |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | 2. CUSTOMIZING PROLOG CONFIGURATION FILES |
|---|
| 31 | |
|---|
| 32 | Logtalk interfaces with a specific Prolog compiler via a configuration file |
|---|
| 33 | that can be found on the "configs" folder inside your Logtalk user folder. |
|---|
| 34 | These configuration files can be customized by changing the values of the |
|---|
| 35 | default flags that are used by Logtalk when compiling source files. For a |
|---|
| 36 | full description of these default flags, consult the "Running and debugging |
|---|
| 37 | Logtalk programs" section of the User Manual. Some of the default flags that |
|---|
| 38 | you may want to change include: "smart_compilation", "startup_message", |
|---|
| 39 | "portability", "underscore_vars", "altdirs", and the set of documentation- |
|---|
| 40 | related flags ("xmldocs", "xslfile", "xmlspec", and "xmlsref"). Be sure to |
|---|
| 41 | read the "configs/NOTES" file for Prolog specific notes; some Prolog compilers |
|---|
| 42 | do not support the whole range of compilation flag values. |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | 3. CUSTOMIZING DOCUMENTATION PROCESSING SCRIPTS AND SUPPORTING FILES |
|---|
| 46 | |
|---|
| 47 | Inside your Logtalk user folder, you will find a "xml" folder containing a |
|---|
| 48 | set of shell scripts, CSS and XSLT style-sheets, and DTD and XML Schema files |
|---|
| 49 | for processing the XML documenting files that are automatically generated |
|---|
| 50 | when you compile source files. You may want to customize the CSS and XSLT |
|---|
| 51 | files to modify the layout or style of the resulting PDF/(X)HTML files or to |
|---|
| 52 | write new scripts and transformations to generate other formats. You may also |
|---|
| 53 | edit the file "custom.ent" in order to specify XML entities for your personal |
|---|
| 54 | data that can be used on Logtalk documenting directives. For details, see the |
|---|
| 55 | file "xml/NOTES". |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | 4. ADDING SUPPORT FOR EDITING LOGTALK SOURCE FILES TO TEXT EDITORS |
|---|
| 59 | |
|---|
| 60 | Inside your Logtalk user folder, you will find a "wenv" folder, containing |
|---|
| 61 | configuration files for several text editors, which add support for syntax |
|---|
| 62 | coloring and other editing services of Logtalk source files. For details, |
|---|
| 63 | see the file "wenv/NOTES". |
|---|
