swig/Doc/Manual
William S Fulton f278fdac59 Replace pdf documentation generation tool with wkhtmltopdf from htmldoc
htmldoc does not seem to be generating pdfs properly any more (on Ubuntu
14.04). It has been replaced with wkhtmltopdf which is better as it
supports css and so the patched version of htmldoc with the simple css
support is no longer required. wkhtmldoc does have have a few problems
though which have been addressed in prior commits:

- <H1><a name="X"></a>Text</H1> style links need changing to:
  <H1><a name="X">Text</a></H1>
- tabs in <pre> elements should be expanded to 8 spaces by default, but
  are expanded to just one space and css expand-tab is not recognised.

The <pre> <tt> <code> elements do not always select a fixed-width font -
try installing a Courier font.
2015-12-30 22:22:33 +00:00
..
Allegrocl.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
android-class.png Add Android docs - supporting screenshots 2011-12-10 17:03:50 +00:00
android-simple.png Add Android docs - supporting screenshots 2011-12-10 17:03:50 +00:00
Android.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Arguments.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
CCache.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Add Scilab to html docs 2015-01-27 19:30:24 +00:00
Chicken.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Contents.html Minor html fixes 2015-12-30 22:22:33 +00:00
Contract.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
CPlusPlus11.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
CSharp.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Customization.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
D.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Extending.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Guile.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
index.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Introduction.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Java.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Javascript.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Library.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
linkchecker.config html links updates 2015-12-18 21:14:44 +00:00
Lisp.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Lua.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
makechap.py Correct html documentation linking generated by makechap.py script 2015-12-30 22:22:31 +00:00
Makefile Replace pdf documentation generation tool with wkhtmltopdf from htmldoc 2015-12-30 22:22:33 +00:00
maketoc.py HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
margin-left.patch Update htmldoc patch to htmldoc-1.8.27 2013-05-12 19:14:58 +01:00
Modula3.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Modules.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Mzscheme.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Ocaml.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Octave.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Perl5.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Php.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Pike.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Preface.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Preprocessor.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Python.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
R.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Scilab.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Scripting.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Sections.html html fixes 2015-12-30 22:22:32 +00:00
style.css Revert css style changes in javascript branch 2014-04-16 07:59:24 +01:00
SWIG.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Tcl.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Typemaps.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Varargs.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Warnings.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Windows.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00

This directory contains the HTML for the SWIG users manual.

All of this HTML is hand-written.  However, section numbering, indices,
and the table of contents are generated automatically by the 'maketoc.py'
script. The Makefile has further information on how the various alternative
forms of the documentation are generated from the hand-written HTML.

There are 4 types of boxes that code or whatever can be inside:
  - <div class="shell">...</div>
    This is for text that shows the output of running commands on the shell.
  - <div class="code">...</div>
    This is for either C, C++, or SWIG code
  - <div class="targetlang">...</div>
    This is for code in a target scripting language
  - <div class="diagram">...</div>
    This is for text that is not code or a shell

The general format is
<div class="foo"><pre>
whatever here
</pre></div>