Changeset 1191

Timestamp:

07/25/04 11:15:53 (4 years ago)

Author:

pmoura

Message:

Improved documentation.

Location:

trunk

Files:

• examples/NOTES (modified) (1 diff)
• INSTALL (modified) (1 diff)
• library/dates.notes (modified) (1 diff)
• library/events.notes (modified) (1 diff)
• library/hierarchies.notes (modified) (1 diff)
• library/NOTES (modified) (3 diffs)
• library/types.notes (modified) (1 diff)
• misc/NOTES (modified) (1 diff)
• README (modified) (1 diff)
• RELEASE_NOTES (modified) (1 diff)
• scripts/NOTES (modified) (1 diff)

trunk/examples/NOTES

@@ -10 +10 @@
 description of each example is included below.
 
-Each example contains a NOTES file and a loader utility file that may 
-be used to load all the example entities. In addition, most examples 
+Each example folder contains a NOTES file and a loader helper file which 
+may be used to load all the example entities. In addition, most examples 
 contain a SCRIPT file with sample queries for your to try.
 
-Most of these examples need objects, protocols, and categories that 
-are defined in the Logtalk standard library or in other examples, so 
-you should load them first (see the NOTES files inside the library 
-folder and the NOTES file inside each example folder).
+Most of these examples need objects, protocols, and categories which are 
+defined in the Logtalk standard library or in other examples, so you 
+should load them first (see the NOTES files inside the library folder and 
+the NOTES file inside each example folder).
 
 Some examples may redefine objects already loaded from other examples.
 You may want to restart Logtalk after trying each example.
 
-Some of the examples code have been adopted from public available 
-Prolog code and from known Prolog text books and are copyrighted by 
-the respective authors.
+Some of the examples code have been adopted from public available Prolog 
+code and from known Prolog text books and are copyrighted by the respective 
+authors.
 
-These are programming examples, meaning that you should study the 
-source files to fully understand them.
+These are programming examples, meaning that you should study the source 
+files to fully understand them.
 
 All examples are formatted using four spaces tabs.
 
 By default, compiling an example generates a .xml documenting file for each 
-compiled entity (object, category, or protocol). See the xml sub-directory 
-for instructions on how to browse the .xml files for on-line reading or how 
-to convert the files to a print-ready format such as PDF.
+compiled entity (object, category, or protocol). See the xml folder for 
+instructions on how to browse the .xml files for on-line reading or how to 
+convert the files to a print-ready format such as PDF.
 
 

trunk/INSTALL

@@ -17 +17 @@
 INSTALLING FOR A SINGLE USER
 
-In the case of a single user, the Logtalk directory can simply be 
-copied to the user home directory.
+In the case of a single user, the Logtalk directory may simply be copied to 
+the user home directory.
 
 
 INSTALLING FOR MULTIPLE USERS
 
-In the case of multiple users, the Logtalk directory can be copied to 
-any location that its accessible by all the users.
+In the case of multiple users, the Logtalk directory can be copied to any 
+location that its accessible by all the users.
 
 Regarding directory and file permissions, it is advisable to make all files 

trunk/library/dates.notes

@@ -17 +17 @@
 
 Please note that some of the functionality of these objects depends 
-on the used Prolog support for accessing operating system time and 
+on the chosen Prolog support for accessing operating system time and 
 date values.

trunk/library/events.notes

@@ -17 +17 @@
 The protocol event_handlersp declares the two basic event handler predicates
 (before/3 and after/3). You will need to refer this protocol in your objects
-if you need to use the super control structure (^^/1) with these predicates.
+if you want to use the super control structure (^^/1) with these predicates.
 
 The monitor object implements more sophisticated event handling predicates.
 
-Some of the objects assume that the used Prolog compiler defines the 
+Some of the objects assume that the chosen Prolog compiler defines the 
 usual sort/2 built-in predicate.

trunk/library/hierarchies.notes

@@ -12 +12 @@
     | ?- logtalk_load(hierarchies_loader).
 
-These objects implement reflection predicates over class/instance 
-and prototype hierarchies.
+These objects implement reflection predicates over class and prototype 
+hierarchies.

trunk/library/NOTES

@@ -7 +7 @@
 
 
-This folder contains objects, categories, and protocols that implement
-predicates for dealing with common Prolog types and structures.
+This folder contains some useful objects, categories, and protocols. 
 
 To load a group of objects, protocols, and categories in this library 
@@ -56 +55 @@
     | ?- logtalk_load(all_loader).
 
-Specific notes about each group of objects, categories, and protocols 
-can be found in the corresponding *.notes files.
+Specific notes about each group of objects, categories, and protocols can be 
+found in the corresponding *.notes files.
 
-Some of the files contained in this directory represent work in progress 
-and are not loaded by default by any loader utility file.
+Some of the files contained in this directory represent work in progress and 
+are not loaded by default by any loader utility file.
 
-Some of the code in this library is based on public domain Prolog code, 
-in particular, code adopted from the Edinburgh Prolog library. The definition 
+Some of the code in this library is based on public domain Prolog code, in 
+particular, code adopted from the Edinburgh Prolog library. The definition 
 of predicate reverse/2 in object list is from Richard O'Keefe and can be found 
 in its book "The Craft of Prolog".
@@ -70 +69 @@
 documenting file for each compiled entity (object, category, or protocol).
 See the xml sub-directory for instructions on how to browse the .xml files 
-for on-line reading or how to convert the files to print-ready format.
+for on-line reading or how to convert the files to a print-ready format such 
+as PDF.
 
 All source files are formatted using four-spaces tabs.

trunk/library/types.notes

@@ -13 +13 @@
 
 These objects implement predicates over common Prolog terms and 
-structures like lists, diffrence lists, binary trees, dictionaries, 
-and queues.
+structures such as lists, difference lists, binary trees, queues, 
+dictionaries, and sets.

trunk/misc/NOTES

@@ -61 +61 @@
 
 make_xsblgt.sh
-    makes a script named ciaolgt for running Logtalk with XSB
+    makes a script named xsblgt for running Logtalk with XSB
 
 These scripts require the environment variable LOGTALKHOME (pointing to the 

trunk/README

@@ -36 +36 @@
     http://www.logtalk.org/
 
-At this address you can also find useful documentation and information
+At this address you can also find additional documentation and information
 about Logtalk.
 

trunk/RELEASE_NOTES

@@ -17 +17 @@
     on single entity source files plus loading and compiling helper files.
 
-    Updated URL used on the automatically generated XML documenting files 
+    Updated the URL used on the automatically generated XML documenting files 
     when compiling entities with the option doctype(web).
 

trunk/scripts/NOTES

@@ -61 +61 @@
 
 make_xsblgt.sh
-    makes a script named ciaolgt for running Logtalk with XSB
+    makes a script named xsblgt for running Logtalk with XSB
 
 These scripts require the environment variable LOGTALKHOME (pointing to the