| 1 | ================================================================ |
|---|
| 2 | Logtalk - Open source object-oriented logic programming language |
|---|
| 3 | Release 2.43.3 |
|---|
| 4 | |
|---|
| 5 | Copyright (c) 1998-2011 Paulo Moura. All Rights Reserved. |
|---|
| 6 | Logtalk is free software. You can redistribute it and/or modify |
|---|
| 7 | it under the terms of the "Artistic License 2.0" as published by |
|---|
| 8 | The Perl Foundation. Consult the "LICENSE.txt" file for details. |
|---|
| 9 | ================================================================ |
|---|
| 10 | |
|---|
| 11 | |
|---|
| 12 | This file contains detailed instructions for customizing your Logtalk |
|---|
| 13 | installation and working environment. Customization is mostly done on |
|---|
| 14 | a per-user basis by editing a settings file on the Logtalk user folder |
|---|
| 15 | (whose path is stored on the LOGTALKUSER environment variable; this folder |
|---|
| 16 | can be (re)created by running the "logtalk_user_setup" shell command). The |
|---|
| 17 | default path for the Logtalk user folder is: |
|---|
| 18 | |
|---|
| 19 | POSIX systems: $HOME/logtalk |
|---|
| 20 | Windows: My Documents\Logtalk |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | 1. DEFINING A DEFAULT PROLOG BACK-END COMPILER FOR LOGTALK |
|---|
| 24 | |
|---|
| 25 | Users of POSIX systems may use the "logtalk_backend_select" shell command |
|---|
| 26 | to define an alias, "logtalk", for one of the provided back-end Prolog |
|---|
| 27 | compiler integration scripts. |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | 2. SETTING LIBRARY PATHS |
|---|
| 31 | |
|---|
| 32 | In Logtalk, a library is simply a directory containing source files. Library |
|---|
| 33 | paths can be declared using a dynamic, multifile predicate. This allows |
|---|
| 34 | compiling and loading of libraries and library files using the library names |
|---|
| 35 | instead of the full library paths. |
|---|
| 36 | |
|---|
| 37 | Inside your Logtalk user folder, you will find a "libpaths" folder containing |
|---|
| 38 | a sample file which, when loaded, defines the library paths for the Logtalk |
|---|
| 39 | standard library and for all the supplied examples. This file may need to be |
|---|
| 40 | edited to match both your Logtalk installation and your Prolog compiler and |
|---|
| 41 | operating-system requirements. For details, see the "libpaths/NOTES.txt" file. |
|---|
| 42 | |
|---|
| 43 | Library paths for your own source files directories are preferably defined in |
|---|
| 44 | your settings file, described next. |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | 3. CUSTOMIZING LOGTALK SETTINGS |
|---|
| 48 | |
|---|
| 49 | Logtalk interfaces with a specific Prolog compiler using a configuration file |
|---|
| 50 | that can be found on the "configs" folder in the Logtalk installation folder. |
|---|
| 51 | These configuration files define default values of the flags that are used by |
|---|
| 52 | Logtalk when compiling source files (for a full description of these flags, |
|---|
| 53 | consult the "Writing, Running, and Debugging Logtalk Programs" section of the |
|---|
| 54 | User Manual). |
|---|
| 55 | |
|---|
| 56 | You may customize the Logtalk compiler flags by editing the "settings.lgt" |
|---|
| 57 | file in the Logtalk user folder. Settings in this file override the default |
|---|
| 58 | values in the configuration files. Some of the default flag values that you |
|---|
| 59 | may want to change include: |
|---|
| 60 | |
|---|
| 61 | * "startup_message" and "report" |
|---|
| 62 | - for less verbose startup and compilation reports |
|---|
| 63 | * "altdirs", "tmpdir", and "xmldir" |
|---|
| 64 | - to chose where to store temporary compilation files and documenting files |
|---|
| 65 | * "xmldocs", "xslfile", "xmlspec", and "xmlsref" |
|---|
| 66 | - to control the generation of documenting files |
|---|
| 67 | * "portability" and "underscore_variables" |
|---|
| 68 | - essential if you're writing portable Logtalk applications |
|---|
| 69 | * "smart_compilation" |
|---|
| 70 | - for avoiding recompilation of unchanged source files |
|---|
| 71 | |
|---|
| 72 | Be sure to read the "configs/NOTES.txt" file for Prolog specific compatibility |
|---|
| 73 | notes; some back-end Prolog compilers don't support all the possible compilation |
|---|
| 74 | flags values. In addition, some back-end Prolog compilers provide limited or no |
|---|
| 75 | support for settings files. |
|---|
| 76 | |
|---|
| 77 | You may also use the "settings.lgt" file in the Logtalk user folder to define |
|---|
| 78 | your own library paths. See the provided "settings.lgt" file for details. |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | 4. CUSTOMIZING DOCUMENTATION PROCESSING SCRIPTS AND SUPPORTING FILES |
|---|
| 82 | |
|---|
| 83 | Inside your Logtalk user folder, you will find a "xml" folder containing a |
|---|
| 84 | set of shell scripts, CSS and XSLT style-sheets, and DTD and XML Schema files |
|---|
| 85 | for processing the XML documenting files that are automatically generated |
|---|
| 86 | when you compile source files. You may want to customize the CSS and XSLT |
|---|
| 87 | files to modify the layout or style of the resulting PDF/(X)HTML files or to |
|---|
| 88 | write new scripts and transformations to generate other formats. You may also |
|---|
| 89 | edit the file "custom.ent" in order to specify XML entities for your personal |
|---|
| 90 | data that can be used on Logtalk documenting directives. For details, see the |
|---|
| 91 | "xml/NOTES.txt" file. |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | 5. ADDING SUPPORT TO TEXT EDITORS FOR EDITING LOGTALK SOURCE FILES |
|---|
| 95 | |
|---|
| 96 | Inside your Logtalk user folder, you will find a "wenv" folder, containing |
|---|
| 97 | configuration files for several text editors, which add support for syntax |
|---|
| 98 | highlighting and other text editing services for Logtalk source files. |
|---|
| 99 | For details, see the "wenv/NOTES.txt" file. |
|---|
