diogo/yap-6.3
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Logtalk 2.24.0 files.

Browse Source 
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1282 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
This commit is contained in:
pmoura
2005-04-22 23:57:45 +00:00
parent 08efcbeb64
commit c2e03a81b9
195 changed files with 4005 additions and 1219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
Logtalk/xml/NOTES
View File

@@ -1,23 +1,25 @@
=================================================================
Logtalk - Object oriented extension to Prolog
Release 2.23.1
Release 2.24.0
Copyright (c) 1998-2005 Paulo Moura. All Rights Reserved.
=================================================================
This folder contains supporting files for converting XML documentation
files (which are created when compiling objects, categories, or protocols)
to PDF files or (X)HTML files using XSL style sheets. The documentation
files may also be viewed directly in a web browser that supports the W3C
standards XML, XSLT, CSS, and HTML 4 or XHTML 1.0.
This folder contains supporting files for converting and/or indexing XML
documentation files (which are created when compiling objects, categories,
or protocols) to PDF files or (X)HTML files using XSL style sheets. The
documentation files may also be viewed directly on a web browser that
supports the W3C standards XML, XSLT, CSS, and HTML 4 or XHTML 1.0.
The scripts provided in this folder are just samples, which you should adapt
to your working environment. Some scripts expect that all files be in the
same directory. Some others should be called from the directory containing
the XML documenting files that you wish to convert. See the description of
each script below for details. Make sure that the XSL processors you intend
to use are properly installed before running the scripts.
each script below for details.
MAKE SURE THAT THE XSL PROCESSORS YOU INTEND TO USE ARE PROPERLY INSTALLED
AND WORKING BEFORE RUNNING THE SCRIPTS!
Regarding conversion to HTML/XHTML, the links to the .xsl files on the
.xml files and the links to the .css files in the generated .html files
@@ -38,18 +40,25 @@ flag, or by using the doctype/1 compiler flag. Choose the option value
that works best with your XSLT tools. To choose between the .dtd or .xsd
specifications use the xmlspec/1 compiler flag.
As Logtalk uses a single namespace for all objects, categories, and protocols,
it is advisable that you define an alternate compilation directory to store
all the XML documenting files (see the predicate '$lgt_alt_directory'/2 on the
config files). This will ensure proper working of links to other entities in
the generated (X)HTML files.
Brief description of each file in this folder:
lgtxml.xsl
XSLT file for viewing .xml files directly in in a browser such as Mozilla
(version 0.9.2 or later) or Microsoft Internet Explorer 5.5 for Windows
(after installing the latest Microsoft XML Parser Release that is needed
for XSL standard compliance). The links in the (internally generated)
HTML files point to related XML files. UTF-8 encoding is assumed. Edit
the file if you use a different encoding.
XSLT file for viewing .xml files directly in in a browser such as Safari
(version 1.3 or later), Firefox 1.0.x, Mozilla (version 0.9.2 or later),
or Microsoft Internet Explorer 5.5 for Windows (after installing the
latest Microsoft XML Parser Release that is needed for XSL standard
compliance). The links in the (internally generated) HTML files point to
related XML files. UTF-8 encoding is assumed. Edit the file if you use a
different encoding.
lgthtml.xsl
@@ -128,7 +137,7 @@ lgt2pdf.js
you wish to convert. Call the scripts with the help option for a description
of the available optional parameters (type "cscript lgt2pdf.js help" or
"lgt2pdf.sh -h"; depending on your Logtalk installation, you may simply need
to type lgt2pdf in order to run the script).
to type "lgt2pdf" in order to run the script).
lgt2html.sh
@@ -147,8 +156,8 @@ lgt2html.js
http://xml.apache.org/xalan-c/index.html
* Sablotron (tested with version 1.0.1)
http://www.gingerall.com/charlie/ga/xml/p_sab.xml
* Microsoft MSXSL (only for the JScript script)
http://msdn.microsoft.com/library/en-us/dnxml/html/msxsl.asp
* Microsoft MSXSL (only for the Windows JScript script)
http://msdn.microsoft.com/XML/XMLDownloads/default.aspx
These scripts assumes that the LOGTALKUSER environment variable is defined
and that the chosen XSLT processor is available in the path.
@@ -156,8 +165,28 @@ lgt2html.js
The scripts should be called from the directory containing the .xml files
you wish to convert. Call the scripts with the help option for a description
of the available optional parameters (type "cscript lgt2html.js help" or
"lgt2html.sh -h"; depending on your Logtalk installation, you may simply need
to type lgt2html in order to run the script).
"lgt2html.sh -h"; depending on your Logtalk installation, you may simply
need to type "lgt2html" in order to run the script).
lgt2xml.sh
(bash shell script)
lgt2xml.js
(JScript command-line script for Windows; requires WSH 5.6 or later version)
Sample scripts for indexing the .xml files in the current directory by
generating an index.html file which contains links to all the files. In
addition, these scripts also make a copy of the lgtxml.xsl file to the
current directory, allowing direct visualization of the .xml files on a
supported web browser.
These scripts assumes that the LOGTALKUSER environment variable is defined.
The scripts should be called from the directory containing the .xml files
you wish to index. Call the scripts with the help option for a description
of the available optional parameters (type "cscript lgt2xml.js help" or
"lgt2xml.sh -h"; depending on your Logtalk installation, you may simply
need to type "lgt2xml" in order to run the script).
html.sh