Changeset 5349

Show
Ignore:
Timestamp:
03/09/10 11:08:55 (6 months ago)
Author:
pmoura
Message:

Documentation cleanup, specially regarding installing, customizing, and running Logtalk. Simplified Prolog compatibility notes as the current set of compatible Prolog compilers provide a more uniform experience.

Location:
trunk
Files:
2 modified

Legend:

Unmodified
Added
Removed

  • trunk/RELEASE_NOTES.txt

    r5348 r5349  
    3434    installer in order to also create shortcuts to the main documentation 
    3535    files on the Logtalk user folder. 
     36 
     37    Documentation cleanup, specially regarding installing, customizing, and 
     38    running Logtalk. Simplified Prolog compatibility notes as the current set 
     39    of compatible Prolog compilers provide a more uniform experience. 
    3640 
    3741 

  • trunk/xml/NOTES.txt

    r5335 r5349  
    2727that all files reside in the same directory. 
    2828 
    29 The choice of the default XSL file to use is made in the config files by  
    30 the '$lgt_default_flag'/2 predicate. You may also choose a different XSL  
    31 file by using the xslfile/1 compiler flag in the logtalk_compile/2 or  
    32 logtalk_load/2 calls. The default file is "lgtxml.xsl" (described below). 
    33  
    34 The documenting files can be generated either as standalone XML files  
    35 or contain a reference to either the Logtalk DTD file, "logtalk.dtd",  
    36 or to the Logtalk XML Schema file, "logtalk.xsd". The reference to the  
    37 XML specification file can be either a local reference or a URI reference. 
    38 By default, all XML documenting files contain a local reference but that  
    39 can be changed either in the config files, by setting a Logtalk compiler  
    40 flag, or by using the xmlsref/1 compiler flag. Choose the option value  
     29The default XSL file to use ("lgtxml.xsl", described below) is set in the 
     30config files. You may choose a different default XSL file in your settings 
     31file or by using the "xslfile" flag. You may also override the default XSL 
     32file by using the xslfile/1 compiler option in the logtalk_compile/2 and 
     33logtalk_load/2 calls. 
     34 
     35The documenting files can be generated either as standalone XML files or 
     36containing a reference to either the Logtalk DTD file, "logtalk.dtd", or 
     37to the Logtalk XML Schema file, "logtalk.xsd". The reference to the XML 
     38specification file can be either a local reference or a URI reference. By 
     39default, all XML documenting files contain a local reference but that can 
     40be changed in your settings file, by setting the "xmlsref" Logtalk compiler 
     41flag, or by using the xmlsref/1 compiler option. Choose the option value 
    4142that works best with your XSLT tools. To choose between the DTD or XSD  
    42 specifications use the xmlspec/1 compiler flag. 
     43specifications use the "xmlspec" compiler flag or the xmlsref/1 compiler 
     44option. 
    4345 
    4446As Logtalk uses a single namespace for all objects, categories, and protocols, 
    4547you may want to define an alternate, global compilation directory to store all  
    4648the XML documenting files, thus ensuring proper working of links to other  
    47 entities in the generated (X)HTML files. This can be easily accomplished by  
    48 using the predicate '$lgt_default_flag'/2, which is defined on the config  
    49 files. For example: 
    50  
    51     '$lgt_default_flag'(xmldir, 'xml_docs/'). 
    52     ... 
    53     '$lgt_default_flag'(altdirs, on). 
    54     ... 
     49entities in the generated (X)HTML files. See the sample settings file in your 
     50Logtalk user folder for details. 
    5551 
    5652