/trunk/Doc/Manual/README

# · #! · 21 lines · 18 code · 3 blank · 0 comment · 0 complexity · dc321a76d49092c682b969bdfee7704f MD5 · raw file

  1. This directory contains the HTML for the SWIG users manual.
  2. All of this HTML is hand-written. However, section numbering, indices,
  3. and the table of contents is generated automatically by the 'maketoc.py'
  4. script. The Makefile has further information on how the various alternative
  5. forms of the documentation is generated from the hand-written HTML.
  6. There are 4 types of boxes that code or whatever can be inside:
  7. - <div class="shell">...</div>
  8. This is for text that shows the output of running commands on the shell.
  9. - <div class="code">...</div>
  10. This is for either C, C++, or SWIG code
  11. - <div class="targetlang">...</div>
  12. This is for code in a target scripting language
  13. - <div class="diagram">...</div>
  14. This is for text that is not code or a shell
  15. The general format is
  16. <div class="foo"><pre>
  17. whatever here
  18. </pre></div>