aboutsummaryrefslogtreecommitdiff
path: root/Doc/Manual/README
diff options
context:
space:
mode:
authorJohn Lenz <jlenz2@math.uiuc.edu>2005-02-26 02:56:29 +0000
committerJohn Lenz <jlenz2@math.uiuc.edu>2005-02-26 02:56:29 +0000
commit13ad5fff852a4ab63c3a2050c12543ebe0eae36a (patch)
tree178754f7c2c080cc02ae58b1b8deb406f835cdee /Doc/Manual/README
parentbc96925c9d1c33636e8ddee019ec417a53656ad6 (diff)
downloadswig-13ad5fff852a4ab63c3a2050c12543ebe0eae36a.tar.gz
- Updated documentation to use CSS and <div> instead of blockquotes
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@7003 626c5289-ae23-0410-ae9c-e8d60b6d4f22
Diffstat (limited to 'Doc/Manual/README')
-rw-r--r--Doc/Manual/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/Doc/Manual/README b/Doc/Manual/README
index cb01432fb..f01013d54 100644
--- a/Doc/Manual/README
+++ b/Doc/Manual/README
@@ -5,3 +5,17 @@ and the table of contents is generated automatically by the 'maketoc.py'
script. The Makefile has further information on how the various alternative
forms of the documentation is 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>