| 1 | ================================================================ |
|---|
| 2 | Logtalk - Open source object-oriented logic programming language |
|---|
| 3 | Release 2.31.1 |
|---|
| 4 | |
|---|
| 5 | Copyright (c) 1998-2008 Paulo Moura. All Rights Reserved. |
|---|
| 6 | ================================================================ |
|---|
| 7 | |
|---|
| 8 | |
|---|
| 9 | This folder contains supporting files for converting and/or indexing XML |
|---|
| 10 | documentation files (which are created when compiling objects, categories, |
|---|
| 11 | or protocols) to PDF files or (X)HTML files using XSL style sheets. The |
|---|
| 12 | documentation files may also be viewed directly on a web browser that |
|---|
| 13 | supports the W3C standards XML, XSLT, CSS, and HTML 4 or XHTML 1.0. |
|---|
| 14 | |
|---|
| 15 | The shell and command-line scripts should be called from the directory |
|---|
| 16 | containing the XML documenting files that you wish to convert. See the |
|---|
| 17 | description of each script below for details. |
|---|
| 18 | |
|---|
| 19 | MAKE SURE THAT THE XSL PROCESSORS YOU INTEND TO USE ARE PROPERLY INSTALLED |
|---|
| 20 | AND WORKING BEFORE RUNNING THESE SCRIPTS! |
|---|
| 21 | |
|---|
| 22 | Regarding conversion to (X)HTML, the links to the XSL files on the XML |
|---|
| 23 | files and the links to the CSS files in the generated HTML files assume |
|---|
| 24 | that all files reside in the same directory. |
|---|
| 25 | |
|---|
| 26 | The choice of the default XSL file to use is made in the config files by |
|---|
| 27 | the '$lgt_default_flag'/2 predicate. You may also choose a different XSL |
|---|
| 28 | file by using the xslfile/1 compiler flag in the logtalk_compile/2 or |
|---|
| 29 | logtalk_load/2 calls. The default file is "lgtxml.xsl" (described below). |
|---|
| 30 | |
|---|
| 31 | The documenting files can be generated either as standalone XML files |
|---|
| 32 | or contain a reference to either the Logtalk DTD file, "logtalk.dtd", |
|---|
| 33 | or to the Logtalk XML Schema file, "logtalk.xsd". The reference to the |
|---|
| 34 | XML specificationfile can be either a local reference or a URI reference. |
|---|
| 35 | By default, all XML documenting files contain a local reference but that |
|---|
| 36 | can be changed either in the config files, by setting a Logtalk compiler |
|---|
| 37 | flag, or by using the xmlsref/1 compiler flag. Choose the option value |
|---|
| 38 | that works best with your XSLT tools. To choose between the DTD or XSD |
|---|
| 39 | specifications use the xmlspec/1 compiler flag. |
|---|
| 40 | |
|---|
| 41 | As Logtalk uses a single namespace for all objects, categories, and protocols, |
|---|
| 42 | you may want to define an alternate, global compilation directory to store all |
|---|
| 43 | the XML documenting files, thus ensuring proper working of links to other |
|---|
| 44 | entities in the generated (X)HTML files. This can be easily accomplished by |
|---|
| 45 | using the predicate '$lgt_default_flag'/2, which is defined on the config |
|---|
| 46 | files. For example: |
|---|
| 47 | |
|---|
| 48 | '$lgt_default_flag'(xmldir, 'xml_docs/'). |
|---|
| 49 | ... |
|---|
| 50 | '$lgt_default_flag'(altdirs, on). |
|---|
| 51 | ... |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | Brief description of each file in this folder: |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | lgtxml.xsl |
|---|
| 58 | |
|---|
| 59 | XSLT file for viewing XML files directly in a browser. The links |
|---|
| 60 | in the (internally generated) HTML 4.01 files point to related XML |
|---|
| 61 | files. UTF-8 encoding is assumed. Edit the file if you use a different |
|---|
| 62 | encoding. |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | lgthtml.xsl |
|---|
| 66 | |
|---|
| 67 | XSLT file to output HTML 4.01 files from the XML files. The links in |
|---|
| 68 | the generated HTML files point to related HTML files. It can be used |
|---|
| 69 | to batch convert XML files to HTML files. UTF-8 encoding is assumed. |
|---|
| 70 | Edit the file if you use a different encoding. |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | lgtxhtml.xsl |
|---|
| 74 | |
|---|
| 75 | XSLT file to output XHTML 1.1 files from the XML files. The links in |
|---|
| 76 | the generated XHTML files point to related XHTML files. It can be used |
|---|
| 77 | to batch convert XML files to XHTML files. UTF-8 encoding is assumed. |
|---|
| 78 | Edit the file if you use a different encoding. |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | lgtpdf.xsl |
|---|
| 82 | lgtpdfa4.xsl |
|---|
| 83 | lgtpdfus.xsl |
|---|
| 84 | |
|---|
| 85 | XSLT files to generate PDF files from the XML files (formatted either |
|---|
| 86 | for A4 paper or US Letter paper) using XSL Formatting Objects. Tested |
|---|
| 87 | with the XSL-FO processors Apache FOP 0.20.5 (http://xml.apache.org/fop) |
|---|
| 88 | and RenderX 4.4 (http://www.renderx.com/). |
|---|
| 89 | |
|---|
| 90 | The "lgtpdf.xsl" file defines a parameter for the paper format (either |
|---|
| 91 | A4 or US Letter). The files "lgtpdfa4.xsl" and "lgtpdfus.xsl" import the |
|---|
| 92 | "lgtpdf.xsl" file and set the paper format parameter to the appropriate |
|---|
| 93 | value. |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | ie50.xsl |
|---|
| 97 | |
|---|
| 98 | XSLT file for viewing XML files in Microsoft Internet Explorer 5.x |
|---|
| 99 | (using the outdated Microsoft XML Parser; works with both Macintosh |
|---|
| 100 | and Windows versions). The links in the (internally generated) HTML |
|---|
| 101 | files point to related XML files. It can be used to browse and view |
|---|
| 102 | the XML files directly. |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | logtalk.dtd |
|---|
| 106 | |
|---|
| 107 | DTD file describing the structure of the XML files generated by |
|---|
| 108 | Logtalk. |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | custom.ent |
|---|
| 112 | |
|---|
| 113 | Document type description defining XML entities for personal data |
|---|
| 114 | that may be used on Logtalk documenting directives. |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | logtalk.rng |
|---|
| 118 | |
|---|
| 119 | RELAX NG file describing the structure of the XML files generated |
|---|
| 120 | by Logtalk. |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | logtalk.xsd |
|---|
| 124 | |
|---|
| 125 | XML Schema file describing the structure of the XML files generated |
|---|
| 126 | by Logtalk. |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | logtalk.css |
|---|
| 130 | |
|---|
| 131 | Cascade style sheet file to render the HTML/XHTML output of the XSL |
|---|
| 132 | files in a web browser. |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | lgt2pdf.sh |
|---|
| 136 | (bash shell script) |
|---|
| 137 | lgt2pdf.js |
|---|
| 138 | (JScript command-line script for Windows; requires WSH 5.6 or later |
|---|
| 139 | version) |
|---|
| 140 | |
|---|
| 141 | Sample scripts to batch convert XML files to PDF files |
|---|
| 142 | |
|---|
| 143 | Supported XSL-FO processors: |
|---|
| 144 | * Apache FOP processor (tested with version 0.20.5) |
|---|
| 145 | http://xml.apache.org/fop |
|---|
| 146 | * Lunasil Xinc processor (tested with version 2.02) |
|---|
| 147 | http://www.lunasil.com/index.html |
|---|
| 148 | * RenderX XEP processor (tested with version 3.8.1) |
|---|
| 149 | http://www.renderx.com/ |
|---|
| 150 | |
|---|
| 151 | When using the FOP, you must compile your Logtalk source files using |
|---|
| 152 | the compiler option xmlsref(standalone) in order to workaround a bug |
|---|
| 153 | on the XALAN processor used by this processor. |
|---|
| 154 | |
|---|
| 155 | These script assume that the LOGTALKHOME and LOGTALKUSER environment |
|---|
| 156 | variables are defined and that the chosen XSL-FO processor is available |
|---|
| 157 | in the path. |
|---|
| 158 | |
|---|
| 159 | The scripts should be called from the directory containing the XML |
|---|
| 160 | files you wish to convert. Call the scripts with the help option for |
|---|
| 161 | a description of the available optional parameters (type "cscript |
|---|
| 162 | lgt2pdf.js help" or "lgt2pdf.sh -h"; depending on your Logtalk |
|---|
| 163 | installation, you may simply need to type "lgt2pdf" in order to run |
|---|
| 164 | the script). |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | lgt2html.sh |
|---|
| 168 | (bash shell script) |
|---|
| 169 | lgt2html.js |
|---|
| 170 | (JScript command-line script for Windows; requires WSH 5.6 or |
|---|
| 171 | later version) |
|---|
| 172 | |
|---|
| 173 | Sample scripts to batch convert XML files to HTML files. These |
|---|
| 174 | scripts also generate an "index.html" file which contains links |
|---|
| 175 | to all the converted files. |
|---|
| 176 | |
|---|
| 177 | Supported XSLT processors: |
|---|
| 178 | * libxslt (tested with version 1.1.8) |
|---|
| 179 | http://xmlsoft.org/XSLT/ |
|---|
| 180 | * Xalan (tested with version 1.7.0) |
|---|
| 181 | http://xml.apache.org/xalan-c/index.html |
|---|
| 182 | * Sablotron (tested with version 1.0.1) |
|---|
| 183 | http://www.gingerall.com/charlie/ga/xml/p_sab.xml |
|---|
| 184 | * Microsoft MSXSL (only for the Windows JScript script) |
|---|
| 185 | http://msdn.microsoft.com/XML/XMLDownloads/default.aspx |
|---|
| 186 | |
|---|
| 187 | These scripts assumes that the LOGTALKHOME and LOGTALKUSER environment |
|---|
| 188 | variables are defined and that the chosen XSLT processor is available in |
|---|
| 189 | the path. |
|---|
| 190 | |
|---|
| 191 | The scripts should be called from the directory containing the XML files |
|---|
| 192 | you wish to convert. Call the scripts with the help option for a description |
|---|
| 193 | of the available optional parameters (type "cscript lgt2html.js help" or |
|---|
| 194 | "lgt2html.sh -h"; depending on your Logtalk installation, you may simply |
|---|
| 195 | need to type "lgt2html" in order to run the script). |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | lgt2xml.sh |
|---|
| 199 | (bash shell script) |
|---|
| 200 | lgt2xml.js |
|---|
| 201 | (JScript command-line script for Windows; requires WSH 5.6 or |
|---|
| 202 | later version) |
|---|
| 203 | |
|---|
| 204 | Sample scripts for indexing the XML files in the current directory |
|---|
| 205 | by generating an index.html file which contains links to all the |
|---|
| 206 | files. In addition, these scripts also copies of the "lgtxml.xsl" |
|---|
| 207 | and "logtalk.css" files to the current directory, allowing direct |
|---|
| 208 | visualization of the XML files on a supported web browser. |
|---|
| 209 | |
|---|
| 210 | These scripts assumes that the LOGTALKHOME and LOGTALKUSER environment |
|---|
| 211 | variables are defined. |
|---|
| 212 | |
|---|
| 213 | The scripts should be called from the directory containing the XML files |
|---|
| 214 | you wish to index. Call the scripts with the help option for a description |
|---|
| 215 | of the available optional parameters (type "cscript lgt2xml.js help" or |
|---|
| 216 | "lgt2xml.sh -h"; depending on your Logtalk installation, you may simply |
|---|
| 217 | need to type "lgt2xml" in order to run the script). |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | Note that you can write other XSL files for converting the XML files to |
|---|
| 221 | other formats besides PDF or (X)HTML. You can also write alternative CSS |
|---|
| 222 | and XSL files to change the appearance of the (X)HTML and PDF files. |
|---|
