| 1 | ================================================================= |
|---|
| 2 | Logtalk - Object oriented extension to Prolog |
|---|
| 3 | Release 2.9.3 |
|---|
| 4 | |
|---|
| 5 | Copyright (c) 1998-2002 Paulo Moura. All Rights Reserved. |
|---|
| 6 | ================================================================= |
|---|
| 7 | |
|---|
| 8 | This folder contains several files that enables .xml documentation files |
|---|
| 9 | created when compiling objects, categories, or protocols, to be converted |
|---|
| 10 | to PDF files, to be viewed in a web browser that supports the W3C standards |
|---|
| 11 | XML, XSLT, CSS and HTML 4, or to be converted to LateX for printing. |
|---|
| 12 | |
|---|
| 13 | You will need to either copy your .xml files to this directory or copy |
|---|
| 14 | these files to the directory where the .xml files reside. |
|---|
| 15 | |
|---|
| 16 | Regarding conversion to HTML, the links to the .xsl files on the .xml |
|---|
| 17 | files and the links to the .css files in the generated .html files assume |
|---|
| 18 | that all files reside in the same directory. |
|---|
| 19 | |
|---|
| 20 | The choice of the default .xsl file to use is made in the config files by |
|---|
| 21 | the lgt_default_compiler_option/2 predicate. You can also choose a different |
|---|
| 22 | .xsl file by using the xsl/1 compiler option in the logtalk_compile/2 or |
|---|
| 23 | logtalk_load/2 calls. The default file is lgtxml.xsl (described below). |
|---|
| 24 | |
|---|
| 25 | Brief description of each file in this folder: |
|---|
| 26 | |
|---|
| 27 | |
|---|
| 28 | lgthtml.xsl |
|---|
| 29 | |
|---|
| 30 | XSLT file to output HTML files from the .xml files. The links in the |
|---|
| 31 | generated HTML files point to related HTML files. It can be used |
|---|
| 32 | to batch convert XML files to HTML files. |
|---|
| 33 | |
|---|
| 34 | |
|---|
| 35 | lgtxml.xsl |
|---|
| 36 | |
|---|
| 37 | XSLT file for viewing .xml files directly in in a browser such as Mozilla |
|---|
| 38 | (version 0.9.2 or later) or Microsoft Internet Explorer 5.5 for Windows |
|---|
| 39 | (after installing the latest Microsoft XML Parser Release that is needed |
|---|
| 40 | for XSL standard compliance). The links in the (internally generated) |
|---|
| 41 | HTML files point to related XML files. |
|---|
| 42 | |
|---|
| 43 | |
|---|
| 44 | lgtpdfa4.xsl lgtpdfus.xsl |
|---|
| 45 | |
|---|
| 46 | XSLT files to generate PDF files from the .xml files (formatted either |
|---|
| 47 | for A4 paper or US Letter paper) using XSL Formatting Objects. Tested |
|---|
| 48 | with Apache Fop processor (http://xml.apache.org/fop). |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | texml.xsl |
|---|
| 52 | |
|---|
| 53 | XSLT file to output TeXML files that can be further processed by |
|---|
| 54 | TeXMLatte to produce LaTeX files. The TeXMLatte program can be found |
|---|
| 55 | at: http://www.alphaworks.ibm.com/tech/texml/. |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | ie5.xsl |
|---|
| 59 | |
|---|
| 60 | XSLT file for viewing .xml files in Microsoft Internet Explorer 5.x |
|---|
| 61 | (using the outdated Microsoft XML Parser; works with both Macintosh |
|---|
| 62 | and Windows versions). The links in the (internally generated) HTML |
|---|
| 63 | files point to related XML files. It can be used to browse and view |
|---|
| 64 | the XML files directly. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | logtalk.dtd |
|---|
| 68 | |
|---|
| 69 | Document type description describing the structure of the .xml files |
|---|
| 70 | generated by Logtalk. |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | logtalk.xsd |
|---|
| 74 | |
|---|
| 75 | XML Schema describing the structure of the .xml files generated by |
|---|
| 76 | Logtalk. |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | logtalk.css |
|---|
| 80 | |
|---|
| 81 | Cascade style sheet file to render the HTML output of the .xsl files |
|---|
| 82 | in a web browser. |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | html.sh |
|---|
| 86 | |
|---|
| 87 | Sample Unix shell script to batch convert .xml files to .html files. |
|---|
| 88 | Edit the script to match your environment before running it. |
|---|
| 89 | Requires James Clarck XT processor (http://www.jclark.com/xml/xt.html). |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | html.bat |
|---|
| 93 | |
|---|
| 94 | Sample DOS batch script to convert .xml files to .html files. |
|---|
| 95 | Edit the script to match your environment before running it. |
|---|
| 96 | Requires James Clarck XT processor (http://www.jclark.com/xml/xt.html). |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | pdf.sh |
|---|
| 100 | |
|---|
| 101 | Sample Unix shell script to batch convert .xml files to .pdf files. |
|---|
| 102 | Edit the script to match your environment and paper format preference |
|---|
| 103 | before running it. |
|---|
| 104 | Requires Apache FOP processor (http://xml.apache.org/fop). |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | pdf.bat |
|---|
| 108 | |
|---|
| 109 | Sample DOS batch script to convert .xml files to .pdf files. |
|---|
| 110 | Edit the script to match your environment and paper format preference |
|---|
| 111 | before running it. |
|---|
| 112 | Requires Apache FOP processor (http://xml.apache.org/fop). |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | Note that you can write other XSLT files for converting the XML files to |
|---|
| 116 | other formats besides PDF, HTML, or LaTeX. You can also write alternative |
|---|
| 117 | CSS and XSLT files to change the appearance of the HTML and LaTeX files. |
|---|
