Logtalk 2.20.0 files.
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1114 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
This commit is contained in:
pmoura
@@ -1,51 +1,47 @@
|
||||
=================================================================
|
||||
Logtalk - Object oriented extension to Prolog
|
||||
Release 2.19.1
|
||||
Release 2.20.0
|
||||
|
||||
Copyright (c) 1998-2004 Paulo Moura. All Rights Reserved.
|
||||
=================================================================
|
||||
|
||||
|
||||
This folder contains several files that enables .xml documentation files
|
||||
created when compiling objects, categories, or protocols, to be converted
|
||||
to PDF files, to be viewed in a web browser that supports the W3C standards
|
||||
XML, XSLT, CSS, and HTML 4 or XHTML 1.0, or to be converted to LateX for
|
||||
printing.
|
||||
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.
|
||||
|
||||
You will need to either copy your .xml files to this directory or copy
|
||||
these files to the directory where the .xml files reside.
|
||||
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.
|
||||
|
||||
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
|
||||
assume that all files reside in the same directory.
|
||||
|
||||
The choice of the default .xsl file to use is made in the config files by
|
||||
the '$lgt_default_flag'/2 predicate. You can also choose a different
|
||||
the '$lgt_default_flag'/2 predicate. You may also choose a different
|
||||
.xsl file by using the xsl/1 compiler option in the logtalk_compile/2 or
|
||||
logtalk_load/2 calls. The default file is lgtxml.xsl (described below).
|
||||
|
||||
The .xml documenting files can be either generated as standalone XML files
|
||||
or contain a reference to either the Logtalk DTD file, logtalk.dtd, or to
|
||||
The documenting files can be either generated as standalone XML files or
|
||||
contain a reference to either the Logtalk DTD file, logtalk.dtd, or to
|
||||
the Logtalk XML Schema file, logtalk.xsd. The reference to the XML
|
||||
specification file can be either a local reference or a URI reference. By
|
||||
default, all .xml documenting files contain a local reference but that
|
||||
can be changed either in the config files, by setting a Logtalk compiler
|
||||
flag, or by using the doctype/1 compiler option. Choose the option value
|
||||
that works best for your XSLT tools. To choose between the .dtd or .xsd
|
||||
that works best with your XSLT tools. To choose between the .dtd or .xsd
|
||||
specifications use the xmlspec/1 compiler option.
|
||||
|
||||
|
||||
Brief description of each file in this folder:
|
||||
|
||||
|
||||
lgthtml.xsl
|
||||
|
||||
XSLT file to output HTML files from the .xml files. The links in the
|
||||
generated HTML files point to related HTML files. It can be used to
|
||||
batch convert XML files to HTML files. UTF-8 encoding is assumed. Edit
|
||||
the file if you use a different encoding.
|
||||
|
||||
|
||||
lgtxml.xsl
|
||||
|
||||
XSLT file for viewing .xml files directly in in a browser such as Mozilla
|
||||
@@ -56,6 +52,14 @@ lgtxml.xsl
|
||||
the file if you use a different encoding.
|
||||
|
||||
|
||||
lgthtml.xsl
|
||||
|
||||
XSLT file to output HTML files from the .xml files. The links in the
|
||||
generated HTML files point to related HTML files. It can be used to
|
||||
batch convert XML files to HTML files. UTF-8 encoding is assumed. Edit
|
||||
the file if you use a different encoding.
|
||||
|
||||
|
||||
lgtxhtml.xsl
|
||||
|
||||
XSLT file to output XHTML 1.0 files from the .xml files. The links in
|
||||
@@ -67,18 +71,11 @@ lgtxhtml.xsl
|
||||
lgtpdfa4.xsl
|
||||
lgtpdfus.xsl
|
||||
|
||||
XSLT files to generate PDF files from the .xml files (formatted either
|
||||
XSLT files to generate PDF files from the XML files (formatted either
|
||||
for A4 paper or US Letter paper) using XSL Formatting Objects. Tested
|
||||
with the XSL:FO processors Apache FOP 0.20.5 (http://xml.apache.org/fop),
|
||||
with the XSL-FO processors Apache FOP 0.20.5 (http://xml.apache.org/fop),
|
||||
PassiveTeX 1.21 (http://www.tei-c.org.uk/Software/passivetex/), and
|
||||
RenderX 2.77 (http://www.renderx.com/).
|
||||
|
||||
|
||||
texml.xsl
|
||||
|
||||
XSLT file to output TeXML files that can be further processed by
|
||||
TeXMLatte to produce LaTeX files. The TeXMLatte program can be found
|
||||
at: http://www.alphaworks.ibm.com/tech/texml/.
|
||||
RenderX 3.7.8 (http://www.renderx.com/).
|
||||
|
||||
|
||||
ie50.xsl
|
||||
@@ -108,14 +105,70 @@ logtalk.css
|
||||
files in a web browser.
|
||||
|
||||
|
||||
html.sh
|
||||
lgt2pdf.sh
|
||||
(bash shell script)
|
||||
lgt2pdf.js
|
||||
(JScript command-line script for Windows; requires WSH 5.6 or later version)
|
||||
|
||||
Sample Unix shell script to batch convert .xml files to .html files.
|
||||
The script also generates an index.html file which contains links to all the
|
||||
Sample scripts to batch convert .xml files to .pdf files
|
||||
|
||||
Supported XSL-FO processors:
|
||||
* Apache FOP processor (tested with version 0.20.5)
|
||||
http://xml.apache.org/fop
|
||||
* RenderX XEP processor (tested with version 3.8.1)
|
||||
http://www.renderx.com/
|
||||
|
||||
When using the FOP, compile your Logtalk source files using the compiler
|
||||
option doctype(standalone) in order to workaround a bug on the XALAN
|
||||
processor used by this processor.
|
||||
|
||||
These script assumes that the LOGTALKHOME environment variable is defined
|
||||
and that the chosen XSL-FO processor is available in the path.
|
||||
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 lgt2pdf.js help" or
|
||||
"lgt2pdf.sh -h").
|
||||
|
||||
|
||||
lgt2html.sh
|
||||
(bash shell script)
|
||||
lgt2html.js
|
||||
(JScript command-line script for Windows; requires WSH 5.6 or later version)
|
||||
|
||||
Sample scripts to batch convert .xml files to .html files. These scripts
|
||||
also generate an index.html file which contains links to all the converted
|
||||
files.
|
||||
|
||||
Supported XSLT processors:
|
||||
* libxslt (tested with version 1.1.8)
|
||||
http://xmlsoft.org/XSLT/
|
||||
* Xalan (tested with version 1.7.0)
|
||||
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
|
||||
|
||||
These scripts assumes that the LOGTALKHOME environment variable is defined
|
||||
and that the chosen XSLT processor is available in the path.
|
||||
|
||||
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 lgt2pdf.js help" or
|
||||
"lgt2pdf.sh -h").
|
||||
|
||||
|
||||
html.sh
|
||||
xhtml.sh
|
||||
|
||||
Sample Unix shell scripts to batch convert .xml files to .html files. These
|
||||
scripts also generates an index.html file which contains links to all the
|
||||
converted files. The title of the index.html file can be given as a parameter
|
||||
to the script. Edit the script to match your environment before running it
|
||||
and to chose between HTML or XHTML output. Requires James Clark XT XSLT
|
||||
processor 20020426a or later version (http://www.jclark.com/xml/).
|
||||
to the script. Edit the scripts to match your environment before running them.
|
||||
Requires James Clark XT XSLT processor 20020426a or later version
|
||||
(http://www.jclark.com/xml/). You will need either to copy your .xml files to
|
||||
this directory or to copy these files to the directory where the .xml files
|
||||
reside.
|
||||
|
||||
|
||||
htmlnt.cmd
|
||||
@@ -126,6 +179,8 @@ htmlnt.cmd
|
||||
to the script. Edit the script to match your environment before running
|
||||
it and to chose between HTML or XHTML output. Requires James Clark XT
|
||||
XSLT processor 20020426a or later version (http://www.jclark.com/xml/).
|
||||
You will need either to copy your .xml files to this directory or to copy
|
||||
these files to the directory where the .xml files reside.
|
||||
|
||||
|
||||
htmldos.bat
|
||||
@@ -133,7 +188,9 @@ htmldos.bat
|
||||
Sample DOS batch script to convert .xml files to .html files. Edit the
|
||||
script to match your environment before running it and to chose between
|
||||
HTML or XHTML output. Requires James Clark XT XSLT processor 20020426a
|
||||
or later version (http://www.jclark.com/xml/).
|
||||
or later version (http://www.jclark.com/xml/). You will need either to
|
||||
copy your .xml files to this directory or to copy these files to the
|
||||
directory where the .xml files reside.
|
||||
|
||||
|
||||
pdf.sh
|
||||
@@ -143,7 +200,9 @@ pdf.sh
|
||||
before running it. Requires Apache FOP processor (http://xml.apache.org/fop).
|
||||
Tested with version 0.20.5 (to workaround a bug on the XALAN processor used
|
||||
by FOP, you should use the compiler option doctype(standalone) when compiling
|
||||
your Logtalk source files).
|
||||
your Logtalk source files). You will need either to copy your .xml files to
|
||||
this directory or to copy these files to the directory where the .xml files
|
||||
reside.
|
||||
|
||||
|
||||
pdf.bat
|
||||
@@ -153,9 +212,11 @@ pdf.bat
|
||||
before running it. Requires Apache FOP processor (http://xml.apache.org/fop).
|
||||
Tested with version 0.20.5 (to workaround a bug on the XALAN processor used
|
||||
by FOP, you should use the compiler option doctype(standalone) when compiling
|
||||
your Logtalk source files).
|
||||
your Logtalk source files). You will need either to copy your .xml files to
|
||||
this directory or to copy these files to the directory where the .xml files
|
||||
reside.
|
||||
|
||||
|
||||
Note that you can write other XSLT files for converting the XML files to
|
||||
other formats besides PDF, HTML, or LaTeX. You can also write alternative
|
||||
CSS and XSLT files to change the appearance of the HTML and LaTeX files.
|
||||
Note that you can write other XSL files for converting the XML files to other
|
||||
formats besides PDF or (X)HTML. You can also write alternative CSS and XSL
|
||||
files to change the appearance of the (X)HTML and PDF files.
|
||||
|
||||
Reference in New Issue
Block a user