]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Exclude online doc information from main page and create a page of its own.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 3 Apr 2000 11:51:17 +0000 (11:51 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 3 Apr 2000 11:51:17 +0000 (11:51 +0000)
git-svn-id: https://svn.dealii.org/trunk@2656 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/documentation.html [new file with mode: 0644]
deal.II/doc/navbar.html
deal.II/doc/toc.html

diff --git a/deal.II/doc/documentation.html b/deal.II/doc/documentation.html
new file mode 100644 (file)
index 0000000..7878153
--- /dev/null
@@ -0,0 +1,142 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"
+   "http://www.w3.org/TR/REC-html40/strict.dtd">
+<html>
+  <head>
+    <link href="screen.css" rel="StyleSheet" title="deal.II Homepage" media="screen">
+    <link href="print.css" rel="StyleSheet" title="deal.II Homepage" media="print">
+    <title>The deal.II Homepage</title>
+    <meta name="author" content="Wolfgang Bangerth <deal@iwr.uni-heidelberg.de>">
+    <meta name="keywords" content="deal.II"></head>
+
+<body>
+
+    <h2>Online documentation</h2>
+
+    <p>
+    <acronym>deal.II</acronym> comes with quite extensive online
+    documentation, which falls into several categories. They are
+    listed below.
+    </p>
+
+
+    <h4>README file</h4>
+      <p>
+      The <a href="readme.html" target="body">README file</a> of
+      the library. It gives information on system requirements,
+      installation, and copyright.</p>
+
+    <h4>Tutorials</h4>
+    
+      <p>
+      The <a href="tutorial/index.html" target="_top">tutorial</a>:
+      for new users of the library. It explains the basic elements of
+      finite element programs based on the library, and provides small
+      example programs.
+      </p>
+
+      <p>
+      Another chapter of the tutorial gives an overview of information
+      classified by subject. This is more for reference than to learn
+      about the library the first time.
+      </p>
+
+
+    <h4>Programming interface</h4>
+
+      <p>
+      These are the pages you will need most often as a reference of
+      all classes, functions and variables in the library. They are
+      extensively documented (presently approximately 1250 pages if
+      printed), and are split into several parts, according to the
+      sub-libraries and the different directories of the main
+      <acronym>deal.II</acronym> library:
+        <ul>
+          <li> <a href="auto/kdoc/base/index.html" target="body">
+                 <code>/base</code> library</a>: a set of classes not
+                 specifically related to finite elements, but
+                 nonetheless important for the overall library,
+          <li> <a href="auto/kdoc/lac/index.html" target="body">
+                 <code>/lac</code> library</a>: <em>L</em>inear
+                 <em>a</em>lgebra <em>c</em>lasses,
+          <li> <a href="auto/kdoc/grid/index.html" target="body">
+               Grid handling</a> in the 
+                 <code>/deal.II</code> library,
+          <li> <a href="auto/kdoc/dof/index.html" target="body">
+               Degrees of freedom and finite elements</a> in the 
+                 <code>/deal.II</code> library,
+          <li> <a href="auto/kdoc/numerics/index.html" target="body">
+               Numerical tools</a> in the 
+                 <code>/deal.II</code> library.
+        </ul>
+      </p>
+
+
+    <h4>Development information</h4>
+  
+      <p>
+      If you plan to <a href="development/index.html"
+           target="_top">develop your own applications</a> using
+      <acronym>deal.II</acronym>, it might be worth to take a look
+      at <a href="development/index.html" target="_top">this
+      page</a>.
+      </p>
+
+      
+    <h4>Reports</h4>
+    
+      <p>
+      We have a few reports written on <acronym>deal.II</acronym>,
+      the following of which are online:
+        <ul>
+        <li> <p>
+             A <a href="reports/deal.II-paper/index.html" target="body">
+             paper describing the background, purpose and methods</a>
+             of <acronym>deal.II</acronym>, by Wolfgang Bangerth and
+             Guido Kanschat. This paper is also available as preprint
+             99-43 from the 
+             <a href="http://www.iwr.uni-heidelberg.de" target="_top">
+             IWR preprint server</a>.
+              </p>
+
+        <li> <p>
+              A brief report about the classes involved in the
+             <a href="reports/class-hierarchies/index.html"
+                 target="body">iterators</a>
+             used to access cells in the triangulations and the data
+             thereon, such as their geometry, the number of the
+             degrees of freedom, data values, etc. (by Wolfgang Bangerth).
+             </p>
+
+         <li> <p>
+              A report on how
+             <a href="reports/multithreading/index.html"
+                 target="body">multithreading</a> is implemented and
+              supported in <acronym>deal.II</acronym> (by Wolfgang
+              Bangerth). 
+             </p>
+        </ul>
+      </p>
+
+
+    <h4>Publications</h4>
+
+      <p>
+      A <a href="publications/toc.html" target="body">list of
+      publications</a> about and based on
+      <acronym>deal.II</acronym> can be found on 
+      <a href="publications/toc.html" target="body">this</a> page.
+      </p>
+
+
+    <h4>Future</h4>
+
+      <p>
+      Finally, we have a page where we list our
+      <a href="future.html" target="body">plans for extensions of deal.II in
+      the future</a>.
+      </p>
+
+
+</body>
+</html>
+
index 1d70cf447504c46b07bf19467a6dd334c8346ae4..95dd51da0e93deaafda4e3892d686038df90b770 100644 (file)
        </p>
       </li>
 
+      <li>
+       <p>
+         <a href="documentation.html" target="body">
+           Documentation
+         </a>
+       </p>
+      </li>
+
       <li>
        <p>
           <a href="auto/kdoc/base/index.html" target="body">
index 46e7d72753f85ab49eb5a148678ed4033bc824b4..891cac82dbfaefa0a311cd720b393c6f2417fc17 100644 (file)
 
     <h2>Online documentation</h2>
 
+    <p>
     <acronym>deal.II</acronym> has quite extensive online
-    documentation, which falls into several categories:
-    <ul>
-    <li> <p>The <a href="readme.html" target="body">README</a> file of
-         the library. It gives information on system requirements,
-         installation, and copyright.</p>
-
-    <li> <p>The <a href="tutorial/index.html" target="_top">tutorial</a>:
-         for new users of the library. It
-         explains the basic elements of finite element programs based
-         on the library, and provides small example programs.</p>
-
-    <li> <p> If you plan to
-         <a href="development/index.html" target="_top">develop 
-         your own applications</a>  using
-         <acronym>deal.II</acronym>, it might be worth to take a look
-        at <a href="development/index.html" target="_top">this
-         page</a>.
-        </p>
-
-    <li> <p>Programming interface documentation: the classes and methods
-         in the library are extensively documented (presently
-         approximately 1250 pages if printed). This API documentation
-         is split into several parts, according 
-        to the sub-libraries and the different directories of the main
-        <acronym>deal.II</acronym> library:
-        <ul>
-          <li> <a href="auto/kdoc/base/index.html" target="body">
-                 <code>/base</code> library</a>: a set of classes not
-                 specifically related to finite elements, but
-                 nonetheless important for the overall library,
-          <li> <a href="auto/kdoc/lac/index.html" target="body">
-                 <code>/lac</code> library</a>: <em>L</em>inear
-                 <em>a</em>lgebra <em>c</em>lasses,
-          <li> <a href="auto/kdoc/grid/index.html" target="body">
-               Grid handling</a> in the 
-                 <code>/deal.II</code> library,
-          <li> <a href="auto/kdoc/dof/index.html" target="body">
-               Degrees of freedom and finite elements</a> in the 
-                 <code>/deal.II</code> library,
-          <li> <a href="auto/kdoc/numerics/index.html" target="body">
-               Numerical tools</a> in the 
-                 <code>/deal.II</code> library.
-        </ul>
-        </p>
+    documentation, so we dedicated a
+    <a href="documentation.html" target="body">separate
+    page on documentation</a> to this subject.
+    </p>
 
-    <li> <p> We have a few reports written on <acronym>deal.II</acronym>,
-         the following of which are online:
-        <ul>
-        <li> <p>
-             A <a href="reports/deal.II-paper/index.html" target="body">
-             paper describing the background, purpose and methods</a>
-             of <acronym>deal.II</acronym>, by Wolfgang Bangerth and
-             Guido Kanschat. This paper is also available as preprint
-             99-43 from the 
-             <a href="http://www.iwr.uni-heidelberg.de" target="_top">
-             IWR preprint server</a>.
-              </p>
-
-        <li> <p>
-              A brief report about the classes involved in the
-             <a href="reports/class-hierarchies/index.html"
-                 target="body">iterators</a>
-             used to access cells in the triangulations and the data
-             thereon, such as their geometry, the number of the
-             degrees of freedom, data values, etc. (by Wolfgang Bangerth).
-             </p>
-
-         <li> <p>
-              A report on how
-             <a href="reports/multithreading/index.html"
-                 target="body">multithreading</a> is implemented and
-              supported in <acronym>deal.II</acronym> (by Wolfgang
-              Bangerth). 
-             </p>
-        </ul>
-        </p>
 
-    <li> <p>
-         A <a href="publications/toc.html" target="body">list of
-         publications</a> about and based on
-         <acronym>deal.II</acronym> can be found on 
-        <a href="publications/toc.html" target="body">this</a> page.
-        </p>
+    <p>
+    Those parts of the online documentation that are most often
+    accessed are the API references. For your convenience, they are
+    also listed in the navigation panel on the left.
+    </p>
 
-    <li> <p> Finally, we have a page where we list our
-         <a href="future.html" target="body">plans for extensions of deal.II in
-         the future</a>.
-        </p>
-    </ul>
 
 
     <H2>Authors</H2>
 
+    <p>
     <acronym>deal.II</acronym> was originally designed and written by
     <a href="http://gaia.iwr.uni-heidelberg.de/~wolf/" target="_top">Wolfgang
     Bangerth</a>, starting in early 1998; he is still maintaining and
     Kanschat</a> helped with advice in the early
     implementation stages on questions of the design of object-oriented
     finite element software and later joined into the coding.
+    </p>
 
     <p>
-
     Other contributors, in alphabetical order, are:
     <UL>
     <LI><em>Ralf Hartmann:</em>
     <LI><em>Franz-Theo Suttmeier:</em>
         initial parts of the linear algebra.
     </UL>
+    </p>
 
 
     <H2>License</H2>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.